diff --git a/.agents/.gitignore b/.agents/.gitignore new file mode 100644 index 000000000..c96a04f00 --- /dev/null +++ b/.agents/.gitignore @@ -0,0 +1,2 @@ +* +!.gitignore \ No newline at end of file diff --git a/.claude/.gitignore b/.claude/.gitignore new file mode 100644 index 000000000..f09ddd2f8 --- /dev/null +++ b/.claude/.gitignore @@ -0,0 +1,8 @@ +* +!.gitignore +!CLAUDE.md +!rules +!rules/*.md +!agents +!agents/*.md +!settings.json \ No newline at end of file diff --git a/.claude/CLAUDE.md b/.claude/CLAUDE.md new file mode 100644 index 000000000..fe2232a13 --- /dev/null +++ b/.claude/CLAUDE.md @@ -0,0 +1,148 @@ +# CLAUDE.md + +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. Detailed rules are in `.claude/rules/*.md` files organized by topic. + +## Build Commands + +Run `make help` to list all available targets. Key commands: + +**Backend (Go):** +- `make build-go` — build the `photoprism` binary (develop mode) +- `make build-all` — build backend + frontend +- `go build ./...` — compile all Go packages + +**Frontend (Vue 3):** +- `make build-js` — production build of the frontend +- `make watch-js` — watch mode for frontend development (Ctrl+C to stop) + +**Dependencies:** +- `make dep` — install all dependencies (TensorFlow models, ONNX models, JS packages) +- `make dep-js` — install JS dependencies only (`npm ci`). The `photoprism/develop` image and the repo `Makefile` both set `NPM_CONFIG_IGNORE_SCRIPTS=true`, so install scripts are skipped automatically; when running npm directly in an env without that default, pass `--ignore-scripts`. Rebuild native addons with `npm rebuild --ignore-scripts=false ` — a bare `npm rebuild` no-ops wherever the env default is active. + +**Docker dev environment:** +- `make docker-build` — build local Docker image +- `docker compose up` — start dev environment (app at http://localhost:2342/) +- `make terminal` — open shell in dev container + +## Testing + +**Run all tests:** +- `make test` — runs both JS and Go tests +- `make test-go` — all Go tests (slow, ~20 min) +- `make test-js` — frontend unit tests (Vitest) +- `make test-short` — short Go tests in parallel (~5 min) + +**Run targeted Go tests:** +```bash +go test ./internal/api -run 'TestFunctionName' -count=1 +go test ./internal/photoprism -run 'TestMediaFile_' -count=1 +go test ./internal/entity/... -count=1 -tags="slow,develop" +``` + +**Run targeted JS tests:** +- `make vitest-watch` — Vitest in watch mode +- `make vitest-coverage` — Vitest with coverage report + +**Reset test databases before running Go tests:** +- `make reset-testdb` — clears SQLite test DBs and MariaDB testdb + +**Subset targets:** `make test-pkg`, `make test-api`, `make test-entity`, `make test-commands`, `make test-photoprism`, `make test-ai` + +## Formatting & Linting + +Available targets: `make fmt` (everything), `make fmt-go`, `make fmt-js`, `make fmt-swag` / `make swag` (Swagger), `make lint-go`, `make lint-js`. Detailed conventions live in `.claude/rules/go-code-style.md` and `.claude/rules/frontend-rules.md`. + +When creating or editing shell scripts, run `shellcheck ` and resolve warnings. When editing Markdown files that contain tables, format them with `npx --yes markdown-table-formatter `. + +## Schema Migrations + +If a change touches database schema, check migrations: +```bash +go run cmd/photoprism/photoprism.go migrations ls +go run cmd/photoprism/photoprism.go migrations run +# or via Makefile: +make migrate +``` + +Migration files live in `internal/entity/migrate/`. + +## Architecture Overview + +PhotoPrism is a self-hosted photo management app. The backend is Go, the frontend is Vue 3 + Vuetify 3, and the database is MariaDB or SQLite (via GORM). + +### Backend (`internal/`, `pkg/`, `cmd/`) + +| Package | Purpose | +|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `internal/photoprism` | **Core application logic**: indexing originals, metadata extraction, thumbnail generation, import/stacking, converter orchestration (FFmpeg/ImageMagick/ExifTool). Entry point for workers and CLI. | +| `internal/entity` | **Database models** (GORM): Photo, File, Album, Label, Face, User, Session, etc. Contains fixtures for tests and migration helpers. | +| `internal/entity/query` | Database query helpers used by the API and core packages. | +| `internal/api` | **REST API handlers** (Gin): thin handlers that validate input, enforce ACL/auth, delegate to services. Annotated with Swagger comments. | +| `internal/server` | HTTP server setup, routing (Gin engine), WebDAV, static assets, middleware wiring. Routes are registered in `routes.go`. | +| `internal/config` | Application configuration: CLI flags, env vars, client config sent to the frontend. | +| `internal/workers` | Background workers: indexing scheduler, metadata sync, sharing, backup, vision jobs. | +| `internal/commands` | CLI command implementations (`github.com/urfave/cli/v2`). | +| `internal/auth` | Authentication: ACL (`auth/acl`), JWT (`auth/jwt`), OIDC (`auth/oidc`), session management. | +| `internal/form` | Request form/binding structs for the API layer. | +| `internal/meta` | Metadata extraction from EXIF, XMP, JSON sidecars. | +| `internal/ffmpeg` | FFmpeg/transcoding helpers. | +| `internal/thumb` | Thumbnail generation helpers. | +| `internal/ai` | AI/vision model integration (TensorFlow, ONNX). | +| `internal/service` | Services: maps geocoding, hub (membership), cluster, WebDAV client, CIDR helpers. | +| `internal/event` | Event bus for structured logging and audit events. | +| `pkg/` | Standalone, reusable packages: `fs`, `geo`, `media`, `txt`, `clean`, `rnd`, `i18n`, `http`, `time`, etc. No dependency on `internal/`. | + +**Request flow:** HTTP request → Gin middleware (auth, rate limiting) → `internal/api` handler → `internal/photoprism` or `internal/entity` → response. + +**Audit logging convention** (`event.AuditInfo/Warn/Err`): slices must follow the pattern **Who → What → Outcome**: +- Who: `ClientIP(c)` + actor context (`"session %s"`, `"user %s"`) +- What: resource constant + action segments +- Outcome: single token like `status.Succeeded`, `status.Failed`, `status.Denied`, `status.Error(err)` + +### Frontend (`frontend/`) + +Vue 3 app using the Options API and Vuetify 3. + +| Directory | Purpose | +|---------------------------|-------------------------------------------------------------------------------------------------| +| `frontend/src/model/` | Client-side models mirroring API responses (Photo, Album, File, User, etc.) | +| `frontend/src/app/` | App bootstrap, routing (`routes.js`), and the `$session` reactive singleton | +| `frontend/src/page/` | Page-level components | +| `frontend/src/component/` | Reusable UI components | +| `frontend/src/common/` | Shared utilities, the API client (`$api`), and reactive singletons (`$config`, `$view`, `$log`) | +| `frontend/src/locales/` | i18n translation files | +| `frontend/tests/` | Vitest unit tests + TestCafe acceptance tests | + +State management uses reactive singleton modules in `src/common/` and `src/app/`, not Vuex or Pinia. Frontend code-style, formatting, testing, translation, and Playwright rules live in `.claude/rules/frontend-rules.md`. + +### API Conventions + +- REST API v1 base path: `/api/v1/` (configured via `conf.BaseUri()`) +- Authentication: Bearer token (`Authorization` header) or `X-Auth-Token` header +- Pagination: `count`, `offset`, `limit` parameters (default 100, max 1000) +- After adding/changing API handlers, regenerate Swagger docs: `make fmt-go swag-fmt swag` +- New routes must be registered in `internal/server/routes.go` + +### Config & Flags + +Verify config option names before using them: +```bash +./photoprism --help +./photoprism show config-options +./photoprism show config-yaml +``` + +### Verify Before Propagating + +Before promoting a claim from `CLAUDE.md`, `AGENTS.md`, a memory entry, or another spec into a new rule, spec, code comment, or commit message, verify it against the current code (grep imports, list directories, read the cited file). Stale documentation silently turns into stale rules and stale specs that future sessions will trust. When the claim names a package, function, file, or framework, the cost of one grep is much smaller than the cost of repeating an error across multiple files. + +### Detailed Rules + +Topic-specific conventions live under `.claude/rules/` and are loaded alongside this file: + +- `code-comments.md` — shared JS/Go doc comment rules (length cap, what to omit); referenced by both style files. +- `go-code-style.md`, `go-testing.md` — Go style, package boundaries, test patterns, fixtures. +- `frontend-rules.md` — JS/Vue code style, formatting, dependencies, tests, Playwright, translations. +- `commit-and-docs-style.md` — commit-message format, GitHub issue templates, spec heading style. +- `safety-and-security.md` — Git/data safety, destructive commands, file I/O and archive-extraction policies, HTTP download helpers. +- `api-and-config.md`, `cluster-operations.md`, `import-index-download.md`, `build-and-runtime.md`, `sources-of-truth.md` — domain-specific guidance. diff --git a/.claude/agents/ui-tester.md b/.claude/agents/ui-tester.md new file mode 100644 index 000000000..b523df4a6 --- /dev/null +++ b/.claude/agents/ui-tester.md @@ -0,0 +1,41 @@ +--- +name: ui-tester +description: Drives the Playwright MCP browser to exercise UI flows, verify behavior in a real Chromium, and report findings concisely. Use for any task that needs to navigate pages, click through flows, fill forms, capture console errors, check network requests, or validate UI state. Returns a short verdict + evidence so the parent context isn't filled with raw snapshots and console logs. +tools: Bash, Read, Grep, Glob, WebFetch, ToolSearch, mcp__playwright__browser_navigate, mcp__playwright__browser_navigate_back, mcp__playwright__browser_snapshot, mcp__playwright__browser_take_screenshot, mcp__playwright__browser_click, mcp__playwright__browser_hover, mcp__playwright__browser_drag, mcp__playwright__browser_drop, mcp__playwright__browser_type, mcp__playwright__browser_fill_form, mcp__playwright__browser_select_option, mcp__playwright__browser_press_key, mcp__playwright__browser_file_upload, mcp__playwright__browser_handle_dialog, mcp__playwright__browser_wait_for, mcp__playwright__browser_console_messages, mcp__playwright__browser_network_requests, mcp__playwright__browser_evaluate, mcp__playwright__browser_run_code, mcp__playwright__browser_resize, mcp__playwright__browser_tabs, mcp__playwright__browser_close +--- + +You are a focused UI test driver. The parent agent has delegated browser-driven work to you so its context stays clean. Your output is the only thing it sees — make it short, structured, and decision-ready. + +## Loading tool schemas + +The Playwright MCP tools above appear in your toolset by name but their schemas are deferred. Before you can call any of them, run `ToolSearch` once with `select:` to load the schemas for the specific tools you need (e.g. `select:mcp__playwright__browser_navigate,mcp__playwright__browser_snapshot,mcp__playwright__browser_click`). Don't load all of them — just the handful this task actually needs. + +## Browser environment + +- The MCP server runs **one shared Chromium instance** with a **persistent profile**. Cookies and `localStorage` from earlier sessions persist. Assume state may already exist — log in fresh if a flow requires a known account. +- This profile is **separate** from the user's real Chrome. You won't see their personal logins or extensions. +- There is no parallelism — only you should be driving the browser during your run. + +## Workflow + +1. **Plan first.** Decide the minimum flow that proves or disproves the parent's question. Don't explore; execute. +2. **Run.** Navigate, interact, observe. Prefer `browser_snapshot` (accessibility tree) over `browser_take_screenshot` — it's much smaller and works for assertions. Reach for screenshots only when the parent explicitly wants visual evidence. +3. **Capture signals.** Pull `browser_console_messages` and, if relevant, `browser_network_requests` near the end of the flow — they're often the actual answer. +4. **Clean up before returning.** Call `browser_close` so the next subagent starts with no open tabs. The persistent profile keeps cookies, but tabs/state shouldn't leak across runs. + +## Reporting format + +Default to **under 300 words** unless the parent asked for more. Structure: + +- **Verdict:** one sentence — pass / fail / partial, and what was tested. +- **Evidence:** 3–6 bullet points with the concrete observations (URLs visited, elements clicked, console errors verbatim, network failures with status codes). Quote error messages exactly; don't paraphrase. +- **Notes (optional):** anything the parent should know that wasn't asked for but matters (e.g. "noticed an unrelated 404 on `/api/foo`"). + +Don't paste full snapshots, full console logs, or screenshot data unless the parent specifically requested them. The parent does not need to see your tool-call play-by-play — just the conclusion and the evidence supporting it. + +## What not to do + +- Don't open new browsers, install Playwright, or modify the MCP server config. +- Don't edit application code unless the parent explicitly told you to. Your job is to test what's there. +- Don't run long-form Go/JS test suites (that's `make test` territory) — you're the manual-QA-in-a-browser agent, not a CI runner. +- Don't summarize what you just did at the end ("I navigated to X, then clicked Y, then..."). The verdict + evidence is the summary. \ No newline at end of file diff --git a/.claude/rules/api-and-config.md b/.claude/rules/api-and-config.md new file mode 100644 index 000000000..bf64a8c9e --- /dev/null +++ b/.claude/rules/api-and-config.md @@ -0,0 +1,42 @@ +## API & Config Changes + +- Respect precedence: `options.yml` overrides CLI/env values, which override defaults. +- Adding a new option: update `internal/config/options.go` (yaml/flag tags), register in `internal/config/flags.go`, expose a getter, surface it in `*config.Report()`, and write generated values back to `options.yml`. Use `CliTestContext` in `internal/config/test.go` to exercise new flags. +- Adding a `customize.FeatureSettings` flag: a new field defaults to `true` via reflection (`features_default.go`) and is operator-disableable through `PHOTOPRISM_DISABLE_FEATURES` — no new CLI option needed. It cascades: update the full-struct literals in `internal/config/customize/{acl,scope}_test.go` and `internal/config/client_config_test.go` (the longest field name re-aligns every literal via gofmt), and `testdata/settings.yml` self-updates via `TestSettings_Save`. If the flag is only meaningful for accounts/roles, gate it per-session in `customize.Settings.ApplyACL` / `ApplyScope` (e.g. `Account`/`AppPasswords` require `ResourcePassword`/`ActionUpdate`); that shapes the Web UI client config only — enforce server-side behavior on the global flag via a `Config.DisableX()` helper. +- Identify an app-password credential by its session, not its token: `(*entity.Session).IsApplication()` (auth provider `application`) covers every grant that mints one (`password`/`session`/`cli`). The token format and grant type vary, so don't gate on `rnd.IsAppPassword` or `GrantType`. +- For `options.yml` writes, prefer config-owned persistence helpers: `Config.SaveOptionsPatch(...)` for generic merges, `Config.SaveClusterOptionsUpdate(...)` for cluster-managed metadata. +- Use `pkg/fs.ConfigFilePath` for config filenames so existing `.yml` files stay valid and new installs can adopt `.yaml` transparently. +- Use the public accessors on `*config.Config` (e.g. `JWKSUrl()`, `SetJWKSUrl()`) instead of mutating `Config.Options()` directly; reserve raw option tweaks for test fixtures. +- New metadata sources (e.g. `SrcOllama`, `SrcOpenAI`) must be defined in both `internal/entity/src.go` and the frontend lookup tables (`frontend/src/common/util.js`). +- Config init order: load `options.yml` (`c.initSettings()`), run `EarlyExt().InitEarly(c)`, connect/register the DB, then `Ext().Init(c)`. +- Favor explicit CLI flags: check `c.cliCtx.IsSet("")` before overriding user-supplied values. +- Database helpers: reuse `conf.Db()` / `conf.Database*()`, avoid GORM `WithContext`, quote MySQL identifiers, and reject unsupported drivers early. + +## Handler Conventions + +- Reuse limiter stacks (`limiter.Auth`, `limiter.Login`) and `limiter.AbortJSON` for 429s. Lean on `api.ClientIP`, `header.BearerToken`, and `Abort*` helpers. +- Compare secrets with constant-time checks; set `Cache-Control: no-store` on sensitive responses. +- Register routes in `internal/server/routes.go`. New list endpoints default `count=100` (max 1000) and `offset≥0`; document parameters explicitly. +- Set portal mode via `PHOTOPRISM_NODE_ROLE=portal` plus `PHOTOPRISM_JOIN_TOKEN` when needed. + +## API Shape Checklist + +When renaming or adding fields: +- Field casing: **TitleCase** (`UUID`, `Name`, `SiteUrl`) for fields backed by a DB entity (mirror the entity/model), **camelCase** (`storageNamespace`, `redirectUri`) for generated/artificial payloads (client config, session, action/RPC bodies). A filtered/computed entity projection stays TitleCase; an action payload stays camelCase but MAY TitleCase its single entity-identity field (e.g. `UUID`). See `specs/common/field-casing.md`. +- Update DTOs in `internal/service/cluster/response.go` and any mappers. +- Update handlers and regenerate Swagger: `make fmt-go swag-fmt swag`. +- Update tests (search/replace old field names) and examples in `specs/`. +- Quick grep: `rg -n 'oldField|newField' -S` across code, tests, and specs. + +## Testing Helpers + +- Isolate config paths with `t.TempDir()`; reuse `NewConfig`, `CliTestContext`, and `NewApiTest()` harnesses. +- Authenticate via `AuthenticateAdmin`, `AuthenticateUser`, or `OAuthToken`. Toggle auth with `conf.SetAuthMode(config.AuthModePasswd)`. +- Prefer OAuth client tokens over non-admin fixtures for negative permission checks. + +## Roles & ACL + +- Map roles via the shared tables: users through `acl.ParseRole(s)` / `acl.UserRoles[...]`, clients through `acl.ClientRoles[...]`. +- Treat `RoleAliasNone` ("none") and an empty string as `RoleNone`; default unknown client roles to `RoleClient`. +- Build CLI role help from the registered role map (never hand-maintained literals) so each edition lists exactly the roles it accepts: `commands.UserRoleUsageFor()` / `Roles.CliUsageString()`, passing CE `acl.UserRoles` or an edition's own static `auth.UserRoles` (reference the edition map directly, not the runtime-reassigned `acl.UserRoles`, to avoid the init-order trap; Portal's map includes `cluster_admin`). For federatable / cluster-instance contexts (LDAP, OIDC group→role, cluster grants) use `acl.ClusterInstanceRolesCliUsageString()` — it excludes `cluster_admin`/`visitor`. `pkg/txt.JoinOr` renders the "a, b, or c" style. +- For JWT/client scope checks, use the shared helpers (`acl.ScopePermits` / `acl.ScopeAttrPermits`). diff --git a/.claude/rules/build-and-runtime.md b/.claude/rules/build-and-runtime.md new file mode 100644 index 000000000..c9fd9d390 --- /dev/null +++ b/.claude/rules/build-and-runtime.md @@ -0,0 +1,46 @@ +## Agent Runtime (Host vs Container) + +Agents MAY run either inside the Development Environment container (recommended) or on the host. + +### Detecting the Environment + +- **Inside container if** `/.dockerenv` exists (authoritative signal). +- Path hint: when the project path is `/go/src/github.com/photoprism/photoprism` *and* `/.dockerenv` is absent, assume you are on the host with a bind mount. + +### Host Mode + +- Build local dev image (once): `make docker-build` +- Start services: `docker compose up` (add `-d` for background) +- Follow live app logs: `docker compose logs -f --tail=100 photoprism` +- Execute a single command in the app container: `docker compose exec photoprism ` + - Run as non-root to avoid root-owned files: `docker compose exec -u "$(id -u):$(id -g)" photoprism ` +- Open a terminal session: `make terminal` +- Stop everything: `docker compose --profile=all down --remove-orphans` (`make down`) + +### Container Mode + +- Install deps: `make dep` +- Build frontend/backend: `make build-js` and `make build-go` +- Watch frontend changes: `make watch-js` +- Start PhotoPrism server: `./photoprism start` + - HTTP: http://localhost:2342/ + - HTTPS: https://app.localssl.dev/ (via Traefik, if running) +- Admin Login: Default credentials are `admin` / `photoprism`; check `compose.yaml` for `PHOTOPRISM_ADMIN_USER` and `PHOTOPRISM_ADMIN_PASSWORD` if they differ. +- Do not use the Docker CLI inside the container; starting/stopping services requires host Docker access. + +### Operating Systems & Architectures + +- Guides and command examples assume Linux/Unix shell on 64-bit AMD64 or ARM64. +- For Windows-specifics, see the Developer Guide FAQ: https://docs.photoprism.app/developer-guide/faq/#can-your-development-environment-be-used-under-windows + +### CLI Binary Names + +The CLI name is `photoprism` in production and public docs. Other binary names (`photoprism-plus`, `photoprism-pro`, `photoprism-portal`) are only used in development builds for side-by-side comparisons. + +## Container Image Builds + +- **Pin the dev `Dockerfile` `FROM` to a dated `photoprism/develop` tag, never the floating codename.** Use `photoprism/develop:-` (e.g. `photoprism/develop:260520-resolute`), not `photoprism/develop:resolute` / `:latest` / `:ubuntu`. The dated tag pins to a known-good build so a drive-by `docker pull` doesn't silently swap in a fresh base mid-session, and bumping the date in a commit gives developers + reviewers a visible signal that a new base image is available. The `buildx-multi.sh` script publishes both `:` and `:-` on every build — the dated one is the durable pointer. When you bump the base image, also update `Dockerfile`, the host `compose.yaml` (if it references the tag explicitly), and any docs that quote the current dev image. +- **Never mix Debian and Ubuntu `apt` repositories in the same image:** + - Don't add a Debian source to an Ubuntu base (or vice versa) to install a single missing package — the transitive deps drift, apt's solver pulls newer libraries from the foreign distro, and other build steps in the same `RUN` (e.g. `install-libheif.sh` running `apt-get install libavcodec-dev`) silently link against the wrong soname. + - Symptoms surface much later as `dlopen: libfoo.so.N: cannot open shared object file` at image runtime, with the binary referencing a soname that exists only in the foreign distro. + - If a package isn't available in the host distro's repos, prefer (a) a same-distro PPA / backports source, (b) a vendor-supplied .deb (e.g. Google Chrome from `dl.google.com`), or (c) a from-source build pinned to a known version. diff --git a/.claude/rules/cluster-operations.md b/.claude/rules/cluster-operations.md new file mode 100644 index 000000000..a1641dc22 --- /dev/null +++ b/.claude/rules/cluster-operations.md @@ -0,0 +1,41 @@ +## Cluster Operations + +- Keep bootstrap decoupled: avoid importing `internal/service/cluster/node/*` from `internal/config` or the cluster root; nodes talk to the Portal over HTTP(S) using constants from `internal/service/cluster/const.go`. +- Bootstrap refreshes node OAuth credentials on 401/403 (rotate secret + retry, info-level log). If the secret file can't be written, the rotated value stays cached in memory so the current process continues. +- Portal validation accepts HTTP advertise URLs only for loopback or cluster-internal domains (`*.svc`, `*.cluster.local`, `*.internal`); everything else must use HTTPS. +- Theme endpoint: `GET /api/v1/cluster/theme` streams a zip from `conf.ThemePath()`; reinstall only when `app.js` is missing and always use the header helpers in `pkg/http/header`. +- Registration flow: send `rotate=true` only for MySQL/MariaDB nodes without credentials; treat 401/403/404 as terminal; include `ClientID` + `ClientSecret` when renaming an existing node; persist only newly generated secrets or DB settings. + +### Registry & DTOs + +- Use the client-backed registry (`NewClientRegistryWithConfig`) — the file-backed version is legacy. +- Nodes are keyed by UUID v7 (`/api/v1/cluster/nodes/{uuid}`); registry interface is UUID-first (`Get`, `FindByNodeUUID`, `FindByClientID`, `RotateSecret`, `DeleteAllByUUID`). CLI lookups resolve `uuid → ClientID → name`. +- DTOs normalize `Database.{Name,User,Driver,RotatedAt}`; `ClientSecret` is exposed only during creation/rotation. `nodes rm --all-ids` cleans duplicate client rows. `ClientData` no longer stores `NodeUUID`. +- Admin responses may include `AdvertiseUrl`/`Database`; client/user sessions stay redacted. +- Registry files live under `conf.PortalConfigPath()/nodes/` (mode 0600). + +### Provisioner & DSN + +- Database/user names use UUID-based HMACs (`d`, `u`; prefix defaults to `cluster_`). +- `BuildDSN` accepts a `driver` but falls back to MySQL format with a warning when unsupported. For Postgres, extend `BuildDSN` and `provisioner.DatabaseDriver` handling, add validations, and return `driver=postgres` consistently in API and CLI output. + +### Sessions & Redaction + +- Admin session (full view): `AuthenticateAdmin(app, router)`. +- User session: create a non-admin test user (role=guest), set a password, then `AuthenticateUser`. +- Client session (redacted internal fields; `SiteUrl` visible): + ```go + s, _ := entity.AddClientSession("test-client", conf.SessionMaxAge(), "cluster", authn.GrantClientCredentials, nil) + token := s.AuthToken() + r := AuthenticatedRequest(app, http.MethodGet, "/api/v1/cluster/nodes", token) + ``` +- Admins see `AdvertiseUrl` and `Database`; client/user sessions don't. `SiteUrl` is safe for all roles. Client config includes `storageNamespace` (SHA-256 of `SiteUrl`) for browser storage scoping. + +### Preflight Checklist + +- `go build ./...` +- `make fmt-go swag-fmt swag` +- `go test ./internal/service/cluster/registry -count=1` +- `go test ./internal/api -run 'Cluster' -count=1` +- `go test ./internal/commands -run 'ClusterRegister|ClusterNodesRotate' -count=1` +- Tooling: `make swag` may fetch modules — confirm network access before running. diff --git a/.claude/rules/code-comments.md b/.claude/rules/code-comments.md new file mode 100644 index 000000000..97cde32ff --- /dev/null +++ b/.claude/rules/code-comments.md @@ -0,0 +1,12 @@ +## JS/Go Code Comment Rules + +A doc comment is **required** for every function (including unexported helpers), as well as for every non-trivial Vue `methods:` / `computed:` / watcher: +- Keep comments **compact** and default to one line for "what" in the format `// Name does X.`. Skip trivial getters (`isOpen: () => this.open`). +- Add 1-2 follow-up lines (`// …`) **only** if the "why" is non-obvious: a hidden invariant, a workaround that would otherwise be undone by a future cleanup, a contract a reader can't infer from the code. If readers can infer the "why" from the function body or a nearby line, then omit it. +- Multi-paragraph explanations belong in `specs/`, package `README.md` files, or GitHub issues — never in the source itself. + +Doc comments for packages and exported identifiers must be complete sentences that begin with the name of the thing being described and end with a period. For short examples in comments, indent code instead of using backticks. + +Use US English spelling in all code comments (`parameterized`, `behavior`, `color`, `serialize`, `normalize`, `optimize`, …) — not the British `-ised`/`-our`/`-re` variants. + +> **Don't include in code comments:** Issue / PR numbers, "previously…" history, alternatives considered, what the function used to do, references to old commits, names of subsequent reviewers, or any narrative that names the change rather than the steady-state behavior. That context belongs in commit messages, specs, or handover notes. diff --git a/.claude/rules/commit-and-docs-style.md b/.claude/rules/commit-and-docs-style.md new file mode 100644 index 000000000..284073b74 --- /dev/null +++ b/.claude/rules/commit-and-docs-style.md @@ -0,0 +1,57 @@ +## Commit Messages + +Use concise, imperative subjects with a one-word prefix indicating the scope or topic: + +- `Config: Add tests for "darktable-cli" path detection` + +If the commit relates to specific issues or pull requests, reference their IDs in the message: + +- `Docker: Use two stage build to reduce image size #123 #5632` + +Commit messages must not exceed 80 characters in length. + +Do not add `Co-Authored-By: Claude …` trailers (or any other AI-authorship trailer) to commit messages. + +## GitHub Issues + +Issue titles MUST be concise, use the imperative mood, and start with a single capitalized prefix followed by a colon and a space, e.g. `Search: Add filter for RAW image formats`. + +Issue descriptions MUST begin with a one-sentence **User Story** in the format: `**As a , I want , so that .**` +Use level-3 Markdown headings for sections within issue descriptions, for example `### Acceptance Criteria`. +Follow the User Story with a clear summary of the expected behavior, rationale, technical considerations, and constraints. + +Descriptions MUST conclude with a checklist of **Acceptance Criteria**: +- Use GitHub checklist formatting: `- [ ]` +- Criteria MUST be clear, testable, and unambiguous. +- Each item MUST use one of the following requirement-level keywords: + - `MUST` — required for the issue to be considered complete + - `SHOULD` — strongly recommended but not strictly required + - `MAY` — optional enhancement +- Keep the checklist current: once the work for a criterion is implemented **and verified**, mark it done (`- [x]`). +- Leave items that are unverified, not yet implemented, or skipped optional (`MAY`) enhancements unchecked. +- An issue is complete only when every `MUST` is checked; never tick a box on the strength of a plan alone or an unrun test. +- When referencing an issue from a commit that fulfills some of its criteria, update the matching boxes first. + +> Agents MUST create, edit, close, reopen, relabel, or otherwise modify GitHub issues only when explicitly requested by the user. + +The repo's issue templates use the new GitHub `type:` property (`Bug`, `Feature`) instead of `bug`/`idea` labels. `gh issue create` does not yet accept a `--type` flag, so when filing issues programmatically use `--label` only and tell the user to set the issue type via the web UI. + +## Specifications & Documentation + +- Document headings use a **Chicago-style title case**, with additional code- and path-aware normalization rules (see below). Always spell the product name as `PhotoPrism`. +- When writing CLI examples or scripts, place option flags before positional arguments unless the command requires a different order. +- Use RFC 3339 UTC timestamps in request and response examples, and valid ID, UID and UUID examples in docs and tests. +- Technical specifications in the nested `specs/` subrepository may not be present in every clone or environment. Do not add `Makefile` targets in the main project that depend on `specs/` paths. + - Auto-generated configuration and command references live under `specs/generated/`. Agents MUST NOT read, analyze, or modify anything in this directory. + - Nested Git repositories may appear to be ignored; if so, change directories before staging or committing updates. +- **Never reference `specs/` paths from public artifacts** — issue bodies, PR descriptions, package READMEs (`frontend/README.md`, `internal/*/README.md`, etc.), top-level `CODEMAP.md`/`GLOSSARY.md`, code comments outside `specs/`. External readers see a 404 and the private subrepo's existence is leaked. Hints in `AGENTS.md` and `CLAUDE.md` files are the documented exception. Quick check: `grep -n "specs/" ` should return no matches before saving any public-facing file. + +> **Title Case** rules (Chicago-style headline capitalization, with code- and path-aware normalization): +> - Capitalize the first word, the first word after a colon, dash, or end punctuation, and all major words, including the second part of a hyphenated major word. +> - Lowercase only articles, short conjunctions, and short prepositions of three letters or fewer when they are not in one of those positions. +> - Preserve known acronyms (for example, API, CLI, HTTP, JSON) and slash-separated acronym groups (for example, CSV/TSV) as uppercase. +> - Preserve RFC 2119 / RFC 8174 normative keywords (MUST, SHOULD, MAY, SHALL, REQUIRED, RECOMMENDED, OPTIONAL) as uppercase when used in their normative sense. +> - Preserve inline code spans (`` `foo` ``), file paths (e.g. `docs/foo-bar.md`), and slash commands (e.g. `/grill-me`) verbatim; do not recase their contents. +> - Use `&` instead of `And`/`Or` in headings. + +> Refresh the `**Last Updated:**` date at the top of documents whenever you make changes to their contents, using the format `January 20, 2026` (without time); leave it as-is for simple formatting or whitespace-only edits. diff --git a/.claude/rules/frontend-rules.md b/.claude/rules/frontend-rules.md new file mode 100644 index 000000000..982f2e9f7 --- /dev/null +++ b/.claude/rules/frontend-rules.md @@ -0,0 +1,77 @@ +## Frontend Code Style & Test Coverage + +- **Comments:** Follow the code comment rules in `code-comments.md`. +- **Tests:** Test new JS functions (including helpers) and new Vue components whenever practical; update existing tests when behavior changes. When a unit test is impractical (DOM-heavy flows, third-party widget integration), the doc comment is still mandatory — it's the minimum bar. +- **State:** Shared state lives in reactive singleton modules under `src/common/` and `src/app/` (e.g., `app/session.js`, `common/config.js`, `common/clipboard.js`, `common/log.js`) that export a `reactive()` / `ref()` object directly; components access them via `import` or via the globally-installed `$config` / `$session` plugins. Do not introduce Vuex, Pinia, or new ad-hoc stores — extend an existing singleton or add a new one alongside its peers in `common/` or `app/`. +- **Vue/Vuetify:** Use the Options API in Vue components (consistent with the rest of the codebase); do not introduce Composition API or ` diff --git a/frontend/src/component/components.js b/frontend/src/component/components.js index 59023c6a8..e14b30310 100644 --- a/frontend/src/component/components.js +++ b/frontend/src/component/components.js @@ -6,7 +6,7 @@ import PUpdate from "component/update.vue"; import PLoading from "component/loading.vue"; import PLoadingBar from "component/loading-bar.vue"; import PLightboxMenu from "component/lightbox/menu.vue"; -import PSidebarInfo from "component/sidebar/info.vue"; +import PLightboxSidebar from "component/lightbox/sidebar.vue"; import PMap from "component/map.vue"; import PLightbox from "component/lightbox.vue"; @@ -68,6 +68,9 @@ import PPhotoArchiveDialog from "component/photo/archive/dialog.vue"; import PPhotoAlbumDialog from "component/photo/album/dialog.vue"; import PPhotoEditDialog from "component/photo/edit/dialog.vue"; +// Meta. +import PMetaFaceMarkers from "component/meta/face/markers.vue"; + // Upload. import PUploadDialog from "component/upload/dialog.vue"; @@ -86,7 +89,7 @@ export function install(app) { app.component("PLoading", PLoading); app.component("PLoadingBar", PLoadingBar); app.component("PLightboxMenu", PLightboxMenu); - app.component("PSidebarInfo", PSidebarInfo); + app.component("PLightboxSidebar", PLightboxSidebar); app.component("PMap", PMap); app.component("PLightbox", PLightbox); @@ -134,6 +137,9 @@ export function install(app) { app.component("PPhotoArchiveDialog", PPhotoArchiveDialog); app.component("PPhotoAlbumDialog", PPhotoAlbumDialog); app.component("PPhotoEditDialog", PPhotoEditDialog); + + app.component("PMetaFaceMarkers", PMetaFaceMarkers); + app.component("PUploadDialog", PUploadDialog); app.component("PServiceAdd", PServiceAdd); diff --git a/frontend/src/component/confirm/dialog.vue b/frontend/src/component/confirm/dialog.vue index ea74addf2..3c9f3d835 100644 --- a/frontend/src/component/confirm/dialog.vue +++ b/frontend/src/component/confirm/dialog.vue @@ -15,14 +15,14 @@ > - +
{{ text ? text : $gettext(`Are you sure?`) }}
 {{ $gettext(`Cancel`) }} - + {{ action ? action : $gettext(`Yes`) }} @@ -53,6 +53,10 @@ export default { type: String, default: "", }, + confirmColor: { + type: String, + default: "highlight", + }, }, emits: ["close", "confirm"], data() { diff --git a/frontend/src/component/confirm/sponsor.vue b/frontend/src/component/confirm/sponsor.vue index 42fd42bef..de106e59b 100644 --- a/frontend/src/component/confirm/sponsor.vue +++ b/frontend/src/component/confirm/sponsor.vue @@ -58,6 +58,7 @@ export default { default: false, }, }, + emits: ["close"], data() { return { links, diff --git a/frontend/src/component/defaults.js b/frontend/src/component/defaults.js index 3e63e64a2..0fe136e3d 100644 --- a/frontend/src/component/defaults.js +++ b/frontend/src/component/defaults.js @@ -1,3 +1,5 @@ +import $util from "common/util"; + export default { global: { ripple: false, @@ -83,6 +85,12 @@ export default { validateOn: "invalid-input", hideDetails: "auto", }, + VTooltip: { + openDelay: 0, + closeDelay: 0, + disabled: $util.isMobile(), + transition: false, + }, VMenu: { origin: "auto", location: "bottom end", @@ -176,7 +184,8 @@ export default { ripple: false, }, VDataTable: { - color: "background", + // Forwarded to the footer only as the "items per page" select's active-item color (not the table). + color: "surface-variant", itemsPerPage: -1, hover: true, }, diff --git a/frontend/src/component/file/clipboard.vue b/frontend/src/component/file/clipboard.vue index a13a0bacf..03a330e00 100644 --- a/frontend/src/component/file/clipboard.vue +++ b/frontend/src/component/file/clipboard.vue @@ -120,7 +120,7 @@ export default { Promise.all(uniqueAlbumUids.map((uid) => $api.post(`albums/${uid}/photos`, body))) .then(() => this.onAdded()) - .catch((error) => { + .catch(() => { $notify.error(this.$gettext("Some albums could not be updated")); }); }, diff --git a/frontend/src/component/file/delete/dialog.vue b/frontend/src/component/file/delete/dialog.vue index 494ef0038..fb524a7d6 100644 --- a/frontend/src/component/file/delete/dialog.vue +++ b/frontend/src/component/file/delete/dialog.vue @@ -34,6 +34,7 @@ export default { default: false, }, }, + emits: ["close", "confirm"], data() { return {}; }, diff --git a/frontend/src/component/input/chip-selector.vue b/frontend/src/component/input/chip-selector.vue index 2dd8a6d99..f20a80d8d 100644 --- a/frontend/src/component/input/chip-selector.vue +++ b/frontend/src/component/input/chip-selector.vue @@ -6,7 +6,6 @@ :key="item.value || item.title" :text="getChipTooltip(item)" location="top" - :disabled="$vuetify?.display?.mobile === true" > @@ -51,7 +50,6 @@ class="chip-selector__input" @click:control="focusInput" @keydown.enter.prevent="onEnter" - @blur="addNewItem" @update:model-value="onComboboxChange" @update:menu="onMenuUpdate" > @@ -107,6 +105,10 @@ export default { type: Function, default: null, }, + maxLength: { + type: Number, + default: 0, + }, }, emits: ["update:items"], data() { @@ -142,7 +144,7 @@ export default { if (typeof this.normalizeTitleForCompare === "function") { try { return this.normalizeTitleForCompare(input); - } catch (e) { + } catch { return input.toLowerCase(); } } @@ -158,22 +160,28 @@ export default { } if (item.action === "add") { - classes.push(item.mixed ? `${baseClass}--green-light` : `${baseClass}--green`); + classes.push(item.mixed ? `${baseClass}--add-mixed` : `${baseClass}--add`); } else if (item.action === "remove") { - classes.push(item.mixed ? `${baseClass}--red-light` : `${baseClass}--red`); + classes.push(item.mixed ? `${baseClass}--remove-mixed` : `${baseClass}--remove`); } else if (item.mixed) { - classes.push(`${baseClass}--gray-light`); + classes.push(`${baseClass}--default-mixed`); } else { - classes.push(`${baseClass}--gray`); + classes.push(`${baseClass}--default`); } return classes; }, getChipIcon(item) { - if (item.action === "add") return "mdi-plus"; - if (item.action === "remove") return "mdi-minus"; - if (item.mixed) return "mdi-circle-half-full"; + if (item.action === "add") { + return "mdi-plus"; + } + if (item.action === "remove") { + return "mdi-minus"; + } + if (item.mixed) { + return "mdi-circle-half-full"; + } return null; }, @@ -189,7 +197,9 @@ export default { }, handleChipClick(item) { - if (this.loading || this.disabled) return; + if (this.loading || this.disabled) { + return; + } let newAction; @@ -256,14 +266,28 @@ export default { return; } - if (!title) return; + if (!title) { + return; + } + + // Block the create path when the typed title exceeds the configured cap — + // otherwise the backend setter clips with an ellipsis and the user is + // shown a green success against a renamed entity they didn't intend. + if (this.maxLength > 0 && title.length > this.maxLength) { + this.$notify.error(this.$gettext("%{s} is too long", { s: this.$gettext("Name") })); + return; + } let resolvedApplied = false; if (typeof this.resolveItemFromText === "function") { const resolved = this.resolveItemFromText(title); if (resolved && typeof resolved === "object") { - if (resolved.title) title = resolved.title; - if (resolved.value) value = resolved.value; + if (resolved.title) { + title = resolved.title; + } + if (resolved.value) { + value = resolved.value; + } resolvedApplied = true; } } diff --git a/frontend/src/component/label/clipboard.vue b/frontend/src/component/label/clipboard.vue index bcb5a2c92..8ba81c07f 100644 --- a/frontend/src/component/label/clipboard.vue +++ b/frontend/src/component/label/clipboard.vue @@ -111,7 +111,7 @@ export default { Promise.all(uniqueAlbumUids.map((uid) => $api.post(`albums/${uid}/photos`, body))) .then(() => this.onAdded()) - .catch((error) => { + .catch(() => { $notify.error(this.$gettext("Some albums could not be updated")); }); }, diff --git a/frontend/src/component/label/delete/dialog.vue b/frontend/src/component/label/delete/dialog.vue index 97bf7104c..b0e2c1408 100644 --- a/frontend/src/component/label/delete/dialog.vue +++ b/frontend/src/component/label/delete/dialog.vue @@ -34,6 +34,7 @@ export default { default: false, }, }, + emits: ["close", "confirm"], data() { return {}; }, diff --git a/frontend/src/component/label/edit/dialog.vue b/frontend/src/component/label/edit/dialog.vue index fd40c055a..3f26ba2d6 100644 --- a/frontend/src/component/label/edit/dialog.vue +++ b/frontend/src/component/label/edit/dialog.vue @@ -13,18 +13,21 @@ > - - mdi-label -
{{ $gettext(`Edit %{s}`, { s: model.modelName() }) }}
- + + + {{ $gettext(`Edit %{s}`, { s: model.modelName() }) }} + + + mdi-close + + diff --git a/frontend/src/component/lightbox/sidebar/toolbar.vue b/frontend/src/component/lightbox/sidebar/toolbar.vue new file mode 100644 index 000000000..b9f4d497e --- /dev/null +++ b/frontend/src/component/lightbox/sidebar/toolbar.vue @@ -0,0 +1,71 @@ + + + diff --git a/frontend/src/component/loading-bar.vue b/frontend/src/component/loading-bar.vue index 891ee6c51..c24f646b7 100644 --- a/frontend/src/component/loading-bar.vue +++ b/frontend/src/component/loading-bar.vue @@ -168,7 +168,7 @@ export default { }, methods: { - beforeEnter(el) { + beforeEnter() { this.opacity = 0; this.progress = 0; this.width = 0; @@ -179,7 +179,7 @@ export default { done(); }, - afterEnter(el) { + afterEnter() { this._runStart(); }, diff --git a/frontend/src/component/map.vue b/frontend/src/component/map.vue index 38f13b154..a6d361a9a 100644 --- a/frontend/src/component/map.vue +++ b/frontend/src/component/map.vue @@ -1,5 +1,5 @@ diff --git a/frontend/src/component/meta/datetime/dialog.vue b/frontend/src/component/meta/datetime/dialog.vue new file mode 100644 index 000000000..4106308cd --- /dev/null +++ b/frontend/src/component/meta/datetime/dialog.vue @@ -0,0 +1,331 @@ + + + diff --git a/frontend/src/component/meta/face/markers.vue b/frontend/src/component/meta/face/markers.vue new file mode 100644 index 000000000..70e9b038b --- /dev/null +++ b/frontend/src/component/meta/face/markers.vue @@ -0,0 +1,1086 @@ + + + diff --git a/frontend/src/component/location/dialog.vue b/frontend/src/component/meta/location/dialog.vue similarity index 92% rename from frontend/src/component/location/dialog.vue rename to frontend/src/component/meta/location/dialog.vue index 2ebb00b46..c48f35602 100644 --- a/frontend/src/component/location/dialog.vue +++ b/frontend/src/component/meta/location/dialog.vue @@ -7,24 +7,20 @@ persistent scrim scrollable - class="p-location-dialog" - @keydown.esc.exact="close" + class="p-meta-location-dialog" + @keydown.esc.exact.stop="close" @after-enter="afterEnter" @after-leave="afterLeave" > - - - mdi-close - + {{ $gettext("Adjust Location") }} + + mdi-close + - - mdi-map-marker -
{{ $gettext("Adjust Location") }}
-
@@ -69,8 +65,9 @@ clearable autocomplete="off" no-filter - menu-icon="" + :menu-icon="null" :menu-props="{ maxHeight: 300 }" + :list-props="{ density: 'compact' }" @update:search="onSearchQueryChange" @update:model-value="onPlaceSelected" @click:clear="clearSearch" @@ -78,12 +75,12 @@ @@ -101,7 +98,7 @@
- + >
@@ -118,9 +115,10 @@ {{ $gettext("Cancel") }} diff --git a/frontend/src/component/upload/dialog.vue b/frontend/src/component/upload/dialog.vue index 17ed416a2..ac01fb71f 100644 --- a/frontend/src/component/upload/dialog.vue +++ b/frontend/src/component/upload/dialog.vue @@ -12,20 +12,15 @@ @keydown.esc.exact="onClose" > - - - - mdi-close - + {{ title }} + + mdi-close + - - mdi-cloud-upload -
{{ title }}
-
@@ -35,27 +30,42 @@ {{ $gettext(`Upload complete. Indexing…`) }} {{ $gettext(`Done.`) }} - {{ $gettext(`Insufficient storage.`) }} {{ $gettext(`Increase storage size or delete files to continue.`) }} - {{ $gettext(`Select the files to upload…`) }} + {{ $gettext(`Select the files to upload…`) }} + {{ $gettext(`Select or drop files to upload…`) }}
+ @@ -108,8 +118,14 @@ {{ $gettext(`Close`) }} - - {{ $gettext(`Browse`) }} + + {{ $gettext(`Upload`) }} @@ -121,6 +137,7 @@ import $api from "common/api"; import $notify from "common/notify"; import Album from "model/album"; import { createAlbumSelectionWatcher } from "common/albums"; +import { $gettext } from "common/gettext"; import { Duration } from "luxon"; export default { @@ -150,7 +167,7 @@ export default { loading: false, indexing: false, failed: false, - filesQuotaReached: this.$config.filesQuotaReached(), + insufficientStorage: this.$config.insufficientStorage(), current: 0, total: 0, totalSize: 0, @@ -172,6 +189,9 @@ export default { title() { return this.$gettext(`Upload`); }, + hasFiles() { + return Array.isArray(this.selected) && this.selected.length > 0; + }, }, watch: { visible: function (show) { @@ -287,8 +307,33 @@ export default { this.albumsMenu = false; this.suppressAlbumsMenuOpen = false; }, - onUploadDialog() { - this.$refs.upload.click(); + onFilesSelected(newFiles) { + const newArr = Array.isArray(newFiles) ? newFiles : newFiles ? [newFiles] : []; + const existing = Array.isArray(this.selected) ? this.selected : []; + + // Clear: empty array from the clearable button or a reset. + if (newArr.length === 0) { + this.selected = []; + return; + } + + // Remove: every file in the new set is already present by reference → + // this is a single-item removal emitted by VFileUploadItem's × button. + if (newArr.every((f) => existing.includes(f))) { + this.selected = newArr; + return; + } + + // Browse / drop: merge with existing selection, skip duplicates + // identified by name + size + lastModified so re-selecting the same + // file on a second browse pass does not add a second entry. + const merged = [...existing]; + for (const f of newArr) { + if (!merged.some((e) => e.name === f.name && e.size === f.size && e.lastModified === f.lastModified)) { + merged.push(f); + } + } + this.selected = merged; }, onUploadProgress(ev) { if (!ev || !ev.loaded || !ev.total) { @@ -335,25 +380,19 @@ export default { return; } - const files = this.$refs.upload.files; - // Too many files selected for upload? - if (this.isDemo && files && files.length > this.fileLimit) { + if (this.isDemo && this.selected && this.selected.length > this.fileLimit) { $notify.error(this.$gettext("Too many files selected")); return; } - this.selected = files; - this.total = files.length; - // No files selected? - if (!this.selected || this.total < 1) { + if (!this.selected || this.selected.length < 1) { return; } this.uploads = []; this.token = this.$util.generateToken(); - this.selected = this.$refs.upload.files; this.busy = true; this.indexing = false; this.failed = false; @@ -437,12 +476,12 @@ export default { }) .then(() => { ctx.reset(); - $notify.success(ctx.$gettext("Upload complete")); + $notify.success($gettext("Upload complete")); ctx.$emit("confirm"); }) .catch(() => { ctx.reset(); - $notify.error(ctx.$gettext("Upload failed")); + $notify.error($gettext("Upload failed")); }); }); }, diff --git a/frontend/src/css/app.css b/frontend/src/css/app.css index 04f5f5a59..dfbf9086b 100644 --- a/frontend/src/css/app.css +++ b/frontend/src/css/app.css @@ -1,6 +1,6 @@ /* -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -13,7 +13,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - + Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. @@ -28,6 +28,7 @@ Additional information can be found in our Developer Guide: @import url("root.css"); @import url("splash.css"); @import url("text.css"); +@import url("meta.css"); @import url("lightbox.css"); @import url("controls.css"); @import url("wallpapers.css"); diff --git a/frontend/src/css/auth.css b/frontend/src/css/auth.css index cfc13e2a4..861bd661f 100644 --- a/frontend/src/css/auth.css +++ b/frontend/src/css/auth.css @@ -16,46 +16,18 @@ main .auth-login { /* Auth Form Colors */ -main .auth-login .accent { - background-color: #05dde1 !important; -} - -main .auth-login .accent--text { - caret-color: #05dde1 !important; - color: #05dde1 !important; -} - -main .auth-login .primary { - background-color: #00a6a9 !important; -} - -main .auth-login .primary--text { - caret-color: #00a6a9 !important; - color: #00a6a9 !important; -} - -main .auth-login .secondary { - background-color: #505050 !important; -} - -main .auth-login .secondary--text { - caret-color: #505050 !important; - color: #505050 !important; -} - -main .auth-login .link { - background-color: #c8e3e7 !important; -} - -main .auth-login .link--text { - caret-color: #c8e3e7 !important; - color: #c8e3e7 !important; -} - main .auth-actions .auth-links { min-height: 24px; } +main .auth-actions__options { + opacity: 0.95; + padding-bottom: 4px; + align-items: center; + justify-content: center; + display: flex; +} + main .auth-login a, main .auth-login .clickable { color: rgb(var(--v-theme-secondary, #c8e3e7)); @@ -176,6 +148,45 @@ main .auth-login .text-subtitle-2, margin: 0; } +/* Instance Chooser */ + +main .auth-login .instance-results.v-table { + background: transparent; +} + +main .auth-login .instance-results .v-table__wrapper > table > thead > tr > th { + background: transparent !important; + border-bottom: 1px solid rgba(255, 255, 255, 0.16) !important; + font-size: 0.72rem; + letter-spacing: 0.04em; + text-transform: uppercase; + color: rgba(255, 255, 255, 0.6) !important; +} + +main .auth-login .instance-results .v-table__wrapper > table > tbody > tr > td { + background: transparent !important; + border-bottom: 1px solid rgba(255, 255, 255, 0.08) !important; + color: #ffffff; +} + +main .auth-login .instance-results .v-table__wrapper > table > tbody > tr:last-child > td { + border-bottom: none !important; +} + +main .auth-login .instance-chooser-row { + cursor: pointer; +} + +main .auth-login .instance-results .action-open-instance { + font-weight: 500; + color: rgb(var(--v-theme-secondary, #c8e3e7)); + cursor: pointer; +} + +main .auth-login .instance-results .instance-url { + color: rgba(255, 255, 255, 0.6); +} + /* Account Page */ .user-avatar { diff --git a/frontend/src/css/chip-selector.css b/frontend/src/css/chip-selector.css index a8875e165..8bc8acd45 100644 --- a/frontend/src/css/chip-selector.css +++ b/frontend/src/css/chip-selector.css @@ -1,112 +1,130 @@ /* Chip Selector Styles */ .chip-selector { - display: flex; - flex-direction: column; - gap: 12px; + display: flex; + flex-direction: column; + gap: 12px; } .chip-selector__title { - font-weight: 500; - font-size: 14px; - color: rgba(var(--v-theme-on-surface), 0.87); - margin-bottom: 8px; + font-weight: 500; + font-size: 14px; + color: rgba(var(--v-theme-on-surface), 0.87); + margin-bottom: 8px; } .chip-selector__chips { - display: flex; - flex-wrap: wrap; - gap: 8px; - min-height: 40px; - align-items: flex-start; + display: flex; + flex-wrap: wrap; + gap: 8px; + min-height: 40px; + align-items: flex-start; } .chip-selector__input-container { - margin-top: 8px; + margin-top: 8px; } .chip-selector__input { - width: 100%; + width: 100%; } /* Chip Styles */ .chip { - display: inline-flex; - align-items: center; - padding: 6px 12px; - border-radius: 16px; - font-size: 13px; - font-weight: 500; - cursor: pointer; - user-select: none; - min-height: 32px; - transition: all 0.2s ease; + display: inline-flex; + align-items: center; + padding: 6px 12px; + border-radius: 16px; + font-size: 13px; + font-weight: 500; + cursor: pointer; + user-select: none; + min-height: 32px; + max-width: 100%; + min-width: 0; + transition: all 0.2s ease; } .chip__content { - display: flex; - align-items: center; - gap: 6px; + display: flex; + align-items: center; + gap: 6px; + min-width: 0; + max-width: 100%; } .chip__icon { - font-size: 16px; - opacity: 0.9; + font-size: 16px; + opacity: 0.9; + flex-shrink: 0; } -/* Chip States */ -.chip--gray { - background-color: rgb(var(--v-theme-secondary-light, var(--v-theme-surface-bright, var(--v-theme-surface)))); - color: rgb(var(--v-theme-on-surface)); - box-shadow: inset 0 0 0 1px rgba(var(--v-theme-on-surface), 0.12); +/* Allow the label to shrink within the chip's inline-flex layout so + Vuetify's `text-truncate` (overflow + ellipsis + nowrap) can engage on + single-word titles like `WWWWWWW…`; the chip itself is constrained by + `max-width: 100%` against its flex-wrap parent. */ +.chip__text { + min-width: 0; } -.chip--gray-light { - background-color: rgba(var(--v-theme-secondary-light, var(--v-theme-surface-bright, var(--v-theme-surface))), 0.55); - color: rgb(var(--v-theme-on-surface)); - box-shadow: inset 0 0 0 1px rgba(var(--v-theme-on-surface), 0.12); +/* Chip States — class names mirror the `item.action` value the chip-selector + emits (`add` / `remove` / default), and `--mixed` is the partial-selection + variant (action applies to only some of the selected items). Selectors are + doubled (`.chip.chip--*`) so the `color` rules out-rank the UA-level + `[role="button"] { color: inherit }` reset, which would otherwise strip the + on-token foreground from a solid chip rendered as a button. */ +.chip.chip--default { + background-color: rgb(var(--v-theme-secondary-light, var(--v-theme-surface-bright, var(--v-theme-surface)))); + color: rgb(var(--v-theme-on-surface)); + box-shadow: inset 0 0 0 1px rgba(var(--v-theme-on-surface), 0.12); } -.chip--green { - background-color: rgb(var(--v-theme-download)); - color: rgb(var(--v-theme-on-download)); +.chip.chip--default-mixed { + background-color: rgba(var(--v-theme-secondary-light, var(--v-theme-surface-bright, var(--v-theme-surface))), 0.55); + color: rgb(var(--v-theme-on-surface)); + box-shadow: inset 0 0 0 1px rgba(var(--v-theme-on-surface), 0.12); } -.chip--green-light { - background-color: rgba(var(--v-theme-download), 0.3); - color: rgb(var(--v-theme-download)); +.chip.chip--add { + background-color: rgba(var(--v-theme-add), 0.8); + color: rgb(var(--v-theme-on-add)); } -.chip--red { - background-color: rgb(var(--v-theme-error)); - color: rgb(var(--v-theme-on-error)); +.chip.chip--add-mixed { + background-color: rgba(var(--v-theme-add-darken-1), 0.45); + color: rgb(var(--v-theme-on-add)); } -.chip--red-light { - background-color: rgba(var(--v-theme-error), 0.3); - color: rgb(var(--v-theme-error)); +.chip.chip--remove { + background-color: rgba(var(--v-theme-remove), 0.8); + color: rgb(var(--v-theme-on-remove)); +} + +.chip.chip--remove-mixed { + background-color: rgba(var(--v-theme-remove-darken-1), 0.45); + color: rgb(var(--v-theme-on-remove)); } /* Empty state */ .chip-selector__empty { - padding: 16px; - text-align: center; - color: rgba(var(--v-theme-on-surface), 0.6); - font-style: italic; + padding: 16px; + text-align: center; + color: rgba(var(--v-theme-on-surface), 0.6); + font-style: italic; } /* Mobile optimizations */ @media (max-width: 600px) { - .chip-selector__chips { - gap: 6px; - } - - .chip { - padding: 4px 8px; - font-size: 12px; - min-height: 28px; - } - - .chip__icon { - font-size: 14px; - } + .chip-selector__chips { + gap: 6px; + } + + .chip { + padding: 4px 8px; + font-size: 12px; + min-height: 28px; + } + + .chip__icon { + font-size: 14px; + } } diff --git a/frontend/src/css/controls.css b/frontend/src/css/controls.css index d038e8ba6..452cce89a 100644 --- a/frontend/src/css/controls.css +++ b/frontend/src/css/controls.css @@ -256,6 +256,12 @@ table td > .action-buttons { padding: 8px; } +.nav-user-menu__icon { + width: 24px; + height: 24px; + object-fit: contain; +} + .v-menu.action-menu .action-menu__list .action-menu__shortcut { margin-inline-start: 0.75rem; opacity: 0.5; @@ -281,3 +287,15 @@ table .table-actions { gap: 12px; } } + +/* Portal Cluster Access: the label-less in-table role selector. Pin it to the + standard label-less input height (it would otherwise collapse to the text + line) and inset the selected value so it is not flush against the cell edge. */ + +.instance-role-select .v-field { + min-height: 40px; +} + +.instance-role-select .v-field__input { + padding-inline-start: 12px !important; +} diff --git a/frontend/src/css/lightbox.css b/frontend/src/css/lightbox.css index 5245f6266..1d6c6dc80 100644 --- a/frontend/src/css/lightbox.css +++ b/frontend/src/css/lightbox.css @@ -1,4 +1,4 @@ -/* Media Viewer Styles */ +/* Lightbox Styles */ .p-lightbox { position: fixed; @@ -67,7 +67,14 @@ z-index: 1; } -/* Sidebar Info */ +/* Lightbox Tooltips */ + +.v-tooltip.v-theme--lightbox > .v-overlay__content { + background: rgba(var(--v-theme-surface), var(--v-medium-emphasis-opacity)); + color: rgb(var(--v-theme-on-surface)); +} + +/* Lightbox Sidebar */ .p-lightbox__container > .p-lightbox__sidebar { position: relative; @@ -114,23 +121,314 @@ user-select: text; } +/* Reset Vuetify's `v-list nav` cursor:pointer on non-clickable rows so the + browser picks context-appropriate cursors (text I-beam, link pointer). */ +.p-lightbox__container > .p-lightbox__sidebar .metadata__item:not(.clickable) { + cursor: auto; +} + +.p-lightbox__container > .p-lightbox__sidebar .metadata__item .v-list-item-title, +.p-lightbox__container > .p-lightbox__sidebar .metadata__item .v-list-item-subtitle { + white-space: normal; + overflow: visible; + text-overflow: unset; +} + .p-lightbox__container > .p-lightbox__sidebar .meta-title { font-weight: 700; word-wrap: normal; word-break: break-word; - text-align: start; hyphens: auto; } -.p-lightbox__container > .p-lightbox__sidebar .meta-caption { +.p-lightbox__container > .p-lightbox__sidebar .meta-caption, +.p-lightbox__container > .p-lightbox__sidebar .meta-notes { white-space: pre-wrap; overflow-wrap: normal; word-wrap: normal; word-break: break-word; - text-align: start; hyphens: auto; } +.p-lightbox__container > .p-lightbox__sidebar .meta-scrollable { + max-height: 120px; + overflow-y: auto; + overflow-x: hidden; + scrollbar-width: thin; + scrollbar-color: rgba(var(--v-theme-on-surface), 0.2) transparent; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-scrollable.meta-caption { + max-height: 320px; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-scrollable::-webkit-scrollbar { + width: 4px; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-scrollable::-webkit-scrollbar-track { + background: transparent; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-scrollable::-webkit-scrollbar-thumb { + background: rgba(var(--v-theme-on-surface), 0.2); + border-radius: 2px; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-scrollable::-webkit-scrollbar-thumb:hover { + background: rgba(var(--v-theme-on-surface), 0.4); +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-keywords { + word-break: break-word; + text-align: start; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-chip { + display: inline-flex; + align-items: center; + padding: 6px 12px; + border-radius: 16px; + font-size: 13px; + font-weight: 500; + line-height: 1.4; + cursor: pointer; + user-select: none; + min-height: 32px; + max-width: 100%; + min-width: 0; + transition: all 0.2s ease; + background-color: rgb(var(--v-theme-secondary-light, var(--v-theme-surface-bright, var(--v-theme-surface)))); + color: rgb(var(--v-theme-on-surface)); + box-shadow: inset 0 0 0 1px rgba(var(--v-theme-on-surface), 0.12); +} + +/* Allow the label to shrink within the chip's inline-flex layout so + Vuetify's `text-truncate` (overflow + ellipsis + nowrap) can engage on + single-word titles like `WWWWWWW…`; the chip itself is constrained by + `max-width: 100%` against its flex-wrap parent. */ +.p-lightbox__container > .p-lightbox__sidebar .meta-chip__label { + min-width: 0; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-chip:hover { + background-color: rgba(var(--v-theme-secondary-light, var(--v-theme-surface-bright, var(--v-theme-surface))), 0.7); +} + +/* Keyboard focus ring drawn inside the chip (negative offset) so it isn't + clipped when chips wrap against the sidebar edge. */ +.p-lightbox__container > .p-lightbox__sidebar .meta-chip:focus { + outline: 2px solid rgba(var(--v-theme-on-surface), 0.5); + outline-offset: -2px; +} + +/* Suppress the ring on mouse focus where supported; click on a chip already + navigates or toggles, so a transient outline there is just visual noise. */ +.p-lightbox__container > .p-lightbox__sidebar .meta-chip:focus:not(:focus-visible) { + outline: none; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-chip--primary { + background-color: rgb(var(--v-theme-secondary-light, var(--v-theme-surface-bright, var(--v-theme-surface)))); + color: rgb(var(--v-theme-on-surface)); + box-shadow: inset 0 0 0 1px rgba(var(--v-theme-on-surface), 0.12); +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-chip--primary:hover { + background-color: rgba(var(--v-theme-secondary-light, var(--v-theme-surface-bright, var(--v-theme-surface))), 0.7); +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-chip .v-icon { + opacity: 0.7; + cursor: pointer; + flex-shrink: 0; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-chip .v-icon:hover { + opacity: 1; +} + +/* Lightweight native icon buttons (B1: clickable controls are real buttons + for keyboard activation + focus ring + button role) used inside bespoke + chrome where Vuetify's box model would fight the compact layout. */ +.p-lightbox__container .meta-icon-btn { + -webkit-appearance: none; + appearance: none; + display: inline-flex; + align-items: center; + justify-content: center; + flex-shrink: 0; + margin: 0; + padding: 0; + border: 0; + background: transparent; + color: inherit; + font: inherit; + line-height: 0; + cursor: pointer; +} + +.p-lightbox__container .meta-icon-btn:focus-visible { + outline: 2px solid currentColor; + outline-offset: 2px; + border-radius: 50%; +} + +.p-lightbox__container .meta-icon-btn:disabled { + cursor: default; + opacity: 0.5; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-chip__remove:hover .v-icon { + opacity: 1; +} + +/* Person row in sidebar */ +.p-lightbox__container > .p-lightbox__sidebar .metadata__person-row { + min-height: 44px; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-person__avatar { + width: 40px; + height: 40px; + border-radius: 8px; + object-fit: cover; + margin-right: 12px; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-person__name { + font-size: 14px; + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; +} + +/* Inline edit fields in sidebar */ +.p-lightbox__container > .p-lightbox__sidebar .meta-inline-edit { + margin: 0; +} + +.p-lightbox__container > .p-lightbox__sidebar .v-input--density-compact { + /* Sets the v-text-field control height and the floor for auto-grown + textareas. Do not add `min-height` on .v-field__input — it would + shadow Vuetify's auto-grow inheritance and freeze textareas at 36 px. */ + --v-input-control-height: 36px; +} + +.p-lightbox__container > .p-lightbox__sidebar .v-input--density-compact .v-field { + --v-field-input-padding-top: 6px; + --v-field-input-padding-bottom: 6px; + --v-field-padding-start: 10px; + --v-field-padding-end: 10px; + --v-field-padding-after: 0; + --v-field-padding-top: 6px; + --v-field-padding-bottom: 6px; + padding-inline-end: 4px; +} + +.p-lightbox__container > .p-lightbox__sidebar .v-input--density-compact .v-field .v-field__input { + font-size: 0.875rem; +} + +/* Thin themed scrollbar for textareas; legible against the dark surface on + Firefox/Chromium. Do not unset min-height — see the comment above. */ +.p-lightbox__container > .p-lightbox__sidebar .meta-inline-edit textarea.v-field__input { + scrollbar-width: thin; + scrollbar-color: rgba(var(--v-theme-on-surface), 0.2) transparent; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-inline-edit textarea.v-field__input::-webkit-scrollbar { + width: 4px; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-inline-edit textarea.v-field__input::-webkit-scrollbar-thumb { + background: rgba(var(--v-theme-on-surface), 0.2); + border-radius: 2px; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-inline-title .v-field__input { + font-weight: 700; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-inline-caption .v-field__input { + white-space: pre-wrap; + overflow-wrap: normal; + word-wrap: normal; + word-break: break-word; +} + +/* Drop Vuetify's top fade-mask on auto-grown inline textareas — without + a scroll viewport, the mask just dims the first line of text. */ +.p-lightbox__container > .p-lightbox__sidebar .meta-inline-edit .v-field__input, +.p-lightbox__container > .p-lightbox__sidebar .meta-inline-edit .v-textarea__sizer { + mask-image: none; +} + +/* Pencil button: hidden by default, revealed on list-item hover. */ +.p-lightbox__container > .p-lightbox__sidebar .meta-inline-pencil { + display: none; +} + +.p-lightbox__container > .p-lightbox__sidebar .metadata__item:hover > .v-list-item__append .meta-inline-pencil { + display: inline-flex; +} + +/* `.hide-edit-pencils` on the sidebar root hides every pencil even on hover; + row clicks and chip-toolbar Save/Undo remain reachable. */ +.p-lightbox__container > .p-lightbox__sidebar > .p-lightbox-sidebar.hide-edit-pencils .metadata__item:hover > .v-list-item__append .meta-inline-pencil, +.p-lightbox__container > .p-lightbox__sidebar > .p-lightbox-sidebar.hide-edit-pencils .meta-inline-pencil { + display: none; +} + +/* Hide inline-text Undo/Save (keyboard covers commit/cancel/revert); chip + toolbars opt out via `meta-chip-*`. Keep `:not()` on the hide rule itself + so the minifier doesn't collapse it into `:is()` and break the combinator. */ +.p-lightbox__container > .p-lightbox__sidebar > .p-lightbox-sidebar.hide-edit-undo .meta-inline-undo:not(.meta-chip-undo) { + display: none; +} + +.p-lightbox__container > .p-lightbox__sidebar > .p-lightbox-sidebar.hide-edit-save .meta-inline-confirm:not(.meta-chip-confirm) { + display: none; +} + +/* Add prompt for empty editable fields */ +.p-lightbox__container > .p-lightbox__sidebar .meta-add-prompt { + color: rgba(var(--v-theme-on-surface), 0.35); + font-size: 0.875rem; + cursor: pointer; + transition: color 0.15s ease; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-add-prompt:hover { + color: rgba(var(--v-theme-on-surface), 0.6); +} + +/* Per-row marker buttons (× reject, ⏏ Unassign) — hidden by default, revealed + on row hover so a non-hovered row has no nested focusable targets. */ +.p-lightbox__container > .p-lightbox__sidebar .meta-marker-remove, +.p-lightbox__container > .p-lightbox__sidebar .meta-marker-clear-subject { + display: none; +} + +.p-lightbox__container > .p-lightbox__sidebar .metadata__person-row:hover .meta-marker-remove, +.p-lightbox__container > .p-lightbox__sidebar .metadata__person-row:hover .meta-marker-clear-subject { + display: inline-flex; +} + +.p-lightbox__container > .p-lightbox__sidebar .meta-inline-edit .v-combobox__selection, +.p-lightbox__container > .p-lightbox__sidebar .meta-inline-edit .v-autocomplete__selection, +.p-lightbox__container > .p-lightbox__sidebar .meta-inline-edit .v-select__selection, +.p-lightbox__container > .p-lightbox__sidebar .meta-inline-edit .v-field--focused .v-label.v-field-label { + color: rgb(var(--v-theme-on-surface)) !important; +} + +/* density="compact" leaves the v-list title at 16 px; trim it so the menu + matches the sidebar's 0.875 rem inline editors. */ +.meta-inline-menu .v-list-item-title { + font-size: 0.8125rem; + line-height: 1.125rem; +} + /* Media Content */ .pswp__content { @@ -255,6 +553,33 @@ visibility: visible; } +.p-lightbox__content.face-marker-mode .pswp__media.pswp__media--video .pswp__video, +.p-lightbox__content.face-marker-mode .pswp__media.pswp__media--live .pswp__video, +.p-lightbox__content.face-marker-mode .pswp__media.pswp__media--animated .pswp__video, +.p-lightbox__content.face-marker-mode .pswp__media.pswp__media--video .pswp__play, +.p-lightbox__content.face-marker-mode .pswp__media.pswp__media--live .pswp__play, +.p-lightbox__content.face-marker-mode .pswp__media.pswp__media--animated .pswp__play { + visibility: hidden !important; +} + +.p-lightbox__content.face-marker-mode .pswp__media.pswp__media--video .pswp__image, +.p-lightbox__content.face-marker-mode .pswp__media.pswp__media--live .pswp__image, +.p-lightbox__content.face-marker-mode .pswp__media.pswp__media--animated .pswp__image { + visibility: visible !important; +} + +/* Hide every chrome element while face-marker mode is active; the overlay's + Back button (.p-meta-face-markers__btn--back) is the sole exit affordance. + Sidebar chrome lives in a different region and stays reachable. */ +.p-lightbox__content.face-marker-mode .pswp__top-bar .pswp__button, +.p-lightbox__content.face-marker-mode .pswp__button--arrow, +.p-lightbox__content.face-marker-mode .pswp__dynamic-caption, +.p-lightbox__content.face-marker-mode .pswp__counter, +.p-lightbox__content.face-marker-mode .p-lightbox__controls { + visibility: hidden !important; + pointer-events: none !important; +} + .pswp__img { -webkit-touch-callout: default; } @@ -368,20 +693,6 @@ touch-action: none; } -.pswp__dynamic-caption a { - color: inherit; - text-decoration: underline; - white-space: normal; - overflow-wrap: normal; - word-wrap: normal; - word-break: break-word; - text-align: start; - text-overflow: ellipsis; - hyphens: auto; - pointer-events: auto; - touch-action: auto; -} - .pswp__dynamic-caption h4 { font-weight: 600; word-wrap: normal; @@ -398,6 +709,13 @@ white-space: pre-wrap; } +/* User-toggled caption visibility (Ctrl+H, #5580). */ + +.p-lightbox__container > .p-lightbox__content.hide-caption .pswp__dynamic-caption { + display: none !important; + transition: none !important; +} + /* Top Bar Controls */ .pswp__top-bar { @@ -501,6 +819,11 @@ padding-inline-end: 8px; } +.p-lightbox__controls .video-btn:hover, +.p-lightbox__controls .video-btn:focus-visible { + color: #ffffff; +} + .p-lightbox__controls .v-slider .v-slider-thumb { color: #ffffff; } @@ -621,3 +944,14 @@ .p-lightbox__container > .p-lightbox__content > .pswp--touch .pswp__button--arrow .pswp__icn { display: none; } + +/* On 360° sphere slides, swipe is captured for panning the sphere instead of switching + photos, so the navigation arrows must stay visible on touch devices — where PhotoSwipe + hides them with `visibility: hidden` because a swipe normally navigates. The + `pswp--sphere` marker is set on the PhotoSwipe root only while a 360° slide is active. + Only `visibility` is overridden (not `display`) so disabled arrows at the first/last + photo stay hidden via PhotoSwipe's `:disabled { display: none }` rule. */ + +.pswp--touch.pswp--sphere .pswp__button--arrow { + visibility: visible; +} diff --git a/frontend/src/css/meta.css b/frontend/src/css/meta.css new file mode 100644 index 000000000..6a2cbe9e8 --- /dev/null +++ b/frontend/src/css/meta.css @@ -0,0 +1,166 @@ +/* Metadata Styles */ + +/* Camera & Datetime Dialogs */ + +/* Keep labels and selection text readable when fields are focused. + Vuetify 3 applies the focused color via an inline style, so overriding + it requires !important. */ +.p-meta-camera-dialog .v-field--focused .v-label.v-field-label, +.p-meta-camera-dialog .v-field--focused .v-label.v-field-label--floating, +.p-meta-datetime-dialog .v-field--focused .v-label.v-field-label, +.p-meta-datetime-dialog .v-field--focused .v-label.v-field-label--floating { + color: rgb(var(--v-theme-on-surface)) !important; + opacity: var(--v-medium-emphasis-opacity, 0.7); +} + +/* Face Markers */ + +.p-meta-face-markers { + position: absolute; + inset: 0; + z-index: 2; + user-select: none; + /* Stays transparent so PhotoSwipe pan/zoom keeps working; .is-edit + captures the pointer. */ + pointer-events: none; + touch-action: auto; + cursor: default; +} + +.p-meta-face-markers.is-edit { + pointer-events: auto; + touch-action: none; + cursor: crosshair; +} + +.p-meta-face-markers__svg { + pointer-events: none; + overflow: visible; +} + +.p-meta-face-markers__rect { + fill: rgba(var(--v-theme-on-surface), 0.05); + stroke: rgba(var(--v-theme-on-surface), 0.9); + stroke-width: 2px; + vector-effect: non-scaling-stroke; + pointer-events: none; +} + +.p-meta-face-markers__rect--named { + stroke: rgba(var(--v-theme-primary), 0.98); /* rgba(167, 139, 250, 0.98);*/ + cursor: default; +} + +.p-meta-face-markers__rect--draft { + stroke: rgba(var(--v-theme-accent), 1); + stroke-dasharray: 6 4; + fill: rgba(var(--v-theme-accent), 0.1); + pointer-events: none; + z-index: 3; +} + +/* Visual emphasis on a marker that the user has clicked for removal — + the inline remove-confirm pill is anchored below it. Red stroke + plus a faint red fill makes the destructive intent obvious. */ +.p-meta-face-markers__rect--removing { + stroke: rgba(var(--v-theme-remove), 0.95); + fill: rgba(var(--v-theme-remove), 0.16); + stroke-width: 2.5px; +} + +/* Hover highlight driven by sidebar People-row hover. Listed after --named + so it overrides the named-marker stroke color too. */ +.p-meta-face-markers__rect--hovered { + stroke: rgba(var(--v-theme-primary-darken-1), 1); + stroke-width: 4px; + fill: none; + filter: drop-shadow(0 0 4px rgba(var(--v-theme-primary-darken-1), 0.5)); +} + +.p-meta-face-markers__handle { + fill: rgba(var(--v-theme-primary-darken-1), 1); /* rgba(167, 139, 250, 1); */ + stroke: rgba(var(--v-theme-primary), 0.95); /* rgba(70, 40, 140, 0.95); */ + stroke-width: 1.5px; + vector-effect: non-scaling-stroke; + pointer-events: none; +} + +.p-meta-face-markers__label { + font-size: 13px; + font-weight: 600; + fill: #fff; + stroke: rgba(0, 0, 0, 0.85); + stroke-width: 3px; + paint-order: stroke fill; + pointer-events: none; + user-select: none; + dominant-baseline: hanging; +} + +.p-meta-face-markers__confirm, +.p-meta-face-markers__remove-confirm { + display: flex; + gap: 10px; + pointer-events: auto; + z-index: 3; +} + +.p-meta-face-markers__btn { + width: 32px; + height: 32px; + border-radius: 50%; + border: none; + display: inline-flex; + align-items: center; + justify-content: center; + cursor: pointer; + box-shadow: 0 2px 6px rgba(0, 0, 0, 0.45); + color: rgb(var(--v-theme-on-surface)); + transition: transform 0.08s ease-out; +} + +.p-meta-face-markers__btn:hover { + transform: scale(1.08); +} + +.p-meta-face-markers__btn--confirm { + background: rgba(var(--v-theme-primary-darken-2), 0.95); +} + +.p-meta-face-markers__btn--cancel { + background: rgba(var(--v-theme-highlight-lighten-1), 0.95); +} + +.p-meta-face-markers__btn--remove { + background: rgba(var(--v-theme-remove), 0.95); +} + +/* Back button — anchored top-left in LTR / top-right in RTL with its own + pointer-events so it works regardless of the overlay root's pointer state. */ +.p-meta-face-markers__btn--back { + position: absolute; + top: 12px; + background: rgba(var(--v-theme-surface), 0.7); + backdrop-filter: blur(4px); + pointer-events: auto; + z-index: 4; +} + +.is-ltr .p-meta-face-markers__btn--back { + left: 12px; +} + +.is-rtl .p-meta-face-markers__btn--back { + right: 12px; +} + +.p-meta-face-markers__btn--back:hover { + background: rgba(var(--v-theme-surface), 0.85); +} + +.p-meta-face-markers__btn.is-disabled, +.p-meta-face-markers__btn[disabled] { + cursor: default; + opacity: 0.6; + transform: none; +} diff --git a/frontend/src/css/navigation.css b/frontend/src/css/navigation.css index 83e3d5580..23bdc27fd 100644 --- a/frontend/src/css/navigation.css +++ b/frontend/src/css/navigation.css @@ -20,6 +20,10 @@ nav .v-list__item__title.title { color: #ffffff77; } +.v-avatar.nav-logo { + border-radius: 0; +} + #p-navigation .nav-logo a, #p-navigation .nav-toolbar-title a, #p-navigation .navigation-home a { @@ -54,6 +58,33 @@ nav .v-list__item__title.title { margin-right: auto; } +#p-navigation .nav-user-activator { + display: flex; + align-items: center; + flex-grow: 1; + gap: 8px; + min-width: 0; + padding: 2px 4px; + border-radius: 8px; + cursor: pointer; +} + +#p-navigation .nav-user-activator .nav-user-text { + min-width: 0; + overflow: hidden; +} + +#p-navigation .nav-user-activator .nav-user-text p { + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; +} + +.nav-sidebar.v-navigation-drawer--rail .nav-container > .nav-info > .nav-user-activator { + flex-grow: 0; + justify-content: center; +} + #p-navigation .nav-sidebar .nav-logo { width: 40px; text-align: inherit; diff --git a/frontend/src/css/places.css b/frontend/src/css/places.css index 42e509980..6b8af3585 100644 --- a/frontend/src/css/places.css +++ b/frontend/src/css/places.css @@ -239,7 +239,20 @@ overflow: hidden; } -.p-location-dialog .p-map { +/* MapLibre renders the default marker as a
diff --git a/frontend/src/page/about/license.vue b/frontend/src/page/about/license.vue index a6f931bc6..15c40ca7a 100644 --- a/frontend/src/page/about/license.vue +++ b/frontend/src/page/about/license.vue @@ -547,7 +547,7 @@ (a) PhotoPrism’s Brand Assets — including trademarks, logos, icons, fonts, corporate design, product and service names, and any other brand features and elements, whether registered or unregistered („Brand Assets“) — are proprietary assets owned exclusively by PhotoPrism UG („PhotoPrism“). We reserve the right to object to any use or misuse in any jurisdiction worldwide. Visit - photoprism.app/trademark + photoprism.app/trademark to learn more.

diff --git a/frontend/src/page/admin.vue b/frontend/src/page/admin.vue index 7d963ba69..2e76493d5 100644 --- a/frontend/src/page/admin.vue +++ b/frontend/src/page/admin.vue @@ -1,17 +1,13 @@ - diff --git a/frontend/src/page/auth/login.vue b/frontend/src/page/auth/login.vue index 032c8a3e6..c2481e865 100644 --- a/frontend/src/page/auth/login.vue +++ b/frontend/src/page/auth/login.vue @@ -115,7 +115,7 @@ -

+
+
+ +
{{ $gettext(`Can't access your authenticator app or device?`) }} {{ $gettext(`Use your recovery code or contact an administrator for help.`) }}
-
+
{{ $gettext(`Forgot password?`) }} @@ -204,6 +214,7 @@ export default { username: "", password: "", showPassword: false, + staySignedIn: true, useRecoveryCode: false, code: "", enterCode: false, @@ -254,14 +265,34 @@ export default { }, }, created() { - const authError = getAppStorage().getItem("session.error"); - if (authError) { - this.$notify.error(authError); - getAppStorage().removeItem("session.error"); - } + this.staySignedIn = this.currentStaySignedInState(); }, mounted() { this.$view.enter(this, this.$refs?.form, 'input[value=""], button.action-confirm'); + + // Surface an OIDC sign-in failure (e.g. "no access to this instance") + // stashed by the auth bridge before its full-page redirect. In mounted() so + // the notification component has already subscribed (its created() runs + // before any mounted()). + const messageId = getAppStorage().getItem("session.messageId"); + const authError = getAppStorage().getItem("session.error"); + if (messageId || authError) { + let messageParams = []; + const rawParams = getAppStorage().getItem("session.messageParams"); + if (rawParams) { + try { + messageParams = JSON.parse(rawParams); + } catch (e) { + messageParams = []; + } + } + getAppStorage().removeItem("session.error"); + getAppStorage().removeItem("session.messageId"); + getAppStorage().removeItem("session.messageParams"); + // Render in the current UI locale via the message key (notify.vue applies + // Tp); the server-rendered string stays as the fallback. + this.$notify.error(authError, messageId, messageParams); + } }, unmounted() { this.$view.leave(this); @@ -316,6 +347,20 @@ export default { }); } }, + currentStaySignedInState() { + if (typeof this.$session?.usesSessionStorage === "function") { + return !this.$session.usesSessionStorage(); + } + + return getAppStorage().getItem("session") !== "true"; + }, + applySessionPersistence() { + if (this.staySignedIn) { + this.$session.useLocalStorage(); + } else { + this.$session.useSessionStorage(); + } + }, onLogin() { const username = this.username.trim(); const password = this.password.trim(); @@ -325,6 +370,7 @@ export default { return; } + this.applySessionPersistence(); this.loading = true; this.$session .login(username, password, code) @@ -347,7 +393,13 @@ export default { } if (this.config.ext?.oidc?.loginUri) { + this.applySessionPersistence(); this.loading = true; + // Arm the per-tab OIDC attempt guard (not the post-login redirect loop + // guard): a failed or abandoned roundtrip then falls back to the form via + // consumeOidcAttempt instead of auto-redirecting again, while a stored deep + // link or Portal return_to survives for the authenticated return trip. + this.$session.markOidcAttempt(); this.$session.followRedirect(this.config.ext.oidc.loginUri); } else { this.$notify.warn(this.$gettext("Missing or invalid configuration")); diff --git a/frontend/src/page/cluster.vue b/frontend/src/page/cluster.vue index 74467e37b..a995ca6a8 100644 --- a/frontend/src/page/cluster.vue +++ b/frontend/src/page/cluster.vue @@ -1,17 +1,13 @@ - diff --git a/frontend/src/page/settings/content.vue b/frontend/src/page/settings/content.vue index 29a0d444d..d55bddd53 100644 --- a/frontend/src/page/settings/content.vue +++ b/frontend/src/page/settings/content.vue @@ -164,16 +164,22 @@ - + {{ $gettext(`Download`) }} - + - + - + + + + + @@ -232,10 +255,16 @@ export default { PAboutFooter, }, data() { + const user = this.$session.getUser(); + const role = user ? user.Role : ""; + const canChangeDownloads = + this.$session.isAdmin() || (this.$session.isUser() && !this.$session.hasScope() && (role === "user" || role === "manager")); + return { isDemo: this.$config.isDemo(), isAdmin: this.$session.isAdmin(), isSuperAdmin: this.$session.isSuperAdmin(), + canChangeDownloads: canChangeDownloads, readonly: this.$config.get("readonly"), experimental: this.$config.get("experimental"), config: this.$config.values, diff --git a/frontend/src/page/settings/general.vue b/frontend/src/page/settings/general.vue index c466cf6be..f7bb5da1e 100644 --- a/frontend/src/page/settings/general.vue +++ b/frontend/src/page/settings/general.vue @@ -72,6 +72,66 @@ + + + + + + + + + + + + + + + + + + + + - + + + {{ $gettext(`Accessibility`) }} + + + + + + + + + + + + + + + + + + + + + + + + + + + + {{ $gettext(`Places`) }} @@ -398,6 +528,7 @@ + @@ -517,6 +648,30 @@ export default { }) .finally(() => (this.busy = false)); }, + // saveAndReload persists the settings and reloads the page so changes baked into the + // server-rendered HTML (viewport meta for zoom, hide-scrollbar body class) take effect. + saveAndReload() { + this.busy = true; + this.settings + .save() + .then(() => { + this.$config.setSettings(this.settings); + this.$notify.info(this.$gettext("Reloading…")); + this.$notify.blockUI(); + setTimeout(() => window.location.reload(), 100); + }) + .finally(() => (this.busy = false)); + }, + // onChangeZoom saves the page-zoom setting and reloads to refresh the viewport meta tag. + onChangeZoom() { + this.saveAndReload(); + }, + // onChangeScrollbar maps the inverted "Hide Scrollbar" checkbox to the stored ui.scrollbar + // flag and reloads so the server-rendered hide-scrollbar body class is refreshed. + onChangeScrollbar(hidden) { + this.settings.ui.scrollbar = !hidden; + this.saveAndReload(); + }, }, }; diff --git a/frontend/src/share.js b/frontend/src/share.js index 483b1f67d..728318946 100644 --- a/frontend/src/share.js +++ b/frontend/src/share.js @@ -1,6 +1,6 @@ /* -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -13,7 +13,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - + Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/frontend/src/sw-scope-cleanup.js b/frontend/src/sw-scope-cleanup.js index 509f47218..e252b3e3a 100644 --- a/frontend/src/sw-scope-cleanup.js +++ b/frontend/src/sw-scope-cleanup.js @@ -1,6 +1,6 @@ /* -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -13,7 +13,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - + Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/frontend/testcaferc.json b/frontend/testcaferc.json deleted file mode 100644 index 0fc3afb22..000000000 --- a/frontend/testcaferc.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "skipJsErrors": true, - "quarantineMode": false, - "selectorTimeout": 3500, - "assertionTimeout": 3500, - "hostname": "localhost", - "retryTestPages": true, - "screenshots": { - "path": "tests/acceptance/screenshots/", - "takeOnFails": true - } -} - diff --git a/frontend/tests/README.md b/frontend/tests/README.md index 78bd00e44..201652d83 100644 --- a/frontend/tests/README.md +++ b/frontend/tests/README.md @@ -1,6 +1,6 @@ ## Frontend Tests & Linting -**Last Updated:** February 22, 2026 +**Last Updated:** May 3, 2026 ### Purpose @@ -59,29 +59,28 @@ When evaluating frontend tooling changes, test at least one CE run plus Plus and Current frontend tool versions are defined in `frontend/package.json` unless stated otherwise. -| Tool | Version | -|:-------------------------------------|:------------| -| Node.js engine | `>= 18.0.0` | -| npm engine | `>= 9.0.0` | -| Vitest | `^3.2.4` | -| `@vitest/ui` | `^3.2.4` | -| `@vitest/coverage-v8` | `^3.2.4` | -| `@vitejs/plugin-vue` | `^6.0.4` | -| `@vue/test-utils` | `^2.4.6` | -| JSDOM | `^26.1.0` | -| Playwright (Vitest browser provider) | `^1.58.2` | -| ESLint | `^9.39.2` | -| `@eslint/js` | `^9.33.0` | -| `@eslint/eslintrc` | `^3.3.3` | -| `eslint-config-prettier` | `^10.1.8` | -| `eslint-plugin-import` | `^2.32.0` | -| `eslint-plugin-node` | `^11.1.0` | -| `eslint-plugin-prettier` | `^5.5.5` | -| `eslint-plugin-vue` | `^10.7.0` | -| `eslint-plugin-vuetify` | `^2.5.3` | -| `eslint-webpack-plugin` | `^5.0.2` | -| Prettier | `^3.8.1` | -| TestCafe CLI (dev environment) | `3.7.4` | +| Tool | Version | +|:-------------------------------------|:-------------| +| Node.js engine | `>= 22.15.0` | +| npm engine | `>= 9.0.0` | +| Vitest | `^3.2.4` | +| `@vitest/ui` | `^3.2.4` | +| `@vitest/coverage-v8` | `^3.2.4` | +| `@vitejs/plugin-vue` | `^6.0.4` | +| `@vue/test-utils` | `^2.4.6` | +| JSDOM | `^26.1.0` | +| Playwright (Vitest browser provider) | `^1.58.2` | +| ESLint | `^9.39.2` | +| `@eslint/js` | `^9.33.0` | +| `@eslint/eslintrc` | `^3.3.3` | +| `eslint-config-prettier` | `^10.1.8` | +| `eslint-plugin-import` | `^2.32.0` | +| `eslint-plugin-node` | `^11.1.0` | +| `eslint-plugin-vue` | `^10.7.0` | +| `eslint-plugin-vuetify` | `^2.5.3` | +| `eslint-webpack-plugin` | `^5.0.2` | +| Prettier | `^3.8.1` | +| TestCafe CLI (dev environment) | `3.7.4` | Note: TestCafe is available in the development environment but is currently not pinned as a direct dependency in `frontend/package.json`. Verify with `testcafe --version`. diff --git a/frontend/tests/acceptance/acceptance-api/cleanup.js b/frontend/tests/acceptance/acceptance-api/cleanup.js new file mode 100644 index 000000000..e0a619e15 --- /dev/null +++ b/frontend/tests/acceptance/acceptance-api/cleanup.js @@ -0,0 +1,898 @@ +import { Selector } from "testcafe"; +import testcafeconfig from "../../testcafeconfig.json"; +import { helperBeforeFixture, helperBeforeEach, helperAfterEach, logMessage } from "../page-model/helpers"; + +fixture`Test helper` +.page`${testcafeconfig.url}` +.before(async ctx => { + await helperBeforeFixture(ctx); +}); + +function cleanAlbumsFilesAndLabels(jsonBody) { + let items = JSON.parse(JSON.stringify(jsonBody.Albums)); + jsonBody.Albums.length = 0; + for (let item of items) { + delete item.UpdatedAt; + delete item.ThumbSrc; + jsonBody.Albums.push(item); + } + items = JSON.parse(JSON.stringify(jsonBody.Files)); + jsonBody.Files.length = 0; + for (let item of items) { + delete item.UpdatedAt; + jsonBody.Files.push(item); + } + items = JSON.parse(JSON.stringify(jsonBody.Labels)); + jsonBody.Labels.length = 0; + for (let item of items) { + delete item.Label.UpdatedAt; + delete item.LabelSrc; // can't be set by API + delete item.Uncertainty; // when Src changes, the uncertainty changes. + jsonBody.Labels.push(item); + } +} + +test.meta("testID", "cleanup-001").meta({ type: "short", mode: "api" })("Common: Cleanup Album remove album cover photo and change caption/description of existing album", async (t) => { + await helperBeforeEach(t); + let beforeAlbumResponse = await t.request({ + url: `${testcafeconfig.api}albums`, + method: 'get', + params: { + count: 1, + q: `Christmas type:album` + } + }); + await t.expect(beforeAlbumResponse.status).eql(200); + const albumUID = beforeAlbumResponse.body[0].UID; + beforeAlbumResponse = await t.request(`${testcafeconfig.api}albums/${albumUID}`); + await t.expect(beforeAlbumResponse.status).eql(200); + // Change the name on the album + let apiResponse = await t.request({ + url: `${testcafeconfig.api}albums/${albumUID}`, + method: 'put', + body: { + "Caption": "Cleanup test data", + "Description": "This should be removed" + } + }); + await t.expect(apiResponse.status).eql(200); + + // remove pqmxlr7188hz4bih from album "Christmas", which is the album cover photo + apiResponse = await t.request({ + url: `${testcafeconfig.api}albums/${albumUID}/photos`, + method: 'delete', + body: { + "photos": [ "pqmxlr7188hz4bih" ] // This should be ok. + } + }); + await t.expect(apiResponse.status).eql(200); + + await helperAfterEach(t); + const afterAlbumResponse = await t.request(`${testcafeconfig.api}albums/${albumUID}`); + await t.expect(beforeAlbumResponse).notEql(afterAlbumResponse); + // Remove the fields that are impacted by changes + delete beforeAlbumResponse.body.UpdatedAt; // Will change + delete afterAlbumResponse.body.UpdatedAt; + delete beforeAlbumResponse.body.ThumbSrc; // Will change on 1st run, wont on subsequent + delete afterAlbumResponse.body.ThumbSrc; + delete beforeAlbumResponse.headers["content-length"]; // Will change (timestamp) + delete afterAlbumResponse.headers["content-length"]; + delete beforeAlbumResponse.headers.date; // May change if second ticks over + delete afterAlbumResponse.headers.date; + await t.expect(afterAlbumResponse).eql(beforeAlbumResponse); +}); + +test.meta("testID", "cleanup-002").meta({ type: "short", mode: "api" })("Common: Cleanup Album remove Garden album", async (t) => { + await helperBeforeEach(t); + const albumUID = "arkgush1tdwk4fsy"; + let beforeAlbumResponse = await t.request(`${testcafeconfig.api}albums/${albumUID}`); + await t.expect(beforeAlbumResponse.status).eql(200); + // Soft Delete the album + let apiResponse = await t.request({ + url: `${testcafeconfig.api}albums/${albumUID}`, + method: 'delete', + params: { + force: false + } + }); + await t.expect(apiResponse.status).eql(200); + + await helperAfterEach(t); + let afterAlbumResponse = await t.request(`${testcafeconfig.api}albums/${albumUID}`); + await t.expect(beforeAlbumResponse).notEql(afterAlbumResponse); + await t.expect(afterAlbumResponse.status).eql(200); // A deleted album with the SAME CreatedBy as the current user will be undeleted + // Remove the fields that are impacted by changes + delete beforeAlbumResponse.body.UpdatedAt; + delete afterAlbumResponse.body.UpdatedAt; + delete beforeAlbumResponse.body.ThumbSrc; + delete afterAlbumResponse.body.ThumbSrc; + delete beforeAlbumResponse.headers["content-length"]; + delete afterAlbumResponse.headers["content-length"]; + delete beforeAlbumResponse.headers.date; + delete afterAlbumResponse.headers.date; + await t.expect(afterAlbumResponse).eql(beforeAlbumResponse); +}); + +test.meta("testID", "cleanup-003").meta({ type: "short", mode: "api" })("Common: Cleanup Album remove Holiday album owned by other user", async (t) => { + await helperBeforeEach(t); + let beforeAlbumResponse = await t.request({ + url: `${testcafeconfig.api}albums`, + method: 'get', + params: { + count: 1, + q: `Holiday type:album` + } + }); + await t.expect(beforeAlbumResponse.status).eql(200); + const albumUID = beforeAlbumResponse.body[0].UID; + await t.expect(albumUID).eql("aqmxlt22ilujuxux", "Test requires Holiday album to not have been deleted already"); + beforeAlbumResponse = await t.request(`${testcafeconfig.api}albums/${albumUID}`); + await t.expect(beforeAlbumResponse.status).eql(200); + // Soft Delete the album + let apiResponse = await t.request({ + url: `${testcafeconfig.api}albums/${albumUID}`, + method: 'delete', + params: { + force: false + } + }); + await t.expect(apiResponse.status).eql(200); + + await helperAfterEach(t); + let afterAlbumResponse = await t.request(`${testcafeconfig.api}albums/${albumUID}`); + await t.expect(beforeAlbumResponse).notEql(afterAlbumResponse); + await t.expect(afterAlbumResponse.status).eql(404); // A deleted album with a null or different CreatedBy will change UID + afterAlbumResponse = await t.request({ + url: `${testcafeconfig.api}albums`, + method: 'get', + params: { + count: 1, + q: `Holiday type:album` + } + }); + await t.expect(afterAlbumResponse.status).eql(200); + afterAlbumResponse = await t.request(`${testcafeconfig.api}albums/${afterAlbumResponse.body[0].UID}`); + await t.expect(afterAlbumResponse.status).eql(200); + // Remove the fields that are impacted by changes + delete beforeAlbumResponse.body.UID; + delete afterAlbumResponse.body.UID; + delete beforeAlbumResponse.body.ID; + delete afterAlbumResponse.body.ID; + delete beforeAlbumResponse.body.UpdatedAt; + delete afterAlbumResponse.body.UpdatedAt; + delete beforeAlbumResponse.body.CreatedAt; + delete afterAlbumResponse.body.CreatedAt; + delete beforeAlbumResponse.body.CreatedBy; + delete afterAlbumResponse.body.CreatedBy; + delete beforeAlbumResponse.body.ThumbSrc; + delete afterAlbumResponse.body.ThumbSrc; + delete beforeAlbumResponse.headers["content-length"]; + delete afterAlbumResponse.headers["content-length"]; + delete beforeAlbumResponse.headers.date; + delete afterAlbumResponse.headers.date; + await t.expect(afterAlbumResponse).eql(beforeAlbumResponse); +}); + +test.meta("testID", "cleanup-004").meta({ type: "short", mode: "api" })("Common: Cleanup Photo revert titles and details", async (t) => { + await helperBeforeEach(t); + let beforePhotoResponse = await t.request({ + url: `${testcafeconfig.api}photos`, + method: 'get', + params: { + count: 1, + q: `geo:true camera:apple` + } + }); + await t.expect(beforePhotoResponse.status).eql(200); + const photoUID = beforePhotoResponse.body[0].UID; + beforePhotoResponse = await t.request(`${testcafeconfig.api}photos/${photoUID}`); + await t.expect(beforePhotoResponse.status).eql(200); + // Change the name and other stuff on the photo + let apiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${photoUID}`, + method: 'put', + body: { + "Title": "Cleanup test data", + "Description": "This should be removed", + "CameraID": 7, + "LensID": 10, + "CellID": "s2:47a85a634bcc", + "PlaceID": "de:ukLS8nroIoB7" + } + }); + await t.expect(apiResponse.status).eql(200); + + await helperAfterEach(t); + + let afterPhotoResponse = await t.request(`${testcafeconfig.api}photos/${photoUID}`); + await t.expect(afterPhotoResponse).notEql(beforePhotoResponse); + // Remove the fields that are impacted by changes + delete beforePhotoResponse.headers["content-length"]; // Will change (timestamp) + delete afterPhotoResponse.headers["content-length"]; + delete beforePhotoResponse.headers.date; // May change if second ticks over + delete afterPhotoResponse.headers.date; + delete beforePhotoResponse.body.UpdatedAt; + delete afterPhotoResponse.body.UpdatedAt; + delete beforePhotoResponse.body.EditedAt; + delete afterPhotoResponse.body.EditedAt; + delete beforePhotoResponse.body.Details.UpdatedAt; + delete afterPhotoResponse.body.Details.UpdatedAt; + cleanAlbumsFilesAndLabels(beforePhotoResponse.body); + cleanAlbumsFilesAndLabels(afterPhotoResponse.body); + await t.expect(afterPhotoResponse).eql(beforePhotoResponse); +}) + +test.meta("testID", "cleanup-005").meta({ type: "short", mode: "api" })("Common: Cleanup Photo revert Labels", async (t) => { + await helperBeforeEach(t); + const stamp = Date.now(); + const labelTitle = `CleanupLabel-${stamp}`; + let beforePhotoResponse = await t.request({ + url: `${testcafeconfig.api}photos`, + method: 'get', + params: { + count: 1, + q: `label:cat` + } + }); + await t.expect(beforePhotoResponse.status).eql(200); + const photoUID = beforePhotoResponse.body[0].UID; + beforePhotoResponse = await t.request(`${testcafeconfig.api}photos/${photoUID}`); + await t.expect(beforePhotoResponse.status).eql(200); + const labelID = 11; // The Cat label! beforePhotoResponse.body.Labels[0].ID; + // Remove a label from the photo + let apiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${photoUID}/label/${labelID}`, + method: 'delete' + }); + await t.expect(apiResponse.status).eql(200); + + // Add a manual label + const labelApiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${photoUID}/label`, + method: 'post', + body: { + "Description": "Testing Label", + "Favorite": false, + "Name": labelTitle, + "Priority": 0, + "Uncertainty": 0 + } + }); + await t.expect(labelApiResponse.status).eql(200); + + await helperAfterEach(t); + + const afterPhotoResponse = await t.request(`${testcafeconfig.api}photos/${photoUID}`); + await t.expect(afterPhotoResponse).notEql(beforePhotoResponse); + // Remove the fields that are impacted by changes + delete beforePhotoResponse.headers["content-length"]; // Will change (timestamp) + delete afterPhotoResponse.headers["content-length"]; + delete beforePhotoResponse.headers.date; // May change if second ticks over + delete afterPhotoResponse.headers.date; + if (!beforePhotoResponse.body.Title.includes("Cat")) { + // If the title didn't include cat, then the label change to Manual 100% certainty MAY add cat to the Title. + delete beforePhotoResponse.body.Title; + delete afterPhotoResponse.body.Title; + } + delete beforePhotoResponse.body.UpdatedAt; + delete afterPhotoResponse.body.UpdatedAt; + delete beforePhotoResponse.body.EditedAt; + delete afterPhotoResponse.body.EditedAt; + delete beforePhotoResponse.body.Details.UpdatedAt; + delete afterPhotoResponse.body.Details.UpdatedAt; + cleanAlbumsFilesAndLabels(beforePhotoResponse.body); + cleanAlbumsFilesAndLabels(afterPhotoResponse.body); + await t.expect(afterPhotoResponse).eql(beforePhotoResponse); +}) + +// This test will leave a junk label behind if it fails, as it's testing that manual labels are reverted correctly. +// This test is no longer possible due to beforeFixture caching state before this test initiates. +test.meta("testID", "cleanup-006").meta({ type: "short", mode: "api" }).skip("Common: Cleanup Photo revert manual deleted Label", async (t) => { + // This test is not possible as there is no manual labels in the acceptance database. + // This prevents the required conditions from being there when beforeFixture runs. + await helperBeforeEach(t); + const stamp = Date.now(); + const labelTitle = `CleanupLabel-${stamp}`; + let beforePhotoResponse = await t.request({ + url: `${testcafeconfig.api}photos`, + method: 'get', + params: { + count: 1 + } + }); + await t.expect(beforePhotoResponse.status).eql(200); + const photoUID = beforePhotoResponse.body[0].UID; + // Add a manual label + let labelApiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${photoUID}/label`, + method: 'post', + body: { + "Description": "Testing Label", + "Favorite": false, + "Name": labelTitle, + "Priority": 0, + "Uncertainty": 0 + } + }); + await t.expect(labelApiResponse.status).eql(200); + labelApiResponse = await t.request({ + url: `${testcafeconfig.api}labels`, + method: 'get', + params: { + count: 1, + q: labelTitle + } + }); + await t.expect(labelApiResponse.status).eql(200); + const labelID = labelApiResponse.body[0].ID; + + beforePhotoResponse = await t.request(`${testcafeconfig.api}photos/${photoUID}`); + await t.expect(beforePhotoResponse.status).eql(200); + + // Remove the manual label from the photo + let apiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${photoUID}/label/${labelID}`, + method: 'delete' + }); + await t.expect(apiResponse.status).eql(200); + await helperAfterEach(t); + + const afterPhotoResponse = await t.request(`${testcafeconfig.api}photos/${photoUID}`); + await t.expect(afterPhotoResponse).notEql(beforePhotoResponse); + // Remove the fields that are impacted by changes + delete beforePhotoResponse.headers["content-length"]; // Will change (timestamp) + delete afterPhotoResponse.headers["content-length"]; + delete beforePhotoResponse.headers.date; // May change if second ticks over + delete afterPhotoResponse.headers.date; + delete beforePhotoResponse.body.UpdatedAt; + delete afterPhotoResponse.body.UpdatedAt; + delete beforePhotoResponse.body.EditedAt; + delete afterPhotoResponse.body.EditedAt; + delete beforePhotoResponse.body.Details.UpdatedAt; + delete afterPhotoResponse.body.Details.UpdatedAt; + cleanAlbumsFilesAndLabels(beforePhotoResponse.body); + cleanAlbumsFilesAndLabels(afterPhotoResponse.body); + await t.expect(afterPhotoResponse).eql(beforePhotoResponse); + + // Remove the manual label from the photo + apiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${photoUID}/label/${labelID}`, + method: 'delete' + }); + await t.expect(apiResponse.status).eql(200); +}) + +// This test will leave a junk album behind if it fails, as it's testing that manual albums are reverted correctly from a photo. +test.meta("testID", "cleanup-007").meta({ type: "short", mode: "api" })("Common: Cleanup Photo revert Albums", async (t) => { + await helperBeforeEach(t); + const stamp = Date.now(); + const albumTitle = `CleanupAlbum-${stamp}`; + let beforePhotoResponse = await t.request({ + url: `${testcafeconfig.api}photos`, + method: 'get', + params: { + count: 1, + q: `album:garden private:false` + } + }); + await t.expect(beforePhotoResponse.status).eql(200); + const photoUID = beforePhotoResponse.body[0].UID; + beforePhotoResponse = await t.request(`${testcafeconfig.api}photos/${photoUID}`); + await t.expect(beforePhotoResponse.status).eql(200); + + const albumUID = "arkgush1tdwk4fsy"; + // Remove an existing album from the photo + let apiResponse = await t.request({ + url: `${testcafeconfig.api}albums/${albumUID}/photos`, + method: 'delete', + body: { + "photos": [ photoUID ] + } + }); + await t.expect(apiResponse.status).eql(200); + + // Add a manual album + let albumApiResponse = await t.request({ + url: `${testcafeconfig.api}albums`, + method: 'post', + body: { + "Caption": "cleanup-007", + "Title": albumTitle + } + }); + await t.expect(albumApiResponse.status).eql(201); + + // Add photo to the new album + const newAlbumUID = albumApiResponse.body.UID; + + albumApiResponse = await t.request({ + url: `${testcafeconfig.api}albums/${newAlbumUID}/photos`, + method: 'post', + body: { + "photos": [ photoUID ] + } + }); + await t.expect(albumApiResponse.status).eql(200); + logMessage(JSON.stringify(albumApiResponse)); + + await helperAfterEach(t); + + const afterPhotoResponse = await t.request(`${testcafeconfig.api}photos/${photoUID}`); + await t.expect(afterPhotoResponse).notEql(beforePhotoResponse); + // Remove the fields that are impacted by changes + delete beforePhotoResponse.headers["content-length"]; // Will change (timestamp) + delete afterPhotoResponse.headers["content-length"]; + delete beforePhotoResponse.headers.date; // May change if second ticks over + delete afterPhotoResponse.headers.date; + delete beforePhotoResponse.body.UpdatedAt; + delete afterPhotoResponse.body.UpdatedAt; + delete beforePhotoResponse.body.EditedAt; + delete afterPhotoResponse.body.EditedAt; + delete beforePhotoResponse.body.Details.UpdatedAt; + delete afterPhotoResponse.body.Details.UpdatedAt; + cleanAlbumsFilesAndLabels(beforePhotoResponse.body); + cleanAlbumsFilesAndLabels(afterPhotoResponse.body); + await t.expect(afterPhotoResponse).eql(beforePhotoResponse); + + // await helperBeforeEach(t); + // await helperRemoveAlbum(t, "name", albumTitle); + // await helperAfterEach(t); + + albumApiResponse = await t.request({ + url: `${testcafeconfig.api}albums/${newAlbumUID}`, + method: 'get' + }); + await t.expect(albumApiResponse.status).eql(404); +}) + +// This test can fail due to order of label results changing (which testcafe thinks is an actual change), +// or if a named person is chosen, then the title can change, assuming the original title isn't up to date. +test.meta("testID", "cleanup-008").meta({ type: "short", mode: "api" })("Common: Cleanup Photo revert Markers", async (t) => { + await helperBeforeEach(t); + let beforePhotoResponse = await t.request({ + url: `${testcafeconfig.api}photos`, + method: 'get', + params: { + count: 1, + q: `faces:new` // faces:new so that the title can't change, and labels are less likely to change order. + } + }); + await t.expect(beforePhotoResponse.status).eql(200); + const photoUID = beforePhotoResponse.body[0].UID; + beforePhotoResponse = await t.request(`${testcafeconfig.api}photos/${photoUID}`); + await t.expect(beforePhotoResponse.status).eql(200); + + // Loop files and markers. Invalidate the 1st marker found. Store the FileUID and MarkerUID + let fileUID = ""; + let markerUID = ""; + + for (const file of beforePhotoResponse.body.Files){ + for (const marker of file.Markers) { + if (!marker.Invalid) { + markerUID = marker.UID; + fileUID = marker.FileUID; + break; + } + } + if (markerUID != "") { + break; + } + } + + // Remove an existing marker from the photo + let apiResponse = await t.request({ + url: `${testcafeconfig.api}markers/${markerUID}`, + method: 'put', + body: { + "Invalid":true + } + }); + await t.expect(apiResponse.status).eql(200); + + // Add a manual marker + let markerApiResponse = await t.request({ + url: `${testcafeconfig.api}markers`, + method: 'post', + body: { + "FileUID":fileUID, + "Type":"face", + "Src":"manual", + "X":0.42172298011844334, + "Y":0.35562737944162437, + "W":0.1810358502538071, + "H":0.13577688769035534 + } + }); + await t.expect(markerApiResponse.status).eql(201); + const newMarkerUID = markerApiResponse.body.UID; + + await helperAfterEach(t); + + const afterPhotoResponse = await t.request(`${testcafeconfig.api}photos/${photoUID}`); + await t.expect(afterPhotoResponse).notEql(beforePhotoResponse); + // Remove the fields that are impacted by changes + delete beforePhotoResponse.headers["content-length"]; // Will change (timestamp) + delete afterPhotoResponse.headers["content-length"]; + delete beforePhotoResponse.headers.date; // May change if second ticks over + delete afterPhotoResponse.headers.date; + delete beforePhotoResponse.body.UpdatedAt; + delete afterPhotoResponse.body.UpdatedAt; + delete beforePhotoResponse.body.EditedAt; + delete afterPhotoResponse.body.EditedAt; + delete beforePhotoResponse.body.Details.UpdatedAt; + delete afterPhotoResponse.body.Details.UpdatedAt; + cleanAlbumsFilesAndLabels(beforePhotoResponse.body); + cleanAlbumsFilesAndLabels(afterPhotoResponse.body); + await t.expect(afterPhotoResponse).notEql(beforePhotoResponse); + + // need to remove the new marker as it will be invalid=true, not removed. + for (const file of afterPhotoResponse.body.Files){ + let items = JSON.parse(JSON.stringify(file.Markers)); + file.Markers.length = 0; + for (let item of items) { + if (item.UID != newMarkerUID) + { + delete item.UpdatedAt; + file.Markers.push(item); + } else { + await t.expect(item.Invalid).eql(true); // Make sure it was marked invalid. + } + } + } + await t.expect(afterPhotoResponse).eql(beforePhotoResponse); + +}) + +// This test will leave a junk album behind if it fails, as it's testing that manual albums are reverted correctly from a photo. +test.meta("testID", "cleanup-009").meta({ type: "short", mode: "api" })("Common: Cleanup Album", async (t) => { + await helperBeforeEach(t); + const stamp = Date.now(); + const albumTitle1 = `CleanupAlbum1-${stamp}`; + const albumTitle2 = `CleanupAlbum2-${stamp}`; + + // Add a manual album + let albumApiResponse = await t.request({ + url: `${testcafeconfig.api}albums`, + method: 'post', + body: { + "Caption": "cleanup-009", + "Title": albumTitle1 + } + }); + await t.expect(albumApiResponse.status).eql(201); + const newAlbum1UID = albumApiResponse.body.UID; + + // Add a manual album + albumApiResponse = await t.request({ + url: `${testcafeconfig.api}albums`, + method: 'post', + body: { + "Caption": "cleanup-009", + "Title": albumTitle2 + } + }); + await t.expect(albumApiResponse.status).eql(201); + const newAlbum2UID = albumApiResponse.body.UID; + + await helperAfterEach(t); + + albumApiResponse = await t.request({ + url: `${testcafeconfig.api}albums/${newAlbum1UID}`, + method: 'get' + }); + await t.expect(albumApiResponse.status).eql(404); + albumApiResponse = await t.request({ + url: `${testcafeconfig.api}albums/${newAlbum2UID}`, + method: 'get' + }); + await t.expect(albumApiResponse.status).eql(404); +}) + +test.meta("testID", "cleanup-010").meta({ type: "short", mode: "api" })("Common: Cleanup Labels 2 manual labels", async (t) => { + await helperBeforeEach(t); + const stamp = Date.now(); + const label1Title = `CleanupLabel1-${stamp}`; + const label2Title = `CleanupLabel2-${stamp}`; + let beforePhotoResponse = await t.request({ + url: `${testcafeconfig.api}photos`, + method: 'get', + params: { + count: 1, + q: `label:beach` + } + }); + await t.expect(beforePhotoResponse.status).eql(200); + const photoUID = beforePhotoResponse.body[0].UID; + beforePhotoResponse = await t.request(`${testcafeconfig.api}photos/${photoUID}`); + await t.expect(beforePhotoResponse.status).eql(200); + + // Add a manual label + let labelApiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${photoUID}/label`, + method: 'post', + body: { + "Description": "Testing Label", + "Favorite": false, + "Name": label1Title, + "Priority": 0, + "Uncertainty": 0 + } + }); + await t.expect(labelApiResponse.status).eql(200); + + // Add a manual label + labelApiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${photoUID}/label`, + method: 'post', + body: { + "Description": "Testing Label", + "Favorite": false, + "Name": label2Title, + "Priority": 0, + "Uncertainty": 0 + } + }); + await t.expect(labelApiResponse.status).eql(200); + + await helperAfterEach(t); + + const afterPhotoResponse = await t.request(`${testcafeconfig.api}photos/${photoUID}`); + await t.expect(beforePhotoResponse).notEql(afterPhotoResponse); + // Remove the fields that are impacted by changes + delete beforePhotoResponse.headers["content-length"]; // Will change (timestamp) + delete afterPhotoResponse.headers["content-length"]; + delete beforePhotoResponse.headers.date; // May change if second ticks over + delete afterPhotoResponse.headers.date; + delete beforePhotoResponse.body.UpdatedAt; + delete afterPhotoResponse.body.UpdatedAt; + delete beforePhotoResponse.body.EditedAt; + delete afterPhotoResponse.body.EditedAt; + delete beforePhotoResponse.body.Details.UpdatedAt; + delete afterPhotoResponse.body.Details.UpdatedAt; + cleanAlbumsFilesAndLabels(beforePhotoResponse.body); + cleanAlbumsFilesAndLabels(afterPhotoResponse.body); + await t.expect(afterPhotoResponse).eql(beforePhotoResponse); +}) + +test.meta("testID", "cleanup-010b").meta({ type: "short", mode: "api" })("Common: Cleanup Labels remove 1 label from 2 photos", async (t) => { + await helperBeforeEach(t); + const stamp = Date.now(); + const labelTitle = `CleanupLabel-${stamp}`; + let beforePhotoResponse = await t.request({ + url: `${testcafeconfig.api}photos`, + method: 'get', + params: { + count: 2, + q: `label:zebra` + } + }); + await t.expect(beforePhotoResponse.status).eql(200); + await t.expect(beforePhotoResponse.body.length).eql(2); + const photo1UID = beforePhotoResponse.body[0].UID; + const photo2UID = beforePhotoResponse.body[1].UID; + + // Add a manual label + let labelApiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${photo1UID}/label`, + method: 'post', + body: { + "Description": "Testing Label", + "Favorite": false, + "Name": labelTitle, + "Priority": 0, + "Uncertainty": 0 + } + }); + await t.expect(labelApiResponse.status).eql(200); + const label1UID = labelApiResponse.body.Labels.find((element) => element.Label.Name == labelTitle).Label.UID; + + // Add a manual label + labelApiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${photo2UID}/label`, + method: 'post', + body: { + "Description": "Testing Label", + "Favorite": false, + "Name": labelTitle, + "Priority": 0, + "Uncertainty": 0 + } + }); + await t.expect(labelApiResponse.status).eql(200); + const label2UID = labelApiResponse.body.Labels.find((element) => element.Label.Name == labelTitle).Label.UID; + + await helperAfterEach(t); + + await t.expect(label1UID).eql(label2UID); + await t.expect(label1UID.length).eql(16); + + labelApiResponse = await t.request({ + url: `${testcafeconfig.api}labels/${label1UID}`, + method: 'put', + body: { + "Description": "Testing Label", + "Favorite": false, + "Name": labelTitle, + "Priority": 0, + "Uncertainty": 0 + } + }); + await t.expect(labelApiResponse.status).eql(404); + + labelApiResponse = await t.request({ + url: `${testcafeconfig.api}labels/${label2UID}`, + method: 'put', + body: { + "Description": "Testing Label", + "Favorite": false, + "Name": labelTitle, + "Priority": 0, + "Uncertainty": 0 + } + }); + await t.expect(labelApiResponse.status).eql(404); + +}) + +test.meta("testID", "cleanup-011").meta({ type: "short", mode: "api" })("Common: Cleanup Photo revert archive and restore", async (t) => { + await helperBeforeEach(t); + let beforeRestorePhotoResponse = await t.request({ + url: `${testcafeconfig.api}photos`, + method: 'get', + params: { + count: 1, + q: `archived:true photo:yes` + } + }); + await t.expect(beforeRestorePhotoResponse.status).eql(200); + const archivedPhotoUID = beforeRestorePhotoResponse.body[0].UID; + beforeRestorePhotoResponse = await t.request(`${testcafeconfig.api}photos/${archivedPhotoUID}`); + await t.expect(beforeRestorePhotoResponse.status).eql(200); + + // Change the name and other stuff on the photo + let apiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${archivedPhotoUID}`, + method: 'put', + body: { + "Title": "Cleanup test data", + "Description": "This should be removed", + "CameraID": 7, + "LensID": 10, + "CellID": "s2:47a85a634bcc", + "PlaceID": "de:ukLS8nroIoB7" + } + }); + await t.expect(apiResponse.status).eql(200); + + apiResponse = await t.request({ + url: `${testcafeconfig.api}batch/photos/restore`, + method: 'post', + body: { + "photos": [ archivedPhotoUID ] + } + }); + await t.expect(apiResponse.status).eql(200); + + let beforeArchivePhotoResponse = await t.request({ + url: `${testcafeconfig.api}photos`, + method: 'get', + params: { + count: 1, + q: `archived:false photo:yes` + } + }); + await t.expect(beforeArchivePhotoResponse.status).eql(200); + const restoredPhotoUID = beforeArchivePhotoResponse.body[0].UID; + beforeArchivePhotoResponse = await t.request(`${testcafeconfig.api}photos/${restoredPhotoUID}`); + await t.expect(beforeArchivePhotoResponse.status).eql(200); + + // Change the name and other stuff on the photo + apiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${restoredPhotoUID}`, + method: 'put', + body: { + "Title": "Cleanup test data", + "Description": "This should be removed", + "CameraID": 7, + "LensID": 10, + "CellID": "s2:47a85a634bcc", + "PlaceID": "de:ukLS8nroIoB7" + } + }); + await t.expect(apiResponse.status).eql(200); + + apiResponse = await t.request({ + url: `${testcafeconfig.api}batch/photos/archive`, + method: 'post', + body: { + "photos": [ restoredPhotoUID ] + } + }); + await t.expect(apiResponse.status).eql(200); + + + await helperAfterEach(t); + + let afterPhotoResponse = await t.request(`${testcafeconfig.api}photos/${archivedPhotoUID}`); + await t.expect(afterPhotoResponse).notEql(beforeRestorePhotoResponse); + // Remove the fields that are impacted by changes + delete beforeRestorePhotoResponse.headers["content-length"]; // Will change (timestamp) + delete afterPhotoResponse.headers["content-length"]; + delete beforeRestorePhotoResponse.headers.date; // May change if second ticks over + delete afterPhotoResponse.headers.date; + delete beforeRestorePhotoResponse.body.UpdatedAt; + delete afterPhotoResponse.body.UpdatedAt; + delete beforeRestorePhotoResponse.body.EditedAt; + delete afterPhotoResponse.body.EditedAt; + delete beforeRestorePhotoResponse.body.Details.UpdatedAt; + delete afterPhotoResponse.body.Details.UpdatedAt; + cleanAlbumsFilesAndLabels(beforeRestorePhotoResponse.body); + cleanAlbumsFilesAndLabels(afterPhotoResponse.body); + // DeletedAt will be different. + await t.expect(beforeRestorePhotoResponse.body.DeletedAt).contains("Z"); + await t.expect(afterPhotoResponse.body.DeletedAt).contains("Z"); + delete beforeRestorePhotoResponse.body.DeletedAt; + delete afterPhotoResponse.body.DeletedAt; + await t.expect(afterPhotoResponse).eql(beforeRestorePhotoResponse); + + afterPhotoResponse = await t.request(`${testcafeconfig.api}photos/${restoredPhotoUID}`); + await t.expect(afterPhotoResponse).notEql(beforeArchivePhotoResponse); + // Remove the fields that are impacted by changes + delete beforeArchivePhotoResponse.headers["content-length"]; // Will change (timestamp) + delete afterPhotoResponse.headers["content-length"]; + delete beforeArchivePhotoResponse.headers.date; // May change if second ticks over + delete afterPhotoResponse.headers.date; + delete beforeArchivePhotoResponse.body.UpdatedAt; + delete afterPhotoResponse.body.UpdatedAt; + delete beforeArchivePhotoResponse.body.EditedAt; + delete afterPhotoResponse.body.EditedAt; + delete beforeArchivePhotoResponse.body.Details.UpdatedAt; + delete afterPhotoResponse.body.Details.UpdatedAt; + cleanAlbumsFilesAndLabels(beforeArchivePhotoResponse.body); + cleanAlbumsFilesAndLabels(afterPhotoResponse.body); + await t.expect(afterPhotoResponse).eql(beforeArchivePhotoResponse); +}) + +test.meta("testID", "cleanup-012").meta({ type: "short", mode: "api" })("Common: Cleanup Photo revert primary", async (t) => { + await helperBeforeEach(t); + let beforePhotoResponse = await t.request({ + url: `${testcafeconfig.api}photos`, + method: 'get', + params: { + count: 1, + q: `stacks` + } + }); + await t.expect(beforePhotoResponse.status).eql(200); + const photoUID = beforePhotoResponse.body[0].UID; + beforePhotoResponse = await t.request(`${testcafeconfig.api}photos/${photoUID}`); + await t.expect(beforePhotoResponse.status).eql(200); + + const currentPrimary = beforePhotoResponse.body.Files.find((element) => element.Primary == true).UID + const targetPrimary = beforePhotoResponse.body.Files.find((element) => element.Primary == false).UID + + let apiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${photoUID}/files/${targetPrimary}/primary`, + method: 'post' + }); + await t.expect(apiResponse.status).eql(200); + + await helperAfterEach(t); + + let afterPhotoResponse = await t.request(`${testcafeconfig.api}photos/${photoUID}`); + await t.expect(afterPhotoResponse).notEql(beforePhotoResponse); + // Remove the fields that are impacted by changes + delete beforePhotoResponse.headers["content-length"]; // Will change (timestamp) + delete afterPhotoResponse.headers["content-length"]; + delete beforePhotoResponse.headers.date; // May change if second ticks over + delete afterPhotoResponse.headers.date; + delete beforePhotoResponse.body.UpdatedAt; + delete afterPhotoResponse.body.UpdatedAt; + delete beforePhotoResponse.body.EditedAt; + delete afterPhotoResponse.body.EditedAt; + delete beforePhotoResponse.body.Details.UpdatedAt; + delete afterPhotoResponse.body.Details.UpdatedAt; + cleanAlbumsFilesAndLabels(beforePhotoResponse.body); + cleanAlbumsFilesAndLabels(afterPhotoResponse.body); + await t.expect(afterPhotoResponse).eql(beforePhotoResponse); +}) diff --git a/frontend/tests/acceptance/acceptance-auth/settings/account.js b/frontend/tests/acceptance/acceptance-auth/settings/account.js index e60932413..3a411119d 100644 --- a/frontend/tests/acceptance/acceptance-auth/settings/account.js +++ b/frontend/tests/acceptance/acceptance-auth/settings/account.js @@ -94,6 +94,7 @@ test.meta("testID", "account-003").meta({ type: "short", mode: "auth" })( .expect(Selector('tr[data-name="john-full"] td').nth(2).innerText) .notContains("20") .click(account.close); + await t.expect(account.close.exists).notOk(); await page.logout(); await page.login("john", "Zx78HJ-YFZMjS-aOyR6l-Bz8D2b"); @@ -107,6 +108,7 @@ test.meta("testID", "account-003").meta({ type: "short", mode: "auth" })( .expect(Selector("td").withText("john-full").visible) .notOk() .click(account.close); + await t.expect(account.close.exists).notOk(); await page.logout(); await page.login("john", "photoprism"); @@ -118,7 +120,9 @@ test.meta("testID", "account-003").meta({ type: "short", mode: "auth" })( .expect(Selector('tr[data-name="john-full"] td').nth(2).innerText) .contains("20") .expect(Selector('tr[data-name="john-full"] td').nth(2).innerText) - .notContains("–"); + .notContains("–") + .click(account.close); + await t.expect(account.close.exists).notOk(); await page.logout(); } ); @@ -184,13 +188,15 @@ test.meta("testID", "account-006").meta({ type: "short", mode: "auth" })( .typeText(account.passcode, "123456", { replace: true }) .click(account.confirm) .expect(account.qrcode.visible) - .ok(); + .ok() + .click(account.cancel); + await t.expect(account.cancel.exists).notOk(); await page.logout(); } ); test.meta("testID", "account-007").meta({ type: "short", mode: "auth" })("Core: Force rate limiting", async (t) => { - let counter = 0 + let counter = 0; do { if (await Selector(".p-notify--error").exists) { await t.click(Selector(".p-notify__close")); @@ -199,10 +205,10 @@ test.meta("testID", "account-007").meta({ type: "short", mode: "auth" })("Core: .typeText(Selector(".input-username input"), "admin", { replace: true }) .typeText(Selector(".input-password input"), "wrongpassword", { replace: true }) .click(Selector(".action-confirm")); - if (await Selector(".p-notify--error").withText("Too many requests").exists) { - break - } - } while (counter++ < 10) + if (await Selector(".p-notify--error").withText("Too many requests").exists) { + break; + } + } while (counter++ < 10); if (await Selector(".p-notify--error").exists) { await t.click(Selector(".p-notify__close")); } diff --git a/frontend/tests/acceptance/acceptance-auth/settings/general.js b/frontend/tests/acceptance/acceptance-auth/settings/general.js index e93065330..0429b1c2d 100644 --- a/frontend/tests/acceptance/acceptance-auth/settings/general.js +++ b/frontend/tests/acceptance/acceptance-auth/settings/general.js @@ -9,6 +9,7 @@ import Page from "../../page-model/page"; import Photo from "../../page-model/photo"; import PhotoEdit from "../../page-model/photo-edit"; import Album from "../../page-model/album"; +import AlbumDialog from "../../page-model/dialog-album"; import Settings from "../../page-model/settings"; import Library from "../../page-model/library"; import Notifies from "../../page-model/notifications"; @@ -25,77 +26,72 @@ const page = new Page(); const photo = new Photo(); const photoedit = new PhotoEdit(); const album = new Album(); +const albumdialog = new AlbumDialog(); const settings = new Settings(); const library = new Library(); const getPageUrl = ClientFunction(() => window.location.href); const notifies = new Notifies(); -test.meta("testID", "settings-general-001").meta({ type: "short", mode: "auth" })( - "Common: Disable delete", - async (t) => { - await menu.openPage("archive"); - await toolbar.checkToolbarActionAvailability("delete-all", true); - await photo.triggerHoverAction("nth", 0, "select"); - await contextmenu.checkContextMenuActionAvailability("delete", true); - await contextmenu.clearSelection(); - await menu.openPage("settings"); - await t.click(settings.deleteCheckbox); - await menu.openPage("archive"); - await toolbar.checkToolbarActionAvailability("delete-all", false); +test.meta("testID", "settings-general-001").meta({ type: "short", mode: "auth" })("Common: Disable delete", async (t) => { + await menu.openPage("archive"); + await toolbar.checkToolbarActionAvailability("delete-all", true); + await photo.triggerHoverAction("nth", 0, "select"); + await contextmenu.checkContextMenuActionAvailability("delete", true); + await contextmenu.clearSelection(); + await menu.openPage("settings"); + await t.click(settings.deleteCheckbox); + await menu.openPage("archive"); + await toolbar.checkToolbarActionAvailability("delete-all", false); - await photo.triggerHoverAction("nth", 0, "select"); + await photo.triggerHoverAction("nth", 0, "select"); - await contextmenu.checkContextMenuActionAvailability("restore", true); - await contextmenu.checkContextMenuActionAvailability("delete", false); - await contextmenu.clearSelection(); + await contextmenu.checkContextMenuActionAvailability("restore", true); + await contextmenu.checkContextMenuActionAvailability("delete", false); + await contextmenu.clearSelection(); - await menu.openPage("browse"); - await toolbar.search("stack:true"); - await photo.triggerHoverAction("nth", 0, "select"); - await contextmenu.triggerContextMenuAction("edit", ""); - await t.click(photoedit.filesTab); - await t.click(photoedit.toggleExpandFile.nth(1)); + await menu.openPage("browse"); + await toolbar.search("stack:true"); + await photo.triggerHoverAction("nth", 0, "select"); + await contextmenu.triggerContextMenuAction("edit", ""); + await t.click(photoedit.filesTab); + await t.click(photoedit.toggleExpandFile.nth(1)); - await t.expect(photoedit.deleteFile.visible).notOk(); + await t.expect(photoedit.deleteFile.visible).notOk(); - await t.click(photoedit.dialogClose); - await contextmenu.clearSelection(); - await menu.openPage("settings"); - await t.click(settings.deleteCheckbox); - await menu.openPage("browse"); - await toolbar.search("stack:true"); - await photo.triggerHoverAction("nth", 0, "select"); - await contextmenu.triggerContextMenuAction("edit", ""); - await t.click(photoedit.filesTab); - await t.click(photoedit.toggleExpandFile.nth(1)); + await t.click(photoedit.dialogClose); + await contextmenu.clearSelection(); + await menu.openPage("settings"); + await t.click(settings.deleteCheckbox); + await menu.openPage("browse"); + await toolbar.search("stack:true"); + await photo.triggerHoverAction("nth", 0, "select"); + await contextmenu.triggerContextMenuAction("edit", ""); + await t.click(photoedit.filesTab); + await t.click(photoedit.toggleExpandFile.nth(1)); - await t.expect(photoedit.deleteFile.visible).ok(); - } -); + await t.expect(photoedit.deleteFile.visible).ok(); +}); -test.meta("testID", "settings-general-002").meta({ type: "short", mode: "auth" })( - "Common: Change language", - async (t) => { - await menu.openNav(); - await t.expect(Selector("a.nav-browse").innerText).contains("Search"); +test.meta("testID", "settings-general-002").meta({ type: "short", mode: "auth" })("Common: Change language", async (t) => { + await menu.openNav(); + await t.expect(Selector("a.nav-browse").innerText).contains("Search"); - await menu.openPage("settings"); - await t - .click(settings.languageOpenSelection) - .hover(Selector("div").withText("Deutsch").parent('div[role="option"]')) - .click(Selector("div").withText("Deutsch").parent('div[role="option"]')); - await t.eval(() => location.reload()); + await menu.openPage("settings"); + await t + .click(settings.languageOpenSelection) + .hover(Selector("div").withText("Deutsch").parent('div[role="option"]')) + .click(Selector("div").withText("Deutsch").parent('div[role="option"]')); + await t.eval(() => location.reload()); - await t.expect(Selector("a.nav-browse").innerText).contains("Suche"); + await t.expect(Selector("a.nav-browse").innerText).contains("Suche"); - await t - .click(settings.languageOpenSelection) - .hover(Selector("div").withText("English").parent('div[role="option"]')) - .click(Selector("div").withText("English").parent('div[role="option"]')); + await t + .click(settings.languageOpenSelection) + .hover(Selector("div").withText("English").parent('div[role="option"]')) + .click(Selector("div").withText("English").parent('div[role="option"]')); - await t.expect(Selector("a.nav-browse").innerText).contains("Search"); - } -); + await t.expect(Selector("a.nav-browse").innerText).contains("Search"); +}); test.meta("testID", "settings-general-003").meta({ type: "short", mode: "auth" })( "Common: Disable pages: import, originals, logs, moments, places, library, calendar, services, account", @@ -128,13 +124,7 @@ test.meta("testID", "settings-general-003").meta({ type: "short", mode: "auth" } await menu.openPage("library"); - await t - .expect(library.importTab.visible) - .ok() - .expect(library.logsTab.visible) - .ok() - .expect(library.indexTab.visible) - .ok(); + await t.expect(library.importTab.visible).ok().expect(library.logsTab.visible).ok().expect(library.indexTab.visible).ok(); await menu.openPage("browse"); await notifies.waitForPhotosToLoad(7000); await photo.toggleSelectNthPhoto(0, "image"); @@ -162,7 +152,7 @@ test.meta("testID", "settings-general-003").meta({ type: "short", mode: "auth" } await menu.openPage("settings"); - await t.expect(settings.accountTab.visible).ok().expect(settings.servicesTab.visible).ok(); + await t.expect(settings.accountTab.visible).ok(); await menu.checkMenuItemAvailability("originals", true); await menu.checkMenuItemAvailability("folders", true); await menu.checkMenuItemAvailability("moments", true); @@ -206,32 +196,16 @@ test.meta("testID", "settings-general-003").meta({ type: "short", mode: "auth" } await photo.toggleSelectNthPhoto(0, "image"); await contextmenu.triggerContextMenuAction("edit"); - await t - .expect(photoedit.batchDialog.visible) - .notOk() - .expect(photoedit.locationAction.visible) - .notOk() - .click(photoedit.dialogClose); + await t.expect(photoedit.batchDialog.visible).notOk().expect(photoedit.locationAction.visible).notOk().click(photoedit.dialogClose); await photo.toggleSelectNthPhoto(1, "image"); await contextmenu.triggerContextMenuAction("edit"); - await t - .expect(photoedit.batchDialog.visible) - .ok() - .expect(photoedit.locationAction.visible) - .notOk() - .click(photoedit.dialogClose); + await t.expect(photoedit.batchDialog.visible).ok().expect(photoedit.locationAction.visible).notOk().click(photoedit.dialogClose); await contextmenu.clearSelection(); await menu.openPage("library"); - await t - .expect(library.importTab.visible) - .notOk() - .expect(library.logsTab.visible) - .notOk() - .expect(library.indexTab.visible) - .ok(); + await t.expect(library.importTab.visible).notOk().expect(library.logsTab.visible).notOk().expect(library.indexTab.visible).ok(); await menu.checkMenuItemAvailability("originals", false); await menu.checkMenuItemAvailability("folders", true); await menu.checkMenuItemAvailability("moments", false); @@ -241,13 +215,7 @@ test.meta("testID", "settings-general-003").meta({ type: "short", mode: "auth" } await menu.openPage("settings"); - await t - .expect(settings.accountTab.visible) - .notOk() - .expect(settings.servicesTab.visible) - .notOk() - .expect(settings.generalTab.visible) - .ok(); + await t.expect(settings.accountTab.visible).notOk().expect(settings.generalTab.visible).ok(); await t .click(settings.importCheckbox) @@ -270,13 +238,7 @@ test.meta("testID", "settings-general-003").meta({ type: "short", mode: "auth" } await menu.openPage("albums"); await menu.openPage("settings"); - await t - .expect(settings.accountTab.visible) - .ok() - .expect(settings.servicesTab.visible) - .ok() - .expect(settings.generalTab.visible) - .ok(); + await t.expect(settings.accountTab.visible).ok().expect(settings.generalTab.visible).ok(); if (t.browser.platform === "mobile") { if (await toolbar.openMobileToolbar.visible) { @@ -312,343 +274,724 @@ test.meta("testID", "settings-general-003").meta({ type: "short", mode: "auth" } } ); -test.meta("testID", "settings-general-004").meta({ type: "short", mode: "auth" })( - "Common: Disable people and labels", +test.meta("testID", "settings-general-004").meta({ type: "short", mode: "auth" })("Common: Disable people and labels", async (t) => { + //Use photo with all kinds of metadata + await toolbar.search("filename:Images/albums-002_3.jpg"); + await notifies.waitForSearchToFinish(7000); + await t.click(toolbar.cardsViewAction); + await t.click(page.cardTitle.nth(0)); + await t.click(photoedit.labelsTab); + + await t.expect(photoedit.addLabel.visible).ok(); + + await t.click(photoedit.peopleTab); + + await t.expect(Selector("div.p-faces").visible).ok(); + + await t.click(photoedit.dialogClose); + + // Lightbox sidebar baseline: with the People feature enabled, the + // sidebar renders the People header and markers controls. The PR + // that rewrote the sidebar gated both on $config.feature("people"), + // so this assertion fails if the feature flag no longer propagates. + await photoviewer.openPhotoViewer("nth", 0); + await photoviewer.openSidebar(); + await t.expect(Selector(".p-lightbox-sidebar .text-subtitle-2").withText("People").exists).ok(); + // Admin (Edit on) sees the pencil "Edit" button. The pencil carries both + // `.meta-markers-toggle` (visibility-toggle role, shared with the eye) and + // `.meta-faces-edit` (edit-mode discriminator); `markersEditToggle` is the + // compound selector that only matches the pencil variant. + await t.expect(photoviewer.markersEditToggle.exists).ok(); + await t.expect(photoviewer.sidebarLabels.exists).ok(); + await photoviewer.triggerPhotoViewerAction("close-button"); + + await photo.toggleSelectNthPhoto(0, "image"); + await t.click(toolbar.searchClearAction); + await notifies.waitForSearchToFinish(7000); + await photo.toggleSelectNthPhoto(1, "image"); + await contextmenu.triggerContextMenuAction("edit"); + + await t.expect(photoedit.batchDialog.visible).ok(); + await t.expect(photoedit.batchLabels.visible).ok(); + + await t.click(photoedit.dialogClose); + await contextmenu.clearSelection(); + + await menu.checkMenuItemAvailability("people", true); + await menu.checkMenuItemAvailability("labels", true); + await menu.openPage("settings"); + await t.click(settings.peopleCheckbox).click(settings.labelsCheckbox); + await t.eval(() => location.reload()); + await menu.openPage("browse"); + //Use photo with all kinds of metadata + await toolbar.search("filename:Images/albums-002_3.jpg"); + await notifies.waitForSearchToFinish(7000); + await t.click(toolbar.cardsViewAction); + await t.click(page.cardTitle.nth(0)); + await t.click(photoedit.labelsTab); + + await t.expect(photoedit.addLabel.exists).notOk(); + + await t.click(photoedit.peopleTab); + + await t.expect(Selector("div.p-faces ").exists).notOk(); + + await t.click(photoedit.dialogClose); + + // With People disabled the lightbox sidebar must hide the entire + // People section and the face-marker toggle/add controls, even for + // an admin on a photo that has markers in the fixtures. + await photoviewer.openPhotoViewer("nth", 0); + await photoviewer.openSidebar(); + await t.expect(Selector(".p-lightbox-sidebar .text-subtitle-2").withText("People").exists).notOk(); + await t.expect(photoviewer.markersVisibilityToggle.exists).notOk(); + await t.expect(photoviewer.markersEditToggle.exists).notOk(); + await t.expect(photoviewer.sidebarLabels.exists).notOk(); + await photoviewer.triggerPhotoViewerAction("close-button"); + + await photo.toggleSelectNthPhoto(0, "image"); + await t.click(toolbar.searchClearAction); + await notifies.waitForSearchToFinish(7000); + await photo.toggleSelectNthPhoto(1, "image"); + await contextmenu.triggerContextMenuAction("edit"); + + await t.expect(photoedit.batchDialog.visible).ok(); + await t.expect(photoedit.batchLabels.exists).notOk(); + + await t.click(photoedit.dialogClose); + await contextmenu.clearSelection(); + + await menu.checkMenuItemAvailability("people", false); + await menu.checkMenuItemAvailability("labels", false); + + await menu.openPage("settings"); + await t.click(settings.peopleCheckbox).click(settings.labelsCheckbox); + await menu.openPage("browse"); + + await menu.checkMenuItemAvailability("people", true); + await menu.checkMenuItemAvailability("labels", true); +}); + +test.meta("testID", "settings-general-005").meta({ type: "short", mode: "auth" })("Common: Disable private, archive and quality filter", async (t) => { + await menu.checkMenuItemAvailability("archive", true); + await menu.checkMenuItemAvailability("review", true); + await menu.checkMenuItemAvailability("private", true); + + await menu.openPage("browse"); + await t.eval(() => location.reload()); + await toolbar.search("photo:true stack:true"); + + await photo.triggerHoverAction("nth", 0, "select"); + + await contextmenu.checkContextMenuActionAvailability("archive", true); + await contextmenu.checkContextMenuActionAvailability("private", true); + + await contextmenu.triggerContextMenuAction("edit", ""); + await t.click(photoedit.infoTab); + + await photoedit.checkFieldDisabled(photoedit.privateInput, false); + + await t.click(photoedit.dialogClose); + await contextmenu.clearSelection(); + await toolbar.search("Viewpoint / Mexico / 2017"); + + await photo.checkPhotoVisibility("pqmxlr7188hz4bih", false); + + await toolbar.search("Truck / Vancouver / 2019"); + + await photo.checkPhotoVisibility("pqmxlr0kg161o9ek", false); + + await toolbar.search("Archive / 2020"); + + await photo.checkPhotoVisibility("pqnah1k2frui6p63", false); + + await t.navigateTo("/library/archive"); + await toolbar.checkToolbarActionAvailability("delete-all", true); + + await menu.openPage("settings"); + await t.click(settings.archiveCheckbox).click(settings.privateCheckbox).click(Selector(settings.libraryTab)).click(settings.reviewCheckbox); + + await menu.checkMenuItemAvailability("archive", false); + await menu.checkMenuItemAvailability("review", false); + await menu.checkMenuItemAvailability("private", false); + await menu.openPage("browse"); + await t.eval(() => location.reload()); + + await toolbar.search("photo:true"); + await photo.triggerHoverAction("nth", 0, "select"); + + await contextmenu.checkContextMenuActionAvailability("archive", false); + await contextmenu.checkContextMenuActionAvailability("private", false); + + await contextmenu.triggerContextMenuAction("edit", ""); + await t.click(photoedit.infoTab); + + //await photoedit.checkFieldDisabled(photoedit.privateInput, true); + + await t.click(photoedit.dialogClose); + await contextmenu.clearSelection(); + await toolbar.search("Viewpoint / Mexico / 2017"); + + await photo.checkPhotoVisibility("pqmxlr7188hz4bih", true); + + await toolbar.search("Truck / Vancouver / 2019"); + + await photo.checkPhotoVisibility("pqmxlr0kg161o9ek", false); + + await toolbar.search("Archive / 2020"); + + await photo.checkPhotoVisibility("pqnah1k2frui6p63", true); + + await t.navigateTo("/library/archive"); + await toolbar.checkToolbarActionAvailability("delete-all", false); + + await menu.openPage("settings"); + await t.click(settings.privateCheckbox).click(settings.archiveCheckbox).click(Selector(settings.libraryTab)).click(settings.reviewCheckbox); + + await menu.checkMenuItemAvailability("archive", true); + await menu.checkMenuItemAvailability("review", true); + await menu.checkMenuItemAvailability("private", true); +}); + +test.meta("testID", "settings-general-006").meta({ type: "short", mode: "auth" })("Common: Disable upload, download, edit and share", async (t) => { + await toolbar.checkToolbarActionAvailability("upload", true); + + await toolbar.search("photo:true stack:true"); + await photo.triggerHoverAction("nth", 0, "select"); + + await contextmenu.checkContextMenuActionAvailability("download", true); + await contextmenu.checkContextMenuActionAvailability("share", true); + await contextmenu.checkContextMenuActionAvailability("edit", true); + + await contextmenu.triggerContextMenuAction("edit", ""); + + await t.expect(photoedit.batchDialog.visible).notOk(); + + await photoedit.checkAllDetailsFieldsDisabled(false); + await t.expect(photoedit.infoTab.visible).ok(); + await t.click(photoedit.filesTab); + + await t + .expect(photoedit.downloadFile.nth(0).visible) + .ok() + .click(photoedit.toggleExpandFile.nth(1)) + .expect(photoedit.downloadFile.nth(0).visible) + .ok() + .expect(photoedit.deleteFile.visible) + .ok() + .click(photoedit.dialogClose); + + await photo.triggerHoverAction("nth", 1, "select"); + await contextmenu.triggerContextMenuAction("edit", ""); + + await t.expect(photoedit.batchDialog.visible).ok(); + await t.click(photoedit.dialogClose); + + await contextmenu.clearSelection(); + //Use photo with all kinds of metadata + await toolbar.search("filename:Images/albums-002_3.jpg"); + await notifies.waitForSearchToFinish(7000); + await photoviewer.openPhotoViewer("nth", 0); + + await photoviewer.checkPhotoViewerActionAvailability("download", true); + await photoviewer.checkPhotoViewerActionAvailability("edit-button", true); + + // Baseline sidebar assertion: with Edit enabled, every editable row + // surfaces its editor / dialog when clicked. + await photoviewer.openSidebar(); + await photoviewer.assertSidebarIsEditable(); + + await photoviewer.triggerPhotoViewerAction("close-button"); + await t.expect(Selector("div.p-lightbox__pswp").visible).notOk(); + + await menu.openPage("albums"); + await album.toggleSelectNthAlbum(0, "all"); + await contextmenu.checkContextMenuActionAvailability("download", true); + await contextmenu.triggerContextMenuAction("clear"); + await album.openNthAlbum(0); + await toolbar.checkToolbarActionAvailability("download", true); + + await menu.openPage("settings"); + + await t.click(settings.uploadCheckbox).click(settings.downloadCheckbox).click(settings.editCheckbox).click(settings.shareCheckbox); + await t.eval(() => location.reload()); + await t.navigateTo("/library/calendar"); + + await toolbar.checkToolbarActionAvailability("upload", false); + await album.checkHoverActionAvailability("nth", 2, "share", false); + + await album.triggerHoverAction("nth", 0, "select"); + + await contextmenu.checkContextMenuActionAvailability("edit", true); + await contextmenu.checkContextMenuActionAvailability("download", false); + await contextmenu.checkContextMenuActionAvailability("share", false); + + await contextmenu.clearSelection(); + await album.openNthAlbum(0); + + await toolbar.checkToolbarActionAvailability("upload", false); + await toolbar.checkToolbarActionAvailability("download", false); + await toolbar.checkToolbarActionAvailability("share", false); + await toolbar.checkToolbarActionAvailability("edit", true); + + await t.navigateTo("/library/folders"); + + await toolbar.checkToolbarActionAvailability("upload", false); + await album.checkHoverActionAvailability("nth", 0, "share", false); + + await album.triggerHoverAction("nth", 0, "select"); + + await contextmenu.checkContextMenuActionAvailability("edit", true); + await contextmenu.checkContextMenuActionAvailability("download", false); + await contextmenu.checkContextMenuActionAvailability("share", false); + + await contextmenu.clearSelection(); + await album.openNthAlbum(0); + + await toolbar.checkToolbarActionAvailability("upload", false); + await toolbar.checkToolbarActionAvailability("download", false); + await toolbar.checkToolbarActionAvailability("share", false); + await toolbar.checkToolbarActionAvailability("edit", true); + + await t.navigateTo("/library/albums"); + + await toolbar.checkToolbarActionAvailability("upload", false); + await album.checkHoverActionAvailability("nth", 0, "share", false); + + await album.triggerHoverAction("nth", 0, "select"); + + await contextmenu.checkContextMenuActionAvailability("edit", true); + await contextmenu.checkContextMenuActionAvailability("delete", true); + await contextmenu.checkContextMenuActionAvailability("download", false); + await contextmenu.checkContextMenuActionAvailability("share", false); + + await contextmenu.clearSelection(); + await album.openNthAlbum(0); + + await toolbar.checkToolbarActionAvailability("upload", false); + await toolbar.checkToolbarActionAvailability("download", false); + await toolbar.checkToolbarActionAvailability("share", false); + await toolbar.checkToolbarActionAvailability("edit", true); + + await t.navigateTo("/library/browse"); + + await toolbar.checkToolbarActionAvailability("upload", false); + + await toolbar.search("photo:true stack:true"); + await photo.triggerHoverAction("nth", 0, "select"); + + await contextmenu.checkContextMenuActionAvailability("download", false); + await contextmenu.checkContextMenuActionAvailability("share", false); + await contextmenu.checkContextMenuActionAvailability("edit", false); + + await contextmenu.clearSelection(); + await t.click(toolbar.cardsViewAction); + + //Use photo with all kinds of metadata + await toolbar.search("filename:Images/albums-002_3.jpg"); + await notifies.waitForSearchToFinish(7000); + await photoviewer.openPhotoViewer("nth", 0); + await photoviewer.checkPhotoViewerActionAvailability("download", false); + await photoviewer.checkPhotoViewerActionAvailability("edit-button", false); + + await photoviewer.openSidebar(); + // The first non-stacked photo has Title + Labels + Albums but no Caption or People; + // the Filmpreis-anchored block below covers the People positive case. + await photoviewer.assertSidebarIsReadOnly(); + await photoviewer.triggerPhotoViewerAction("close-button"); + await t.expect(Selector("div.p-lightbox__pswp").visible).notOk(); + + // Positive control for the eye toggle — search a photo with markers (the People + // section only renders the eye when people.length > 0 for non-editable users). + // `markersVisibilityToggle` resolves to the eye here because the pencil branch + // doesn't render for non-editable sessions. + await toolbar.search("Filmpreis"); + await photoviewer.openPhotoViewer("nth", 0); + await photoviewer.openSidebar(); + await t.expect(photoviewer.markersVisibilityToggle.visible).ok(); + await t.expect(photoviewer.markersEditToggle.exists).notOk(); + await photoviewer.triggerPhotoViewerAction("close-button"); + await t.expect(Selector("div.p-lightbox__pswp").visible).notOk(); + + await menu.openPage("settings"); + await t.click(settings.uploadCheckbox).click(settings.downloadCheckbox).click(settings.editCheckbox).click(settings.shareCheckbox); + await t.navigateTo("/library/browse"); + await photo.triggerHoverAction("nth", 0, "select"); + await photo.triggerHoverAction("nth", 1, "select"); + await contextmenu.triggerContextMenuAction("edit", ""); + + await t.expect(photoedit.batchDialog.visible).notOk(); + await t.click(photoedit.dialogClose); + + await contextmenu.clearSelection(); + await menu.openPage("settings"); + await t.click(settings.batchCheckbox); +}); + +test.meta("testID", "settings-general-007").meta({ type: "short", mode: "auth" })("Common: Configure start page", async (t) => { + await t.expect(getPageUrl()).contains("browse"); + + await menu.openPage("settings"); + await t + .click(settings.startpageOpenSelection) + .hover(Selector("div").withText("Places").parent('div[role="option"]')) + .click(Selector("div").withText("Places").parent('div[role="option"]')); + await page.logout(); + await page.login("admin", "photoprism"); + await t.expect(getPageUrl()).contains("places"); + await menu.openPage("settings"); + await t.click(settings.placesCheckbox); + await page.logout(); + await page.login("admin", "photoprism"); + await t.expect(getPageUrl()).contains("browse"); + await menu.openPage("settings"); + await t.click(settings.placesCheckbox); + await page.logout(); + await page.login("admin", "photoprism"); + await t.expect(getPageUrl()).contains("places"); + await page.logout(); + await page.login("admin", "photoprism"); + await t.expect(getPageUrl()).contains("places"); + await menu.openPage("settings"); + await t + .click(settings.startpageOpenSelection) + .hover(Selector("div").withText("Albums").parent('div[role="option"]')) + .click(Selector("div").withText("Albums").parent('div[role="option"]')); + await page.logout(); + await page.login("admin", "photoprism"); + await t.expect(getPageUrl()).contains("albums"); + await menu.openPage("settings"); + await t + .click(settings.startpageOpenSelection) + .hover(Selector("div").withText("Default").parent('div[role="option"]')) + .click(Selector("div").withText("Default").parent('div[role="option"]')); + await page.logout(); + await page.login("admin", "photoprism"); + await t.expect(getPageUrl()).contains("browse"); +}); + +test.meta("testID", "settings-general-008").meta({ type: "short", mode: "auth" })( + "Common: Disable albums, favorites, folders, and media", async (t) => { - await t.click(toolbar.cardsViewAction); - await t.click(page.cardTitle.nth(0)); - await t.click(photoedit.labelsTab); + await menu.checkMenuItemAvailability("albums", true); + await menu.checkMenuItemAvailability("favorites", true); + await menu.checkMenuItemAvailability("folders", true); + await menu.checkMenuItemAvailability("media", true); - await t.expect(photoedit.addLabel.visible).ok(); - - await t.click(photoedit.peopleTab); - - await t.expect(Selector("div.p-faces").visible).ok(); - - await t.click(photoedit.dialogClose); - await menu.checkMenuItemAvailability("people", true); - await menu.checkMenuItemAvailability("labels", true); await menu.openPage("settings"); - await t.click(settings.peopleCheckbox).click(settings.labelsCheckbox); + await t + .click(settings.albumsCheckbox) + .click(settings.favoritesCheckbox) + .click(settings.foldersCheckbox) + .click(settings.videosCheckbox); await t.eval(() => location.reload()); - await menu.openPage("browse"); - await t.click(toolbar.cardsViewAction); - await t.click(page.cardTitle.nth(0)); - await t.click(photoedit.labelsTab); - await t.expect(photoedit.addLabel.exists).notOk(); - - await t.click(photoedit.peopleTab); - - await t.expect(Selector("div.p-faces ").exists).notOk(); - - await t.click(photoedit.dialogClose); - - await menu.checkMenuItemAvailability("people", false); - await menu.checkMenuItemAvailability("labels", false); + await menu.checkMenuItemAvailability("albums", false); + await menu.checkMenuItemAvailability("favorites", false); + await menu.checkMenuItemAvailability("folders", false); + await menu.checkMenuItemAvailability("media", false); await menu.openPage("settings"); - await t.click(settings.peopleCheckbox).click(settings.labelsCheckbox); - await menu.openPage("browse"); + await t + .click(settings.albumsCheckbox) + .click(settings.favoritesCheckbox) + .click(settings.foldersCheckbox) + .click(settings.videosCheckbox); - await menu.checkMenuItemAvailability("people", true); - await menu.checkMenuItemAvailability("labels", true); + await menu.checkMenuItemAvailability("albums", true); + await menu.checkMenuItemAvailability("favorites", true); + await menu.checkMenuItemAvailability("folders", true); + await menu.checkMenuItemAvailability("media", true); } ); -test.meta("testID", "settings-general-005").meta({ type: "short", mode: "auth" })( - "Common: Disable private, archive and quality filter", + +test.meta("testID", "settings-general-009").meta({ type: "short", mode: "auth" })( + "Common: Disable album downloads only - file downloads still work", async (t) => { - await menu.checkMenuItemAvailability("archive", true); - await menu.checkMenuItemAvailability("review", true); - await menu.checkMenuItemAvailability("private", true); - - await menu.openPage("browse"); - await t.eval(() => location.reload()); - await toolbar.search("photo:true stack:true"); - - await photo.triggerHoverAction("nth", 0, "select"); - - await contextmenu.checkContextMenuActionAvailability("archive", true); - await contextmenu.checkContextMenuActionAvailability("private", true); - - await contextmenu.triggerContextMenuAction("edit", ""); - await t.click(photoedit.infoTab); - - await photoedit.checkFieldDisabled(photoedit.privateInput, false); - - await t.click(photoedit.dialogClose); - await contextmenu.clearSelection(); - await toolbar.search("Viewpoint / Mexico / 2017"); - - await photo.checkPhotoVisibility("pqmxlr7188hz4bih", false); - - await toolbar.search("Truck / Vancouver / 2019"); - - await photo.checkPhotoVisibility("pqmxlr0kg161o9ek", false); - - await toolbar.search("Archive / 2020"); - - await photo.checkPhotoVisibility("pqnah1k2frui6p63", false); - - await t.navigateTo("/library/archive"); - await toolbar.checkToolbarActionAvailability("delete-all", true); - - await menu.openPage("settings"); - await t - .click(settings.archiveCheckbox) - .click(settings.privateCheckbox) - .click(Selector(settings.libraryTab)) - .click(settings.reviewCheckbox); - - await menu.checkMenuItemAvailability("archive", false); - await menu.checkMenuItemAvailability("review", false); - await menu.checkMenuItemAvailability("private", false); - await menu.openPage("browse"); - await t.eval(() => location.reload()); - - await toolbar.search("photo:true"); - await photo.triggerHoverAction("nth", 0, "select"); - - await contextmenu.checkContextMenuActionAvailability("archive", false); - await contextmenu.checkContextMenuActionAvailability("private", false); - - await contextmenu.triggerContextMenuAction("edit", ""); - await t.click(photoedit.infoTab); - - //await photoedit.checkFieldDisabled(photoedit.privateInput, true); - - await t.click(photoedit.dialogClose); - await contextmenu.clearSelection(); - await toolbar.search("Viewpoint / Mexico / 2017"); - - await photo.checkPhotoVisibility("pqmxlr7188hz4bih", true); - - await toolbar.search("Truck / Vancouver / 2019"); - - await photo.checkPhotoVisibility("pqmxlr0kg161o9ek", false); - - await toolbar.search("Archive / 2020"); - - await photo.checkPhotoVisibility("pqnah1k2frui6p63", true); - - await t.navigateTo("/library/archive"); - await toolbar.checkToolbarActionAvailability("delete-all", false); - - await menu.openPage("settings"); - await t - .click(settings.privateCheckbox) - .click(settings.archiveCheckbox) - .click(Selector(settings.libraryTab)) - .click(settings.reviewCheckbox); - - await menu.checkMenuItemAvailability("archive", true); - await menu.checkMenuItemAvailability("review", true); - await menu.checkMenuItemAvailability("private", true); - } -); - -test.meta("testID", "settings-general-006").meta({ type: "short", mode: "auth" })( - "Common: Disable upload, download, edit and share", - async (t) => { - await toolbar.checkToolbarActionAvailability("upload", true); - - await toolbar.search("photo:true stack:true"); - await photo.triggerHoverAction("nth", 0, "select"); - - await contextmenu.checkContextMenuActionAvailability("download", true); - await contextmenu.checkContextMenuActionAvailability("share", true); - await contextmenu.checkContextMenuActionAvailability("edit", true); - - await contextmenu.triggerContextMenuAction("edit", ""); - - await t.expect(photoedit.batchDialog.visible).notOk(); - - await photoedit.checkAllDetailsFieldsDisabled(false); - await t.expect(photoedit.infoTab.visible).ok(); - await t.click(photoedit.filesTab); - - await t - .expect(photoedit.downloadFile.nth(0).visible) - .ok() - .click(photoedit.toggleExpandFile.nth(1)) - .expect(photoedit.downloadFile.nth(0).visible) - .ok() - .expect(photoedit.deleteFile.visible) - .ok() - .click(photoedit.dialogClose); - - await photo.triggerHoverAction("nth", 1, "select"); - await contextmenu.triggerContextMenuAction("edit", ""); - - await t.expect(photoedit.batchDialog.visible).ok(); - await t.click(photoedit.dialogClose); - - await contextmenu.clearSelection(); - await toolbar.search("photo:true"); - await photoviewer.openPhotoViewer("nth", 0); - - await photoviewer.checkPhotoViewerActionAvailability("download", true); - await photoviewer.checkPhotoViewerActionAvailability("edit-button", true); - - await photoviewer.triggerPhotoViewerAction("close-button"); - await t.expect(Selector("div.p-lightbox__pswp").visible).notOk(); - await menu.openPage("albums"); + await notifies.waitForAlbumsToLoad(7000); + await album.toggleSelectNthAlbum(0, "all"); await contextmenu.checkContextMenuActionAvailability("download", true); - await contextmenu.triggerContextMenuAction("clear"); + await contextmenu.clearSelection(); + await album.openNthAlbum(0); await toolbar.checkToolbarActionAvailability("download", true); - await menu.openPage("settings"); - - await t - .click(settings.uploadCheckbox) - .click(settings.downloadCheckbox) - .click(settings.editCheckbox) - .click(settings.shareCheckbox); - await t.eval(() => location.reload()); - await t.navigateTo("/library/calendar"); - - await toolbar.checkToolbarActionAvailability("upload", false); - await album.checkHoverActionAvailability("nth", 2, "share", false); - - await album.triggerHoverAction("nth", 0, "select"); - - await contextmenu.checkContextMenuActionAvailability("edit", true); - await contextmenu.checkContextMenuActionAvailability("download", false); - await contextmenu.checkContextMenuActionAvailability("share", false); - - await contextmenu.clearSelection(); - await album.openNthAlbum(0); - - await toolbar.checkToolbarActionAvailability("upload", false); - await toolbar.checkToolbarActionAvailability("download", false); - await toolbar.checkToolbarActionAvailability("share", false); - await toolbar.checkToolbarActionAvailability("edit", true); - - await t.navigateTo("/library/folders"); - - await toolbar.checkToolbarActionAvailability("upload", false); - await album.checkHoverActionAvailability("nth", 0, "share", false); - - await album.triggerHoverAction("nth", 0, "select"); - - await contextmenu.checkContextMenuActionAvailability("edit", true); - await contextmenu.checkContextMenuActionAvailability("download", false); - await contextmenu.checkContextMenuActionAvailability("share", false); - - await contextmenu.clearSelection(); - await album.openNthAlbum(0); - - await toolbar.checkToolbarActionAvailability("upload", false); - await toolbar.checkToolbarActionAvailability("download", false); - await toolbar.checkToolbarActionAvailability("share", false); - await toolbar.checkToolbarActionAvailability("edit", true); - - await t.navigateTo("/library/albums"); - - await toolbar.checkToolbarActionAvailability("upload", false); - await album.checkHoverActionAvailability("nth", 0, "share", false); - - await album.triggerHoverAction("nth", 0, "select"); - - await contextmenu.checkContextMenuActionAvailability("edit", true); - await contextmenu.checkContextMenuActionAvailability("delete", true); - await contextmenu.checkContextMenuActionAvailability("download", false); - await contextmenu.checkContextMenuActionAvailability("share", false); - - await contextmenu.clearSelection(); - await album.openNthAlbum(0); - - await toolbar.checkToolbarActionAvailability("upload", false); - await toolbar.checkToolbarActionAvailability("download", false); - await toolbar.checkToolbarActionAvailability("share", false); - await toolbar.checkToolbarActionAvailability("edit", true); - await t.navigateTo("/library/browse"); - - await toolbar.checkToolbarActionAvailability("upload", false); - await toolbar.search("photo:true stack:true"); await photo.triggerHoverAction("nth", 0, "select"); - await contextmenu.checkContextMenuActionAvailability("download", false); - await contextmenu.checkContextMenuActionAvailability("share", false); - await contextmenu.checkContextMenuActionAvailability("edit", false); - + await contextmenu.checkContextMenuActionAvailability("download", true); await contextmenu.clearSelection(); - await t.click(toolbar.cardsViewAction); await toolbar.search("photo:true"); await photoviewer.openPhotoViewer("nth", 0); - await photoviewer.checkPhotoViewerActionAvailability("download", false); - await photoviewer.checkPhotoViewerActionAvailability("edit-button", false); + await photoviewer.checkPhotoViewerActionAvailability("download", true); await photoviewer.triggerPhotoViewerAction("close-button"); await t.expect(Selector("div.p-lightbox__pswp").visible).notOk(); - await menu.openPage("settings"); - await t - .click(settings.uploadCheckbox) - .click(settings.downloadCheckbox) - .click(settings.editCheckbox) - .click(settings.shareCheckbox); - await t.navigateTo("/library/browse"); + await toolbar.search("photo:true stack:true"); await photo.triggerHoverAction("nth", 0, "select"); - await photo.triggerHoverAction("nth", 1, "select"); await contextmenu.triggerContextMenuAction("edit", ""); - - await t.expect(photoedit.batchDialog.visible).notOk(); + await t.click(photoedit.filesTab); + await t.expect(photoedit.downloadFile.nth(0).visible).ok(); await t.click(photoedit.dialogClose); - await contextmenu.clearSelection(); + await menu.openPage("settings"); - await t.click(settings.batchCheckbox); + await t.click(Selector(settings.collectionsTab)); + await t.wait(500); + await t.click(settings.albumDownloadDisabledCheckbox); + await t.wait(500); + + await menu.openPage("albums"); + await notifies.waitForAlbumsToLoad(7000); + + await album.toggleSelectNthAlbum(0, "all"); + await contextmenu.checkContextMenuActionAvailability("download", false); + await contextmenu.clearSelection(); + + await album.openNthAlbum(0); + await toolbar.checkToolbarActionAvailability("download", false); + + await t.navigateTo("/library/browse"); + await toolbar.search("photo:true stack:true"); + await photo.triggerHoverAction("nth", 0, "select"); + + await contextmenu.checkContextMenuActionAvailability("download", true); + + await photo.triggerHoverAction("nth", 1, "select"); + await contextmenu.checkContextMenuActionAvailability("download", true); + await contextmenu.clearSelection(); + + await toolbar.search("photo:true"); + await photoviewer.openPhotoViewer("nth", 0); + await photoviewer.checkPhotoViewerActionAvailability("download", true); + await photoviewer.triggerPhotoViewerAction("close-button"); + await t.expect(Selector("div.p-lightbox__pswp").visible).notOk(); + + await toolbar.search("photo:true stack:true"); + await photo.triggerHoverAction("nth", 0, "select"); + await contextmenu.triggerContextMenuAction("edit", ""); + await t.click(photoedit.filesTab); + await t.expect(photoedit.downloadFile.nth(0).visible).ok(); + await t.click(photoedit.dialogClose); + await contextmenu.clearSelection(); + + await menu.openPage("settings"); + await t.click(Selector(settings.collectionsTab)); + await t.wait(500); + await t.click(settings.albumDownloadDisabledCheckbox); + await t.wait(500); + + await menu.openPage("albums"); + await notifies.waitForAlbumsToLoad(7000); + await album.toggleSelectNthAlbum(0, "all"); + await contextmenu.checkContextMenuActionAvailability("download", true); + await contextmenu.clearSelection(); } ); -test.meta("testID", "settings-general-007").meta({ type: "short", mode: "auth" })( - "Common: Configure start page", +test.meta("testID", "settings-general-011").meta({ type: "short", mode: "auth" })( + "Common: Change file download name setting and verify persistence", async (t) => { - await t.expect(getPageUrl()).contains("browse"); + await menu.openPage("settings"); + await t.click(Selector(settings.libraryTab)); + await t.wait(500); - await menu.openPage("settings"); - await t - .click(settings.startpageOpenSelection) - .hover(Selector("div").withText("Places").parent('div[role="option"]')) - .click(Selector("div").withText("Places").parent('div[role="option"]')); - await page.logout(); - await page.login("admin", "photoprism"); - await t.expect(getPageUrl()).contains("places"); - await menu.openPage("settings"); - await t.click(settings.placesCheckbox); - await page.logout(); - await page.login("admin", "photoprism"); - await t.expect(getPageUrl()).contains("browse"); - await menu.openPage("settings"); - await t.click(settings.placesCheckbox); - await page.logout(); - await page.login("admin", "photoprism"); - await t.expect(getPageUrl()).contains("places"); - await page.logout(); - await page.login("admin", "photoprism"); - await t.expect(getPageUrl()).contains("places"); - await menu.openPage("settings"); - await t - .click(settings.startpageOpenSelection) - .hover(Selector("div").withText("Albums").parent('div[role="option"]')) - .click(Selector("div").withText("Albums").parent('div[role="option"]')); - await page.logout(); - await page.login("admin", "photoprism"); - await t.expect(getPageUrl()).contains("albums"); - await menu.openPage("settings"); - await t - .click(settings.startpageOpenSelection) - .hover(Selector("div").withText("Default").parent('div[role="option"]')) - .click(Selector("div").withText("Default").parent('div[role="option"]')); - await page.logout(); - await page.login("admin", "photoprism"); - await t.expect(getPageUrl()).contains("browse"); + await t.click(settings.downloadNameSelect); + await t.click(Selector(".v-list-item").withText("Original Name")); + await t.wait(500); + + await t.expect(Selector(".input-download-name .v-field__input").innerText).contains("Original"); + + await t.eval(() => location.reload()); + await t.click(Selector(settings.libraryTab)); + await t.wait(500); + await t.expect(Selector(".input-download-name .v-field__input").innerText).contains("Original"); + + await t.click(settings.downloadNameSelect); + await t.click(Selector(".v-list-item").withText("Share Friendly")); + await t.wait(500); + + await t.expect(Selector(".input-download-name .v-field__input").innerText).contains("Share"); + + await t.click(settings.downloadNameSelect); + await t.click(Selector(".v-list-item").withText("Current Name")); + await t.wait(500); + + await t.expect(Selector(".input-download-name .v-field__input").innerText).contains("Current"); + } +); + +test.meta("testID", "settings-general-012").meta({ type: "short", mode: "auth" })( + "Common: Change album download name setting and verify persistence", + async (t) => { + await menu.openPage("settings"); + await t.click(Selector(settings.collectionsTab)); + await t.wait(500); + + await t.click(settings.albumDownloadNameSelect); + await t.click(Selector(".v-list-item").withText("Original Name")); + await t.wait(500); + + await t.expect(Selector(".input-album-download-name .v-field__input").innerText).contains("Original"); + + await t.eval(() => location.reload()); + await t.click(Selector(settings.collectionsTab)); + await t.wait(500); + await t.expect(Selector(".input-album-download-name .v-field__input").innerText).contains("Original"); + + await t.click(settings.albumDownloadNameSelect); + await t.click(Selector(".v-list-item").withText("Share Friendly")); + await t.wait(500); + + await t.expect(Selector(".input-album-download-name .v-field__input").innerText).contains("Share"); + + await t.click(settings.albumDownloadNameSelect); + await t.click(Selector(".v-list-item").withText("Current Name")); + await t.wait(500); + + await t.expect(Selector(".input-album-download-name .v-field__input").innerText).contains("Current"); + } +); + +test.meta("testID", "settings-general-013").meta({ type: "short", mode: "auth" })( + "Common: Default album sort order is applied to newly created albums", + async (t) => { + await menu.openPage("settings"); + await t.click(Selector(settings.collectionsTab)); + await t.wait(500); + + await t.click(settings.albumOrderSelect); + await t.click(Selector(".v-list-item").withText("Oldest First")); + await t.wait(500); + await t.expect(Selector(".input-album-order .v-field__input").innerText).contains("Oldest"); + + await menu.openPage("albums"); + await notifies.waitForAlbumsToLoad(7000); + const initialAlbumCount = await album.getAlbumCount("all"); + + await toolbar.triggerToolbarAction("add"); + await t.wait(1000); + + const albumCountAfterCreate = await album.getAlbumCount("all"); + await t.expect(albumCountAfterCreate).eql(initialAlbumCount + 1); + + const newAlbumUid = await album.getNthAlbumUid("all", 0); + + await album.openAlbumWithUid(newAlbumUid); + await t.wait(500); + + await toolbar.triggerToolbarAction("edit"); + await t.wait(500); + + await t.expect(albumdialog.sortOrderValue.innerText).contains("Oldest"); + + await t.click(albumdialog.dialogCancel); + await t.wait(300); + + await toolbar.triggerToolbarAction("delete"); + await t.wait(500); + + await menu.openPage("settings"); + await t.click(Selector(settings.collectionsTab)); + await t.wait(500); + + await t.click(settings.albumOrderSelect); + await t.click(Selector(".v-list-item").withText("Newest First")); + await t.wait(500); + await t.expect(Selector(".input-album-order .v-field__input").innerText).contains("Newest"); + } +); + +test.meta("testID", "settings-general-014").meta({ type: "short", mode: "auth" })( + "Common: Change default album order settings and verify persistence", + async (t) => { + await menu.openPage("settings"); + await t.click(Selector(settings.collectionsTab)); + await t.wait(500); + + await t.click(settings.albumOrderSelect); + await t.click(Selector(".v-list-item").withText("Oldest First")); + await t.wait(500); + await t.expect(Selector(".input-album-order .v-field__input").innerText).contains("Oldest"); + + await t.click(settings.folderOrderSelect); + await t.click(Selector(".v-list-item").withText("File Name")); + await t.wait(500); + await t.expect(Selector(".input-folder-order .v-field__input").innerText).contains("File Name"); + + await t.eval(() => location.reload()); + await t.click(Selector(settings.collectionsTab)); + await t.wait(500); + await t.expect(Selector(".input-album-order .v-field__input").innerText).contains("Oldest"); + await t.expect(Selector(".input-folder-order .v-field__input").innerText).contains("File Name"); + + await t.click(settings.albumOrderSelect); + await t.click(Selector(".v-list-item").withText("Newest First")); + await t.wait(500); + + await t.click(settings.folderOrderSelect); + await t.click(Selector(".v-list-item").withText("Newest First")); + await t.wait(500); + + await t.expect(Selector(".input-album-order .v-field__input").innerText).contains("Newest"); + await t.expect(Selector(".input-folder-order .v-field__input").innerText).contains("Newest"); + } +); + +test.meta("testID", "settings-general-015").meta({ type: "short", mode: "auth" })( + "Common: Toggle accessibility settings and verify persistence", + async (t) => { + const hasReduceMotionClass = ClientFunction(() => document.documentElement.classList.contains("reduce-motion")); + const reloadPage = ClientFunction(() => window.location.reload()); + const setNoReloadSentinel = ClientFunction(() => { + window.__ppNoReload = true; + }); + const noReloadSentinel = ClientFunction(() => window.__ppNoReload === true); + + await menu.openPage("settings"); + await t.click(Selector(settings.generalTab)); + await t.wait(500); + + // A window sentinel detects an unexpected full-page reload: the live toggles below + // (Reduce Motion, Open on Hover) must NOT reload, so the sentinel must survive them. + await setNoReloadSentinel(); + + // Reduce Motion applies a live class without reloading the page. + await t.expect(Selector(".input-reduce-motion input").checked).notOk(); + await t.expect(hasReduceMotionClass()).notOk(); + await t.click(settings.reduceMotionCheckbox); + await t.wait(500); + await t.expect(Selector(".input-reduce-motion input").checked).ok(); + await t.expect(hasReduceMotionClass()).ok(); + await t.expect(noReloadSentinel()).ok(); + + // Open on Hover persists as a plain preference (unchecking the default). + await t.click(settings.openOnHoverCheckbox); + await t.wait(500); + await t.expect(Selector(".input-open-on-hover input").checked).notOk(); + await t.expect(noReloadSentinel()).ok(); + + // An explicit reload clears the sentinel; the settings must persist across it. + await reloadPage(); + await t.expect(noReloadSentinel()).notOk(); + await t.click(Selector(settings.generalTab)); + await t.wait(500); + await t.expect(Selector(".input-reduce-motion input").checked).ok(); + await t.expect(hasReduceMotionClass()).ok(); + await t.expect(Selector(".input-open-on-hover input").checked).notOk(); + + // Restore defaults so the shared fixture state is left unchanged. + await t.click(settings.reduceMotionCheckbox); + await t.wait(500); + await t.click(settings.openOnHoverCheckbox); + await t.wait(500); + await t.expect(Selector(".input-reduce-motion input").checked).notOk(); + await t.expect(hasReduceMotionClass()).notOk(); + await t.expect(Selector(".input-open-on-hover input").checked).ok(); } ); diff --git a/frontend/tests/acceptance/acceptance-auth/sharing.js b/frontend/tests/acceptance/acceptance-auth/sharing.js index 7be22ce25..9d41a7a23 100644 --- a/frontend/tests/acceptance/acceptance-auth/sharing.js +++ b/frontend/tests/acceptance/acceptance-auth/sharing.js @@ -128,12 +128,12 @@ test.meta("testID", "sharing-001").meta({ mode: "auth" })("Common: Create, view, await t.navigateTo("http://localhost:2343/s/secretfortesting"); await t - .expect(toolbar.toolbarSecondTitle.withText("Christmas").visible) - .notOk() - .expect(toolbar.toolbarSecondTitle.withText("Albums").visible) - .notOk() .expect(Selector(".input-username input").visible) - .ok(); + .ok() + .expect(toolbar.toolbarSecondTitle.withText("Christmas").exists) + .notOk() + .expect(toolbar.toolbarSecondTitle.withText("Albums").exists) + .notOk(); }); test.meta("testID", "sharing-002").meta({ type: "short", mode: "auth" })("Multi-Window: Verify visitor role has limited permissions", async (t) => { @@ -197,3 +197,26 @@ test.meta("testID", "sharing-002").meta({ type: "short", mode: "auth" })("Multi- await contextmenu.checkContextMenuActionAvailability("share", false); await contextmenu.clearSelection(); }); + +test.meta("testID", "sharing-003").meta({ type: "short", mode: "auth" })("Common: Lightbox sidebar shows only restricted metadata on share links", async (t) => { + await t.useRole(Role.anonymous()); + await t.navigateTo("http://localhost:2343/s/2t6124pb6d/holiday"); + await t.expect(toolbar.toolbarSecondTitle.withText("Holiday").visible).ok(); + + await photoviewer.openPhotoViewer("nth", 1); + await photoviewer.openSidebar(); + + await t.expect(photoviewer.sidebarRow("mdi-calendar").exists).ok(); + + await photoviewer.assertSidebarIsReadOnly({ restricted: true}); + // Merged file row renders for restricted sessions (type + size as + // the title) but the filename subtitle must be suppressed. + await t.expect(Selector(".p-lightbox-sidebar .meta-file .v-list-item-subtitle").exists).notOk(); + await t.expect(Selector(".p-lightbox-sidebar .text-subtitle-2").withText("People").exists).notOk(); + await t.expect(Selector(".p-lightbox-sidebar .text-subtitle-2").withText("Labels").exists).notOk(); + await t.expect(Selector(".p-lightbox-sidebar .text-subtitle-2").withText("Albums").exists).ok(); + await t.expect(Selector(".p-lightbox-sidebar .text-subtitle-2").withText("Keywords").exists).notOk(); + await t.expect(Selector(".p-lightbox-sidebar .text-subtitle-2").withText("Notes").exists).notOk(); + + await photoviewer.triggerPhotoViewerAction("close-button"); +}); diff --git a/frontend/tests/acceptance/acceptance-public/albums.js b/frontend/tests/acceptance/acceptance-public/albums.js index da5fc224b..6e5da7238 100644 --- a/frontend/tests/acceptance/acceptance-public/albums.js +++ b/frontend/tests/acceptance/acceptance-public/albums.js @@ -10,8 +10,19 @@ import Page from "../page-model/page"; import AlbumDialog from "../page-model/dialog-album"; import PhotoEdit from "../page-model/photo-edit"; import Notifies from "../page-model/notifications"; +import { helperBeforeFixture, helperBeforeEach, helperAfterEach, logTime, logTimeEnd } from "../page-model/helpers"; -fixture`Test albums`.page`${testcafeconfig.url}`; +fixture`Test albums` +.page`${testcafeconfig.url}` +.beforeEach(async t => { + await helperBeforeEach(t); +}) +.afterEach(async t => { + await helperAfterEach(t); +}) +.before(async ctx => { + await helperBeforeFixture(ctx); +}); const menu = new Menu(); const album = new Album(); @@ -52,9 +63,11 @@ test.meta("testID", "albums-002").meta({ type: "short", mode: "public" })("Commo await t .click(photoedit.infoTab) - .expect(Selector("td").withText("Albums").visible) + .expect(Selector("td").withText("Favorite").visible) // make sure the UI is there + .ok() + .expect(Selector("td").withText("Albums").exists) .notOk() - .expect(Selector("td").withText("NotYetExistingAlbum").visible) + .expect(Selector("td").withText("NotYetExistingAlbum").exists) .notOk() .click(photoedit.dialogClose); @@ -93,9 +106,11 @@ test.meta("testID", "albums-002").meta({ type: "short", mode: "public" })("Commo await t .click(photoedit.infoTab) - .expect(Selector("td").withText("Albums").visible) + .expect(Selector("td").withText("Favorite").visible) // make sure the UI is there + .ok() + .expect(Selector("td").withText("Albums").exists) .notOk() - .expect(Selector("td").withText("NotYetExistingAlbum").visible) + .expect(Selector("td").withText("NotYetExistingAlbum").exists) .notOk() .click(photoedit.dialogClose); }); @@ -122,12 +137,17 @@ test.meta("testID", "albums-003").meta({ type: "short", mode: "public" })("Commo await t.expect(albumdialog.description.value).eql("All my animals").expect(albumdialog.category.value).eql("Pets"); await t.click(albumdialog.description).pressKey("ctrl+a delete"); - await t.click(albumdialog.category).click(albumdialog.category).pressKey("ctrl+a delete").click(Selector("form.form-album-edit i.mdi-bookmark")); + await t.click(albumdialog.category).click(albumdialog.category).pressKey("ctrl+a delete").click(Selector("form.form-album-edit div.v-toolbar-title")); await t.expect(albumdialog.category.value).eql(""); await t.click(albumdialog.dialogSave); await menu.openPage("albums"); await t.expect(Selector("div").withText("Holiday").visible).ok().expect(Selector("div").withText("Animals").exists).notOk(); + + await album.openAlbumWithUid(AlbumUid); + await toolbar.triggerToolbarAction("edit"); + await t.expect(albumdialog.category.value).eql(""); + await t.click(albumdialog.dialogCancel); }); test.meta("testID", "albums-004").meta({ type: "short", mode: "public" })("Common: Add/Remove Photos to/from multiple albums", async (t) => { @@ -152,16 +172,20 @@ test.meta("testID", "albums-004").meta({ type: "short", mode: "public" })("Commo // Verify photos are not in any albums initially await page.clickCardTitleOfUID(FirstPhotoUid); + logTime('infoTab'); await t .click(photoedit.infoTab) - .expect(Selector("td").withText("Albums").visible) + .expect(Selector("td").withText("Favorite").visible) // make sure the UI is there + .ok() + .expect(Selector("td").withText("Albums").exists) // visible.notOk takes 5 seconds .notOk() - .expect(Selector("td").withText("Holiday").visible) + .expect(Selector("td").withText("Holiday").exists) // visible.notOk takes 5 seconds .notOk() - .expect(Selector("td").withText("Christmas").visible) + .expect(Selector("td").withText("Christmas").exists) // visible.notOk takes 5 seconds .notOk() .click(photoedit.dialogClose); + logTimeEnd('infoTab'); // Select both photos and add to multiple albums simultaneously await photo.selectPhotoFromUID(SecondPhotoUid); await photoviewer.openPhotoViewer("uid", FirstPhotoUid); @@ -218,9 +242,9 @@ test.meta("testID", "albums-004").meta({ type: "short", mode: "public" })("Commo await page.clickCardTitleOfUID(FirstPhotoUid); await t .click(photoedit.infoTab) - .expect(Selector("td").withText("Albums").visible) + .expect(Selector("td").withText("Albums").visible) // We now know the UI is there .ok() - .expect(Selector("td").withText("Holiday").visible) + .expect(Selector("td").withText("Holiday").exists) // visible.notOk takes 5 seconds .notOk() .expect(Selector("td").withText("Christmas").visible) .ok() @@ -248,13 +272,15 @@ test.meta("testID", "albums-004").meta({ type: "short", mode: "public" })("Commo await page.clickCardTitleOfUID(FirstPhotoUid); await t .click(photoedit.infoTab) - .expect(Selector("td").withText("Albums").visible) + .expect(Selector("td").withText("Favorite").visible) // make sure the UI is there + .ok() + .expect(Selector("td").withText("Albums").exists)// visible.notOk takes 5 seconds .notOk() - .expect(Selector("td").withText("Food").visible) + .expect(Selector("td").withText("Food").exists) // visible.notOk takes 5 seconds .notOk() - .expect(Selector("td").withText("Holiday").visible) + .expect(Selector("td").withText("Holiday").exists) // visible.notOk takes 5 seconds .notOk() - .expect(Selector("td").withText("Christmas").visible) + .expect(Selector("td").withText("Christmas").exists) // visible.notOk takes 5 seconds .notOk() .click(photoedit.dialogClose); }); diff --git a/frontend/tests/acceptance/acceptance-public/batch.js b/frontend/tests/acceptance/acceptance-public/batch.js index e619793f3..25b1d00dd 100644 --- a/frontend/tests/acceptance/acceptance-public/batch.js +++ b/frontend/tests/acceptance/acceptance-public/batch.js @@ -9,8 +9,19 @@ import PhotoViewer from "../page-model/photoviewer"; import Page from "../page-model/page"; import PhotoEdit from "../page-model/photo-edit"; import Notifies from "../page-model/notifications"; +import { helperBeforeFixture, helperBeforeEach, helperAfterEach } from "../page-model/helpers"; -fixture`Test batch edit`.page`${testcafeconfig.url}`; +fixture`Test batch edit` +.page`${testcafeconfig.url}` +.beforeEach(async t => { + await helperBeforeEach(t); +}) +.afterEach(async t => { + await helperAfterEach(t); +}) +.before(async ctx => { + await helperBeforeFixture(ctx); +}); const menu = new Menu(); const toolbar = new Toolbar(); @@ -121,31 +132,38 @@ test.meta("testID", "batch-003").meta({ mode: "public" })("Common: Test batch di await t.expect(photoedit.countryValue.innerText).eql("Germany"); await t.click(Selector(".input-labels input")); - await t.expect(page.selectOption.withText("People").visible).ok().expect(page.selectOption.withText("Cat").visible).ok(); + // The dropdown hides labels already assigned to any selected photo: + // "Cat" is a chip on photo 1, "Animal" is unassigned across all 4. + await t.expect(page.selectOption.withText("Cat").exists).notOk().expect(page.selectOption.withText("Animal").visible).ok(); await t.typeText(Selector(".input-labels input"), "P", { replace: true }); await t - .expect(page.selectOption.withText("Cat").visible) - .notOk() .expect(page.selectOption.withText("Portrait").visible) .ok() .expect(page.selectOption.withText("P").visible) - .ok(); + .ok() + .expect(page.selectOption.withText("Cat").exists) // visible.notOk takes 15 seconds + .notOk(); + + await t + .pressKey("ctrl+a delete") + .pressKey("enter"); await t.click(Selector(".input-albums input")); - await t.expect(page.selectOption.withText("Holiday").visible).ok().expect(page.selectOption.withText("Christmas").visible).ok(); + // "Holiday" is on photo 3, "Christmas" is unassigned. + await t.expect(page.selectOption.withText("Holiday").exists).notOk().expect(page.selectOption.withText("Christmas").visible).ok(); await t.typeText(Selector(".input-albums input"), "C", { replace: true }); await t - .expect(page.selectOption.withText("Holiday").visible) - .notOk() .expect(page.selectOption.withText("Christmas").visible) .ok() .expect(page.selectOption.withText("C").visible) - .ok(); + .ok() + .expect(page.selectOption.withText("Holiday").exists) // visible.notOk takes 15 seconds + .notOk(); await t.click(photoedit.batchDialogCloseAction); await t.expect(photoedit.batchDialog.visible).notOk(); await contextmenu.clearSelection(); diff --git a/frontend/tests/acceptance/acceptance-public/calendar.js b/frontend/tests/acceptance/acceptance-public/calendar.js index 7a863b9c1..2cb22fa18 100644 --- a/frontend/tests/acceptance/acceptance-public/calendar.js +++ b/frontend/tests/acceptance/acceptance-public/calendar.js @@ -7,8 +7,18 @@ import ContextMenu from "../page-model/context-menu"; import Photo from "../page-model/photo"; import Page from "../page-model/page"; import AlbumDialog from "../page-model/dialog-album"; +import { helperBeforeFixture, helperBeforeEach, helperAfterEach } from "../page-model/helpers"; -fixture`Test calendar`.page`${testcafeconfig.url}`; +fixture`Test calendar`.page`${testcafeconfig.url}` +.beforeEach(async t => { + await helperBeforeEach(t); +}) +.afterEach(async t => { + await helperAfterEach(t); +}) +.before(async ctx => { + await helperBeforeFixture(ctx); +}); const menu = new Menu(); const album = new Album(); @@ -80,9 +90,9 @@ test.meta("testID", "calendar-002").meta({ mode: "public" })("Common: Update cal .eql("Snow"); await t + .click(albumdialog.category) .click(albumdialog.category) .pressKey("ctrl+a delete") - .pressKey("enter") .click(albumdialog.description) .pressKey("ctrl+a delete") .pressKey("enter") @@ -94,10 +104,15 @@ test.meta("testID", "calendar-002").meta({ mode: "public" })("Common: Update cal await toolbar.search("March 2014"); await t - .expect(page.cardDescription.innerText) - .notContains("We went to ski") + .expect(page.cardDescription.exists) + .notOk() .expect(Selector("button.meta-location").exists) .notOk(); + + await album.openAlbumWithUid(AlbumUid); + await toolbar.triggerToolbarAction("edit"); + await t.expect(albumdialog.category.value).eql(""); + await t.click(albumdialog.dialogCancel); }); test.meta("testID", "calendar-003").meta({ mode: "public" })( diff --git a/frontend/tests/acceptance/acceptance-public/folders.js b/frontend/tests/acceptance/acceptance-public/folders.js index 012eff1e0..a4a7f0382 100644 --- a/frontend/tests/acceptance/acceptance-public/folders.js +++ b/frontend/tests/acceptance/acceptance-public/folders.js @@ -7,8 +7,18 @@ import ContextMenu from "../page-model/context-menu"; import Photo from "../page-model/photo"; import Page from "../page-model/page"; import AlbumDialog from "../page-model/dialog-album"; +import { helperBeforeFixture, helperBeforeEach, helperAfterEach } from "../page-model/helpers"; -fixture`Test folders`.page`${testcafeconfig.url}`; +fixture`Test folders`.page`${testcafeconfig.url}` +.beforeEach(async t => { + await helperBeforeEach(t); +}) +.afterEach(async t => { + await helperAfterEach(t); +}) +.before(async ctx => { + await helperBeforeFixture(ctx); +}); const menu = new Menu(); const album = new Album(); @@ -97,8 +107,8 @@ test.meta("testID", "folders-002").meta({ mode: "public" })("Common: Update fold await t .typeText(albumdialog.title, "Kanada", { replace: true }) .click(albumdialog.category) + .click(albumdialog.category) .pressKey("ctrl+a delete") - .pressKey("enter") .click(albumdialog.description) .pressKey("ctrl+a delete") .pressKey("enter") @@ -112,10 +122,15 @@ test.meta("testID", "folders-002").meta({ mode: "public" })("Common: Update fold await t .expect(page.cardTitle.nth(0).innerText) .contains("Kanada") - .expect(page.cardDescription.nth(0).innerText) - .notContains("We went to ski") - .expect(Selector("button.meta-location").nth(0).innerText) - .notContains("United States"); + .expect(page.cardDescription.exists) + .notOk(); + + // Card-level checks aren't sufficient for these fields: the location button can render + // via the album's Country/State fallback, and the category never had a card affordance. + await album.openAlbumWithUid(AlbumUid); + await toolbar.triggerToolbarAction("edit"); + await t.expect(albumdialog.location.value).eql("").expect(albumdialog.category.value).eql(""); + await t.click(albumdialog.dialogCancel); }); test.meta("testID", "folders-003").meta({ mode: "public" })("Common: Create, Edit, delete sharing link", async (t) => { diff --git a/frontend/tests/acceptance/acceptance-public/labels.js b/frontend/tests/acceptance/acceptance-public/labels.js index 975c137bd..16cb0555b 100644 --- a/frontend/tests/acceptance/acceptance-public/labels.js +++ b/frontend/tests/acceptance/acceptance-public/labels.js @@ -8,8 +8,19 @@ import Photo from "../page-model/photo"; import Page from "../page-model/page"; import Label from "../page-model/label"; import PhotoEdit from "../page-model/photo-edit"; +import { helperBeforeFixture, helperBeforeEach, helperAfterEach } from "../page-model/helpers"; -fixture`Test labels`.page`${testcafeconfig.url}`; +fixture`Test labels` +.page`${testcafeconfig.url}` +.beforeEach(async t => { + await helperBeforeEach(t); +}) +.afterEach(async t => { + await helperAfterEach(t); +}) +.before(async ctx => { + await helperBeforeFixture(ctx); +}); const menu = new Menu(); const album = new Album(); @@ -124,7 +135,7 @@ test.meta("testID", "labels-003").meta({ mode: "public" })("Common: Rename Label await t.expect(Selector("div.no-results").visible).ok(); }); -test.meta("testID", "labels-003").meta({ mode: "public" })("Common: Add label to albums", async (t) => { +test.meta("testID", "labels-004").meta({ mode: "public" })("Common: Add label to albums", async (t) => { await menu.openPage("albums"); await toolbar.search("Christmas"); const ChristmasAlbumUid = await album.getNthAlbumUid("all", 0); @@ -179,7 +190,7 @@ test.meta("testID", "labels-003").meta({ mode: "public" })("Common: Add label to await t.expect(PhotoCountHolidayAfterDelete).eql(InitialPhotoCountHoliday); }); -test.meta("testID", "labels-004").meta({ mode: "public" })("Common: Delete label", async (t) => { +test.meta("testID", "labels-005").meta({ mode: "public" })("Common: Delete label", async (t) => { await menu.openPage("labels"); await toolbar.search("dome"); const LabelDomeUid = await label.getNthLabeltUid(0); @@ -208,7 +219,7 @@ test.meta("testID", "labels-004").meta({ mode: "public" })("Common: Delete label await t.expect(Selector("td").withText("Dome").visible).ok(); }); -test.meta("testID", "labels-005").meta({ mode: "public" })("Common: Test mark label as favorite", async (t) => { +test.meta("testID", "labels-006").meta({ mode: "public" })("Common: Test mark label as favorite", async (t) => { await menu.openPage("labels"); const FirstLabelUid = await label.getNthLabeltUid(0); const SecondLabelUid = await label.getNthLabeltUid(1); diff --git a/frontend/tests/acceptance/acceptance-public/moment.js b/frontend/tests/acceptance/acceptance-public/moment.js index ea70ad881..f20fdee24 100644 --- a/frontend/tests/acceptance/acceptance-public/moment.js +++ b/frontend/tests/acceptance/acceptance-public/moment.js @@ -7,8 +7,19 @@ import ContextMenu from "../page-model/context-menu"; import Photo from "../page-model/photo"; import Page from "../page-model/page"; import AlbumDialog from "../page-model/dialog-album"; +import { helperBeforeFixture, helperBeforeEach, helperAfterEach } from "../page-model/helpers"; -fixture`Test moments`.page`${testcafeconfig.url}`; +fixture`Test moments` + .page`${testcafeconfig.url}` + .beforeEach(async t => { + await helperBeforeEach(t); + }) + .afterEach(async t => { + await helperAfterEach(t); + }) + .before(async ctx => { + await helperBeforeFixture(ctx); + }); const menu = new Menu(); const album = new Album(); @@ -83,8 +94,8 @@ test.meta("testID", "moments-001").meta({ mode: "public" })("Common: Update mome await t .typeText(albumdialog.title, "Nature & Landscape", { replace: true }) .click(albumdialog.category) + .click(albumdialog.category) .pressKey("ctrl+a delete") - .pressKey("enter") .click(albumdialog.description) .pressKey("ctrl+a delete") .pressKey("enter") @@ -98,10 +109,15 @@ test.meta("testID", "moments-001").meta({ mode: "public" })("Common: Update mome await t .expect(page.cardTitle.nth(0).innerText) .contains("Nature & Landscape") - .expect(page.cardDescription.innerText) - .notContains("We went to ski") + .expect(page.cardDescription.exists) + .notOk() .expect(Selector("button.meta-location").exists) .notOk(); + + await album.openAlbumWithUid(AlbumUid); + await toolbar.triggerToolbarAction("edit"); + await t.expect(albumdialog.category.value).eql(""); + await t.click(albumdialog.dialogCancel); }); test.meta("testID", "moments-002").meta({ mode: "public" })( @@ -133,7 +149,7 @@ test.meta("testID", "moments-003").meta({ mode: "public" })( const SeventhPhotoUid = await photo.getNthPhotoUid("image", 6); await menu.openPage("moments"); await album.selectAlbumFromUID(SecondMomentUid); - await contextmenu.triggerContextMenuAction("clone", ["NotYetExistingAlbumForMoment", "Holiday"]); + await contextmenu.triggerContextMenuAction("clone", ["Holiday", "NotYetExistingAlbumForMoment"]); // NotYetExistingAlbumForMoment happens to be long enough to be the middle of the text box (which causes it to be removed when Holiday is added), so put it second. await menu.openPage("albums"); const AlbumCountAfterCreation = await album.getAlbumCount("all"); diff --git a/frontend/tests/acceptance/acceptance-public/originals.js b/frontend/tests/acceptance/acceptance-public/originals.js index e2ae98a8c..416a6f15a 100644 --- a/frontend/tests/acceptance/acceptance-public/originals.js +++ b/frontend/tests/acceptance/acceptance-public/originals.js @@ -6,8 +6,19 @@ import Toolbar from "../page-model/toolbar"; import ContextMenu from "../page-model/context-menu"; import Album from "../page-model/album"; import Originals from "../page-model/originals"; +import { helperBeforeFixture, helperBeforeEach, helperAfterEach } from "../page-model/helpers"; -fixture`Test files`.page`${testcafeconfig.url}`; +fixture`Test files` +.page`${testcafeconfig.url}` +.beforeEach(async t => { + await helperBeforeEach(t); +}) +.afterEach(async t => { + await helperAfterEach(t); +}) +.before(async ctx => { + await helperBeforeFixture(ctx); +}); const menu = new Menu(); const photo = new Photo(); diff --git a/frontend/tests/acceptance/acceptance-public/photos-archive-private.js b/frontend/tests/acceptance/acceptance-public/photos-archive-private.js index b36da3f3c..bf2e9f7e4 100644 --- a/frontend/tests/acceptance/acceptance-public/photos-archive-private.js +++ b/frontend/tests/acceptance/acceptance-public/photos-archive-private.js @@ -9,8 +9,19 @@ import PhotoEdit from "../page-model/photo-edit"; import Album from "../page-model/album"; import Subject from "../page-model/subject"; import Label from "../page-model/label"; +import { helperBeforeFixture, helperBeforeEach, helperAfterEach } from "../page-model/helpers"; -fixture`Test photos archive and private functionalities`.page`${testcafeconfig.url}`; +fixture`Test photos archive and private functionalities` +.page`${testcafeconfig.url}` +.beforeEach(async t => { + await helperBeforeEach(t); +}) +.afterEach(async t => { + await helperAfterEach(t); +}) +.before(async ctx => { + await helperBeforeFixture(ctx); +}); const menu = new Menu(); const toolbar = new Toolbar(); diff --git a/frontend/tests/acceptance/acceptance-public/photos-face-markers.js b/frontend/tests/acceptance/acceptance-public/photos-face-markers.js new file mode 100644 index 000000000..379717074 --- /dev/null +++ b/frontend/tests/acceptance/acceptance-public/photos-face-markers.js @@ -0,0 +1,236 @@ +import testcafeconfig from "../../testcafeconfig.json"; +import PhotoViewer from "../page-model/photoviewer"; +import Menu from "../page-model/menu"; +import { helperBeforeFixture, helperBeforeEach, helperAfterEach } from "../page-model/helpers"; + +fixture`Test face markers in the photo viewer` +.page`${testcafeconfig.url}` +.beforeEach(async t => { + await helperBeforeEach(t); +}) +.afterEach(async t => { + await helperAfterEach(t); +}) +.before(async ctx => { + await helperBeforeFixture(ctx); +}); + +const photoviewer = new PhotoViewer(); +const menu = new Menu(); + +test.meta("testID", "face-markers-001").meta({ mode: "public" })("Common: Show/hide markers toggle reveals and hides marker overlays", async (t) => { + // `faces:1` guarantees the photo carries at least one face marker so the rect assertions are non-vacuous. + await photoviewer.openSidebarOnFirstPhoto("faces:1"); + + // Public mode = editable, so only the pencil renders. + await t.expect(photoviewer.markersEditToggle.visible).ok(); + await t.expect(photoviewer.faceMarkerOverlay.exists).notOk(); + + await t.click(photoviewer.markersEditToggle); + await t.expect(photoviewer.faceMarkerOverlay.visible).ok(); + await t.expect(photoviewer.faceMarkerRect.count).gte(1); + + await t.click(photoviewer.markersEditToggle); + await t.expect(photoviewer.faceMarkerOverlay.exists).notOk(); +}); + +test.meta("testID", "face-markers-002").meta({ mode: "public" })( + "Common: People header and marker controls render for editable users on a photo without face markers", + async (t) => { + // `faces:no` excludes photos with detected faces + await photoviewer.openSidebarOnFirstPhoto("faces:no"); + await t.expect(photoviewer.peopleHeader.visible).ok(); + await t.expect(photoviewer.markersEditToggle.visible).ok(); + } +); + +test.meta("testID", "face-markers-003").meta({ mode: "public" })("Common: Drawing a new face marker persists it and shows it in the People list", async (t) => { + // `faces:no` ensures the photo has no pre-existing markers, so the cleanup at the end targets the marker we drew. + await photoviewer.openSidebarOnFirstPhoto("faces:no"); + + const beforeRows = await photoviewer.getPersonRowCount(); + + await photoviewer.startMarkersEdit(); + await t.expect(photoviewer.faceMarkerOverlay.visible).ok(); + await photoviewer.drawMarkerInCenter(); + await t.expect(photoviewer.faceMarkerConfirmButton.visible).ok(); + await photoviewer.confirmMarkerDraft(); + + await t.expect(photoviewer.personRow.count).eql(beforeRows + 1); + await t.expect(photoviewer.faceMarkerRect.count).gte(1); + + await photoviewer.removeLastUnnamedMarker(); + await t.expect(photoviewer.personRow.count).eql(beforeRows); +}); + +test.meta("testID", "face-markers-004").meta({ mode: "public" })("Common: Cancelling a draft does not persist anything", async (t) => { + await photoviewer.openSidebarOnFirstPhoto("faces:no"); + + const beforeRows = await photoviewer.getPersonRowCount(); + + await photoviewer.startMarkersEdit(); + await t.expect(photoviewer.faceMarkerOverlay.visible).ok(); + await photoviewer.drawMarkerInCenter(); + await t.expect(photoviewer.faceMarkerCancelButton.visible).ok(); + await photoviewer.cancelMarkerDraft(); + + await t.expect(photoviewer.personRow.count).eql(beforeRows); +}); + +test.meta("testID", "face-markers-005").meta({ mode: "public" })( + "Common: Removing an unnamed marker requires confirmation via the overlay pill", + async (t) => { + await photoviewer.openSidebarOnFirstPhoto("faces:no"); + + // Add an unnamed marker so the removal flow is deterministic and self-undoing. + await photoviewer.startMarkersEdit(); + await t.expect(photoviewer.faceMarkerOverlay.visible).ok(); + await photoviewer.drawMarkerInCenter(); + await t.expect(photoviewer.faceMarkerConfirmButton.visible).ok(); + await photoviewer.confirmMarkerDraft(); + await t.expect(photoviewer.personRow.count).eql(1); + + // Dismiss path: clicking ✕ on the pill keeps the marker. + await t.click(photoviewer.faceMarkerUnnamedRect.nth(-1)); + await t.expect(photoviewer.faceMarkerRemoveConfirm.visible).ok(); + await t.click(photoviewer.faceMarkerCancelButton); + await t.expect(photoviewer.faceMarkerRemoveConfirm.exists).notOk(); + await t.expect(photoviewer.personRow.count).eql(1); + + // Confirm path: clicking ✓ on the pill removes the marker. + await t.click(photoviewer.faceMarkerUnnamedRect.nth(-1)); + await t.expect(photoviewer.faceMarkerRemoveConfirm.visible).ok(); + await t.click(photoviewer.faceMarkerRemoveButton); + await t.expect(photoviewer.personRow.count).eql(0); + } +); + +test.meta("testID", "face-markers-006").meta({ mode: "public" })("Common: Named markers expose only the Unassign icon in edit mode", async (t) => { + await photoviewer.openSidebarOnFirstPhoto("faces:no"); + + // Create a named marker we control so the assertion is non-vacuous. + await photoviewer.startMarkersEdit(); + await t.expect(photoviewer.faceMarkerOverlay.visible).ok(); + await photoviewer.drawMarkerInCenter(); + await t.expect(photoviewer.faceMarkerConfirmButton.visible).ok(); + await photoviewer.confirmMarkerDraft(); + const unnamed = photoviewer.unnamedPersonRows.nth(-1); + await t.typeText(unnamed.find(".meta-inline-marker input"), "UnassignIconTest").pressKey("enter"); + + const named = photoviewer.namedPersonRows.withText("UnassignIconTest"); + await t.expect(named.visible).ok(); + await t.expect(named.find(".meta-marker-clear-subject").exists).ok(); + + // Undo: clearing the subject unlinks the name, then remove the now-unnamed marker. + await photoviewer.clearMarkerSubject(named); + await photoviewer.removeLastUnnamedMarker(); + await t.expect(photoviewer.personRow.count).eql(0); +}); + +test.meta("testID", "face-markers-007").meta({ mode: "public" })("Common: Newly added markers persist across photo viewer reopens", async (t) => { + const uid = await photoviewer.openSidebarOnFirstPhoto("faces:no"); + const beforeRows = await photoviewer.getPersonRowCount(); + + await photoviewer.startMarkersEdit(); + await t.expect(photoviewer.faceMarkerOverlay.visible).ok(); + await photoviewer.drawMarkerInCenter(); + await t.expect(photoviewer.faceMarkerConfirmButton.visible).ok(); + await photoviewer.confirmMarkerDraft(); + await t.expect(photoviewer.personRow.count).eql(beforeRows + 1); + + // Toggle add-mode off before closing — its full-viewer hit area otherwise blocks the close button. + await photoviewer.startMarkersEdit(); + await photoviewer.triggerPhotoViewerAction("close-button"); + await t + .expect(menu.navDrawer.visible).ok() // confirm that the base page is loaded + .expect(photoviewer.viewer.exists).notOk(); // visible takes 15 seconds. + + // Clear the `faces:no` filter (the photo now has 1 face and would be excluded) and reopen by UID. + await photoviewer.openSidebarOnPhoto(uid); + await t.expect(photoviewer.personRow.count).eql(beforeRows + 1); + + await photoviewer.removeLastUnnamedMarker(); + await t.expect(photoviewer.personRow.count).eql(beforeRows); +}); + +test.meta("testID", "face-markers-008").meta({ mode: "public" })("Common: Naming an unnamed marker via the inline combobox persists the subject", async (t) => { + await photoviewer.openSidebarOnFirstPhoto("faces:no"); + const beforeRows = await photoviewer.getPersonRowCount(); + + await photoviewer.startMarkersEdit(); + await t.expect(photoviewer.faceMarkerOverlay.visible).ok(); + // Center-relative size keeps the draft inside the rendered photo across viewports. + await photoviewer.drawMarkerInCenter(); + await t.expect(photoviewer.faceMarkerConfirmButton.visible).ok(); + await photoviewer.confirmMarkerDraft(); + + const newRow = photoviewer.unnamedPersonRows.nth(-1); + await t.expect(newRow.visible).ok(); + const nameInput = newRow.find(".meta-inline-marker input"); + await t.expect(nameInput.visible).ok(); + await t.typeText(nameInput, "SidebarFaceTestPerson").pressKey("enter"); + + const namedRow = photoviewer.namedPersonRows.withText("SidebarFaceTestPerson"); + await t.expect(namedRow.visible).ok(); + + // Undo: clearing the subject unlinks the name, then remove the now-unnamed marker. + await photoviewer.clearMarkerSubject(namedRow); + await photoviewer.removeLastUnnamedMarker(); + await t.expect(photoviewer.personRow.count).eql(beforeRows); +}); + +test.meta("testID", "face-markers-010").meta({ mode: "public" })("Common: Blurring an unnamed marker with a novel name opens the Add-name dialog", async (t) => { + await photoviewer.openSidebarOnFirstPhoto("faces:no"); + const beforeRows = await photoviewer.getPersonRowCount(); + + await photoviewer.startMarkersEdit(); + await t.expect(photoviewer.faceMarkerOverlay.visible).ok(); + await photoviewer.drawMarkerInCenter(); + await t.expect(photoviewer.faceMarkerConfirmButton.visible).ok(); + await photoviewer.confirmMarkerDraft(); + + const newRow = photoviewer.unnamedPersonRows.nth(-1); + await t.expect(newRow.visible).ok(); + const nameInput = newRow.find(".meta-inline-marker input"); + await t.expect(nameInput.visible).ok(); + + // Blur via header click (not Enter) — the typed novel name must trigger the Add-name dialog. + await t.typeText(nameInput, "SidebarBlurDialogPerson"); + await t.click(photoviewer.peopleHeader); + await t.expect(photoviewer.addNameDialog.withText("SidebarBlurDialogPerson").visible).ok(); + + await t.click(photoviewer.addNameDialogCancel); + await t.expect(photoviewer.addNameDialog.withText("SidebarBlurDialogPerson").exists).notOk(); + await t.expect(photoviewer.personRow.withText("SidebarBlurDialogPerson").exists).notOk(); + + // The cancel only discards the typed name — the unnamed marker the draft confirm persisted is still there. + await photoviewer.removeLastUnnamedMarker(); + await t.expect(photoviewer.personRow.count).eql(beforeRows); +}); + +test.meta("testID", "face-markers-009").meta({ mode: "public" })("Common: Unassigning a named marker removes the subject link but keeps the marker", async (t) => { + await photoviewer.openSidebarOnFirstPhoto("faces:no"); + const beforeRows = await photoviewer.getPersonRowCount(); + + // Draw + name a marker we control so the test is deterministic. + await photoviewer.startMarkersEdit(); + await t.expect(photoviewer.faceMarkerOverlay.visible).ok(); + await photoviewer.drawMarkerInCenter(); + await t.expect(photoviewer.faceMarkerConfirmButton.visible).ok(); + await photoviewer.confirmMarkerDraft(); + const unnamed = photoviewer.unnamedPersonRows.nth(-1); + await t.typeText(unnamed.find(".meta-inline-marker input"), "SidebarClearSubjectTest").pressKey("enter"); + + const namedRow = photoviewer.namedPersonRows.withText("SidebarClearSubjectTest"); + await t.expect(namedRow.visible).ok(); + const totalAfterName = await photoviewer.personRow.count; + + await photoviewer.clearMarkerSubject(namedRow); + + // Clearing the subject unlinks the name without removing the marker — total rows stay, the named row goes away. + await t.expect(photoviewer.personRow.count).eql(totalAfterName); + await t.expect(namedRow.exists).notOk(); + + await photoviewer.removeLastUnnamedMarker(); + await t.expect(photoviewer.personRow.count).eql(beforeRows); +}); diff --git a/frontend/tests/acceptance/acceptance-public/photos-sidebar-edit.js b/frontend/tests/acceptance/acceptance-public/photos-sidebar-edit.js new file mode 100644 index 000000000..32224d325 --- /dev/null +++ b/frontend/tests/acceptance/acceptance-public/photos-sidebar-edit.js @@ -0,0 +1,260 @@ +import { Selector } from "testcafe"; +import testcafeconfig from "../../testcafeconfig.json"; +import PhotoViewer from "../page-model/photoviewer"; +import Menu from "../page-model/menu"; +import Label from "../page-model/label"; +import Album from "../page-model/album"; +import { helperBeforeFixture, helperBeforeEach, helperAfterEach } from "../page-model/helpers"; + +fixture`Test lightbox sidebar inline editing` +.page`${testcafeconfig.url}` +.beforeEach(async t => { + await helperBeforeEach(t); +}) +.afterEach(async t => { + await helperAfterEach(t); +}) +.before(async ctx => { + await helperBeforeFixture(ctx); +}); + +const photoviewer = new PhotoViewer(); +const menu = new Menu(); +const label = new Label(); +const album = new Album(); + +test.meta("testID", "sidebar-edit-001").meta({ mode: "public" })( + "Common: Edits title, caption, keywords, notes, and plain-text inline fields from the sidebar", + async (t) => { + await photoviewer.openSidebarOnFirstPhoto(); + + const titleInput = Selector(".p-lightbox-sidebar .meta-inline-title input", { timeout: 15000 }); + await photoviewer.startInlineEditOrAdd("meta-title", "Title"); + await t.expect(titleInput.visible).ok(); + await t.typeText(titleInput, "Sidebar Edit Title", { replace: true }).pressKey("enter"); + await t.expect(Selector(".p-lightbox-sidebar .meta-title").withText("Sidebar Edit Title").exists).ok(); + + // Caption commits on blur (Enter inserts a newline). + const captionTextarea = Selector(".p-lightbox-sidebar .meta-inline-caption textarea", { timeout: 15000 }); + await photoviewer.startInlineEditOrAdd("meta-caption", "Caption"); + await t.expect(captionTextarea.visible).ok(); + await t.typeText(captionTextarea, "Caption added in sidebar edit test", { replace: true }).pressKey("tab"); + await t.expect(Selector(".p-lightbox-sidebar .meta-caption").withText("Caption added in sidebar edit test").exists).ok(); + + // Keyword value is a single lowercase token to survive the backend's lowercase + dedup. + const plainTextFields = [ + { key: "subject", value: "Testing sidebar edits", commitKey: "enter" }, + { key: "artist", value: "Test Artist", commitKey: "enter" }, + { key: "copyright", value: "2024 Test", commitKey: "enter" }, + { key: "license", value: "Test-License-1.0", commitKey: "enter" }, + { key: "keywords", value: "sidebareditkw", commitKey: "enter" }, + { key: "notes", value: "SidebarNoteFromTest", commitKey: "tab" }, + ]; + for (const field of plainTextFields) { + await photoviewer.editTextFieldByKey(field.key, field.value, field.commitKey); + } + } +); + +test.meta("testID", "sidebar-edit-002").meta({ mode: "public" })("Common: Adds a label and an album inline and persists them to the photo", async (t) => { + const uid = await photoviewer.openSidebarOnFirstPhoto(); + + // Date-stamp names so reruns don't collide with leftovers from previous failed runs. + const stamp = Date.now(); + const labelTitle = `SidebarEditLabel-${stamp}`; + const albumTitle = `SidebarEditAlbum-${stamp}`; + + await photoviewer.typeAndConfirmInlineChip("Labels", labelTitle); + await photoviewer.typeAndConfirmInlineChip("Albums", albumTitle); + + await photoviewer.triggerPhotoViewerAction("close-button"); + + await menu.openPage("labels"); + await label.openByTitle(labelTitle); + await t.expect(Selector("div.is-photo").withAttribute("data-uid", uid).exists).ok(); + + await menu.openPage("albums"); + await album.openByTitle(albumTitle); + await t.expect(Selector("div.is-photo").withAttribute("data-uid", uid).exists).ok(); +}); + +test.meta("testID", "sidebar-edit-004").meta({ mode: "public" })( + "Common: Removes a label and an album inline, undoes before save, and keeps them on the photo", + async (t) => { + const uid = await photoviewer.openSidebarOnFirstPhoto(); + + const stamp = Date.now(); + const labelTitle = `SidebarEditLabelUndo-${stamp}`; + const albumTitle = `SidebarEditAlbumUndo-${stamp}`; + + await photoviewer.typeAndConfirmInlineChip("Labels", labelTitle); + await photoviewer.typeAndConfirmInlineChip("Albums", albumTitle); + + const labelChip = photoviewer.chipByTitle("Labels", labelTitle); + const albumChip = photoviewer.chipByTitle("Albums", albumTitle); + + await photoviewer.removeInlineChip("Labels", labelTitle); + await t.expect(labelChip.exists).notOk(); + await photoviewer.removeInlineChip("Albums", albumTitle); + await t.expect(albumChip.exists).notOk(); + + await photoviewer.undoChipRemovals("Labels"); + await t.expect(labelChip.exists).ok(); + await photoviewer.undoChipRemovals("Albums"); + await t.expect(albumChip.exists).ok(); + + // Close + reopen rehydrates the sidebar from the API; both chips must + // still be there because Undo never reached the backend. + await photoviewer.triggerPhotoViewerAction("close-button"); + await photoviewer.openSidebarOnPhoto(uid); + + await t.expect(photoviewer.chipByTitle("Labels", labelTitle).exists).ok(); + await t.expect(photoviewer.chipByTitle("Albums", albumTitle).exists).ok(); + } +); + +test.meta("testID", "sidebar-edit-005").meta({ mode: "public" })( + "Common: Removes a label and an album inline, saves the removal, and detaches them from the photo", + async (t) => { + const uid = await photoviewer.openSidebarOnFirstPhoto(); + + const stamp = Date.now(); + const labelTitle = `SidebarEditLabelSave-${stamp}`; + const albumTitle = `SidebarEditAlbumSave-${stamp}`; + + await photoviewer.typeAndConfirmInlineChip("Labels", labelTitle); + await photoviewer.typeAndConfirmInlineChip("Albums", albumTitle); + + await photoviewer.removeInlineChip("Labels", labelTitle); + await photoviewer.removeInlineChip("Albums", albumTitle); + + await photoviewer.confirmChipRemovals("Labels"); + await photoviewer.confirmChipRemovals("Albums"); + + await t.expect(photoviewer.chipByTitle("Labels", labelTitle).exists).notOk(); + await t.expect(photoviewer.chipByTitle("Albums", albumTitle).exists).notOk(); + + // Close + reopen confirms the removal persisted past the round-trip; + // the saved photo no longer references either chip. + await photoviewer.triggerPhotoViewerAction("close-button"); + await photoviewer.openSidebarOnPhoto(uid); + + await t.expect(photoviewer.chipByTitle("Labels", labelTitle).exists).notOk(); + await t.expect(photoviewer.chipByTitle("Albums", albumTitle).exists).notOk(); + } +); + +test.meta("testID", "sidebar-edit-003").meta({ mode: "public" })( + "Common: Edits every taken-at, camera, and location field and confirms persistence", + async (t) => { + await photoviewer.openSidebarOnFirstPhoto(); + + const dateTimeDialog = photoviewer.dateTimeDialog; + const cameraDialog = photoviewer.cameraDialog; + const locationDialog = photoviewer.locationDialog; + const optionWith = (text) => Selector('div[role="option"]').withText(text); + + // Keyboard nav is more stable than click on autocomplete options + // (the list re-mounts between visibility and click on fast systems). + const pickAutocomplete = async (input, value) => { + await t.typeText(input, value, { replace: true }).pressKey("down enter"); + }; + const pickFromSelect = async (field, value) => { + await t.click(field).click(optionWith(value)); + }; + + // Snapshot the initial values so the test can restore them on exit and other + // tests in this suite see a clean photo. + await photoviewer.openSidebarDialog("takenAt"); + const initialYear = await dateTimeDialog.yearValue.innerText; + const initialMonth = await dateTimeDialog.monthValue.innerText; + const initialDay = await dateTimeDialog.dayValue.innerText; + const initialLocalTime = await dateTimeDialog.localTime.value; + const initialTimezone = await dateTimeDialog.timezoneValue.innerText; + await t.click(dateTimeDialog.cancel); + await t.expect(dateTimeDialog.root.exists).notOk({ timeout: 10000 }); + + await photoviewer.openSidebarDialog("camera"); + const initialCamera = await cameraDialog.cameraValue.innerText; + const initialLens = await cameraDialog.lensValue.innerText; + const initialIso = await cameraDialog.iso.value; + const initialExposure = await cameraDialog.exposure.value; + const initialFnumber = await cameraDialog.fnumber.value; + const initialFocalLength = await cameraDialog.focalLength.value; + await t.click(cameraDialog.cancel); + await t.expect(cameraDialog.root.exists).notOk({ timeout: 5000 }); + + await photoviewer.openSidebarDialog("location"); + const initialCoordinates = await locationDialog.coordinates.value; + await t.click(locationDialog.cancel); + await t.expect(locationDialog.root.exists).notOk({ timeout: 2000 }); + + await photoviewer.openSidebarDialog("takenAt"); + await pickAutocomplete(dateTimeDialog.year, "2022"); + await pickAutocomplete(dateTimeDialog.month, "07"); + await pickAutocomplete(dateTimeDialog.day, "15"); + await t.typeText(dateTimeDialog.localTime, "13:45:30", { replace: true }).pressKey("tab"); + await pickAutocomplete(dateTimeDialog.timezone, "UTC"); + await t.click(dateTimeDialog.confirm); + await t.expect(dateTimeDialog.root.exists).notOk({ timeout: 15000 }); + + // formatTime() drops the zone abbreviation on UTC photos, so "UTC" never appears + // in the sidebar text — it's only checked via the dialog below. + const calendarRow = photoviewer.sidebarRow("mdi-calendar"); + await t.expect(calendarRow.withText("2022").exists).ok(); + await t.expect(calendarRow.withText("Jul").exists).ok(); + await t.expect(calendarRow.withText("15").exists).ok(); + + await photoviewer.openSidebarDialog("takenAt"); + await t.expect(dateTimeDialog.yearValue.innerText).eql("2022"); + await t.expect(dateTimeDialog.monthValue.innerText).eql("07"); + await t.expect(dateTimeDialog.dayValue.innerText).eql("15"); + await t.expect(dateTimeDialog.localTime.value).eql("13:45:30"); + await t.expect(dateTimeDialog.timezoneValue.innerText).eql("UTC"); + await t.click(dateTimeDialog.cancel); + await t.expect(dateTimeDialog.root.exists).notOk({ timeout: 15000 }); + + const cameraName = "Canon EOS M10"; + const lensName = "EF-M15-45mm f/3.5-6.3 IS STM"; + await photoviewer.openSidebarDialog("camera"); + await pickFromSelect(cameraDialog.camera, cameraName); + await pickFromSelect(cameraDialog.lens, lensName); + await t.typeText(cameraDialog.iso, "6400", { replace: true }); + await t.typeText(cameraDialog.exposure, "1/250", { replace: true }); + await t.typeText(cameraDialog.fnumber, "1.8", { replace: true }); + await t.typeText(cameraDialog.focalLength, "35", { replace: true }); + await t.typeText(cameraDialog.iso, "6400", { replace: true }); + await t.click(cameraDialog.confirm); + await t.expect(cameraDialog.root.exists).notOk({ timeout: 15000 }); + + const cameraRow = photoviewer.sidebarRow("mdi-camera"); + await t.expect(cameraRow.withText(cameraName).exists).ok(); + await t.expect(cameraRow.withText("ISO 6400").exists).ok(); + await t.expect(cameraRow.withText("1/250").exists).ok(); + + await photoviewer.openSidebarDialog("camera"); + await t.expect(cameraDialog.cameraValue.innerText).eql(cameraName); + await t.expect(cameraDialog.lensValue.innerText).eql(lensName); + await t.expect(cameraDialog.iso.value).eql("6400"); + await t.expect(cameraDialog.exposure.value).eql("1/250"); + await t.expect(cameraDialog.fnumber.value).eql("1.8"); + await t.expect(cameraDialog.focalLength.value).eql("35"); + await t.click(cameraDialog.cancel); + await t.expect(cameraDialog.root.exists).notOk({ timeout: 15000 }); + + // Raw coordinates avoid hitting the external reverse-geocoder. + await photoviewer.openSidebarDialog("location"); + // (search field skipped on purpose to keep the test offline) + await t.expect(locationDialog.coordinates.visible).ok(); + await t.typeText(locationDialog.coordinates, "52.5200, 13.4050", { replace: true }).pressKey("enter"); + await t.click(locationDialog.confirm); + await t.expect(locationDialog.root.exists).notOk({ timeout: 15000 }); + await t.expect(Selector(".p-lightbox-sidebar .p-map").exists).ok(); + + // Thumb.getLatLngShort() formats as 4-digit decimals with °N / °E suffix — + // assert the suffix too so a regression that drops it doesn't silently pass. + const locationRow = photoviewer.sidebarRow("mdi-map-marker"); + await t.expect(locationRow.withText("52.5200°N").visible).ok(); + await t.expect(locationRow.withText("13.4050°E").visible).ok(); + } +); diff --git a/frontend/tests/acceptance/acceptance-public/photos-upload-delete.js b/frontend/tests/acceptance/acceptance-public/photos-upload-delete.js index 02821e41b..6e903c1c7 100644 --- a/frontend/tests/acceptance/acceptance-public/photos-upload-delete.js +++ b/frontend/tests/acceptance/acceptance-public/photos-upload-delete.js @@ -11,8 +11,19 @@ import Originals from "../page-model/originals"; import Album from "../page-model/album"; import Library from "../page-model/library"; import Notifies from "../page-model/notifications"; +import { helperBeforeFixture, helperBeforeEach, helperAfterEach } from "../page-model/helpers"; -fixture`Test photos upload and delete`.page`${testcafeconfig.url}`; +fixture`Test photos upload and delete` +.page`${testcafeconfig.url}` +.beforeEach(async t => { + await helperBeforeEach(t); +}) +.afterEach(async t => { + await helperAfterEach(t); +}) +.before(async ctx => { + await helperBeforeFixture(ctx); +}); const menu = new Menu(); const album = new Album(); @@ -41,10 +52,11 @@ test.meta("testID", "photos-upload-delete-001").meta({ type: "short", mode: "pub await toolbar.triggerToolbarAction("upload"); await t - .setFilesToUpload(Selector(".input-upload"), [ + .setFilesToUpload(Selector('input[type="file"]'), [ "../../upload-files/digikam.jpg", "../../upload-files/digikam.json", ]); + await t.click(Selector("button.action-upload")); await notifies.waitForUpload(); await toolbar.triggerToolbarAction("refresh"); const PhotoCountAfterUpload = await photo.getPhotoCount("all"); @@ -114,7 +126,9 @@ test.meta("testID", "photos-upload-delete-002").meta({ mode: "public" })("Core: await t.expect(PhotoCount).eql(0); await toolbar.triggerToolbarAction("upload"); - await t.setFilesToUpload(Selector(".input-upload"), ["../../upload-files/korn.mp4"]); + await t.setFilesToUpload(Selector('input[type="file"]'), ["../../upload-files/korn.mp4"]); + await t.click(Selector("button.action-upload")); + await notifies.waitForUpload(); await toolbar.triggerToolbarAction("refresh"); const PhotoCountAfterUpload = await photo.getPhotoCount("all"); @@ -183,7 +197,8 @@ test.meta("testID", "photos-upload-delete-003").meta({ mode: "public" })( await album.openAlbumWithUid(AlbumUid); const PhotoCount = await photo.getPhotoCount("all"); await toolbar.triggerToolbarAction("upload"); - await t.setFilesToUpload(Selector(".input-upload"), ["../../upload-files/ladybug.jpg"]); + await t.setFilesToUpload(Selector('input[type="file"]'), ["../../upload-files/ladybug.jpg"]); + await t.click(Selector("button.action-upload")); await notifies.waitForUpload(); await toolbar.triggerToolbarAction("refresh"); const PhotoCountAfterUpload = await photo.getPhotoCount("all", 12000); @@ -224,7 +239,8 @@ test.meta("testID", "photos-upload-delete-004").meta({ mode: "public" })( .click(Selector(".input-albums")) .typeText(Selector(".input-albums input"), "NewCreatedAlbum") .pressKey("enter") - .setFilesToUpload(Selector(".input-upload"), ["../../upload-files/digikam.jpg"]); + .setFilesToUpload(Selector('input[type="file"]'), ["../../upload-files/digikam.jpg"]); + await t.click(Selector("button.action-upload")); await notifies.waitForUpload(); if (t.browser.platform === "mobile") { await t.eval(() => location.reload()); @@ -276,7 +292,8 @@ test.meta("testID", "photos-upload-delete-005").meta({ type: "short", mode: "pub console.log("Skipped on mobile"); } else { await toolbar.triggerToolbarAction("upload"); - await t.setFilesToUpload(Selector(".input-upload"), ["../../upload-files/hentai_2.jpg"]); + await t.setFilesToUpload(Selector('input[type="file"]'), ["../../upload-files/hentai_2.jpg"]); + await t.click(Selector("button.action-upload")); await notifies.waitForUploadFailed(); await t.click(Selector("button.action-close")).wait(8000); @@ -301,7 +318,8 @@ test.meta("testID", "photos-upload-delete-006").meta({ type: "short", mode: "pub await menu.openPage("browse"); await toolbar.triggerToolbarAction("upload"); - await t.setFilesToUpload(Selector(".input-upload"), ["../../upload-files/foo.txt"]); + await t.setFilesToUpload(Selector('input[type="file"]'), ["../../upload-files/foo.txt"]); + await t.click(Selector("button.action-upload")); await notifies.waitForUpload(); await menu.openNav(); const OriginalsCountAfterUpload = await Selector("a.nav-originals span.nav-count-item", { diff --git a/frontend/tests/acceptance/acceptance-public/photos.js b/frontend/tests/acceptance/acceptance-public/photos.js index c72e3a7da..f96a77e1a 100644 --- a/frontend/tests/acceptance/acceptance-public/photos.js +++ b/frontend/tests/acceptance/acceptance-public/photos.js @@ -8,11 +8,24 @@ import Photo from "../page-model/photo"; import PhotoViewer from "../page-model/photoviewer"; import Page from "../page-model/page"; import PhotoEdit from "../page-model/photo-edit"; +import Notify from "../page-model/notifications"; + +import { helperBeforeFixture, helperBeforeEach, helperAfterEach, logTime, logTimeEnd, logMessage } from "../page-model/helpers"; const scroll = ClientFunction((x, y) => window.scrollTo(x, y)); const getcurrentPosition = ClientFunction(() => window.scrollY); -fixture`Test photos`.page`${testcafeconfig.url}`; +fixture`Test photos` +.page`${testcafeconfig.url}` +.beforeEach(async t => { + await helperBeforeEach(t); +}) +.afterEach(async t => { + await helperAfterEach(t); +}) +.before(async ctx => { + await helperBeforeFixture(ctx); +}); const menu = new Menu(); const toolbar = new Toolbar(); @@ -21,6 +34,7 @@ const photo = new Photo(); const photoviewer = new PhotoViewer(); const page = new Page(); const photoedit = new PhotoEdit(); +const notify = new Notify(); test.meta("testID", "photos-001").meta({ mode: "public" })("Common: Scroll to top", async (t) => { await t.click(toolbar.cardsViewAction); @@ -110,6 +124,29 @@ test.meta("testID", "photos-003").meta({ type: "short", mode: "public" })( await photo.checkPhotoVisibility(FirstPhotoUid, true); await photo.checkPhotoVisibility(SecondPhotoUid, true); await photo.checkPhotoVisibility(ThirdPhotoUid, true); + // These three photos are missing a lot of data, can't be reverted, so need to be set as old, so they are not 1st on the list (which can break other tests). + // Please note that reversion of review photos is explicity prevented, so these changes will stick. + // Private isn't suitable as it may break other tests. + // As at 2026-06-05 there are no tests that choose the last photos. + + const expectedInputValues = [ + ["description", "Was a review photo"], + ]; + const expectedSelectValues = [ + ["day", "28"], + ["month", "02"], + ["year", "2009"], + ]; + + await page.clickCardImageLabelOfUID(FirstPhotoUid); + await t.expect(photoedit.coordinates.visible).ok(); + await photoedit.editFormValues(expectedInputValues, expectedSelectValues); + await page.clickCardImageLabelOfUID(SecondPhotoUid); + await t.expect(photoedit.coordinates.visible).ok(); + await photoedit.editFormValues(expectedInputValues, expectedSelectValues); + await page.clickCardImageLabelOfUID(ThirdPhotoUid); + await t.expect(photoedit.coordinates.visible).ok(); + await photoedit.editFormValues(expectedInputValues, expectedSelectValues); } ); @@ -174,45 +211,13 @@ test.meta("testID", "photos-005").meta({ type: "short", mode: "public" })("Commo await page.clickCardTitleOfUID(FirstPhotoUid); await t.expect(photoedit.coordinates.visible).ok(); + const FirstPhotoTitle = await photoedit.title.value; await t.click(photoedit.dialogNext); await t.expect(photoedit.dialogPrevious.getAttribute("disabled")).notEql("disabled"); await t.click(photoedit.dialogPrevious).click(photoedit.dialogClose); - await photoviewer.openPhotoViewer("uid", FirstPhotoUid); - await photoviewer.triggerPhotoViewerAction("edit-button"); - const FirstPhotoTitle = await photoedit.title.value; - const FirstPhotoLocalTime = await photoedit.localTime.value; - let FirstPhotoDay = await photoedit.dayValue.innerText; - if (!FirstPhotoDay) { - FirstPhotoDay = "Unknown"; - } - let FirstPhotoMonth = await photoedit.monthValue.innerText; - if (!FirstPhotoMonth) { - FirstPhotoMonth = "Unknown"; - } - let FirstPhotoYear = await photoedit.yearValue.innerText; - if (!FirstPhotoYear) { - FirstPhotoYear = "Unknown"; - } - const FirstPhotoTimezone = await photoedit.timezoneValue.innerText; - const FirstPhotoCoordinates = await photoedit.coordinates.value; - const FirstPhotoAltitude = await photoedit.altitude.value; - const FirstPhotoCountry = await photoedit.countryValue.innerText; - const FirstPhotoCamera = await photoedit.cameraValue.innerText; - const FirstPhotoIso = await photoedit.iso.value; - const FirstPhotoExposure = await photoedit.exposure.value; - const FirstPhotoLens = await photoedit.lensValue.innerText; - const FirstPhotoFnumber = await photoedit.fnumber.value; - const FirstPhotoFocalLength = await photoedit.focallength.value; - const FirstPhotoSubject = await photoedit.subject.value; - const FirstPhotoArtist = await photoedit.artist.value; - const FirstPhotoCopyright = await photoedit.copyright.value; - const FirstPhotoLicense = await photoedit.license.value; - const FirstPhotoDescription = await photoedit.description.value; - const FirstPhotoKeywords = await photoedit.keywords.value; - const FirstPhotoNotes = await photoedit.notes.value; const expectedInputValues = [ ["title", "New Photo Title"], @@ -246,30 +251,10 @@ test.meta("testID", "photos-005").meta({ type: "short", mode: "public" })("Commo ["camera", "Canon EOS M10"], ["lens", "EF-M15-45mm f/3.5-6.3 IS STM"], ]; - const initialInputValues = [ - ["title", FirstPhotoTitle], - ["localTime", FirstPhotoLocalTime], - ["altitude", FirstPhotoAltitude], - ["coordinates", FirstPhotoCoordinates], - ["iso", FirstPhotoIso], - ["exposure", FirstPhotoExposure], - ["fnumber", FirstPhotoFnumber], - ["focallength", FirstPhotoFocalLength], - ["subject", FirstPhotoSubject], - ["artist", FirstPhotoArtist], - ["copyright", FirstPhotoCopyright], - ["license", FirstPhotoLicense], - ["description", FirstPhotoDescription], - ["notes", FirstPhotoNotes], - ]; - const initialSelectValuesNoCountry = [ - ["day", FirstPhotoDay], - ["month", FirstPhotoMonth], - ["year", FirstPhotoYear], - ["timezone", FirstPhotoTimezone], - ["camera", FirstPhotoCamera], - ["lens", FirstPhotoLens], - ]; + + await photoviewer.openPhotoViewer("uid", FirstPhotoUid); + await photoviewer.triggerPhotoViewerAction("edit-button"); + await t.typeText(photoedit.title, "Not saved photo title", { replace: true }).click(photoedit.detailsClose); await page.clickCardTitleOfUID(FirstPhotoUid); @@ -297,22 +282,12 @@ test.meta("testID", "photos-005").meta({ type: "short", mode: "public" })("Commo await t .expect(Selector('div[data-uid="' + FirstPhotoUid + '"] button.action-title-edit').innerText) .eql("New Photo Title"); - await photo.triggerHoverAction("uid", FirstPhotoUid, "select"); await contextmenu.triggerContextMenuAction("edit", ""); await photoedit.checkEditFormValues(expectedInputValues, expectedSelectValues); await t.expect(await photoedit.coordinates.value).eql("41.15333, 20.168331"); - await photoedit.editFormValues(initialInputValues, initialSelectValuesNoCountry); - await page.clickCardTitleOfUID(FirstPhotoUid); - await t.typeText(Selector("div.p-tab-photo-details .input-coordinates input"), FirstPhotoCoordinates, { - replace: true, - }); - await t.click(photoedit.detailsApply); await t.click(photoedit.detailsClose); - await contextmenu.triggerContextMenuAction("edit", ""); - await photoedit.checkEditFormValues(initialInputValues, initialSelectValuesNoCountry); - await contextmenu.checkContextMenuCount("1"); await contextmenu.clearSelection(); }); @@ -381,14 +356,13 @@ test.meta("testID", "photos-007").meta({ mode: "public" })("Common: Mark photos/ await photoedit.turnSwitchOff("scan"); await photoedit.turnSwitchOff("panorama"); await t.click(photoedit.dialogClose); - await t.wait(9000); if (t.browser.platform === "mobile") { await t.eval(() => location.reload()); } else { await toolbar.triggerToolbarAction("refresh"); } - + await notify.waitForPhotosToLoad(5000, true); await photo.checkPhotoVisibility(FirstPhotoUid, false); await photo.checkPhotoVisibility(FirstVideoUid, false); }); @@ -442,10 +416,12 @@ test.meta("testID", "photos-010").meta({ mode: "public" })("Common: Set location await t.click(photoedit.locationAction); const CoordinatesBefore = await photoedit.locationInput.value; await t.expect(CoordinatesBefore).eql(""); - await t.expect(photoedit.locationMarker.visible).notOk(); + await t.expect(photoedit.locationMarker.with({timeout: 200}).visible).notOk(); // The location marker won't be there, so why wait a long time? //search - await t.typeText(photoedit.locationSearch, "Brandenburger Tor Berlin").wait(5000).pressKey("enter"); + await t + .typeText(photoedit.locationSearch, "Brandenburger Tor Berlin") + .click(Selector('div.v-autocomplete__content').find('i.mdi-map-marker')); const Coordinates = await photoedit.locationInput.value; await t.expect(Coordinates).eql("52.5162546, 13.3777166"); await t.expect(photoedit.locationMarker.visible).ok(); @@ -454,18 +430,18 @@ test.meta("testID", "photos-010").meta({ mode: "public" })("Common: Set location const CoordinatesAfterClear = await photoedit.locationInput.value; await t.expect(CoordinatesAfterClear).eql(""); - await t.expect(photoedit.locationMarker.visible).notOk(); + await t.expect(photoedit.locationMarker.with({timeout: 200}).visible).notOk(); // The location marker won't be there, so why wait a long time? await t.click(photoedit.locationUndo); const CoordinatesAfterUndo = await photoedit.locationInput.value; await t.expect(CoordinatesAfterUndo).eql("52.5162546, 13.3777166"); await t.expect(photoedit.locationMarker.visible).ok(); - await t.click(photoedit.locationConfirm).wait(10000); + await t.click(photoedit.locationConfirm); // use ok on the following to avoid excessive wait time. - await t.expect(photoedit.altitude.value).eql("0"); - await t.expect(photoedit.coordinates.value).eql("52.5162546, 13.3777166"); - await t.expect(photoedit.countryValue.innerText).eql("Germany"); + await t.expect(photoedit.altitude.withAttribute('value', "0").visible).ok(); // These will continue when the value appears + await t.expect(photoedit.coordinates.withAttribute('value', "52.5162546, 13.3777166").visible).ok(); + await t.expect(photoedit.countryValue.withExactText("Germany").visible).ok(); await t.click(photoedit.detailsApply); await t.click(photoedit.detailsClose); await page.clickCardTitleOfUID(FirstPhotoUid); @@ -482,6 +458,6 @@ test.meta("testID", "photos-010").meta({ mode: "public" })("Common: Set location await t.click(Selector("div.maplibregl-map"), { offsetX: 4, offsetY: 4 }); const CoordinatesAfterChange = await photoedit.locationInput.value; await t.expect(CoordinatesAfterChange).eql("52.534636098259455, 13.332140504419073"); - await t.click(photoedit.locationCancel).wait(10000); - await t.expect(photoedit.coordinates.value).eql("52.5162546, 13.3777166"); + await t.click(photoedit.locationCancel); // use ok on the following to avoid excessive wait time. + await t.expect(photoedit.coordinates.withAttribute('value', "52.5162546, 13.3777166").visible).ok(); // This will exit when the value appears }); diff --git a/frontend/tests/acceptance/acceptance-public/shortcuts.js b/frontend/tests/acceptance/acceptance-public/shortcuts.js index 67c6658b8..be45f1eb5 100644 --- a/frontend/tests/acceptance/acceptance-public/shortcuts.js +++ b/frontend/tests/acceptance/acceptance-public/shortcuts.js @@ -10,8 +10,19 @@ import Subject from "../page-model/subject"; import Label from "../page-model/label"; import Library from "../page-model/library"; import Notifies from "../page-model/notifications"; +import { helperBeforeFixture, helperBeforeEach, helperAfterEach } from "../page-model/helpers"; -fixture`Test Keyboard Shortcuts`.page`${testcafeconfig.url}`; +fixture`Test Keyboard Shortcuts` +.page`${testcafeconfig.url}` +.beforeEach(async t => { + await helperBeforeEach(t); +}) +.afterEach(async t => { + await helperAfterEach(t); +}) +.before(async ctx => { + await helperBeforeFixture(ctx); +}); const menu = new Menu(); const toolbar = new Toolbar(); @@ -129,11 +140,11 @@ test.meta("testID", "shortcuts-003").meta({ type: "short", mode: "public" })( await t.expect(photoviewer.viewer.visible).ok(); - await triggerKeyPress("a", "KeyA", 65, true, false); + await triggerKeyPress("x", "KeyX", 88, true, false); await t.click(Selector("div.p-notify--success").withText("Archived")); - await triggerKeyPress("a", "KeyA", 65, true, false); + await triggerKeyPress("x", "KeyX", 88, true, false); await t.click(Selector("div.p-notify--success").withText("Restored")); diff --git a/frontend/tests/acceptance/acceptance-public/sphere.js b/frontend/tests/acceptance/acceptance-public/sphere.js new file mode 100644 index 000000000..9fc6e175b --- /dev/null +++ b/frontend/tests/acceptance/acceptance-public/sphere.js @@ -0,0 +1,45 @@ +import { Selector } from "testcafe"; +import testcafeconfig from "../../testcafeconfig.json"; +import Menu from "../page-model/menu"; +import Photo from "../page-model/photo"; +import PhotoViewer from "../page-model/photoviewer"; + +fixture`Test 360° sphere viewer`.page`${testcafeconfig.url}`; + +const menu = new Menu(); +const photo = new Photo(); +const photoviewer = new PhotoViewer(); + +// Smoke tests for the equirectangular 360° viewer pipeline. +// Live runs require the acceptance fixture set to include +// `panorama_sphere.jpg` (and ideally `panorama_sphere.mp4`) +// with ProjectionType=equirectangular metadata. + +test.meta("testID", "sphere-001").meta({ mode: "public" })("Common: Opens 360° photo in sphere viewer", async (t) => { + await menu.openPage("panoramas"); + const uid = await photo.getNthPhotoUid("image", 0); + await photoviewer.openPhotoViewer("uid", uid); + + await t.expect(Selector("div.pswp__media--sphere").exists).ok({ timeout: 5000 }); + await t.expect(Selector("div.psv-container").exists).ok({ timeout: 10000 }); +}); + +test.meta("testID", "sphere-002").meta({ mode: "public" })("Common: Standard photo does not mount sphere viewer", async (t) => { + await menu.openPage("browse"); + const uid = await photo.getNthPhotoUid("image", 0); + await photoviewer.openPhotoViewer("uid", uid); + + await t.expect(Selector("div.p-lightbox__pswp").visible).ok(); + await t.expect(Selector("div.pswp__media--sphere").exists).notOk(); +}); + +test.meta("testID", "sphere-003").meta({ mode: "public" })("Common: Opens 360° video in sphere viewer", async (t) => { + await menu.openPage("panoramas"); + // The acceptance fixture set must include a 360° equirectangular video; fail clearly if it is missing. + await t.expect(Selector("div.type-video").exists).ok({ timeout: 5000 }); + const uid = await photo.getNthPhotoUid("video", 0); + + await photoviewer.openPhotoViewer("uid", uid); + await t.expect(Selector("div.pswp__media--sphere").exists).ok({ timeout: 5000 }); + await t.expect(Selector("div.pswp__media--sphere video").exists).ok({ timeout: 30000 }); +}); diff --git a/frontend/tests/acceptance/acceptance-public/stacks.js b/frontend/tests/acceptance/acceptance-public/stacks.js index 29ead36b6..135e9342b 100644 --- a/frontend/tests/acceptance/acceptance-public/stacks.js +++ b/frontend/tests/acceptance/acceptance-public/stacks.js @@ -8,8 +8,19 @@ import Page from "../page-model/page"; import PhotoEdit from "../page-model/photo-edit"; import Library from "../page-model/library"; import Notifies from "../page-model/notifications"; +import { helperBeforeFixture, helperBeforeEach, helperAfterEach } from "../page-model/helpers"; -fixture`Test stacks`.page`${testcafeconfig.url}`; +fixture`Test stacks` +.page`${testcafeconfig.url}` +.beforeEach(async t => { + await helperBeforeEach(t); +}) +.afterEach(async t => { + await helperAfterEach(t); +}) +.before(async ctx => { + await helperBeforeFixture(ctx); +}); const menu = new Menu(); const toolbar = new Toolbar(); diff --git a/frontend/tests/acceptance/acceptance-public/states.js b/frontend/tests/acceptance/acceptance-public/states.js index 4dfa6b815..501a3196c 100644 --- a/frontend/tests/acceptance/acceptance-public/states.js +++ b/frontend/tests/acceptance/acceptance-public/states.js @@ -7,8 +7,19 @@ import ContextMenu from "../page-model/context-menu"; import Photo from "../page-model/photo"; import Page from "../page-model/page"; import AlbumDialog from "../page-model/dialog-album"; +import { helperBeforeFixture, helperBeforeEach, helperAfterEach } from "../page-model/helpers"; -fixture`Test states`.page`${testcafeconfig.url}`; +fixture`Test states` +.page`${testcafeconfig.url}` +.beforeEach(async t => { + await helperBeforeEach(t); +}) +.afterEach(async t => { + await helperAfterEach(t); +}) +.before(async ctx => { + await helperBeforeFixture(ctx); +}); const menu = new Menu(); const album = new Album(); @@ -83,8 +94,8 @@ test.meta("testID", "states-001").meta({ mode: "public" })("Common: Update state await t .typeText(albumdialog.title, "British Columbia", { replace: true }) .click(albumdialog.category) + .click(albumdialog.category) .pressKey("ctrl+a delete") - .pressKey("enter") .click(albumdialog.description) .pressKey("ctrl+a delete") .pressKey("enter") @@ -96,10 +107,15 @@ test.meta("testID", "states-001").meta({ mode: "public" })("Common: Update state await t .expect(page.cardTitle.nth(0).innerText) .contains("British Columbia") - .expect(page.cardDescription.innerText) - .notContains("We love earth") + .expect(page.cardDescription.exists) + .notOk() .expect(Selector("button.meta-location").innerText) .notContains("Earth"); + + await album.openAlbumWithUid(AlbumUid); + await toolbar.triggerToolbarAction("edit"); + await t.expect(albumdialog.category.value).eql(""); + await t.click(albumdialog.dialogCancel); }); test.meta("testID", "states-002").meta({ mode: "public" })("Common: Create, Edit, delete sharing link for state", async (t) => { @@ -122,7 +138,9 @@ test.meta("testID", "states-003").meta({ mode: "public" })("Common: Create/delet const SecondPhotoUid = await photo.getNthPhotoUid("image", 1); await menu.openPage("states"); await album.selectAlbumFromUID(FirstStateUid); - await contextmenu.triggerContextMenuAction("clone", ["NotYetExistingAlbumForState", "Holiday"]); + await contextmenu.triggerContextMenuAction("clone", ["Holiday", "NotYetExistingAlbumForState"]); // NotYetExistingAlbumForState happens to be long enough to be the middle of the text box (which causes it to be removed when Holiday is added), so put it second. + + await menu.openPage("albums"); const AlbumCountAfterCreation = await album.getAlbumCount("all"); diff --git a/frontend/tests/acceptance/page-model/album.js b/frontend/tests/acceptance/page-model/album.js index f5afcd492..8642de368 100644 --- a/frontend/tests/acceptance/page-model/album.js +++ b/frontend/tests/acceptance/page-model/album.js @@ -1,7 +1,9 @@ import { Selector, t } from "testcafe"; export default class Page { - constructor() {} + constructor() { + this.search = Selector(".input-search input"); + } async getNthAlbumUid(type, nth) { if (type === "all") { @@ -36,20 +38,14 @@ export default class Page { } async selectAlbumFromUID(uid) { - await t - .hover(Selector("div.result.is-album").withAttribute("data-uid", uid)) - .click(Selector(`.uid-${uid} .input-select`)); + await t.hover(Selector("div.result.is-album").withAttribute("data-uid", uid)).click(Selector(`.uid-${uid} .input-select`)); } async toggleSelectNthAlbum(nth, type) { if (type === "all") { - await t - .hover(Selector("div.result.is-album", { timeout: 4000 }).nth(nth)) - .click(Selector("div.result.is-album .input-select").nth(nth)); + await t.hover(Selector("div.result.is-album", { timeout: 4000 }).nth(nth)).click(Selector("div.result.is-album .input-select").nth(nth)); } else { - await t - .hover(Selector("div.type-" + type, { timeout: 4000 }).nth(nth)) - .click(Selector("div.type-" + type + " .input-select").nth(nth)); + await t.hover(Selector("div.type-" + type, { timeout: 4000 }).nth(nth)).click(Selector("div.type-" + type + " .input-select").nth(nth)); } } @@ -69,6 +65,17 @@ export default class Page { await t.click(Selector("div.result.is-album").withAttribute("data-uid", uid)); } + async openByTitle(title) { + // Enter submits the filter to the backend; without it the grid stays on + // the default ordering and a freshly-added album can be pushed off-screen + // by virtual scrolling. + await t.typeText(this.search, title, { replace: true }).pressKey("enter"); + const card = Selector("div.result.is-album", { timeout: 10000 }).withText(title); + await t.expect(card.exists).ok(); + await t.click(card); + await t.expect(Selector("div.is-photo").visible).ok(); + } + async checkAlbumVisibility(uid, visible) { if (visible) { await t.expect(Selector("div").withAttribute("data-uid", uid).visible).ok(); diff --git a/frontend/tests/acceptance/page-model/context-menu.js b/frontend/tests/acceptance/page-model/context-menu.js index d44b4983d..99300b2f7 100644 --- a/frontend/tests/acceptance/page-model/context-menu.js +++ b/frontend/tests/acceptance/page-model/context-menu.js @@ -1,7 +1,10 @@ import { Selector, t } from "testcafe"; export default class Page { - constructor() {} + constructor() { + // Inert dialog title used to blur the album combobox while keeping focus in the dialog. + this.albumDialogTitle = Selector("div.p-photo-album-dialog div.v-toolbar-title", { timeout: 7000 }); + } async openContextMenu() { if (!(await Selector(".action-clear").visible)) { @@ -50,9 +53,9 @@ export default class Page { // Click on the album option to select it await t .click(Selector("div").withText(name).parent('div[role="option"]')) - .click(Selector("div i.mdi-bookmark")); + .click(this.albumDialogTitle); } else { - await t.typeText(Selector(".input-albums input"), name).click(Selector("div i.mdi-bookmark")); + await t.typeText(Selector(".input-albums input"), name).click(this.albumDialogTitle); } await t.expect(Selector("span.v-chip").withText(name).visible).ok(); } diff --git a/frontend/tests/acceptance/page-model/dialog-album.js b/frontend/tests/acceptance/page-model/dialog-album.js index b86a5d4a4..c754dc280 100644 --- a/frontend/tests/acceptance/page-model/dialog-album.js +++ b/frontend/tests/acceptance/page-model/dialog-album.js @@ -8,5 +8,7 @@ export default class Page { this.description = Selector(".input-description textarea", { timeout: 15000 }); this.category = Selector(".input-category input", { timeout: 15000 }); this.location = Selector(".input-location input", { timeout: 15000 }); + this.sortOrderSelect = Selector(".form-album-edit .v-select", { timeout: 15000 }); + this.sortOrderValue = Selector(".form-album-edit .v-select .v-field__input", { timeout: 15000 }); } } diff --git a/frontend/tests/acceptance/page-model/dialog/camera.js b/frontend/tests/acceptance/page-model/dialog/camera.js new file mode 100644 index 000000000..ce0d63a47 --- /dev/null +++ b/frontend/tests/acceptance/page-model/dialog/camera.js @@ -0,0 +1,18 @@ +import { Selector } from "testcafe"; + +export default class CameraDialog { + constructor() { + this.root = Selector(".p-meta-camera-dialog", { timeout: 15000 }); + this.camera = this.root.find(".input-camera"); + this.lens = this.root.find(".input-lens"); + // v-select renders the chosen option in `.v-select__selection-text`. + this.cameraValue = this.root.find(".input-camera .v-select__selection-text"); + this.lensValue = this.root.find(".input-lens .v-select__selection-text"); + this.iso = this.root.find(".input-iso input"); + this.exposure = this.root.find(".input-exposure input"); + this.fnumber = this.root.find(".input-fnumber input"); + this.focalLength = this.root.find(".input-focal-length input"); + this.confirm = this.root.find(".action-confirm"); + this.cancel = this.root.find(".action-cancel"); + } +} diff --git a/frontend/tests/acceptance/page-model/dialog/date-time.js b/frontend/tests/acceptance/page-model/dialog/date-time.js new file mode 100644 index 000000000..47709d5df --- /dev/null +++ b/frontend/tests/acceptance/page-model/dialog/date-time.js @@ -0,0 +1,20 @@ +import { Selector } from "testcafe"; + +export default class DateTimeDialog { + constructor() { + this.root = Selector(".p-meta-datetime-dialog", { timeout: 15000 }); + this.year = this.root.find(".input-year input"); + this.month = this.root.find(".input-month input"); + this.day = this.root.find(".input-day input"); + this.localTime = this.root.find(".input-local-time input"); + this.timezone = this.root.find(".input-timezone input"); + // v-autocomplete renders the chosen option text in a sibling element; + // the inner .value tracks the search/filter string instead. + this.yearValue = this.root.find(".input-year .v-autocomplete__selection"); + this.monthValue = this.root.find(".input-month .v-autocomplete__selection"); + this.dayValue = this.root.find(".input-day .v-autocomplete__selection"); + this.timezoneValue = this.root.find(".input-timezone .v-autocomplete__selection"); + this.confirm = this.root.find(".action-confirm"); + this.cancel = this.root.find(".action-cancel"); + } +} diff --git a/frontend/tests/acceptance/page-model/dialog/location.js b/frontend/tests/acceptance/page-model/dialog/location.js new file mode 100644 index 000000000..dcf4234cb --- /dev/null +++ b/frontend/tests/acceptance/page-model/dialog/location.js @@ -0,0 +1,10 @@ +import { Selector } from "testcafe"; + +export default class LocationDialog { + constructor() { + this.root = Selector(".p-meta-location-dialog", { timeout: 15000 }); + this.coordinates = this.root.find(".input-coordinates input"); + this.confirm = this.root.find(".action-confirm"); + this.cancel = this.root.find(".action-cancel"); + } +} diff --git a/frontend/tests/acceptance/page-model/helpers.js b/frontend/tests/acceptance/page-model/helpers.js new file mode 100644 index 000000000..1745bd0d6 --- /dev/null +++ b/frontend/tests/acceptance/page-model/helpers.js @@ -0,0 +1,1008 @@ +import { ClientFunction } from "testcafe"; +import testcafeconfig from "../../testcafeconfig.json"; + +export const showLogs = process.env.SHOW_LOGS === "true"; + +// getTopElement will return details on what is on top of a selector. +// Useful when the standard output from testcafe warning is insufficient to identify the obstruction. +export const getTopElement = ClientFunction((selectorFn) => { + const el = selectorFn(); + const rect = el.getBoundingClientRect(); + const centerX = rect.left + rect.width / 2; + const centerY = rect.top + rect.height / 2; + + // Returns the topmost element at the exact center of the target + const topEl = document.elementFromPoint(centerX, centerY); + + return { + tagName: topEl.tagName.toLowerCase(), + className: topEl.className, + id: topEl.id, + innerText: topEl.innerText, + innerHTML: topEl.innerHTML, + outerHTML: topEl.outerHTML + }; +}); + +// clickIfVisible speeds up testcafe's click by shortening the wait time when an item is visible. +// Should only be used for cases where an overlay obscures a selection, but it will not impact the testing. +export async function clickIfVisible(t, sel) { + if (await sel.visible) { + await t.click(sel.with({ timeout: 150 })); + } else { + await t.click(sel); + } +} + +export function logMessage(message) { + if (showLogs) { + const now = new Date(); + console.log(now.toISOString() + " " + message); + } +} + +export function logTime(key) { + showLogs && console.time(key); +} + +export function logTimeEnd(key) { + showLogs && console.timeEnd(key); +} + +// helperRequest performs in a similar way to t.request, but uses fetch instead. +// Currently supports public tests. +// Must be provided with url and method objects +// Example : +// { +// url: `${testcafeconfig.api}albums`, +// method: 'get', +// params: { +// count: Limit, +// offset: xOffset +// } +// } +async function helperRequest(requestOptions) { + const rURL = new URL(requestOptions.url); + if (requestOptions.params) { + Object.entries(requestOptions.params).forEach(([key, value]) => { + rURL.searchParams.append(key, value); + }); + } + + let rOption = { + method: requestOptions.method + } + + if (requestOptions.body) { + rOption.body = requestOptions.body; + } + + const response = await fetch(rURL, rOption); + + let headers = {}; + if (response.headers) { + response.headers.forEach((value, key) => { + headers[key] = value; + }); + } + + if (response.ok) { + const result = await response.json(); + return { + status: response.status, + statusText: response.statusText, + headers: headers, + body: result + }; + } else { + try { + const result = await response.json(); + return { + status: response.status, + statusText: response.statusText, + headers: headers, + body: result + }; + } catch { + return response; + } + } +} + +// getAllAlbumPhotos uses Fetch for get all the basic photo information of photos that are in the album identified by it's UID (albumUID). +async function getAllAlbumPhotos(albumUID) { + let photos = []; + const Limit = 50; + let xCount = Limit; + let xOffset = 0; + + while (xCount === Limit) { + const photoApiResponse = await helperRequest({ + url: `${testcafeconfig.api}photos`, + params: { + count: Limit, + offset: xOffset, + s: albumUID + } + }); + xOffset += Limit; + if (photoApiResponse.status === 200) { + xCount = Number(photoApiResponse.headers["x-count"]); + photos.push(...photoApiResponse.body); + } else { + xCount = 0; + throw new Error(`getAllPhotos failed with status ${photoApiResponse.status} and ${photoApiResponse.statusText}`); + } + } + return photos; +} + +// getAllAlbums populates the passed in array with all the albums details +// returns empty string on success, or error message. +async function getAllAlbums(albums) { + albums.length = 0; + let searchApiResponse; + const Limit = 50; + let xCount = Limit; + let xOffset = 0; + // Snapshot all albums, and the photos in them + while (xCount === Limit) { + searchApiResponse = await helperRequest({ + url: `${testcafeconfig.api}albums`, + method: 'get', + params: { + count: Limit, + offset: xOffset + } + }); + xOffset += Limit; + if (searchApiResponse.status === 200) { + xCount = Number(searchApiResponse.headers["x-count"]); + for (const album of searchApiResponse.body) { + const photos = await getAllAlbumPhotos(album.UID); + const rAlbum = { + "uid": album.UID, + "data": album, + "photos": photos + } + albums.push(rAlbum); + } + } else { + const msg = "getAllAlbums gather albums " + JSON.stringify(searchApiResponse); + logMessage(msg); + return msg; + } + } + return ''; +} + +// getAllLabels populates the passed in array with all the label details +// returns empty string on success, or error message. +async function getAllLabels(labels) { + labels.length = 0; + let searchApiResponse; + const Limit = 50; + let xCount = Limit; + let xOffset = 0; + // Snapshot all labels (the photo snapshot captures which labels are for which photos) + while (xCount === Limit) { + searchApiResponse = await helperRequest({ + url: `${testcafeconfig.api}labels`, + method: 'get', + params: { + count: Limit, + offset: xOffset, + all: true + } + }); + xOffset += Limit; + if (searchApiResponse.status === 200) { + xCount = searchApiResponse.body.length; // labels does not return an x-count as at 2026-06-04. + for (const label of searchApiResponse.body) { + const rLabel = { + "uid": label.UID, + "data": label + } + labels.push(rLabel); + } + } else { + const msg = "getAllLabels gather labels " + JSON.stringify(searchApiResponse); + logMessage(msg); + return msg; + } + } + return ''; +} + +// getAllPhotos populates the passed in array with all the photo details +// returns empty string on success, or error message. +async function getAllPhotos(photos) { + photos.length = 0; + let searchApiResponse; + const Limit = 50; + let xCount = Limit; + let xOffset = 0; + // There are 110 photos with files in Acceptance database + // primary:true public:false - 104 (includes review photos) + // primary:true archived:true - 6 (archived:true overrides public:false, so only archived photos are returned.) + // Snapshot non archived photos, getting all their details (2nd call per photo required) + while (xCount === Limit) { + searchApiResponse = await helperRequest({ + url: `${testcafeconfig.api}photos`, + method: 'get', + params: { + count: Limit, + offset: xOffset, + q: "primary:true public:false" + } + }); + xOffset += Limit; + if (searchApiResponse.status === 200) { + xCount = Number(searchApiResponse.headers["x-count"]); + for (const photo of searchApiResponse.body) { + const photoApiResponse = await helperRequest({ + url: `${testcafeconfig.api}photos/${photo.UID}`, + method: 'get' + }); + if (photoApiResponse.status === 200) { + const rPhoto = { + "uid": photo.UID, + "data": photoApiResponse.body + } + photos.push(rPhoto); + } else { + const msg = "getAllPhotos query photo " + JSON.stringify(photoApiResponse); + logMessage(msg); + return msg; + } + } + } else { + const msg = "getAllPhotos gather photos " + JSON.stringify(searchApiResponse); + logMessage(msg); + return msg; + } + } + // Snapshot archived photos, getting all their details (2nd call per photo required) + xCount = Limit; + xOffset = 0; + while (xCount === Limit) { + searchApiResponse = await helperRequest({ + url: `${testcafeconfig.api}photos`, + method: 'get', + params: { + count: Limit, + offset: xOffset, + q: "primary:true archived:true" + } + }); + xOffset += Limit; + if (searchApiResponse.status === 200) { + xCount = Number(searchApiResponse.headers["x-count"]); + for (const photo of searchApiResponse.body) { + const photoApiResponse = await helperRequest({ + url: `${testcafeconfig.api}photos/${photo.UID}`, + method: 'get' + }); + if (photoApiResponse.status === 200) { + const rPhoto = { + "uid": photo.UID, + "data": photoApiResponse.body + } + photos.push(rPhoto); + } else { + const msg = "getAllPhotos query archived photo " + JSON.stringify(photoApiResponse); + logMessage(msg); + return msg; + } + } + } else { + const msg = "getAllPhotos gather archived photos " + JSON.stringify(searchApiResponse); + logMessage(msg); + return msg; + } + } + return ''; +} + + +// helperBeforeFixture will setup the context for all the tests, by taking a snapshot of the before fixture state. +export async function helperBeforeFixture(ctx) { + logMessage("helperBeforeFixture"); + let snapshotAlbums = []; + let snapshotLabels = []; + let snapshotPhotos = []; + + // Snapshot all albums, and the photos in them + let result = await getAllAlbums(snapshotAlbums); + if (result !== '') { + throw new Error(result); + } + + // Snapshot all labels + result = await getAllLabels(snapshotLabels); + if (result !== '') { + throw new Error(result); + } + + // Snapshot all photos + result = await getAllPhotos(snapshotPhotos); + if (result !== '') { + throw new Error(result); + } + + // Store all the snapshots for use in the beforeEach/afterEach functions + ctx.snapshots = { + "snapshotAlbums": snapshotAlbums, + "snapshotLabels": snapshotLabels, + "snapshotPhotos": snapshotPhotos + } +} + +export async function helperBeforeEach(t) { + logMessage("helperBeforeEach"); + + let startTimestamp = new Date(); + startTimestamp.setMilliseconds(0); + let helperFailures = []; + + t.ctx.testChanges = { + "startTimestamp": startTimestamp.toISOString(), + "revertAlbums": [], + "revertPhotos": [], + "removeAlbums": [], + "removeLabels": [], + "removePhotos": [] + } + await t.expect(helperFailures).eql([]); +} + +// deepEqual attempts to determine if 2 json objects are different. +function deepEqual(x, y) { + const ignoreKeys = ["UpdatedAt", "EditedAt", "CheckedAt", "EstimatedAt", "IndexedAt", "ThumbSrc", "LabelSrc"]; // Ignore these keys as we are looking for real changes. + return x && y && typeof x === 'object' && typeof x === typeof y ? ( + Object.keys(x).filter(key => !ignoreKeys.includes(key)).length === Object.keys(y).filter(key => !ignoreKeys.includes(key)).length && + Object.keys(x).every(key => { + if (ignoreKeys.includes(key)) { + return true; + } else { + return deepEqual(x[key], y[key]); + } + }) + ) : (x === y); +} + +// determineChangedAlbums works out which albums have been changed since the beforeFixture was run. +async function determineChangedAlbums(t) { + const beforeTimestamp = new Date(t.ctx.testChanges.startTimestamp); + let currentAlbums = []; + + // Snapshot all albums, and the photos in them + const result = await getAllAlbums(currentAlbums); + if (result !== '') { + throw new Error(result); + } + + for (const currentAlbum of currentAlbums) { + if (new Date(currentAlbum.data.CreatedAt) >= beforeTimestamp) { + if (!t.ctx.testChanges.removeAlbums.some(ra => ra.uid === currentAlbum.uid)) { + const removeAlbum = { + "name": "uid", + "uid": currentAlbum.uid + } + t.ctx.testChanges.removeAlbums.push(removeAlbum); + } + } else { + const rAlbum = t.fixtureCtx.snapshots.snapshotAlbums.find((a) => a.uid === currentAlbum.uid); + if (rAlbum) { + if (!deepEqual(currentAlbum, rAlbum)) { + t.ctx.testChanges.revertAlbums.push(rAlbum); + } + } else { + const msg = `helperDetermineChangedItems revert albums (1) ${currentAlbum.uid} is missing from snapshot albums`; + logMessage(msg); + return msg; + } + } + } + let foundAlbums = []; + foundAlbums.push(...currentAlbums.map(album => album.uid)); + // Find albums that have been deleted, and flag them for reversion. + for (const album of t.fixtureCtx.snapshots.snapshotAlbums) { + if (!foundAlbums.includes(album.uid)) { + t.ctx.testChanges.revertAlbums.push(album); + } + } + return ''; +} + +// determineChangedLabels works out which labels have been changed since the beforeFixture was run. +async function determineChangedLabels(t) { + const beforeTimestamp = new Date(t.ctx.testChanges.startTimestamp); + let currentLabels = []; + + // Snapshot all labels + const result = await getAllLabels(currentLabels); + if (result !== '') { + throw new Error(result); + } + + for (const currentLabel of currentLabels) { + if (new Date(currentLabel.data.CreatedAt) >= beforeTimestamp) { + if (!t.ctx.testChanges.removeLabels.some(rl => rl.uid === currentLabel.uid)) { + const removeLabel = { + "uid": currentLabel.uid + } + t.ctx.testChanges.removeLabels.push(removeLabel); + } + } + } + return ''; +} + +// determineChangedPhotos works out which photos have been changed since the beforeFixture was run. +// this function stores the snapshot information about a photo that will need to be reverted into the context. +// Known issues after executing helperAfterEach: +// Automatically generated titles may be updated to match new format (over old in acceptance data), or reflect labels reverted +// Labels will change type and uncertainty if they were not manual and need to be reverted +// Updated timestamps will change +// Can not restack a file that has been unstacked from a photo +// Can not undelete a file that has been deleted from a photo +// Can NOT revert a photo that has Quality < 3, because the quality will be 3 after reversion due to edits applied. +// Please note that photos of quality < 3 will not be selected for reversion. + +async function determineChangedPhotos(t) { + const beforeTimestamp = new Date(t.ctx.testChanges.startTimestamp); + let currentPhotos = []; + + // Snapshot all photos + const result = await getAllPhotos(currentPhotos); + if (result !== '') { + throw new Error(result); + } + + for (const currentPhoto of currentPhotos) { + if (new Date(currentPhoto.data.CreatedAt) >= beforeTimestamp) { + t.ctx.testChanges.removePhotos.push(currentPhoto); + } else { + const rPhoto = t.fixtureCtx.snapshots.snapshotPhotos.find((a) => a.uid === currentPhoto.uid); + if (rPhoto) { + if (!deepEqual(currentPhoto, rPhoto)) { + if (rPhoto.data.Quality > 2) { // all photos have Quality, so null check is not required + t.ctx.testChanges.revertPhotos.push(rPhoto); + } + } + } else { + // This is the result of an unstack call /api/v1/photos/{uid}/files/{fileuid}/unstack + // There is no API to revert this :-( + const msg = `Unable to revert photo ${currentPhoto.uid} as it has been unstacked from another photo.`; + logMessage(msg); + } + } + } + return ''; +} + +// This function will undo what the test has done (to the best of it's ability) +// as requested by the helperRemove and helperRevert functions. +export async function helperAfterEach(t) { + logMessage("helperAfterEach"); + + let helperFailures = []; + + let result = await determineChangedLabels(t); + if (result !== ""){ + throw new Error(result); + } + + // Remove Labels + try { + if (t.ctx.testChanges.removeLabels.length > 0) { + let labels = []; + for (const removeLabel of t.ctx.testChanges.removeLabels) { + labels.push(removeLabel.uid); + } + if (labels.length > 0) { + const apiResponse = await t.request({ + url: `${testcafeconfig.api}batch/labels/delete`, + method: 'post', + body: { + "labels": labels + } + }); + if (apiResponse.status !== 200 || apiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach delete labels " + JSON.stringify(apiResponse); + logMessage(msg); + helperFailures.push(msg); + } + } + } + } catch (e) { + const errorText = e.errmsg || e.message || "An unknown error occurred"; + helperFailures.push(`removeLabels threw ${errorText}`); + } + + result = await determineChangedPhotos(t); + if (result !== ""){ + throw new Error(result); + } + + // Detect album changes before reverting photos so the photo loop can skip albums + // that revertAlbums will restore: re-adding a photo to a soft-deleted album 404s + // and pushes revertAlbums onto its re-create-under-a-new-UID branch. + result = await determineChangedAlbums(t); + if (result !== ""){ + throw new Error(result); + } + const albumsHandledByRevert = new Set(t.ctx.testChanges.revertAlbums.map(a => a.uid)); + + // Revert Photos state + // this can not fully restore labels to a photo. + // if the label has been fully removed, and it matches a keyword, then it will + // be restored as a keyword based label. Otherwise it will be a manual + // style label. + try { + for (const revertPhoto of t.ctx.testChanges.revertPhotos) { + // Get current photo status + let apiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${revertPhoto.uid}`, + method: 'get' + }); + if (apiResponse.status !== 200 || apiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach revert photo (1) " + JSON.stringify(apiResponse); + logMessage(msg); + helperFailures.push(msg); + } + + if (!revertPhoto.data.DeletedAt && apiResponse.body.DeletedAt) { + // Need to restore the photo + const restoreResponse = await t.request({ + url: `${testcafeconfig.api}batch/photos/restore`, + method: 'post', + body: { + "photos": [ revertPhoto.uid ] + } + }); + if (restoreResponse.status !== 200 || restoreResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach revert restore photo " + JSON.stringify(restoreResponse); + logMessage(msg); + helperFailures.push(msg); + } + } + + // Revert the photo + apiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${revertPhoto.uid}`, + method: 'put', + body: revertPhoto.data + }); + if (apiResponse.status !== 200 || apiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach revert photo (2) " + JSON.stringify(apiResponse); + logMessage(msg); + helperFailures.push(msg); + } + + // Loop through the labels in revertPhoto.data and apiResponse.body to add/remove as needed. + // Remove + for (const label of apiResponse.body.Labels) { + const exists = revertPhoto.data.Labels.find(slug => slug.Label.Slug === label.Label.Slug); + if (!exists) { + let labelApiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${revertPhoto.uid}/label/${label.LabelID}`, + method: 'put', + body: { + "Uncertainty": 10, // Need to set Uncertainty < 100, and LabelSrc to manual so it gets soft deleted! + "LabelSrc": "manual" + } + }); + if (labelApiResponse.status !== 200 || labelApiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach manual label " + JSON.stringify(labelApiResponse); + logMessage(msg); + helperFailures.push(msg); + } + labelApiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${revertPhoto.uid}/label/${label.LabelID}`, + method: 'delete' + }); + if ((labelApiResponse.status !== 200 && labelApiResponse.status !== 404) || labelApiResponse.status === null ) { // Ignore Ok and not found + const msg = "helperAfterEach remove label from photo " + JSON.stringify(labelApiResponse); + logMessage(msg); + helperFailures.push(msg); + } + } + } + // Add + for (const label of revertPhoto.data.Labels) { + const exists = apiResponse.body.Labels.find(slug => slug.Label.Slug === label.Label.Slug); + if (!exists) { + const labelApiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${revertPhoto.uid}/label`, + method: 'post', + body: { + "Description": label.Label.Description, + "Favorite": label.Label.Favorite, + "Name": label.Label.Name, + "Notes": label.Label.Notes, + "Priority": label.Label.Priority, + "Thumb": label.Label.Thumb, + // "ThumbSrc": label.Label.ThumbSrc, + "Uncertainty": label.Uncertainty, + "LabelSrc": "manual" // Reverted ThumbSrc will always be manual due to API. + } + }); + if (labelApiResponse.status !== 200 || labelApiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach add label " + JSON.stringify(labelApiResponse); + logMessage(msg); + helperFailures.push(msg); + } + } else { + let labelApiResponse; + labelApiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${revertPhoto.uid}/label/${label.LabelID}`, + method: 'put', + body: { + "Description": label.Label.Description, + "Favorite": label.Label.Favorite, + "Name": label.Label.Name, + "Notes": label.Label.Notes, + "Priority": label.Label.Priority, + "Thumb": label.Label.Thumb, + // "ThumbSrc": label.Label.ThumbSrc, + "Uncertainty": label.Uncertainty // Although this doesn't match the previous number, it forces a manual label back into place. All that can be done. + } + }); + if (labelApiResponse.status !== 200 || labelApiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach reset label " + JSON.stringify(labelApiResponse); + logMessage(msg); + helperFailures.push(msg); + } + } + } + + // Loop through the Albums in revertPhoto.data and apiResponse.body to add/remove as needed. + // Remove + for (const album of apiResponse.body.Albums) { + const exists = revertPhoto.data.Albums.some(slug => slug.Slug === album.Slug); + if (!exists) { + const albumApiResponse = await t.request({ + url: `${testcafeconfig.api}albums/${album.UID}/photos`, + method: 'delete', + body: { + "photos": [ revertPhoto.uid ] + } + }); + if (albumApiResponse.status !== 200 || albumApiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach delete from album " + JSON.stringify(albumApiResponse); + logMessage(msg); + helperFailures.push(msg); + } + } + } + // Add + for (const album of revertPhoto.data.Albums) { + // Skip albums that revertAlbums will restore below — it recreates the album + // (possibly under a new UID) and reconnects its snapshot photos. POSTing here + // would target a soft-deleted UID, 404, and leave the album orphaned. + if (albumsHandledByRevert.has(album.UID)) { + continue; + } + // Re-add only when the photo is not already in this still-live album. The + // condition is !exists (mirror of the Remove loop's set difference): a test + // that removed the photo leaves the album absent from the current set. + const exists = apiResponse.body.Albums.some(slug => slug.UID === album.UID); + if (!exists) { + const albumApiResponse = await t.request({ + url: `${testcafeconfig.api}albums/${album.UID}/photos`, + method: 'post', + body: { + "photos": [ revertPhoto.uid ] + } + }); + // Ignore Ok and 404: a snapshot album owned by another user is recreated + // under a new UID by revertAlbums, so the photo's snapshot still references + // a now-dead UID. Membership can't be restored there and revertAlbums has + // already reconnected what it can under the new UID — so 404 is expected. + if ((albumApiResponse.status !== 200 && albumApiResponse.status !== 404) || albumApiResponse.status === null) { + const msg = `helperAfterEach add to album ${album.UID} ${JSON.stringify(albumApiResponse)}`; + logMessage(msg); + helperFailures.push(msg); + } + } + } + + // Loop through the files and markers to update as required + // Invalidate any that shouldn't be there. + for (const file of apiResponse.body.Files) { + const rFile = revertPhoto.data.Files.find(fileI => fileI.UID === file.UID) + if (rFile) { + for (const marker of file.Markers) { + const rMarker = rFile.Markers.find(m => m.UID === marker.UID && m.FileUID === marker.FileUID); + let markerApiResponse; + if (rMarker) { + // reset + markerApiResponse = await t.request({ + url: `${testcafeconfig.api}markers/${rMarker.UID}`, + method: 'put', + body: rMarker + }); + } else { + // inactivate + markerApiResponse = await t.request({ + url: `${testcafeconfig.api}markers/${marker.UID}`, + method: 'put', + body: { + "Invalid":true + } + }); + } + if (markerApiResponse.status !== 200 || markerApiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach sync markers (1) file " + marker.FileUID + " marker " + marker.UID + " " + JSON.stringify(markerApiResponse); + logMessage(msg); + helperFailures.push(msg); + } + } + } else { + const msg = `Choosing not to remove file ${file.UID} which has been added, as that will break future tests as the file is physically deleted.`; + logMessage(msg); + helperFailures.push(msg); + } + } + for (const file of revertPhoto.data.Files) { + const cFile = apiResponse.body.Files.find(fileI => fileI.UID === file.UID) + if (cFile) { + for (const marker of file.Markers) { + // Restore the marker whether it is there or not. + const markerApiResponse = await t.request({ + url: `${testcafeconfig.api}markers/${marker.UID}`, + method: 'put', + body: marker + }); + if (markerApiResponse.status !== 200 || markerApiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach sync markers (2)" + JSON.stringify(markerApiResponse); + logMessage(msg); + helperFailures.push(msg); + } + } + } else { + // This is the result of an unstack call /api/v1/photos/{uid}/files/{fileuid}/unstack + // There is no API to revert this :-( + const msg = `Unable to restore file ${file.UID} which has been unstacked from photo ${revertPhoto.uid}.`; + logMessage(msg); + } + } + + // Revert any changes to Primary file. + const originalPrimary = revertPhoto.data.Files.find((element) => element.Primary === true) + const currentPrimary = apiResponse.body.Files.find((element) => element.Primary === true) + if (originalPrimary && currentPrimary) { + const originalUID = originalPrimary.UID + const currentUID = currentPrimary.UID + if (originalUID !== currentUID) { + const primaryApiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${revertPhoto.uid}/files/${originalUID}/primary`, + method: 'post' + }); + if (primaryApiResponse.status !== 200 || primaryApiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach revert photo primary " + JSON.stringify(primaryApiResponse); + logMessage(msg); + helperFailures.push(msg); + } + } + } + + // Do the photo again to try the Title again. + apiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${revertPhoto.uid}`, + method: 'put', + body: revertPhoto.data + }); + if (apiResponse.status !== 200 || apiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach revert photo again " + JSON.stringify(apiResponse); + logMessage(msg); + helperFailures.push(msg); + } + if (revertPhoto.data.DeletedAt && !apiResponse.body.DeletedAt) { + // Need to archive the photo + const archiveResponse = await t.request({ + url: `${testcafeconfig.api}batch/photos/archive`, + method: 'post', + body: { + "photos": [ revertPhoto.uid ] + } + }); + if (archiveResponse.status !== 200 || archiveResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach revert archive photo " + JSON.stringify(archiveResponse); + logMessage(msg); + helperFailures.push(msg); + } + } + + } + } catch (e) { + const errorText = e.errmsg || e.message || "An unknown error occurred"; + helperFailures.push(`revertPhoto threw ${errorText}`); + } + + // Archive any new photos + let deletePhotos = []; + try { + for (const removePhoto of t.ctx.testChanges.removePhotos) { + // Get current photo status + let apiResponse = await t.request({ + url: `${testcafeconfig.api}photos/${removePhoto.uid}`, + method: 'get' + }); + if (apiResponse.status !== 200 || apiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach removePhoto get " + JSON.stringify(apiResponse); + logMessage(msg); + helperFailures.push(msg); + } + if (!apiResponse.body.DeletedAt) { + deletePhotos.push(removePhoto.uid); + } + } + + if (deletePhotos.length > 0) { + let apiResponse = await t.request({ + url: `${testcafeconfig.api}batch/photos/archive`, // Can NOT use delete, as this will remove the associated file from the file system, which will break all subsequent test suite executions. + method: 'post', + body: { "photos": deletePhotos } + }); + if (apiResponse.status !== 200 || apiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach removePhoto archive " + JSON.stringify(apiResponse); + logMessage(msg); + helperFailures.push(msg); + } + } + } catch (e) { + const errorText = e.errmsg || e.message || "An unknown error occurred"; + helperFailures.push(`removePhoto threw ${errorText}`); + } + + // Revert Albums state + // This MAY result in a different UID if the album has been deleted, and it wasn't created by the current user. + // This step owns membership restoration for every reverted album (see the reconnect + // below) — the photo-revert loop deliberately skips these albums so it never POSTs to + // one that is still soft-deleted here. + try { + for (let revertAlbum of t.ctx.testChanges.revertAlbums) { + let apiResponse = await t.request({ + url: `${testcafeconfig.api}albums/${revertAlbum.uid}`, + method: 'put', + body: revertAlbum.data + }); + if (apiResponse.status === 404) { + let apiPostResponse = await t.request({ + url: `${testcafeconfig.api}albums`, + method: 'post', + body: revertAlbum.data + }); + + if (apiPostResponse.status === 201) { // The Album has been created with a different UID! + revertAlbum.data.UID = apiPostResponse.body.UID; + revertAlbum.data.ID = apiPostResponse.body.ID; + revertAlbum.uid = apiPostResponse.body.UID; + if (revertAlbum.data.Thumb) { + revertAlbum.data.ThumbSrc = "manual"; // To revert a thumb it must be manual + } + // Updating the NEW album + apiResponse = await t.request({ + url: `${testcafeconfig.api}albums/${revertAlbum.uid}`, + method: 'put', + body: revertAlbum.data + }); + if (apiResponse.status !== 200 || apiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach revert albums (1) " + JSON.stringify(apiResponse); + logMessage(msg); + helperFailures.push(msg); + } + } + } else { + if (apiResponse.status !== 200 || apiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach revert albums (2) " + JSON.stringify(apiResponse); + logMessage(msg); + helperFailures.push(msg); + } + } + // Restore the photos connections for this album, now that it is live again. + // This is why the photo-revert loop skips reverted albums: their membership is + // re-added here against the correct (possibly recreated) UID. + const albumPhotoApiResponse = await t.request(`${testcafeconfig.api}photos?count=50&offset=0&s=${revertAlbum.uid}`); + + let photos = []; + for (const photo of revertAlbum.photos) { + if (!albumPhotoApiResponse.body.find(ap => ap.UID === photo.UID)) + { + photos.push(photo.UID); + } + } + if (photos.length > 0){ + const photoApiResponse = await t.request({ + url: `${testcafeconfig.api}albums/${revertAlbum.uid}/photos`, + method: 'post', + body: { "photos": photos } + }); + if (photoApiResponse.status !== 200 || photoApiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach revert albums photos " + JSON.stringify(photoApiResponse); + logMessage(msg); + helperFailures.push(msg); + } + } + apiResponse = await t.request({ + url: `${testcafeconfig.api}albums/${revertAlbum.uid}`, + method: 'get' + }); + if (revertAlbum.data.Thumb !== apiResponse.body.Thumb) { + // Try updating the album again in case the thumb was from a removed photo. + if (revertAlbum.data.Thumb) { + revertAlbum.data.ThumbSrc = "manual"; // To revert a thumb it must be manual + } + + let apiResponse = await t.request({ + url: `${testcafeconfig.api}albums/${revertAlbum.uid}`, + method: 'put', + body: revertAlbum.data + }); + if (apiResponse.status !== 200 || apiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach revert albums with thumb manual " + JSON.stringify(apiResponse); + logMessage(msg); + helperFailures.push(msg); + } + } + } + } catch (e) { + const errorText = e.errmsg || e.message || "An unknown error occurred"; + helperFailures.push(`revertAlbum threw ${errorText}`); + } + + + // Remove albums + try { + for (const removeAlbum of t.ctx.testChanges.removeAlbums) { + let listApiResponse; + if (removeAlbum.uid === "name") { + listApiResponse = await t.request({ + url: `${testcafeconfig.api}albums`, + method: 'get', + params: { + count: 10, + q: `${removeAlbum.name} type:album` + } + }); + } else { + listApiResponse = await t.request({ + url: `${testcafeconfig.api}albums`, + method: 'get', + params: { + count: 10, + q: `uid:${removeAlbum.uid}` + } + }); + } + if (listApiResponse.status !== 200 || listApiResponse.status === null) { // Ignore Ok + const msg = "helperAfterEach list albums " + JSON.stringify(listApiResponse); + logMessage(msg); + helperFailures.push(msg); + } + for (const album of listApiResponse.body) { + const apiResponse = await t.request({ + url: `${testcafeconfig.api}albums/${album.UID}`, + method: 'delete', + params: { + force: true + } + }); + if (apiResponse.status !== 200 || apiResponse.status === null && apiResponse.status !== 404) { // Ignore Ok and not found + const msg = "helperAfterEach delete album " + JSON.stringify(apiResponse); + logMessage(msg); + helperFailures.push(msg); + } + } + } + } catch (e) { + const errorText = e.errmsg || e.message || "An unknown error occurred"; + helperFailures.push(`removeAlbums threw ${errorText}`); + } + + // Error if there were any API or try/catch failures. + await t.expect(helperFailures).eql([]); +} diff --git a/frontend/tests/acceptance/page-model/label.js b/frontend/tests/acceptance/page-model/label.js index 6b3a0d52b..6ff030dab 100644 --- a/frontend/tests/acceptance/page-model/label.js +++ b/frontend/tests/acceptance/page-model/label.js @@ -20,9 +20,7 @@ export default class Page { } async toggleSelectNthLabel(nth) { - await t - .hover(Selector("div.is-label", { timeout: 4000 }).nth(nth)) - .click(Selector("div.is-label .input-select").nth(nth)); + await t.hover(Selector("div.is-label", { timeout: 4000 }).nth(nth)).click(Selector("div.is-label .input-select").nth(nth)); } async openNthLabel(nth) { @@ -33,6 +31,17 @@ export default class Page { await t.click(Selector("div.is-label").withAttribute("data-uid", uid)); } + async openByTitle(title) { + // Enter submits the filter to the backend; without it the grid stays on + // the default (count-sorted) ordering and a freshly-added label with + // count=1 is pushed off-screen by virtual scrolling. + await t.typeText(this.search, title, { replace: true }).pressKey("enter"); + const card = Selector("div.is-label", { timeout: 10000 }).withText(title); + await t.expect(card.exists).ok(); + await t.click(card); + await t.expect(Selector("div.is-photo").visible).ok(); + } + async triggerHoverAction(mode, uidOrNth, action) { if (mode === "uid") { await t.hover(Selector("div.uid-" + uidOrNth)); diff --git a/frontend/tests/acceptance/page-model/menu.js b/frontend/tests/acceptance/page-model/menu.js index 16983012f..098c050ba 100644 --- a/frontend/tests/acceptance/page-model/menu.js +++ b/frontend/tests/acceptance/page-model/menu.js @@ -1,6 +1,5 @@ import { Selector, t } from "testcafe"; - -const showLogs = process.env.SHOW_LOGS == "true"; +import { getTopElement, logTime, logTimeEnd } from "./helpers"; export default class Page { constructor() { @@ -12,7 +11,6 @@ export default class Page { } async openNav() { - showLogs && console.time("openNav") if (await this.navActive.visible) { // Make sure that the nav has been rendered if (await this.navInRail.exists) { // fail fast looking for a minimized nav if (await this.expandButton.exists) { @@ -22,7 +20,6 @@ export default class Page { } } } - showLogs && console.timeEnd("openNav") } async openPage(page) { diff --git a/frontend/tests/acceptance/page-model/notifications.js b/frontend/tests/acceptance/page-model/notifications.js index 1907effac..68111110d 100644 --- a/frontend/tests/acceptance/page-model/notifications.js +++ b/frontend/tests/acceptance/page-model/notifications.js @@ -1,146 +1,141 @@ import { Selector, t } from "testcafe"; +import { logMessage, logTime, logTimeEnd, showLogs } from "./helpers"; -const showLogs = process.env.SHOW_LOGS == "true"; -const waitAfterClick = 350 // Please note that all t.click have to wait to allow the clicked item time to go away (300ms fade out). +const waitAfterClick = 350; // Please note that all t.click have to wait to allow the clicked item time to go away (300ms fade out). export default class Page { constructor() { - this.notifyClose250 = Selector(".p-notify__close", {timeout: 250}) - } - - logMessage(message) { - var now = new Date(); - console.log(now.toISOString() + " " + message); + this.notifyClose250 = Selector(".p-notify__close", {timeout: 250}); } // closeAllEventPopups will close any event popups that are open, ignoring any click issues. async closeAllEventPopups() { - showLogs && console.time("closeAllEventPopups"); - showLogs && this.logMessage("Before While in closeAllEventPopups"); + logTime("closeAllEventPopups"); + logMessage("Before While in closeAllEventPopups"); while(await this.notifyClose250.visible) { try { - showLogs && this.logMessage("Before Click in closeAllEventPopups"); + logMessage("Before Click in closeAllEventPopups"); await t.click(this.notifyClose250).wait(waitAfterClick); - showLogs && this.logMessage("After Click in closeAllEventPopups"); + logMessage("After Click in closeAllEventPopups"); } catch { - showLogs && this.logMessage("After Click In Catch in closeAllEventPopups"); - showLogs && console.trace("notify close missed in closeAllEventPopups") + logMessage("After Click In Catch in closeAllEventPopups"); + showLogs && console.trace("notify close missed in closeAllEventPopups"); } } - showLogs && console.timeEnd("closeAllEventPopups"); + logTimeEnd("closeAllEventPopups"); } // waitForSpecficEvent will wait for the event to show up, for delay amount of time (after closing any event messages that do not match). async waitForSpecficEvent(event, delay = 7000, close = true) { - showLogs && this.logMessage("Before While in waitForSpecficEvent"); + logMessage("Before While in waitForSpecficEvent"); while(await this.notifyClose250.visible) { if (await Selector("div.p-notify__text", {timeout: 50}).withText(event).visible) { try { if (close) { - showLogs && this.logMessage("Before Click in waitForSpecficEvent"); + logMessage("Before Click in waitForSpecficEvent"); await t.click(this.notifyClose250).wait(waitAfterClick); - showLogs && this.logMessage("After Click in waitForSpecficEvent"); + logMessage("After Click in waitForSpecficEvent"); } } catch { // ignore the error as the item may not show up - showLogs && this.logMessage("After Click In Catch in waitForSpecficEvent"); - console.trace("notify close missed in waitForSpecficEvent " + event) + logMessage("After Click In Catch in waitForSpecficEvent"); + console.trace("notify close missed in waitForSpecficEvent " + event); } finally { - return + return; } } try { - showLogs && this.logMessage("Before Click in waitForSpecficEvent"); + logMessage("Before Click in waitForSpecficEvent"); await t.click(this.notifyClose250).wait(waitAfterClick); - showLogs && this.logMessage("After Click in waitForSpecficEvent"); + logMessage("After Click in waitForSpecficEvent"); } catch { - showLogs && this.logMessage("After Click In Catch in waitForSpecficEvent"); - showLogs && console.trace("notify close missed in waitForSpecficEvent Pre") + logMessage("After Click In Catch in waitForSpecficEvent"); + showLogs && console.trace("notify close missed in waitForSpecficEvent Pre"); } } - showLogs && this.logMessage("Before Visible in waitForSpecficEvent"); + logMessage("Before Visible in waitForSpecficEvent"); if ((await Selector("div.p-notify__text", {timeout: delay}).withText(event).visible) && close){ try { - showLogs && this.logMessage("Before Click in waitForSpecficEvent"); + logMessage("Before Click in waitForSpecficEvent"); await t.click(this.notifyClose250).wait(waitAfterClick); - showLogs && this.logMessage("After Click in waitForSpecficEvent"); + logMessage("After Click in waitForSpecficEvent"); } catch { // ignore the error as the item may not show up - showLogs && this.logMessage("After Click In Catch in waitForSpecficEvent"); - showLogs && console.trace("notify close missed in waitForSpecficEvent") + logMessage("After Click In Catch in waitForSpecficEvent"); + showLogs && console.trace("notify close missed in waitForSpecficEvent"); } } } async waitForFileDeleted(delay = 10000, close = true) { - showLogs && console.time("waitForFileDeleted") + logTime("waitForFileDeleted"); await this.waitForSpecficEvent("File deleted", delay, close); - showLogs && console.timeEnd("waitForFileDeleted") + logTimeEnd("waitForFileDeleted"); } async waitForFoldersToLoad(delay, close) { - showLogs && console.time("waitForFoldersToLoad") + logTime("waitForFoldersToLoad"); await this.waitForSpecficEvent(/[fF]older/, delay, close); - showLogs && console.timeEnd("waitForFoldersToLoad") + logTimeEnd("waitForFoldersToLoad"); } async waitForImport(delay = 10000, close = true) { - showLogs && console.time("waitForImport") + logTime("waitForImport"); await this.waitForSpecficEvent("Import completed in", delay, close); - showLogs && console.timeEnd("waitForImport") + logTimeEnd("waitForImport"); } async waitForIndexing(delay = 10000, close = true) { - showLogs && console.time("waitForIndexing") + logTime("waitForIndexing"); await this.waitForSpecficEvent("Indexing completed in", delay, close); - showLogs && console.timeEnd("waitForIndexing") + logTimeEnd("waitForIndexing"); } async waitForPeopleToLoad(delay, close = true) { - showLogs && console.time("waitForPeopleToLoad") + logTime("waitForPeopleToLoad"); await this.waitForSpecficEvent(/(people|person) (found|loaded)/, delay, close); - showLogs && console.timeEnd("waitForPeopleToLoad") + logTimeEnd("waitForPeopleToLoad"); } async waitForPersonCoverUpdate(delay, close = true) { - showLogs && console.time("waitForPersonCoverUpdate") + logTime("waitForPersonCoverUpdate"); await this.waitForSpecficEvent("Person cover updated", delay, close); - showLogs && console.timeEnd("waitForPersonCoverUpdate") + logTimeEnd("waitForPersonCoverUpdate"); } async waitForPhotosToLoad(delay, close = true){ - showLogs && console.time("waitForPhotosToLoad") + logTime("waitForPhotosToLoad"); await this.waitForSpecficEvent(/(picture|pictures) found/, delay, close); - showLogs && console.timeEnd("waitForPhotosToLoad") + logTimeEnd("waitForPhotosToLoad"); } async waitForAlbumsToLoad(delay, close = true){ - showLogs && console.time("waitForAlbumsToLoad") + logTime("waitForAlbumsToLoad"); await this.waitForSpecficEvent(/(album|albums) found/, delay, close); - showLogs && console.timeEnd("waitForAlbumsToLoad") + logTimeEnd("waitForAlbumsToLoad"); } async waitForSearchToFinish(delay, close = true){ - showLogs && console.time("waitForSearchToFinish") + logTime("waitForSearchToFinish"); await this.waitForSpecficEvent(/(found|contain|empty)/, delay, close); - showLogs && console.timeEnd("waitForSearchToFinish") + logTimeEnd("waitForSearchToFinish"); } async waitForUnstack(delay = 12000, close = true) { - showLogs && console.time("waitForUnstack") + logTime("waitForUnstack"); await this.waitForSpecficEvent("File removed from stack", delay, close); - showLogs && console.timeEnd("waitForUnstack") + logTimeEnd("waitForUnstack"); } async waitForUpload(delay = 15000, close = true) { - showLogs && console.time("waitForUpload") + logTime("waitForUpload"); await this.waitForSpecficEvent("Upload has been processed", delay, close); - showLogs && console.timeEnd("waitForUpload") + logTimeEnd("waitForUpload"); } async waitForUploadFailed(delay = 15000, close = true) { - showLogs && console.time("waitForUploadFailed") + logTime("waitForUploadFailed"); await this.waitForSpecficEvent("Upload failed", delay, close); - showLogs && console.timeEnd("waitForUploadFailed") + logTimeEnd("waitForUploadFailed"); } } \ No newline at end of file diff --git a/frontend/tests/acceptance/page-model/page.js b/frontend/tests/acceptance/page-model/page.js index fa9d9a1ea..a6b0210b5 100644 --- a/frontend/tests/acceptance/page-model/page.js +++ b/frontend/tests/acceptance/page-model/page.js @@ -44,8 +44,8 @@ export default class Page { .click(Selector(".action-confirm")); if (handleTMR) { if (await Selector(".p-notify--error").withText("Too many requests").exists) { - console.log("Rate Limiting recovery in progress, test may be slowed by 1 minute") - let counter = 0 + console.log("Rate Limiting recovery in progress, test may be slowed by 1 minute"); + let counter = 0; while (await Selector(".p-notify--error").withText("Too many requests").exists) { if (counter === 62) { break; @@ -61,13 +61,23 @@ export default class Page { async logout() { await menu.openNav(); - await t.click(Selector("button i.mdi-power")); + await t.hover(Selector("div.nav-user-avatar")); + await t.click(Selector(".nav-user-menu__content .action-logout")); + } + + async openAccount() { + await t.hover(Selector("div.nav-user-avatar")); + await t.click(Selector(".nav-user-menu__content .action-account")); } async clickCardTitleOfUID(uid) { await t.click(Selector('div[data-uid="' + uid + '"] button.action-title-edit')); } + async clickCardImageLabelOfUID(uid) { + await t.click(Selector('div[data-uid="' + uid + '"] button.meta-image')); + } + async testCreateEditDeleteSharingLink(type) { await menu.openPage(type); const FirstAlbum = await album.getNthAlbumUid("all", 0); diff --git a/frontend/tests/acceptance/page-model/photo-edit.js b/frontend/tests/acceptance/page-model/photo-edit.js index 6c18ac10f..ae6fe2fae 100644 --- a/frontend/tests/acceptance/page-model/photo-edit.js +++ b/frontend/tests/acceptance/page-model/photo-edit.js @@ -1,4 +1,5 @@ import { Selector, t } from "testcafe"; +import { clickIfVisible } from "./helpers"; export default class Page { constructor() { @@ -13,14 +14,14 @@ export default class Page { this.labelsTab = Selector("#tab-labels", { timeout: 15000 }); this.peopleTab = Selector("#tab-people", { timeout: 15000 }); - this.locationAction = Selector(".input-coordinates i.action-map", { timeout: 15000 }); - this.locationSearch = Selector("div.p-location-dialog .v-autocomplete", { timeout: 15000 }); - this.locationClear = Selector(".input-coordinates i.action-delete", { timeout: 15000 }); - this.locationUndo = Selector("div.p-location-dialog .input-coordinates i.action-undo", { timeout: 15000 }); - this.locationInput = Selector("div.p-location-dialog .input-coordinates input", { timeout: 15000 }); - this.locationConfirm = Selector("div.p-location-dialog button.action-confirm", { timeout: 15000 }); - this.locationCancel = Selector("div.p-location-dialog button.action-cancel", { timeout: 15000 }); - this.locationMarker = Selector("div.maplibregl-marker", { timeout: 15000 }); + this.locationAction = Selector(".input-coordinates .action-map", { timeout: 15000 }); + this.locationSearch = Selector("div.p-meta-location-dialog .v-autocomplete", { timeout: 15000 }); + this.locationClear = Selector(".input-coordinates .action-delete", { timeout: 15000 }); + this.locationUndo = Selector("div.p-meta-location-dialog .input-coordinates .action-undo", { timeout: 15000 }); + this.locationInput = Selector("div.p-meta-location-dialog .input-coordinates input", { timeout: 15000 }); + this.locationConfirm = Selector("div.p-meta-location-dialog button.action-confirm", { timeout: 15000 }); + this.locationCancel = Selector("div.p-meta-location-dialog button.action-cancel", { timeout: 15000 }); + this.locationMarker = Selector("div.maplibregl-marker", { timeout: 30000 }); this.batchDialog = Selector("div.v-dialog--batch-edit"); this.batchDialogTitle = Selector("div.v-dialog--batch-edit div.v-toolbar-title"); @@ -30,6 +31,7 @@ export default class Page { this.batchDialogToolbarCloseAction = Selector("div.v-dialog--batch-edit header.v-toolbar button.action-close"); this.batchToggleAllCheckbox = Selector("div.v-dialog--batch-edit .toggle-all div.v-selection-control__input"); this.batchToggleSelectCheckbox = Selector("div.v-dialog--batch-edit .toggle-select div.v-selection-control__input"); + this.batchLabels = Selector("div.v-dialog--batch-edit .input-labels", { timeout: 15000 }); this.detailsDone = Selector(".p-form-photo-details-meta button.action-done", { timeout: 15000, @@ -70,8 +72,8 @@ export default class Page { this.license = Selector(".input-license textarea", { timeout: 15000 }); this.description = Selector(".input-caption textarea", { timeout: 15000 }); this.notes = Selector(".input-notes textarea", { timeout: 15000 }); - this.camera = Selector(".input-camera input", { timeout: 15000 }); - this.lens = Selector(".input-lens input", { timeout: 15000 }); + this.camera = Selector(".input-camera input", { timeout: 15000 }).parent('div[class="v-field__input"]'); + this.lens = Selector(".input-lens input", { timeout: 15000 }).parent('div[class="v-field__input"]'); this.cameraValue = Selector(".input-camera .v-select__selection-text", { timeout: 15000 }); this.lensValue = Selector(".input-lens .v-select__selection-text", { timeout: 15000 }); @@ -279,6 +281,7 @@ export default class Page { await t.click(Selector("button.action-approve")); await t.expect(this.coordinates.visible, { timeout: 5000 }).ok(); - await t.click(this.detailsApply).click(Selector("button.action-close")); + await clickIfVisible(t, this.detailsApply); + await t.click(Selector("button.action-discard")); } } diff --git a/frontend/tests/acceptance/page-model/photo.js b/frontend/tests/acceptance/page-model/photo.js index be35fdd39..6d5d3240f 100644 --- a/frontend/tests/acceptance/page-model/photo.js +++ b/frontend/tests/acceptance/page-model/photo.js @@ -19,7 +19,7 @@ export default class Page { } async getPhotoCount(type, delay = 7000) { - await notifies.waitForPhotosToLoad(delay, true) + await notifies.waitForPhotosToLoad(delay, true); if (type === "all") { const PhotoCount = await Selector("div.is-photo", { timeout: 2000 }).count; return PhotoCount; diff --git a/frontend/tests/acceptance/page-model/photoviewer.js b/frontend/tests/acceptance/page-model/photoviewer.js index 942cfdd7c..d458d83ee 100644 --- a/frontend/tests/acceptance/page-model/photoviewer.js +++ b/frontend/tests/acceptance/page-model/photoviewer.js @@ -1,4 +1,10 @@ import { Selector, t } from "testcafe"; +import Toolbar from "./toolbar"; +import Photo from "./photo"; +import DateTimeDialog from "./dialog/date-time"; +import CameraDialog from "./dialog/camera"; +import LocationDialog from "./dialog/location"; +import { clickIfVisible } from "./helpers"; export default class Page { constructor() { @@ -14,6 +20,390 @@ export default class Page { this.playButton = Selector('[class^="pswp__button pswp__button--slideshow-toggle pswp__"]', { timeout: 5000 }); this.favoriteOnIcon = Selector("button.action-favorite i.icon-favorite", { timeout: 5000 }); this.favoriteOffIcon = Selector("button.action-favorite i.icon-favorite-border", { timeout: 5000 }); + this.sidebar = Selector("div.p-lightbox__sidebar div.p-lightbox-sidebar", { timeout: 15000 }); + // People-section toggles render one of two variants depending on role. + // Both carry the shared `.meta-markers-toggle` role class (since edit mode + // also toggles visibility), plus a dedicated discriminator: + // - eye (non-editable, read-only display): `.meta-faces-display` + // - pencil (editable, edit-mode superset of display): `.meta-faces-edit` + // + // `markersVisibilityToggle` matches the eye-only variant; `markersEditToggle` + // matches the pencil-only variant. + this.markersVisibilityToggle = Selector(".meta-faces-display", { timeout: 15000 }); + this.markersEditToggle = Selector(".meta-faces-edit", { timeout: 15000 }); + this.faceMarkerOverlay = Selector("div.p-meta-face-markers", { timeout: 15000 }); + this.faceMarkerRect = Selector("rect.p-meta-face-markers__rect", { timeout: 15000 }); + this.faceMarkerUnnamedRect = Selector( + "rect.p-meta-face-markers__rect:not(.p-meta-face-markers__rect--named):not(.p-meta-face-markers__rect--draft):not(.p-meta-face-markers__rect--removing)", + { timeout: 15000 } + ); + this.faceMarkerDraft = Selector("rect.p-meta-face-markers__rect--draft", { timeout: 15000 }); + this.faceMarkerConfirmButton = Selector("button.p-meta-face-markers__btn--confirm", { timeout: 15000 }); + this.faceMarkerCancelButton = Selector("button.p-meta-face-markers__btn--cancel", { timeout: 15000 }); + this.faceMarkerRemoveConfirm = Selector("div.p-meta-face-markers__remove-confirm", { timeout: 15000 }); + this.faceMarkerRemoveButton = Selector("button.p-meta-face-markers__btn--remove", { timeout: 15000 }); + this.personRow = Selector(".metadata__person-row", { timeout: 15000 }); + this.sidebarTitle = Selector(".p-lightbox-sidebar .meta-title", { timeout: 15000 }); + this.sidebarCaption = Selector(".p-lightbox-sidebar .meta-caption", { timeout: 15000 }); + this.sidebarKeywords = Selector(".p-lightbox-sidebar .meta-keywords", { timeout: 15000 }); + this.sidebarNotes = Selector(".p-lightbox-sidebar .meta-notes", { timeout: 15000 }); + this.sidebarChips = Selector(".p-lightbox-sidebar .meta-chip", { timeout: 15000 }); + this.sidebarLabels = Selector(".p-lightbox-sidebar .v-list-item.meta-labels", { timeout: 15000 }); + this.faceMarkerClearSubjectButton = Selector(".metadata__person-row .meta-marker-clear-subject", { timeout: 15000 }); + this.faceMarkerNameInput = Selector(".metadata__person-row .meta-inline-marker input", { timeout: 15000 }); + this.peopleHeader = Selector(".p-lightbox-sidebar .text-subtitle-2").withText("People"); + this.addNameDialog = Selector(".v-dialog.p-confirm-dialog", { timeout: 15000 }); + this.addNameDialogCancel = Selector(".v-dialog.p-confirm-dialog .action-cancel", { timeout: 15000 }); + this.dateTimeDialog = new DateTimeDialog(); + this.cameraDialog = new CameraDialog(); + this.locationDialog = new LocationDialog(); + } + + // unnamedPersonRows are sidebar person rows whose inline-marker combobox is in unnamed mode. + get unnamedPersonRows() { + return this.personRow.filter((node) => node.querySelector(".meta-inline-marker:not(.meta-inline-marker--named)") !== null); + } + + // namedPersonRows are sidebar person rows whose inline-marker combobox is in named mode. + // Discriminates on `.meta-inline-marker--named` rather than the Unassign icon, which is + // gated on edit mode and would miss named rows when the People section is read-only. + get namedPersonRows() { + return this.personRow.filter((node) => node.querySelector(".meta-inline-marker--named") !== null); + } + + // ensureMarkersEdit toggles the People section into edit mode if it isn't already. + // The pencil button (`.meta-faces-edit`) flips null ↔ FaceMarkerEdit; calling + // startMarkersEdit unconditionally would silently EXIT edit mode for callers + // that are already in it, so probe `.is-active` (the `markersEdit` binding) first. + async ensureMarkersEdit() { + if (!(await this.markersEditToggle.hasClass("is-active"))) { + await this.startMarkersEdit(); + } + } + + // clearMarkerSubject ensures the People section is in edit mode (the Unassign + // button is gated on `markersEdit`), hovers the row to reveal the display:none + // button, then clicks it. + async clearMarkerSubject(row) { + await this.ensureMarkersEdit(); + await t.hover(row).click(row.find(".meta-marker-clear-subject")); + } + + // sidebarRow returns the v-list-item that contains the given MDI prepend-icon class. + sidebarRow(iconClass) { + return Selector("." + iconClass).parent(".p-lightbox-sidebar .v-list-item"); + } + + // editTextFieldByKey opens, types, commits, and verifies a sidebar text field by its + // detailsFields key (`meta-${key}` on the v-list-item). + // commitKey is "enter" for commitOnEnter fields, "tab" for blur-commit fields (Notes, Caption). + async editTextFieldByKey(fieldKey, value, commitKey = "enter") { + const row = Selector(`.p-lightbox-sidebar .v-list-item.meta-${fieldKey}`, { timeout: 15000 }); + await t.click(row); + const input = row.find(".meta-inline-edit").find("input,textarea"); + await t.expect(input.visible).ok(); + await t.typeText(input, value, { replace: true }).pressKey(commitKey); + await t.expect(row.withText(value).exists).ok(); + } + + // typeAndConfirmInlineChip adds a Labels or Albums chip via the always-rendered combobox. + // The short wait lets Vuetify's combobox seat the typed value before Enter commits it. + async typeAndConfirmInlineChip(sectionLabel, value) { + const sectionClass = this._chipSectionClass(sectionLabel); + const input = Selector(`.p-lightbox-sidebar .${sectionClass} .meta-inline-edit input`, { timeout: 15000 }); + await t.click(input).typeText(input, value); + await t.wait(200); + await t.pressKey("enter"); + await t.expect(Selector(".meta-inline-menu").exists).notOk(); + } + + // chipByTitle returns the .meta-chip in the Labels or Albums section matching `title`. + chipByTitle(sectionLabel, title) { + const sectionClass = this._chipSectionClass(sectionLabel); + return Selector(`.p-lightbox-sidebar .${sectionClass}.metadata__chips .meta-chip`, { timeout: 15000 }).withText(title); + } + + // removeInlineChip clicks the × on a Labels or Albums chip matching `title`. + // Soft-removes locally via chipState..removals until confirm or undo. + async removeInlineChip(sectionLabel, title) { + await t.click(this.chipByTitle(sectionLabel, title).find(".meta-chip__remove")); + } + + // undoChipRemovals clicks Undo in the Labels or Albums chip toolbar, + // restoring all soft-removed chips for that section. + async undoChipRemovals(sectionLabel) { + const sectionClass = this._chipSectionClass(sectionLabel); + await t.click(Selector(`.p-lightbox-sidebar .${sectionClass} .meta-chip-undo`, { timeout: 15000 })); + } + + // confirmChipRemovals clicks Save in the Labels or Albums chip toolbar, + // persisting all pending removals. + async confirmChipRemovals(sectionLabel) { + const sectionClass = this._chipSectionClass(sectionLabel); + await t.click(Selector(`.p-lightbox-sidebar .${sectionClass} .meta-chip-confirm`, { timeout: 15000 })); + } + + _chipSectionClass(sectionLabel) { + if (sectionLabel === "Labels") { + return "meta-labels"; + } + if (sectionLabel === "Albums") { + return "meta-albums"; + } + throw new Error(`Unknown chip section: ${sectionLabel}`); + } + + // startInlineEditOrAdd enters edit mode for Title or Caption by clicking the row, or + // falls back to the add-prompt when the field is empty. + async startInlineEditOrAdd(displayClass, promptLabel) { + const display = Selector(".p-lightbox-sidebar ." + displayClass, { timeout: 15000 }); + if (await display.exists) { + await t.click(display.parent(".p-lightbox-sidebar .v-list-item")); + } else { + await t.click(Selector(".p-lightbox-sidebar .meta-add-prompt").withText(promptLabel)); + } + } + + // openSidebarOnFirstPhoto opens the lightbox + info sidebar on the first image in cards view. + // Pass a search query to scope the view first (e.g. "faces:1" for a photo with markers). + async openSidebarOnFirstPhoto(query) { + const toolbar = new Toolbar(); + const photo = new Photo(); + await t.click(toolbar.cardsViewAction); + if (query) { + await toolbar.search(query); + } + const uid = await photo.getNthPhotoUid("image", 0); + await this.openPhotoViewer("uid", uid); + await this.openSidebar(); + return uid; + } + + // openSidebarOnPhoto opens the lightbox + info sidebar on a specific photo by UID. + // Pass a search query when the photo might not be in the current filtered view; + // an empty string navigates to /library/browse to reset any active filter. + async openSidebarOnPhoto(uid, query = "") { + const toolbar = new Toolbar(); + if (query) { + await t.click(toolbar.cardsViewAction); + await toolbar.search(query); + } else { + await t.navigateTo("/library/browse"); + await t.click(toolbar.cardsViewAction); + } + await this.openPhotoViewer("uid", uid); + await this.openSidebar(); + } + + // assertSidebarIsEditable verifies that clicking each editable sidebar row surfaces its + // editor or dialog. Paired with assertSidebarIsReadOnly() so every selector has both a + // positive and a negative assertion. + async assertSidebarIsEditable() { + // Title and Caption render unconditionally in editable mode; click each + // to open its inline editor and escape back out before continuing. + await this.startInlineEditOrAdd("meta-title", "Add a Title"); + await t.expect(Selector(".p-lightbox-sidebar .meta-inline-title").visible).ok(); + await t.pressKey("esc"); + + await this.startInlineEditOrAdd("meta-caption", "Add a Caption"); + await t.expect(Selector(".p-lightbox-sidebar .meta-inline-caption").visible).ok(); + await t.pressKey("esc"); + + await t.click(this.sidebarRow("mdi-calendar")); + await t.expect(this.dateTimeDialog.root.visible).ok(); + await t.click(this.dateTimeDialog.cancel); + + if (await this.sidebarRow("mdi-camera").exists) { + await t.click(this.sidebarRow("mdi-camera")); + await t.expect(this.cameraDialog.root.visible).ok(); + await t.click(this.cameraDialog.cancel); + } + + if (await this.sidebarRow("mdi-map-marker").exists) { + await t.click(this.sidebarRow("mdi-map-marker")); + await t.expect(this.locationDialog.root.visible).ok(); + await t.click(this.locationDialog.cancel); + } + + // People, Albums, and Labels: assert their editable-only controls render. + // The pencil toggle and chip-add inputs only exist when isEditable=true, + // so they discriminate edit mode from read-only mode (which uses the eye + // toggle and renders chips without an add input). + await t.expect(this.peopleHeader.exists).ok(); + await t.expect(this.markersEditToggle.exists).ok(); + await t.expect(this.markersVisibilityToggle.exists).notOk(); + await t.expect(Selector(".p-lightbox-sidebar .v-list-item.meta-albums").exists).ok(); + await t.expect(Selector(".p-lightbox-sidebar .meta-albums .meta-inline-edit").exists).ok(); + await t.expect(Selector(".p-lightbox-sidebar .v-list-item.meta-labels").exists).ok(); + await t.expect(Selector(".p-lightbox-sidebar .meta-labels .meta-inline-edit").exists).ok(); + + // The next iteration's row click cancels the previous edit, so only the trailing + // toolbar click is needed for cleanup. Gate on .visible so rows that v-show hides + // for empty fields are skipped. + for (const key of ["subject", "artist", "copyright", "license", "keywords", "notes"]) { + const row = Selector(`.p-lightbox-sidebar .v-list-item.meta-${key}`); + if (!(await row.visible)) { + continue; + } + await t.click(row); + await t.expect(row.find(".meta-inline-edit").exists).ok(); + } + await t.click(Selector(".p-lightbox-sidebar .v-toolbar-title")); + } + + // assertSidebarIsReadOnly verifies the sidebar surfaces no editors or dialogs. + // restricted=true asserts the visitor subset (Title, Caption, Date, Location). + // expect* flags toggle positive existence checks; defaults assert presence. + async assertSidebarIsReadOnly({ + restricted = false, + expectTitle = true, + expectCaption = true, + expectPeople = true, + expectLabels = true, + expectAlbums = true, + } = {}) { + await t.click(this.sidebarRow("mdi-calendar")); + await t.expect(this.dateTimeDialog.root.visible).notOk(); + + if (await this.sidebarRow("mdi-map-marker").exists) { + await t.click(this.sidebarRow("mdi-map-marker")); + await t.expect(this.locationDialog.root.visible).notOk(); + } + + for (const [key, expected] of [ + ["title", expectTitle], + ["caption", expectCaption], + ]) { + const display = Selector(`.p-lightbox-sidebar .meta-${key}`); + if (expected) { + await t.expect(display.exists).ok(); + const row = display.parent(".v-list-item"); + await t.click(row); + await t.expect(row.find(".meta-inline-edit").exists).notOk(); + } else { + await t.expect(display.exists).notOk(); + } + } + // meta-add-prompt is an editing affordance and must never render here. + await t.expect(Selector(".p-lightbox-sidebar .meta-add-prompt").visible).notOk(); + + if (restricted) { + await t.expect(this.sidebarRow("mdi-camera").exists).notOk(); + await t.expect(this.sidebarRow("mdi-camera-iris").exists).notOk(); + await t.expect(this.peopleHeader.exists).notOk(); + await t.expect(Selector(".p-lightbox-sidebar .metadata__person-row").exists).notOk(); + await t.expect(this.markersVisibilityToggle.exists).notOk(); + await t.expect(this.markersEditToggle.exists).notOk(); + await t.expect(Selector(".p-lightbox-sidebar .meta-albums").exists).notOk(); + await t.expect(Selector(".p-lightbox-sidebar .meta-labels").exists).notOk(); + for (const key of ["subject", "artist", "copyright", "license", "keywords", "notes"]) { + await t.expect(Selector(`.p-lightbox-sidebar .v-list-item.meta-${key}`).exists).notOk(); + } + return; + } + + if (await this.sidebarRow("mdi-camera").exists) { + await t.click(this.sidebarRow("mdi-camera")); + await t.expect(this.cameraDialog.root.visible).notOk(); + } + + // Mirror the editable assertions: section renders, but with read-only + // controls only — eye toggle for People, no chip-add input for Albums/Labels. + if (expectPeople) { + await t.expect(this.peopleHeader.exists).ok(); + await t.expect(this.markersVisibilityToggle.exists).ok(); + await t.expect(this.markersEditToggle.exists).notOk(); + } + if (expectAlbums) { + await t.expect(Selector(".p-lightbox-sidebar .v-list-item.meta-albums").exists).ok(); + await t.expect(Selector(".p-lightbox-sidebar .meta-albums .meta-inline-edit").exists).notOk(); + } + if (expectLabels) { + await t.expect(Selector(".p-lightbox-sidebar .v-list-item.meta-labels").exists).ok(); + await t.expect(Selector(".p-lightbox-sidebar .meta-labels .meta-inline-edit").exists).notOk(); + } + + for (const key of ["subject", "artist", "copyright", "license", "keywords", "notes"]) { + const row = Selector(`.p-lightbox-sidebar .v-list-item.meta-${key}`); + if (!(await row.visible)) { + continue; + } + await t.click(row); + await t.expect(row.find(".meta-inline-edit").exists).notOk(); + } + } + + // openSidebarDialog opens the Date / Camera / Location dialog by clicking its sidebar row. + async openSidebarDialog(which) { + if (which === "takenAt") { + await t.click(this.sidebarRow("mdi-calendar")); + await t.expect(this.dateTimeDialog.root.visible).ok(); + } else if (which === "camera") { + await t.click(this.sidebarRow("mdi-camera")); + await t.expect(this.cameraDialog.root.visible).ok(); + } else if (which === "location") { + await t.click(this.sidebarRow("mdi-map-marker")); + await t.expect(this.locationDialog.root.visible).ok(); + } else { + throw new Error(`Unknown sidebar dialog: ${which}`); + } + } + + async openSidebar() { + if (!(await this.sidebar.exists)) { + await this.triggerPhotoViewerAction("info-button"); + } + await t.expect(this.sidebar.visible).ok(); + } + + async startMarkersEdit() { + await t.click(this.markersEditToggle); + } + + async cancelMarkerDraft() { + await t.click(this.faceMarkerCancelButton); + } + + async confirmMarkerDraft() { + await t.click(this.faceMarkerConfirmButton); + } + + // removeLastUnnamedMarker deletes the most recently drawn unnamed marker via the overlay confirm pill. + // Used by tests that draw a marker for setup and want to undo before exit so the fixture stays clean. + async removeLastUnnamedMarker() { + await t.expect(this.sidebar.visible).ok(); + if (await this.markersEditToggle.find('i.mdi-pencil-outline').exists) { + await this.startMarkersEdit(); + await t.expect(this.faceMarkerOverlay.visible).ok(); + } + await clickIfVisible(t, this.faceMarkerUnnamedRect.nth(-1)); + await t.expect(this.faceMarkerRemoveConfirm.visible).ok(); + await t.click(this.faceMarkerRemoveButton); + } + + async getRenderedMarkerCount() { + return this.faceMarkerRect.count; + } + + async getPersonRowCount() { + return this.personRow.count; + } + + // Draw a small rectangle in the middle of the overlay, sized in + // percent of the overlay's actual box. Avoids viewport-dependent + // coordinates (Mac Chrome vs headless Linux) that can land outside + // the rendered photo and fail the draft. + async drawMarkerInCenter(sizePercent = 0.2) { + const width = await this.faceMarkerOverlay.clientWidth; + const height = await this.faceMarkerOverlay.clientHeight; + const boxW = Math.max(Math.floor(width * sizePercent), 40); + const boxH = Math.max(Math.floor(height * sizePercent), 40); + const fromX = Math.floor(width / 2 - boxW / 2); + const fromY = Math.floor(height / 2 - boxH / 2); + await t.drag(this.faceMarkerOverlay, boxW, boxH, { + offsetX: fromX, + offsetY: fromY, + }); } async openPhotoViewer(mode, uidOrNth) { diff --git a/frontend/tests/acceptance/page-model/settings.js b/frontend/tests/acceptance/page-model/settings.js index b0b1346a4..8095a9cb7 100644 --- a/frontend/tests/acceptance/page-model/settings.js +++ b/frontend/tests/acceptance/page-model/settings.js @@ -25,19 +25,44 @@ export default class Page { this.peopleCheckbox = Selector(".input-people div.v-selection-control__input"); this.deleteCheckbox = Selector(".input-delete div.v-selection-control__input"); this.libraryCheckbox = Selector(".input-library div.v-selection-control__input"); + this.albumsCheckbox = Selector(".input-albums div.v-selection-control__input"); + this.favoritesCheckbox = Selector(".input-favorites div.v-selection-control__input"); + this.foldersCheckbox = Selector(".input-folders div.v-selection-control__input"); + this.videosCheckbox = Selector(".input-videos div.v-selection-control__input"); + this.zoomCheckbox = Selector(".input-zoom div.v-selection-control__input"); + this.openOnHoverCheckbox = Selector(".input-open-on-hover div.v-selection-control__input"); + this.hideScrollbarCheckbox = Selector(".input-hide-scrollbar div.v-selection-control__input"); + this.reduceMotionCheckbox = Selector(".input-reduce-motion div.v-selection-control__input"); this.libraryTab = Selector("#tab-settings_content"); + this.collectionsTab = Selector("#tab-settings_collections"); this.reviewCheckbox = Selector(".input-review div.v-selection-control__input"); this.convertCheckbox = Selector(".input-convert div.v-selection-control__input"); this.estimatesCheckbox = Selector(".input-estimates div.v-selection-control__input"); this.dateTimeStacksCheckbox = Selector(".input-stack-meta div.v-selection-control__input"); this.uuidStacksCheckbox = Selector(".input-stack-uuid div.v-selection-control__input"); this.nameStacksCheckbox = Selector(".input-stack-name div.v-selection-control__input"); - this.downloadRawCheckbox = Selector(".input-download-raw div.v-selection-control__input"); this.hideTitlesCheckbox = Selector(".input-search-titles div.v-selection-control__input"); this.hideCaptionsCheckbox = Selector(".input-search-captions div.v-selection-control__input"); this.hideListViewCheckbox = Selector(".input-search-listview div.v-selection-control__input"); + this.downloadNameSelect = Selector(".input-download-name div.v-input__control"); + this.downloadOriginalsCheckbox = Selector(".input-download-originals div.v-selection-control__input"); + this.downloadRawCheckbox = Selector(".input-download-raw div.v-selection-control__input"); + this.downloadSidecarCheckbox = Selector(".input-download-sidecar div.v-selection-control__input"); + + this.albumDownloadDisabledCheckbox = Selector(".input-album-download-disabled div.v-selection-control__input"); + this.albumDownloadNameSelect = Selector(".input-album-download-name div.v-input__control"); + this.albumDownloadOriginalsCheckbox = Selector(".input-album-download-originals div.v-selection-control__input"); + this.albumDownloadRawCheckbox = Selector(".input-album-download-raw div.v-selection-control__input"); + this.albumDownloadSidecarCheckbox = Selector(".input-album-download-sidecar div.v-selection-control__input"); + + this.albumOrderSelect = Selector(".input-album-order div.v-input__control"); + this.folderOrderSelect = Selector(".input-folder-order div.v-input__control"); + this.momentOrderSelect = Selector(".input-moment-order div.v-input__control"); + this.stateOrderSelect = Selector(".input-state-order div.v-input__control"); + this.monthOrderSelect = Selector(".input-month-order div.v-input__control"); + this.advancedTab = Selector("#tab-settings_advanced"); this.debugCheckbox = Selector("label").withText("Debug Logs"); this.backupCheckbox = Selector("label").withText("Disable Backups"); @@ -47,6 +72,5 @@ export default class Page { this.readOnlyCheckbox = Selector("label").withText("Read-Only Mode"); this.accountTab = Selector("#tab-settings_account"); - this.servicesTab = Selector("#tab-settings_services"); } } diff --git a/frontend/tests/acceptance/page-model/toolbar.js b/frontend/tests/acceptance/page-model/toolbar.js index bd4f53cc4..878a17181 100644 --- a/frontend/tests/acceptance/page-model/toolbar.js +++ b/frontend/tests/acceptance/page-model/toolbar.js @@ -16,6 +16,7 @@ export default class Page { this.cardsViewAction = Selector("button.action-view-cards"); this.mosaicViewAction = Selector("button.action-view-mosaic"); this.listViewAction = Selector("button.action-view-list"); + this.searchClearAction = Selector("div.input-search .v-field__clearable", { timeout: 7000 }); } async checkToolbarActionAvailability(action, visible) { diff --git a/frontend/tests/testcafeconfig.json b/frontend/tests/testcafeconfig.json index 31e539b3a..af8f428af 100644 --- a/frontend/tests/testcafeconfig.json +++ b/frontend/tests/testcafeconfig.json @@ -1,3 +1,4 @@ { - "url": "http://localhost:2343/library/login" + "url": "http://localhost:2343/library/login", + "api": "http://localhost:2343/api/v1/" } diff --git a/frontend/tests/vitest/app/routes-login.test.js b/frontend/tests/vitest/app/routes-login.test.js new file mode 100644 index 000000000..b8582d235 --- /dev/null +++ b/frontend/tests/vitest/app/routes-login.test.js @@ -0,0 +1,431 @@ +import { describe, it, expect, beforeEach, afterEach, vi } from "vitest"; +import "../fixtures"; +import routes, { safeReturnTo } from "app/routes"; +import { $config, $session } from "app/session"; + +// Find the /login route's beforeEnter so it can be invoked directly with +// mocked to/from/next args. Driving navigation through a real router would +// require booting every page component the file imports — too heavy for a +// guard-focused unit test. +const loginRoute = routes.find((r) => r.name === "login"); +const loginGuard = loginRoute.beforeEnter; + +describe("app/routes /login guard", () => { + let restore; + + beforeEach(() => { + window.localStorage.clear(); + window.sessionStorage.clear(); + // Snapshot the singleton session/config fields we mutate so each test + // starts from a clean slate. + const sessionState = { + authToken: $session.authToken, + id: $session.id, + user: $session.user, + auth: $session.auth, + loginRedirect: $session.loginRedirect, + }; + const configValues = $config.values; + restore = () => { + $session.authToken = sessionState.authToken; + $session.id = sessionState.id; + $session.user = sessionState.user; + $session.auth = sessionState.auth; + $session.loginRedirect = sessionState.loginRedirect; + $config.values = configValues; + }; + + // Force an unauthenticated session by default. + $session.authToken = null; + $session.id = null; + $session.user = { hasId: () => false }; + $session.auth = false; + $session.loginRedirect = false; + if ($session.localStorage?.removeItem) { + $session.localStorage.removeItem("login.next"); + $session.localStorage.removeItem("login.logout"); + } + }); + + afterEach(() => { + restore?.(); + vi.restoreAllMocks(); + }); + + // The legacy bug (#5506 follow-up): a direct visit to /library/login was + // auto-bouncing through the IdP, so admins could not sign in with local + // or LDAP/AD credentials when PHOTOPRISM_OIDC_REDIRECT was on. The guard + // must show the form unless an explicit deep-link target was recorded. + it("shows the form on a direct visit when PHOTOPRISM_OIDC_REDIRECT is on but no deep-link target is recorded", () => { + $config.values = { + ...$config.values, + ext: { oidc: { enabled: true, redirect: true, loginUri: "/api/v1/oidc/login" } }, + }; + const followRedirect = vi.spyOn($session, "followRedirect").mockImplementation(() => {}); + const next = vi.fn(); + + loginGuard({}, {}, next); + + expect(followRedirect).not.toHaveBeenCalled(); + expect(next).toHaveBeenCalledWith(); + }); + + it("auto-redirects to the configured OIDC login URI when a deep-link target was recorded", () => { + $config.values = { + ...$config.values, + ext: { oidc: { enabled: true, redirect: true, loginUri: "/api/v1/oidc/login" } }, + }; + $session.setLoginRedirectUrl("/library/albums/at1sqs7gr75pl5r7/view"); + const followRedirect = vi.spyOn($session, "followRedirect").mockImplementation(() => {}); + const next = vi.fn(); + + loginGuard({}, {}, next); + + expect(followRedirect).toHaveBeenCalledWith("/api/v1/oidc/login"); + expect(next).toHaveBeenCalledWith(false); + }); + + it("respects the one-shot logout signal and shows the form even with a deep-link target", () => { + $config.values = { + ...$config.values, + ext: { oidc: { enabled: true, redirect: true, loginUri: "/api/v1/oidc/login" } }, + }; + $session.setLoginRedirectUrl("/library/people"); + $session.localStorage.setItem("login.logout", "1"); + const followRedirect = vi.spyOn($session, "followRedirect").mockImplementation(() => {}); + const next = vi.fn(); + + loginGuard({}, {}, next); + + expect(followRedirect).not.toHaveBeenCalled(); + expect(next).toHaveBeenCalledWith(); + // The signal is consumed by the guard so a subsequent navigation + // (e.g. user retries the deep link) can auto-bounce again. + expect($session.localStorage.getItem("login.logout")).toBeNull(); + }); + + it("does not auto-redirect when PHOTOPRISM_OIDC_REDIRECT is off, even on deep-link arrivals", () => { + $config.values = { + ...$config.values, + ext: { oidc: { enabled: true, redirect: false, loginUri: "/api/v1/oidc/login" } }, + }; + $session.setLoginRedirectUrl("/library/photos"); + const followRedirect = vi.spyOn($session, "followRedirect").mockImplementation(() => {}); + const next = vi.fn(); + + loginGuard({}, {}, next); + + expect(followRedirect).not.toHaveBeenCalled(); + expect(next).toHaveBeenCalledWith(); + }); + + it("does not auto-redirect when OIDC is disabled entirely", () => { + $config.values = { + ...$config.values, + ext: { oidc: { enabled: false, redirect: true, loginUri: "" } }, + }; + $session.setLoginRedirectUrl("/library/folders"); + const followRedirect = vi.spyOn($session, "followRedirect").mockImplementation(() => {}); + const next = vi.fn(); + + loginGuard({}, {}, next); + + expect(followRedirect).not.toHaveBeenCalled(); + expect(next).toHaveBeenCalledWith(); + }); + + // One-shot guard: the first deep-link arrival auto-redirects to OIDC and + // marks the attempt; a second arrival within the same tab (typical of a + // failed/abandoned IdP roundtrip) consumes the flag and shows the form + // instead of looping back to OIDC. + it("auto-redirects only once per tab so a failed OIDC roundtrip falls back to the form", () => { + $config.values = { + ...$config.values, + ext: { oidc: { enabled: true, redirect: true, loginUri: "/api/v1/oidc/login" } }, + }; + $session.setLoginRedirectUrl("/library/people"); + const followRedirect = vi.spyOn($session, "followRedirect").mockImplementation(() => {}); + const firstNext = vi.fn(); + const secondNext = vi.fn(); + + loginGuard({}, {}, firstNext); + expect(followRedirect).toHaveBeenCalledTimes(1); + expect(firstNext).toHaveBeenCalledWith(false); + + // Simulate the user dismissing the IdP and arriving back at /login. The + // deep-link target is still in localStorage; the attempt flag in + // sessionStorage breaks the loop. + loginGuard({}, {}, secondNext); + expect(followRedirect).toHaveBeenCalledTimes(1); + expect(secondNext).toHaveBeenCalledWith(); + }); + + it("re-arms the OIDC auto-redirect after a successful login or explicit logout", () => { + $config.values = { + ...$config.values, + ext: { oidc: { enabled: true, redirect: true, loginUri: "/api/v1/oidc/login" } }, + }; + $session.setLoginRedirectUrl("/library/people"); + const followRedirect = vi.spyOn($session, "followRedirect").mockImplementation(() => {}); + + loginGuard({}, {}, vi.fn()); + expect(followRedirect).toHaveBeenCalledTimes(1); + + // Successful login (or onLogout) clears both the deep-link target and + // the attempt flag via clearLoginRedirectUrl. A fresh deep-link arrival + // should be allowed to auto-redirect again. + $session.clearLoginRedirectUrl(); + $session.setLoginRedirectUrl("/library/albums/new/view"); + + loginGuard({}, {}, vi.fn()); + expect(followRedirect).toHaveBeenCalledTimes(2); + }); + + // Post-OIDC roundtrip: auth.gohtml writes the new session and reloads + // /library/login. The guard must consume the stored deep-link URL and + // hard-navigate back to it instead of falling through to the default + // route (which would lose the user's intended destination). + it("follows the recorded deep-link URL when the user is already authenticated", () => { + $session.user = { hasId: () => true }; + $session.authToken = "999900000000000000000000000000000000000000000000"; + $session.id = "a9b8ff820bf40ab451910f8bbfe401b2432446693aa539538fbd2399560a722f"; + $session.auth = true; + $session.setLoginRedirectUrl("/library/albums/xyz/view"); + const followLogin = vi.spyOn($session, "followLoginRedirectUrl").mockImplementation(() => {}); + const next = vi.fn(); + + loginGuard({}, {}, next); + + expect(followLogin).toHaveBeenCalled(); + expect(next).toHaveBeenCalledWith(false); + }); + + it("falls back to the default route when the user is authenticated and no deep link is recorded", () => { + $session.user = { hasId: () => true }; + $session.authToken = "999900000000000000000000000000000000000000000000"; + $session.id = "a9b8ff820bf40ab451910f8bbfe401b2432446693aa539538fbd2399560a722f"; + $session.auth = true; + const getDefault = vi.spyOn($session, "getDefaultRoute").mockReturnValue("browse"); + const next = vi.fn(); + + loginGuard({}, {}, next); + + expect(getDefault).toHaveBeenCalled(); + expect(next).toHaveBeenCalledWith({ name: "browse" }); + }); + + // Defense in depth: if the recorded deep link keeps bouncing the authenticated + // user straight back to /login (e.g. the OIDC OP can't authenticate the + // navigation), the guard must drop the target and fall through to the default + // route instead of looping forever. + it("breaks the redirect loop when the recorded deep link keeps bouncing back", () => { + $session.user = { hasId: () => true }; + $session.authToken = "999900000000000000000000000000000000000000000000"; + $session.id = "a9b8ff820bf40ab451910f8bbfe401b2432446693aa539538fbd2399560a722f"; + $session.auth = true; + $session.setLoginRedirectUrl("/api/v1/oauth/authorize?client_id=abc&state=x"); + $session.markLoginRedirectAttempt(); // simulate having just followed it + const followLogin = vi.spyOn($session, "followLoginRedirectUrl").mockImplementation(() => {}); + const getDefault = vi.spyOn($session, "getDefaultRoute").mockReturnValue("browse"); + const next = vi.fn(); + + loginGuard({}, {}, next); + + expect(followLogin).not.toHaveBeenCalled(); + expect(getDefault).toHaveBeenCalled(); + expect(next).toHaveBeenCalledWith({ name: "browse" }); + expect($session.hasLoginRedirectUrl()).toBe(false); + }); + + // The Portal OIDC OP redirects unauthenticated users to + // /portal/login?return_to= via a top-level browser + // navigation, so the global router guard never gets to record the deep + // link via setLoginRedirectUrl(). The login route reads the inbound + // `return_to` query parameter directly to bridge the hand-off. + it("records a safe return_to query param as the post-login deep link", () => { + const next = vi.fn(); + + loginGuard({ query: { return_to: "/api/v1/oauth/authorize?client_id=abc&state=x" } }, {}, next); + + expect($session.hasLoginRedirectUrl()).toBe(true); + expect($session.getLoginRedirectUrl()).toBe("/api/v1/oauth/authorize?client_id=abc&state=x"); + expect(next).toHaveBeenCalledWith(); + }); + + it("ignores an unsafe return_to that escapes the current origin", () => { + const next = vi.fn(); + + loginGuard({ query: { return_to: "https://attacker.example/steal" } }, {}, next); + + expect($session.hasLoginRedirectUrl()).toBe(false); + expect(next).toHaveBeenCalledWith(); + }); +}); + +describe("app/routes /logout guard", () => { + const logoutGuard = routes.find((r) => r.name === "logout").beforeEnter; + let restore; + + beforeEach(() => { + const configValues = $config.values; + const provider = $session.provider; + restore = () => { + $config.values = configValues; + $session.provider = provider; + }; + }); + + afterEach(() => { + restore?.(); + vi.restoreAllMocks(); + }); + + // A cluster-OIDC user who hits /logout directly is bounced to the Portal login + // page so they re-auth with their cluster account and pick an instance there. + // The redirect must wait for the cluster-wide sign-out (which clears the Portal OP + // cookie) so the Portal shows its login form instead of silently re-issuing a session. + it("bounces a cluster-OIDC sign-out to the Portal login after clearing the OP cookie", async () => { + $config.values = { + ...$config.values, + ext: { + oidc: { + enabled: true, + redirect: true, + cluster: true, + loginUri: "/api/v1/oidc/login", + portalLoginUri: "https://app.example.com/portal/login", + }, + }, + }; + $session.provider = "oidc"; + // logoutEverywhere resolves to the landing URL (here the Portal login, since RP-logout + // is off so no provider logout URL is returned). + const logoutEverywhere = vi.spyOn($session, "logoutEverywhere").mockResolvedValue("https://app.example.com/portal/login"); + const followRedirect = vi.spyOn($session, "followRedirect").mockImplementation(() => {}); + const next = vi.fn(); + + logoutGuard({}, {}, next); + + // The SPA navigation is cancelled immediately, but the redirect is deferred + // until the cluster-wide sign-out resolves. + expect(next).toHaveBeenCalledWith(false); + expect(logoutEverywhere).toHaveBeenCalledWith(true); + expect(followRedirect).not.toHaveBeenCalled(); + + await new Promise((resolve) => setTimeout(resolve, 0)); + expect(followRedirect).toHaveBeenCalledWith("https://app.example.com/portal/login"); + }); + + // With RP-initiated logout enabled, logoutEverywhere resolves to the provider logout URL + // (the Portal end-session endpoint); the guard must follow it so the upstream session ends. + it("follows the provider logout URL on a cluster-OIDC sign-out with RP-initiated logout", async () => { + $config.values = { + ...$config.values, + ext: { oidc: { enabled: true, redirect: true, cluster: true, logout: true, loginUri: "/api/v1/oidc/login", portalLoginUri: "https://app.example.com/portal/login" } }, + }; + $session.provider = "oidc"; + const providerLogoutUri = "https://app.example.com/api/v1/oauth/logout?id_token_hint=abc"; + const logoutEverywhere = vi.spyOn($session, "logoutEverywhere").mockResolvedValue(providerLogoutUri); + const followRedirect = vi.spyOn($session, "followRedirect").mockImplementation(() => {}); + const next = vi.fn(); + + logoutGuard({}, {}, next); + + expect(next).toHaveBeenCalledWith(false); + expect(logoutEverywhere).toHaveBeenCalledWith(true); + + await new Promise((resolve) => setTimeout(resolve, 0)); + expect(followRedirect).toHaveBeenCalledWith(providerLogoutUri); + }); + + // A node that has not (re-)registered against a current Portal has no Portal + // login URL yet — the cluster-wide sign-out and OP-cookie clearing must still + // run, with the local login form as the fallback landing. + it("still signs out cluster-wide when the Portal login URL is unknown", async () => { + $config.values = { + ...$config.values, + ext: { oidc: { enabled: true, redirect: true, cluster: true, loginUri: "/api/v1/oidc/login" } }, + }; + $session.provider = "oidc"; + const logoutEverywhere = vi.spyOn($session, "logoutEverywhere").mockResolvedValue($config.loginUri); + const followRedirect = vi.spyOn($session, "followRedirect").mockImplementation(() => {}); + const next = vi.fn(); + + logoutGuard({}, {}, next); + + expect(next).toHaveBeenCalledWith(false); + expect(logoutEverywhere).toHaveBeenCalledWith(true); + + await new Promise((resolve) => setTimeout(resolve, 0)); + expect(followRedirect).toHaveBeenCalledWith($config.loginUri); + }); + + // A non-cluster OIDC node reached via direct /logout entry must still chain RP-initiated + // logout: the guard runs the cluster-wide sign-out (peer fan-out is a no-op when there are + // no peers) and follows the provider logout URL it resolves, matching the nav-menu Sign-Out. + it("follows the provider logout URL on a standalone OIDC sign-out with RP-initiated logout", async () => { + $config.values = { + ...$config.values, + ext: { oidc: { enabled: true, redirect: false, cluster: false, logout: true, loginUri: "/api/v1/oidc/login" } }, + }; + $session.provider = "oidc"; + const providerLogoutUri = "https://keycloak.example.com/realms/master/protocol/openid-connect/logout?id_token_hint=abc"; + const logoutEverywhere = vi.spyOn($session, "logoutEverywhere").mockResolvedValue(providerLogoutUri); + const followRedirect = vi.spyOn($session, "followRedirect").mockImplementation(() => {}); + const next = vi.fn(); + + logoutGuard({}, {}, next); + + expect(next).toHaveBeenCalledWith(false); + expect(logoutEverywhere).toHaveBeenCalledWith(true); + + await new Promise((resolve) => setTimeout(resolve, 0)); + expect(followRedirect).toHaveBeenCalledWith(providerLogoutUri); + }); + + it("sends a local sign-out to the login route", () => { + $config.values = { + ...$config.values, + ext: { oidc: { enabled: false, redirect: false, cluster: false, loginUri: "" } }, + }; + $session.provider = "local"; + vi.spyOn($session, "signOut").mockReturnValue($session); + const followRedirect = vi.spyOn($session, "followRedirect").mockImplementation(() => {}); + const next = vi.fn(); + + logoutGuard({}, {}, next); + + expect(followRedirect).not.toHaveBeenCalled(); + expect(next).toHaveBeenCalledWith({ name: "login" }); + }); +}); + +describe("app/routes safeReturnTo", () => { + it("accepts root-relative paths", () => { + expect(safeReturnTo("/library/photos")).toBe("/library/photos"); + expect(safeReturnTo("/api/v1/oauth/authorize?client_id=x&state=y")).toBe("/api/v1/oauth/authorize?client_id=x&state=y"); + }); + it("accepts absolute URLs on the same origin and returns the path+query+hash", () => { + const here = window.location?.origin; + if (!here) { + return; + } + expect(safeReturnTo(here + "/portal/cluster")).toBe("/portal/cluster"); + expect(safeReturnTo(here + "/api/v1/oauth/authorize?client_id=x#frag")).toBe("/api/v1/oauth/authorize?client_id=x#frag"); + }); + it("rejects cross-origin absolutes", () => { + expect(safeReturnTo("https://attacker.example/steal")).toBe(""); + expect(safeReturnTo("http://attacker.example/steal")).toBe(""); + }); + it("rejects protocol-relative and backslash-prefixed values that some browsers misparse", () => { + expect(safeReturnTo("//attacker.example/")).toBe(""); + expect(safeReturnTo("\\\\attacker.example\\path")).toBe(""); + }); + it("rejects empty, whitespace, or non-string inputs", () => { + expect(safeReturnTo("")).toBe(""); + expect(safeReturnTo(" ")).toBe(""); + expect(safeReturnTo(undefined)).toBe(""); + expect(safeReturnTo(null)).toBe(""); + expect(safeReturnTo(42)).toBe(""); + }); +}); diff --git a/frontend/tests/vitest/common/albums.test.js b/frontend/tests/vitest/common/albums.test.js index 04e718313..dae84e577 100644 --- a/frontend/tests/vitest/common/albums.test.js +++ b/frontend/tests/vitest/common/albums.test.js @@ -1,14 +1,14 @@ -import { describe, it, expect } from 'vitest'; -import { processAlbumSelection } from '../../../src/common/albums.js'; +import { describe, it, expect } from "vitest"; +import { processAlbumSelection } from "../../../src/common/albums.js"; function album(title, uid) { return { Title: title, UID: uid }; } -describe('processAlbumSelection', () => { - it('trims whitespace and matches existing albums (case-insensitive)', () => { - const available = [album('Summer', '1')]; - const selected = [' summer ']; +describe("processAlbumSelection", () => { + it("trims whitespace and matches existing albums (case-insensitive)", () => { + const available = [album("Summer", "1")]; + const selected = [" summer "]; const { processed, changed } = processAlbumSelection(selected, available); @@ -17,9 +17,9 @@ describe('processAlbumSelection', () => { expect(changed).toBe(true); }); - it('deduplicates identical UIDs and strings resolving to same album', () => { - const a1 = album('Trips', 't1'); - const selected = [a1, a1, 'trips', 'TRIPS']; + it("deduplicates identical UIDs and strings resolving to same album", () => { + const a1 = album("Trips", "t1"); + const selected = [a1, a1, "trips", "TRIPS"]; const { processed, changed } = processAlbumSelection(selected, [a1]); @@ -28,28 +28,28 @@ describe('processAlbumSelection', () => { expect(changed).toBe(true); }); - it('keeps unmatched names as trimmed strings (for creation later)', () => { - const selected = [' New Album ']; + it("keeps unmatched names as trimmed strings (for creation later)", () => { + const selected = [" New Album "]; const { processed, changed } = processAlbumSelection(selected, []); - expect(processed).toEqual(['New Album']); + expect(processed).toEqual(["New Album"]); // No structural change: only trimming does not count as change if lengths are equal and no replacements/drops expect(changed).toBe(false); }); - it('drops empty / whitespace-only entries and reports change', () => { - const selected = [' ', '\n', '\t', ' Name ']; + it("drops empty / whitespace-only entries and reports change", () => { + const selected = [" ", "\n", "\t", " Name "]; const { processed, changed } = processAlbumSelection(selected, []); - expect(processed).toEqual(['Name']); + expect(processed).toEqual(["Name"]); expect(changed).toBe(true); }); - it('reconciles selection with new available items (race condition)', () => { - const selected = [' Road Trip ']; - const availableThen = [album('Road Trip', 'rt01')]; + it("reconciles selection with new available items (race condition)", () => { + const selected = [" Road Trip "]; + const availableThen = [album("Road Trip", "rt01")]; const { processed, changed } = processAlbumSelection(selected, availableThen); @@ -58,8 +58,8 @@ describe('processAlbumSelection', () => { expect(changed).toBe(true); }); - it('preserves existing album objects and prevents duplicates', () => { - const a = album('Family', 'fam1'); + it("preserves existing album objects and prevents duplicates", () => { + const a = album("Family", "fam1"); const selected = [a, { ...a }]; // two distinct objects with same UID const { processed, changed } = processAlbumSelection(selected, [a]); diff --git a/frontend/tests/vitest/common/captions.test.js b/frontend/tests/vitest/common/captions.test.js new file mode 100644 index 000000000..de34aa02f --- /dev/null +++ b/frontend/tests/vitest/common/captions.test.js @@ -0,0 +1,213 @@ +import { describe, expect, it } from "vitest"; +import Captions from "common/captions"; + +function newCaptions(options = {}) { + return new Captions( + { + on() {}, + }, + options + ); +} + +// captionsWithPswp returns an instance whose pswp stub records dispatched +// events, mirroring what onCalcSlideSize would do at runtime. +function captionsWithPswp(options = {}) { + const dispatched = []; + const inst = newCaptions(options); + inst.pswp = { + dispatch: (name, payload) => { + dispatched.push({ name, payload }); + }, + }; + return { inst, dispatched }; +} + +describe("common/captions", () => { + it("sanitizes hidden caption html before returning it", () => { + const container = document.createElement("div"); + const caption = document.createElement("div"); + caption.className = "pswp-caption-content"; + caption.innerHTML = `

Hello

link`; + container.appendChild(caption); + + const html = newCaptions().getCaptionHTML({ + data: { element: container }, + }); + + expect(html).toBe(`

Hello

link`); + }); + + it("html-encodes caption text read from image alt attributes", () => { + const container = document.createElement("div"); + const img = document.createElement("img"); + img.setAttribute("alt", `Caption`); + container.appendChild(img); + + const html = newCaptions().getCaptionHTML({ + data: { element: container }, + }); + + expect(html).toBe(`<img src=x onerror="alert(1)">Caption`); + }); + + describe("refreshCaption", () => { + it("creates the caption element lazily when content first appears", () => { + let html = ""; + const { inst } = captionsWithPswp({ captionContent: () => html }); + const holder = document.createElement("div"); + const slide = { + dynamicCaption: { element: undefined, type: false, hidden: false }, + holderElement: holder, + }; + + inst.refreshCaption(slide); + expect(slide.dynamicCaption.element).toBeUndefined(); + expect(holder.children.length).toBe(0); + + html = "

Title

"; + inst.refreshCaption(slide); + expect(slide.dynamicCaption.element).toBeDefined(); + expect(holder.children.length).toBe(1); + expect(slide.dynamicCaption.element.innerHTML).toBe("

Title

"); + }); + + it("updates the existing element when the caption HTML changes", () => { + let html = "

Old Title

"; + const { inst, dispatched } = captionsWithPswp({ captionContent: () => html }); + const holder = document.createElement("div"); + const slide = { + dynamicCaption: { element: undefined, type: false, hidden: false }, + holderElement: holder, + }; + + inst.refreshCaption(slide); + const element = slide.dynamicCaption.element; + expect(element.innerHTML).toBe("

Old Title

"); + + html = "

New Title

New caption text.

"; + inst.refreshCaption(slide); + + expect(slide.dynamicCaption.element).toBe(element); // same element instance + expect(element.innerHTML).toBe("

New Title

New caption text.

"); + + const updates = dispatched.filter((e) => e.name === "dynamicCaptionUpdateHTML"); + expect(updates.length).toBe(2); + expect(updates[1].payload.slide).toBe(slide); + }); + + it("no-ops when the caption HTML has not changed", () => { + const { inst, dispatched } = captionsWithPswp({ captionContent: () => "

Same

" }); + const holder = document.createElement("div"); + const slide = { + dynamicCaption: { element: undefined, type: false, hidden: false }, + holderElement: holder, + }; + + inst.refreshCaption(slide); + inst.refreshCaption(slide); + + const updates = dispatched.filter((e) => e.name === "dynamicCaptionUpdateHTML"); + expect(updates.length).toBe(1); + }); + + it("refreshCurrentCaption targets pswp.currSlide", () => { + const { inst } = captionsWithPswp({ captionContent: (s) => s.captionHtml }); + const holder = document.createElement("div"); + const slide = { + dynamicCaption: { element: undefined, type: false, hidden: false }, + holderElement: holder, + captionHtml: "

One

", + }; + inst.pswp.currSlide = slide; + inst.refreshCurrentCaption(); + expect(slide.dynamicCaption.element.innerHTML).toBe("

One

"); + + slide.captionHtml = "

Two

"; + inst.refreshCurrentCaption(); + expect(slide.dynamicCaption.element.innerHTML).toBe("

Two

"); + }); + + it("does nothing without a dynamicCaption container", () => { + const { inst } = captionsWithPswp({ captionContent: () => "

X

" }); + expect(() => inst.refreshCaption(null)).not.toThrow(); + expect(() => inst.refreshCaption({ holderElement: document.createElement("div") })).not.toThrow(); + }); + + it("dispatches the dynamicCaptionUpdateHTML event after the element is appended", () => { + const { inst, dispatched } = captionsWithPswp({ captionContent: () => "

Hi

" }); + const holder = document.createElement("div"); + const slide = { + dynamicCaption: { element: undefined, type: false, hidden: false }, + holderElement: holder, + }; + + inst.refreshCaption(slide); + const updates = dispatched.filter((e) => e.name === "dynamicCaptionUpdateHTML"); + expect(updates.length).toBe(1); + expect(holder.contains(updates[0].payload.captionElement)).toBe(true); + }); + }); + + describe("formatCaption", () => { + it("renders a Title-only model as a single

", () => { + const html = newCaptions().formatCaption({ Title: "Sunset" }); + expect(html).toBe("

Sunset

"); + }); + + it("promotes a single-line caption to

when there is no title", () => { + const html = newCaptions().formatCaption({ Caption: "Just a single line." }); + expect(html).toBe("

Just a single line.

"); + }); + + it("uses

for multi-line caption text", () => { + const html = newCaptions().formatCaption({ Caption: "Line one\nLine two" }); + expect(html).toBe("

Line one\nLine two

"); + }); + + it("renders Title plus Caption as

+

", () => { + const html = newCaptions().formatCaption({ Title: "Hello", Caption: "World." }); + expect(html).toBe("

Hello

World.

"); + }); + + it("falls back to Description when Caption is empty without mutating the model", () => { + const model = { Title: "", Caption: "", Description: "Fallback text" }; + const html = newCaptions().formatCaption(model); + expect(html).toBe("

Fallback text

"); + expect(model.Caption).toBe(""); + }); + + it("encodes HTML in title and caption to prevent XSS", () => { + const html = newCaptions().formatCaption({ + Title: `Title `, + Caption: `Visit https://example.com/`, + }); + expect(html).toContain('

Title <img src=x onerror="alert(1)">

'); + expect(html).not.toContain(" { + const inst = newCaptions(); + expect(inst.formatCaption(null)).toBe(""); + expect(inst.formatCaption({})).toBe(""); + expect(inst.formatCaption({ Title: "", Caption: " ", Description: " " })).toBe(""); + }); + }); + + describe("getCaptionHTML with getModel option", () => { + it("delegates to formatCaption when getModel returns a model", () => { + const inst = newCaptions({ getModel: () => ({ Title: "From model" }) }); + const html = inst.getCaptionHTML({}); + expect(html).toBe("

From model

"); + }); + + it("falls back to captionContent when getModel returns null", () => { + const inst = newCaptions({ + getModel: () => null, + captionContent: () => "

Fallback

", + }); + const html = inst.getCaptionHTML({}); + expect(html).toBe("

Fallback

"); + }); + }); +}); diff --git a/frontend/tests/vitest/common/config.test.js b/frontend/tests/vitest/common/config.test.js index 247e29bde..f4200240b 100644 --- a/frontend/tests/vitest/common/config.test.js +++ b/frontend/tests/vitest/common/config.test.js @@ -1,4 +1,4 @@ -import { describe, it, expect, beforeEach, afterEach } from "vitest"; +import { describe, it, expect, beforeEach, afterEach, vi } from "vitest"; import "../fixtures"; import Config from "common/config"; import StorageShim from "node-storage-shim"; @@ -93,12 +93,12 @@ describe("common/config", () => { const values = { siteTitle: "Foo", baseUri: "/portal", - frontendUri: "/portal/admin/", + frontendUri: "/portal/", }; const config = new Config(storage, values); - expect(config.frontendUri).toBe("/portal/admin"); - expect(config.loginUri).toBe("/portal/admin/login"); + expect(config.frontendUri).toBe("/portal"); + expect(config.loginUri).toBe("/portal/login"); }); it("uses base uri fallback when frontend uri is missing", () => { @@ -113,6 +113,87 @@ describe("common/config", () => { expect(config.loginUri).toBe("/portal/library/login"); }); + it("themeAssetUri resolves a bare basename into the theme dir", () => { + const config = new Config(new StorageShim(), { siteTitle: "Foo", baseUri: "/i/pro-1" }); + expect(config.themeAssetUri("logo.svg")).toBe("/i/pro-1/_theme/logo.svg"); + expect(config.themeAssetUri("icons/logo.svg")).toBe("/i/pro-1/_theme/icons/logo.svg"); + }); + + it("themeAssetUri resolves a bare basename without a base uri", () => { + const config = new Config(new StorageShim(), { siteTitle: "Foo" }); + expect(config.themeAssetUri("logo.svg")).toBe("/_theme/logo.svg"); + }); + + it("themeAssetUri still prefixes a root-relative theme path with the base uri", () => { + const config = new Config(new StorageShim(), { siteTitle: "Foo", baseUri: "/i/pro-1" }); + expect(config.themeAssetUri("/_theme/logo.svg")).toBe("/i/pro-1/_theme/logo.svg"); + }); + + it("themeAssetUri returns the path unchanged without a base uri", () => { + const config = new Config(new StorageShim(), { siteTitle: "Foo" }); + expect(config.themeAssetUri("/_theme/logo.svg")).toBe("/_theme/logo.svg"); + }); + + it("themeAssetUri leaves absolute, protocol-relative, data, already-prefixed, and empty paths alone", () => { + const config = new Config(new StorageShim(), { siteTitle: "Foo", baseUri: "/i/pro-1" }); + expect(config.themeAssetUri("https://cdn.example.com/logo.svg")).toBe("https://cdn.example.com/logo.svg"); + expect(config.themeAssetUri("//cdn.example.com/logo.svg")).toBe("//cdn.example.com/logo.svg"); + expect(config.themeAssetUri("data:image/svg+xml;base64,AAAA")).toBe("data:image/svg+xml;base64,AAAA"); + expect(config.themeAssetUri("/i/pro-1/_theme/logo.svg")).toBe("/i/pro-1/_theme/logo.svg"); + expect(config.themeAssetUri("")).toBe(""); + }); + + it("getIcon resolves a theme-provided basename icon against the base uri", () => { + const config = new Config(new StorageShim(), { + siteTitle: "Foo", + baseUri: "/i/pro-1", + settings: { ui: { theme: "branded" } }, + }); + themes.Set("branded", { name: "branded", title: "Branded", colors: {}, variables: { icon: "logo.svg" } }); + config.setTheme("branded"); + expect(config.getIcon()).toBe("/i/pro-1/_theme/logo.svg"); + }); + + it("getIcon still resolves a legacy /_theme path-style icon", () => { + const config = new Config(new StorageShim(), { + siteTitle: "Foo", + baseUri: "/i/pro-1", + settings: { ui: { theme: "legacy" } }, + }); + themes.Set("legacy", { name: "legacy", title: "Legacy", colors: {}, variables: { icon: "/_theme/logo.svg" } }); + config.setTheme("legacy"); + expect(config.getIcon()).toBe("/i/pro-1/_theme/logo.svg"); + }); + + it("getIcon resolves a built-in appIcon name against the static uri", () => { + const config = new Config(new StorageShim(), { siteTitle: "Foo", baseUri: "/i/pro-1", appIcon: "bloom" }); + expect(config.getIcon()).toBe("/i/pro-1/static/icons/bloom.svg"); + }); + + it("getIcon resolves each selectable app-icon variant to its static svg", () => { + ["crisp", "mint", "bold", "bloom", "flower", "ring", "shutter"].forEach((name) => { + const config = new Config(new StorageShim(), { siteTitle: "Foo", appIcon: name }); + expect(config.getIcon()).toBe(`/static/icons/${name}.svg`); + }); + }); + + it("getIcon falls back to the logo for an unknown or empty app-icon name", () => { + expect(new Config(new StorageShim(), { siteTitle: "Foo", appIcon: "does-not-exist" }).getIcon()).toBe("/static/icons/logo.svg"); + expect(new Config(new StorageShim(), { siteTitle: "Foo" }).getIcon()).toBe("/static/icons/logo.svg"); + }); + + it("getIcon prefers a theme-provided icon over the appIcon setting", () => { + const config = new Config(new StorageShim(), { + siteTitle: "Foo", + baseUri: "/i/pro-1", + appIcon: "bloom", + settings: { ui: { theme: "branded-icon" } }, + }); + themes.Set("branded-icon", { name: "branded-icon", title: "Branded", colors: {}, variables: { icon: "logo.svg" } }); + config.setTheme("branded-icon"); + expect(config.getIcon()).toBe("/i/pro-1/_theme/logo.svg"); + }); + it("should store values", () => { const storage = new StorageShim(); const values = { siteTitle: "Foo", country: "Germany", city: "Hamburg" }; @@ -190,6 +271,17 @@ describe("common/config", () => { expect(defaultConfig.feature("download")).toBe(true); }); + it("featAppPasswords mirrors the appPasswords feature flag", () => { + const cfg = createTestConfig(); + const settings = JSON.parse(JSON.stringify(cfg.getSettings())); + settings.features = { ...settings.features, appPasswords: true }; + cfg.set("settings", settings); + expect(cfg.featAppPasswords()).toBe(true); + settings.features = { ...settings.features, appPasswords: false }; + cfg.set("settings", settings); + expect(cfg.featAppPasswords()).toBe(false); + }); + it("returns albums when library access is restricted", () => { const cfg = createTestConfig(); const settings = JSON.parse(JSON.stringify(cfg.getSettings())); @@ -270,50 +362,6 @@ describe("common/config", () => { expect(cfg.getDefaultRoute()).toBe("browse"); }); - it("should test get name", () => { - const result = defaultConfig.getPerson("a"); - expect(result).toBeNull(); - - const result2 = defaultConfig.getPerson("Andrea Sander"); - expect(result2.UID).toBe("jr0jgyx2viicdnf7"); - - const result3 = defaultConfig.getPerson("Otto Sander"); - expect(result3.UID).toBe("jr0jgyx2viicdn88"); - }); - - it("should create, update and delete people", () => { - const storage = new StorageShim(); - const values = { Debug: true, siteTitle: "Foo", country: "Germany", city: "Hamburg" }; - - const cfg = new Config(storage, values); - cfg.onPeople("people.created", { entities: {} }); - expect(cfg.values.people).toEqual([]); - cfg.onPeople("people.created", { - entities: [ - { - UID: "abc123", - Name: "Test Name", - Keywords: ["Test", "Name"], - }, - ], - }); - expect(cfg.values.people[0].Name).toBe("Test Name"); - cfg.onPeople("people.updated", { - entities: [ - { - UID: "abc123", - Name: "New Name", - Keywords: ["New", "Name"], - }, - ], - }); - expect(cfg.values.people[0].Name).toBe("New Name"); - cfg.onPeople("people.deleted", { - entities: ["abc123"], - }); - expect(cfg.values.people).toEqual([]); - }); - it("should return language locale", () => { const cfg = new Config(new StorageShim(), Object.assign({}, window.__CONFIG__)); expect(cfg.getLanguageLocale()).toBe("en"); @@ -480,4 +528,132 @@ describe("common/config", () => { expect(document.dir).toBe("ltr"); expect(cfg.dir()).toBe("ltr"); }); + + // A10 contract: isPublic / isDemo / isPortal must return a Boolean for every + // input shape so that bindings like `:disabled="isDemo"` never pass undefined + // to a Vuetify Boolean prop. See #4966. + describe("isPublic / isDemo / isPortal Boolean contract", () => { + const make = (overrides) => new Config(new StorageShim(), { ...window.__CONFIG__, ...overrides }); + + it("return Boolean false when the underlying flag is missing", () => { + const cfg = make({ public: undefined, demo: undefined, portal: undefined }); + for (const fn of ["isPublic", "isDemo", "isPortal"]) { + const result = cfg[fn](); + expect(typeof result, fn).toBe("boolean"); + expect(result, fn).toBe(false); + } + }); + it("return Boolean true when the underlying flag is true", () => { + const cfg = make({ public: true, demo: true, portal: true }); + for (const fn of ["isPublic", "isDemo", "isPortal"]) { + const result = cfg[fn](); + expect(typeof result, fn).toBe("boolean"); + expect(result, fn).toBe(true); + } + }); + it("return Boolean false when `values` itself is missing", () => { + const cfg = new Config(new StorageShim(), null); + for (const fn of ["isPublic", "isDemo", "isPortal"]) { + const result = cfg[fn](); + expect(typeof result, fn).toBe("boolean"); + expect(result, fn).toBe(false); + } + }); + }); + + describe("cluster OIDC accessors", () => { + const make = (oidc) => new Config(new StorageShim(), { ...window.__CONFIG__, ext: { oidc } }); + + it("isClusterOidc reflects the ext.oidc.cluster flag as a Boolean", () => { + expect(make({ cluster: true }).isClusterOidc()).toBe(true); + expect(make({ cluster: false }).isClusterOidc()).toBe(false); + expect(make(undefined).isClusterOidc()).toBe(false); + expect(new Config(new StorageShim(), null).isClusterOidc()).toBe(false); + }); + + it("oidcLoginUri returns the ext.oidc.loginUri or an empty string", () => { + expect(make({ loginUri: "/library/api/v1/oidc/login" }).oidcLoginUri()).toBe("/library/api/v1/oidc/login"); + expect(make({}).oidcLoginUri()).toBe(""); + expect(new Config(new StorageShim(), null).oidcLoginUri()).toBe(""); + }); + + it("portalLoginUri returns the ext.oidc.portalLoginUri or an empty string", () => { + expect(make({ portalLoginUri: "https://app.example.com/portal/login" }).portalLoginUri()).toBe("https://app.example.com/portal/login"); + expect(make({}).portalLoginUri()).toBe(""); + expect(new Config(new StorageShim(), null).portalLoginUri()).toBe(""); + }); + + it("oidcLogout reflects the ext.oidc.logout flag as a Boolean", () => { + expect(make({ logout: true }).oidcLogout()).toBe(true); + expect(make({ logout: false }).oidcLogout()).toBe(false); + expect(make(undefined).oidcLogout()).toBe(false); + expect(new Config(new StorageShim(), null).oidcLogout()).toBe(false); + }); + }); + + describe("storage availability", () => { + const make = (usage) => new Config(new StorageShim(), { ...window.__CONFIG__, usage }); + + it("filesQuotaReached returns true only when the files quota is reached or exceeded", () => { + expect(make({ filesUsedPct: 99 }).filesQuotaReached()).toBe(false); + expect(make({ filesUsedPct: 100 }).filesQuotaReached()).toBe(true); + expect(make({ filesUsedPct: 101 }).filesQuotaReached()).toBe(true); + }); + it("storageLow mirrors the usage.storageLow flag as a Boolean", () => { + expect(make({ storageLow: true }).storageLow()).toBe(true); + expect(make({ storageLow: false }).storageLow()).toBe(false); + expect(make({}).storageLow()).toBe(false); + }); + it("insufficientStorage is true when either the quota is reached or storage is low", () => { + expect(make({ filesUsedPct: 50, storageLow: false }).insufficientStorage()).toBe(false); + expect(make({ filesUsedPct: 100, storageLow: false }).insufficientStorage()).toBe(true); + expect(make({ filesUsedPct: 50, storageLow: true }).insufficientStorage()).toBe(true); + }); + it("return Boolean false when usage info is missing", () => { + const cfg = new Config(new StorageShim(), null); + for (const fn of ["filesQuotaReached", "storageLow", "insufficientStorage"]) { + const result = cfg[fn](); + expect(typeof result, fn).toBe("boolean"); + expect(result, fn).toBe(false); + } + }); + }); + + describe("setReduceMotion", () => { + afterEach(() => { + document.documentElement.classList.remove("reduce-motion"); + }); + + it("toggles the reduce-motion class on based on the argument", () => { + const cfg = createTestConfig(); + cfg.setReduceMotion(true); + expect(document.documentElement.classList.contains("reduce-motion")).toBe(true); + cfg.setReduceMotion(false); + expect(document.documentElement.classList.contains("reduce-motion")).toBe(false); + }); + it("coerces truthy and falsy values and returns the config instance", () => { + const cfg = createTestConfig(); + cfg.setReduceMotion("yes"); + expect(document.documentElement.classList.contains("reduce-motion")).toBe(true); + cfg.setReduceMotion(undefined); + expect(document.documentElement.classList.contains("reduce-motion")).toBe(false); + expect(cfg.setReduceMotion(true)).toBe(cfg); + }); + it("applies the class on construction when settings enable reduced motion", () => { + const values = JSON.parse(JSON.stringify(window.__CONFIG__)); + values.settings.ui.reduceMotion = true; + new Config(new StorageShim(), values); + expect(document.documentElement.classList.contains("reduce-motion")).toBe(true); + }); + it("updates the class when settings change via setSettings", () => { + const cfg = createTestConfig(); + const settings = JSON.parse(JSON.stringify(cfg.getSettings())); + settings.ui.reduceMotion = true; + cfg.setSettings(settings); + expect(document.documentElement.classList.contains("reduce-motion")).toBe(true); + settings.ui.reduceMotion = false; + cfg.setSettings(settings); + expect(document.documentElement.classList.contains("reduce-motion")).toBe(false); + }); + }); }); diff --git a/frontend/tests/vitest/common/event.test.js b/frontend/tests/vitest/common/event.test.js new file mode 100644 index 000000000..447d88ae5 --- /dev/null +++ b/frontend/tests/vitest/common/event.test.js @@ -0,0 +1,153 @@ +// Targets the cache-event subscription helpers in common/event.js. +// The pubsub-js wrapper itself is third-party and not retested here; +// this file pins the contract specific to subscribeEntityActions — +// which actions fire, which don't, and how custom action sets and +// malformed event names behave. +import { describe, it, expect, beforeEach, vi } from "vitest"; + +import $event, { + ENTITY_MUTATIONS, + subscribeEntityActions, + ACTION_CREATED, + ACTION_UPDATED, + ACTION_DELETED, + ACTION_ARCHIVED, + ACTION_RESTORED, +} from "common/event"; + +// Force pubsub-js to flush synchronously for the duration of one test. +// The module configures `async: true` for production so a handler that +// throws can't take down the publisher, but in the test the synchronous +// dispatch lets us assert call counts without flushPromises gymnastics. +async function flushEvents() { + await new Promise((resolve) => setTimeout(resolve, 0)); +} + +describe("common/event.js", () => { + describe("ENTITY_MUTATIONS", () => { + it("contains the five verbs that match the backend constants", () => { + // Mirrors internal/event/publish_entities.go EntityUpdated / + // EntityCreated / EntityDeleted / EntityArchived / EntityRestored. + // Adding a verb here MUST also land a matching constant on the + // Go side. + expect([...ENTITY_MUTATIONS].sort()).toEqual( + [ACTION_ARCHIVED, ACTION_CREATED, ACTION_DELETED, ACTION_RESTORED, ACTION_UPDATED].sort() + ); + }); + + it("exports the five action verbs as individual string constants", () => { + // Switch cases in page-level onUpdate handlers reference these + // symbols so IDE find-references / grep locates every event- + // handling site without false positives from prose, Vue + // lifecycle hooks, Date methods, etc. + expect(ACTION_CREATED).toBe("created"); + expect(ACTION_UPDATED).toBe("updated"); + expect(ACTION_DELETED).toBe("deleted"); + expect(ACTION_ARCHIVED).toBe("archived"); + expect(ACTION_RESTORED).toBe("restored"); + }); + + it("is frozen so call sites cannot mutate the shared default", () => { + expect(Object.isFrozen(ENTITY_MUTATIONS)).toBe(true); + }); + }); + + describe("subscribeEntityActions", () => { + let token; + + beforeEach(() => { + if (token) { + $event.unsubscribe(token); + token = null; + } + }); + + it("forwards events whose action is in the default mutation set", async () => { + const handler = vi.fn(); + token = subscribeEntityActions("test_ns_default", handler); + + for (const action of ["created", "updated", "deleted", "archived", "restored"]) { + $event.publish(`test_ns_default.${action}`, { entities: [`uid-${action}`] }); + } + await flushEvents(); + + expect(handler).toHaveBeenCalledTimes(5); + // Third argument is the parsed action — verifies the helper + // extracts it correctly for downstream callers that want to + // branch (e.g. future per-action logic). + const actions = handler.mock.calls.map(([, , action]) => action); + expect(actions.sort()).toEqual(["archived", "created", "deleted", "restored", "updated"]); + }); + + it("ignores unknown actions on the subscribed namespace", async () => { + const handler = vi.fn(); + token = subscribeEntityActions("test_ns_unknown", handler); + + $event.publish("test_ns_unknown.viewed", {}); + $event.publish("test_ns_unknown.merged", { entities: ["a"] }); + $event.publish("test_ns_unknown.foo.bar", {}); + await flushEvents(); + + expect(handler).not.toHaveBeenCalled(); + }); + + it("ignores publishes on a sibling namespace", async () => { + const handler = vi.fn(); + token = subscribeEntityActions("test_ns_a", handler); + + $event.publish("test_ns_b.updated", { entities: ["a"] }); + await flushEvents(); + + expect(handler).not.toHaveBeenCalled(); + }); + + it("respects a custom action set", async () => { + const handler = vi.fn(); + token = subscribeEntityActions("test_ns_custom", handler, new Set(["deleted"])); + + $event.publish("test_ns_custom.updated", { entities: ["a"] }); + $event.publish("test_ns_custom.deleted", { entities: ["b"] }); + $event.publish("test_ns_custom.edited", { entities: ["c"] }); + await flushEvents(); + + expect(handler).toHaveBeenCalledTimes(1); + expect(handler).toHaveBeenCalledWith("test_ns_custom.deleted", { entities: ["b"] }, "deleted"); + }); + + it("tolerates a publish on the bare namespace without an action", async () => { + const handler = vi.fn(); + token = subscribeEntityActions("test_ns_bare", handler); + + $event.publish("test_ns_bare", { entities: ["a"] }); + await flushEvents(); + + expect(handler).not.toHaveBeenCalled(); + }); + + it("returns the pubsub-js token so callers can unsubscribe", async () => { + const handler = vi.fn(); + token = subscribeEntityActions("test_ns_unsub", handler); + + $event.publish("test_ns_unsub.updated", { entities: ["a"] }); + await flushEvents(); + expect(handler).toHaveBeenCalledTimes(1); + + $event.unsubscribe(token); + token = null; + $event.publish("test_ns_unsub.updated", { entities: ["b"] }); + await flushEvents(); + expect(handler).toHaveBeenCalledTimes(1); + }); + + it("delivers the full topic and original payload to the handler", async () => { + const handler = vi.fn(); + token = subscribeEntityActions("test_ns_topic", handler); + + const payload = { entities: ["one", "two"], meta: 42 }; + $event.publish("test_ns_topic.updated", payload); + await flushEvents(); + + expect(handler).toHaveBeenCalledWith("test_ns_topic.updated", payload, "updated"); + }); + }); +}); diff --git a/frontend/tests/vitest/common/face-markers.test.js b/frontend/tests/vitest/common/face-markers.test.js new file mode 100644 index 000000000..1a7771eec --- /dev/null +++ b/frontend/tests/vitest/common/face-markers.test.js @@ -0,0 +1,120 @@ +import { describe, it, expect, beforeEach } from "vitest"; +import { FaceMarkers, $faceMarkers } from "common/face-markers"; +import { FaceMarkerDisplay, FaceMarkerEdit } from "options/face-marker"; + +describe("common/face-markers", () => { + describe("FaceMarkers (constructor + helpers)", () => { + it("initializes with the inactive default state", () => { + const fm = new FaceMarkers(); + expect(fm.mode).toBeNull(); + expect(fm.busy).toBe(false); + expect(fm.pendingNameMarkerUid).toBe(""); + expect(fm.hoveredMarkerUid).toBe(""); + expect(fm.active).toBe(false); + expect(fm.isDisplay).toBe(false); + expect(fm.isEdit).toBe(false); + }); + + it("setMode accepts FaceMarkerDisplay, FaceMarkerEdit, and null", () => { + const fm = new FaceMarkers(); + fm.setMode(FaceMarkerDisplay); + expect(fm.mode).toBe(FaceMarkerDisplay); + expect(fm.active).toBe(true); + expect(fm.isDisplay).toBe(true); + expect(fm.isEdit).toBe(false); + fm.setMode(FaceMarkerEdit); + expect(fm.mode).toBe(FaceMarkerEdit); + expect(fm.isEdit).toBe(true); + expect(fm.isDisplay).toBe(false); + fm.setMode(null); + expect(fm.mode).toBeNull(); + expect(fm.active).toBe(false); + }); + + it("setMode ignores invalid values without throwing", () => { + const fm = new FaceMarkers(); + fm.setMode("garbage"); + expect(fm.mode).toBeNull(); + fm.setMode(123); + expect(fm.mode).toBeNull(); + }); + + it("display / edit / exit are convenience setters", () => { + const fm = new FaceMarkers(); + fm.display(); + expect(fm.mode).toBe(FaceMarkerDisplay); + fm.edit(); + expect(fm.mode).toBe(FaceMarkerEdit); + fm.exit(); + expect(fm.mode).toBeNull(); + }); + + it("setBusy coerces to boolean", () => { + const fm = new FaceMarkers(); + fm.setBusy(true); + expect(fm.busy).toBe(true); + fm.setBusy(0); + expect(fm.busy).toBe(false); + fm.setBusy("yes"); + expect(fm.busy).toBe(true); + }); + + it("setPendingNameMarkerUid only accepts strings; non-strings clear it", () => { + const fm = new FaceMarkers(); + fm.setPendingNameMarkerUid("abc123"); + expect(fm.pendingNameMarkerUid).toBe("abc123"); + fm.setPendingNameMarkerUid(null); + expect(fm.pendingNameMarkerUid).toBe(""); + fm.setPendingNameMarkerUid(42); + expect(fm.pendingNameMarkerUid).toBe(""); + }); + + it("setHoveredMarkerUid only accepts strings; non-strings clear it", () => { + const fm = new FaceMarkers(); + fm.setHoveredMarkerUid("uid42"); + expect(fm.hoveredMarkerUid).toBe("uid42"); + fm.setHoveredMarkerUid(""); + expect(fm.hoveredMarkerUid).toBe(""); + fm.setHoveredMarkerUid(null); + expect(fm.hoveredMarkerUid).toBe(""); + fm.setHoveredMarkerUid(123); + expect(fm.hoveredMarkerUid).toBe(""); + }); + + it("reset returns every field to its default", () => { + const fm = new FaceMarkers(); + fm.setMode(FaceMarkerEdit); + fm.setBusy(true); + fm.setPendingNameMarkerUid("uid1"); + fm.setHoveredMarkerUid("uid2"); + fm.reset(); + expect(fm.mode).toBeNull(); + expect(fm.busy).toBe(false); + expect(fm.pendingNameMarkerUid).toBe(""); + expect(fm.hoveredMarkerUid).toBe(""); + }); + }); + + describe("$faceMarkers (shared singleton)", () => { + beforeEach(() => { + $faceMarkers.reset(); + }); + + it("is a reactive instance of FaceMarkers", () => { + // Vue's reactive() proxy preserves the prototype chain, so the + // shared singleton still recognizes as a FaceMarkers instance. + expect($faceMarkers).toBeInstanceOf(FaceMarkers); + expect($faceMarkers.mode).toBeNull(); + }); + + it("mode mutations propagate to the active/isDisplay/isEdit getters", () => { + $faceMarkers.display(); + expect($faceMarkers.active).toBe(true); + expect($faceMarkers.isDisplay).toBe(true); + $faceMarkers.edit(); + expect($faceMarkers.isEdit).toBe(true); + $faceMarkers.exit(); + expect($faceMarkers.active).toBe(false); + }); + }); +}); diff --git a/frontend/tests/vitest/common/form.test.js b/frontend/tests/vitest/common/form.test.js index 13f4a684d..1650d7014 100644 --- a/frontend/tests/vitest/common/form.test.js +++ b/frontend/tests/vitest/common/form.test.js @@ -207,10 +207,22 @@ describe("common/form", () => { it("validates time values", () => { expect(rules.isTime("23:59:59")).toBe(true); expect(rules.isTime("24:00:00")).toBe(false); + // isTime mirrors the other is* helpers: non-string / empty + // inputs are "no value", returning true so the wrapper rule's + // own !v / !!v gate decides required-ness. + expect(rules.isTime(null)).toBe(true); + expect(rules.isTime(undefined)).toBe(true); + expect(rules.isTime("")).toBe(true); + expect(rules.isTime({ value: "23:59:59" })).toBe(true); const required = rules.time(true); expect(required[0]("")).toBe("This field is required"); expect(required[1]("23:59:59")).toBe(true); expect(required[1]("25:00:00")).toBe("Invalid time"); + // Required-mode validity rule must short-circuit on empty so + // the "required" message isn't flashed alongside "Invalid time" + // — matches the email(true) / url(true) pattern. + expect(required[1]("")).toBe(true); + expect(required[1](null)).toBe(true); const optional = rules.time(false); expect(optional[0]("")).toBe(true); }); @@ -245,6 +257,45 @@ describe("common/form", () => { expect(optionalText[0]("abc")).toBe(true); }); + // Defensive-input regression for the centralized rules.text + // factory. Several per-component titleRule / textRule arrow + // functions did `v.length` without a null guard, which crashed + // on v-combobox-with-return-object modelValue = null (see the + // labels.vue nameRule fix). Migrating those call sites to the + // factory eliminates the crash class entirely. + // Whitespace is trimmed before the rule fires so a user typing only + // spaces explicitly trips "required" / "is too short" and a trailing + // space doesn't push a value past its cap. + it("trims whitespace before required, minLen, and maxLen checks", () => { + const required = rules.text(true, 2, 4, "Name"); + expect(required[0](" ")).toBe("This field is required"); + expect(required[1](" a ")).toBe("Name is too short"); + // 4-char content with leading/trailing spaces still fits the cap. + expect(required[2](" abcd ")).toBe(true); + // 5-char content with surrounding spaces still trips the cap. + expect(required[2](" abcde ")).toBe("Name is too long"); + + const optional = rules.text(false, 0, 4, "Name"); + expect(optional[0](" ")).toBe(true); + expect(optional[1](" abcd ")).toBe(true); + expect(optional[1](" abcde ")).toBe("Name is too long"); + }); + + it("tolerates null / undefined / object inputs without throwing", () => { + const [minLenRule, maxLenRule] = rules.text(false, 2, 4, "Name"); + // null / undefined short-circuit the !v guard in minLen/maxLen. + expect(minLenRule(null)).toBe(true); + expect(maxLenRule(null)).toBe(true); + expect(minLenRule(undefined)).toBe(true); + expect(maxLenRule(undefined)).toBe(true); + // Non-string inputs (objects from return-object comboboxes, + // numbers, etc.) short-circuit the typeof v !== "string" guard. + expect(minLenRule({ Name: "Flower" })).toBe(true); + expect(maxLenRule({ Name: "a really long name from a return-object combobox" })).toBe(true); + expect(minLenRule(42)).toBe(true); + expect(maxLenRule(42)).toBe(true); + }); + it("validates country, day, month, and year ranges", () => { const requiredCountry = rules.country(true); expect(requiredCountry[0]("")).toBe("This field is required"); diff --git a/frontend/tests/vitest/common/gettext.test.js b/frontend/tests/vitest/common/gettext.test.js new file mode 100644 index 000000000..037269b6e --- /dev/null +++ b/frontend/tests/vitest/common/gettext.test.js @@ -0,0 +1,45 @@ +// Targets the positional-interpolation bridge in common/gettext.js (Tp), which renders backend +// notification messages — addressed by their English source id with Go printf placeholders — in +// the current UI language. The vue3-gettext runtime itself is third-party and not retested here. +import { describe, it, expect } from "vitest"; + +import { Tp } from "common/gettext"; + +describe("common/gettext", () => { + describe("Tp", () => { + it("substitutes a single %s placeholder", () => { + expect(Tp("Indexing files in %s", ["/photos"])).toBe("Indexing files in /photos"); + }); + it("substitutes a single %d placeholder", () => { + expect(Tp("Indexing completed in %d s", [5])).toBe("Indexing completed in 5 s"); + }); + it("substitutes multiple ordered placeholders of mixed type", () => { + expect(Tp("%d entries added to %s", [3, "Holiday"])).toBe("3 entries added to Holiday"); + }); + it("substitutes repeated same-type placeholders positionally", () => { + expect(Tp("Removed %d files and %d photos", [10, 4])).toBe("Removed 10 files and 4 photos"); + }); + it("returns the message unchanged when there are no params", () => { + expect(Tp("Album created", [])).toBe("Album created"); + expect(Tp("Album created")).toBe("Album created"); + }); + it("un-escapes %% to a literal percent and does not consume a param", () => { + expect(Tp("100%% complete in %d s", [5])).toBe("100% complete in 5 s"); + }); + it("leaves a literal percent in translated text intact (no space flag, real verbs only)", () => { + // A translator may write a bare "100% ..." in a localized backend message; "% " must not be + // mistaken for a printf verb and splice a param mid-word. + expect(Tp("100% done in %d s", [5])).toBe("100% done in 5 s"); + expect(Tp("Zu 50% fertig", [])).toBe("Zu 50% fertig"); + }); + it("leaves a placeholder literal when its param is missing", () => { + expect(Tp("Indexing files in %s", [])).toBe("Indexing files in %s"); + }); + it("renders an empty string for null or undefined param values", () => { + expect(Tp("Indexing files in %s", [null])).toBe("Indexing files in "); + }); + it("returns an empty string for a null message", () => { + expect(Tp(null, [1])).toBe(""); + }); + }); +}); diff --git a/frontend/tests/vitest/common/instances.test.js b/frontend/tests/vitest/common/instances.test.js new file mode 100644 index 000000000..10b4726d9 --- /dev/null +++ b/frontend/tests/vitest/common/instances.test.js @@ -0,0 +1,381 @@ +import { describe, it, expect } from "vitest"; +import StorageShim from "node-storage-shim"; +import { buildNamespace, createNamespacedStorage } from "common/storage"; +import { + persistInstanceIdentity, + listReachableInstances, + InstanceIdentityKeys, + instanceLabel, + instanceTitle, + instancePath, + instanceSessionUrl, + listLogoutTargets, + signOutInstances, + clearInstanceStorage, +} from "common/instances"; + +// seedInstance writes a peer instance's session token and identity into a shared store. +const seedInstance = (store, namespace, { token = "tok", url, title, icon, route, portal } = {}) => { + const prefix = buildNamespace(namespace); + if (token) { + store.setItem(prefix + "session.token", token); + } + if (url) { + store.setItem(prefix + "instance.url", url); + } + if (title) { + store.setItem(prefix + "instance.title", title); + } + if (icon) { + store.setItem(prefix + "instance.icon", icon); + } + if (route) { + store.setItem(prefix + "instance.route", route); + } + if (portal) { + store.setItem(prefix + "instance.portal", "true"); + } +}; + +describe("common/instances", () => { + describe("instanceLabel", () => { + it("derives the last base-path segment as a distinctive label", () => { + expect(instanceLabel("https://app.example.com/i/pro-1/")).toBe("pro-1"); + expect(instanceLabel("https://app.example.com/i/pro-2")).toBe("pro-2"); + }); + it("returns an empty string for a root-path or unparseable url", () => { + expect(instanceLabel("https://app.example.com/")).toBe(""); + expect(instanceLabel("not a url")).toBe(""); + expect(instanceLabel("")).toBe(""); + expect(instanceLabel(null)).toBe(""); + }); + }); + + describe("instanceTitle", () => { + it("prefers the configured site name over the base-path slug", () => { + expect( + instanceTitle({ siteName: "ACME", name: "PhotoPrism Pro", siteTitle: "ACME", siteUrl: "https://app.example.com/i/acme/" }) + ).toBe("ACME"); + }); + it("falls back to the base-path slug when no site name is configured", () => { + expect( + instanceTitle({ siteName: "", name: "PhotoPrism Pro", siteTitle: "PhotoPrism Pro", siteUrl: "https://app.example.com/i/pro-1/" }) + ).toBe("pro-1"); + }); + it("falls back through site title, name, then url when no slug is available", () => { + expect(instanceTitle({ name: "PhotoPrism", siteTitle: "My Photos", siteUrl: "https://app.example.com/" })).toBe("My Photos"); + expect(instanceTitle({ name: "My Node", siteUrl: "https://app.example.com/" })).toBe("My Node"); + expect(instanceTitle({ siteUrl: "https://app.example.com/" })).toBe("https://app.example.com/"); + }); + it("returns an empty string for missing or invalid values", () => { + expect(instanceTitle(null)).toBe(""); + expect(instanceTitle({})).toBe(""); + }); + }); + + describe("instancePath", () => { + it("returns the base path of a SiteUrl without a trailing slash", () => { + expect(instancePath("https://app.example.com/i/pro-1/")).toBe("/i/pro-1"); + expect(instancePath("https://app.example.com/i/pro-2")).toBe("/i/pro-2"); + }); + it("returns / for a root install and '' for an unparseable url", () => { + expect(instancePath("https://app.example.com/")).toBe("/"); + expect(instancePath("not a url")).toBe(""); + expect(instancePath("")).toBe(""); + expect(instancePath(null)).toBe(""); + }); + }); + + describe("persistInstanceIdentity", () => { + it("writes url, title, icon, and route under the namespace", () => { + const store = new StorageShim(); + const ns = createNamespacedStorage(store, "ns-pro-1"); + persistInstanceIdentity(ns, { url: "https://pro-1.example.com/", route: "/i/pro-1/library", title: "Pro One", icon: "/static/icons/logo.svg" }); + const prefix = buildNamespace("ns-pro-1"); + expect(store.getItem(prefix + "instance.url")).toBe("https://pro-1.example.com/"); + expect(store.getItem(prefix + "instance.route")).toBe("/i/pro-1/library"); + expect(store.getItem(prefix + "instance.title")).toBe("Pro One"); + expect(store.getItem(prefix + "instance.icon")).toBe("/static/icons/logo.svg"); + }); + it("clears a stale title, icon, or route when none is provided", () => { + const store = new StorageShim(); + const ns = createNamespacedStorage(store, "ns-pro-1"); + persistInstanceIdentity(ns, { url: "https://pro-1.example.com/", route: "/i/pro-1/library", title: "Pro One", icon: "/static/icons/logo.svg" }); + persistInstanceIdentity(ns, { url: "https://pro-1.example.com/" }); + const prefix = buildNamespace("ns-pro-1"); + expect(store.getItem(prefix + "instance.title")).toBeNull(); + expect(store.getItem(prefix + "instance.icon")).toBeNull(); + expect(store.getItem(prefix + "instance.route")).toBeNull(); + }); + it("writes and clears the portal flag", () => { + const store = new StorageShim(); + const ns = createNamespacedStorage(store, "ns-portal"); + const prefix = buildNamespace("ns-portal"); + persistInstanceIdentity(ns, { url: "https://app.example.com/", portal: true }); + expect(store.getItem(prefix + "instance.portal")).toBe("true"); + persistInstanceIdentity(ns, { url: "https://app.example.com/" }); + expect(store.getItem(prefix + "instance.portal")).toBeNull(); + }); + it("is a no-op without a url", () => { + const store = new StorageShim(); + const ns = createNamespacedStorage(store, "ns-pro-1"); + persistInstanceIdentity(ns, { title: "Pro One" }); + expect(store.length).toBe(0); + }); + it("is a no-op without a usable store", () => { + expect(() => persistInstanceIdentity(null, { url: "https://pro-1.example.com/" })).not.toThrow(); + }); + it("exposes the identity suffix keys for cleanup", () => { + expect(InstanceIdentityKeys).toContain("instance.url"); + expect(InstanceIdentityKeys).toContain("instance.title"); + expect(InstanceIdentityKeys).toContain("instance.icon"); + expect(InstanceIdentityKeys).toContain("instance.route"); + }); + }); + + describe("listReachableInstances", () => { + it("returns peer instances excluding the current namespace", () => { + const store = new StorageShim(); + seedInstance(store, "ns-pro-1", { url: "https://pro-1.example.com/", title: "Pro One" }); + seedInstance(store, "ns-pro-2", { url: "https://pro-2.example.com/", title: "Pro Two", icon: "/i/pro-2/static/icons/logo.svg" }); + const result = listReachableInstances({ currentNamespace: "ns-pro-1", storage: store }); + expect(result).toHaveLength(1); + expect(result[0]).toMatchObject({ namespace: "ns-pro-2", url: "https://pro-2.example.com/", title: "Pro Two", icon: "/i/pro-2/static/icons/logo.svg" }); + }); + it("lists the Portal (root path) first, then peers by ascending base-path", () => { + const store = new StorageShim(); + // Seed in a scrambled order; the Portal lives at the origin root. + seedInstance(store, "ns-pro-2", { url: "https://app.example.com/i/pro-2/", title: "Los Angeles" }); + seedInstance(store, "ns-portal", { url: "https://app.example.com/", title: "Portal" }); + seedInstance(store, "ns-pro-1", { url: "https://app.example.com/i/pro-1/", title: "San Francisco" }); + const result = listReachableInstances({ currentNamespace: "ns-current", storage: store }); + expect(result.map((i) => i.title)).toEqual(["Portal", "San Francisco", "Los Angeles"]); + }); + it("resolves the stored route to an app-entry URL at the SiteUrl origin", () => { + const store = new StorageShim(); + seedInstance(store, "ns-pro-1", { url: "https://app.example.com/i/pro-1/" }); + // Proxied instance: route is the frontend URI under the proxy prefix. + seedInstance(store, "ns-pro-2", { url: "https://app.example.com/i/pro-2/", route: "/i/pro-2/library" }); + const result = listReachableInstances({ currentNamespace: "ns-pro-1", storage: store }); + expect(result[0].route).toBe("https://app.example.com/i/pro-2/library"); + }); + it("resolves a Portal route at the origin root", () => { + const store = new StorageShim(); + seedInstance(store, "ns-pro-1", { url: "https://app.example.com/i/pro-1/" }); + seedInstance(store, "ns-portal", { url: "https://app.example.com/", route: "/portal" }); + const result = listReachableInstances({ currentNamespace: "ns-pro-1", storage: store }); + expect(result[0].route).toBe("https://app.example.com/portal"); + }); + it("defaults route to the SiteUrl when none is recorded", () => { + const store = new StorageShim(); + seedInstance(store, "ns-pro-1", { url: "https://app.example.com/i/pro-1/" }); + seedInstance(store, "ns-pro-2", { url: "https://app.example.com/i/pro-2/" }); + const result = listReachableInstances({ currentNamespace: "ns-pro-1", storage: store }); + expect(result[0].route).toBe("https://app.example.com/i/pro-2/"); + }); + it("falls back to the SiteUrl when the stored route resolves to a non-http(s) scheme", () => { + const store = new StorageShim(); + seedInstance(store, "ns-pro-1", { url: "https://app.example.com/i/pro-1/" }); + seedInstance(store, "ns-pro-2", { url: "https://app.example.com/i/pro-2/", route: "javascript:alert(1)" }); + const result = listReachableInstances({ currentNamespace: "ns-pro-1", storage: store }); + expect(result[0].route).toBe("https://app.example.com/i/pro-2/"); + }); + it("falls back to the url when no title is recorded", () => { + const store = new StorageShim(); + seedInstance(store, "ns-pro-1", { url: "https://pro-1.example.com/" }); + seedInstance(store, "ns-pro-2", { url: "https://pro-2.example.com/" }); + const result = listReachableInstances({ currentNamespace: "ns-pro-1", storage: store }); + expect(result[0].title).toBe("https://pro-2.example.com/"); + }); + it("ignores namespaces that have a session but no recorded identity", () => { + const store = new StorageShim(); + seedInstance(store, "ns-pro-1", { url: "https://pro-1.example.com/" }); + seedInstance(store, "ns-pro-2", { token: "tok2" }); // session only, no identity + const result = listReachableInstances({ currentNamespace: "ns-pro-1", storage: store }); + expect(result).toHaveLength(0); + }); + it("ignores namespaces that have an identity but no live session", () => { + const store = new StorageShim(); + seedInstance(store, "ns-pro-1", { url: "https://pro-1.example.com/" }); + seedInstance(store, "ns-pro-2", { token: "", url: "https://pro-2.example.com/" }); // identity only + const result = listReachableInstances({ currentNamespace: "ns-pro-1", storage: store }); + expect(result).toHaveLength(0); + }); + it("returns an empty array for a standalone deployment", () => { + const store = new StorageShim(); + seedInstance(store, "ns-pro-1", { url: "https://pro-1.example.com/" }); + const result = listReachableInstances({ currentNamespace: "ns-pro-1", storage: store }); + expect(result).toEqual([]); + }); + it("excludes peers whose stored url is not http(s)", () => { + // Instance URLs cross a shared same-origin-storage trust boundary, so a peer + // that recorded a javascript:/data: url must never become a switcher entry. + const store = new StorageShim(); + seedInstance(store, "ns-pro-1", { url: "https://pro-1.example.com/" }); + seedInstance(store, "ns-evil", { url: "javascript:alert(1)" }); + const result = listReachableInstances({ currentNamespace: "ns-pro-1", storage: store }); + expect(result).toHaveLength(0); + }); + it("de-duplicates a namespace seen more than once", () => { + const store = new StorageShim(); + seedInstance(store, "ns-pro-1", { url: "https://pro-1.example.com/" }); + seedInstance(store, "ns-pro-2", { url: "https://pro-2.example.com/", title: "Pro Two" }); + store.setItem(buildNamespace("ns-pro-2") + "session.token", "tok-dup"); + const result = listReachableInstances({ currentNamespace: "ns-pro-1", storage: store }); + expect(result).toHaveLength(1); + }); + it("discovers ephemeral peers from sessionStorage as well as localStorage", () => { + const local = new StorageShim(); + const session = new StorageShim(); + seedInstance(local, "ns-pro-1", { url: "https://pro-1.example.com/", title: "Pro One" }); + seedInstance(session, "ns-pro-2", { url: "https://pro-2.example.com/", title: "Pro Two" }); + const result = listReachableInstances({ currentNamespace: "ns-pro-1", stores: [local, session] }); + expect(result.map((i) => i.namespace)).toEqual(["ns-pro-2"]); + }); + it("de-duplicates a namespace present in both storage backends", () => { + const local = new StorageShim(); + const session = new StorageShim(); + seedInstance(local, "ns-pro-1", { url: "https://pro-1.example.com/" }); + seedInstance(local, "ns-pro-2", { url: "https://pro-2.example.com/", title: "Pro Two" }); + seedInstance(session, "ns-pro-2", { url: "https://pro-2.example.com/", title: "Pro Two" }); + const result = listReachableInstances({ currentNamespace: "ns-pro-1", stores: [local, session] }); + expect(result).toHaveLength(1); + }); + }); + + describe("instanceSessionUrl", () => { + it("derives the DELETE-session endpoint from a SiteUrl with a trailing slash", () => { + expect(instanceSessionUrl("https://app.example.com/i/pro-1/")).toBe("https://app.example.com/i/pro-1/api/v1/session"); + }); + it("adds the missing trailing slash before resolving so the base path is kept", () => { + expect(instanceSessionUrl("https://app.example.com/i/pro-1")).toBe("https://app.example.com/i/pro-1/api/v1/session"); + }); + it("derives the root endpoint for a Portal at the origin root", () => { + expect(instanceSessionUrl("https://app.example.com/")).toBe("https://app.example.com/api/v1/session"); + }); + it("returns an empty string for a non-http(s) or unparseable url", () => { + expect(instanceSessionUrl("javascript:alert(1)")).toBe(""); + expect(instanceSessionUrl("not a url")).toBe(""); + expect(instanceSessionUrl("")).toBe(""); + expect(instanceSessionUrl(null)).toBe(""); + }); + }); + + describe("listLogoutTargets", () => { + it("returns peer sessions with token and endpoint, excluding the current namespace", () => { + const store = new StorageShim(); + seedInstance(store, "ns-pro-1", { token: "tok1", url: "https://app.example.com/i/pro-1/" }); + seedInstance(store, "ns-pro-2", { token: "tok2", url: "https://app.example.com/i/pro-2/" }); + seedInstance(store, "ns-portal", { token: "tokp", url: "https://app.example.com/", portal: true }); + const targets = listLogoutTargets({ currentNamespace: "ns-pro-1", storage: store }); + expect(targets).toHaveLength(2); + expect(targets).toEqual( + expect.arrayContaining([ + { namespace: "ns-pro-2", authToken: "tok2", url: "https://app.example.com/i/pro-2/api/v1/session", portal: false }, + { namespace: "ns-portal", authToken: "tokp", url: "https://app.example.com/api/v1/session", portal: true }, + ]) + ); + }); + it("returns a peer with an empty url when its SiteUrl is unknown so its storage can still be cleared", () => { + const store = new StorageShim(); + seedInstance(store, "ns-pro-1", { token: "tok1", url: "https://app.example.com/i/pro-1/" }); + seedInstance(store, "ns-pro-2", { token: "tok2" }); // session only, no recorded url + const targets = listLogoutTargets({ currentNamespace: "ns-pro-1", storage: store }); + expect(targets).toEqual([{ namespace: "ns-pro-2", authToken: "tok2", url: "", portal: false }]); + }); + it("skips namespaces without a token", () => { + const store = new StorageShim(); + seedInstance(store, "ns-pro-1", { token: "tok1", url: "https://app.example.com/i/pro-1/" }); + seedInstance(store, "ns-pro-2", { token: "", url: "https://app.example.com/i/pro-2/" }); + const targets = listLogoutTargets({ currentNamespace: "ns-pro-1", storage: store }); + expect(targets).toEqual([]); + }); + it("scans both storage backends and de-duplicates", () => { + const local = new StorageShim(); + const session = new StorageShim(); + seedInstance(local, "ns-pro-1", { token: "tok1", url: "https://app.example.com/i/pro-1/" }); + seedInstance(local, "ns-pro-2", { token: "tok2", url: "https://app.example.com/i/pro-2/" }); + seedInstance(session, "ns-pro-2", { token: "tok2", url: "https://app.example.com/i/pro-2/" }); + const targets = listLogoutTargets({ currentNamespace: "ns-pro-1", stores: [local, session] }); + expect(targets).toHaveLength(1); + expect(targets[0].namespace).toBe("ns-pro-2"); + }); + }); + + describe("signOutInstances", () => { + it("fires a best-effort authenticated DELETE per reachable target", async () => { + const calls = []; + const fetchImpl = (url, opts) => { + calls.push({ url, opts }); + return Promise.resolve({ ok: true }); + }; + await signOutInstances( + [ + { namespace: "ns-pro-2", authToken: "tok2", url: "https://app.example.com/i/pro-2/api/v1/session" }, + { namespace: "ns-portal", authToken: "tokp", url: "https://app.example.com/api/v1/session" }, + ], + fetchImpl + ); + expect(calls).toHaveLength(2); + expect(calls[0].opts.method).toBe("DELETE"); + expect(calls[0].opts.headers["X-Auth-Token"]).toBe("tok2"); + expect(calls[1].opts.headers["X-Auth-Token"]).toBe("tokp"); + }); + it("skips targets without a resolvable url", async () => { + const calls = []; + const fetchImpl = (url) => { + calls.push(url); + return Promise.resolve({ ok: true }); + }; + await signOutInstances([{ namespace: "ns-x", authToken: "tok", url: "" }], fetchImpl); + expect(calls).toHaveLength(0); + }); + it("swallows per-request failures so one bad peer can't block sign-out", async () => { + const fetchImpl = (url) => + url.includes("pro-2") ? Promise.reject(new Error("offline")) : Promise.resolve({ ok: true }); + await expect( + signOutInstances( + [ + { namespace: "ns-pro-2", authToken: "t2", url: "https://app.example.com/i/pro-2/api/v1/session" }, + { namespace: "ns-portal", authToken: "tp", url: "https://app.example.com/api/v1/session" }, + ], + fetchImpl + ) + ).resolves.toBeDefined(); + }); + it("resolves with an empty array when there are no targets", async () => { + await expect(signOutInstances([], () => Promise.resolve())).resolves.toEqual([]); + await expect(signOutInstances(null, () => Promise.resolve())).resolves.toEqual([]); + }); + }); + + describe("clearInstanceStorage", () => { + it("removes every namespaced key for the given peers from all backends", () => { + const local = new StorageShim(); + const session = new StorageShim(); + seedInstance(local, "ns-pro-1", { token: "tok1", url: "https://app.example.com/i/pro-1/" }); + seedInstance(local, "ns-pro-2", { token: "tok2", url: "https://app.example.com/i/pro-2/", title: "Pro Two" }); + seedInstance(session, "ns-pro-2", { token: "tok2", url: "https://app.example.com/i/pro-2/" }); + clearInstanceStorage(["ns-pro-2"], [local, session]); + const p2 = buildNamespace("ns-pro-2"); + expect(local.getItem(p2 + "session.token")).toBeNull(); + expect(local.getItem(p2 + "instance.url")).toBeNull(); + expect(local.getItem(p2 + "instance.title")).toBeNull(); + expect(session.getItem(p2 + "session.token")).toBeNull(); + // The untouched namespace survives. + expect(local.getItem(buildNamespace("ns-pro-1") + "session.token")).toBe("tok1"); + }); + it("is a no-op with no namespaces", () => { + const local = new StorageShim(); + seedInstance(local, "ns-pro-1", { token: "tok1", url: "https://app.example.com/i/pro-1/" }); + expect(() => clearInstanceStorage([], [local])).not.toThrow(); + expect(local.getItem(buildNamespace("ns-pro-1") + "session.token")).toBe("tok1"); + }); + it("ignores null backends", () => { + const local = new StorageShim(); + seedInstance(local, "ns-pro-2", { token: "tok2", url: "https://app.example.com/i/pro-2/" }); + expect(() => clearInstanceStorage(["ns-pro-2"], [local, null, undefined])).not.toThrow(); + expect(local.getItem(buildNamespace("ns-pro-2") + "session.token")).toBeNull(); + }); + }); +}); diff --git a/frontend/tests/vitest/common/map.test.js b/frontend/tests/vitest/common/map.test.js new file mode 100644 index 000000000..6071b1f75 --- /dev/null +++ b/frontend/tests/vitest/common/map.test.js @@ -0,0 +1,100 @@ +import { describe, it, expect } from "vitest"; +import { groupGeoFeatures } from "common/map"; + +const feature = (uid, lng, lat, id) => ({ + id: id ?? uid, + geometry: { coordinates: [lng, lat] }, + properties: { UID: uid, Hash: `${uid}hash` }, +}); + +// Identity projection treats raw coordinates as screen pixels so the proximity grouping can +// be exercised with a small, explicit tolerance and no live map. +const identity = (coords) => [coords[0], coords[1]]; + +describe("common/map.groupGeoFeatures", () => { + it("should return an empty array for invalid input", () => { + expect(groupGeoFeatures(undefined)).toEqual([]); + expect(groupGeoFeatures(null)).toEqual([]); + expect(groupGeoFeatures([])).toEqual([]); + }); + + it("should keep distinct locations in separate groups", () => { + const groups = groupGeoFeatures([feature("p1", 10, 20), feature("p2", 11, 21)], identity, 0.5); + expect(groups.length).toBe(2); + expect(groups[0].features.length).toBe(1); + expect(groups[1].features.length).toBe(1); + }); + + it("should group pictures sharing the exact same coordinates", () => { + const groups = groupGeoFeatures([feature("p1", 16.5, 47.5), feature("p2", 16.5, 47.5), feature("p3", 16.5, 47.5)], identity, 0.5); + expect(groups.length).toBe(1); + expect(groups[0].features.length).toBe(3); + }); + + it("should group near-coincident pictures within the tolerance", () => { + // Pictures a fraction apart (GPS jitter or tile quantization) must still stack. + const groups = groupGeoFeatures([feature("p1", 16.5, 47.5), feature("p2", 16.5001, 47.5001), feature("p3", 16.4999, 47.4999)], identity, 0.5); + expect(groups.length).toBe(1); + expect(groups[0].features.length).toBe(3); + }); + + it("should not group pictures beyond the tolerance", () => { + const groups = groupGeoFeatures([feature("p1", 16.5, 47.5), feature("p2", 17.5, 47.5)], identity, 0.5); + expect(groups.length).toBe(2); + }); + + it("should fall back to raw coordinate (degree) grouping when no projection is given", () => { + // Without a projection the tolerance is applied in raw [lng, lat] degrees rather than + // screen pixels, so grouping is not zoom-aware. The default 40-degree tolerance merges + // coordinates that are far apart on screen — which is why the live map always passes a + // projection. Two points ~0.7 degrees apart merge; two points 100 degrees apart do not. + const near = groupGeoFeatures([feature("p1", 10, 20), feature("p2", 10.5, 20.5)]); + expect(near.length).toBe(1); + expect(near[0].features.length).toBe(2); + const far = groupGeoFeatures([feature("p1", 0, 0), feature("p2", 100, 0)]); + expect(far.length).toBe(2); + }); + + it("should group by pixel distance when given a maplibregl Point projection", () => { + const project = (coords) => ({ x: coords[0] * 1000, y: coords[1] * 1000 }); + // 0.001 deg => 1px apart with this projection => within the default tolerance. + const near = groupGeoFeatures([feature("p1", 16.5, 47.5), feature("p2", 16.501, 47.5)], project); + expect(near.length).toBe(1); + // 0.1 deg => 100px apart => beyond the default tolerance. + const far = groupGeoFeatures([feature("p1", 16.5, 47.5), feature("p2", 16.6, 47.5)], project); + expect(far.length).toBe(2); + }); + + it("should deduplicate features that reference the same picture", () => { + const groups = groupGeoFeatures([feature("p1", 16.5, 47.5), feature("p1", 16.5, 47.5), feature("p2", 16.5, 47.5)], identity, 0.5); + expect(groups.length).toBe(1); + expect(groups[0].features.length).toBe(2); + expect(Object.keys(groups[0].uids).sort()).toEqual(["p1", "p2"]); + }); + + it("should skip features without valid coordinates", () => { + const groups = groupGeoFeatures([feature("p1", 16.5, 47.5), { id: "x", properties: { UID: "x" } }, { geometry: { coordinates: [1] }, properties: { UID: "y" } }], identity, 0.5); + expect(groups.length).toBe(1); + expect(groups[0].features.length).toBe(1); + }); + + it("should preserve features missing a UID without deduplicating them", () => { + const a = { id: "a", geometry: { coordinates: [0, 0] }, properties: {} }; + const b = { id: "b", geometry: { coordinates: [0, 0] }, properties: {} }; + const groups = groupGeoFeatures([a, b], identity, 0.5); + expect(groups.length).toBe(1); + expect(groups[0].features.length).toBe(2); + }); + + it("should expose the lat/lng bounding box of each group", () => { + const groups = groupGeoFeatures([feature("p2", 16.6, 47.6), feature("p1", 16.4, 47.4)], identity, 0.5); + expect(groups.length).toBe(1); + expect(groups[0].bounds).toEqual({ latN: 47.6, lngE: 16.6, latS: 47.4, lngW: 16.4 }); + }); + + it("should derive a stable key from the smallest UID", () => { + const groups = groupGeoFeatures([feature("p3", 16.5, 47.5), feature("p1", 16.5, 47.5), feature("p2", 16.5, 47.5)], identity, 0.5); + expect(groups.length).toBe(1); + expect(groups[0].key).toBe("p1"); + }); +}); diff --git a/frontend/tests/vitest/common/notify.test.js b/frontend/tests/vitest/common/notify.test.js index a80079dc9..056a7ff2a 100644 --- a/frontend/tests/vitest/common/notify.test.js +++ b/frontend/tests/vitest/common/notify.test.js @@ -1,6 +1,7 @@ -import { describe, it } from "vitest"; +import { describe, it, expect, vi } from "vitest"; import "../fixtures"; import $notify from "common/notify"; +import $event from "common/event"; describe("common/alert", () => { it("should call alert.info", () => { @@ -19,6 +20,20 @@ describe("common/alert", () => { $notify.success("message"); }); + it("error forwards an optional message id and params for UI-locale rendering", async () => { + const handler = vi.fn(); + const token = $event.subscribe("notify.error", handler); + $notify.error("fallback", "Registration disabled", ["x"]); + // pubsub.js delivers asynchronously, so wait a tick before asserting. + await new Promise((resolve) => setTimeout(resolve, 0)); + $event.unsubscribe(token); + expect(handler).toHaveBeenCalledWith("notify.error", { + message: "fallback", + messageId: "Registration disabled", + messageParams: ["x"], + }); + }); + it("should call wait", () => { $notify.wait(); }); diff --git a/frontend/tests/vitest/common/session.test.js b/frontend/tests/vitest/common/session.test.js index ec015a46f..f24afedf4 100644 --- a/frontend/tests/vitest/common/session.test.js +++ b/frontend/tests/vitest/common/session.test.js @@ -1,14 +1,21 @@ -import { describe, it, expect, beforeEach } from "vitest"; +import { describe, it, expect, beforeEach, vi } from "vitest"; import "../fixtures"; import { $config } from "app/session"; +import $api from "common/api"; import Session from "common/session"; import { buildNamespace, createNamespacedStorage } from "common/storage"; import StorageShim from "node-storage-shim"; +import { Photo } from "model/photo"; + +// Lets the suite drain the dynamic import + microtask chain that +// Session.reset() uses to call Photo.clearCache(). +const flushMicrotasks = () => new Promise((resolve) => setTimeout(resolve, 0)); const createConfig = (baseUri, storageNamespace) => { const config = Object.assign(Object.create(Object.getPrototypeOf($config)), $config); config.baseUri = baseUri; config.storageNamespace = storageNamespace; + config.values = { ...config.values, storageNamespace }; config.progress = () => {}; return config; }; @@ -16,6 +23,8 @@ const createConfig = (baseUri, storageNamespace) => { describe("common/session", () => { beforeEach(() => { window.onbeforeunload = () => "Oh no!"; + window.localStorage.clear(); + window.sessionStorage.clear(); }); it("should construct session", () => { @@ -36,6 +45,30 @@ describe("common/session", () => { expect(session.authToken).toBe(null); }); + it("marks, detects, and clears the login-redirect loop guard", () => { + const storage = new StorageShim(); + const session = new Session(storage, $config); + expect(session.loginRedirectLooping()).toBe(false); + session.markLoginRedirectAttempt(); + expect(session.loginRedirectLooping()).toBe(true); + session.clearLoginRedirectAttempt(); + expect(session.loginRedirectLooping()).toBe(false); + }); + + it("stops reporting a login-redirect loop after the loop window elapses", () => { + vi.useFakeTimers(); + try { + const storage = new StorageShim(); + const session = new Session(storage, $config); + session.markLoginRedirectAttempt(); + expect(session.loginRedirectLooping()).toBe(true); + vi.advanceTimersByTime(7000); // exceeds the 6s loop window + expect(session.loginRedirectLooping()).toBe(false); + } finally { + vi.useRealTimers(); + } + }); + it("should set, get and delete user", () => { const storage = new StorageShim(); const session = new Session(storage, $config); @@ -318,6 +351,175 @@ describe("common/session", () => { session.deleteData(); }); + it("should restore session data from namespaced session storage when preferred", () => { + const namespaceKey = "ns-session-pref"; + const namespaced = buildNamespace(namespaceKey); + const token = "999900000000000000000000000000000000000000000000"; + const sessionID = "a9b8ff820bf40ab451910f8bbfe401b2432446693aa539538fbd2399560a722f"; + + window.localStorage.clear(); + window.sessionStorage.clear(); + window.localStorage.setItem(namespaced + "session", "true"); + window.sessionStorage.setItem(namespaced + "session.token", token); + window.sessionStorage.setItem(namespaced + "session.id", sessionID); + window.sessionStorage.setItem(namespaced + "session.provider", "public"); + window.sessionStorage.setItem(namespaced + "session.user", JSON.stringify({ ID: 5, Name: "foo", DisplayName: "Foo" })); + + const storage = createNamespacedStorage(window.localStorage, namespaceKey); + const session = new Session(storage, createConfig("/library", namespaceKey)); + + expect(session.getAuthToken()).toBe(token); + expect(session.getId()).toBe(sessionID); + expect(session.getProvider()).toBe("public"); + expect(session.getUser().DisplayName).toBe("Foo"); + }); + + it("should restore preferred session storage using the client config storageNamespace value", () => { + const namespaceKey = "ns-session-config-values"; + const namespaced = buildNamespace(namespaceKey); + const token = "999900000000000000000000000000000000000000000000"; + const sessionID = "a9b8ff820bf40ab451910f8bbfe401b2432446693aa539538fbd2399560a722f"; + + window.localStorage.clear(); + window.sessionStorage.clear(); + window.localStorage.setItem(namespaced + "session", "true"); + window.sessionStorage.setItem(namespaced + "session.token", token); + window.sessionStorage.setItem(namespaced + "session.id", sessionID); + window.sessionStorage.setItem(namespaced + "session.provider", "public"); + window.sessionStorage.setItem(namespaced + "session.user", JSON.stringify({ ID: 5, Name: "foo", DisplayName: "Foo" })); + + const config = createConfig("/library", namespaceKey); + delete config.storageNamespace; + + const storage = createNamespacedStorage(window.localStorage, namespaceKey); + const session = new Session(storage, config); + + expect(session.getAuthToken()).toBe(token); + expect(session.getId()).toBe(sessionID); + expect(session.getProvider()).toBe("public"); + expect(session.getUser().DisplayName).toBe("Foo"); + }); + + it("should clear only the current namespace from both storage backends on reset", () => { + const namespaceKey = "ns-reset-current"; + const otherNamespaceKey = "ns-reset-other"; + const namespace = buildNamespace(namespaceKey); + const otherNamespace = buildNamespace(otherNamespaceKey); + const sessionID = "a9b8ff820bf40ab451910f8bbfe401b2432446693aa539538fbd2399560a722f"; + const token = "999900000000000000000000000000000000000000000000"; + + window.localStorage.clear(); + window.sessionStorage.clear(); + + window.localStorage.setItem(namespace + "session", "true"); + window.localStorage.setItem(namespace + "session.token", token); + window.localStorage.setItem(namespace + "session.id", sessionID); + window.localStorage.setItem(namespace + "session.user", JSON.stringify({ ID: 5, Name: "foo", DisplayName: "Foo" })); + window.localStorage.setItem(otherNamespace + "session.token", "other-local-token"); + + window.sessionStorage.setItem(namespace + "session.token", token); + window.sessionStorage.setItem(namespace + "session.id", sessionID); + window.sessionStorage.setItem(namespace + "session.provider", "public"); + window.sessionStorage.setItem(namespace + "clipboard.photos", '["p123"]'); + window.sessionStorage.setItem(otherNamespace + "session.token", "other-session-token"); + + const storage = createNamespacedStorage(window.localStorage, namespaceKey); + const session = new Session(storage, createConfig("/library", namespaceKey)); + + session.reset(); + + expect(window.localStorage.getItem(namespace + "session")).toBe("true"); + expect(window.localStorage.getItem(namespace + "session.token")).toBeNull(); + expect(window.localStorage.getItem(namespace + "session.id")).toBeNull(); + expect(window.localStorage.getItem(namespace + "session.user")).toBeNull(); + expect(window.sessionStorage.getItem(namespace + "session.token")).toBeNull(); + expect(window.sessionStorage.getItem(namespace + "session.id")).toBeNull(); + expect(window.sessionStorage.getItem(namespace + "session.provider")).toBeNull(); + expect(window.sessionStorage.getItem(namespace + "clipboard.photos")).toBeNull(); + + expect(window.localStorage.getItem(otherNamespace + "session.token")).toBe("other-local-token"); + expect(window.sessionStorage.getItem(otherNamespace + "session.token")).toBe("other-session-token"); + }); + + it("should remove legacy auth and payload keys from both storage backends on reset", () => { + const namespaceKey = "ns-reset-legacy"; + const sessionID = "a9b8ff820bf40ab451910f8bbfe401b2432446693aa539538fbd2399560a722f"; + const token = "999900000000000000000000000000000000000000000000"; + + window.localStorage.clear(); + window.sessionStorage.clear(); + + const storage = createNamespacedStorage(window.localStorage, namespaceKey); + const session = new Session(storage, createConfig("/library", namespaceKey)); + + session.setId(sessionID); + session.setAuthToken(token); + session.setProvider("public"); + session.setScope("photos:view"); + + window.localStorage.setItem("session.token", token); + window.localStorage.setItem("authToken", token); + window.localStorage.setItem("session.id", sessionID); + window.localStorage.setItem("sessionId", sessionID); + window.localStorage.setItem("session_id", sessionID); + window.localStorage.setItem("provider", "public"); + window.localStorage.setItem("session.provider", "public"); + window.localStorage.setItem("session.scope", "photos:view"); + window.localStorage.setItem("sessionData", '{"user":{"ID":5}}'); + window.localStorage.setItem("session.data", '{"user":{"ID":5}}'); + window.localStorage.setItem("user", '{"ID":5,"Name":"foo"}'); + window.localStorage.setItem("session.user", '{"ID":5,"Name":"foo"}'); + + window.sessionStorage.setItem("session.token", "other-token"); + window.sessionStorage.setItem("sessionId", "other-session-id"); + window.sessionStorage.setItem("provider", "other-provider"); + window.sessionStorage.setItem("session.scope", "other-scope"); + window.sessionStorage.setItem("sessionData", '{"user":{"ID":9}}'); + window.sessionStorage.setItem("session.data", '{"user":{"ID":9}}'); + window.sessionStorage.setItem("user", '{"ID":9,"Name":"bar"}'); + window.sessionStorage.setItem("session.user", '{"ID":9,"Name":"bar"}'); + + session.reset(); + + expect(window.localStorage.getItem("session.token")).toBeNull(); + expect(window.localStorage.getItem("authToken")).toBeNull(); + expect(window.localStorage.getItem("session.id")).toBeNull(); + expect(window.localStorage.getItem("sessionId")).toBeNull(); + expect(window.localStorage.getItem("session_id")).toBeNull(); + expect(window.localStorage.getItem("provider")).toBeNull(); + expect(window.localStorage.getItem("session.provider")).toBeNull(); + expect(window.localStorage.getItem("session.scope")).toBeNull(); + expect(window.localStorage.getItem("sessionData")).toBeNull(); + expect(window.localStorage.getItem("session.data")).toBeNull(); + expect(window.localStorage.getItem("user")).toBeNull(); + expect(window.localStorage.getItem("session.user")).toBeNull(); + + expect(window.sessionStorage.getItem("session.token")).toBeNull(); + expect(window.sessionStorage.getItem("sessionId")).toBeNull(); + expect(window.sessionStorage.getItem("provider")).toBeNull(); + expect(window.sessionStorage.getItem("session.scope")).toBeNull(); + expect(window.sessionStorage.getItem("sessionData")).toBeNull(); + expect(window.sessionStorage.getItem("session.data")).toBeNull(); + expect(window.sessionStorage.getItem("user")).toBeNull(); + expect(window.sessionStorage.getItem("session.user")).toBeNull(); + }); + + it("should discard malformed stored json values", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-bad-json"; + const namespaced = buildNamespace(namespaceKey); + rawStorage.setItem(namespaced + "session.token", "999900000000000000000000000000000000000000000000"); + rawStorage.setItem(namespaced + "session.id", "a9b8ff820bf40ab451910f8bbfe401b2432446693aa539538fbd2399560a722f"); + rawStorage.setItem(namespaced + "session.user", "{bad json"); + + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, createConfig("/library", namespaceKey)); + + expect(session.getAuthToken()).toBe("999900000000000000000000000000000000000000000000"); + expect(session.getUser().hasId()).toBe(false); + expect(rawStorage.getItem(namespaced + "session.user")).toBe(null); + }); + it("should test redeem token", async () => { const storage = new StorageShim(); const session = new Session(storage, $config); @@ -326,4 +528,589 @@ describe("common/session", () => { expect(session.data.token).toBe("123token"); session.deleteData(); }); + + describe("login redirect persistence", () => { + // The OIDC roundtrip hard-navigates the browser through the IdP and back, + // which wipes every in-memory property on the Session instance. The deep + // link must survive in namespaced localStorage so the post-callback boot + // can return the user to the originally-requested page. + it("persists the redirect URL to namespaced storage so it survives a fresh Session instance", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-redirect"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const original = new Session(storage, createConfig("/library", namespaceKey)); + + original.setLoginRedirectUrl("/library/albums/at1sqs7gr75pl5r7/view"); + expect(rawStorage.getItem(buildNamespace(namespaceKey) + "login.next")).toBe("/library/albums/at1sqs7gr75pl5r7/view"); + + // Simulate the OIDC roundtrip: a brand-new Session reads from storage. + const reborn = new Session(storage, createConfig("/library", namespaceKey)); + expect(reborn.getLoginRedirectUrl(null)).toBe("/library/albums/at1sqs7gr75pl5r7/view"); + }); + + it("clears the persisted redirect URL on clearLoginRedirectUrl()", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-redirect-clear"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, createConfig("/library", namespaceKey)); + + session.setLoginRedirectUrl("/library/people"); + session.clearLoginRedirectUrl(); + expect(rawStorage.getItem(buildNamespace(namespaceKey) + "login.next")).toBeNull(); + expect(session.getLoginRedirectUrl(null)).toBeNull(); + }); + + // hasLoginRedirectUrl() is the deep-link arrival signal the /login + // route guard uses to decide whether to auto-bounce through OIDC. A + // stored URL means the global router guard sent the user here from a + // protected page; no URL means the user opened /login directly. + it("hasLoginRedirectUrl() reports the deep-link arrival signal across the OIDC roundtrip", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-redirect-has"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, createConfig("/library", namespaceKey)); + + expect(session.hasLoginRedirectUrl()).toBe(false); + + session.setLoginRedirectUrl("/library/albums/at1sqs7gr75pl5r7/view"); + expect(session.hasLoginRedirectUrl()).toBe(true); + + // A brand-new Session (the post-OIDC reboot) still sees the signal + // from namespaced storage even though in-memory state is fresh. + const reborn = new Session(storage, createConfig("/library", namespaceKey)); + expect(reborn.hasLoginRedirectUrl()).toBe(true); + + reborn.clearLoginRedirectUrl(); + expect(reborn.hasLoginRedirectUrl()).toBe(false); + }); + + it("returns the default URL when no redirect is recorded", () => { + const storage = new StorageShim(); + const session = new Session(storage, $config); + expect(session.getLoginRedirectUrl("/")).toBe("/"); + expect(session.getLoginRedirectUrl(null)).toBeNull(); + }); + + // Defends against null/undefined/whitespace inputs and crafted + // ?return_to=/login URLs. Storing a login page as the deep-link target + // would either no-op the post-login redirect (same-URL guard in + // view.redirect) or re-trigger auto-OIDC forever. + it("rejects invalid post-login redirect URLs via invalidRedirectUrl", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-redirect-valid-guard"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, createConfig("/library", namespaceKey)); + + // Direct helper checks: rejected inputs. + expect(session.invalidRedirectUrl(null)).toBe(true); + expect(session.invalidRedirectUrl(undefined)).toBe(true); + expect(session.invalidRedirectUrl("")).toBe(true); + expect(session.invalidRedirectUrl(" ")).toBe(true); + expect(session.invalidRedirectUrl(42)).toBe(true); + expect(session.invalidRedirectUrl("/portal/login")).toBe(true); + expect(session.invalidRedirectUrl("/library/login?return_to=evil")).toBe(true); + expect(session.invalidRedirectUrl("/library/login/")).toBe(true); + + // Direct helper checks: accepted inputs. + expect(session.invalidRedirectUrl("/library/photos")).toBe(false); + expect(session.invalidRedirectUrl("/api/v1/oauth/authorize?client_id=x")).toBe(false); + + // setLoginRedirectUrl gates on the helper. + session.setLoginRedirectUrl("/portal/login"); + expect(session.hasLoginRedirectUrl()).toBe(false); + session.setLoginRedirectUrl(" "); + expect(session.hasLoginRedirectUrl()).toBe(false); + session.setLoginRedirectUrl(null); + expect(session.hasLoginRedirectUrl()).toBe(false); + + // Non-login deep links still record normally. + session.setLoginRedirectUrl("/library/photos"); + expect(session.getLoginRedirectUrl(null)).toBe("/library/photos"); + }); + + it("clears any stale redirect on logout so a fresh session does not return to the previous deep link", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-redirect-logout"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, createConfig("/library", namespaceKey)); + + session.setLoginRedirectUrl("/library/albums/old/view"); + session.onLogout(true); + + expect(rawStorage.getItem(buildNamespace(namespaceKey) + "login.next")).toBeNull(); + }); + }); + + describe("logout redirect target", () => { + // A cluster-OIDC sign-out lands directly on the Portal login page (re-auth → + // instance chooser) so the just-left instance is never pinned as return_to; + // everyone else stays on the local form. + const oidcLoginUri = "/library/api/v1/oidc/login"; + const portalLoginUri = "https://app.example.com/portal/login"; + + // clusterOidcConfig builds a config whose ext.oidc advertises cluster OIDC. + const clusterOidcConfig = (namespaceKey, { cluster = true, loginUri = oidcLoginUri, portalUri = portalLoginUri } = {}) => { + const config = createConfig("/library", namespaceKey); + config.loginUri = "/library/login"; + config.values.ext = { ...(config.values.ext || {}), oidc: { enabled: true, redirect: true, cluster, loginUri, portalLoginUri: portalUri } }; + return config; + }; + + it("redirects a cluster-OIDC session to the Portal login page", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-logout-cluster-oidc"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, clusterOidcConfig(namespaceKey)); + session.provider = "oidc"; + const spy = vi.spyOn(session, "followRedirect").mockImplementation(() => {}); + + session.onLogout(); + + expect(spy).toHaveBeenCalledWith(portalLoginUri); + }); + + it("falls back to the local login when the Portal login page is unknown", () => { + // The instance OIDC roundtrip must never be re-initiated on sign-out — + // it would pin the Portal login's return_to to the just-left instance. + const rawStorage = new StorageShim(); + const namespaceKey = "ns-logout-cluster-oidc-fallback"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, clusterOidcConfig(namespaceKey, { portalUri: "" })); + session.provider = "oidc"; + const spy = vi.spyOn(session, "followRedirect").mockImplementation(() => {}); + + session.onLogout(); + + expect(spy).toHaveBeenCalledWith("/library/login"); + }); + + it("captures the provider before reset() clears it", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-logout-provider-captured"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, clusterOidcConfig(namespaceKey)); + session.provider = "oidc"; + const spy = vi.spyOn(session, "followRedirect").mockImplementation(() => {}); + + session.onLogout(); + + // reset() runs inside onLogout and clears the provider, yet the redirect + // still targets the Portal login because the target was resolved first. + expect(session.provider).toBe(""); + expect(spy).toHaveBeenCalledWith(portalLoginUri); + }); + + it("redirects a local session to the local login page", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-logout-local"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, clusterOidcConfig(namespaceKey)); + session.provider = "local"; + const spy = vi.spyOn(session, "followRedirect").mockImplementation(() => {}); + + session.onLogout(); + + expect(spy).toHaveBeenCalledWith("/library/login"); + }); + + it("redirects an external-IdP OIDC session to the local login page", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-logout-external-oidc"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, clusterOidcConfig(namespaceKey, { cluster: false })); + session.provider = "oidc"; + const spy = vi.spyOn(session, "followRedirect").mockImplementation(() => {}); + + session.onLogout(); + + expect(spy).toHaveBeenCalledWith("/library/login"); + }); + + it("prefers a backend-provided provider logout URL over the local target", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-logout-provider-uri"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, clusterOidcConfig(namespaceKey, { cluster: false })); + session.provider = "oidc"; + const spy = vi.spyOn(session, "followRedirect").mockImplementation(() => {}); + + const providerLogoutUri = "https://keycloak.localssl.dev/realms/master/protocol/openid-connect/logout?id_token_hint=abc"; + session.onLogout(false, providerLogoutUri); + + expect(spy).toHaveBeenCalledWith(providerLogoutUri); + }); + }); + + describe("logout RP-initiated provider redirect", () => { + it("passes providerLogoutUri from the DELETE response to onLogout", async () => { + const storage = new StorageShim(); + const session = new Session(storage, createConfig("/library", "ns-logout-rp")); + session.setAuthToken("999900000000000000000000000000000000000000000000"); + session.applyId("a9b8ff820bf40ab451910f8bbfe401b2432446693aa539538fbd2399560a722f"); + session.user = new (session.user.constructor)({ ID: 7, Name: "x", DisplayName: "X" }); + expect(session.isAuthenticated()).toBe(true); + + const providerLogoutUri = "https://keycloak.localssl.dev/realms/master/protocol/openid-connect/logout?id_token_hint=abc"; + const deleteSpy = vi.spyOn($api, "delete").mockResolvedValue({ data: { status: "deleted", providerLogoutUri } }); + const onLogoutSpy = vi.spyOn(session, "onLogout").mockReturnValue(Promise.resolve()); + + await session.logout(); + + expect(deleteSpy).toHaveBeenCalledWith("session"); + expect(onLogoutSpy).toHaveBeenCalledWith(undefined, providerLogoutUri); + deleteSpy.mockRestore(); + }); + + it("falls back to local logout when the response carries no provider URL", async () => { + const storage = new StorageShim(); + const session = new Session(storage, createConfig("/library", "ns-logout-rp-none")); + session.setAuthToken("999900000000000000000000000000000000000000000000"); + session.applyId("a9b8ff820bf40ab451910f8bbfe401b2432446693aa539538fbd2399560a722f"); + session.user = new (session.user.constructor)({ ID: 7, Name: "x", DisplayName: "X" }); + + const deleteSpy = vi.spyOn($api, "delete").mockResolvedValue({ data: { status: "deleted" } }); + const onLogoutSpy = vi.spyOn(session, "onLogout").mockReturnValue(Promise.resolve()); + + await session.logout(); + + expect(onLogoutSpy).toHaveBeenCalledWith(undefined, undefined); + deleteSpy.mockRestore(); + }); + }); + + describe("signOut", () => { + // /logout is a SPA route that runs in vue-router's beforeEnter, so it must + // reset client-side session state synchronously — otherwise the login + // route's guard would still see an authenticated user and bounce to the + // default page. + it("synchronously clears session state so the next route guard sees an unauthenticated user", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-signout-sync"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, createConfig("/library", namespaceKey)); + session.setAuthToken("999900000000000000000000000000000000000000000000"); + session.applyId("a9b8ff820bf40ab451910f8bbfe401b2432446693aa539538fbd2399560a722f"); + session.user = new (session.user.constructor)({ ID: 7, Name: "x", DisplayName: "X" }); + + expect(session.isAuthenticated()).toBe(true); + session.signOut(); + expect(session.isAuthenticated()).toBe(false); + expect(session.getAuthToken()).toBeNull(); + }); + + it("raises the one-shot logout flag so a direct /logout visit suppresses auto-OIDC", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-signout-flag"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, createConfig("/library", namespaceKey)); + + session.signOut(); + expect(rawStorage.getItem(buildNamespace(namespaceKey) + "login.logout")).toBe("1"); + }); + }); + + describe("logout signal", () => { + // The one-shot logout flag tells the login page to skip a single + // auto-OIDC bounce so an explicit logout actually shows the login form + // when PHOTOPRISM_OIDC_REDIRECT is enabled. + it("raises a one-shot flag on logout that consumeLogoutSignal() reads and clears", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-logout-signal"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, createConfig("/library", namespaceKey)); + + expect(session.consumeLogoutSignal()).toBe(false); + + session.onLogout(true); + expect(rawStorage.getItem(buildNamespace(namespaceKey) + "login.logout")).toBe("1"); + + // First read consumes the flag; subsequent reads are false. + expect(session.consumeLogoutSignal()).toBe(true); + expect(session.consumeLogoutSignal()).toBe(false); + expect(rawStorage.getItem(buildNamespace(namespaceKey) + "login.logout")).toBeNull(); + }); + }); + + describe("OIDC attempt one-shot", () => { + // The /login route guard uses markOidcAttempt + consumeOidcAttempt to cap + // auto-OIDC at one attempt per browser tab. Without it, a deep-link target + // persisted to localStorage during a failed/abandoned OIDC roundtrip would + // re-trigger the redirect on every subsequent /login visit, locking the + // user out of the local form indefinitely. + it("markOidcAttempt sets a one-shot flag in namespaced sessionStorage", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-oidc-attempt-set"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, createConfig("/library", namespaceKey)); + + session.markOidcAttempt(); + const key = buildNamespace(namespaceKey) + "login.oidc.attempt"; + expect(window.sessionStorage.getItem(key)).toBe("1"); + }); + + it("consumeOidcAttempt returns true once then false", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-oidc-attempt-consume"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, createConfig("/library", namespaceKey)); + + expect(session.consumeOidcAttempt()).toBe(false); + + session.markOidcAttempt(); + expect(session.consumeOidcAttempt()).toBe(true); + expect(session.consumeOidcAttempt()).toBe(false); + + const key = buildNamespace(namespaceKey) + "login.oidc.attempt"; + expect(window.sessionStorage.getItem(key)).toBeNull(); + }); + + it("clearLoginRedirectUrl also clears the OIDC attempt so the next deep link can retry", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-oidc-attempt-paired"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, createConfig("/library", namespaceKey)); + + session.setLoginRedirectUrl("/library/people"); + session.markOidcAttempt(); + session.clearLoginRedirectUrl(); + + const key = buildNamespace(namespaceKey) + "login.oidc.attempt"; + expect(window.sessionStorage.getItem(key)).toBeNull(); + expect(session.consumeOidcAttempt()).toBe(false); + }); + + it("onLogout clears the OIDC attempt alongside the deep link target", () => { + const rawStorage = new StorageShim(); + const namespaceKey = "ns-oidc-attempt-logout"; + const storage = createNamespacedStorage(rawStorage, namespaceKey); + const session = new Session(storage, createConfig("/library", namespaceKey)); + + session.markOidcAttempt(); + session.onLogout(true); + + const key = buildNamespace(namespaceKey) + "login.oidc.attempt"; + expect(window.sessionStorage.getItem(key)).toBeNull(); + }); + }); + + describe("Photo cache invalidation on reset", () => { + // Session.reset() dynamically imports model/photo and calls + // Photo.clearCache() so metadata fetched under one role cannot leak + // to another after logout, login, or role change. Pin the contract + // here because the cache lives in a separate module and is wired + // up via a runtime import — easy to break without noticing. + it("clears the Photo LRU cache when reset() runs", async () => { + const storage = new StorageShim(); + const session = new Session(storage, $config); + + Photo._cache.clear(); + Photo._cache.set("uid-pre-reset", { UID: "uid-pre-reset", Title: "Cached" }); + expect(Photo._cache.has("uid-pre-reset")).toBe(true); + + session.reset(); + + // The dynamic import resolves on the microtask queue. + await flushMicrotasks(); + + expect(Photo._cache.has("uid-pre-reset")).toBe(false); + }); + + // End-to-end repro of the post-logout race spec Open Question #1 + // describes: an in-flight Photo.findCached() under role A must + // neither re-seed Photo._cache after Session.reset() has wiped it + // NOR resolve to role-A data that a caller's .then handler could + // route into role-B UI. The ModelCache epoch counter rejects the + // stale fetch so both guarantees hold. + it("rejects in-flight findCached() after reset() so neither cache nor UI sees role-A data", async () => { + const storage = new StorageShim(); + const session = new Session(storage, $config); + + Photo._cache.clear(); + + let resolveFind; + const findSpy = vi.spyOn(Photo.prototype, "find").mockImplementation( + () => + new Promise((res) => { + resolveFind = res; + }) + ); + + // Open the sidebar under role A — issues Photo.findCached(). + const inFlight = Photo.findCached("uid-leak"); + // Let the loader actually run. + await Promise.resolve(); + + // Logout while the request is still pending. + session.reset(); + await flushMicrotasks(); + expect(Photo._cache.size()).toBe(0); + + // Backend response from role A finally arrives. + resolveFind(new Photo({ UID: "uid-leak", Title: "Role A" })); + + // The promise rejects — both guarantees hold: + // 1. cache stays empty (next read reissues under role B) + // 2. waiter's .then never fires (no role-A data into UI) + await expect(inFlight).rejects.toThrow(/stale fetch/i); + expect(Photo._cache.has("uid-leak")).toBe(false); + expect(Photo._cache.size()).toBe(0); + + findSpy.mockRestore(); + }); + }); + + // A10 contract: isUser / isAdmin / isSuperAdmin must always return a Boolean, + // so bindings like `:disabled="isAdmin"` never pass null/undefined to a + // Vuetify Boolean prop. See specs/frontend/best-practices.md#a10. + describe("isUser / isAdmin / isSuperAdmin Boolean contract", () => { + it("return Boolean false when no user is loaded", () => { + const session = new Session(new StorageShim(), $config); + for (const fn of ["isUser", "isAdmin", "isSuperAdmin"]) { + const result = session[fn](); + expect(typeof result, fn).toBe("boolean"); + expect(result, fn).toBe(false); + } + }); + it("return Boolean true for an admin user (super-admin only for isSuperAdmin)", () => { + const session = new Session(new StorageShim(), $config); + session.setData({ user: { ID: 1, Name: "admin", Role: "admin", SuperAdmin: true } }); + for (const fn of ["isUser", "isAdmin", "isSuperAdmin"]) { + expect(typeof session[fn](), fn).toBe("boolean"); + expect(session[fn](), fn).toBe(true); + } + session.deleteData(); + }); + it("isSuperAdmin returns Boolean false for a non-super admin", () => { + const session = new Session(new StorageShim(), $config); + session.setData({ user: { ID: 2, Name: "ops", Role: "admin", SuperAdmin: false } }); + expect(typeof session.isSuperAdmin()).toBe("boolean"); + expect(session.isSuperAdmin()).toBe(false); + session.deleteData(); + }); + }); + + describe("logoutEverywhere", () => { + it("revokes each peer session server-side, clears their storage, then signs out locally", async () => { + // Mirror the app: Session is constructed with a NamespacedStorage wrapper + // (getAppStorage), so logoutEverywhere must unwrap to the raw backend. + const raw = new StorageShim(); + const appStorage = createNamespacedStorage(raw, "ns-current"); + const session = new Session(appStorage, createConfig("/", "ns-current")); + + // Seed two peer sessions directly in the raw backend, as the app stores them. + const pro2 = buildNamespace("ns-pro-2"); + const portal = buildNamespace("ns-portal"); + raw.setItem(pro2 + "session.token", "tok2"); + raw.setItem(pro2 + "instance.url", "https://app.example.com/i/pro-2/"); + raw.setItem(portal + "session.token", "tokp"); + raw.setItem(portal + "instance.url", "https://app.example.com/"); + + const fetchCalls = []; + const originalFetch = window.fetch; + window.fetch = (url, opts) => { + fetchCalls.push({ url, token: opts?.headers?.["X-Auth-Token"], method: opts?.method }); + return Promise.resolve({ ok: true }); + }; + const logoutSpy = vi.spyOn(session, "logout").mockResolvedValue(undefined); + + try { + await session.logoutEverywhere(true); + } finally { + window.fetch = originalFetch; + } + + // Both peers were revoked with their own token via DELETE. + expect(fetchCalls).toHaveLength(2); + expect(fetchCalls.every((c) => c.method === "DELETE")).toBe(true); + expect(fetchCalls.map((c) => c.url).sort()).toEqual([ + "https://app.example.com/api/v1/session", + "https://app.example.com/i/pro-2/api/v1/session", + ]); + expect(fetchCalls.find((c) => c.url.includes("pro-2")).token).toBe("tok2"); + // Peer storage was cleared from the raw backend (no double-prefixed leftovers). + expect(raw.getItem(pro2 + "session.token")).toBeNull(); + expect(raw.getItem(portal + "session.token")).toBeNull(); + expect(raw.getItem(pro2 + "instance.url")).toBeNull(); + expect(logoutSpy).toHaveBeenCalledWith(true); + }); + + it("still signs out locally on a standalone deployment with no peers", async () => { + const storage = new StorageShim(); + const session = new Session(storage, createConfig("/", "ns-current")); + const logoutSpy = vi.spyOn(session, "logout").mockResolvedValue(undefined); + await session.logoutEverywhere(); + expect(logoutSpy).toHaveBeenCalledTimes(1); + }); + + it("signOut revokes peers and clears their storage for the /logout route guard", () => { + // The /logout route guard calls signOut() synchronously; it must still fan + // out the cluster-wide revocation, not just drop the current session. + const raw = new StorageShim(); + const appStorage = createNamespacedStorage(raw, "ns-current"); + const session = new Session(appStorage, createConfig("/", "ns-current")); + + const pro2 = buildNamespace("ns-pro-2"); + raw.setItem(pro2 + "session.token", "tok2"); + raw.setItem(pro2 + "instance.url", "https://app.example.com/i/pro-2/"); + + const fetchCalls = []; + const originalFetch = window.fetch; + window.fetch = (url, opts) => { + fetchCalls.push({ url, method: opts?.method, token: opts?.headers?.["X-Auth-Token"] }); + return Promise.resolve({ ok: true }); + }; + const onLogoutSpy = vi.spyOn(session, "onLogout").mockReturnValue(Promise.resolve()); + + try { + // Synchronous: returns this so the route guard can proceed immediately. + expect(session.signOut()).toBe(session); + } finally { + window.fetch = originalFetch; + } + + // The peer was revoked server-side and its storage cleared synchronously. + expect(fetchCalls).toEqual([{ url: "https://app.example.com/i/pro-2/api/v1/session", method: "DELETE", token: "tok2" }]); + expect(raw.getItem(pro2 + "session.token")).toBeNull(); + expect(onLogoutSpy).toHaveBeenCalledWith(true); + }); + + it("delegates the Portal session to the Portal OP on a cluster-OIDC Sign-Out (no instance-side Portal DELETE)", async () => { + // With RP-initiated logout enabled, the instance must NOT revoke the Portal + // session itself — the Portal's end-session endpoint ends it and performs the + // upstream RP-logout. The instance still revokes peer instances and clears all + // peer storage (including the Portal's stale token). + const raw = new StorageShim(); + const appStorage = createNamespacedStorage(raw, "ns-current"); + const config = createConfig("/library", "ns-current"); + config.values.ext = { oidc: { enabled: true, cluster: true, logout: true, portalLoginUri: "https://app.example.com/portal/login" } }; + const session = new Session(appStorage, config); + session.provider = "oidc"; + + const pro2 = buildNamespace("ns-pro-2"); + const portal = buildNamespace("ns-portal"); + raw.setItem(pro2 + "session.token", "tok2"); + raw.setItem(pro2 + "instance.url", "https://app.example.com/i/pro-2/"); + raw.setItem(portal + "session.token", "tokp"); + raw.setItem(portal + "instance.url", "https://app.example.com/"); + raw.setItem(portal + "instance.portal", "true"); // Portal flags its own session + + const fetchCalls = []; + const originalFetch = window.fetch; + window.fetch = (url, opts) => { + fetchCalls.push({ url, method: opts?.method }); + return Promise.resolve({ ok: true }); + }; + try { + await session.revokePeerSessions(); + } finally { + window.fetch = originalFetch; + } + + // Only the peer instance was DELETEd; the Portal session was NOT revoked here. + expect(fetchCalls).toEqual([{ url: "https://app.example.com/i/pro-2/api/v1/session", method: "DELETE" }]); + // Both peers' local storage is still cleared, including the Portal's stale token. + expect(raw.getItem(pro2 + "session.token")).toBeNull(); + expect(raw.getItem(portal + "session.token")).toBeNull(); + }); + }); }); diff --git a/frontend/tests/vitest/common/sphere.test.js b/frontend/tests/vitest/common/sphere.test.js new file mode 100644 index 000000000..5cee61378 --- /dev/null +++ b/frontend/tests/vitest/common/sphere.test.js @@ -0,0 +1,113 @@ +import "../fixtures"; +import { expect, describe, it, vi, beforeEach } from "vitest"; + +const { viewerCtor, destroySpy } = vi.hoisted(() => ({ + viewerCtor: vi.fn(), + destroySpy: vi.fn(), +})); + +vi.mock("@photo-sphere-viewer/core", () => ({ + Viewer: function Viewer(cfg) { + viewerCtor(cfg); + this.destroy = destroySpy; + }, +})); + +vi.mock("@photo-sphere-viewer/video-plugin", () => ({ + VideoPlugin: function VideoPlugin() {}, +})); + +vi.mock("@photo-sphere-viewer/equirectangular-video-adapter", () => ({ + EquirectangularVideoAdapter: function EquirectangularVideoAdapter() {}, +})); + +vi.mock("@photo-sphere-viewer/core/index.css", () => ({})); +vi.mock("@photo-sphere-viewer/video-plugin/index.css", () => ({})); + +import { createSphereViewer, destroySphereViewer, is360Equirectangular } from "common/sphere"; + +describe("common/sphere is360Equirectangular", () => { + it("is true for an explicit equirectangular projection without known dimensions", () => { + expect(is360Equirectangular({ Type: "image", Projection: "equirectangular" })).toBe(true); + expect(is360Equirectangular({ Type: "video", Projection: "equirectangular" })).toBe(true); + }); + it("is true for an explicit equirectangular projection with ~2:1 dimensions", () => { + expect(is360Equirectangular({ Type: "image", Projection: "equirectangular", Width: 6656, Height: 3328 })).toBe(true); + expect(is360Equirectangular({ Type: "image", Projection: "equirectangular", Width: 15520, Height: 7760 })).toBe(true); + }); + it("is false for an equirectangular-tagged frame that is clearly not 2:1 (partial/cylindrical panorama)", () => { + expect(is360Equirectangular({ Type: "image", Projection: "equirectangular", Width: 8192, Height: 1024 })).toBe(false); + expect(is360Equirectangular({ Type: "video", Projection: "equirectangular", Width: 8192, Height: 1024 })).toBe(false); + }); + it("is false for any other non-empty projection", () => { + expect(is360Equirectangular({ Type: "video", Projection: "cubemap", Panorama: true, Width: 3840, Height: 1920 })).toBe(false); + expect(is360Equirectangular({ Type: "image", Projection: "cubestrip" })).toBe(false); + }); + it("falls back to the 2:1 frame for a panorama video without a projection tag", () => { + expect(is360Equirectangular({ Type: "video", Panorama: true, Width: 3840, Height: 1920 })).toBe(true); + expect(is360Equirectangular({ Type: "video", Panorama: true, Width: 4096, Height: 2048 })).toBe(true); + }); + it("is false for a wide non-2:1 video (ultrawide) even when panorama-flagged", () => { + expect(is360Equirectangular({ Type: "video", Panorama: true, Width: 3840, Height: 1632 })).toBe(false); + }); + it("is false for a 2:1 video that is not panorama-flagged", () => { + expect(is360Equirectangular({ Type: "video", Panorama: false, Width: 3840, Height: 1920 })).toBe(false); + }); + it("does not apply the 2:1 fallback to photos (projection only)", () => { + expect(is360Equirectangular({ Type: "image", Panorama: true, Width: 3840, Height: 1920 })).toBe(false); + }); + it("is false for empty, null, or dimensionless input", () => { + expect(is360Equirectangular(null)).toBe(false); + expect(is360Equirectangular({})).toBe(false); + expect(is360Equirectangular({ Type: "video", Panorama: true })).toBe(false); + }); +}); + +describe("common/sphere", () => { + beforeEach(() => { + viewerCtor.mockClear(); + destroySpy.mockClear(); + }); + + it("photo path constructs Viewer with panorama option", async () => { + const container = document.createElement("div"); + const viewer = await createSphereViewer(container, "/photo.jpg"); + expect(viewerCtor).toHaveBeenCalledOnce(); + expect(viewerCtor.mock.calls[0][0]).toMatchObject({ + container, + panorama: "/photo.jpg", + keyboard: "always", + defaultYaw: 0, + defaultPitch: 0, + }); + expect(viewer).toBeDefined(); + }); + + it("video path wires VideoPlugin and equirectangular adapter", async () => { + const container = document.createElement("div"); + await createSphereViewer(container, "/video.mp4", { isVideo: true }); + expect(viewerCtor).toHaveBeenCalledOnce(); + const cfg = viewerCtor.mock.calls[0][0]; + expect(cfg.panorama).toEqual({ source: "/video.mp4" }); + expect(cfg.plugins).toHaveLength(1); + expect(cfg.adapter).toHaveLength(2); + }); + + it("destroySphereViewer calls viewer.destroy exactly once", async () => { + const container = document.createElement("div"); + const viewer = await createSphereViewer(container, "/photo.jpg"); + destroySphereViewer(viewer); + expect(destroySpy).toHaveBeenCalledOnce(); + }); + + it("destroySphereViewer is safe on null", () => { + expect(() => destroySphereViewer(null)).not.toThrow(); + expect(() => destroySphereViewer(undefined)).not.toThrow(); + expect(destroySpy).not.toHaveBeenCalled(); + }); + + it("destroySphereViewer is safe on viewer without destroy method", () => { + expect(() => destroySphereViewer({})).not.toThrow(); + expect(destroySpy).not.toHaveBeenCalled(); + }); +}); diff --git a/frontend/tests/vitest/common/storage.test.js b/frontend/tests/vitest/common/storage.test.js index 5e4bca023..aa83017b8 100644 --- a/frontend/tests/vitest/common/storage.test.js +++ b/frontend/tests/vitest/common/storage.test.js @@ -33,25 +33,39 @@ describe("common/storage", () => { expect(storage.getItem("photos.view")).toBe("legacy-view"); expect(storage.getItem(namespace + "photos.view")).toBeNull(); - storage.setItem("clipboard.photos", "[\"p123\"]"); - storage.setItem(namespace + "clipboard.photos", "[\"p456\"]"); + storage.setItem("clipboard.photos", '["p123"]'); + storage.setItem(namespace + "clipboard.photos", '["p456"]'); ns.removeItem("clipboard.photos"); expect(storage.getItem("clipboard.photos")).toBeNull(); expect(storage.getItem(namespace + "clipboard.photos")).toBeNull(); - storage.setItem("clipboard", "[\"legacy\"]"); - storage.setItem(namespace + "clipboard", "[\"namespaced\"]"); + storage.setItem("clipboard", '["legacy"]'); + storage.setItem(namespace + "clipboard", '["namespaced"]'); ns.removeItem("clipboard"); expect(storage.getItem("clipboard")).toBeNull(); expect(storage.getItem(namespace + "clipboard")).toBeNull(); - storage.setItem("clipboard.albums", "[\"a123\"]"); - storage.setItem(namespace + "clipboard.albums", "[\"a456\"]"); + storage.setItem("clipboard.albums", '["a123"]'); + storage.setItem(namespace + "clipboard.albums", '["a456"]'); ns.removeItem("clipboard.albums"); expect(storage.getItem("clipboard.albums")).toBeNull(); expect(storage.getItem(namespace + "clipboard.albums")).toBeNull(); }); + it("can remove namespaced keys without clearing legacy keys", () => { + const storage = new StorageShim(); + const namespace = buildNamespace("ns-pro-1"); + const ns = createNamespacedStorage(storage, "ns-pro-1"); + + storage.setItem("session.token", "legacy"); + storage.setItem(namespace + "session.token", "namespaced"); + + ns.removeItem("session.token", { legacy: false }); + + expect(storage.getItem("session.token")).toBe("legacy"); + expect(storage.getItem(namespace + "session.token")).toBeNull(); + }); + it("supports an explicit namespace key", () => { const storage = new StorageShim(); const namespace = buildNamespace("abc123"); @@ -74,5 +88,4 @@ describe("common/storage", () => { expect(map.get("ns-b")).toBe("token-b"); expect(map.get("/")).toBe("legacy-root"); }); - }); diff --git a/frontend/tests/vitest/common/typeahead-cache.test.js b/frontend/tests/vitest/common/typeahead-cache.test.js new file mode 100644 index 000000000..3d1091466 --- /dev/null +++ b/frontend/tests/vitest/common/typeahead-cache.test.js @@ -0,0 +1,532 @@ +import { describe, it, expect, beforeEach, vi } from "vitest"; +import Album from "model/album"; +import Label from "model/label"; +import Subject from "model/subject"; +import $event from "common/event"; +import { typeaheadCache, CAP } from "common/typeahead-cache"; + +beforeEach(() => { + typeaheadCache.clear(); + vi.restoreAllMocks(); +}); + +describe("typeaheadCache.getLabels", () => { + it("fetches labels on first call and caches the result", async () => { + const models = [{ Name: "Cat", UID: "lbl-cat" }]; + const spy = vi.spyOn(Label, "search").mockResolvedValueOnce({ models }); + + const first = await typeaheadCache.getLabels(); + const second = await typeaheadCache.getLabels(); + + expect(first).toEqual(models); + expect(second).toEqual(models); + expect(spy).toHaveBeenCalledTimes(1); + expect(spy).toHaveBeenCalledWith({ count: CAP, order: "name", all: true }); + }); + + it("dedupes concurrent in-flight calls into one network request", async () => { + let resolveFn; + const spy = vi + .spyOn(Label, "search") + .mockImplementationOnce(() => new Promise((resolve) => (resolveFn = resolve))); + + const p1 = typeaheadCache.getLabels(); + const p2 = typeaheadCache.getLabels(); + expect(spy).toHaveBeenCalledTimes(1); + + const models = [{ Name: "Dog", UID: "lbl-dog" }]; + resolveFn({ models }); + await expect(p1).resolves.toEqual(models); + await expect(p2).resolves.toEqual(models); + expect(spy).toHaveBeenCalledTimes(1); + }); + + it("re-fetches after labels.updated WS event evicts the cache", async () => { + const first = [{ Name: "First", UID: "lbl-1" }]; + const second = [{ Name: "Second", UID: "lbl-2" }]; + const spy = vi + .spyOn(Label, "search") + .mockResolvedValueOnce({ models: first }) + .mockResolvedValueOnce({ models: second }); + + expect(await typeaheadCache.getLabels()).toEqual(first); + $event.publishSync("labels.updated", { entities: [] }); + expect(await typeaheadCache.getLabels()).toEqual(second); + expect(spy).toHaveBeenCalledTimes(2); + }); + + // Pins the create-channel subscription. Without this, freshly added + // labels (e.g. typing 你好 in the sidebar combobox when no such label + // exists yet) would stay invisible to subsequent typeahead consumers + // until something else evicted the cache. + it("re-fetches after labels.created WS event evicts the cache", async () => { + const first = [{ Name: "Existing", UID: "lbl-1" }]; + const second = [ + { Name: "Existing", UID: "lbl-1" }, + { Name: "你好", UID: "lbl-2" }, + ]; + const spy = vi + .spyOn(Label, "search") + .mockResolvedValueOnce({ models: first }) + .mockResolvedValueOnce({ models: second }); + + expect(await typeaheadCache.getLabels()).toEqual(first); + $event.publishSync("labels.created", { entities: [{ UID: "lbl-2", Name: "你好" }] }); + expect(await typeaheadCache.getLabels()).toEqual(second); + expect(spy).toHaveBeenCalledTimes(2); + }); + + it("re-fetches after labels.deleted WS event", async () => { + const first = [{ Name: "First", UID: "lbl-1" }]; + const second = []; + const spy = vi + .spyOn(Label, "search") + .mockResolvedValueOnce({ models: first }) + .mockResolvedValueOnce({ models: second }); + + await typeaheadCache.getLabels(); + $event.publishSync("labels.deleted", { entities: ["lbl-1"] }); + expect(await typeaheadCache.getLabels()).toEqual(second); + expect(spy).toHaveBeenCalledTimes(2); + }); + + it("warns when the response equals the cap", async () => { + const models = Array.from({ length: CAP }, (_, i) => ({ Name: `lbl-${i}`, UID: `lbl-uid-${i}` })); + vi.spyOn(Label, "search").mockResolvedValueOnce({ models }); + const warn = vi.spyOn(console, "warn").mockImplementation(() => {}); + await typeaheadCache.getLabels(); + expect(warn).toHaveBeenCalledWith(expect.stringContaining(`Label.search returned ${CAP} results`)); + }); + + it("does not warn when the response is below the cap", async () => { + vi.spyOn(Label, "search").mockResolvedValueOnce({ models: [{ Name: "x", UID: "y" }] }); + const warn = vi.spyOn(console, "warn").mockImplementation(() => {}); + await typeaheadCache.getLabels(); + expect(warn).not.toHaveBeenCalled(); + }); + + it("returns an empty list when the response has no models", async () => { + vi.spyOn(Label, "search").mockResolvedValueOnce({}); + expect(await typeaheadCache.getLabels()).toEqual([]); + }); + + it("propagates rejection and clears the in-flight slot", async () => { + const err = new Error("boom"); + const spy = vi + .spyOn(Label, "search") + .mockRejectedValueOnce(err) + .mockResolvedValueOnce({ models: [{ Name: "After", UID: "lbl-after" }] }); + + await expect(typeaheadCache.getLabels()).rejects.toThrow("boom"); + expect(await typeaheadCache.getLabels()).toEqual([{ Name: "After", UID: "lbl-after" }]); + expect(spy).toHaveBeenCalledTimes(2); + }); +}); + +describe("typeaheadCache.getAlbums", () => { + it("fetches albums on first call and caches the result", async () => { + const models = [{ Title: "Trip", UID: "alb-trip" }]; + const spy = vi.spyOn(Album, "search").mockResolvedValueOnce({ models }); + + const first = await typeaheadCache.getAlbums(); + const second = await typeaheadCache.getAlbums(); + + expect(first).toEqual(models); + expect(second).toEqual(models); + expect(spy).toHaveBeenCalledTimes(1); + expect(spy).toHaveBeenCalledWith({ count: CAP, order: "name", type: "album" }); + }); + + it("re-fetches after albums.updated WS event", async () => { + const first = [{ Title: "First", UID: "alb-1" }]; + const second = [{ Title: "Second", UID: "alb-2" }]; + const spy = vi + .spyOn(Album, "search") + .mockResolvedValueOnce({ models: first }) + .mockResolvedValueOnce({ models: second }); + + await typeaheadCache.getAlbums(); + $event.publishSync("albums.updated", { entities: [] }); + expect(await typeaheadCache.getAlbums()).toEqual(second); + expect(spy).toHaveBeenCalledTimes(2); + }); + + // Mirrors the labels.created test: the entity layer publishes albums.created + // via PublishUserEntities("albums", EntityCreated, …) from Album.Save(), + // and the websocket writer strips the user.. prefix before relaying. + // Without this subscription, brand-new albums would stay invisible to + // every other typeahead consumer in the same browser session. + it("re-fetches after albums.created WS event", async () => { + const first = [{ Title: "Existing", UID: "alb-1" }]; + const second = [ + { Title: "Existing", UID: "alb-1" }, + { Title: "Trip", UID: "alb-2" }, + ]; + const spy = vi + .spyOn(Album, "search") + .mockResolvedValueOnce({ models: first }) + .mockResolvedValueOnce({ models: second }); + + await typeaheadCache.getAlbums(); + $event.publishSync("albums.created", { entities: [{ UID: "alb-2", Title: "Trip" }] }); + expect(await typeaheadCache.getAlbums()).toEqual(second); + expect(spy).toHaveBeenCalledTimes(2); + }); + + it("re-fetches after config.updated (album-delete signal)", async () => { + const first = [{ Title: "First", UID: "alb-1" }]; + const second = []; + const spy = vi + .spyOn(Album, "search") + .mockResolvedValueOnce({ models: first }) + .mockResolvedValueOnce({ models: second }); + + await typeaheadCache.getAlbums(); + $event.publishSync("config.updated", {}); + expect(await typeaheadCache.getAlbums()).toEqual(second); + expect(spy).toHaveBeenCalledTimes(2); + }); + + it("warns when the response equals the cap", async () => { + const models = Array.from({ length: CAP }, (_, i) => ({ Title: `alb-${i}`, UID: `alb-uid-${i}` })); + vi.spyOn(Album, "search").mockResolvedValueOnce({ models }); + const warn = vi.spyOn(console, "warn").mockImplementation(() => {}); + await typeaheadCache.getAlbums(); + expect(warn).toHaveBeenCalledWith(expect.stringContaining(`Album.search returned ${CAP} results`)); + }); +}); + +describe("typeaheadCache.getPeople", () => { + it("fetches people on first call and caches the result", async () => { + const models = [{ Name: "Jane Doe", UID: "ps-1" }]; + const spy = vi.spyOn(Subject, "search").mockResolvedValueOnce({ models }); + + const first = await typeaheadCache.getPeople(); + const second = await typeaheadCache.getPeople(); + + expect(first).toEqual(models); + expect(second).toEqual(models); + expect(spy).toHaveBeenCalledTimes(1); + expect(spy).toHaveBeenCalledWith({ count: CAP, order: "name", type: "person" }); + }); + + it("dedupes concurrent in-flight calls into one network request", async () => { + let resolveFn; + const spy = vi + .spyOn(Subject, "search") + .mockImplementationOnce(() => new Promise((resolve) => (resolveFn = resolve))); + + const p1 = typeaheadCache.getPeople(); + const p2 = typeaheadCache.getPeople(); + expect(spy).toHaveBeenCalledTimes(1); + + const models = [{ Name: "John Roe", UID: "ps-2" }]; + resolveFn({ models }); + await expect(p1).resolves.toEqual(models); + await expect(p2).resolves.toEqual(models); + expect(spy).toHaveBeenCalledTimes(1); + }); + + it("re-fetches after people.updated WS event evicts the cache", async () => { + const first = [{ Name: "First", UID: "ps-1" }]; + const second = [{ Name: "Second", UID: "ps-1" }]; + const spy = vi + .spyOn(Subject, "search") + .mockResolvedValueOnce({ models: first }) + .mockResolvedValueOnce({ models: second }); + + expect(await typeaheadCache.getPeople()).toEqual(first); + $event.publishSync("people.updated", { entities: ["ps-1"] }); + expect(await typeaheadCache.getPeople()).toEqual(second); + expect(spy).toHaveBeenCalledTimes(2); + }); + + it("re-fetches after subjects.updated WS event evicts the cache", async () => { + const first = [{ Name: "First", UID: "ps-1" }]; + const second = [{ Name: "Renamed", UID: "ps-1" }]; + const spy = vi + .spyOn(Subject, "search") + .mockResolvedValueOnce({ models: first }) + .mockResolvedValueOnce({ models: second }); + + expect(await typeaheadCache.getPeople()).toEqual(first); + $event.publishSync("subjects.updated", { entities: ["ps-1"] }); + expect(await typeaheadCache.getPeople()).toEqual(second); + expect(spy).toHaveBeenCalledTimes(2); + }); + + it("tolerates an empty or missing models payload", async () => { + vi.spyOn(Subject, "search").mockResolvedValueOnce({}); + expect(await typeaheadCache.getPeople()).toEqual([]); + }); +}); + +describe("typeaheadCache in-flight eviction (epoch guard)", () => { + // A fetch that is still in flight when the slot is evicted must NOT populate + // the cache when it later resolves; otherwise a websocket eviction landing + // mid-request is silently undone and the next read serves stale data. + it("discards a people fetch that resolves after an eviction", async () => { + let resolveStale; + const spy = vi + .spyOn(Subject, "search") + .mockImplementationOnce(() => new Promise((resolve) => (resolveStale = resolve))) + .mockResolvedValueOnce({ models: [{ Name: "Fresh", UID: "ps-2" }] }); + + const inFlight = typeaheadCache.getPeople(); + typeaheadCache.evictPeople(); + resolveStale({ models: [{ Name: "Stale", UID: "ps-1" }] }); + await inFlight; + + expect(await typeaheadCache.getPeople()).toEqual([{ Name: "Fresh", UID: "ps-2" }]); + expect(spy).toHaveBeenCalledTimes(2); + }); + + it("discards a fetch evicted by a WS event before it resolves", async () => { + let resolveStale; + const spy = vi + .spyOn(Subject, "search") + .mockImplementationOnce(() => new Promise((resolve) => (resolveStale = resolve))) + .mockResolvedValueOnce({ models: [{ Name: "Renamed", UID: "ps-1" }] }); + + const inFlight = typeaheadCache.getPeople(); + $event.publishSync("subjects.updated", { entities: ["ps-1"] }); + resolveStale({ models: [{ Name: "Original", UID: "ps-1" }] }); + await inFlight; + + expect(await typeaheadCache.getPeople()).toEqual([{ Name: "Renamed", UID: "ps-1" }]); + expect(spy).toHaveBeenCalledTimes(2); + }); +}); + +describe("typeaheadCache.upsertPerson", () => { + it("adds a saved name to a loaded cache without refetching", async () => { + const spy = vi.spyOn(Subject, "search").mockResolvedValueOnce({ models: [{ Name: "Alpha", UID: "ps-1" }] }); + + await typeaheadCache.getPeople(); + typeaheadCache.upsertPerson({ UID: "ps-2", Name: "Beta" }); + + expect(await typeaheadCache.getPeople()).toEqual([ + { Name: "Alpha", UID: "ps-1" }, + { UID: "ps-2", Name: "Beta" }, + ]); + expect(spy).toHaveBeenCalledTimes(1); + }); + + it("updates an existing person in place by UID", async () => { + vi.spyOn(Subject, "search").mockResolvedValueOnce({ models: [{ Name: "Old", UID: "ps-1" }] }); + + await typeaheadCache.getPeople(); + typeaheadCache.upsertPerson({ UID: "ps-1", Name: "New" }); + + expect(await typeaheadCache.getPeople()).toEqual([{ Name: "New", UID: "ps-1" }]); + }); + + it("de-duplicates by case-insensitive name when no UID is given", async () => { + vi.spyOn(Subject, "search").mockResolvedValueOnce({ models: [{ Name: "Alpha", UID: "ps-1" }] }); + + await typeaheadCache.getPeople(); + typeaheadCache.upsertPerson({ Name: "alpha" }); + + expect(await typeaheadCache.getPeople()).toEqual([{ Name: "alpha", UID: "ps-1" }]); + }); + + it("leaves the slot untouched when re-saving an unchanged name (idempotent)", async () => { + vi.spyOn(Subject, "search").mockResolvedValueOnce({ models: [{ Name: "Alpha", UID: "ps-1" }] }); + + const before = await typeaheadCache.getPeople(); + typeaheadCache.upsertPerson({ UID: "ps-1", Name: "Alpha" }); + const after = await typeaheadCache.getPeople(); + + // Same array reference proves the slot was not replaced and the epoch was + // not bumped, so a redundant save cannot invalidate a pending fetch. + expect(after).toBe(before); + }); + + it("replaces the slot when a save actually changes the list", async () => { + vi.spyOn(Subject, "search").mockResolvedValueOnce({ models: [{ Name: "Alpha", UID: "ps-1" }] }); + + const before = await typeaheadCache.getPeople(); + typeaheadCache.upsertPerson({ UID: "ps-2", Name: "Beta" }); + const after = await typeaheadCache.getPeople(); + + expect(after).not.toBe(before); + expect(after).toContainEqual({ UID: "ps-2", Name: "Beta" }); + }); + + it("is a no-op when the people cache is cold", async () => { + const spy = vi.spyOn(Subject, "search").mockResolvedValueOnce({ models: [{ Name: "Alpha", UID: "ps-1" }] }); + + typeaheadCache.upsertPerson({ UID: "ps-2", Name: "Beta" }); + + expect(await typeaheadCache.getPeople()).toEqual([{ Name: "Alpha", UID: "ps-1" }]); + expect(spy).toHaveBeenCalledTimes(1); + }); + + it("ignores entries without a usable name", async () => { + vi.spyOn(Subject, "search").mockResolvedValueOnce({ models: [{ Name: "Alpha", UID: "ps-1" }] }); + + await typeaheadCache.getPeople(); + typeaheadCache.upsertPerson({ UID: "ps-2", Name: " " }); + typeaheadCache.upsertPerson(null); + + expect(await typeaheadCache.getPeople()).toEqual([{ Name: "Alpha", UID: "ps-1" }]); + }); + + // The reported bug: two names saved in quick succession. The optimistic seed + // keeps the second name visible before its WS event arrives, and the eventual + // event still refreshes from server truth. + it("keeps a quick second save visible before the WS eviction lands", async () => { + const spy = vi + .spyOn(Subject, "search") + .mockResolvedValueOnce({ models: [{ Name: "Alpha", UID: "ps-1" }] }) + .mockResolvedValueOnce({ + models: [ + { Name: "Alpha", UID: "ps-1" }, + { Name: "Beta", UID: "ps-2" }, + ], + }); + + expect(await typeaheadCache.getPeople()).toEqual([{ Name: "Alpha", UID: "ps-1" }]); + + typeaheadCache.upsertPerson({ UID: "ps-2", Name: "Beta" }); + expect(await typeaheadCache.getPeople()).toEqual([ + { Name: "Alpha", UID: "ps-1" }, + { UID: "ps-2", Name: "Beta" }, + ]); + expect(spy).toHaveBeenCalledTimes(1); + + $event.publishSync("subjects.created", { entities: [{ UID: "ps-2", Name: "Beta" }] }); + expect(await typeaheadCache.getPeople()).toEqual([ + { Name: "Alpha", UID: "ps-1" }, + { Name: "Beta", UID: "ps-2" }, + ]); + expect(spy).toHaveBeenCalledTimes(2); + }); +}); + +describe("typeaheadCache.evict / clear", () => { + it("evictLabels forces a fresh fetch on the next read", async () => { + const spy = vi + .spyOn(Label, "search") + .mockResolvedValueOnce({ models: [{ Name: "A", UID: "1" }] }) + .mockResolvedValueOnce({ models: [{ Name: "B", UID: "2" }] }); + + await typeaheadCache.getLabels(); + typeaheadCache.evictLabels(); + expect(await typeaheadCache.getLabels()).toEqual([{ Name: "B", UID: "2" }]); + expect(spy).toHaveBeenCalledTimes(2); + }); + + it("clear empties all lists", async () => { + const labelSpy = vi + .spyOn(Label, "search") + .mockResolvedValueOnce({ models: [{ Name: "L1", UID: "1" }] }) + .mockResolvedValueOnce({ models: [{ Name: "L2", UID: "2" }] }); + const albumSpy = vi + .spyOn(Album, "search") + .mockResolvedValueOnce({ models: [{ Title: "A1", UID: "a1" }] }) + .mockResolvedValueOnce({ models: [{ Title: "A2", UID: "a2" }] }); + const personSpy = vi + .spyOn(Subject, "search") + .mockResolvedValueOnce({ models: [{ Name: "P1", UID: "p1" }] }) + .mockResolvedValueOnce({ models: [{ Name: "P2", UID: "p2" }] }); + + await typeaheadCache.getLabels(); + await typeaheadCache.getAlbums(); + await typeaheadCache.getPeople(); + typeaheadCache.clear(); + + expect(await typeaheadCache.getLabels()).toEqual([{ Name: "L2", UID: "2" }]); + expect(await typeaheadCache.getAlbums()).toEqual([{ Title: "A2", UID: "a2" }]); + expect(await typeaheadCache.getPeople()).toEqual([{ Name: "P2", UID: "p2" }]); + expect(labelSpy).toHaveBeenCalledTimes(2); + expect(albumSpy).toHaveBeenCalledTimes(2); + expect(personSpy).toHaveBeenCalledTimes(2); + }); + + it("session.logout clears all lists", async () => { + const labelSpy = vi + .spyOn(Label, "search") + .mockResolvedValueOnce({ models: [{ Name: "L1", UID: "1" }] }) + .mockResolvedValueOnce({ models: [{ Name: "L2", UID: "2" }] }); + const albumSpy = vi + .spyOn(Album, "search") + .mockResolvedValueOnce({ models: [{ Title: "A1", UID: "a1" }] }) + .mockResolvedValueOnce({ models: [{ Title: "A2", UID: "a2" }] }); + const personSpy = vi + .spyOn(Subject, "search") + .mockResolvedValueOnce({ models: [{ Name: "P1", UID: "p1" }] }) + .mockResolvedValueOnce({ models: [{ Name: "P2", UID: "p2" }] }); + + await typeaheadCache.getLabels(); + await typeaheadCache.getAlbums(); + await typeaheadCache.getPeople(); + $event.publishSync("session.logout", {}); + + expect(await typeaheadCache.getLabels()).toEqual([{ Name: "L2", UID: "2" }]); + expect(await typeaheadCache.getAlbums()).toEqual([{ Title: "A2", UID: "a2" }]); + expect(await typeaheadCache.getPeople()).toEqual([{ Name: "P2", UID: "p2" }]); + expect(labelSpy).toHaveBeenCalledTimes(2); + expect(albumSpy).toHaveBeenCalledTimes(2); + expect(personSpy).toHaveBeenCalledTimes(2); + }); +}); + +// Forward-compat coverage for the subscribeEntityActions refactor: +// every entity-mutation verb in ENTITY_MUTATIONS — including ones the +// backend does not currently emit on these channels — flows through +// the namespace-level subscriber and evicts without any per-channel +// wiring in this module. Non-mutation actions stay no-ops so an +// unrelated future event under the same namespace can't pull the +// cache out from under live consumers. +describe("subscribeEntityActions integration", () => { + it("re-fetches after labels.restored (mutation verb without a current emitter)", async () => { + const first = [{ Name: "A", UID: "1" }]; + const second = [{ Name: "B", UID: "2" }]; + const spy = vi + .spyOn(Label, "search") + .mockResolvedValueOnce({ models: first }) + .mockResolvedValueOnce({ models: second }); + + await typeaheadCache.getLabels(); + $event.publishSync("labels.restored", { entities: ["1"] }); + expect(await typeaheadCache.getLabels()).toEqual(second); + expect(spy).toHaveBeenCalledTimes(2); + }); + + it("re-fetches after albums.archived", async () => { + const first = [{ Title: "First", UID: "alb-1" }]; + const second = [{ Title: "Second", UID: "alb-2" }]; + const spy = vi + .spyOn(Album, "search") + .mockResolvedValueOnce({ models: first }) + .mockResolvedValueOnce({ models: second }); + + await typeaheadCache.getAlbums(); + $event.publishSync("albums.archived", { entities: ["alb-1"] }); + expect(await typeaheadCache.getAlbums()).toEqual(second); + expect(spy).toHaveBeenCalledTimes(2); + }); + + it("ignores labels.* events whose action is not in ENTITY_MUTATIONS", async () => { + const cached = [{ Name: "A", UID: "1" }]; + const spy = vi.spyOn(Label, "search").mockResolvedValueOnce({ models: cached }); + + await typeaheadCache.getLabels(); + $event.publishSync("labels.merged", { entities: ["1"] }); + $event.publishSync("labels.viewed", {}); + expect(await typeaheadCache.getLabels()).toEqual(cached); + expect(spy).toHaveBeenCalledTimes(1); + }); + + it("ignores albums.* events whose action is not in ENTITY_MUTATIONS", async () => { + const cached = [{ Title: "First", UID: "alb-1" }]; + const spy = vi.spyOn(Album, "search").mockResolvedValueOnce({ models: cached }); + + await typeaheadCache.getAlbums(); + $event.publishSync("albums.merged", { entities: ["alb-1"] }); + $event.publishSync("albums.viewed", {}); + expect(await typeaheadCache.getAlbums()).toEqual(cached); + expect(spy).toHaveBeenCalledTimes(1); + }); +}); diff --git a/frontend/tests/vitest/common/util.test.js b/frontend/tests/vitest/common/util.test.js index c30f21c34..522efdc82 100644 --- a/frontend/tests/vitest/common/util.test.js +++ b/frontend/tests/vitest/common/util.test.js @@ -1,7 +1,8 @@ -import { describe, it, expect } from "vitest"; +import { describe, it, expect, afterEach } from "vitest"; import "../fixtures"; import $util from "common/util"; import { tokenRegexp, tokenLength } from "common/util"; +import { $config } from "app/session"; import * as can from "common/can"; import { ContentTypeMp4AvcMain, ContentTypeMp4HvcMain } from "common/media"; @@ -75,31 +76,13 @@ describe("common/util", () => { expect(long).toBe("45,065,875 ms"); }); it("should return formatted camera name", () => { - const iPhone15Pro = $util.formatCamera( - { Make: "Apple", Model: "iPhone 15 Pro" }, - 23, - "Apple", - "iPhone 15 Pro", - false, - ); + const iPhone15Pro = $util.formatCamera({ Make: "Apple", Model: "iPhone 15 Pro" }, 23, "Apple", "iPhone 15 Pro", false); expect(iPhone15Pro).toBe("iPhone 15 Pro"); - const iPhone15ProLong = $util.formatCamera( - { Make: "Apple", Model: "iPhone 15 Pro" }, - 23, - "Apple", - "iPhone 15 Pro", - true, - ); + const iPhone15ProLong = $util.formatCamera({ Make: "Apple", Model: "iPhone 15 Pro" }, 23, "Apple", "iPhone 15 Pro", true); expect(iPhone15ProLong).toBe("Apple iPhone 15 Pro"); - const iPhone14 = $util.formatCamera( - { Make: "Apple", Model: "iPhone 14" }, - 22, - "Apple", - "iPhone 14", - false, - ); + const iPhone14 = $util.formatCamera({ Make: "Apple", Model: "iPhone 14" }, 22, "Apple", "iPhone 14", false); expect(iPhone14).toBe("iPhone 14"); const iPhone13 = $util.formatCamera(null, 21, "Apple", "iPhone 13", false); @@ -147,9 +130,7 @@ describe("common/util", () => { expect($util.thumb(thumbs, 1300, 900).size).toBe("fit_1920"); expect($util.thumb(thumbs, 1300, 900).w).toBe(1800); expect($util.thumb(thumbs, 1300, 900).h).toBe(1200); - expect($util.thumb(thumbs, 1300, 900).src).toBe( - "/api/v1/t/bfdcf45e58b1978af66bbf6212c195851dc65814/174usyd0/fit_1920", - ); + expect($util.thumb(thumbs, 1300, 900).src).toBe("/api/v1/t/bfdcf45e58b1978af66bbf6212c195851dc65814/174usyd0/fit_1920"); expect($util.thumb(thumbs, 1400, 1200).size).toBe("fit_1920"); expect($util.thumb(thumbs, 100000, 120000).size).toBe("fit_7680"); }); @@ -204,14 +185,19 @@ describe("common/util", () => { const result = $util.encodeHTML("Micha & Theresa > < 'Lilly'"); expect(result).toBe("Micha & Theresa > < 'Lilly'"); }); - it.skip("should encode link", () => { - const result = $util.encodeHTML( - "Try this: https://photoswipe.com/options/?foo=bar&bar=baz. It's a link!", - ); + it("should encode link", () => { + const result = $util.encodeHTML("Try this: https://photoswipe.com/options/?foo=bar&bar=baz. It's a link!"); expect(result).toBe( - `Try this: https://photoswipe.com/options/ It's a link!`, + `Try this: https://photoswipe.com/options/ It's a link!` ); }); + it("should sanitize html using the shared allowlist", () => { + const result = $util.sanitizeHtml( + `

Hello there link

` + ); + + expect(result).toBe(`

Hello there link

`); + }); it("should generate tokens reliably", () => { const tokens = new Set(); const numTokens = 100; @@ -224,4 +210,217 @@ describe("common/util", () => { // Check they are all unique expect(tokens.size).toBe(numTokens); }); + + describe("normalizeTitle", () => { + it("preserves lowercase ASCII", () => { + expect($util.normalizeTitle("cat")).toBe("cat"); + }); + it("lowercases input", () => { + expect($util.normalizeTitle("Cat")).toBe("cat"); + }); + it("replaces & with and", () => { + expect($util.normalizeTitle("Rock & Roll")).toBe("rock and roll"); + }); + it("replaces underscores with spaces", () => { + expect($util.normalizeTitle("hello_world")).toBe("hello world"); + }); + it("replaces hyphens with spaces", () => { + expect($util.normalizeTitle("hello-world")).toBe("hello world"); + }); + it("replaces pluses with spaces", () => { + expect($util.normalizeTitle("hello+world")).toBe("hello world"); + }); + it("replaces periods with spaces", () => { + expect($util.normalizeTitle("hello.cat")).toBe("hello cat"); + expect($util.normalizeTitle("photoprism.app")).toBe("photoprism app"); + expect($util.normalizeTitle("2024.07.15")).toBe("2024 07 15"); + }); + it("treats all punctuation as word separators for case-insensitive comparison", () => { + // All punctuation (`.`, `,`, `;`, `:`, `!`, `?`, `/`, …) collapses + // to whitespace so the dedup comparison ignores it. Letters, digits, + // and emoji are preserved. + expect($util.normalizeTitle("foo,bar")).toBe("foo bar"); + expect($util.normalizeTitle("foo;bar")).toBe("foo bar"); + expect($util.normalizeTitle("foo:bar")).toBe("foo bar"); + expect($util.normalizeTitle("foo!bar?baz")).toBe("foo bar baz"); + expect($util.normalizeTitle("Mr. Smith")).toBe("mr smith"); + }); + it("collapses runs of mixed word separators into a single space", () => { + expect($util.normalizeTitle("hello._-+cat")).toBe("hello cat"); + expect($util.normalizeTitle("hello . cat")).toBe("hello cat"); + expect($util.normalizeTitle("foo,,, bar")).toBe("foo bar"); + }); + it("normalizes hello.cat, hello-cat, hello_cat, hello,cat, and Hello Cat to the same value", () => { + expect($util.normalizeTitle("hello.cat")).toBe("hello cat"); + expect($util.normalizeTitle("hello-cat")).toBe("hello cat"); + expect($util.normalizeTitle("hello_cat")).toBe("hello cat"); + expect($util.normalizeTitle("hello,cat")).toBe("hello cat"); + expect($util.normalizeTitle("Hello Cat")).toBe("hello cat"); + }); + it("preserves emoji", () => { + expect($util.normalizeTitle("🌅")).toBe("🌅"); + }); + it("preserves emoji with text", () => { + expect($util.normalizeTitle("🏔️ Mountains")).toBe("🏔️ mountains"); + }); + it("preserves compound emoji with ZWJ", () => { + expect($util.normalizeTitle("👨‍👩‍👧")).toBe("👨‍👩‍👧"); + }); + it("preserves accented characters", () => { + expect($util.normalizeTitle("café")).toBe("café"); + }); + it("preserves flag emoji", () => { + expect($util.normalizeTitle("🇺🇸")).toBe("🇺🇸"); + }); + it("preserves skin tone emoji", () => { + expect($util.normalizeTitle("👋🏽")).toBe("👋🏽"); + }); + it("preserves keycap sequences", () => { + expect($util.normalizeTitle("1️⃣")).toBe("1️⃣"); + }); + it("preserves CJK characters", () => { + expect($util.normalizeTitle("猫")).toBe("猫"); + }); + it("converts punctuation to whitespace and keeps emoji and text", () => { + expect($util.normalizeTitle("hello! 🌅 world")).toBe("hello 🌅 world"); + }); + it("returns empty for punctuation-only input", () => { + // Punctuation-only inputs collapse to a single space and then trim, + // so they normalize to empty — a title made entirely of punctuation + // characters cannot be created or matched. + expect($util.normalizeTitle("!!!")).toBe(""); + expect($util.normalizeTitle("...")).toBe(""); + expect($util.normalizeTitle("---")).toBe(""); + expect($util.normalizeTitle("+_-.")).toBe(""); + expect($util.normalizeTitle(",;:!?")).toBe(""); + }); + it("trims leading and trailing whitespace", () => { + expect($util.normalizeTitle(" hello cat ")).toBe("hello cat"); + expect($util.normalizeTitle(".hello-cat.")).toBe("hello cat"); + expect($util.normalizeTitle("!!!hello!!!")).toBe("hello"); + }); + it("returns empty for null", () => { + expect($util.normalizeTitle(null)).toBe(""); + }); + it("returns empty for undefined", () => { + expect($util.normalizeTitle(undefined)).toBe(""); + }); + }); + + describe("typeName", () => { + it("returns the localized label for known media types", () => { + expect($util.typeName("image")).toBe("Image"); + expect($util.typeName("raw")).toBe("Raw"); + expect($util.typeName("live")).toBe("Live"); + expect($util.typeName("video")).toBe("Video"); + expect($util.typeName("audio")).toBe("Audio"); + expect($util.typeName("animated")).toBe("Animated"); + expect($util.typeName("vector")).toBe("Vector"); + expect($util.typeName("document")).toBe("Document"); + expect($util.typeName("sidecar")).toBe("Sidecar"); + }); + it("falls back to defaultValue for unknown type", () => { + expect($util.typeName("unknown", "File")).toBe("File"); + }); + it("falls back to defaultValue for empty/null/undefined input", () => { + expect($util.typeName("", "File")).toBe("File"); + expect($util.typeName(null, "File")).toBe("File"); + expect($util.typeName(undefined, "File")).toBe("File"); + }); + it("returns empty string when no defaultValue and unknown type", () => { + expect($util.typeName("unknown")).toBe(""); + expect($util.typeName(null)).toBe(""); + }); + }); + + // isMobile must return a Boolean. Earlier code short-circuited + // `navigator.maxTouchPoints && maxTouchPoints > 2`, which returned the + // Number 0 on desktop and tripped Vue prop type checks (VTooltip.disabled). + describe("isMobile", () => { + const userAgent = navigator.userAgent; + const maxTouchPoints = navigator.maxTouchPoints; + const stub = (ua, touch) => { + Object.defineProperty(navigator, "userAgent", { value: ua, configurable: true }); + Object.defineProperty(navigator, "maxTouchPoints", { value: touch, configurable: true }); + }; + afterEach(() => stub(userAgent, maxTouchPoints)); + + it("returns Boolean false on desktop with no touch", () => { + stub("Mozilla/5.0 (X11; Linux x86_64)", 0); + const result = $util.isMobile(); + expect(typeof result).toBe("boolean"); + expect(result).toBe(false); + }); + it("returns Boolean false when maxTouchPoints is undefined", () => { + stub("Mozilla/5.0 (X11; Linux x86_64)", undefined); + const result = $util.isMobile(); + expect(typeof result).toBe("boolean"); + expect(result).toBe(false); + }); + it("returns true for a mobile user agent", () => { + stub("Mozilla/5.0 (iPhone; CPU iPhone OS 17_0 like Mac OS X)", 0); + expect($util.isMobile()).toBe(true); + }); + it("returns true when maxTouchPoints > 2 (iPad in desktop mode)", () => { + stub("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)", 5); + expect($util.isMobile()).toBe(true); + }); + it("returns false when maxTouchPoints is 2 or less", () => { + stub("Mozilla/5.0 (X11; Linux x86_64)", 2); + expect($util.isMobile()).toBe(false); + }); + }); + + describe("shouldOpenOnHover", () => { + const maxTouchPoints = navigator.maxTouchPoints; + const settings = $config.getSettings(); + const openOnHover = settings.ui.openOnHover; + const stubTouch = (touch) => Object.defineProperty(navigator, "maxTouchPoints", { value: touch, configurable: true }); + afterEach(() => { + stubTouch(maxTouchPoints); + settings.ui.openOnHover = openOnHover; + }); + + it("returns true when enabled and the device has no touch", () => { + stubTouch(0); + settings.ui.openOnHover = true; + expect($util.shouldOpenOnHover()).toBe(true); + }); + it("returns false when the setting is disabled", () => { + stubTouch(0); + settings.ui.openOnHover = false; + expect($util.shouldOpenOnHover()).toBe(false); + }); + it("defaults to true when the setting is absent", () => { + stubTouch(0); + delete settings.ui.openOnHover; + expect($util.shouldOpenOnHover()).toBe(true); + }); + it("returns false on a touch device regardless of the setting", () => { + stubTouch(5); + settings.ui.openOnHover = true; + expect($util.shouldOpenOnHover()).toBe(false); + }); + }); + + describe("mapAnimateDuration", () => { + it("returns the global Maps.Animate duration by default", () => { + expect($util.mapAnimateDuration({ maps: { animate: 400 } })).toBe(400); + }); + it("prefers a non-negative override over the global setting", () => { + expect($util.mapAnimateDuration({ maps: { animate: 400 } }, 0)).toBe(0); + expect($util.mapAnimateDuration({ maps: { animate: 400 } }, 250)).toBe(250); + }); + it("ignores a negative override and falls back to the global setting", () => { + expect($util.mapAnimateDuration({ maps: { animate: 400 } }, -1)).toBe(400); + }); + it("forces 0 when Reduce Motion is enabled, overriding both sources", () => { + expect($util.mapAnimateDuration({ ui: { reduceMotion: true }, maps: { animate: 400 } })).toBe(0); + expect($util.mapAnimateDuration({ ui: { reduceMotion: true }, maps: { animate: 400 } }, 250)).toBe(0); + }); + it("returns 0 when no settings or animation value is available", () => { + expect($util.mapAnimateDuration(undefined)).toBe(0); + expect($util.mapAnimateDuration({})).toBe(0); + }); + }); }); diff --git a/frontend/tests/vitest/common/view.test.js b/frontend/tests/vitest/common/view.test.js index aab13f6f0..af4217f14 100644 --- a/frontend/tests/vitest/common/view.test.js +++ b/frontend/tests/vitest/common/view.test.js @@ -1,7 +1,41 @@ -import { describe, it, expect, beforeEach } from "vitest"; -import { $view } from "common/view"; +import { describe, it, expect, beforeEach, afterEach, vi } from "vitest"; +import { $view, preventNavigationTouchEvent } from "common/view"; import { buildNamespace } from "common/storage"; +// jsdom does not implement TouchEvent (PointerEvent is the modern path), +// but preventNavigationTouchEvent uses `ev instanceof TouchEvent` as its +// first guard. Polyfill a minimal subclass so the test can construct +// synthetic TouchEvents and exercise every branch of the handler. +if (typeof globalThis.TouchEvent === "undefined") { + globalThis.TouchEvent = class TouchEvent extends Event { + constructor(type, init = {}) { + super(type, init); + } + }; +} + +// Builds a synthetic TouchEvent with the shape preventNavigationTouchEvent +// reads: `type`, `cancelable`, `touches[0].clientX/clientY`, and `target`. +// Wraps preventDefault in a vi.fn so we can count calls precisely (Event's +// own preventDefault just flips defaultPrevented; the call count is more +// expressive in assertions). +function makeTouchEvent({ type = "touchmove", cancelable = true, clientX = 0, clientY = 0, target = document.body, changedOnly = false } = {}) { + const ev = new TouchEvent(type, { cancelable, bubbles: true }); + const touch = { clientX, clientY }; + if (changedOnly) { + Object.defineProperty(ev, "touches", { value: [] }); + Object.defineProperty(ev, "changedTouches", { value: [touch] }); + } else { + Object.defineProperty(ev, "touches", { value: [touch] }); + Object.defineProperty(ev, "changedTouches", { value: [touch] }); + } + Object.defineProperty(ev, "target", { value: target }); + ev.preventDefault = vi.fn(() => { + Object.defineProperty(ev, "defaultPrevented", { value: true, configurable: true }); + }); + return ev; +} + describe("common/view", () => { it("should return parent", () => { expect($view.getParent()).toBe(null); @@ -81,4 +115,311 @@ describe("common/view", () => { expect(localStorage.getItem(namespacedStorageKey)).toBeNull(); }); }); + + // preventNavigationTouchEvent is the navigation-gesture suppressor wired + // to `window` while the lightbox view is active. Its purpose is non- + // obvious (it intercepts iOS swipe-back / pull-to-refresh / horizontal- + // swipe-to-navigate so users can't accidentally close PhotoPrism while + // using PhotoSwipe's pan/swipe gestures), so regressions are silent + // until somebody reports broken scroll on iPad or a broken Back button. + // The contract these tests pin: + // + // 1. Only TouchEvents that can be canceled are inspected at all. + // 2. Only touchstart / touchmove are inspected. + // 3. Touches inside the 30px L / R / T edge bands trigger preventDefault. + // 4. Inner-area touches are left alone (sidebar / dialog / menu scroll). + // 5. Touches on interactive widgets (button, input, textarea, select, + // anchored link, role=button) are exempt even inside the edge bands + // — so the overlay's top-left Back button and the sidebar's right- + // edge action buttons stay tap-reliable on iPad. The exemption + // walks up via `target.closest(...)` so taps that land on an inner + // / glyph are exempt too. + describe("preventNavigationTouchEvent", () => { + const innerWidth = 800; // jsdom default + const innerHeight = 600; + + beforeEach(() => { + // Pin the viewport so edge-band math is deterministic. + Object.defineProperty(window, "innerWidth", { configurable: true, value: innerWidth }); + Object.defineProperty(window, "innerHeight", { configurable: true, value: innerHeight }); + }); + + it("is a no-op for non-TouchEvent inputs", () => { + const ev = new Event("touchmove", { cancelable: true }); + ev.preventDefault = vi.fn(); + preventNavigationTouchEvent(ev); + expect(ev.preventDefault).not.toHaveBeenCalled(); + }); + + it("is a no-op when the event is not cancelable", () => { + const ev = makeTouchEvent({ cancelable: false, clientX: 10, clientY: 200 }); + preventNavigationTouchEvent(ev); + expect(ev.preventDefault).not.toHaveBeenCalled(); + }); + + it("is a no-op for event types other than touchstart / touchmove", () => { + const touchend = makeTouchEvent({ type: "touchend", clientX: 10, clientY: 200, changedOnly: true }); + const touchcancel = makeTouchEvent({ type: "touchcancel", clientX: 10, clientY: 200, changedOnly: true }); + preventNavigationTouchEvent(touchend); + preventNavigationTouchEvent(touchcancel); + expect(touchend.preventDefault).not.toHaveBeenCalled(); + expect(touchcancel.preventDefault).not.toHaveBeenCalled(); + }); + + it("is a no-op when no touch point is available", () => { + const ev = new TouchEvent("touchmove", { cancelable: true }); + Object.defineProperty(ev, "touches", { value: [] }); + Object.defineProperty(ev, "changedTouches", { value: [] }); + Object.defineProperty(ev, "target", { value: document.body }); + ev.preventDefault = vi.fn(); + preventNavigationTouchEvent(ev); + expect(ev.preventDefault).not.toHaveBeenCalled(); + }); + + it("leaves inner-area touches alone (sidebar / dialog / menu scroll)", () => { + const ev = makeTouchEvent({ clientX: 200, clientY: 200 }); + preventNavigationTouchEvent(ev); + expect(ev.preventDefault).not.toHaveBeenCalled(); + }); + + describe("edge bands trigger preventDefault on bare canvas", () => { + it("left edge", () => { + const ev = makeTouchEvent({ clientX: 10, clientY: 200 }); + preventNavigationTouchEvent(ev); + expect(ev.preventDefault).toHaveBeenCalledTimes(1); + }); + + it("right edge", () => { + const ev = makeTouchEvent({ clientX: innerWidth - 10, clientY: 200 }); + preventNavigationTouchEvent(ev); + expect(ev.preventDefault).toHaveBeenCalledTimes(1); + }); + + it("top edge", () => { + const ev = makeTouchEvent({ clientX: 200, clientY: 10 }); + preventNavigationTouchEvent(ev); + expect(ev.preventDefault).toHaveBeenCalledTimes(1); + }); + + it("touchstart and touchmove behave the same", () => { + const start = makeTouchEvent({ type: "touchstart", clientX: 10, clientY: 200 }); + const move = makeTouchEvent({ type: "touchmove", clientX: 10, clientY: 200 }); + preventNavigationTouchEvent(start); + preventNavigationTouchEvent(move); + expect(start.preventDefault).toHaveBeenCalledTimes(1); + expect(move.preventDefault).toHaveBeenCalledTimes(1); + }); + + // The bottom edge is intentionally NOT in the suppression band — iOS + // uses the bottom region for system gestures (Home indicator) which + // we don't try to block, and pull-to-refresh originates from the + // top, not the bottom. + it("bottom edge is NOT in the suppression band", () => { + const ev = makeTouchEvent({ clientX: 200, clientY: innerHeight - 10 }); + preventNavigationTouchEvent(ev); + expect(ev.preventDefault).not.toHaveBeenCalled(); + }); + }); + + describe("interactive targets at edges are exempted", () => { + let host; + beforeEach(() => { + host = document.createElement("div"); + document.body.appendChild(host); + }); + + it("exempts " }, + VIcon: { template: "" }, + }, + }, + }); + + // Stub the watched model's update() so confirm() doesn't hit the API. + const update = vi.fn().mockResolvedValue({}); + wrapper.vm.model.update = update; + return { wrapper, update }; +}; + +// vm.$.refs is the underlying refs container the proxy reads from; the +// public vm.$refs proxy ignores plain assignments. +const overrideFormRef = (vm, validate) => { + vm.$.refs.form = { validate }; +}; + +describe("component/album/edit/dialog", () => { + let wrapper; + let update; + + beforeEach(() => { + ({ wrapper, update } = makeWrapper()); + }); + + afterEach(() => { + if (wrapper) wrapper.unmount(); + }); + + it("blocks save and notifies when form validation fails", async () => { + const validate = vi.fn().mockResolvedValue({ valid: false }); + overrideFormRef(wrapper.vm, validate); + + await wrapper.vm.confirm(); + + expect(validate).toHaveBeenCalled(); + expect(update).not.toHaveBeenCalled(); + expect(wrapper.vm.$notify.error).toHaveBeenCalledWith("Changes could not be saved"); + expect(wrapper.emitted("close")).toBeFalsy(); + }); + + it("proceeds with save when form validation passes", async () => { + const validate = vi.fn().mockResolvedValue({ valid: true }); + overrideFormRef(wrapper.vm, validate); + + await wrapper.vm.confirm(); + + expect(validate).toHaveBeenCalled(); + expect(update).toHaveBeenCalled(); + expect(wrapper.emitted("close")).toBeTruthy(); + }); +}); diff --git a/frontend/tests/vitest/component/auth/menu.test.js b/frontend/tests/vitest/component/auth/menu.test.js new file mode 100644 index 000000000..74cb8d79c --- /dev/null +++ b/frontend/tests/vitest/component/auth/menu.test.js @@ -0,0 +1,93 @@ +import { beforeEach, describe, expect, it, vi } from "vitest"; + +// PAuthMenu derives its Switch Instance entries from listReachableInstances; mock +// it so the menu logic can be exercised without seeding browser storage, while +// keeping the real instancePath used to build the subtitle. +vi.mock("common/instances", async (importActual) => ({ + ...(await importActual()), + listReachableInstances: vi.fn(), +})); + +import { listReachableInstances } from "common/instances"; +import AuthMenu from "component/auth/menu.vue"; + +describe("component/auth/menu", () => { + beforeEach(() => { + listReachableInstances.mockReset(); + }); + + describe("refresh", () => { + it("loads reachable peers and adds the base-path subtitle", () => { + const peers = [{ namespace: "ns-pro-2", url: "https://app.example.com/i/pro-2", title: "pro-2", icon: "/i/pro-2/static/icons/logo.svg" }]; + listReachableInstances.mockReturnValue(peers); + const ctx = { $config: { values: { storageNamespace: "ns-pro-1" } }, instances: [] }; + AuthMenu.methods.refresh.call(ctx); + expect(listReachableInstances).toHaveBeenCalledWith({ currentNamespace: "ns-pro-1" }); + expect(ctx.instances).toEqual([{ ...peers[0], path: "/i/pro-2" }]); + }); + it("blanks the subtitle path for the Portal root", () => { + const peers = [{ namespace: "ns-portal", url: "https://app.example.com/", title: "Portal", icon: "/static/icons/logo.svg" }]; + listReachableInstances.mockReturnValue(peers); + const ctx = { $config: { values: { storageNamespace: "ns-pro-1" } }, instances: [] }; + AuthMenu.methods.refresh.call(ctx); + expect(ctx.instances[0].path).toBe(""); + }); + it("defaults a missing instance icon to the logo", () => { + const peers = [{ namespace: "ns-pro-3", url: "https://app.example.com/i/pro-3", title: "pro-3", icon: "" }]; + listReachableInstances.mockReturnValue(peers); + const ctx = { $config: { values: { storageNamespace: "ns-pro-1" } }, instances: [] }; + AuthMenu.methods.refresh.call(ctx); + expect(ctx.instances[0].icon).toBe("/static/icons/logo.svg"); + }); + it("yields an empty list when no peers are reachable, hiding the switcher", () => { + listReachableInstances.mockReturnValue([]); + const ctx = { $config: { values: { storageNamespace: "ns-pro-1" } }, instances: [{ namespace: "stale" }] }; + AuthMenu.methods.refresh.call(ctx); + expect(ctx.instances).toEqual([]); + }); + }); + + describe("onToggle", () => { + it("refreshes the peer list when the menu opens", () => { + const refresh = vi.fn(); + AuthMenu.methods.onToggle.call({ refresh }, true); + expect(refresh).toHaveBeenCalledTimes(1); + }); + it("does not refresh when the menu closes", () => { + const refresh = vi.fn(); + AuthMenu.methods.onToggle.call({ refresh }, false); + expect(refresh).not.toHaveBeenCalled(); + }); + }); + + describe("onSwitch", () => { + it("navigates to the instance app-entry route", () => { + const navigate = vi.fn(); + AuthMenu.methods.onSwitch.call({ navigate }, { route: "https://pro-2.example.com/i/pro-2/library", url: "https://pro-2.example.com/i/pro-2/" }); + expect(navigate).toHaveBeenCalledWith("https://pro-2.example.com/i/pro-2/library"); + }); + it("falls back to the site url when no route is present", () => { + const navigate = vi.fn(); + AuthMenu.methods.onSwitch.call({ navigate }, { url: "https://pro-2.example.com/" }); + expect(navigate).toHaveBeenCalledWith("https://pro-2.example.com/"); + }); + it("does nothing for an entry without a url or route", () => { + const navigate = vi.fn(); + AuthMenu.methods.onSwitch.call({ navigate }, {}); + expect(navigate).not.toHaveBeenCalled(); + }); + }); + + describe("onIconError", () => { + it("falls back to the default logo when a recorded icon fails to load", () => { + const instance = { namespace: "ns-pro-2", icon: "/i/pro-2/static/icons/logo.svg" }; + AuthMenu.methods.onIconError.call({}, instance); + expect(instance.icon).toBe("/static/icons/logo.svg"); + }); + it("does not reassign when the default logo itself fails", () => { + const instance = { icon: "/static/icons/logo.svg" }; + AuthMenu.methods.onIconError.call({}, instance); + expect(instance.icon).toBe("/static/icons/logo.svg"); + }); + }); +}); diff --git a/frontend/tests/vitest/component/file/chip-selector.test.js b/frontend/tests/vitest/component/file/chip-selector.test.js index 7e245677b..ef069d9d9 100644 --- a/frontend/tests/vitest/component/file/chip-selector.test.js +++ b/frontend/tests/vitest/component/file/chip-selector.test.js @@ -69,9 +69,9 @@ describe("component/file/chip-selector", () => { describe("Chip Icons", () => { it.each([ - { idx: 0, expectedClass: "chip--gray", expectedIcon: null }, - { idx: 1, expectedClass: "chip--green-light", expectedIcon: "mdi-plus" }, - { idx: 2, expectedClass: "chip--red", expectedIcon: "mdi-minus" }, + { idx: 0, expectedClass: "chip--default", expectedIcon: null }, + { idx: 1, expectedClass: "chip--add-mixed", expectedIcon: "mdi-plus" }, + { idx: 2, expectedClass: "chip--remove", expectedIcon: "mdi-minus" }, ])("should render expected style/icon for chip at index $idx", ({ idx, expectedClass, expectedIcon }) => { const chips = wrapper.findAll(".chip"); const chip = chips[idx]; @@ -232,6 +232,32 @@ describe("component/file/chip-selector", () => { expect(wrapper.emitted("update:items")).toBeFalsy(); }); + + // Regression pin for the user-reported ArrowDown bug: previously + // pressing ↓ shifted DOM focus to the first v-list-item in the + // dropdown menu and the input's @blur handler treated that focus + // shift as "commit pending text", silently turning typed prefixes + // (e.g. `ca`) into a brand-new chip before the user could highlight + // `Camping` and press Enter. The fix is to drop the @blur handler + // entirely: commits only happen on Enter (`onEnter`) or on the + // combobox emitting a real item-object selection + // (`onComboboxChange`). Tabbing or clicking elsewhere with pending + // text simply discards it. This test pins both halves of that + // contract — Enter still commits, ArrowDown does not. + it("commits typed text on Enter but not on ArrowDown", async () => { + const combobox = wrapper.findComponent({ name: "VCombobox" }); + + wrapper.vm.newItemTitle = "ca"; + await combobox.trigger("keydown.down"); + + expect(wrapper.emitted("update:items")).toBeFalsy(); + + await combobox.trigger("keydown.enter"); + + const emitted = wrapper.emitted("update:items"); + expect(emitted).toBeTruthy(); + expect(emitted[0][0]).toEqual(expect.arrayContaining([expect.objectContaining({ title: "ca", action: "add", isNew: true })])); + }); }); describe("Label resolver and normalization", () => { diff --git a/frontend/tests/vitest/component/label/edit/dialog.test.js b/frontend/tests/vitest/component/label/edit/dialog.test.js new file mode 100644 index 000000000..0a4e43e2b --- /dev/null +++ b/frontend/tests/vitest/component/label/edit/dialog.test.js @@ -0,0 +1,80 @@ +import { describe, it, expect, vi, beforeEach, afterEach } from "vitest"; +import { shallowMount } from "@vue/test-utils"; +import "../../../fixtures"; +import { Label } from "model/label"; +import PLabelEditDialog from "component/label/edit/dialog.vue"; + +const makeWrapper = () => { + const label = new Label({ UID: "lbl1", Name: "Cat", Favorite: false }); + + const wrapper = shallowMount(PLabelEditDialog, { + props: { visible: true, label }, + global: { + mocks: { + $gettext: (s) => s, + $notify: { error: vi.fn(), success: vi.fn() }, + $view: { enter: vi.fn(), leave: vi.fn() }, + $config: { allow: () => true }, + }, + stubs: { + VDialog: { template: "
" }, + VForm: { template: "
" }, + VCard: { template: "
" }, + VCardText: { template: "
" }, + VCardActions: { template: "
" }, + VToolbar: { template: "
" }, + VToolbarTitle: { template: "
" }, + VRow: { template: "
" }, + VCol: { template: "
" }, + VTextField: { template: "" }, + VCheckbox: { template: "" }, + VBtn: { template: "" }, + VIcon: { template: "" }, + }, + }, + }); + + const update = vi.fn().mockResolvedValue({}); + wrapper.vm.model.update = update; + return { wrapper, update }; +}; + +const overrideFormRef = (vm, validate) => { + vm.$.refs.form = { validate }; +}; + +describe("component/label/edit/dialog", () => { + let wrapper; + let update; + + beforeEach(() => { + ({ wrapper, update } = makeWrapper()); + }); + + afterEach(() => { + if (wrapper) wrapper.unmount(); + }); + + it("blocks save and notifies when form validation fails", async () => { + const validate = vi.fn().mockResolvedValue({ valid: false }); + overrideFormRef(wrapper.vm, validate); + + await wrapper.vm.confirm(); + + expect(validate).toHaveBeenCalled(); + expect(update).not.toHaveBeenCalled(); + expect(wrapper.vm.$notify.error).toHaveBeenCalledWith("Changes could not be saved"); + expect(wrapper.emitted("close")).toBeFalsy(); + }); + + it("proceeds with save when form validation passes", async () => { + const validate = vi.fn().mockResolvedValue({ valid: true }); + overrideFormRef(wrapper.vm, validate); + + await wrapper.vm.confirm(); + + expect(validate).toHaveBeenCalled(); + expect(update).toHaveBeenCalled(); + expect(wrapper.emitted("close")).toBeTruthy(); + }); +}); diff --git a/frontend/tests/vitest/component/lightbox.basic.test.js b/frontend/tests/vitest/component/lightbox.basic.test.js index 7b8b4dff4..5b3afbda8 100644 --- a/frontend/tests/vitest/component/lightbox.basic.test.js +++ b/frontend/tests/vitest/component/lightbox.basic.test.js @@ -1,14 +1,41 @@ import { mount, config as VTUConfig } from "@vue/test-utils"; -import { describe, it, expect, beforeEach } from "vitest"; +import { describe, it, expect, beforeEach, afterEach, vi } from "vitest"; import * as contexts from "options/contexts"; import { nextTick } from "vue"; import PLightbox from "component/lightbox.vue"; +import Photo from "model/photo"; +import Thumb from "model/thumb"; +import Album from "model/album"; +import $util from "common/util"; import { buildNamespace } from "common/storage"; +import { FaceMarkerDisplay, FaceMarkerEdit } from "options/face-marker"; import clientConfig from "../config"; +// makeFaceMarkers builds a minimal mock of the face-markers singleton. +// Lightbox methods read `this.faceMarkers.X` via the data() handle in +// real life; in tests the ctx object stands in for the component +// instance, so we attach a hand-built mock matching the singleton shape. +const makeFaceMarkers = (overrides = {}) => ({ + mode: null, + busy: false, + pendingNameMarkerUid: "", + active: false, + isDisplay: false, + isEdit: false, + display: vi.fn(), + edit: vi.fn(), + exit: vi.fn(), + setMode: vi.fn(), + setBusy: vi.fn(), + setPendingNameMarkerUid: vi.fn(), + reset: vi.fn(), + ...overrides, +}); + const storagePrefix = buildNamespace(clientConfig.storageNamespace); -const infoKey = `${storagePrefix}lightbox.info`; +const sidebarKey = `${storagePrefix}lightbox.sidebar`; const mutedKey = `${storagePrefix}lightbox.muted`; +const captionKey = `${storagePrefix}lightbox.caption`; const mountLightbox = () => mount(PLightbox, { @@ -18,29 +45,42 @@ const mountLightbox = () => "v-icon": true, "v-slider": true, "p-lightbox-menu": true, - "p-sidebar-info": true, + "p-lightbox-sidebar": true, + }, + mocks: { + $util, }, }, }); +// allowAllConfig stubs the ACL gates some lightbox methods read via +// this.$config.allow/deny. Vue's globalProperties (`$config`, +// `$session`) are not own properties of `wrapper.vm`, so a +// `{ ...wrapper.vm, ... }` spread does NOT carry them onto a synthetic +// test ctx — methods driven via $options.methods..call(ctx) that +// read $config must add it explicitly. This is the permissive default; +// suites that exercise a denied path override deny / allow inline. +const allowAllConfig = { allow: () => true, deny: () => false }; + describe("PLightbox (low-mock, jsdom-friendly)", () => { beforeEach(() => { - localStorage.removeItem(infoKey); + localStorage.removeItem(sidebarKey); + localStorage.removeItem(captionKey); sessionStorage.removeItem(mutedKey); }); - it("toggleInfo updates info and localStorage when visible", async () => { + it("toggleSidebar updates sidebar and localStorage when visible", async () => { const wrapper = mountLightbox(); await wrapper.setData({ visible: true }); - // Use exposed onShortCut to trigger info toggle (KeyI) + // Use exposed onShortCut to trigger sidebar toggle (KeyI) await wrapper.vm.onShortCut({ code: "KeyI" }); await nextTick(); - expect(localStorage.getItem(infoKey)).toBe("true"); + expect(localStorage.getItem(sidebarKey)).toBe("true"); await wrapper.vm.onShortCut({ code: "KeyI" }); await nextTick(); - expect(localStorage.getItem(infoKey)).toBe("false"); + expect(localStorage.getItem(sidebarKey)).toBe("false"); }); it("toggleMute writes sessionStorage without requiring video or exposed state", async () => { @@ -68,9 +108,238 @@ describe("PLightbox (low-mock, jsdom-friendly)", () => { it("KeyI is ignored when dialog is not visible", async () => { const wrapper = mountLightbox(); - expect(localStorage.getItem(infoKey)).toBeNull(); + expect(localStorage.getItem(sidebarKey)).toBeNull(); await wrapper.vm.onShortCut({ code: "KeyI" }); - expect(localStorage.getItem(infoKey)).toBeNull(); + expect(localStorage.getItem(sidebarKey)).toBeNull(); + }); + + // Ctrl+H (#5580) toggles the PhotoSwipe Dynamic Caption overlay and + // persists the choice to localStorage. Default state is visible + // (hideCaption reads "lightbox.caption" with a strict !== "false" + // check, so missing-key resolves to true). Mirrors the toggleSidebar + // pattern so future shortcut additions can copy the same shape. + it("toggleCaption updates hideCaption and localStorage when visible", async () => { + const wrapper = mountLightbox(); + await wrapper.setData({ visible: true }); + + // Default: missing localStorage entry → hideCaption defaults to true. + expect(localStorage.getItem(captionKey)).toBeNull(); + + await wrapper.vm.onShortCut({ code: "KeyH" }); + await nextTick(); + expect(localStorage.getItem(captionKey)).toBe("false"); + + await wrapper.vm.onShortCut({ code: "KeyH" }); + await nextTick(); + expect(localStorage.getItem(captionKey)).toBe("true"); + }); + + it("KeyH is ignored when dialog is not visible", async () => { + const wrapper = mountLightbox(); + expect(localStorage.getItem(captionKey)).toBeNull(); + await wrapper.vm.onShortCut({ code: "KeyH" }); + expect(localStorage.getItem(captionKey)).toBeNull(); + }); + + // onShortCut focus guard. Mirrors onPswpKeyDown's pattern: when an + // input/textarea/contenteditable element holds focus, the global + // keydown forwarder must defer to the browser's native handling so + // text-editing shortcuts (Ctrl+A select-all, Ctrl+C copy, Ctrl+X + // cut, Ctrl+V paste, Ctrl+Z undo, …) work as expected instead of + // triggering global lightbox actions. Covers KeyX specifically + // (the current Archive/Restore binding — would silently delete the + // photo if the gate regressed) plus KeyA (the canonical select-all + // chord, also gated even though no longer bound, as defense in + // depth) plus the surrounding non-input case that proves the gate + // doesn't accidentally suppress legitimate shortcuts. + describe("onShortCut — input focus guard", () => { + let scratch; + beforeEach(() => { + scratch = document.createElement("div"); + document.body.appendChild(scratch); + }); + afterEach(() => { + if (scratch && scratch.parentNode) { + scratch.parentNode.removeChild(scratch); + } + }); + + it("returns false (no-op) when an INPUT is focused — KeyX must not archive", () => { + const wrapper = mountLightbox(); + const onArchive = vi.spyOn(wrapper.vm.$options.methods, "onArchive").mockImplementation(() => {}); + const input = document.createElement("input"); + scratch.appendChild(input); + input.focus(); + const ret = wrapper.vm.$options.methods.onShortCut.call(wrapper.vm, { code: "KeyX" }); + expect(ret).toBe(false); + expect(onArchive).not.toHaveBeenCalled(); + onArchive.mockRestore(); + }); + + it("returns false (no-op) when a TEXTAREA is focused — KeyX must not archive", () => { + const wrapper = mountLightbox(); + const onArchive = vi.spyOn(wrapper.vm.$options.methods, "onArchive").mockImplementation(() => {}); + const ta = document.createElement("textarea"); + scratch.appendChild(ta); + ta.focus(); + const ret = wrapper.vm.$options.methods.onShortCut.call(wrapper.vm, { code: "KeyX" }); + expect(ret).toBe(false); + expect(onArchive).not.toHaveBeenCalled(); + onArchive.mockRestore(); + }); + + it("returns false for unbound text-editing chords too (KeyA select-all)", () => { + const wrapper = mountLightbox(); + const ta = document.createElement("textarea"); + scratch.appendChild(ta); + ta.focus(); + const ret = wrapper.vm.$options.methods.onShortCut.call(wrapper.vm, { code: "KeyA" }); + expect(ret).toBe(false); + }); + + it("does NOT bail when focus is on a non-editable element (KeyM still mutes)", async () => { + const wrapper = mountLightbox(); + const span = document.createElement("span"); + span.tabIndex = 0; + scratch.appendChild(span); + span.focus(); + expect(sessionStorage.getItem(mutedKey)).toBeNull(); + await wrapper.vm.onShortCut({ code: "KeyM" }); + expect(sessionStorage.getItem(mutedKey)).toBe("true"); + }); + }); + + describe("onPswpKeyDown — sidebar input focus guard", () => { + let scratch; + beforeEach(() => { + scratch = document.createElement("div"); + document.body.appendChild(scratch); + }); + afterEach(() => { + if (scratch && scratch.parentNode) { + scratch.parentNode.removeChild(scratch); + } + }); + + it("calls preventDefault when sidebar is open and an INPUT is focused", () => { + const wrapper = mountLightbox(); + wrapper.vm.sidebarVisible = true; + const input = document.createElement("input"); + scratch.appendChild(input); + input.focus(); + const ev = { preventDefault: vi.fn() }; + wrapper.vm.$options.methods.onPswpKeyDown.call(wrapper.vm, ev); + expect(ev.preventDefault).toHaveBeenCalledTimes(1); + }); + + it("calls preventDefault when sidebar is open and a TEXTAREA is focused", () => { + const wrapper = mountLightbox(); + wrapper.vm.sidebarVisible = true; + const ta = document.createElement("textarea"); + scratch.appendChild(ta); + ta.focus(); + const ev = { preventDefault: vi.fn() }; + wrapper.vm.$options.methods.onPswpKeyDown.call(wrapper.vm, ev); + expect(ev.preventDefault).toHaveBeenCalledTimes(1); + }); + + // Note: isContentEditable behavior isn't reliably simulated by jsdom, so + // the contenteditable branch of onPswpKeyDown is exercised in the browser + // ui-tester run. The INPUT / TEXTAREA / non-editable / no-sidebar / no-event + // cases here cover the predicate's two-class boundary in unit tests. + it("does NOT call preventDefault when sidebar is closed even with input focused", () => { + const wrapper = mountLightbox(); + wrapper.vm.sidebarVisible = false; + const input = document.createElement("input"); + scratch.appendChild(input); + input.focus(); + const ev = { preventDefault: vi.fn() }; + wrapper.vm.$options.methods.onPswpKeyDown.call(wrapper.vm, ev); + expect(ev.preventDefault).not.toHaveBeenCalled(); + }); + + it("does NOT call preventDefault when focus is on a non-editable element", () => { + const wrapper = mountLightbox(); + wrapper.vm.sidebarVisible = true; + const span = document.createElement("span"); + span.tabIndex = 0; + scratch.appendChild(span); + span.focus(); + const ev = { preventDefault: vi.fn() }; + wrapper.vm.$options.methods.onPswpKeyDown.call(wrapper.vm, ev); + expect(ev.preventDefault).not.toHaveBeenCalled(); + }); + + it("tolerates a missing event argument", () => { + const wrapper = mountLightbox(); + wrapper.vm.sidebarVisible = true; + expect(() => wrapper.vm.$options.methods.onPswpKeyDown.call(wrapper.vm, undefined)).not.toThrow(); + }); + }); + + describe("onTabKey — Tab focus suppression scoped to lightbox tree", () => { + let scratch; + beforeEach(() => { + scratch = document.createElement("div"); + document.body.appendChild(scratch); + }); + afterEach(() => { + if (scratch && scratch.parentNode) { + scratch.parentNode.removeChild(scratch); + } + }); + + it("calls stopPropagation when focus is inside the lightbox tree", () => { + const wrapper = mountLightbox(); + const root = document.createElement("div"); + const inner = document.createElement("input"); + root.appendChild(inner); + scratch.appendChild(root); + inner.focus(); + const ev = { stopPropagation: vi.fn() }; + // Call with a fake `this` that supplies the container ref — the + // mountLightbox-built proxy doesn't expose a writable `$refs`. + wrapper.vm.$options.methods.onTabKey.call({ $refs: { container: root } }, ev); + expect(ev.stopPropagation).toHaveBeenCalledTimes(1); + }); + + it("falls back to the content ref when container is missing", () => { + const wrapper = mountLightbox(); + const content = document.createElement("div"); + const inner = document.createElement("input"); + content.appendChild(inner); + scratch.appendChild(content); + inner.focus(); + const ev = { stopPropagation: vi.fn() }; + wrapper.vm.$options.methods.onTabKey.call({ $refs: { container: null, content } }, ev); + expect(ev.stopPropagation).toHaveBeenCalledTimes(1); + }); + + it("does NOT call stopPropagation when focus is outside the lightbox tree", () => { + const wrapper = mountLightbox(); + const root = document.createElement("div"); + scratch.appendChild(root); + const outsider = document.createElement("input"); + scratch.appendChild(outsider); + outsider.focus(); + const ev = { stopPropagation: vi.fn() }; + wrapper.vm.$options.methods.onTabKey.call({ $refs: { container: root } }, ev); + expect(ev.stopPropagation).not.toHaveBeenCalled(); + }); + + it("does NOT call stopPropagation when no container ref is available", () => { + const wrapper = mountLightbox(); + const ev = { stopPropagation: vi.fn() }; + wrapper.vm.$options.methods.onTabKey.call({ $refs: { container: null, content: null } }, ev); + expect(ev.stopPropagation).not.toHaveBeenCalled(); + }); + + it("tolerates a missing event argument", () => { + const wrapper = mountLightbox(); + expect(() => + wrapper.vm.$options.methods.onTabKey.call({ $refs: { container: scratch } }, undefined) + ).not.toThrow(); + }); }); it("getViewport falls back to window size without content ref", () => { @@ -98,4 +367,1305 @@ describe("PLightbox (low-mock, jsdom-friendly)", () => { expect(download).toBeTruthy(); expect(download.visible).toBe(true); }); + + // P1-10 — pause playable media (and any running slideshow) whenever + // face-marker mode is entered, whether display or draw. Drawing on a + // moving frame leads to wrong-rectangle saves and Live / Animated + // never expose video controls, so manual pause isn't an option. + // Playback is NOT resumed on exit; the user reopens it explicitly if + // they want it back. + // Regression: a single Escape press reaches onEscapeKey twice — once via the + // v-dialog `@keydown.esc` binding and once via the `$view` window forwarder, + // both with the same KeyboardEvent. Without per-event dedup the second call + // unwinds an extra level: exiting face-marker mode right after the first + // already consumed the in-progress draft, or closing the lightbox right after + // the first exited face-marker mode. + describe("onEscapeKey — one unwind per Escape press", () => { + const onEscapeKey = () => mountLightbox().vm.$options.methods.onEscapeKey; + it("consumes the overlay draft once and does not also exit face-marker mode", () => { + const handleEscape = vi.fn(() => true); + const exitFaceMarkerMode = vi.fn(); + const close = vi.fn(); + const ctx = { + $refs: { faceMarkerOverlay: { handleEscape } }, + faceMarkers: makeFaceMarkers({ active: true }), + exitFaceMarkerMode, + close, + }; + const ev = new KeyboardEvent("keydown", { key: "Escape" }); + const m = onEscapeKey(); + m.call(ctx, ev); + m.call(ctx, ev); + expect(handleEscape).toHaveBeenCalledTimes(1); + expect(exitFaceMarkerMode).not.toHaveBeenCalled(); + expect(close).not.toHaveBeenCalled(); + }); + it("exits face-marker mode once and does not also close the lightbox", () => { + const exitFaceMarkerMode = vi.fn(); + const close = vi.fn(); + const ctx = { + $refs: { faceMarkerOverlay: { handleEscape: () => false } }, + faceMarkers: makeFaceMarkers({ active: true }), + exitFaceMarkerMode, + close, + }; + const ev = new KeyboardEvent("keydown", { key: "Escape" }); + const m = onEscapeKey(); + m.call(ctx, ev); + m.call(ctx, ev); + expect(exitFaceMarkerMode).toHaveBeenCalledTimes(1); + expect(close).not.toHaveBeenCalled(); + }); + it("handles distinct Escape presses independently", () => { + const exitFaceMarkerMode = vi.fn(); + const ctx = { + $refs: { faceMarkerOverlay: { handleEscape: () => false } }, + faceMarkers: makeFaceMarkers({ active: true }), + exitFaceMarkerMode, + close: vi.fn(), + }; + const m = onEscapeKey(); + m.call(ctx, new KeyboardEvent("keydown", { key: "Escape" })); + m.call(ctx, new KeyboardEvent("keydown", { key: "Escape" })); + expect(exitFaceMarkerMode).toHaveBeenCalledTimes(2); + }); + }); + + describe("enterFaceMarkerMode — pauses media on entry into either face-marker mode", () => { + it("calls pauseLightbox so video and slideshow both stop", () => { + const ctx = { + pauseLightbox: vi.fn(), + $refs: {}, + $nextTick: (cb) => Promise.resolve().then(cb), + }; + const wrapper = mountLightbox(); + wrapper.vm.$options.methods.enterFaceMarkerMode.call(ctx); + expect(ctx.pauseLightbox).toHaveBeenCalledTimes(1); + }); + + it("schedules an overlay bounds recompute after the visibility swap", async () => { + const overlay = { scheduleUpdate: vi.fn() }; + const ctx = { + pauseLightbox: vi.fn(), + $refs: { faceMarkerOverlay: overlay }, + $nextTick: (cb) => Promise.resolve().then(cb), + }; + const wrapper = mountLightbox(); + wrapper.vm.$options.methods.enterFaceMarkerMode.call(ctx); + await Promise.resolve(); + await Promise.resolve(); + expect(overlay.scheduleUpdate).toHaveBeenCalledTimes(1); + }); + + it("is a safe no-op when the face-marker overlay is not mounted", () => { + const ctx = { + pauseLightbox: vi.fn(), + $refs: {}, + $nextTick: (cb) => Promise.resolve().then(cb), + }; + const wrapper = mountLightbox(); + expect(() => wrapper.vm.$options.methods.enterFaceMarkerMode.call(ctx)).not.toThrow(); + }); + + // P1-10 — closing the sidebar while face-marker UI is active fully + // exits it. The eye and ✓ Done controls live in the sidebar, so a + // closed sidebar would otherwise leave the overlay mounted with no + // way to disable it. + it("hideSidebar exits face-marker UI so the overlay tears down", async () => { + const wrapper = mountLightbox(); + const exitFaceMarkerMode = vi.fn(); + const ctx = { + visible: true, + sidebarVisible: true, + faceMarkers: makeFaceMarkers({ active: true, isEdit: true, mode: FaceMarkerEdit }), + exitFaceMarkerMode, + confirmDiscardSidebar: () => Promise.resolve(true), + $nextTick: (cb) => Promise.resolve().then(cb), + resize: vi.fn(), + focusContent: vi.fn(), + }; + await wrapper.vm.$options.methods.hideSidebar.call(ctx); + expect(ctx.sidebarVisible).toBe(false); + expect(exitFaceMarkerMode).toHaveBeenCalledTimes(1); + }); + + // Guard: hideSidebar does not exit face-marker UI if the user cancels + // out of the discard prompt. Sidebar (and overlay) stay open. + it("hideSidebar keeps face-marker UI when confirmDiscardSidebar resolves false", async () => { + const wrapper = mountLightbox(); + const exitFaceMarkerMode = vi.fn(); + const faceMarkers = makeFaceMarkers({ active: true, isEdit: true, mode: FaceMarkerEdit }); + const ctx = { + visible: true, + sidebarVisible: true, + faceMarkers, + exitFaceMarkerMode, + confirmDiscardSidebar: () => Promise.resolve(false), + $nextTick: (cb) => Promise.resolve().then(cb), + resize: vi.fn(), + focusContent: vi.fn(), + }; + await wrapper.vm.$options.methods.hideSidebar.call(ctx); + expect(ctx.sidebarVisible).toBe(true); + expect(faceMarkers.mode).toBe(FaceMarkerEdit); + expect(exitFaceMarkerMode).not.toHaveBeenCalled(); + }); + + // Wiring: the faceMarkerMode watcher routes through enterFaceMarkerMode + // on null → active transitions and exitFaceMarkerMode on active → null. + // Transitions between two truthy modes (display ↔ draw) are no-ops — + // playback is already paused and the markers stay on screen. + it("faceMarkers.mode watcher enters on null → active and exits on active → null", () => { + const wrapper = mountLightbox(); + const watcher = wrapper.vm.$options.watch["faceMarkers.mode"]; + const ctx = { + enterFaceMarkerMode: vi.fn(), + exitFaceMarkerMode: vi.fn(), + }; + // null → display: enters. + watcher.call(ctx, FaceMarkerDisplay, null); + expect(ctx.enterFaceMarkerMode).toHaveBeenCalledTimes(1); + expect(ctx.exitFaceMarkerMode).not.toHaveBeenCalled(); + // null → draw: enters. + ctx.enterFaceMarkerMode.mockClear(); + watcher.call(ctx, FaceMarkerEdit, null); + expect(ctx.enterFaceMarkerMode).toHaveBeenCalledTimes(1); + // display → null: exits. + watcher.call(ctx, null, FaceMarkerDisplay); + expect(ctx.exitFaceMarkerMode).toHaveBeenCalledTimes(1); + // draw → null: exits. + ctx.exitFaceMarkerMode.mockClear(); + watcher.call(ctx, null, FaceMarkerEdit); + expect(ctx.exitFaceMarkerMode).toHaveBeenCalledTimes(1); + // Truthy → truthy transitions are no-ops (✓ Done step-down + eye-from-draw). + ctx.enterFaceMarkerMode.mockClear(); + ctx.exitFaceMarkerMode.mockClear(); + watcher.call(ctx, FaceMarkerDisplay, FaceMarkerEdit); + watcher.call(ctx, FaceMarkerEdit, FaceMarkerDisplay); + expect(ctx.enterFaceMarkerMode).not.toHaveBeenCalled(); + expect(ctx.exitFaceMarkerMode).not.toHaveBeenCalled(); + }); + }); + + // Escape during face-draw mode must exit draw mode without closing the + // lightbox. The lightbox owns the routing via `onEscapeKey` (wired to + // both the v-dialog `@keydown.esc.exact` handler and `onShortCut`), + // delegating fine-grained draft / pending cleanup to the face-marker + // overlay first. See `frontend/src/common/README.md` for the documented + // keyboard pattern this follows. + describe("onEscapeKey — face-draw vs lightbox close routing", () => { + it("delegates to the face-marker overlay first when it has a pending rect", () => { + const wrapper = mountLightbox(); + const handleEscape = vi.fn().mockReturnValue(true); + const exitFaceMarkerMode = vi.fn(); + const close = vi.fn(); + const ctx = { + $refs: { faceMarkerOverlay: { handleEscape } }, + faceMarkers: makeFaceMarkers({ active: true, isEdit: true, mode: FaceMarkerEdit }), + exitFaceMarkerMode, + close, + }; + wrapper.vm.$options.methods.onEscapeKey.call(ctx); + expect(handleEscape).toHaveBeenCalledTimes(1); + expect(exitFaceMarkerMode).not.toHaveBeenCalled(); + expect(close).not.toHaveBeenCalled(); + }); + + it("hides face-marker UI when the overlay had nothing to cancel and draw mode is active", () => { + const wrapper = mountLightbox(); + const handleEscape = vi.fn().mockReturnValue(false); + const exitFaceMarkerMode = vi.fn(); + const close = vi.fn(); + const ctx = { + $refs: { faceMarkerOverlay: { handleEscape } }, + faceMarkers: makeFaceMarkers({ active: true, isEdit: true, mode: FaceMarkerEdit }), + exitFaceMarkerMode, + close, + }; + wrapper.vm.$options.methods.onEscapeKey.call(ctx); + expect(exitFaceMarkerMode).toHaveBeenCalledTimes(1); + expect(close).not.toHaveBeenCalled(); + }); + + // Display-only markers (eye toggle without Add Face) also exit on + // Escape — consistent with the Add Face path, and saves the user a + // dedicated "hide markers" gesture. + it("hides face-marker UI when only display mode is active", () => { + const wrapper = mountLightbox(); + const exitFaceMarkerMode = vi.fn(); + const close = vi.fn(); + const ctx = { + $refs: {}, + faceMarkers: makeFaceMarkers({ active: true, isDisplay: true, mode: FaceMarkerDisplay }), + exitFaceMarkerMode, + close, + }; + wrapper.vm.$options.methods.onEscapeKey.call(ctx); + expect(exitFaceMarkerMode).toHaveBeenCalledTimes(1); + expect(close).not.toHaveBeenCalled(); + }); + + it("closes the lightbox when no face-marker UI is active", () => { + const wrapper = mountLightbox(); + const exitFaceMarkerMode = vi.fn(); + const close = vi.fn(); + const ctx = { $refs: {}, faceMarkers: makeFaceMarkers(), exitFaceMarkerMode, close }; + wrapper.vm.$options.methods.onEscapeKey.call(ctx); + expect(close).toHaveBeenCalledTimes(1); + expect(exitFaceMarkerMode).not.toHaveBeenCalled(); + }); + + // exitFaceMarkerMode delegates to the singleton's exit() — the + // singleton clears mode (and the marker array is now derived from + // the photo, so no local copy needs resetting). + it("exitFaceMarkerMode calls faceMarkers.exit()", () => { + const wrapper = mountLightbox(); + const faceMarkers = makeFaceMarkers({ active: true, isEdit: true, mode: FaceMarkerEdit }); + const ctx = { faceMarkers }; + wrapper.vm.$options.methods.exitFaceMarkerMode.call(ctx); + expect(faceMarkers.exit).toHaveBeenCalledTimes(1); + }); + + // The pencil toggle for editable users now fully exits face-marker + // mode on second click — landing on `null` instead of stepping + // down to FaceMarkerDisplay. The historical ✓ Done step-down made + // sense when the sidebar had both an eye toggle and a pencil + // toggle; with the per-role simplification (editable users see + // ONLY the pencil), exiting must land on `null` or the toggle + // gets stuck in the "on" state with no way to leave face-marker + // mode from the sidebar. + it("toggleFaceMarkerEdit exits to null when already active (pencil off)", () => { + const wrapper = mountLightbox(); + const exitFaceMarkerMode = vi.fn(); + const faceMarkers = makeFaceMarkers({ active: true, isEdit: true, mode: FaceMarkerEdit }); + const ctx = { + faceMarkers, + shouldShowEditButton: () => true, + exitFaceMarkerMode, + $refs: {}, + }; + wrapper.vm.$options.methods.toggleFaceMarkerEdit.call(ctx); + expect(exitFaceMarkerMode).toHaveBeenCalledTimes(1); + expect(faceMarkers.edit).not.toHaveBeenCalled(); + expect(faceMarkers.display).not.toHaveBeenCalled(); + }); + + // toggleFaceMarkerMode is the non-editable eye toggle. Active → + // exitFaceMarkerMode (lands on null); null → display. The gate + // dropped the `shouldShowEditButton()` check so non-editable users + // who reach this handler (via the eye toggle the template now + // gives them) can actually toggle display mode. + it("toggleFaceMarkerMode's exit path routes through exitFaceMarkerMode from display (eye toggle off)", () => { + const wrapper = mountLightbox(); + const exitFaceMarkerMode = vi.fn(); + const ctx = { + faceMarkers: makeFaceMarkers({ active: true, isDisplay: true, mode: FaceMarkerDisplay }), + featPeople: true, + exitFaceMarkerMode, + }; + wrapper.vm.$options.methods.toggleFaceMarkerMode.call(ctx); + expect(exitFaceMarkerMode).toHaveBeenCalledTimes(1); + }); + + it("toggleFaceMarkerMode enters display when null and featPeople is true", () => { + const wrapper = mountLightbox(); + const faceMarkers = makeFaceMarkers(); + const ctx = { + faceMarkers, + featPeople: true, + exitFaceMarkerMode: vi.fn(), + }; + wrapper.vm.$options.methods.toggleFaceMarkerMode.call(ctx); + expect(faceMarkers.display).toHaveBeenCalledTimes(1); + }); + + it("toggleFaceMarkerMode is a no-op when featPeople is false", () => { + const wrapper = mountLightbox(); + const faceMarkers = makeFaceMarkers(); + const ctx = { faceMarkers, featPeople: false, exitFaceMarkerMode: vi.fn() }; + wrapper.vm.$options.methods.toggleFaceMarkerMode.call(ctx); + expect(faceMarkers.display).not.toHaveBeenCalled(); + }); + + it("onShortCut Escape routes through onEscapeKey, not close directly", () => { + const wrapper = mountLightbox(); + const onEscapeKey = vi.fn(); + const ctx = { onEscapeKey }; + const handled = wrapper.vm.$options.methods.onShortCut.call(ctx, { code: "Escape" }); + expect(handled).toBe(true); + expect(onEscapeKey).toHaveBeenCalledTimes(1); + }); + + // While face-marker mode is active, keys that open hidden chrome + // (menus), stack a competing modal, fire silent destructive + // actions, or contradict the entry-only-pause / overlay-stays- + // mounted contracts are gated to a no-op. Escape / Tab / KeyI / + // KeyD / KeyF / KeyM stay enabled. + describe("face-marker mode shortcut gates", () => { + const disabled = ["Period", "KeyX", "KeyE", "KeyH", "KeyL", "KeyS", "ArrowLeft", "ArrowRight", "Space"]; + const enabled = ["KeyD", "KeyF", "KeyI", "KeyM"]; + + it("isShortcutDisabledInFaceMarkerMode returns true for every conflicting key and false for the rest", () => { + const wrapper = mountLightbox(); + const predicate = wrapper.vm.$options.methods.isShortcutDisabledInFaceMarkerMode; + for (const code of disabled) { + expect(predicate(code)).toBe(true); + } + for (const code of enabled) { + expect(predicate(code)).toBe(false); + } + // Escape + Tab stay enabled — Escape via the priority chain, + // Tab via the v-dialog-level focus handler. + expect(predicate("Escape")).toBe(false); + expect(predicate("Tab")).toBe(false); + }); + + // The gate keys on `faceMarkers.active` (truthy for BOTH display + // and draw modes), so the inert key set must apply identically + // in both modes — playback / slideshow / nav stay frozen in + // either case, so the corresponding shortcuts must stay inert in + // either case. Parametrized over both modes pins the contract. + const modes = [ + ["display", { isDisplay: true, mode: FaceMarkerDisplay }], + ["edit", { isEdit: true, mode: FaceMarkerEdit }], + ]; + + for (const [label, modeFlags] of modes) { + it(`onShortCut short-circuits gated keys in ${label} mode`, () => { + const wrapper = mountLightbox(); + const onShowMenu = vi.fn(); + const toggleSlideshow = vi.fn(); + const onArchive = vi.fn(); + const ctx = { + faceMarkers: makeFaceMarkers({ active: true, ...modeFlags }), + isShortcutDisabledInFaceMarkerMode: wrapper.vm.$options.methods.isShortcutDisabledInFaceMarkerMode, + onShowMenu, + toggleSlideshow, + onArchive, + canArchive: true, + context: contexts.Photos, + model: { Archived: false }, + }; + for (const code of disabled) { + const r = wrapper.vm.$options.methods.onShortCut.call(ctx, { code }); + expect(r).toBe(false); + } + expect(onShowMenu).not.toHaveBeenCalled(); + expect(toggleSlideshow).not.toHaveBeenCalled(); + expect(onArchive).not.toHaveBeenCalled(); + }); + + it(`onKeyDown short-circuits Space + Arrow keys in ${label} mode`, () => { + const wrapper = mountLightbox(); + const pswpStub = { prev: vi.fn(), next: vi.fn() }; + const toggleVideo = vi.fn(); + const ctx = { + visible: true, + sidebarVisible: false, + faceMarkers: makeFaceMarkers({ active: true, ...modeFlags }), + isShortcutDisabledInFaceMarkerMode: wrapper.vm.$options.methods.isShortcutDisabledInFaceMarkerMode, + $view: { isActive: () => true }, + pauseSlideshow: vi.fn(), + pswp: () => pswpStub, + toggleVideo, + toggleControls: vi.fn(), + getContent: () => ({ video: null }), + model: {}, + video: { controls: false, playing: false }, + models: [{}, {}], + index: 0, + $isRtl: false, + }; + for (const code of ["ArrowLeft", "ArrowRight", "Space"]) { + wrapper.vm.$options.methods.onKeyDown.call(ctx, { + code, + preventDefault: () => {}, + stopPropagation: () => {}, + }); + } + expect(pswpStub.prev).not.toHaveBeenCalled(); + expect(pswpStub.next).not.toHaveBeenCalled(); + expect(toggleVideo).not.toHaveBeenCalled(); + }); + } + + it("onShortCut still routes Escape + KeyI even when face-marker mode is active", () => { + const wrapper = mountLightbox(); + const onEscapeKey = vi.fn(); + const toggleSidebar = vi.fn(); + const ctx = { + faceMarkers: makeFaceMarkers({ active: true, isDisplay: true, mode: FaceMarkerDisplay }), + isShortcutDisabledInFaceMarkerMode: wrapper.vm.$options.methods.isShortcutDisabledInFaceMarkerMode, + onEscapeKey, + toggleSidebar, + }; + wrapper.vm.$options.methods.onShortCut.call(ctx, { code: "Escape" }); + wrapper.vm.$options.methods.onShortCut.call(ctx, { code: "KeyI" }); + expect(onEscapeKey).toHaveBeenCalledTimes(1); + expect(toggleSidebar).toHaveBeenCalledTimes(1); + }); + }); + }); + + it("captionPlugin.formatCaption returns sanitized caption html", async () => { + const Captions = (await import("common/captions")).default; + const plugin = new Captions({ on() {} }, {}); + const caption = plugin.formatCaption({ + Title: `Title `, + Caption: `Visit https://example.com/?q=1&x=2`, + }); + + expect(caption).toContain('

Title <img src=x onerror="alert(1)">

'); + expect(caption).toContain(`

Visit https://example.com/

`); + expect(caption).not.toContain(" { + // The /photos/:uid endpoint now reduces detail server-side for + // shared-only sessions, so the sidebar preloads for every session and + // the previous slide's (stale) photo IS replaced by the loaded metadata; + // the sidebar's per-section ACL gates decide what renders. + const loaded = new Photo({ UID: "ps6sg6be2lvl0yh7", Title: "Shared" }); + const spy = vi.spyOn(Photo, "findCached").mockResolvedValue(loaded); + const wrapper = mountLightbox(); + const ctx = { + ...wrapper.vm, + photo: new Photo({ UID: "stale" }), + model: new Thumb({ UID: "ps6sg6be2lvl0yh7" }), + $config: { ...wrapper.vm.$config, deny: () => true, allow: () => false }, + }; + + wrapper.vm.$options.methods.fetchPhoto.call(ctx, "ps6sg6be2lvl0yh7"); + await Promise.resolve(); + await Promise.resolve(); + + expect(spy).toHaveBeenCalledWith("ps6sg6be2lvl0yh7"); + expect(ctx.photo).toBe(loaded); + spy.mockRestore(); + }); + + it("fetchPhoto resets to an empty Photo when the uid is missing", () => { + const spy = vi.spyOn(Photo, "findCached"); + const wrapper = mountLightbox(); + const ctx = { + ...wrapper.vm, + photo: new Photo({ UID: "stale" }), + model: new Thumb({ UID: "" }), + $config: allowAllConfig, + }; + + wrapper.vm.$options.methods.fetchPhoto.call(ctx, ""); + + // No uid → empty Photo (not null) so the sidebar can read + // this.view.photo.X without nullable chains, and no fetch is issued. + expect(ctx.photo).toBeInstanceOf(Photo); + expect(ctx.photo.UID).toBe(""); + expect(spy).not.toHaveBeenCalled(); + spy.mockRestore(); + }); + + it("fetchPhoto calls Photo.findCached when ACL allows photos:access_library", () => { + const spy = vi.spyOn(Photo, "findCached").mockResolvedValue({}); + const wrapper = mountLightbox(); + const ctx = { + ...wrapper.vm, + photo: null, + model: new Thumb({ UID: "ps6sg6be2lvl0yh7" }), + $config: { ...wrapper.vm.$config, deny: () => false, allow: () => true }, + }; + + wrapper.vm.$options.methods.fetchPhoto.call(ctx, "ps6sg6be2lvl0yh7"); + + expect(spy).toHaveBeenCalledWith("ps6sg6be2lvl0yh7"); + spy.mockRestore(); + }); + + // Symmetric to fetchPhoto: prefetch also runs for shared-only sessions + // now that /photos/:uid reduces detail server-side. Gating remains on + // sidebar visibility, not on library access. + it("preloadNextPhoto prefetches even when ACL denies photos:access_library", () => { + const spy = vi.spyOn(Photo, "prefetchAround").mockReturnValue(Promise.resolve([])); + const wrapper = mountLightbox(); + const models = [{ UID: "uid-curr" }, { UID: "uid-next" }]; + const ctx = { + ...wrapper.vm, + sidebarVisible: true, + models, + index: 0, + $config: { ...wrapper.vm.$config, deny: () => true, allow: () => false }, + }; + + wrapper.vm.$options.methods.preloadNextPhoto.call(ctx); + + expect(spy).toHaveBeenCalledWith(models, 0, { before: 0, after: 1 }); + spy.mockRestore(); + }); + + it("preloadNextPhoto skips Photo.prefetchAround when the sidebar is hidden", () => { + const spy = vi.spyOn(Photo, "prefetchAround"); + const wrapper = mountLightbox(); + const ctx = { + ...wrapper.vm, + sidebarVisible: false, + models: [{ UID: "uid-curr" }, { UID: "uid-next" }], + index: 0, + }; + + wrapper.vm.$options.methods.preloadNextPhoto.call(ctx); + + expect(spy).not.toHaveBeenCalled(); + spy.mockRestore(); + }); + + it("preloadNextPhoto delegates to Photo.prefetchAround when sidebar is visible and unrestricted", () => { + const spy = vi.spyOn(Photo, "prefetchAround").mockReturnValue(Promise.resolve([])); + const wrapper = mountLightbox(); + const models = [{ UID: "uid-curr" }, { UID: "uid-next" }]; + const ctx = { + ...wrapper.vm, + sidebarVisible: true, + models, + index: 0, + $config: allowAllConfig, + }; + + wrapper.vm.$options.methods.preloadNextPhoto.call(ctx); + + expect(spy).toHaveBeenCalledWith(models, 0, { before: 0, after: 1 }); + spy.mockRestore(); + }); + + // The race guard inside fetchPhoto is the last line of defense against + // a slow /photos/:uid response landing after the user has already + // swiped to the next slide. Without the `this.model.UID === uid` check, + // an out-of-order resolution would overwrite `this.photo` with the + // previous slide's metadata and the sidebar would silently flip to + // editing the wrong photo. Pin the contract with a deterministic test. + describe("fetchPhoto race guard", () => { + it("does NOT overwrite this.photo when the user has navigated away before the fetch resolves", async () => { + let resolveSlideN; + const findSpy = vi.spyOn(Photo, "findCached").mockImplementation( + (uid) => + new Promise((res) => { + // Only the slide-N fetch is pending; slide-N+1 isn't issued in this test. + if (uid === "uid-slide-n") { + resolveSlideN = () => res(new Photo({ UID: "uid-slide-n", Title: "Slide N" })); + } + }) + ); + + const wrapper = mountLightbox(); + const placeholder = new Photo(); + const ctx = { + ...wrapper.vm, + photo: placeholder, + // Start with the user viewing slide N. + model: new Thumb({ UID: "uid-slide-n" }), + $config: allowAllConfig, + }; + + // Sidebar fetch issued for slide N. + wrapper.vm.$options.methods.fetchPhoto.call(ctx, "uid-slide-n"); + + // User swipes to slide N+1 BEFORE slide N's response arrives. + ctx.model = new Thumb({ UID: "uid-slide-n-plus-1" }); + + // Slide N's response finally lands. + resolveSlideN(); + await Promise.resolve(); + await Promise.resolve(); + + // The race guard MUST keep ctx.photo on the placeholder — slide N's + // payload is dropped because this.model.UID has already moved on. + expect(ctx.photo).toBe(placeholder); + findSpy.mockRestore(); + }); + + it("applies the response when this.model.UID still matches the fetched uid", async () => { + const slideNPhoto = new Photo({ UID: "uid-slide-n", Title: "Slide N" }); + const findSpy = vi.spyOn(Photo, "findCached").mockResolvedValue(slideNPhoto); + + const wrapper = mountLightbox(); + const ctx = { + ...wrapper.vm, + photo: new Photo(), + model: new Thumb({ UID: "uid-slide-n" }), + $config: allowAllConfig, + }; + + wrapper.vm.$options.methods.fetchPhoto.call(ctx, "uid-slide-n"); + // Drain the resolved Promise + race-guard .then. + await Promise.resolve(); + await Promise.resolve(); + + expect(ctx.photo).toBe(slideNPhoto); + findSpy.mockRestore(); + }); + + it("absorbs a rejected findCached without throwing or mutating this.photo", async () => { + const findSpy = vi.spyOn(Photo, "findCached").mockRejectedValue(new Error("offline")); + + const wrapper = mountLightbox(); + const placeholder = new Photo(); + const ctx = { + ...wrapper.vm, + photo: placeholder, + model: new Thumb({ UID: "uid-slide-n" }), + $config: allowAllConfig, + }; + + // Calling fetchPhoto must not throw even when findCached rejects. + expect(() => wrapper.vm.$options.methods.fetchPhoto.call(ctx, "uid-slide-n")).not.toThrow(); + await Promise.resolve(); + await Promise.resolve(); + + // The placeholder stays in place — the sidebar continues to read + // from this.view.photo.X without nullable chains. + expect(ctx.photo).toBe(placeholder); + findSpy.mockRestore(); + }); + + // Companion to the ModelCache epoch-rejection test: when the cache + // rejects an in-flight fetch after Photo.clearCache() (logout race), + // the lightbox's existing .catch handler must absorb it cleanly + // and leave this.photo untouched — even when this.model.UID still + // matches the requested uid (i.e. the race-guard isn't what's + // saving us; the rejection is). Without this, a logout-then-relogin + // window could route role-A data into role-B UI before unmount. + it("absorbs a ModelCacheStaleFetchError from findCached without mutating this.photo", async () => { + const findSpy = vi.spyOn(Photo, "findCached").mockImplementation(() => { + const err = new Error("ModelCache: discarded stale fetch after clear()"); + err.name = "ModelCacheStaleFetchError"; + return Promise.reject(err); + }); + + const wrapper = mountLightbox(); + const placeholder = new Photo(); + const ctx = { + ...wrapper.vm, + photo: placeholder, + // model.UID intentionally STILL matches — to prove the rejection + // (not the race-guard) is what protects this.photo here. + model: new Thumb({ UID: "uid-slide-n" }), + $config: allowAllConfig, + }; + + expect(() => wrapper.vm.$options.methods.fetchPhoto.call(ctx, "uid-slide-n")).not.toThrow(); + await Promise.resolve(); + await Promise.resolve(); + + expect(ctx.photo).toBe(placeholder); + findSpy.mockRestore(); + }); + }); + + // preloadNextPhoto is fire-and-forget. The realistic contract under + // test is that a slow prefetch that resolves AFTER the user has + // moved on doesn't block or interfere — the actual Photo.prefetchAround + // wraps tasks in Promise.allSettled, so it can't reject in practice. + describe("preloadNextPhoto async resilience", () => { + it("forwards the call when the prefetch resolves late", async () => { + let resolvePrefetch; + const spy = vi.spyOn(Photo, "prefetchAround").mockImplementation(() => new Promise((res) => (resolvePrefetch = res))); + + const wrapper = mountLightbox(); + const models = [{ UID: "uid-curr" }, { UID: "uid-next" }]; + const ctx = { + ...wrapper.vm, + sidebarVisible: true, + models, + index: 0, + $config: allowAllConfig, + }; + + wrapper.vm.$options.methods.preloadNextPhoto.call(ctx); + + // Even after a later resolve, the call site must still have been + // invoked exactly once with the documented args. + expect(spy).toHaveBeenCalledTimes(1); + expect(spy).toHaveBeenCalledWith(models, 0, { before: 0, after: 1 }); + resolvePrefetch([]); + await Promise.resolve(); + spy.mockRestore(); + }); + }); + + // Wiring tests for the lightbox archive / restore / album-remove + // delegations. These pin the component-to-Thumb boundary so a + // future refactor that breaks the call edge (e.g., reverting back + // to inline $api.post or skipping the model methods) fails here + // instead of silently surviving the unit-test layer. + describe("onArchive wiring", () => { + it("calls this.model.archive() and notifies on success when canArchive is true", async () => { + const wrapper = mountLightbox(); + const model = new Thumb({ UID: "uid-archive" }); + const archiveSpy = vi.spyOn(model, "archive").mockResolvedValue({ status: 200, data: {} }); + const ctx = { + ...wrapper.vm, + model, + canArchive: true, + pauseSlideshow: vi.fn(), + $notify: { ...wrapper.vm.$notify, success: vi.fn() }, + $gettext: VTUConfig.global.mocks.$gettext, + }; + + await wrapper.vm.$options.methods.onArchive.call(ctx); + + expect(ctx.pauseSlideshow).toHaveBeenCalledTimes(1); + expect(archiveSpy).toHaveBeenCalledTimes(1); + expect(ctx.$notify.success).toHaveBeenCalledTimes(1); + archiveSpy.mockRestore(); + }); + + it("does NOT call archive() when canArchive is false", () => { + const wrapper = mountLightbox(); + const model = new Thumb({ UID: "uid-archive" }); + const archiveSpy = vi.spyOn(model, "archive"); + const ctx = { + ...wrapper.vm, + model, + canArchive: false, + pauseSlideshow: vi.fn(), + }; + + wrapper.vm.$options.methods.onArchive.call(ctx); + + expect(archiveSpy).not.toHaveBeenCalled(); + expect(ctx.pauseSlideshow).not.toHaveBeenCalled(); + archiveSpy.mockRestore(); + }); + + it("does NOT call archive() when model.UID is empty", () => { + const wrapper = mountLightbox(); + const model = new Thumb({ UID: "" }); + const archiveSpy = vi.spyOn(model, "archive"); + const ctx = { + ...wrapper.vm, + model, + canArchive: true, + pauseSlideshow: vi.fn(), + log: vi.fn(), + }; + + wrapper.vm.$options.methods.onArchive.call(ctx); + + expect(archiveSpy).not.toHaveBeenCalled(); + archiveSpy.mockRestore(); + }); + }); + + describe("onRestore wiring", () => { + it("calls this.model.restore() and notifies on success when canArchive is true", async () => { + const wrapper = mountLightbox(); + const model = new Thumb({ UID: "uid-restore", Archived: true }); + const restoreSpy = vi.spyOn(model, "restore").mockResolvedValue({ status: 200, data: {} }); + const ctx = { + ...wrapper.vm, + model, + canArchive: true, + pauseSlideshow: vi.fn(), + $notify: { ...wrapper.vm.$notify, success: vi.fn() }, + $gettext: VTUConfig.global.mocks.$gettext, + }; + + wrapper.vm.$options.methods.onRestore.call(ctx); + // Drain the .then chain. + await Promise.resolve(); + await Promise.resolve(); + + expect(ctx.pauseSlideshow).toHaveBeenCalledTimes(1); + expect(restoreSpy).toHaveBeenCalledTimes(1); + expect(ctx.$notify.success).toHaveBeenCalledTimes(1); + restoreSpy.mockRestore(); + }); + + it("does NOT call restore() when canArchive is false", () => { + const wrapper = mountLightbox(); + const model = new Thumb({ UID: "uid-restore", Archived: true }); + const restoreSpy = vi.spyOn(model, "restore"); + const ctx = { + ...wrapper.vm, + model, + canArchive: false, + pauseSlideshow: vi.fn(), + }; + + wrapper.vm.$options.methods.onRestore.call(ctx); + + expect(restoreSpy).not.toHaveBeenCalled(); + restoreSpy.mockRestore(); + }); + }); + + describe("onRemoveFromAlbum wiring", () => { + it("calls this.model.removeFromAlbum(collection.UID) then evicts the photo on success", async () => { + const wrapper = mountLightbox(); + const model = new Thumb({ UID: "uid-remove" }); + const removeSpy = vi.spyOn(model, "removeFromAlbum").mockResolvedValue({ status: 200, data: {} }); + const evictSpy = vi.spyOn(model, "evictPhoto"); + const collection = new Album({ UID: "album-1" }); + const ctx = { + ...wrapper.vm, + model, + collection, + canManageAlbums: true, + pauseSlideshow: vi.fn(), + }; + + wrapper.vm.$options.methods.onRemoveFromAlbum.call(ctx); + // Drain the .then chain. + await Promise.resolve(); + await Promise.resolve(); + + expect(ctx.pauseSlideshow).toHaveBeenCalledTimes(1); + expect(removeSpy).toHaveBeenCalledWith("album-1"); + // Album-remove publishes only albums.updated, so the manual + // evictPhoto() in onRemoveFromAlbum.then is what drops the + // sidebar's stale Photo.Albums view. + expect(evictSpy).toHaveBeenCalledTimes(1); + removeSpy.mockRestore(); + evictSpy.mockRestore(); + }); + + it("does NOT call removeFromAlbum when canManageAlbums is false", () => { + const wrapper = mountLightbox(); + const model = new Thumb({ UID: "uid-remove" }); + const removeSpy = vi.spyOn(model, "removeFromAlbum"); + const collection = new Album({ UID: "album-1" }); + const ctx = { + ...wrapper.vm, + model, + collection, + canManageAlbums: false, + pauseSlideshow: vi.fn(), + }; + + wrapper.vm.$options.methods.onRemoveFromAlbum.call(ctx); + + expect(removeSpy).not.toHaveBeenCalled(); + removeSpy.mockRestore(); + }); + + it("does NOT call removeFromAlbum when collection isn't an Album", () => { + const wrapper = mountLightbox(); + const model = new Thumb({ UID: "uid-remove" }); + const removeSpy = vi.spyOn(model, "removeFromAlbum"); + // A plain object (or a non-Album collection) must short-circuit. + const ctx = { + ...wrapper.vm, + model, + collection: { UID: "not-an-album-instance" }, + canManageAlbums: true, + pauseSlideshow: vi.fn(), + }; + + wrapper.vm.$options.methods.onRemoveFromAlbum.call(ctx); + + expect(removeSpy).not.toHaveBeenCalled(); + removeSpy.mockRestore(); + }); + + it("does NOT call evictPhoto when removeFromAlbum rejects", async () => { + // The optimistic Removed flip and its rollback live inside + // Thumb.removeFromAlbum (covered in thumb.test.js); here we + // pin that the lightbox does NOT evict the cache on failure + // — otherwise the sidebar would lose its (still-correct) + // Photo.Albums view after a no-op failed remove. + const wrapper = mountLightbox(); + const model = new Thumb({ UID: "uid-remove" }); + const removeSpy = vi.spyOn(model, "removeFromAlbum").mockRejectedValue(new Error("offline")); + const evictSpy = vi.spyOn(model, "evictPhoto"); + const collection = new Album({ UID: "album-1" }); + const ctx = { + ...wrapper.vm, + model, + collection, + canManageAlbums: true, + pauseSlideshow: vi.fn(), + }; + + wrapper.vm.$options.methods.onRemoveFromAlbum.call(ctx); + await Promise.resolve(); + await Promise.resolve(); + + expect(removeSpy).toHaveBeenCalledTimes(1); + expect(evictSpy).not.toHaveBeenCalled(); + removeSpy.mockRestore(); + evictSpy.mockRestore(); + }); + }); + + // getItemData dispatch: equirectangular media must route to the sphere viewer, + // while a regular photo with no projection must stay on the flat lightbox path. + describe("getItemData sphere dispatch", () => { + const baseThumbs = { + fit_720: { src: "/thumb-720.jpg", w: 720, h: 360 }, + fit_1280: { src: "/thumb-1280.jpg", w: 1280, h: 640 }, + fit_2048: { src: "/thumb-2048.jpg", w: 2048, h: 1024 }, + fit_2560: { src: "/thumb-2560.jpg", w: 2560, h: 1280 }, + fit_3840: { src: "/thumb-3840.jpg", w: 3840, h: 1920 }, + fit_4096: { src: "/thumb-4096.jpg", w: 4096, h: 2048 }, + fit_7680: { src: "/thumb-7680.jpg", w: 7680, h: 3840 }, + }; + + it("returns sphere data for an equirectangular photo", () => { + const wrapper = mountLightbox(); + const model = { Hash: "abc", Projection: "equirectangular", Type: "image", Thumbs: baseThumbs, Title: "Pano" }; + const ctx = { ...wrapper.vm, models: [model], $util, getSlidePixels: () => ({ width: 2048, height: 1024 }) }; + + const slide = wrapper.vm.$options.methods.getItemData.call(ctx, null, 0); + expect(slide.type).toBe("html"); + expect(slide.isSphere).toBe(true); + expect(slide.isVideo).toBe(false); + expect(slide.src).toBeTruthy(); + }); + + it("returns sphere data with isVideo=true for an equirectangular video", () => { + const wrapper = mountLightbox(); + const model = { Hash: "vid", Projection: "equirectangular", Type: "video", Thumbs: baseThumbs, Codec: "avc1", Mime: "video/mp4", Playable: true }; + const ctx = { ...wrapper.vm, models: [model], $util, getSlidePixels: () => ({ width: 2048, height: 1024 }) }; + + const slide = wrapper.vm.$options.methods.getItemData.call(ctx, null, 0); + expect(slide.type).toBe("html"); + expect(slide.isSphere).toBe(true); + expect(slide.isVideo).toBe(true); + }); + + it("returns flat image data for a non-equirectangular photo (regression)", () => { + const wrapper = mountLightbox(); + const model = { Hash: "xyz", Projection: "", Type: "image", Thumbs: baseThumbs, Title: "Regular" }; + const ctx = { ...wrapper.vm, models: [model], $util, getSlidePixels: () => ({ width: 2048, height: 1024 }) }; + + const slide = wrapper.vm.$options.methods.getItemData.call(ctx, null, 0); + expect(slide.type).toBeUndefined(); + expect(slide.isSphere).toBeUndefined(); + expect(slide.src).toBeTruthy(); + }); + it("does NOT mount the sphere for an equirectangular-tagged photo that is not 2:1 (partial panorama)", () => { + const wrapper = mountLightbox(); + const model = { Hash: "strip", Projection: "equirectangular", Type: "image", Width: 8192, Height: 1024, Thumbs: baseThumbs, Title: "Wide" }; + const ctx = { ...wrapper.vm, models: [model], $util, getSlidePixels: () => ({ width: 2048, height: 1024 }) }; + + const slide = wrapper.vm.$options.methods.getItemData.call(ctx, null, 0); + expect(slide.isSphere).toBeUndefined(); + }); + it("does NOT mount the sphere for a cubemap video even when Panorama is flagged", () => { + const wrapper = mountLightbox(); + const model = { Hash: "cube", Projection: "cubemap", Panorama: true, Type: "video", Thumbs: baseThumbs, Codec: "avc1", Mime: "video/mp4", Playable: true }; + const ctx = { ...wrapper.vm, models: [model], $util, getSlidePixels: () => ({ width: 2048, height: 1024 }) }; + + const slide = wrapper.vm.$options.methods.getItemData.call(ctx, null, 0); + expect(slide.isSphere).toBeUndefined(); + }); + it("does NOT mount the sphere for an ultrawide (non-2:1) video flagged as panorama", () => { + const wrapper = mountLightbox(); + const model = { Hash: "wide", Projection: "", Panorama: true, Type: "video", Width: 3840, Height: 1632, Thumbs: baseThumbs, Codec: "avc1", Mime: "video/mp4", Playable: true }; + const ctx = { ...wrapper.vm, models: [model], $util, getSlidePixels: () => ({ width: 2048, height: 1024 }) }; + + const slide = wrapper.vm.$options.methods.getItemData.call(ctx, null, 0); + expect(slide.isSphere).toBeUndefined(); + }); + it("mounts the sphere for a 2:1 panorama video that carries no projection tag", () => { + const wrapper = mountLightbox(); + const model = { Hash: "vr", Projection: "", Panorama: true, Type: "video", Width: 3840, Height: 1920, Thumbs: baseThumbs, Codec: "avc1", Mime: "video/mp4", Playable: true }; + const ctx = { ...wrapper.vm, models: [model], $util, getSlidePixels: () => ({ width: 2048, height: 1024 }) }; + + const slide = wrapper.vm.$options.methods.getItemData.call(ctx, null, 0); + expect(slide.isSphere).toBe(true); + expect(slide.isVideo).toBe(true); + }); + }); + + // bindSphereVideoControls writes to the single shared `video` reactive state. + // PhotoSwipe preloads neighbors and sphere binding is async, so the controls + // bar must only turn on for the active slide — otherwise a preloaded 360° video + // flips the bar on while a plain photo is on screen. + describe("bindSphereVideoControls active-slide gating", () => { + const makeVideoState = () => ({ + controls: false, + error: "", + errorCode: 0, + duration: 0, + time: 0, + seekable: false, + playing: false, + paused: false, + ended: false, + }); + + it("turns controls on when its slide is the active one", () => { + const wrapper = mountLightbox(); + const videoEl = document.createElement("video"); + const content = { data: {} }; + const ctx = { video: makeVideoState(), videoEventListener: () => {}, pswp: () => ({ currSlide: { content } }) }; + + wrapper.vm.$options.methods.bindSphereVideoControls.call(ctx, content, videoEl); + expect(ctx.video.controls).toBe(true); + expect(content.data.events).toBeInstanceOf(AbortController); + }); + + it("leaves controls off for a preloaded (non-active) neighbor but still binds listeners", () => { + const wrapper = mountLightbox(); + const videoEl = document.createElement("video"); + const content = { data: {} }; + const activeContent = { data: {} }; + const ctx = { video: makeVideoState(), videoEventListener: () => {}, pswp: () => ({ currSlide: { content: activeContent } }) }; + + wrapper.vm.$options.methods.bindSphereVideoControls.call(ctx, content, videoEl); + expect(ctx.video.controls).toBe(false); + expect(content.data.events).toBeInstanceOf(AbortController); + }); + + it("leaves controls off when there is no PhotoSwipe instance", () => { + const wrapper = mountLightbox(); + const videoEl = document.createElement("video"); + const content = { data: {} }; + const ctx = { video: makeVideoState(), videoEventListener: () => {}, pswp: () => null }; + + wrapper.vm.$options.methods.bindSphereVideoControls.call(ctx, content, videoEl); + expect(ctx.video.controls).toBe(false); + }); + }); + + // slideZoomable drives the `.is-zoomable` class that shows/hides the zoom + // button. 360° slides must report false so the flat zoom button is hidden. + describe("slideZoomable", () => { + const slideZoomable = (data) => { + const wrapper = mountLightbox(); + return wrapper.vm.$options.methods.slideZoomable.call(wrapper.vm, data); + }; + + it("returns false for a 360° sphere slide", () => { + expect(slideZoomable({ isSphere: true, model: { Type: "image" } })).toBe(false); + }); + it("returns false for video and animation slides", () => { + expect(slideZoomable({ model: { Type: "video" } })).toBe(false); + expect(slideZoomable({ model: { Type: "animated" } })).toBe(false); + }); + it("returns true for a regular image and a live photo", () => { + expect(slideZoomable({ model: { Type: "image" } })).toBe(true); + expect(slideZoomable({ model: { Type: "live" } })).toBe(true); + }); + it("defaults to true when data or model is missing", () => { + expect(slideZoomable({})).toBe(true); + expect(slideZoomable(undefined)).toBe(true); + }); + }); + + // trapSphereGestures must swallow PhotoSwipe's pointer + wheel gestures on the + // sphere container, but must NOT trap touch events — Photo Sphere Viewer pans + // from touchmove/touchend listeners bound on `window`, so trapping touch here + // would break 360° panning on touch devices. A short press without a pan must + // toggle the lightbox controls so the prev/next arrows stay reachable on mobile. + describe("trapSphereGestures", () => { + const trap = () => { + const wrapper = mountLightbox(); + wrapper.vm.toggleControls = vi.fn(); + const registered = []; + const el = { addEventListener: (type, handler, opts) => registered.push({ type, handler, opts }) }; + wrapper.vm.$options.methods.trapSphereGestures.call(wrapper.vm, el); + const fire = (type, props = {}) => registered.filter((r) => r.type === type).forEach((r) => r.handler({ stopPropagation: () => {}, ...props })); + return { vm: wrapper.vm, registered, fire }; + }; + + it("traps pointer and wheel events", () => { + const types = trap().registered.map((r) => r.type); + expect(types).toEqual(expect.arrayContaining(["pointerdown", "pointermove", "pointerup", "pointercancel", "wheel"])); + }); + it("does NOT trap touch events so PSV panning works on mobile", () => { + const types = trap().registered.map((r) => r.type); + expect(types).not.toContain("touchstart"); + expect(types).not.toContain("touchmove"); + expect(types).not.toContain("touchend"); + }); + it("registers listeners in the bubble phase and stops propagation", () => { + const { registered } = trap(); + expect(registered.every((r) => r.opts && r.opts.capture === false)).toBe(true); + const ev = { stopPropagation: vi.fn() }; + registered[0].handler(ev); + expect(ev.stopPropagation).toHaveBeenCalledTimes(1); + }); + it("toggles controls on a touch tap without a pan", () => { + const { vm, fire } = trap(); + fire("pointerdown", { pointerType: "touch", clientX: 100, clientY: 100 }); + fire("pointerup", { pointerType: "touch", clientX: 103, clientY: 102 }); + expect(vm.toggleControls).toHaveBeenCalledTimes(1); + }); + it("does NOT toggle controls when the touch is a pan", () => { + const { vm, fire } = trap(); + fire("pointerdown", { pointerType: "touch", clientX: 100, clientY: 100 }); + fire("pointerup", { pointerType: "touch", clientX: 180, clientY: 100 }); + expect(vm.toggleControls).not.toHaveBeenCalled(); + }); + it("does NOT toggle controls for a mouse press so desktop is unchanged", () => { + const { vm, fire } = trap(); + fire("pointerdown", { pointerType: "mouse", clientX: 100, clientY: 100 }); + fire("pointerup", { pointerType: "mouse", clientX: 100, clientY: 100 }); + expect(vm.toggleControls).not.toHaveBeenCalled(); + }); + it("does NOT toggle controls when a tap is canceled", () => { + const { vm, fire } = trap(); + fire("pointerdown", { pointerType: "touch", clientX: 100, clientY: 100 }); + fire("pointercancel", { pointerType: "touch" }); + fire("pointerup", { pointerType: "touch", clientX: 100, clientY: 100 }); + expect(vm.toggleControls).not.toHaveBeenCalled(); + }); + it("does NOT toggle controls when the dialog capture handler paused on this pointer", () => { + const { vm, fire } = trap(); + // captureDialogPointerDown sets this flag when its pause revealed the controls; the + // tap-toggle must then leave them visible instead of toggling them away again. + vm._slideshowPausedByPointer = true; + fire("pointerdown", { pointerType: "touch", clientX: 100, clientY: 100 }); + fire("pointerup", { pointerType: "touch", clientX: 102, clientY: 101 }); + expect(vm.toggleControls).not.toHaveBeenCalled(); + }); + }); + + // The slideshow pauses on ANY interaction with the slide content — not just sphere + // gestures. The dialog's capture-phase handlers own this for every slide type, gated on + // pswpControl so a press on the chrome (close / arrows / top bar) does not pause. + describe("slideshow pause on content interaction", () => { + const methods = () => mountLightbox().vm.$options.methods; + const makeCtx = (active = true) => { + const m = methods(); + const ctx = { + debug: false, + hasTouch: false, + slideshow: { active }, + pauseSlideshow: vi.fn(function () { + this.slideshow.active = false; + }), + clearIdleTimeout: vi.fn(), + toggleVideo: vi.fn(), + }; + ctx.pswpControl = (ev) => m.pswpControl.call(ctx, ev); + ctx.captureDialogPointerDown = (ev) => m.captureDialogPointerDown.call(ctx, ev); + ctx.captureDialogWheel = (ev) => m.captureDialogWheel.call(ctx, ev); + return ctx; + }; + const evOn = (target) => ({ target, stopPropagation: vi.fn(), preventDefault: vi.fn() }); + const control = () => { + const btn = document.createElement("button"); + btn.className = "pswp__button"; + return btn; + }; + + it("pointerdown on slide content pauses a running slideshow", () => { + const ctx = makeCtx(true); + ctx.captureDialogPointerDown(evOn(document.createElement("div"))); + expect(ctx.pauseSlideshow).toHaveBeenCalledTimes(1); + expect(ctx._slideshowPausedByPointer).toBe(true); + }); + it("pointerdown on a control does NOT pause so buttons keep working", () => { + const ctx = makeCtx(true); + ctx.captureDialogPointerDown(evOn(control())); + expect(ctx.pauseSlideshow).not.toHaveBeenCalled(); + expect(ctx._slideshowPausedByPointer).toBe(false); + }); + it("pointerdown does not pause when no slideshow is running", () => { + const ctx = makeCtx(false); + ctx.captureDialogPointerDown(evOn(document.createElement("div"))); + expect(ctx.pauseSlideshow).not.toHaveBeenCalled(); + expect(ctx._slideshowPausedByPointer).toBe(false); + }); + it("pauses before toggling video so a media tap also stops the slideshow", () => { + const ctx = makeCtx(true); + ctx.captureDialogPointerDown(evOn(document.createElement("video"))); + expect(ctx.pauseSlideshow).toHaveBeenCalledTimes(1); + expect(ctx.toggleVideo).toHaveBeenCalledTimes(1); + }); + it("wheel-zoom on slide content pauses a running slideshow", () => { + const ctx = makeCtx(true); + ctx.captureDialogWheel(evOn(document.createElement("div"))); + expect(ctx.pauseSlideshow).toHaveBeenCalledTimes(1); + }); + it("wheel-zoom on a control does NOT pause", () => { + const ctx = makeCtx(true); + ctx.captureDialogWheel(evOn(control())); + expect(ctx.pauseSlideshow).not.toHaveBeenCalled(); + }); + it("wheel-zoom does nothing when no slideshow is running", () => { + const ctx = makeCtx(false); + ctx.captureDialogWheel(evOn(document.createElement("div"))); + expect(ctx.pauseSlideshow).not.toHaveBeenCalled(); + }); + it("ignores a missing wheel event", () => { + const ctx = makeCtx(true); + expect(() => ctx.captureDialogWheel(undefined)).not.toThrow(); + expect(ctx.pauseSlideshow).not.toHaveBeenCalled(); + }); + }); + + // setSphereClass marks the PhotoSwipe root so CSS can keep the prev/next arrows + // reachable on touch devices for 360° slides (PhotoSwipe hides them on touch). + describe("setSphereClass", () => { + const run = (enabled, hasEl = true) => { + const wrapper = mountLightbox(); + const el = document.createElement("div"); + wrapper.vm.pswp = () => (hasEl ? { element: el } : {}); + wrapper.vm.$options.methods.setSphereClass.call(wrapper.vm, enabled); + return el; + }; + + it("adds pswp--sphere for a sphere slide", () => { + expect(run(true).classList.contains("pswp--sphere")).toBe(true); + }); + it("removes pswp--sphere for a non-sphere slide", () => { + const wrapper = mountLightbox(); + const el = document.createElement("div"); + el.classList.add("pswp--sphere"); + wrapper.vm.pswp = () => ({ element: el }); + wrapper.vm.$options.methods.setSphereClass.call(wrapper.vm, false); + expect(el.classList.contains("pswp--sphere")).toBe(false); + }); + it("is a no-op when the PhotoSwipe element is missing", () => { + expect(() => run(true, false)).not.toThrow(); + }); + }); + + // A 360° sphere slide owns horizontal drag for panning, so PhotoSwipe's swipe-to- + // navigate must be suppressed at its source. The per-element gesture trap can be + // outrun by a fast swipe that leaves the sphere container (seen on touch-capable + // Windows), so onLightboxPointerEvent also default-prevents the dispatched pointer + // event whenever the active slide is a sphere. UI controls stay excluded. + describe("sphere swipe navigation block", () => { + const methods = () => mountLightbox().vm.$options.methods; + const makeCtx = (isSphere) => { + const m = methods(); + const ctx = { debug: false, pswp: () => ({ currSlide: { content: { data: { isSphere } } } }) }; + ctx.pswpControl = (ev) => m.pswpControl.call(ctx, ev); + ctx.activeSlideIsSphere = () => m.activeSlideIsSphere.call(ctx); + ctx.onLightboxPointerEvent = (ev) => m.onLightboxPointerEvent.call(ctx, ev); + return ctx; + }; + const makeEv = (target = document.createElement("div")) => ({ + type: "pointerDown", + originalEvent: { target }, + preventDefault: vi.fn(), + }); + + it("activeSlideIsSphere reflects the current slide content flag", () => { + const m = methods(); + expect(m.activeSlideIsSphere.call({ pswp: () => ({ currSlide: { content: { data: { isSphere: true } } } }) })).toBe(true); + expect(m.activeSlideIsSphere.call({ pswp: () => ({ currSlide: { content: { data: {} } } }) })).toBe(false); + expect(m.activeSlideIsSphere.call({ pswp: () => null })).toBe(false); + }); + it("prevents PhotoSwipe navigation for a pointer on a 360° sphere slide", () => { + const ev = makeEv(); + makeCtx(true).onLightboxPointerEvent(ev); + expect(ev.preventDefault).toHaveBeenCalledTimes(1); + }); + it("does NOT prevent navigation on a regular slide", () => { + const ev = makeEv(); + makeCtx(false).onLightboxPointerEvent(ev); + expect(ev.preventDefault).not.toHaveBeenCalled(); + }); + it("does NOT block a press on a UI control so buttons and arrows still navigate", () => { + const arrow = document.createElement("button"); + arrow.className = "pswp__button pswp__button--arrow"; + const ev = makeEv(arrow); + makeCtx(true).onLightboxPointerEvent(ev); + expect(ev.preventDefault).not.toHaveBeenCalled(); + }); + }); }); diff --git a/frontend/tests/vitest/component/lightbox/sidebar.test.js b/frontend/tests/vitest/component/lightbox/sidebar.test.js new file mode 100644 index 000000000..34ed706fc --- /dev/null +++ b/frontend/tests/vitest/component/lightbox/sidebar.test.js @@ -0,0 +1,4107 @@ +import { describe, it, expect, vi, beforeEach, afterEach } from "vitest"; +import { mount } from "@vue/test-utils"; +import PLightboxSidebar from "component/lightbox/sidebar.vue"; +import * as contexts from "options/contexts"; +import { DateTime } from "luxon"; +import $util from "common/util"; +import { Album } from "model/album"; +import typeaheadCache from "common/typeahead-cache"; +import { $faceMarkers } from "common/face-markers"; + +// Max name length used by the validation pipeline (matches the production +// "clip" client-config value). Override the global $config.get mock so the +// length-check branch can be exercised in tests. +const CLIP_LEN = 160; +const validationConfig = { + feature: () => true, + get: (key) => (key === "clip" ? CLIP_LEN : false), + getSettings: () => ({ features: { edit: true, favorites: true, download: true, archive: true } }), + allow: () => true, + deny: () => false, + featExperimental: () => false, + featDevelop: () => false, + values: {}, + dir: () => "ltr", +}; +// Mounted with the real $util.normalizeTitle so the validation pipeline +// runs against the same normalization the component uses at runtime. +// Other $util methods needed at render time are stubbed inline. +const validationUtil = { + normalizeTitle: (s) => $util.normalizeTitle(s), + formatCamera: (camera, id, make, model, long) => $util.formatCamera(camera, id, make, model, long), + typeName: (type, defaultValue) => $util.typeName(type, defaultValue), + encodeHTML: (s) => s, + sanitizeHtml: (s) => s, + copyText: vi.fn(), + hasTouch: () => false, + formatSeconds: (n) => String(n), + formatRemainingSeconds: () => "0", + videoFormat: () => "avc", + videoFormatUrl: () => "/v.mp4", + thumb: () => ({ src: "/t.jpg", w: 100, h: 100 }), +}; +// mountSidebar accepts the same option shape that the suite used to pass +// directly to `mount(PLightboxSidebar, ...)`. PLightboxSidebar no longer takes the +// legacy props (modelValue/photo/canEdit/context/markersVisible/...); they +// live on the parent lightbox's $data and are surfaced through $view.getData() +// (see lightbox.vue). This helper extracts the legacy keys from `options.props` +// and exposes them as a $view mock so existing tests keep working with only +// `mount(PLightboxSidebar, ` -> `mountSidebar(` renamed. +function mountSidebar(options = {}) { + const props = { ...(options.props || {}) }; + // Translate the legacy boolean props (`markersVisible` / `markersEdit`) + // into the new state-machine value (F2-1: `faceMarkerMode`). Tests + // pre-dating the enum still set the booleans; new tests can pass + // `faceMarkerMode` directly. + let faceMarkerMode = props.faceMarkerMode; + if (faceMarkerMode === undefined) { + if (props.markersEdit) { + faceMarkerMode = "edit"; + } else if (props.markersVisible) { + faceMarkerMode = "display"; + } else { + faceMarkerMode = null; + } + } + const legacy = { + model: props.modelValue, + photo: props.photo, + canEdit: props.canEdit, + contextAllowsEdit: true, + collection: props.collection, + context: props.context, + }; + + // Bridge legacy props that used to live on the parent lightbox $data + // into the shared face-markers singleton. The sidebar's computeds now + // read directly from `$faceMarkers` (mode / busy / pendingNameMarkerUid) + // so individual tests can still drive them via the friendly props + // (`markersVisible`, `markersEdit`, `markersBusy`, `newMarkerUid`). + // Each `mountSidebar()` call is treated as a fresh test scope. + $faceMarkers.reset(); + if (faceMarkerMode) { + $faceMarkers.setMode(faceMarkerMode); + } + if (props.markersBusy) { + $faceMarkers.setBusy(true); + } + if (props.newMarkerUid) { + $faceMarkers.setPendingNameMarkerUid(props.newMarkerUid); + } + + // Strip legacy keys so Vue does not warn about unknown props. + delete props.modelValue; + delete props.photo; + delete props.canEdit; + delete props.collection; + delete props.context; + delete props.markersVisible; + delete props.markersEdit; + delete props.faceMarkerMode; + delete props.markersBusy; + delete props.newMarkerUid; + + if (!props.uid && legacy.model && legacy.model.UID) { + props.uid = legacy.model.UID; + } + + const global = options.global || {}; + const mocks = global.mocks || {}; + const stubs = global.stubs || {}; + + return mount(PLightboxSidebar, { + ...options, + props, + global: { + ...global, + stubs: { PMap: true, ...stubs }, + mocks: { + $view: { getData: () => legacy, enter: () => {}, leave: () => {}, isActive: () => true }, + ...mocks, + }, + }, + }); +} + +function mountInfoForChips(props) { + return mountSidebar({ + props: { canEdit: true, context: contexts.Photos, ...props }, + global: { + mocks: { + $config: validationConfig, + $util: validationUtil, + }, + }, + }); +} + +// Mock dependencies +vi.mock("component/map.vue", () => ({ + default: { + name: "p-map", + template: "
", + props: ["latlng", "animateDuration"], + }, +})); + +vi.mock("options/formats", () => ({ + DATETIME_MED: "DATETIME_MED", + DATETIME_MED_TZ: "DATETIME_MED_TZ", +})); + +describe("PLightboxSidebar component", () => { + let wrapper; + let originalFromISO; + let mockModel; + let mockPhoto; + + function createMocks() { + mockModel = { + UID: "abc123", + Title: "Test Title", + Caption: "Test Caption", + TakenAtLocal: "2023-01-01T10:00:00Z", + TimeZone: "UTC", + Lat: 52.52, + Lng: 13.405, + getLatLng: vi.fn().mockReturnValue("52.5200°N 13.4050°E"), + getLatLngShort: vi.fn().mockReturnValue("52.5200°N 13.4050°E"), + copyLatLng: vi.fn(), + }; + + mockPhoto = { + UID: "ps6sg6be2lvl0y12", + Type: "image", + CameraID: 2, + CameraMake: "Canon", + CameraModel: "EOS R5", + LensID: 2, + LensMake: "Canon", + LensModel: "RF 50mm F1.2L", + getCameraInfo: vi.fn().mockReturnValue("Canon EOS R5"), + getLensInfo: vi.fn().mockReturnValue("RF 50mm F1.2L"), + getImageInfo: vi.fn().mockReturnValue("JPEG, 1920 × 1080, 4.2 MB"), + getVideoInfo: vi.fn().mockReturnValue(""), + getVectorInfo: vi.fn().mockReturnValue(""), + getExifInfo: vi.fn().mockReturnValue("50mm \u2022 \u0192/1.2 \u2022 ISO 400 \u2022 1/125"), + PlaceLabel: "Berlin, Germany", + Country: "de", + placeName: vi.fn().mockReturnValue("Berlin, Germany"), + locationInfo: vi.fn().mockReturnValue("Berlin, Germany"), + getMarkers: vi.fn().mockReturnValue([ + { UID: "m1", CropID: "crop1", Name: "Jane Doe", SubjUID: "subj1", thumbnailUrl: () => "/t/thumb1/public/tile_160" }, + { UID: "m2", CropID: "crop2", Name: "", SubjUID: "", thumbnailUrl: () => "/svg/portrait" }, + ]), + Labels: [ + { Uncertainty: 0, Label: { ID: 1, UID: "lbl1", Name: "Nature", Slug: "nature", CustomSlug: "" } }, + { Uncertainty: 0, Label: { ID: 2, UID: "lbl2", Name: "Landscape", Slug: "landscape", CustomSlug: "custom-landscape" } }, + ], + Albums: [ + { UID: "alb1", Title: "Vacation 2023", Slug: "vacation-2023" }, + { UID: "alb2", Title: "Favorites", Slug: "favorites" }, + ], + Details: { + Notes: "Some notes about this photo", + Subject: "Mountains", + Artist: "John Photographer", + Copyright: "2023 John", + License: "CC BY 4.0", + Keywords: "nature, mountains, sunset", + }, + FileName: "photos/2023/IMG_001.jpg", + OriginalName: "IMG_001_original.jpg", + // Album/label membership writes — the sidebar's instant-save additions + // path (addLabelImmediate / addAlbumImmediate) and the batched removal + // path (confirmLabels / confirmAlbums) all route through these. + addLabel: vi.fn().mockResolvedValue({}), + removeLabel: vi.fn().mockResolvedValue({}), + addToAlbum: vi.fn().mockResolvedValue({}), + removeFromAlbum: vi.fn().mockResolvedValue({}), + }; + } + + beforeEach(() => { + // typeaheadCache is module-scope; clear it before each test so a + // cached labels/albums list from a previous test doesn't bleed + // into the next one's network-spy assertions. + typeaheadCache.clear(); + createMocks(); + + originalFromISO = DateTime.fromISO; + DateTime.fromISO = vi.fn().mockImplementation(() => ({ + toLocaleString: () => "January 1, 2023, 10:00 AM", + })); + + wrapper = mountSidebar({ + props: { + modelValue: mockModel, + photo: mockPhoto, + context: contexts.Photos, + }, + global: { + stubs: { + PMap: true, + }, + }, + }); + }); + + afterEach(() => { + DateTime.fromISO = originalFromISO; + if (wrapper) { + wrapper.unmount(); + wrapper = null; + } + }); + + it("should render correctly with model data", () => { + expect(wrapper.vm).toBeTruthy(); + expect(wrapper.find(".p-lightbox-sidebar").exists()).toBe(true); + + const html = wrapper.html(); + expect(html).toContain("Test Title"); + expect(html).toContain("Test Caption"); + expect(html).toContain("photos/2023/IMG_001.jpg"); + expect(html).toContain("JPEG, 1920 × 1080, 4.2 MB"); + + expect(mockPhoto.getImageInfo).toHaveBeenCalled(); + expect(mockModel.getLatLngShort).toHaveBeenCalled(); + }); + + it("should not render an inline pencil next to the file row", () => { + const fileRow = wrapper.find(".meta-file"); + expect(fileRow.exists()).toBe(true); + // The file row is intentionally non-editable: it merges the type/ + // size title with the filename subtitle and uses click-to-copy + // (which doesn't need a pencil affordance). The mdi-* prepend icon + // is intentional and decorative. + expect(fileRow.find(".meta-inline-pencil").exists()).toBe(false); + expect(fileRow.text()).toContain(mockPhoto.FileName); + }); + + it("should render file info row with the file metadata text", () => { + const html = wrapper.html(); + expect(html).toContain("JPEG, 1920 × 1080, 4.2 MB"); + }); + + it("should emit close event when close button is clicked", async () => { + const onClose = vi.fn(); + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, context: contexts.Photos, onClose }, + global: { stubs: { PMap: true } }, + }); + const closeButton = w.findAll("button")[0]; + await closeButton.trigger("click"); + expect(onClose).toHaveBeenCalled(); + }); + + it("should trigger copyLatLng when the coordinates row is clicked", async () => { + const coordinatesRow = wrapper.find(".meta-coordinates"); + expect(coordinatesRow.exists()).toBe(true); + await coordinatesRow.trigger("click"); + expect(mockModel.copyLatLng).toHaveBeenCalled(); + }); + + it("should handle model without taken time", () => { + const formattedTime = wrapper.vm.formatTime({ ...mockModel, TakenAtLocal: null }); + expect(formattedTime).toBe("Unknown"); + }); + + // Regression: formatTime() used to derive Day=1 / Jan 1 for every + // Year/Month/Day=-1 (Unknown) photo because it formatted the padded + // TakenAtLocal directly. The Thumb model from viewer.Result carries + // no Year/Month/Day, so the right fix is to delegate to the full + // Photo's getDateString() — which already handles the Unknown + // fallback — whenever the full Photo is loaded. + it("delegates to photo.getDateString(true) when the full Photo is loaded", () => { + const getDateString = vi.fn().mockReturnValue("June 2024"); + const photo = { ...mockPhoto, getDateString }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + + const result = w.vm.formatTime(mockModel); + + expect(getDateString).toHaveBeenCalledWith(true); + expect(result).toBe("June 2024"); + }); + + // Limited-access sessions get an empty Photo placeholder whose default + // getDateString() renders "Unknown" against empty Year/Month/Day. The UID + // gate makes formatTime fall through to the Thumb's TakenAtLocal instead. + it("skips photo.getDateString and uses Thumb.TakenAtLocal for the empty Photo placeholder", () => { + const getDateString = vi.fn().mockReturnValue("Unknown"); + const emptyPhoto = { UID: "", getDateString, getMarkers: vi.fn().mockReturnValue([]) }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo: emptyPhoto, canEdit: false, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + + const result = w.vm.formatTime(mockModel); + + expect(getDateString).not.toHaveBeenCalled(); + expect(result).toBe("January 1, 2023, 10:00 AM"); + }); + + // Camera, lens, and EXIF info + it("should display camera info from photo prop", () => { + expect(wrapper.vm.cameraInfo).toBe("Canon EOS R5"); + }); + + it("should display lens info from photo prop", () => { + expect(wrapper.vm.lensInfo).toBe("RF 50mm F1.2L"); + }); + + it("should display EXIF info from photo prop", () => { + expect(wrapper.vm.exifInfo).toBe("50mm \u2022 \u0192/1.2 \u2022 ISO 400 \u2022 1/125"); + }); + + it("should hide camera info when value is Unknown", () => { + const photo = { ...mockPhoto, getCameraInfo: vi.fn().mockReturnValue("Unknown"), getMarkers: vi.fn().mockReturnValue([]) }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.vm.cameraInfo).toBe(""); + }); + + it("should hide camera row in read-only mode when only ISO/exposure are set", () => { + const photo = { + ...mockPhoto, + CameraID: 1, + CameraMake: "", + CameraModel: "", + Iso: 100, + Exposure: "1/125", + getCameraInfo: vi.fn().mockReturnValue("Unknown, ISO 100, 1/125"), + getMarkers: vi.fn().mockReturnValue([]), + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: false, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.vm.cameraInfo).toBe(""); + expect(w.html()).not.toContain("mdi-camera "); + }); + + // Backend hydrates every photo with the "Unknown" placeholder camera + // (CameraID=1, Camera={Make:"", Model:"Unknown"}). The read-only sidebar + // must not surface that as an empty " Unknown" row. + it("should hide camera row when backend returns the Unknown placeholder camera", () => { + const photo = { + ...mockPhoto, + CameraID: 1, + Camera: { ID: 1, Make: "", Model: "Unknown", Slug: "zz" }, + CameraMake: "", + CameraModel: "Unknown", + Iso: 0, + Exposure: "", + getCameraInfo: vi.fn().mockReturnValue(" Unknown"), + getMarkers: vi.fn().mockReturnValue([]), + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: false, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.vm.cameraInfo).toBe(""); + expect(w.html()).not.toContain("mdi-camera "); + }); + + // Editable users (admin) need an actionable camera row even when the + // photo has no camera set — hide the cameraInfo text would leave the row + // blank with just a pencil icon. Fall back to "Unknown" so the intent is + // clear and the click target is discoverable. + it("should show 'Unknown' in the camera row for editable users when no camera info is set", () => { + const photo = { + ...mockPhoto, + CameraID: 1, + Camera: { ID: 1, Make: "", Model: "Unknown", Slug: "zz" }, + CameraMake: "", + CameraModel: "Unknown", + Iso: 0, + Exposure: "", + getCameraInfo: vi.fn().mockReturnValue(" Unknown"), + getMarkers: vi.fn().mockReturnValue([]), + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + // cameraInfo itself stays suppressed; the template falls back to the + // localized "Unknown" placeholder only when the row is visible. + expect(w.vm.cameraInfo).toBe(""); + const cameraRow = w.find(".v-list-item [class*='mdi-camera']")?.element?.closest(".v-list-item"); + expect(cameraRow).toBeTruthy(); + expect(cameraRow.textContent).toContain("Unknown"); + }); + + it("should hide lens row when only FNumber/FocalLength are set without a real lens", () => { + const photo = { + ...mockPhoto, + LensID: 1, + LensMake: "", + LensModel: "", + Lens: null, + FNumber: 1.8, + FocalLength: 50, + getLensInfo: vi.fn().mockReturnValue("50mm, ƒ/1.8"), + getMarkers: vi.fn().mockReturnValue([]), + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: false, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.vm.lensInfo).toBe(""); + }); + + it("should return empty strings when photo prop is null", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: null, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.vm.cameraInfo).toBe(""); + expect(w.vm.lensInfo).toBe(""); + expect(w.vm.exifInfo).toBe(""); + expect(w.vm.people).toEqual([]); + expect(w.vm.labels).toEqual([]); + expect(w.vm.albums).toEqual([]); + expect(w.vm.placeName).toBe(""); + // fileName returns null (not "") so the merged file row's + // `:subtitle` binding skips rendering an empty subtitle element — + // Vuetify gates the subtitle on `props.subtitle != null`, so "" would + // still render an empty slot. + expect(w.vm.fileName).toBeNull(); + expect(w.vm.fileInfo).toBe(""); + expect(w.vm.subject).toBe(""); + expect(w.vm.artist).toBe(""); + expect(w.vm.copyright).toBe(""); + expect(w.vm.license).toBe(""); + expect(w.vm.keywords).toBe(""); + expect(w.vm.notesHtml).toBe(""); + }); + + // People + it("should return all markers including unnamed", () => { + expect(wrapper.vm.people).toHaveLength(2); + expect(wrapper.vm.people[0].Name).toBe("Jane Doe"); + expect(wrapper.vm.people[1].Name).toBe(""); + }); + + it("should render person rows with avatars", () => { + const personRows = wrapper.findAll(".metadata__person-row"); + expect(personRows.length).toBe(2); + + const avatars = wrapper.findAll(".meta-person__avatar"); + expect(avatars.length).toBe(2); + }); + + it("should make the avatar of named people clickable for navigation", () => { + const personRows = wrapper.findAll(".metadata__person-row"); + const namedAvatar = personRows[0].find(".meta-person__avatar"); + const unnamedAvatar = personRows[1].find(".meta-person__avatar"); + expect(namedAvatar.classes()).toContain("clickable"); + expect(unnamedAvatar.classes()).not.toContain("clickable"); + }); + + // People section: per-role toggle in the header (#append slot of the + // section row). Editable users see ONLY the pencil/pencil-off "Edit + // Faces" toggle — draw mode is a strict superset of display mode for + // them, so a separate eye toggle adds no value. Non-editable users + // see ONLY the eye/eye-off "Show face markers" toggle and only when + // there is at least one marker to view. The state machine + // (`$faceMarkers`) still has both FaceMarkerDisplay and FaceMarkerEdit; + // each role just exposes one of the two via its button. + it("should render the People header with only the pencil toggle when editable", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.html()).toContain("People"); + expect(w.find(".meta-faces-edit").exists()).toBe(true); + // `.meta-markers-toggle` is shared by both toggle variants (the eye + // for read-only display and the pencil for edit, since edit-mode also + // toggles visibility). `.meta-faces-display` is the eye-only + // discriminator that should be absent in editable contexts. + expect(w.find(".meta-faces-display").exists()).toBe(false); + }); + + it("should render the pencil toggle even when the photo has no face markers (so editable users can add the first one)", () => { + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([]) }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.html()).toContain("People"); + expect(w.find(".meta-faces-edit").exists()).toBe(true); + expect(w.find(".meta-faces-display").exists()).toBe(false); + }); + + it("should render only the eye toggle when not editable, on a photo with face markers", () => { + // The default wrapper is mounted without canEdit → isEditable false. + // The eye toggle is the only marker control non-editable users see; + // the pencil toggle is editable-only. + expect(wrapper.find(".meta-markers-toggle").exists()).toBe(true); + expect(wrapper.find(".meta-faces-edit").exists()).toBe(false); + }); + + it("should still list named people when not editable but the photo has markers", () => { + expect(wrapper.find(".metadata__person-row").exists()).toBe(true); + expect(wrapper.html()).toContain("Jane Doe"); + }); + + it("should hide the People section entirely when not editable and there are no markers", () => { + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([]) }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.html()).not.toContain("People"); + }); + + it("should reflect the markersVisible state on the eye toggle (non-editable role)", () => { + // Eye toggle is non-editable-only; markersVisible = true paints the + // is-active class so the icon flips to `mdi-eye-off-outline`. + const w = mountSidebar({ + props: { + modelValue: mockModel, + photo: mockPhoto, + context: contexts.Photos, + markersVisible: true, + }, + global: { stubs: { PMap: true } }, + }); + const toggle = w.find(".meta-markers-toggle"); + expect(toggle.exists()).toBe(true); + expect(toggle.classes()).toContain("is-active"); + expect(toggle.find("i.mdi-eye-off-outline").exists()).toBe(true); + }); + + it("should emit toggle-face-marker-mode when the eye icon is clicked (non-editable role)", async () => { + const onToggle = vi.fn(); + const w = mountSidebar({ + props: { + "modelValue": mockModel, + "photo": mockPhoto, + "context": contexts.Photos, + "onToggleFaceMarkerMode": onToggle, + }, + global: { stubs: { PMap: true } }, + }); + await w.find(".meta-markers-toggle").trigger("click"); + expect(onToggle).toHaveBeenCalled(); + }); + + it("should emit toggle-face-marker-edit when the + icon is clicked", async () => { + const onToggle = vi.fn(); + const w = mountSidebar({ + props: { + "modelValue": mockModel, + "photo": mockPhoto, + "canEdit": true, + "context": contexts.Photos, + "onToggleFaceMarkerEdit": onToggle, + }, + global: { stubs: { PMap: true } }, + }); + const btn = w.find(".meta-faces-edit"); + // After the v-icon → v-btn refactor the mdi-* class lives on the + // nested inside the button, not on the button itself. The + // "Edit Faces" toggle uses pencil / pencil-off icons (was +/check + // when the toggle's role was "Add face"; now it enters edit mode + // which covers add AND remove via the overlay). + expect(btn.find("i.mdi-pencil-outline").exists()).toBe(true); + await btn.trigger("click"); + expect(onToggle).toHaveBeenCalled(); + }); + + it("should swap the edit icon to pencil-off while markersEdit is true", () => { + const w = mountSidebar({ + props: { + modelValue: mockModel, + photo: mockPhoto, + canEdit: true, + context: contexts.Photos, + markersEdit: true, + }, + global: { stubs: { PMap: true } }, + }); + const btn = w.find(".meta-faces-edit"); + expect(btn.classes()).toContain("is-active"); + expect(btn.find("i.mdi-pencil-off-outline").exists()).toBe(true); + }); + + it("should still emit toggle-face-marker-edit when markersEdit is true (so the user can exit)", async () => { + const onToggle = vi.fn(); + const w = mountSidebar({ + props: { + "modelValue": mockModel, + "photo": mockPhoto, + "canEdit": true, + "context": contexts.Photos, + "markersEdit": true, + "onToggleFaceMarkerEdit": onToggle, + }, + global: { stubs: { PMap: true } }, + }); + await w.find(".meta-faces-edit").trigger("click"); + expect(onToggle).toHaveBeenCalled(); + }); + + // The per-row mdi-close button (formerly .meta-marker-remove inside + // the combobox's #append-inner slot) was retired: it looked like a + // "clear input" affordance but rejected the marker on the backend + // without confirmation. Removal now lives on the face-marker overlay + // — see tests/vitest/component/meta/face/markers.test.js for + // the click-to-remove + confirm-pill flow. + it("should not render a per-row remove icon on any person row", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + const personRows = w.findAll(".metadata__person-row"); + for (const row of personRows) { + expect(row.find(".meta-marker-remove").exists()).toBe(false); + } + }); + + it("should refuse to emit toggle-face-marker-mode / toggle-face-marker-edit while markersBusy is true", () => { + const onToggleMode = vi.fn(); + const onToggleDraw = vi.fn(); + const w = mountSidebar({ + props: { + "modelValue": mockModel, + "photo": mockPhoto, + "canEdit": true, + "context": contexts.Photos, + "markersBusy": true, + "onToggleFaceMarkerMode": onToggleMode, + "onToggleFaceMarkerEdit": onToggleDraw, + }, + global: { stubs: { PMap: true } }, + }); + w.vm.onToggleFaceMarkerMode(); + w.vm.onToggleFaceMarkerEdit(); + expect(onToggleMode).not.toHaveBeenCalled(); + expect(onToggleDraw).not.toHaveBeenCalled(); + }); + + it("should render an inline name input for every marker when canEdit is true", () => { + const w = mountSidebar({ + props: { + modelValue: mockModel, + photo: mockPhoto, + canEdit: true, + context: contexts.Photos, + markersVisible: true, + markersEdit: true, + }, + global: { stubs: { PMap: true } }, + }); + // One input per marker row — no pencil click required to edit. + const inputs = w.findAll(".meta-inline-marker"); + expect(inputs.length).toBe(2); + expect(w.find(".meta-inline-pencil.meta-person-pencil").exists()).toBe(false); + }); + + // Feature flag gate (Task 4): when $config.feature('people') is false, + // the entire People section is hidden regardless of marker presence. + it("should hide the People section when the people feature is disabled", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { + stubs: { PMap: true }, + mocks: { + $config: { feature: (key) => key !== "people", get: () => false, allow: () => true, values: {}, dir: () => "ltr" }, + }, + }, + }); + expect(w.html()).not.toContain("People"); + expect(w.find(".meta-markers-toggle").exists()).toBe(false); + expect(w.find(".meta-faces-edit").exists()).toBe(false); + expect(w.find(".metadata__person-row").exists()).toBe(false); + }); + + // Unassign button: named markers expose mdi-eject inside the + // combobox's #append-inner slot, but only while the People section + // is in edit mode (pencil on) — gated so a casual hover can't + // accidentally clear a face's subject assignment. + it("should render the Unassign icon on a named marker in edit mode and emit clear-subject on click", async () => { + const onClearSubject = vi.fn(); + const w = mountSidebar({ + props: { + "modelValue": mockModel, + "photo": mockPhoto, + "canEdit": true, + "context": contexts.Photos, + "markersEdit": true, + "onClearSubject": onClearSubject, + }, + global: { stubs: { PMap: true } }, + }); + const personRows = w.findAll(".metadata__person-row"); + // First row: Jane Doe (SubjUID set). + const clearSubjectIcon = personRows[0].find(".meta-marker-clear-subject"); + expect(clearSubjectIcon.exists()).toBe(true); + // Unnamed marker should NOT have an Unassign icon. + expect(personRows[1].find(".meta-marker-clear-subject").exists()).toBe(false); + await clearSubjectIcon.trigger("click"); + expect(onClearSubject).toHaveBeenCalledTimes(1); + expect(onClearSubject.mock.calls[0][0].UID).toBe("m1"); + }); + + it("should hide the Unassign icon on a named marker when not in edit mode", () => { + const w = mountSidebar({ + props: { + modelValue: mockModel, + photo: mockPhoto, + canEdit: true, + context: contexts.Photos, + }, + global: { stubs: { PMap: true } }, + }); + const personRows = w.findAll(".metadata__person-row"); + // Even though the first row is named, the Unassign affordance is + // suppressed outside edit mode. + expect(personRows[0].find(".meta-marker-clear-subject").exists()).toBe(false); + }); + + // Named markers keep the combobox (so named and unnamed rows look + // identical) but render it readonly — renaming a named face requires + // ejecting first. Mirrors the edit dialog's People tab gate. + it("should render the named marker combobox as readonly", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + const personRows = w.findAll(".metadata__person-row"); + const namedInput = personRows[0].find(".meta-inline-marker--named input"); + expect(namedInput.exists()).toBe(true); + expect(namedInput.element.readOnly).toBe(true); + const unnamedInput = personRows[1].find(".meta-inline-marker input"); + expect(unnamedInput.exists()).toBe(true); + expect(unnamedInput.element.readOnly).toBe(false); + }); + + // The default dropdown chevron (`.v-combobox__menu-icon`) is suppressed + // unconditionally on every marker combobox via `:menu-icon="null"` — + // both named (readonly) and unnamed rows. Auto-open-on-focus is the + // discovery affordance for the knownPeople dropdown; the chevron is + // redundant with the inline edit affordances (× / ⏏ buttons) and was + // misleading on named, readonly rows where ejecting is the only path + // to a new name. Mock $config supplies one known person because + // Vuetify additionally gates the chevron on `items.length > 0`, and + // we want a state in which Vuetify *would* render it if it were not + // suppressed by the prop. + it("should hide the v-combobox menu-icon on every marker row", () => { + const config = { + ...validationConfig, + values: { people: [{ UID: "sXYZ", Name: "Alice Smith" }] }, + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { mocks: { $config: config, $util: validationUtil } }, + }); + const personRows = w.findAll(".metadata__person-row"); + // First row: Jane Doe (SubjUID set) — chevron absent. + expect(personRows[0].find(".v-combobox__menu-icon").exists()).toBe(false); + // Second row: unnamed marker — chevron also absent. + expect(personRows[1].find(".v-combobox__menu-icon").exists()).toBe(false); + }); + + it("should refuse to emit clear-subject on a marker without SubjUID", () => { + const onClearSubject = vi.fn(); + const w = mountSidebar({ + props: { + "modelValue": mockModel, + "photo": mockPhoto, + "canEdit": true, + "context": contexts.Photos, + "onClearSubject": onClearSubject, + }, + global: { stubs: { PMap: true } }, + }); + w.vm.onClearSubject({ UID: "mX", SubjUID: "", Name: "" }); + expect(onClearSubject).not.toHaveBeenCalled(); + }); + + it("should refuse to emit clear-subject while markersBusy is true", () => { + const onClearSubject = vi.fn(); + const w = mountSidebar({ + props: { + "modelValue": mockModel, + "photo": mockPhoto, + "canEdit": true, + "context": contexts.Photos, + "markersBusy": true, + "onClearSubject": onClearSubject, + }, + global: { stubs: { PMap: true } }, + }); + w.vm.onClearSubject({ UID: "m1", SubjUID: "subj1", Name: "Jane Doe" }); + expect(onClearSubject).not.toHaveBeenCalled(); + }); + + // pendingNameMarkerUid focuses the input on the freshly-created marker and + // emits naming-started so the parent (lightbox) can clear its own state. + // The value lives on the shared face-markers singleton; mutating it + // triggers the sidebar's `newMarkerUid` computed and its watcher. + it("should focus the matching marker input when pendingNameMarkerUid changes", async () => { + const onNamingStarted = vi.fn(); + const w = mountSidebar({ + props: { + "modelValue": mockModel, + "photo": mockPhoto, + "canEdit": true, + "context": contexts.Photos, + "newMarkerUid": null, + "onNamingStarted": onNamingStarted, + }, + global: { stubs: { PMap: true } }, + attachTo: document.body, + }); + $faceMarkers.setPendingNameMarkerUid("m2"); + await w.vm.$nextTick(); + await w.vm.$nextTick(); + expect(onNamingStarted).toHaveBeenCalled(); + w.unmount(); + }); + + it("should call marker.setName and emit reload-markers when confirming an inline name", async () => { + const setName = vi.fn().mockResolvedValue(undefined); + const namedMarker = { + UID: "m2", + CropID: "crop2", + Name: "", + SubjUID: "", + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName, + }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([namedMarker]) }; + const onReload = vi.fn(); + const w = mountSidebar({ + props: { + "modelValue": mockModel, + "photo": photo, + "canEdit": true, + "context": contexts.Photos, + "onReloadMarkers": onReload, + }, + global: { stubs: { PMap: true } }, + }); + w.vm.setMarkerInputValue("m2", "Alice"); + w.vm.confirmMarkerName(namedMarker); + expect(namedMarker.Name).toBe("Alice"); + expect(setName).toHaveBeenCalled(); + await new Promise((r) => setTimeout(r, 0)); + expect(onReload).toHaveBeenCalled(); + expect(w.vm.hasPendingEdit()).toBe(false); + }); + + it("should revert the draft to the marker's saved name when cancelMarkerName runs", async () => { + const markers = mockPhoto.getMarkers(); + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m1", "Changed"); + expect(w.vm.hasPendingEdit()).toBe(true); + w.vm.cancelMarkerName(markers[0]); + expect(w.vm.markerInputValue("m1")).toBe("Jane Doe"); + expect(w.vm.hasPendingEdit()).toBe(false); + }); + + it("should link an existing subject when the typed name matches a known person", async () => { + const setName = vi.fn().mockResolvedValue(undefined); + const namedMarker = { + UID: "m2", + Name: "", + SubjUID: "", + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName, + }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([namedMarker]) }; + const knownPersonConfig = { + feature: () => true, + get: () => false, + getSettings: () => ({ features: { edit: true } }), + allow: () => true, + featExperimental: () => false, + featDevelop: () => false, + values: { people: [{ UID: "sXYZ", Name: "Alice Smith" }] }, + dir: () => "ltr", + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { + stubs: { PMap: true }, + mocks: { $config: knownPersonConfig }, + }, + }); + await w.vm.$nextTick(); + w.vm.chipState.people.options = [{ UID: "sXYZ", Name: "Alice Smith" }]; + w.vm.setMarkerInputValue("m2", "alice smith"); + w.vm.confirmMarkerName(namedMarker); + expect(namedMarker.Name).toBe("Alice Smith"); + expect(namedMarker.SubjUID).toBe("sXYZ"); + expect(setName).toHaveBeenCalled(); + }); + + it("should commit immediately when onPickPerson selects a dropdown item", async () => { + const setName = vi.fn().mockResolvedValue(undefined); + const namedMarker = { + UID: "m2", + Name: "", + SubjUID: "", + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName, + }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([namedMarker]) }; + const knownPersonConfig = { + feature: () => true, + get: () => false, + getSettings: () => ({ features: { edit: true } }), + allow: () => true, + featExperimental: () => false, + featDevelop: () => false, + values: { people: [{ UID: "sBOB", Name: "Bob" }] }, + dir: () => "ltr", + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { + stubs: { PMap: true }, + mocks: { $config: knownPersonConfig }, + }, + }); + await w.vm.$nextTick(); + w.vm.chipState.people.options = [{ UID: "sBOB", Name: "Bob" }]; + w.vm.onPickPerson(namedMarker, { UID: "sBOB", Name: "Bob" }); + expect(namedMarker.Name).toBe("Bob"); + expect(namedMarker.SubjUID).toBe("sBOB"); + expect(setName).toHaveBeenCalled(); + }); + + it("should populate knownPeople from typeaheadCache.getPeople", async () => { + typeaheadCache.clear(); + const cacheSpy = vi.spyOn(typeaheadCache, "getPeople").mockResolvedValue([ + { UID: "sA", Name: "Alice" }, + { UID: "sB", Name: "Bob" }, + ]); + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.loadChipOptions("people"); + await Promise.resolve(); + await Promise.resolve(); + expect(cacheSpy).toHaveBeenCalled(); + expect(w.vm.knownPeople).toHaveLength(2); + expect(w.vm.knownPeople[0].Name).toBe("Alice"); + cacheSpy.mockRestore(); + }); + + it("should start with an empty knownPeople list before the cache loads", () => { + typeaheadCache.clear(); + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.vm.knownPeople).toEqual([]); + }); + + // Locks in the focus-before-resolve flow: loadChipOptions (combobox @focus) + // may run while the people fetch is still in flight; knownPeople stays empty + // until it resolves, then populates without any synchronous read hazard. + it("knownPeople stays empty until the people fetch resolves, then populates", async () => { + typeaheadCache.clear(); + let resolveFn; + const deferred = new Promise((resolve) => (resolveFn = resolve)); + const spy = vi.spyOn(typeaheadCache, "getPeople").mockReturnValue(deferred); + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.chipState.people.options = []; + w.vm.loadChipOptions("people"); + await Promise.resolve(); + expect(w.vm.knownPeople).toEqual([]); + resolveFn([{ UID: "sA", Name: "Alice" }]); + await Promise.resolve(); + await Promise.resolve(); + expect(w.vm.knownPeople).toEqual([{ Name: "Alice", UID: "sA" }]); + spy.mockRestore(); + }); + + it("should not confirm an empty name (treats it as cancel)", async () => { + const setName = vi.fn(); + const namedMarker = { + UID: "m2", + Name: "", + SubjUID: "", + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName, + }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([namedMarker]) }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m2", " "); + w.vm.confirmMarkerName(namedMarker); + expect(setName).not.toHaveBeenCalled(); + }); + + // Blur on an unnamed marker with a new name (and no matching known person) + // must prompt the user before persisting, mirroring the people-tab pattern. + it("should open the Add-name dialog on blur for an unnamed marker with a novel name", async () => { + const setName = vi.fn().mockResolvedValue(undefined); + const marker = { + UID: "m2", + Name: "", + SubjUID: "", + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName, + }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([marker]) }; + const w = mountInfoForChips({ modelValue: mockModel, photo }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m2", "Plane Port"); + w.vm.confirmMarkerName(marker, "blur"); + expect(setName).not.toHaveBeenCalled(); + expect(w.vm.addNameDialog.visible).toBe(true); + expect(w.vm.addNameDialog.markerUid).toBe("m2"); + expect(w.vm.addNameDialog.name).toBe("Plane Port"); + }); + + it("should persist when the Add-name dialog is confirmed", async () => { + const setName = vi.fn().mockResolvedValue(undefined); + const marker = { + UID: "m2", + Name: "", + SubjUID: "", + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName, + }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([marker]) }; + const w = mountInfoForChips({ modelValue: mockModel, photo }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m2", "Plane Port"); + w.vm.confirmMarkerName(marker, "blur"); + expect(w.vm.addNameDialog.visible).toBe(true); + w.vm.onAddNameConfirm(); + expect(marker.Name).toBe("Plane Port"); + expect(setName).toHaveBeenCalledTimes(1); + expect(w.vm.addNameDialog.visible).toBe(false); + }); + + it("should revert the input and skip save when the Add-name dialog is canceled", async () => { + const setName = vi.fn(); + const marker = { + UID: "m2", + Name: "", + SubjUID: "", + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName, + }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([marker]) }; + const w = mountInfoForChips({ modelValue: mockModel, photo }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m2", "Plane Port"); + w.vm.confirmMarkerName(marker, "blur"); + w.vm.onAddNameCancel(); + expect(setName).not.toHaveBeenCalled(); + expect(w.vm.addNameDialog.visible).toBe(false); + expect(w.vm.markerInputValue("m2")).toBe(""); + }); + + // Skip the dialog when the typed name already resolves to a known subject — + // there's nothing ambiguous to ask about. + it("should skip the Add-name dialog and save immediately on blur when the name matches a known person", async () => { + const setName = vi.fn().mockResolvedValue(undefined); + const marker = { + UID: "m2", + Name: "", + SubjUID: "", + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName, + }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([marker]) }; + const knownPersonConfig = { + ...validationConfig, + values: { people: [{ UID: "sALC", Name: "Alice Smith" }] }, + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { + stubs: { PMap: true }, + mocks: { $config: knownPersonConfig, $util: validationUtil }, + }, + }); + await w.vm.$nextTick(); + w.vm.chipState.people.options = [{ UID: "sALC", Name: "Alice Smith" }]; + w.vm.setMarkerInputValue("m2", "alice smith"); + w.vm.confirmMarkerName(marker, "blur"); + expect(w.vm.addNameDialog.visible).toBe(false); + expect(setName).toHaveBeenCalled(); + expect(marker.Name).toBe("Alice Smith"); + expect(marker.SubjUID).toBe("sALC"); + }); + + // P1-1 — locale-aware case-insensitive match. The previous "en" locale + // missed matches under Turkish dotted/dotless i and other non-ASCII case + // folding rules; we now use `undefined` to defer to the active locale. + // The standard ECMAScript Intl implementation handles Cyrillic case + // collation under base sensitivity regardless of locale, so we can + // exercise the path without relying on a specific JS locale. + it("findKnownPerson resolves Cyrillic case differences via locale-aware match", () => { + const knownPersonConfig = { + ...validationConfig, + values: { people: [{ UID: "sIvan", Name: "Иван Петров" }] }, + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { + stubs: { PMap: true }, + mocks: { $config: knownPersonConfig, $util: validationUtil }, + }, + }); + w.vm.chipState.people.options = [{ UID: "sIvan", Name: "Иван Петров" }]; + expect(w.vm.findKnownPerson("иван петров")).toEqual({ UID: "sIvan", Name: "Иван Петров" }); + expect(w.vm.findKnownPerson("Unknown Person")).toBeNull(); + }); + + // P1-2 — knownPeople is sorted locale-aware in loadChipOptions("people"); + // insertion order from people.created WS events would otherwise put new + // subjects at the top. Blank/null entries are filtered out. + it("knownPeople returns a locale-aware sorted list from the people cache", async () => { + typeaheadCache.clear(); + const cacheSpy = vi.spyOn(typeaheadCache, "getPeople").mockResolvedValue([ + { UID: "sZara", Name: "Zara" }, + { UID: "sAndre", Name: "André" }, + { UID: "sBob", Name: "Bob" }, + { UID: "sAlice", Name: "alice" }, + { UID: "sBlank", Name: "" }, + null, + ]); + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.loadChipOptions("people"); + await Promise.resolve(); + await Promise.resolve(); + const names = w.vm.knownPeople.map((p) => p.Name); + expect(names).toEqual(["alice", "André", "Bob", "Zara"]); + cacheSpy.mockRestore(); + }); + + // P1-3 — typed-but-uncommitted text must survive a WS-driven sync. The + // `editing` flag on the draft entry tells syncMarkerDrafts to leave the + // user's typing alone even when the backend value moves. + it("syncMarkerDrafts does not clobber typed text while editing is in progress", async () => { + const marker = { + UID: "m2", + Name: "", + SubjUID: "", + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName: vi.fn(), + }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([marker]) }; + const w = mountInfoForChips({ modelValue: mockModel, photo }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m2", "Plane Port"); + expect(w.vm.markerDrafts.m2.editing).toBe(true); + // Simulate an unrelated WS update that re-fires the people watcher with + // a renamed backend Name. The user's typing must NOT be overwritten. + w.vm.syncMarkerDrafts([{ UID: "m2", Name: "Renamed By Worker" }]); + expect(w.vm.markerInputValue("m2")).toBe("Plane Port"); + // The captured `original` does update — that's the backend's authoritative + // value the draft will roll back to on cancel. + expect(w.vm.markerDrafts.m2.original).toBe("Renamed By Worker"); + }); + + // P1-3 — once the edit is settled (commit or cancel), the editing flag + // clears and a subsequent WS update can re-sync the input again. + it("syncMarkerDrafts re-syncs after the edit settles", async () => { + const marker = { + UID: "m2", + Name: "", + SubjUID: "", + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName: vi.fn().mockResolvedValue(undefined), + }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([marker]) }; + const w = mountInfoForChips({ modelValue: mockModel, photo }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m2", "Plane Port"); + w.vm.cancelMarkerName(marker); + expect(w.vm.markerDrafts.m2.editing).toBe(false); + w.vm.syncMarkerDrafts([{ UID: "m2", Name: "Server Side Name" }]); + expect(w.vm.markerInputValue("m2")).toBe("Server Side Name"); + }); + + // P1-6 — confirmMarkerName is a no-op when markersBusy. Prevents a queued + // rename from racing with an in-flight reject/eject on the same marker. + it("confirmMarkerName bails when markersBusy is true", async () => { + const setName = vi.fn().mockResolvedValue(undefined); + const marker = { + UID: "m2", + Name: "", + SubjUID: "", + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName, + }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([marker]) }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, markersBusy: true, context: contexts.Photos }, + global: { stubs: { PMap: true }, mocks: { $util: validationUtil } }, + }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m2", "Plane Port"); + w.vm.confirmMarkerName(marker, "enter"); + expect(setName).not.toHaveBeenCalled(); + expect(w.vm.addNameDialog.visible).toBe(false); + }); + + // P1-6 — invalid (rejected) marker is filtered out of getMarkers(true) + // but the row's @blur can still fire during the unmount tick. Make sure + // confirmMarkerName refuses to write through to a rejected marker. + it("confirmMarkerName bails when the marker is invalid (rejected)", async () => { + const setName = vi.fn().mockResolvedValue(undefined); + const marker = { + UID: "m2", + Name: "", + SubjUID: "", + Invalid: true, + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName, + }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([marker]) }; + const w = mountInfoForChips({ modelValue: mockModel, photo }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m2", "Plane Port"); + w.vm.confirmMarkerName(marker, "enter"); + expect(setName).not.toHaveBeenCalled(); + }); + + // P1-7 — onRemoveMarker / onClearSubject stamp _lastDestructiveMarkerActionAt; + // a follow-on @blur within 200ms must be ignored to prevent the destructive + // action from racing the inline-commit path. + it("confirmMarkerName bails when an icon click was registered <200ms ago", async () => { + const setName = vi.fn().mockResolvedValue(undefined); + const marker = { + UID: "m2", + Name: "", + SubjUID: "", + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName, + }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([marker]) }; + const w = mountInfoForChips({ modelValue: mockModel, photo }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m2", "Plane Port"); + w.vm._lastDestructiveMarkerActionAt = Date.now(); + w.vm.confirmMarkerName(marker, "blur"); + expect(setName).not.toHaveBeenCalled(); + // After the 200ms window expires the commit is allowed again. + w.vm._lastDestructiveMarkerActionAt = Date.now() - 500; + w.vm.confirmMarkerName(marker, "enter"); + expect(setName).toHaveBeenCalledTimes(1); + }); + + // P1-7 — onClearSubject arms the destructive-action stamp even when + // emitting upward; the parent lightbox owns the actual mutation. The + // sibling onRemoveMarker path was retired when the combobox's + // mdi-close hazard moved to the overlay's edit-mode click-to-remove. + it("onClearSubject arms _lastDestructiveMarkerActionAt before emitting", () => { + const marker = { UID: "m1", Name: "Jane Doe", SubjUID: "subj1", thumbnailUrl: () => "/t/x/p/tile_160" }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([marker]) }; + const w = mountInfoForChips({ modelValue: mockModel, photo }); + expect(w.vm._lastDestructiveMarkerActionAt).toBeFalsy(); + w.vm.onClearSubject(marker); + expect(w.vm._lastDestructiveMarkerActionAt).toBeGreaterThan(0); + }); + + // P1-8 — the Add-name dialog stores a UID (not the transient Marker + // instance returned by getMarkers). On confirm, the live Marker is + // re-derived; a missing UID resolves to a silent no-op. + it("onAddNameConfirm resolves the marker by UID at commit time", async () => { + const setName = vi.fn().mockResolvedValue(undefined); + const marker = { + UID: "m2", + Name: "", + SubjUID: "", + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName, + }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([marker]) }; + const w = mountInfoForChips({ modelValue: mockModel, photo }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m2", "Plane Port"); + w.vm.confirmMarkerName(marker, "blur"); + expect(w.vm.addNameDialog.visible).toBe(true); + expect(w.vm.addNameDialog.markerUid).toBe("m2"); + w.vm.onAddNameConfirm(); + expect(setName).toHaveBeenCalledTimes(1); + }); + + it("onAddNameConfirm is a silent no-op when the stored UID no longer resolves", async () => { + const setName = vi.fn(); + const marker = { + UID: "m2", + Name: "", + SubjUID: "", + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName, + }; + // First render has the marker; after blur opens the dialog the photo + // navigates away and the marker disappears from getMarkers(). + const getMarkers = vi.fn().mockReturnValueOnce([marker]).mockReturnValue([]); + const photo = { ...mockPhoto, getMarkers }; + const w = mountInfoForChips({ modelValue: mockModel, photo }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m2", "Plane Port"); + w.vm.confirmMarkerName(marker, "blur"); + expect(w.vm.addNameDialog.visible).toBe(true); + w.vm.onAddNameConfirm(); + expect(setName).not.toHaveBeenCalled(); + expect(w.vm.addNameDialog.visible).toBe(false); + }); + + // P1-9 — cancelMarkerName must blur the marker's own input, not whatever + // happens to be document.activeElement at the moment Esc was pressed. + it("cancelMarkerName scopes the blur to the marker's own input, not document.activeElement", async () => { + const marker = { UID: "m2", Name: "", SubjUID: "", thumbnailUrl: () => "/svg/portrait", setName: vi.fn() }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([marker]) }; + const w = mountInfoForChips({ modelValue: mockModel, photo }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m2", "Plane Port"); + // The previous implementation called `document.activeElement.blur()` + // blindly; with an unrelated focused element this would incorrectly + // blur it. Verify the scoped query path leaves the outsider alone. + const outsider = document.createElement("input"); + document.body.appendChild(outsider); + outsider.focus(); + expect(document.activeElement).toBe(outsider); + const outsiderBlur = vi.spyOn(outsider, "blur"); + // Spy on the marker row's own input so we also confirm the scoped path + // ran (not just that the blind path didn't). + const markerInput = w.vm.$el.querySelector(`[data-marker-uid="m2"] input`); + expect(markerInput).toBeTruthy(); + const markerBlur = vi.spyOn(markerInput, "blur"); + w.vm.cancelMarkerName(marker); + expect(markerBlur).toHaveBeenCalled(); + expect(outsiderBlur).not.toHaveBeenCalled(); + document.body.removeChild(outsider); + }); + + // Inline blur now commits the edit instead of silently reverting — this + // was the bug where typing in an inline field and clicking away (or + // navigating) would quietly lose the change. + it("should commit the edit on blur (onInlineFieldBlur calls confirmField)", async () => { + const update = vi.fn().mockResolvedValue(undefined); + const photo = { + ...mockPhoto, + Title: "Original", + update, + wasChanged: function () { + return this.Title !== "Original"; + }, + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.startEditing("title"); + await w.vm.$nextTick(); + photo.Title = "Changed"; + w.vm._editStartedAt = null; + w.vm.onInlineFieldBlur(); + expect(update).toHaveBeenCalled(); + expect(w.vm.editingField).toBeNull(); + // Value must NOT be reverted to "Original". + expect(photo.Title).toBe("Changed"); + }); + + it("should respect the 200ms debounce guard on blur", async () => { + const update = vi.fn().mockResolvedValue(undefined); + const photo = { + ...mockPhoto, + Title: "Original", + update, + wasChanged: () => true, + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.startEditing("title"); + await w.vm.$nextTick(); + // _editStartedAt was just set by startEditing; blur should be a no-op. + w.vm.onInlineFieldBlur(); + expect(update).not.toHaveBeenCalled(); + expect(w.vm.editingField).toBe("title"); + }); + + // onInlineEnter — Enter commits on single-line fields (commitOnEnter: + // true) and falls through (no preventDefault) for free-form fields + // like Notes / Caption so the textarea can insert a newline. Shift+ + // Enter always falls through, even on commitOnEnter fields. Propagation + // is contained by the `.stop` modifier on the @keydown.enter binding, not + // by the method, so the keystroke never reaches the dialog's Enter handler. + describe("onInlineEnter (commit-on-Enter for single-line fields)", () => { + let w; + beforeEach(() => { + w = mountSidebar({ + props: { + modelValue: mockModel, + photo: { ...mockPhoto, Details: { Subject: "", Notes: "", Keywords: "" }, update: vi.fn(), wasChanged: () => false }, + canEdit: true, + context: contexts.Photos, + }, + global: { stubs: { PMap: true } }, + }); + }); + + function makeEvent(shiftKey) { + return { shiftKey, preventDefault: vi.fn(), stopPropagation: vi.fn() }; + } + + it("commits and suppresses the newline for commitOnEnter fields", () => { + const subject = w.vm.fieldRegistry.subject; + expect(subject.commitOnEnter).toBe(true); + const ev = makeEvent(false); + const confirmSpy = vi.spyOn(w.vm, "confirmField").mockImplementation(() => {}); + w.vm.onInlineEnter(ev, subject); + expect(ev.preventDefault).toHaveBeenCalledTimes(1); + // Propagation is stopped by the binding's `.stop` modifier, not the method. + expect(ev.stopPropagation).not.toHaveBeenCalled(); + expect(confirmSpy).toHaveBeenCalledTimes(1); + }); + + it("falls through (no commit) for fields without commitOnEnter (Notes)", () => { + const notes = w.vm.fieldRegistry.notes; + expect(notes.commitOnEnter).toBeUndefined(); + const ev = makeEvent(false); + const confirmSpy = vi.spyOn(w.vm, "confirmField").mockImplementation(() => {}); + w.vm.onInlineEnter(ev, notes); + expect(ev.preventDefault).not.toHaveBeenCalled(); + expect(ev.stopPropagation).not.toHaveBeenCalled(); + expect(confirmSpy).not.toHaveBeenCalled(); + }); + + it("falls through on Shift+Enter even for commitOnEnter fields", () => { + const keywords = w.vm.fieldRegistry.keywords; + expect(keywords.commitOnEnter).toBe(true); + const ev = makeEvent(true); + const confirmSpy = vi.spyOn(w.vm, "confirmField").mockImplementation(() => {}); + w.vm.onInlineEnter(ev, keywords); + expect(ev.preventDefault).not.toHaveBeenCalled(); + expect(confirmSpy).not.toHaveBeenCalled(); + }); + }); + + it("should still cancel on Escape via cancelEditing", async () => { + const photo = { + ...mockPhoto, + Title: "Original", + update: vi.fn(), + wasChanged: () => true, + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.startEditing("title"); + await w.vm.$nextTick(); + photo.Title = "Changed"; + w.vm._editStartedAt = null; + w.vm.cancelEditing(); + // Escape/cancelEditing reverts to the stored original. + expect(photo.Title).toBe("Original"); + expect(w.vm.editingField).toBeNull(); + }); + + // Inline text fields (title/caption/subject/...) are usually NOT tracked + // by hasPendingEdit because onInlineFieldBlur() auto-commits them before + // any nav source can fire. The carve-out is hasPendingInlineOverflow: + // confirmField() short-circuits on a value above the field's maxLength, + // leaving the editor open with invalid text — that case (covered below) + // intentionally DOES report pending so the discard dialog can fire. + it("should NOT report hasPendingEdit for a dirty inline text field within the cap (auto-commits on blur)", () => { + const photo = { + ...mockPhoto, + Title: "Changed", + wasChanged: () => true, + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.editingField = "title"; + expect(w.vm.hasPendingEdit()).toBe(false); + }); + + // Navigation guard: if the user typed past the per-field cap (e.g. 5000- + // char Caption against the 4096 cap), confirmField() keeps the editor + // open instead of persisting the value. Without the overflow branch in + // hasPendingEdit, the next/prev arrow would silently swap the photo + // out from under the invalid edit; with it, confirmDiscardPending() can + // surface the discard dialog and the "Discard invalid changes?" label + // tells the user which kind of edit they're abandoning. + it("should report hasPendingEdit when an inline editor's value exceeds the field cap", () => { + const photo = { + ...mockPhoto, + Caption: "x".repeat(5000), // PhotoMaxLength.Caption is 4096 + wasChanged: () => true, + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + + // No active editor → not pending. + expect(w.vm.hasPendingEdit()).toBe(false); + + // Editing the overlength field → pending; discard label flips. + w.vm.editingField = "caption"; + expect(w.vm.hasPendingInlineOverflow()).toBe(true); + expect(w.vm.hasPendingEdit()).toBe(true); + expect(w.vm.discardDialogText).toBe("Discard invalid changes?"); + }); + + it("should keep the generic discard text when overflow coexists with another pending edit", () => { + const photo = { + ...mockPhoto, + Caption: "x".repeat(5000), + wasChanged: () => true, + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + + w.vm.editingField = "caption"; + w.vm.chipState.labels.removals = [{ Label: { UID: "lbl1" } }]; + + expect(w.vm.hasPendingInlineOverflow()).toBe(true); + expect(w.vm.hasPendingNonOverflowEdit()).toBe(true); + expect(w.vm.discardDialogText).toBe("Discard unsaved changes?"); + }); + + // Additions go through the instant-save path (addLabelImmediate / + // addAlbumImmediate), so they never enter chipState — only batched + // removals can leave the sidebar in a pending state. + it("should report hasPendingEdit when labels have pending removals", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.vm.hasPendingEdit()).toBe(false); + w.vm.chipState.labels.removals = [{ Label: { UID: "lbl1" } }]; + expect(w.vm.hasPendingEdit()).toBe(true); + }); + + it("should report hasPendingEdit when albums have pending removals", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.vm.hasPendingEdit()).toBe(false); + w.vm.chipState.albums.removals = [{ UID: "alb1" }]; + expect(w.vm.hasPendingEdit()).toBe(true); + }); + + it("should report hasPendingEdit while an inline marker name is dirty", async () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + await w.vm.$nextTick(); + expect(w.vm.hasPendingEdit()).toBe(false); + w.vm.setMarkerInputValue("m2", "Alice"); + expect(w.vm.hasPendingEdit()).toBe(true); + }); + + it("should report hasPendingEdit for typed-but-uncommitted text in the labels combobox", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.vm.hasPendingEdit()).toBe(false); + w.vm.chipState.labels.search = "alpha"; + expect(w.vm.hasPendingEdit()).toBe(true); + // Trimmed-empty input is not pending. + w.vm.chipState.labels.search = " "; + expect(w.vm.hasPendingEdit()).toBe(false); + }); + + it("should report hasPendingEdit for typed-but-uncommitted text in the albums autocomplete", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.chipState.albums.search = "vacation"; + expect(w.vm.hasPendingEdit()).toBe(true); + }); + + it("should report hasPendingEdit while the Add-name confirmation dialog is visible", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.vm.hasPendingEdit()).toBe(false); + w.vm.addNameDialog = { visible: true, marker: { UID: "m2" }, name: "Alice" }; + expect(w.vm.hasPendingEdit()).toBe(true); + }); + + it("should resolve confirmDiscardPending to true immediately when there is no pending edit", async () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + await expect(w.vm.confirmDiscardPending()).resolves.toBe(true); + expect(w.vm.discardDialog.visible).toBe(false); + }); + + it("should open the discard dialog when confirmDiscardPending is called with a pending edit", async () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m2", "Alice"); + const promise = w.vm.confirmDiscardPending(); + expect(w.vm.discardDialog.visible).toBe(true); + expect(typeof w.vm.discardDialog.resolver).toBe("function"); + // Resolve the dialog via the confirm handler so the test doesn't hang. + w.vm.onDiscardConfirm(); + await expect(promise).resolves.toBe(true); + expect(w.vm.discardDialog.visible).toBe(false); + expect(w.vm.hasPendingEdit()).toBe(false); + }); + + it("should clear pending edits when onDiscardConfirm runs", async () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m2", "Alice"); + const promise = w.vm.confirmDiscardPending(); + w.vm.onDiscardConfirm(); + await expect(promise).resolves.toBe(true); + expect(w.vm.hasPendingEdit()).toBe(false); + expect(w.vm.markerInputValue("m2")).toBe(""); + }); + + it("should keep pending edits when onDiscardCancel runs", async () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m2", "Alice"); + const promise = w.vm.confirmDiscardPending(); + w.vm.onDiscardCancel(); + await expect(promise).resolves.toBe(false); + expect(w.vm.markerInputValue("m2")).toBe("Alice"); + expect(w.vm.hasPendingEdit()).toBe(true); + }); + + // confirmCamera rolls back the optimistic mutation if the API call fails + // and surfaces the failure via $notify.error so the user knows the save + // didn't take effect. Uses the model's __originalValues snapshot via the + // originalValue() accessor. + describe("confirmCamera failure rollback", () => { + function buildCameraPhoto(overrides = {}) { + const photo = { + UID: "ps6sg6be2lvl0yh7", + CameraID: 1, + LensID: 1, + Iso: 100, + Exposure: "1/200", + FNumber: 2.8, + FocalLength: 50, + Files: [], + Labels: [], + Albums: [], + Details: {}, + getMarkers: () => [], + getCameraInfo: () => "", + getLensInfo: () => "", + getImageInfo: () => "", + getVideoInfo: () => "", + getVectorInfo: () => "", + getExifInfo: () => "", + locationInfo: () => "", + update: vi.fn(), + ...overrides, + }; + // Mirror the Model.__originalValues contract: originalValue(key) reads + // the snapshot taken when the photo was last loaded/saved, and + // rollback() restores every tracked field from that snapshot. + photo.__originalValues = { + CameraID: photo.CameraID, + LensID: photo.LensID, + Iso: photo.Iso, + Exposure: photo.Exposure, + FNumber: photo.FNumber, + FocalLength: photo.FocalLength, + }; + photo.originalValue = (key) => photo.__originalValues[key]; + photo.rollback = () => { + Object.keys(photo.__originalValues).forEach((key) => { + photo[key] = photo.__originalValues[key]; + }); + return photo; + }; + return photo; + } + + const newCameraData = { + CameraID: 5, + LensID: 7, + Iso: 800, + Exposure: "1/60", + FNumber: 1.8, + FocalLength: 35, + }; + + it("rolls back camera fields and notifies the user when update() rejects", async () => { + const photo = buildCameraPhoto(); + photo.update.mockRejectedValueOnce(new Error("boom")); + + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + + w.vm.confirmCamera(newCameraData); + + // Optimistic write applies before the rejection lands. + expect(photo.CameraID).toBe(5); + expect(photo.update).toHaveBeenCalledTimes(1); + + await w.vm.$nextTick(); + await w.vm.$nextTick(); + + // Rolled back to __originalValues — must match the pre-confirmCamera state. + expect(photo.CameraID).toBe(1); + expect(photo.LensID).toBe(1); + expect(photo.Iso).toBe(100); + expect(photo.Exposure).toBe("1/200"); + expect(photo.FNumber).toBe(2.8); + expect(photo.FocalLength).toBe(50); + + expect(w.vm.$notify.error).toHaveBeenCalledTimes(1); + }); + + it("keeps the optimistic mutation when update() resolves", async () => { + const photo = buildCameraPhoto(); + photo.update.mockResolvedValueOnce({}); + + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + + w.vm.confirmCamera(newCameraData); + + await w.vm.$nextTick(); + await w.vm.$nextTick(); + + expect(photo.CameraID).toBe(5); + expect(photo.LensID).toBe(7); + expect(photo.Iso).toBe(800); + expect(w.vm.$notify.error).not.toHaveBeenCalled(); + }); + + it("does nothing when the photo has no UID", () => { + const photo = buildCameraPhoto({ UID: "" }); + + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + + w.vm.confirmCamera(newCameraData); + + expect(photo.update).not.toHaveBeenCalled(); + expect(photo.CameraID).toBe(1); + }); + }); + + // Symmetric coverage for the other three save paths. Each handler mirrors + // confirmCamera: mutate the photo optimistically, call photo.update(), on + // success sync the matching Thumb fields, on failure roll back and notify. + // The Photo mock fakes the Model.__originalValues + rollback() contract so + // these tests stay decoupled from the real model implementation. + function attachRollbackContract(photo, snapshot) { + photo.__originalValues = { ...snapshot }; + photo.originalValue = (key) => photo.__originalValues[key]; + photo.rollback = () => { + Object.keys(photo.__originalValues).forEach((key) => { + photo[key] = photo.__originalValues[key]; + }); + return photo; + }; + return photo; + } + + function buildSidebarPhoto(initial, overrides = {}) { + const photo = { + UID: "ps6sg6be2lvl0yh7", + Files: [], + Labels: [], + Albums: [], + Details: {}, + getMarkers: () => [], + getCameraInfo: () => "", + getLensInfo: () => "", + getImageInfo: () => "", + getVideoInfo: () => "", + getVectorInfo: () => "", + getExifInfo: () => "", + locationInfo: () => "", + wasChanged: vi.fn().mockReturnValue(true), + ...initial, + update: vi.fn(), + ...overrides, + }; + return attachRollbackContract(photo, initial); + } + + describe("confirmDateTime failure rollback", () => { + function buildDateTimePhoto(overrides = {}) { + const photo = buildSidebarPhoto( + { + Day: 1, + Month: 1, + Year: 2020, + TimeZone: "UTC", + TakenAtLocal: "2020-01-01T00:00:00Z", + TakenAt: "2020-01-01T00:00:00Z", + }, + overrides + ); + photo.localDate = vi.fn().mockReturnValue({ + isValid: true, + toISO: () => "2022-07-15T13:45:30", + }); + photo.currentTimeZoneUTC = vi.fn().mockReturnValue(true); + return photo; + } + + // Use UTC so the success-path test stays inside the suite-wide + // DateTime.fromISO mock surface (which only stubs toLocaleString, + // not setZone — see beforeEach above). The rollback-path test + // never re-renders formatTime() because the mutations get reverted + // before Vue flushes, so any timezone works there. + const newDateTimeData = { + Day: 15, + Month: 7, + Year: 2022, + TimeZone: "UTC", + time: "13:45:30", + }; + + it("rolls back date/time fields and notifies the user when update() rejects", async () => { + const photo = buildDateTimePhoto(); + photo.update.mockRejectedValueOnce(new Error("boom")); + + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + + w.vm.confirmDateTime(newDateTimeData); + // Optimistic write applied before the rejection lands. + expect(photo.Year).toBe(2022); + + await w.vm.$nextTick(); + await w.vm.$nextTick(); + + expect(photo.Day).toBe(1); + expect(photo.Month).toBe(1); + expect(photo.Year).toBe(2020); + expect(photo.TimeZone).toBe("UTC"); + expect(w.vm.$notify.error).toHaveBeenCalledTimes(1); + }); + + it("keeps the optimistic mutation when update() resolves", async () => { + const photo = buildDateTimePhoto(); + photo.update.mockResolvedValueOnce({}); + + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + + w.vm.confirmDateTime(newDateTimeData); + + await w.vm.$nextTick(); + await w.vm.$nextTick(); + + expect(photo.Year).toBe(2022); + expect(photo.TimeZone).toBe("UTC"); + expect(w.vm.$notify.error).not.toHaveBeenCalled(); + }); + }); + + describe("confirmLocation failure rollback", () => { + function buildLocationPhoto(overrides = {}) { + return buildSidebarPhoto( + { + Lat: 0, + Lng: 0, + PlaceSrc: "", + Country: "zz", + }, + overrides + ); + } + + const newLocationData = { + lat: 52.52, + lng: 13.405, + location: { country: "de" }, + }; + + it("rolls back location fields and notifies the user when update() rejects", async () => { + const photo = buildLocationPhoto(); + photo.update.mockRejectedValueOnce(new Error("boom")); + + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + + w.vm.confirmLocation(newLocationData); + // Optimistic write applied before the rejection lands. + expect(photo.Lat).toBe(52.52); + + await w.vm.$nextTick(); + await w.vm.$nextTick(); + + expect(photo.Lat).toBe(0); + expect(photo.Lng).toBe(0); + expect(photo.PlaceSrc).toBe(""); + expect(photo.Country).toBe("zz"); + expect(w.vm.$notify.error).toHaveBeenCalledTimes(1); + }); + + it("keeps the optimistic mutation when update() resolves", async () => { + const photo = buildLocationPhoto(); + photo.update.mockResolvedValueOnce({}); + + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + + w.vm.confirmLocation(newLocationData); + + await w.vm.$nextTick(); + await w.vm.$nextTick(); + + expect(photo.Lat).toBe(52.52); + expect(photo.Lng).toBe(13.405); + expect(photo.PlaceSrc).toBe("manual"); + expect(photo.Country).toBe("de"); + expect(w.vm.$notify.error).not.toHaveBeenCalled(); + }); + }); + + describe("confirmField (inline edit) failure rollback", () => { + function buildInlineEditPhoto(overrides = {}) { + // The inline-edit binding is v-model="p.Title", so the user's keystrokes + // mutate photo.Title directly before confirmField() runs. + return buildSidebarPhoto({ Title: "Original", Caption: "Original caption" }, overrides); + } + + it("rolls back the inline edit and notifies the user when update() rejects", async () => { + const photo = buildInlineEditPhoto(); + photo.update.mockRejectedValueOnce(new Error("boom")); + + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + + // Simulate the v-model edit having already mutated photo.Title. + photo.Title = "Edited"; + w.vm.editingField = "title"; + + w.vm.confirmField(); + // editingField is cleared synchronously before the update resolves. + expect(w.vm.editingField).toBeNull(); + + await w.vm.$nextTick(); + await w.vm.$nextTick(); + + expect(photo.Title).toBe("Original"); + expect(w.vm.$notify.error).toHaveBeenCalledTimes(1); + }); + + it("keeps the inline edit when update() resolves", async () => { + const photo = buildInlineEditPhoto(); + photo.update.mockResolvedValueOnce({}); + + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + + photo.Title = "Edited"; + w.vm.editingField = "title"; + + w.vm.confirmField(); + + await w.vm.$nextTick(); + await w.vm.$nextTick(); + + expect(photo.Title).toBe("Edited"); + expect(w.vm.$notify.error).not.toHaveBeenCalled(); + }); + + it("does not call update() when the field is unchanged", () => { + const photo = buildInlineEditPhoto(); + photo.wasChanged.mockReturnValue(false); + + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + + w.vm.editingField = "title"; + w.vm.confirmField(); + + expect(photo.update).not.toHaveBeenCalled(); + expect(w.vm.$notify.error).not.toHaveBeenCalled(); + }); + + it("trims surrounding whitespace before checking the field cap so a value that fits after trim still saves", () => { + // Mirrors the backend trim performed by txt.Clip; without it a user + // typing "x"*1024 + trailing spaces would trip the cap and the + // editor would stay open even though the trimmed value fits the + // column. + const photo = buildInlineEditPhoto(); + photo.update.mockResolvedValueOnce({}); + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + + // Copyright cap is 1024; "x"*1024 + trailing spaces is fine after trim. + photo.Details = { Copyright: "x".repeat(1024) + " " }; + w.vm.editingField = "copyright"; + + w.vm.confirmField(); + + // Trimmed value persisted on the photo and the editor closed. + expect(photo.Details.Copyright).toBe("x".repeat(1024)); + expect(w.vm.editingField).toBeNull(); + expect(w.vm.$notify.error).not.toHaveBeenCalled(); + }); + + it("blocks save and keeps the editor open when the value exceeds the field cap", () => { + // Inline editor has no parent v-form; the rendered `:rules` only + // paint an inline error. The imperative length check inside + // confirmField is the actual gate — without it photo.update() + // would post overlength input and the "successfully saved" toast + // would fire while the server silently drops the value. + const photo = buildInlineEditPhoto(); + + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + + // Copyright cap is 1024 (PhotoMaxLength.Copyright); push past it. + photo.Details = { Copyright: "x".repeat(1025) }; + w.vm.editingField = "copyright"; + + w.vm.confirmField(); + + // Editor stays open so the user can fix the overlong input. + expect(w.vm.editingField).toBe("copyright"); + expect(photo.update).not.toHaveBeenCalled(); + expect(w.vm.$notify.error).toHaveBeenCalledTimes(1); + }); + }); + + // Labels + it("should return labels from photo prop sorted alphabetically", () => { + // Backend preload orders by uncertainty/topicality but the sidebar + // doesn't surface those scores; the chips are sorted by name. + expect(wrapper.vm.labels).toHaveLength(2); + expect(wrapper.vm.labels.map((l) => l.Label.Name)).toEqual(["Landscape", "Nature"]); + }); + + // Albums + it("should return albums from photo prop sorted alphabetically", () => { + expect(wrapper.vm.albums).toHaveLength(2); + expect(wrapper.vm.albums.map((a) => a.Title)).toEqual(["Favorites", "Vacation 2023"]); + }); + + it("should hide private albums from sidebar cross-links", () => { + const photoWithPrivateAlbum = { + ...mockPhoto, + Albums: [ + { UID: "alb1", Title: "Vacation 2023", Slug: "vacation-2023" }, + { UID: "alb2", Title: "Favorites", Slug: "favorites" }, + { UID: "alb3", Title: "Secret", Slug: "secret", Private: true }, + ], + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo: photoWithPrivateAlbum, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + // Alphabetical sort: Favorites < Vacation 2023. + expect(w.vm.albums.map((a) => a.UID)).toEqual(["alb2", "alb1"]); + }); + + // Metadata details + it("should return metadata details from photo prop", () => { + expect(wrapper.vm.subject).toBe("Mountains"); + expect(wrapper.vm.artist).toBe("John Photographer"); + expect(wrapper.vm.copyright).toBe("2023 John"); + expect(wrapper.vm.license).toBe("CC BY 4.0"); + expect(wrapper.vm.keywords).toBe("nature, mountains, sunset"); + }); + + it("should return place and file info from photo prop", () => { + expect(wrapper.vm.placeName).toBe("Berlin, Germany"); + expect(wrapper.vm.fileName).toBe("photos/2023/IMG_001.jpg"); + expect(wrapper.vm.fileInfo).toBe("JPEG, 1920 × 1080, 4.2 MB"); + }); + + // fileName resolution prefers the underlying media file (video / Live) + // over the generated JPEG cover that primaryFile() returns. Previously + // the sidebar showed "...mp4.jpg" for video photos because the JPG was + // marked Primary for indexing — the user-facing name should be the + // original media file. + it("fileName surfaces the original media file for video photos, not the JPEG cover", () => { + const videoPhoto = { + ...mockPhoto, + Type: "video", + FileName: "video/tagesschau.mp4.jpg", + originalFile: () => ({ Name: "video/tagesschau.mp4", OriginalName: "tagesschau.mp4" }), + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo: videoPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true }, mocks: { $util: validationUtil } }, + }); + expect(w.vm.fileName).toBe("video/tagesschau.mp4"); + }); + + // For image photos the originalFile() result equals primaryFile() — both + // return `this` when Files has fewer than 2 entries — so we fall through + // to the existing photo.FileName branch. + it("fileName falls back to photo.FileName when originalFile is the photo itself", () => { + const photo = { ...mockPhoto, originalFile: function () { + return this; + }, FileName: "photos/2023/IMG_001.jpg" }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true }, mocks: { $util: validationUtil } }, + }); + expect(w.vm.fileName).toBe("photos/2023/IMG_001.jpg"); + }); + + // Caption and notes HTML + it("should produce caption and notes HTML via sanitize pipeline", () => { + expect(wrapper.vm.captionHtml).toBe("Test Caption"); + expect(wrapper.vm.notesHtml).toBe("Some notes about this photo"); + }); + + // The merged single-row detailsFields template must route Notes + // through the sanitized v-html branch (display: "html" + htmlValue: + // "notesHtml") rather than plain-text interpolation. Catches any + // future regression where the html-aware ladder is dropped from the + // merged loop and Notes silently falls back to the text branch. + it("renders Notes through the sanitized v-html branch in the merged details row", () => { + const notesRow = wrapper.find(".meta-notes"); + expect(notesRow.exists()).toBe(true); + const innerNotes = notesRow.find(".meta-scrollable.meta-notes"); + expect(innerNotes.exists()).toBe(true); + expect(innerNotes.html()).toContain("Some notes about this photo"); + }); + + it("should return empty caption HTML when no caption", () => { + const w = mountSidebar({ + props: { modelValue: { ...mockModel, Caption: "" }, photo: mockPhoto, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.vm.captionHtml).toBe(""); + }); + + // Cross-link navigation — label, album, and named-person avatars must open + // in a new browser tab so the current lightbox edit context is preserved. + function mountWithMockRouter(resolveHref) { + return mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, context: contexts.Photos }, + global: { + stubs: { PMap: true }, + mocks: { + $router: { resolve: vi.fn().mockReturnValue({ href: resolveHref }) }, + }, + }, + }); + } + + it("should open a new tab with a label filter for label clicks", () => { + const openSpy = vi.spyOn(window, "open").mockImplementation(() => null); + const w = mountWithMockRouter("/library/browse?q=label%3Anature"); + w.vm.navigateToLabel({ UID: "lbl1", Name: "Nature", Slug: "nature", CustomSlug: "" }); + expect(w.vm.$router.resolve).toHaveBeenCalledWith({ name: "browse", query: { q: "label:nature" } }); + expect(openSpy).toHaveBeenCalledWith("/library/browse?q=label%3Anature", "_blank", "noopener,noreferrer"); + openSpy.mockRestore(); + }); + + it("should prefer CustomSlug for label navigation", () => { + const openSpy = vi.spyOn(window, "open").mockImplementation(() => null); + const w = mountWithMockRouter("/library/browse?q=label%3Acustom-landscape"); + w.vm.navigateToLabel({ UID: "lbl2", Name: "Landscape", Slug: "landscape", CustomSlug: "custom-landscape" }); + expect(w.vm.$router.resolve).toHaveBeenCalledWith({ name: "browse", query: { q: "label:custom-landscape" } }); + expect(openSpy).toHaveBeenCalled(); + openSpy.mockRestore(); + }); + + it("should open a new tab for album clicks", () => { + const openSpy = vi.spyOn(window, "open").mockImplementation(() => null); + const w = mountWithMockRouter("/library/albums/alb1/view"); + w.vm.navigateToAlbum({ UID: "alb1", Title: "Vacation 2023" }); + expect(w.vm.$router.resolve).toHaveBeenCalledWith({ name: "album", params: { album: "alb1", slug: "view" } }); + expect(openSpy).toHaveBeenCalledWith("/library/albums/alb1/view", "_blank", "noopener,noreferrer"); + openSpy.mockRestore(); + }); + + it("should open a new tab with a subject filter for person avatars that have SubjUID", () => { + const openSpy = vi.spyOn(window, "open").mockImplementation(() => null); + const w = mountWithMockRouter("/library/browse?q=subject%3Asubj1"); + w.vm.navigateToPerson({ UID: "m1", Name: "Jane Doe", SubjUID: "subj1" }); + expect(w.vm.$router.resolve).toHaveBeenCalledWith({ name: "browse", query: { q: "subject:subj1" } }); + expect(openSpy).toHaveBeenCalled(); + openSpy.mockRestore(); + }); + + it("should open a new tab with a person filter when only Name is available", () => { + const openSpy = vi.spyOn(window, "open").mockImplementation(() => null); + const w = mountWithMockRouter("/library/browse?q=person%3AUnknown%20Person"); + w.vm.navigateToPerson({ UID: "m3", Name: "Unknown Person", SubjUID: "" }); + expect(w.vm.$router.resolve).toHaveBeenCalledWith({ name: "browse", query: { q: "person:Unknown Person" } }); + expect(openSpy).toHaveBeenCalled(); + openSpy.mockRestore(); + }); + + it("should not open a tab for a person without name or SubjUID", () => { + const openSpy = vi.spyOn(window, "open").mockImplementation(() => null); + const w = mountWithMockRouter("/library/browse"); + w.vm.navigateToPerson({ UID: "m4", Name: "", SubjUID: "" }); + expect(openSpy).not.toHaveBeenCalled(); + openSpy.mockRestore(); + }); + + // inlineEditDirty + undoInlineEdit — Undo affordance for inline-text + // editors. The Undo button is always shown while editing, but + // disabled until inlineEditDirty flips true; clicking it reverts to + // the editOriginal captured at startEditing time without exiting + // edit mode (Escape is the revert-AND-exit gesture). + describe("inline edit Undo", () => { + let w; + let photo; + beforeEach(() => { + photo = { + ...mockPhoto, + Title: "Original Title", + Details: { Subject: "Original Subject", Notes: "", Keywords: "" }, + update: vi.fn(), + wasChanged: () => true, + }; + w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + }); + + it("inlineEditDirty is false when no field is being edited", () => { + expect(w.vm.editingField).toBeNull(); + expect(w.vm.inlineEditDirty).toBe(false); + }); + + it("inlineEditDirty stays false right after startEditing (value unchanged)", async () => { + w.vm.startEditing("subject"); + await w.vm.$nextTick(); + expect(w.vm.editingField).toBe("subject"); + expect(w.vm.inlineEditDirty).toBe(false); + }); + + it("inlineEditDirty flips true once the field value diverges from the original", async () => { + w.vm.startEditing("subject"); + await w.vm.$nextTick(); + // Route the mutation through the reactive write helper that the + // textarea's @update:model-value handler uses, so Vue's computed + // dependency tracking picks it up. + w.vm.setFieldValue("subject", "Edited"); + await w.vm.$nextTick(); + expect(w.vm.getFieldValue("subject")).toBe("Edited"); + expect(w.vm.inlineEditDirty).toBe(true); + }); + + it("undoInlineEdit reverts to editOriginal without exiting edit mode", async () => { + w.vm.startEditing("subject"); + await w.vm.$nextTick(); + w.vm.setFieldValue("subject", "Edited"); + await w.vm.$nextTick(); + expect(w.vm.editingField).toBe("subject"); + + w.vm.undoInlineEdit(); + await w.vm.$nextTick(); + expect(w.vm.getFieldValue("subject")).toBe("Original Subject"); + expect(w.vm.editingField).toBe("subject"); + expect(w.vm.inlineEditDirty).toBe(false); + }); + + it("undoInlineEdit is a no-op when no field is being edited", () => { + expect(w.vm.editingField).toBeNull(); + w.vm.undoInlineEdit(); + expect(photo.Details.Subject).toBe("Original Subject"); + }); + + // Defaults-agnostic binding check: the test sets each flag to a + // known value before asserting, so flipping the data() default + // (e.g., for an A/B variant that hides Save by default) doesn't + // break the test. What we care about is that the root :class + // binding actually mirrors the flags in both directions. + it("hide-edit-undo / hide-edit-save root classes mirror the data flags in both directions", async () => { + const root = w.find(".p-lightbox-sidebar"); + + w.vm.hideEditUndo = false; + w.vm.hideEditSave = false; + await w.vm.$nextTick(); + expect(root.classes()).not.toContain("hide-edit-undo"); + expect(root.classes()).not.toContain("hide-edit-save"); + + w.vm.hideEditUndo = true; + w.vm.hideEditSave = true; + await w.vm.$nextTick(); + expect(root.classes()).toContain("hide-edit-undo"); + expect(root.classes()).toContain("hide-edit-save"); + }); + }); + + // isEditable + it("should not be editable without canEdit prop", () => { + expect(wrapper.vm.isEditable).toBeFalsy(); + }); + + it("should be editable when canEdit is true with valid photo", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.vm.isEditable).toBeTruthy(); + }); + + // Altitude + it("should return altitude when photo has Altitude", () => { + const photo = { ...mockPhoto, Altitude: 340 }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.vm.altitude).toBe("340 m"); + }); + + // Labels Uncertainty filter + it("should hide labels with Uncertainty 100", () => { + const photo = { + ...mockPhoto, + Labels: [ + { Uncertainty: 0, Label: { ID: 1, UID: "lbl1", Name: "Nature", Slug: "nature", CustomSlug: "" } }, + { Uncertainty: 100, Label: { ID: 3, UID: "lbl3", Name: "Hidden", Slug: "hidden", CustomSlug: "" } }, + ], + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.vm.labels).toHaveLength(1); + expect(w.vm.labels[0].Label.Name).toBe("Nature"); + }); + + // Inline editing: startEditing / cancelEditing + it("should set editingField and store original value on startEditing", () => { + const photo = { ...mockPhoto, Title: "Test Title", Caption: "Test Caption" }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.startEditing("title"); + expect(w.vm.editingField).toBe("title"); + expect(w.vm.editOriginal).toBe("Test Title"); + }); + + it("should restore original value on cancelEditing", async () => { + const photo = { ...mockPhoto, Title: "Test Title", wasChanged: vi.fn().mockReturnValue(false) }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.startEditing("title"); + photo.Title = "Modified"; + // Wait past the 200ms blur guard + w.vm._editStartedAt = Date.now() - 300; + w.vm.cancelEditing(); + expect(photo.Title).toBe("Test Title"); + expect(w.vm.editingField).toBeNull(); + }); + + // getFieldValue / setFieldValue + it("should get and set field values for all fields", () => { + const photo = { ...mockPhoto, Title: "Test Title", Caption: "Test Caption" }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(w.vm.getFieldValue("title")).toBe("Test Title"); + expect(w.vm.getFieldValue("caption")).toBe("Test Caption"); + expect(w.vm.getFieldValue("subject")).toBe("Mountains"); + expect(w.vm.getFieldValue("notes")).toBe("Some notes about this photo"); + expect(w.vm.getFieldValue("unknown")).toBe(""); + + w.vm.setFieldValue("title", "New Title"); + expect(photo.Title).toBe("New Title"); + }); + + // Pending label operations + it("should toggle label pending removal", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + const id = 1; + + expect(w.vm.isChipPendingRemoval("labels", id)).toBe(false); + w.vm.togglePendingChipRemoval("labels", id); + expect(w.vm.isChipPendingRemoval("labels", id)).toBe(true); + w.vm.togglePendingChipRemoval("labels", id); + expect(w.vm.isChipPendingRemoval("labels", id)).toBe(false); + }); + + // L8: instant-save additions — onLabelSelected / onLabelEnter call + // photo.addLabel(name) immediately. The chip appears as a real primary + // chip via the model's setValues(r.data) chain (mocked here as a + // resolved Promise). chipState.labels.additions does not exist anymore. + it("should call photo.addLabel immediately on onLabelSelected", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.onLabelSelected({ Name: "Sunset", UID: "lbl-new" }); + expect(mockPhoto.addLabel).toHaveBeenCalledWith("Sunset"); + expect(mockPhoto.addLabel).toHaveBeenCalledTimes(1); + }); + + it("should ignore non-object values in onLabelSelected", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.onLabelSelected("string-value"); + w.vm.onLabelSelected(null); + expect(mockPhoto.addLabel).not.toHaveBeenCalled(); + }); + + it("should skip labels already on the photo in onLabelSelected", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.onLabelSelected({ Name: "Nature", UID: "lbl1" }); + expect(mockPhoto.addLabel).not.toHaveBeenCalled(); + }); + + it("should skip labels already on the photo case-insensitively in onLabelSelected", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.onLabelSelected({ Name: "nature" }); + expect(mockPhoto.addLabel).not.toHaveBeenCalled(); + }); + + it("should trim whitespace in onLabelEnter before calling photo.addLabel", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.labels.search = " dog "; + w.vm.onLabelEnter(); + expect(mockPhoto.addLabel).toHaveBeenCalledWith("dog"); + }); + + it("should silently reject empty or whitespace-only label input in onLabelEnter", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.labels.search = " "; + w.vm.onLabelEnter(); + expect(mockPhoto.addLabel).not.toHaveBeenCalled(); + expect(w.vm.$notify.error).not.toHaveBeenCalled(); + }); + + it("should reject labels longer than the configured clip length and notify", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.labels.search = "a".repeat(CLIP_LEN + 10); + w.vm.onLabelEnter(); + expect(mockPhoto.addLabel).not.toHaveBeenCalled(); + expect(w.vm.$notify.error).toHaveBeenCalledWith("Name too long"); + }); + + it("should match existing labels through normalization (punctuation stripped)", () => { + const photo = { + ...mockPhoto, + Labels: [{ Uncertainty: 0, Label: { ID: 99, UID: "lbl99", Name: "Cat!", Slug: "cat", CustomSlug: "" } }], + }; + const w = mountInfoForChips({ modelValue: mockModel, photo }); + w.vm.chipState.labels.search = "cat"; + w.vm.onLabelEnter(); + expect(photo.addLabel).not.toHaveBeenCalled(); + }); + + it("should match existing labels through normalization (& vs and)", () => { + const photo = { + ...mockPhoto, + Labels: [{ Uncertainty: 0, Label: { ID: 99, UID: "lbl99", Name: "Rock & Roll", Slug: "rock-and-roll", CustomSlug: "" } }], + }; + const w = mountInfoForChips({ modelValue: mockModel, photo }); + w.vm.chipState.labels.search = "rock and roll"; + w.vm.onLabelEnter(); + expect(photo.addLabel).not.toHaveBeenCalled(); + }); + + it("should silently reject punctuation-only label input", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.labels.search = "!!!"; + w.vm.onLabelEnter(); + expect(mockPhoto.addLabel).not.toHaveBeenCalled(); + expect(w.vm.$notify.error).not.toHaveBeenCalled(); + }); + + it("should accept emoji-only label input and call photo.addLabel", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.labels.search = "🌅"; + w.vm.onLabelEnter(); + expect(mockPhoto.addLabel).toHaveBeenCalledWith("🌅"); + }); + + it("should notify on photo.addLabel rejection (no transient chip)", async () => { + mockPhoto.addLabel = vi.fn().mockRejectedValue(new Error("boom")); + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.labels.search = "Sunset"; + w.vm.onLabelEnter(); + // Wait two microtasks for the promise rejection + .catch handler. + await Promise.resolve(); + await Promise.resolve(); + expect(w.vm.$notify.error).toHaveBeenCalledWith("Failed to save changes"); + }); + + // L3: addLabelImmediate cross-checks labelOptions via $util.normalizeTitle + // so typed variants like `Hello Cat` / `hello-cat` collapse onto the + // canonical existing label (preserving server-side casing/punctuation). + it("should canonicalize the typed name to an existing labelOption when normalized-equal", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.labels.options = [{ UID: "lbl-canonical", Name: "Hello Cat" }]; + w.vm.chipState.labels.search = "hello-cat"; + w.vm.onLabelEnter(); + // Backend gets the canonical existing-label name, NOT the typed variant. + expect(mockPhoto.addLabel).toHaveBeenCalledWith("Hello Cat"); + }); + + it("should pass the typed name through when no labelOption matches", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.labels.options = [{ UID: "lbl-canonical", Name: "Hello Cat" }]; + w.vm.chipState.labels.search = "Sunset"; + w.vm.onLabelEnter(); + // Sunset has no match in labelOptions → typed name is sent verbatim. + expect(mockPhoto.addLabel).toHaveBeenCalledWith("Sunset"); + }); + + it("should canonicalize across punctuation and case variants", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.labels.options = [{ UID: "lbl-canonical", Name: "Rock & Roll" }]; + // & expands to "and" in normalization, so "Rock and Roll" maps to the + // same canonical label and the saved name picks up the & spelling. + w.vm.chipState.labels.search = "Rock and Roll"; + w.vm.onLabelEnter(); + expect(mockPhoto.addLabel).toHaveBeenCalledWith("Rock & Roll"); + }); + + // Parity with onAlbumEnter: pressing Enter on non-empty Labels input + // ALWAYS clears the input and bumps the key (force-remount closes the + // menu), regardless of whether addLabelImmediate fired an API call. + // The pre-fix code only cleared on success, which left the input + // populated and the menu open when the typed label was already on the + // photo — felt unresolved next to Albums. + it("clears the input and bumps the key when Enter fires a real add", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + const startKey = w.vm.chipState.labels.key; + w.vm.chipState.labels.search = "Brand New Label"; + w.vm.onLabelEnter(); + expect(mockPhoto.addLabel).toHaveBeenCalledWith("Brand New Label"); + expect(w.vm.chipState.labels.search).toBe(""); + expect(w.vm.chipState.labels.input).toBe(null); + expect(w.vm.chipState.labels.key).toBe(startKey + 1); + }); + + it("clears the input and bumps the key when Enter is pressed on a label already on the photo", () => { + const photo = { + ...mockPhoto, + Labels: [{ Uncertainty: 0, Label: { ID: 99, UID: "lbl99", Name: "Nature", Slug: "nature", CustomSlug: "" } }], + }; + const w = mountInfoForChips({ modelValue: mockModel, photo }); + const startKey = w.vm.chipState.labels.key; + w.vm.chipState.labels.search = "Nature"; + w.vm.onLabelEnter(); + // The label is already on the photo — addLabelImmediate short-circuits + // and no API call is made. + expect(photo.addLabel).not.toHaveBeenCalled(); + // …but the input must still clear and the menu close so the gesture + // feels resolved (matches onAlbumEnter). + expect(w.vm.chipState.labels.search).toBe(""); + expect(w.vm.chipState.labels.input).toBe(null); + expect(w.vm.chipState.labels.key).toBe(startKey + 1); + }); + + it("does not clear or bump the key on empty Enter", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + const startKey = w.vm.chipState.labels.key; + w.vm.chipState.labels.search = " "; + w.vm.onLabelEnter(); + expect(mockPhoto.addLabel).not.toHaveBeenCalled(); + // Empty/whitespace Enter is a no-op — leave the input alone so the + // user can keep typing without losing focus mid-keystroke. + expect(w.vm.chipState.labels.key).toBe(startKey); + }); + + it("does not clear the input when the typed name is too long", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + const startKey = w.vm.chipState.labels.key; + const typed = "a".repeat(CLIP_LEN + 10); + w.vm.chipState.labels.search = typed; + w.vm.onLabelEnter(); + expect(mockPhoto.addLabel).not.toHaveBeenCalled(); + expect(w.vm.$notify.error).toHaveBeenCalledWith("Name too long"); + // Length-validation failures keep the typed text so the user can + // shorten it instead of losing the whole entry. + expect(w.vm.chipState.labels.search).toBe(typed); + expect(w.vm.chipState.labels.key).toBe(startKey); + }); + + // Pending album operations + it("should toggle album pending removal", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + const uid = "alb1"; + + expect(w.vm.isChipPendingRemoval("albums", uid)).toBe(false); + w.vm.togglePendingChipRemoval("albums", uid); + expect(w.vm.isChipPendingRemoval("albums", uid)).toBe(true); + w.vm.togglePendingChipRemoval("albums", uid); + expect(w.vm.isChipPendingRemoval("albums", uid)).toBe(false); + }); + + // L8: instant-save additions — onAlbumSelected calls photo.addToAlbum + // with the album UID immediately. The chip appears as a real primary + // chip via the model's evict+refind chain (mocked here as a resolved + // Promise). chipState.albums.additions does not exist anymore. + it("should call photo.addToAlbum immediately on onAlbumSelected", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + const album = { UID: "alb-new", Title: "New Album" }; + + w.vm.onAlbumSelected(album); + expect(mockPhoto.addToAlbum).toHaveBeenCalledWith("alb-new"); + expect(mockPhoto.addToAlbum).toHaveBeenCalledTimes(1); + }); + + // Chip keyboard accessibility (proposal item L6) — onChipActivate covers + // click + Enter (always navigates, in both editable and read-only modes), + // onChipDelete covers Delete + Backspace and the × icon click (toggles + // pending removal only when editable). + it("onChipActivate navigates a label chip when the section is read-only", () => { + const openSpy = vi.spyOn(window, "open").mockImplementation(() => null); + // mountWithMockRouter omits canEdit → isEditable false. + const w = mountWithMockRouter("/library/browse"); + w.vm.onChipActivate("labels", { Label: { ID: 1, UID: "lbl1", Name: "Nature", Slug: "nature", CustomSlug: "" } }); + expect(w.vm.$router.resolve).toHaveBeenCalledWith({ name: "browse", query: { q: "label:nature" } }); + expect(openSpy).toHaveBeenCalled(); + openSpy.mockRestore(); + }); + + // Chip click is always a link — even in edit mode. Removal happens via + // the × icon (separate click handler on the v-icon) or the keyboard + // Delete / Backspace path. The earlier "click anywhere on the chip to + // remove" behavior was a regression flagged by the user on May 11. + it("onChipActivate navigates a label chip even when the section is editable", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + const navSpy = vi.spyOn(w.vm, "navigateToLabel").mockImplementation(() => null); + const label = { Label: { ID: 7, UID: "lbl7", Name: "Beach" } }; + w.vm.onChipActivate("labels", label); + + expect(navSpy).toHaveBeenCalledWith(label.Label); + expect(w.vm.isChipPendingRemoval("labels", 7)).toBe(false); + navSpy.mockRestore(); + }); + + it("onChipActivate navigates an album chip when the section is read-only", () => { + const openSpy = vi.spyOn(window, "open").mockImplementation(() => null); + const w = mountWithMockRouter("/library/albums/alb1/view"); + w.vm.onChipActivate("albums", { UID: "alb1", Title: "Vacation 2023" }); + expect(w.vm.$router.resolve).toHaveBeenCalledWith({ name: "album", params: { album: "alb1", slug: "view" } }); + expect(openSpy).toHaveBeenCalled(); + openSpy.mockRestore(); + }); + + it("onChipActivate navigates an album chip even when the section is editable", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + const navSpy = vi.spyOn(w.vm, "navigateToAlbum").mockImplementation(() => null); + const album = { UID: "alb-x", Title: "Trip" }; + w.vm.onChipActivate("albums", album); + + expect(navSpy).toHaveBeenCalledWith(album); + expect(w.vm.isChipPendingRemoval("albums", "alb-x")).toBe(false); + navSpy.mockRestore(); + }); + + it("onChipDelete is a no-op when the section is not editable", () => { + // mountWithMockRouter omits canEdit → isEditable false. onChipDelete + // should refuse to stage a removal in a read-only context. + const w = mountWithMockRouter("/library/browse"); + w.vm.onChipDelete("labels", { Label: { ID: 1 } }); + w.vm.onChipDelete("albums", { UID: "alb1" }); + expect(w.vm.chipState.labels.removals).toHaveLength(0); + expect(w.vm.chipState.albums.removals).toHaveLength(0); + }); + + it("onChipDelete toggles removal independently per field when editable", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + // Both fields' chips are deletable simultaneously now that the chip + // sections share a single isEditable gate (no per-section edit-mode). + w.vm.onChipDelete("labels", { Label: { ID: 9 } }); + w.vm.onChipDelete("albums", { UID: "alb-y" }); + expect(w.vm.isChipPendingRemoval("labels", 9)).toBe(true); + expect(w.vm.isChipPendingRemoval("albums", "alb-y")).toBe(true); + }); + + it("onChipActivate / onChipDelete tolerate falsy items", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + expect(() => w.vm.onChipActivate("labels", null)).not.toThrow(); + expect(() => w.vm.onChipDelete("labels", undefined)).not.toThrow(); + }); + + it("should ignore non-object values in onAlbumSelected", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.onAlbumSelected("string-value"); + w.vm.onAlbumSelected(null); + expect(mockPhoto.addToAlbum).not.toHaveBeenCalled(); + }); + + // v-combobox emits transient update:model-value events while the user + // types free text. Clearing the input here would bump chipState.albums.key, + // force-remount the combobox, and kill focus mid-keystroke. The non-object + // path must be a silent no-op so typing into the album combobox stays + // usable. Mirrors onLabelSelected. + it("should not clear chipState.albums on transient non-object onAlbumSelected", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.albums.search = "test"; + w.vm.chipState.albums.input = "test"; + const initialKey = w.vm.chipState.albums.key; + w.vm.onAlbumSelected("test"); + w.vm.onAlbumSelected(null); + w.vm.onAlbumSelected({ Title: "test" }); // free-text stub without UID + expect(w.vm.chipState.albums.search).toBe("test"); + expect(w.vm.chipState.albums.input).toBe("test"); + expect(w.vm.chipState.albums.key).toBe(initialKey); + }); + + it("should skip albums already on the photo in onAlbumSelected", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.onAlbumSelected({ UID: "alb1", Title: "Vacation 2023" }); + expect(mockPhoto.addToAlbum).not.toHaveBeenCalled(); + }); + + // Album validation parity with batch edit + labels tab. + it("should dedupe albums by normalized title even when UIDs differ", () => { + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.onAlbumSelected({ UID: "alb-other", Title: "vacation 2023" }); + expect(mockPhoto.addToAlbum).not.toHaveBeenCalled(); + }); + + it("should reject overlong album titles in onAlbumEnter and not call save", () => { + const saveSpy = vi.spyOn(Album.prototype, "save").mockResolvedValue(); + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.albums.search = "a".repeat(CLIP_LEN + 10); + w.vm.onAlbumEnter(); + expect(saveSpy).not.toHaveBeenCalled(); + expect(mockPhoto.addToAlbum).not.toHaveBeenCalled(); + expect(w.vm.$notify.error).toHaveBeenCalledWith("Name too long"); + saveSpy.mockRestore(); + }); + + it("should ignore empty/whitespace input in onAlbumEnter and not call save", () => { + const saveSpy = vi.spyOn(Album.prototype, "save").mockResolvedValue(); + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.albums.search = " "; + w.vm.onAlbumEnter(); + expect(saveSpy).not.toHaveBeenCalled(); + expect(mockPhoto.addToAlbum).not.toHaveBeenCalled(); + saveSpy.mockRestore(); + }); + + it("should skip onAlbumEnter when title matches existing album case-insensitively", () => { + const saveSpy = vi.spyOn(Album.prototype, "save").mockResolvedValue(); + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.albums.search = "VACATION 2023"; + w.vm.onAlbumEnter(); + expect(saveSpy).not.toHaveBeenCalled(); + expect(mockPhoto.addToAlbum).not.toHaveBeenCalled(); + saveSpy.mockRestore(); + }); + + it("should create a new album in onAlbumEnter and add the photo to it", async () => { + const saveSpy = vi.spyOn(Album.prototype, "save").mockImplementation(function () { + this.UID = "alb-created"; + return Promise.resolve(this); + }); + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.albums.options = []; + w.vm.chipState.albums.search = "Brand New Trip"; + w.vm.onAlbumEnter(); + await new Promise((r) => setTimeout(r, 0)); + expect(saveSpy).toHaveBeenCalledTimes(1); + // After Album.save resolves with a UID, the sidebar fires the + // instant-save addAlbumImmediate path → photo.addToAlbum(newUid). + expect(mockPhoto.addToAlbum).toHaveBeenCalledWith("alb-created"); + expect(w.vm.chipState.albums.options.some((a) => a.UID === "alb-created")).toBe(true); + saveSpy.mockRestore(); + }); + + it("should notify on photo.addToAlbum rejection (no transient chip)", async () => { + mockPhoto.addToAlbum = vi.fn().mockRejectedValue(new Error("boom")); + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.onAlbumSelected({ UID: "alb-new", Title: "New Album" }); + // Wait two microtasks for the promise rejection + .catch handler. + await Promise.resolve(); + await Promise.resolve(); + expect(w.vm.$notify.error).toHaveBeenCalledWith("Failed to save changes"); + }); + + // onAlbumEnter resolves typed text to an existing album only via a + // normalized exact match (case + punctuation + `+`/`_`/`-` → space). + // Substring fuzzy matching is intentionally NOT applied — typing `test` + // must not silently merge into an unrelated `LRUTEST-ALBUM-…`. Users pick + // partial matches via the dropdown (click or arrow + Enter on a + // highlighted item, which fires `onAlbumSelected`). + it("onAlbumEnter creates a new album when typed text only fuzzy-matches existing options", async () => { + const saveSpy = vi.spyOn(Album.prototype, "save").mockImplementation(function () { + this.UID = "alb-new-ar"; + return Promise.resolve(this); + }); + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.albums.options = [ + { UID: "alb-berlin", Title: "Berlin" }, + { UID: "alb-archive", Title: "Archive" }, + { UID: "alb-arctic", Title: "Arctic" }, + ]; + // `ar` is a substring of "Archive"/"Arctic"/"Berlin" but NOT a + // normalized exact match for any of them. The legacy fuzzy fallback + // would have silently merged into "Archive"; the new behavior creates + // a fresh "ar" album to mirror the labels combobox's free-text path. + w.vm.chipState.albums.search = "ar"; + w.vm.onAlbumEnter(); + await new Promise((r) => setTimeout(r, 0)); + expect(saveSpy).toHaveBeenCalledTimes(1); + expect(mockPhoto.addToAlbum).toHaveBeenCalledWith("alb-new-ar"); + saveSpy.mockRestore(); + }); + + it("onAlbumEnter normalizes punctuation and case for exact-match resolution", () => { + const saveSpy = vi.spyOn(Album.prototype, "save").mockResolvedValue(); + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.albums.options = [{ UID: "alb-hello-cat", Title: "Hello Cat" }]; + // `hello-cat`, `Hello+Cat`, `hello.CAT`, `HELLO CAT` all normalize to + // "hello cat" (every punctuation character is converted to whitespace + // by normalizeTitle), so they should resolve to the existing + // "Hello Cat" album. + for (const typed of ["hello-cat", "Hello+Cat", "hello.CAT", "HELLO CAT"]) { + mockPhoto.addToAlbum.mockClear(); + w.vm.chipState.albums.search = typed; + w.vm.onAlbumEnter(); + expect(mockPhoto.addToAlbum).toHaveBeenCalledWith("alb-hello-cat"); + // Pulled out the existing album — no Album.save round-trip. + expect(saveSpy).not.toHaveBeenCalled(); + } + saveSpy.mockRestore(); + }); + + it("onAlbumEnter creates a new album for substring-only matches instead of merging", async () => { + const saveSpy = vi.spyOn(Album.prototype, "save").mockImplementation(function () { + this.UID = "alb-new-summer"; + return Promise.resolve(this); + }); + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.albums.options = [{ UID: "alb-summer-2023", Title: "Summer 2023" }]; + // `summer` is a substring of "Summer 2023" but not a normalized exact + // match — typing it and pressing Enter must create a fresh "summer" + // album, not silently add the photo to "Summer 2023". + w.vm.chipState.albums.search = "summer"; + w.vm.onAlbumEnter(); + await new Promise((r) => setTimeout(r, 0)); + expect(saveSpy).toHaveBeenCalledTimes(1); + expect(mockPhoto.addToAlbum).toHaveBeenCalledWith("alb-new-summer"); + saveSpy.mockRestore(); + }); + + // Regression test for the reported bug: typing "test" must not match an + // existing album whose title contains "test" as a substring. + it("onAlbumEnter creates a new album when typed text appears as a substring of an existing title", async () => { + const saveSpy = vi.spyOn(Album.prototype, "save").mockImplementation(function () { + this.UID = "alb-new-test"; + return Promise.resolve(this); + }); + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.chipState.albums.options = [{ UID: "alb-lrutest", Title: "LRUTEST-ALBUM-1777990015505" }]; + w.vm.chipState.albums.search = "test"; + w.vm.onAlbumEnter(); + await new Promise((r) => setTimeout(r, 0)); + expect(saveSpy).toHaveBeenCalledTimes(1); + expect(mockPhoto.addToAlbum).toHaveBeenCalledWith("alb-new-test"); + saveSpy.mockRestore(); + }); + + // cancelEditing only resets inline-text edit state. Pending chip + // removals are independent (committed via the toolbar ✓) and survive + // an inline-text Esc — chip state is cleared by resetInlineEdits() + // when the discard-pending dialog confirms. + it("should leave chip removals intact when cancelEditing fires", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.editingField = "title"; + w.vm.editOriginal = "Original Title"; + w.vm.chipState.labels.removals = [1]; + w.vm.chipState.albums.removals = ["alb1"]; + + w.vm._editStartedAt = Date.now() - 300; + w.vm.cancelEditing(); + + expect(w.vm.editingField).toBeNull(); + expect(w.vm.chipState.labels.removals).toEqual([1]); + expect(w.vm.chipState.albums.removals).toEqual(["alb1"]); + }); + + it("should clear all pending state on resetInlineEdits", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.chipState.labels.removals = [1]; + w.vm.chipState.albums.removals = ["alb1"]; + w.vm.chipState.labels.search = "typed-but-not-saved"; + + w.vm.resetInlineEdits(); + + expect(w.vm.chipState.labels.removals).toHaveLength(0); + expect(w.vm.chipState.albums.removals).toHaveLength(0); + expect(w.vm.chipState.labels.search).toBe(""); + }); + + // Photo watcher: the parent lightbox owns the unsaved-changes guard, so + // the sidebar no longer silently cancels inline edits when photo changes. + it("should preserve inline edit state across photo changes (parent guards navigation)", async () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.editingField = "title"; + w.vm._editStartedAt = Date.now() - 300; + + await w.setProps({ photo: { ...mockPhoto, Title: "Other" } }); + expect(w.vm.editingField).toBe("title"); + }); + + // L10: loadChipOptions reads from the shared module-scope typeahead + // cache. The cache itself owns the cap warning + de-dup contract + // (see common/typeahead-cache.test.js); these tests only pin that + // the sidebar populates chipState..options from getLabels / + // getAlbums and maps to the consumer-friendly shape. + describe("loadChipOptions cache integration", () => { + it("populates chipState.labels.options from typeaheadCache.getLabels", async () => { + typeaheadCache.clear(); + const models = [{ Name: "Cat", UID: "lbl-cat", Slug: "cat" }]; + const cacheSpy = vi.spyOn(typeaheadCache, "getLabels").mockResolvedValueOnce(models); + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.loadChipOptions("labels"); + await Promise.resolve(); + await Promise.resolve(); + expect(cacheSpy).toHaveBeenCalled(); + // Sidebar maps to the {Name, UID} shape its combobox needs. + expect(w.vm.chipState.labels.options).toEqual([{ Name: "Cat", UID: "lbl-cat" }]); + cacheSpy.mockRestore(); + }); + + it("populates chipState.albums.options from typeaheadCache.getAlbums", async () => { + typeaheadCache.clear(); + const models = [{ Title: "Trip", UID: "alb-trip" }]; + const cacheSpy = vi.spyOn(typeaheadCache, "getAlbums").mockResolvedValueOnce(models); + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.loadChipOptions("albums"); + await Promise.resolve(); + await Promise.resolve(); + expect(cacheSpy).toHaveBeenCalled(); + // Sidebar passes album models through unchanged. + expect(w.vm.chipState.albums.options).toEqual(models); + cacheSpy.mockRestore(); + }); + + it("swallows cache errors so a transient fetch failure does not block the editor", async () => { + const cacheSpy = vi.spyOn(typeaheadCache, "getLabels").mockRejectedValueOnce(new Error("boom")); + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + expect(() => w.vm.loadChipOptions("labels")).not.toThrow(); + await Promise.resolve(); + await Promise.resolve(); + expect(w.vm.chipState.labels.options).toEqual([]); + cacheSpy.mockRestore(); + }); + + // The backend's order=name doesn't always return a clean + // alphabetical list (and the cap-bounded fetch may interleave). + // Sort client-side via locale-aware comparison so the dropdown + // reads naturally for the user. + it("sorts label options alphabetically (case-insensitive)", async () => { + typeaheadCache.clear(); + const cacheSpy = vi + .spyOn(typeaheadCache, "getLabels") + .mockResolvedValueOnce([ + { Name: "Mountain", UID: "1" }, + { Name: "apple", UID: "2" }, + { Name: "Beach", UID: "3" }, + ]); + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.loadChipOptions("labels"); + await Promise.resolve(); + await Promise.resolve(); + expect(w.vm.chipState.labels.options.map((l) => l.Name)).toEqual(["apple", "Beach", "Mountain"]); + cacheSpy.mockRestore(); + }); + + it("sorts album options alphabetically by title", async () => { + typeaheadCache.clear(); + const cacheSpy = vi + .spyOn(typeaheadCache, "getAlbums") + .mockResolvedValueOnce([ + { Title: "Zebra", UID: "z" }, + { Title: "alpha", UID: "a" }, + { Title: "Mango", UID: "m" }, + ]); + const w = mountInfoForChips({ modelValue: mockModel, photo: mockPhoto }); + w.vm.loadChipOptions("albums"); + await Promise.resolve(); + await Promise.resolve(); + expect(w.vm.chipState.albums.options.map((a) => a.Title)).toEqual(["alpha", "Mango", "Zebra"]); + cacheSpy.mockRestore(); + }); + }); + + // clearChipInput now takes a field argument; the no-arg form clears + // every field (used by resetInlineEdits during a discard-pending). + it("should reset per-field chip state on clearChipInput(field)", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.chipState.labels.input = { Name: "test" }; + w.vm.chipState.labels.search = "test"; + const prevKey = w.vm.chipState.labels.key; + + w.vm.clearChipInput("labels"); + + expect(w.vm.chipState.labels.input).toBeNull(); + expect(w.vm.chipState.labels.search).toBe(""); + expect(w.vm.chipState.labels.key).toBe(prevKey + 1); + }); + + it("should reset both fields when clearChipInput is called without arguments", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.chipState.labels.search = "type-l"; + w.vm.chipState.albums.search = "type-a"; + + w.vm.clearChipInput(); + + expect(w.vm.chipState.labels.search).toBe(""); + expect(w.vm.chipState.albums.search).toBe(""); + }); + + // `visibleLabels` / `visibleAlbums` filter out chips marked for removal + // so the chip-row `v-list-item` disappears once every chip in the + // section has been soft-removed. Without these computeds the wrapper + // would render as an empty box above the combobox row. + describe("visibleLabels / visibleAlbums computeds", () => { + it("hides soft-removed labels from the visible list", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + const total = w.vm.labels.length; + expect(total).toBeGreaterThan(0); + const firstId = w.vm.labels[0].Label.ID; + w.vm.togglePendingChipRemoval("labels", firstId); + + expect(w.vm.visibleLabels).toHaveLength(total - 1); + expect(w.vm.visibleLabels.some((l) => l?.Label?.ID === firstId)).toBe(false); + }); + + it("repopulates after undoChipRemovals so the wrapper comes back", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + const total = w.vm.labels.length; + w.vm.labels.forEach((l) => w.vm.togglePendingChipRemoval("labels", l?.Label?.ID)); + expect(w.vm.visibleLabels).toHaveLength(0); + + w.vm.undoChipRemovals("labels"); + + expect(w.vm.visibleLabels).toHaveLength(total); + }); + + it("hides soft-removed albums from the visible list", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + const total = w.vm.albums.length; + if (total === 0) { + return; + } // fixture has no albums — nothing to assert + const firstUid = w.vm.albums[0].UID; + w.vm.togglePendingChipRemoval("albums", firstUid); + + expect(w.vm.visibleAlbums).toHaveLength(total - 1); + expect(w.vm.visibleAlbums.some((a) => a?.UID === firstUid)).toBe(false); + }); + }); + + // The Undo icon in each chip section toolbar clears that section's + // `chipState..removals` in a single click. Soft-removed chips + // are filtered out by `visibleLabels` / `visibleAlbums`, so clearing + // the removals array makes the chips reappear reactively in the v-for. + describe("undoChipRemovals(field)", () => { + it("clears pending labels removals but leaves albums untouched", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.chipState.labels.removals = [1, 2]; + w.vm.chipState.albums.removals = ["alb-x"]; + + w.vm.undoChipRemovals("labels"); + + expect(w.vm.chipState.labels.removals).toHaveLength(0); + expect(w.vm.chipState.albums.removals).toEqual(["alb-x"]); + }); + + it("clears pending albums removals but leaves labels untouched", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.chipState.labels.removals = [1]; + w.vm.chipState.albums.removals = ["alb-x", "alb-y"]; + + w.vm.undoChipRemovals("albums"); + + expect(w.vm.chipState.labels.removals).toEqual([1]); + expect(w.vm.chipState.albums.removals).toHaveLength(0); + }); + + it("is a silent no-op for an unknown field key", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.chipState.labels.removals = [1]; + expect(() => w.vm.undoChipRemovals("nope")).not.toThrow(); + expect(w.vm.chipState.labels.removals).toEqual([1]); + }); + }); + + // Auto-commit on navigation/close: when the lightbox calls + // confirmDiscardPending() (slide change, close, keyboard navigation), + // pending chip removals commit silently first — mirroring the inline- + // text auto-commit on blur. The discard dialog only fires for state + // the user could still want to keep (marker drafts, typed combobox text, + // open Add-name confirmation). + describe("auto-commit chip removals on confirmDiscardPending", () => { + it("fires confirmLabels when labels have pending removals", async () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + const spy = vi.spyOn(w.vm, "confirmLabels"); + w.vm.chipState.labels.removals = [42]; + + const result = w.vm.confirmDiscardPending(); + + expect(spy).toHaveBeenCalledTimes(1); + expect(w.vm.discardDialog.visible).toBe(false); + await expect(result).resolves.toBe(true); + }); + + it("fires confirmAlbums when albums have pending removals", async () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + const spy = vi.spyOn(w.vm, "confirmAlbums"); + w.vm.chipState.albums.removals = ["alb-x"]; + + const result = w.vm.confirmDiscardPending(); + + expect(spy).toHaveBeenCalledTimes(1); + expect(w.vm.discardDialog.visible).toBe(false); + await expect(result).resolves.toBe(true); + }); + + it("skips confirmLabels / confirmAlbums when there are no pending removals", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + const labelsSpy = vi.spyOn(w.vm, "confirmLabels"); + const albumsSpy = vi.spyOn(w.vm, "confirmAlbums"); + + w.vm.confirmDiscardPending(); + + expect(labelsSpy).not.toHaveBeenCalled(); + expect(albumsSpy).not.toHaveBeenCalled(); + }); + + it("still opens the discard dialog when typed combobox text remains after auto-commit", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.chipState.labels.removals = [42]; + w.vm.chipState.labels.search = "alpha"; + + w.vm.confirmDiscardPending(); + + // Removals were auto-committed (cleared synchronously by confirmLabels), + // but the typed text remained, so the dialog had to open. + expect(w.vm.chipState.labels.removals).toHaveLength(0); + expect(w.vm.discardDialog.visible).toBe(true); + // Resolve so the test doesn't hang. + w.vm.onDiscardCancel(); + }); + + // Settling matched drafts up front avoids the @blur vs discard-dialog + // race that used to persist the change even when the user clicked Discard. + it("auto-commits a matched marker draft so the discard dialog does not appear", async () => { + const setName = vi.fn().mockResolvedValue(undefined); + const marker = { + UID: "m2", + Name: "", + SubjUID: "", + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName, + }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([marker]) }; + const knownPersonConfig = { + ...validationConfig, + values: { people: [{ UID: "sALC", Name: "Alice Smith" }] }, + }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true }, mocks: { $config: knownPersonConfig, $util: validationUtil } }, + }); + await w.vm.$nextTick(); + w.vm.chipState.people.options = [{ UID: "sALC", Name: "Alice Smith" }]; + w.vm.setMarkerInputValue("m2", "Alice Smith"); + + const result = w.vm.confirmDiscardPending(); + + expect(setName).toHaveBeenCalledTimes(1); + expect(marker.Name).toBe("Alice Smith"); + expect(marker.SubjUID).toBe("sALC"); + expect(w.vm.discardDialog.visible).toBe(false); + await expect(result).resolves.toBe(true); + }); + + // Stacking a discard dialog on top of the Add-name dialog would + // double-prompt for the same decision; defer instead. + it("defers to the Add-name dialog instead of stacking a discard prompt", async () => { + const marker = { + UID: "m2", + Name: "", + SubjUID: "", + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName: vi.fn().mockResolvedValue(undefined), + }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([marker]) }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true }, mocks: { $config: validationConfig, $util: validationUtil } }, + }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m2", "Brand New Name"); + w.vm.confirmMarkerName(marker, "blur"); + expect(w.vm.addNameDialog.visible).toBe(true); + + const result = w.vm.confirmDiscardPending(); + + // No discard dialog stacked on top of Add-name. + expect(w.vm.discardDialog.visible).toBe(false); + // Cancelling Add-name resolves navigation without a second prompt. + w.vm.onAddNameCancel(); + await expect(result).resolves.toBe(true); + }); + + it("confirming the Add-name dialog also resolves the deferred navigation", async () => { + const setName = vi.fn().mockResolvedValue(undefined); + const marker = { + UID: "m2", + Name: "", + SubjUID: "", + thumbnailUrl: () => "/t/thumb2/public/tile_160", + setName, + }; + const photo = { ...mockPhoto, getMarkers: vi.fn().mockReturnValue([marker]) }; + const w = mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true }, mocks: { $config: validationConfig, $util: validationUtil } }, + }); + await w.vm.$nextTick(); + w.vm.setMarkerInputValue("m2", "Brand New Name"); + w.vm.confirmMarkerName(marker, "blur"); + const result = w.vm.confirmDiscardPending(); + + w.vm.onAddNameConfirm(); + + expect(setName).toHaveBeenCalledTimes(1); + expect(marker.Name).toBe("Brand New Name"); + await expect(result).resolves.toBe(true); + }); + }); + + // L9: onChipEscape clears the typed text and pending removals for one + // field — independent of any inline-text editingField that might be + // active in the sidebar. + it("should clear search and removals on onChipEscape(field)", () => { + const w = mountSidebar({ + props: { modelValue: mockModel, photo: mockPhoto, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true } }, + }); + w.vm.chipState.labels.search = "summer"; + w.vm.chipState.labels.removals = [42]; + w.vm.chipState.albums.removals = ["alb-x"]; + + w.vm.onChipEscape("labels"); + + expect(w.vm.chipState.labels.search).toBe(""); + expect(w.vm.chipState.labels.removals).toHaveLength(0); + // Albums removals untouched — Esc is per-field. + expect(w.vm.chipState.albums.removals).toEqual(["alb-x"]); + }); + + describe("restricted-role view", () => { + // Returns a $config mock whose ACL grants deny everything when + // `restricted` is true (simulating a share-link / visitor session + // without library access), or allows everything when false. This + // is the new substrate that replaces the static-array session check + // — the sidebar now reads each gate through $config.allow(). + const restrictedConfig = (restricted) => ({ + feature: () => true, + get: () => false, + getSettings: () => ({ features: { edit: true, favorites: true, download: true, archive: true } }), + allow: () => !restricted, + deny: () => !!restricted, + featExperimental: () => false, + featDevelop: () => false, + values: {}, + dir: () => "ltr", + }); + + const mountRestricted = (isRestricted) => + mountSidebar({ + props: { + modelValue: mockModel, + photo: mockPhoto, + canEdit: true, + context: contexts.Photos, + }, + global: { + stubs: { PMap: true }, + mocks: { + $config: restrictedConfig(isRestricted), + }, + }, + }); + + it("renders permitted fields for restricted sessions", () => { + const w = mountRestricted(true); + const html = w.html(); + + expect(w.vm.canViewLibrary).toBe(false); + expect(html).toContain("Test Title"); + expect(html).toContain("Test Caption"); + expect(html).toContain("JPEG, 1920 × 1080, 4.2 MB"); + expect(html).toContain("52.5200°N 13.4050°E"); + }); + + it("hides every restricted sidebar section for restricted sessions", () => { + const w = mountRestricted(true); + const html = w.html(); + + // The merged file row (type + dimensions + size as the title) + // stays visible for restricted sessions per the parallel + // "renders permitted fields" test above; the filename subtitle + // is gated off and the row collapses to a single line. + expect(w.find(".meta-file").exists()).toBe(true); + expect(html).not.toContain("photos/2023/IMG_001.jpg"); + + expect(html).not.toContain("Canon EOS R5"); + expect(html).not.toContain("RF 50mm F1.2L"); + expect(html).not.toContain("mdi-camera"); + expect(html).not.toContain("mdi-camera-iris"); + + // Place name; coordinates + map remain visible. + expect(html).not.toContain("Berlin, Germany"); + + expect(html).not.toContain(">People<"); + expect(html).not.toContain(">Labels<"); + expect(html).not.toContain(">Albums<"); + + expect(html).not.toContain("Jane Doe"); + expect(html).not.toContain("Nature"); + expect(html).not.toContain("Vacation 2023"); + expect(html).not.toContain("Mountains"); // Subject + expect(html).not.toContain("John Photographer"); // Artist + expect(html).not.toContain("2023 John"); // Copyright + expect(html).not.toContain("CC BY 4.0"); // License + expect(html).not.toContain("Some notes about this photo"); + expect(html).not.toContain("nature, mountains, sunset"); // Keywords + + expect(w.vm.isEditable).toBe(false); + expect(w.find(".meta-inline-pencil").exists()).toBe(false); + }); + + it("shows the full sidebar when the session is not restricted", () => { + const w = mountRestricted(false); + const html = w.html(); + + expect(w.vm.canViewLibrary).toBe(true); + expect(html).toContain("Canon EOS R5"); + expect(html).toContain("RF 50mm F1.2L"); + expect(html).toContain("photos/2023/IMG_001.jpg"); + expect(html).toContain("Berlin, Germany"); + }); + + it("falls back to model.getTypeInfo for fileInfo when photo is null", () => { + const thumbModel = { + ...mockModel, + getTypeInfo: vi.fn().mockReturnValue("JPEG\u20034.0MP\u20034032\u2009\u00d7\u20093024"), + }; + const w = mountSidebar({ + props: { + modelValue: thumbModel, + photo: null, + canEdit: false, + context: contexts.Photos, + }, + global: { + stubs: { PMap: true }, + mocks: { + $config: restrictedConfig(true), + }, + }, + }); + expect(w.vm.fileInfo).toBe("JPEG\u20034.0MP\u20034032\u2009\u00d7\u20093024"); + expect(thumbModel.getTypeInfo).toHaveBeenCalled(); + }); + + // fileTypeName drives the file-row tooltip \u2014 Image, Raw, Video, etc. + // The setup.js mock for $util.typeName echoes the type value for known + // strings and falls back to defaultValue when type is empty. + it("fileTypeName resolves the photo Type through $util.typeName", () => { + const w = mountSidebar({ + props: { + modelValue: mockModel, + photo: { ...mockPhoto, Type: "raw" }, + canEdit: false, + context: contexts.Photos, + }, + global: { stubs: { PMap: true } }, + }); + expect(w.vm.fileTypeName).toBe("raw"); + }); + + it("fileTypeName falls back to the generic File label when Type is empty", () => { + const thumbModel = { ...mockModel, Type: "" }; + const w = mountSidebar({ + props: { + modelValue: thumbModel, + photo: null, + canEdit: false, + context: contexts.Photos, + }, + global: { stubs: { PMap: true } }, + }); + expect(w.vm.fileTypeName).toBe("File"); + }); + + // Limited-access sessions never load the full Photo; the empty + // placeholder Photo.getDefaults() returns is seeded Type="image" and + // would mask the Thumb's real type (e.g. live) without the UID gate. + it("mediaType / fileTypeName / fileIcon fall through to Thumb.Type when Photo is the empty placeholder", () => { + const thumbModel = { ...mockModel, Type: "live" }; + const emptyPhoto = { UID: "", Type: "image", getMarkers: vi.fn().mockReturnValue([]) }; + const w = mountSidebar({ + props: { + modelValue: thumbModel, + photo: emptyPhoto, + canEdit: false, + context: contexts.Photos, + }, + global: { + stubs: { PMap: true }, + mocks: { $config: restrictedConfig(true) }, + }, + }); + expect(w.vm.mediaType).toBe("live"); + expect(w.vm.fileTypeName).toBe("live"); + expect(w.vm.fileIcon).toBe("mdi-play-circle-outline"); + }); + it("fileIcon is the panorama icon for an equirectangular 360° photo", () => { + const w = mountSidebar({ + props: { + modelValue: { ...mockModel, Type: "image", Projection: "equirectangular" }, + photo: { ...mockPhoto, Type: "image", Projection: "equirectangular" }, + context: contexts.Photos, + }, + }); + expect(w.vm.mediaIs360).toBe(true); + expect(w.vm.fileIcon).toBe("mdi-panorama-variant-outline"); + }); + it("fileIcon is the panorama icon for an equirectangular 360° video", () => { + const w = mountSidebar({ + props: { + modelValue: { ...mockModel, Type: "video", Projection: "equirectangular" }, + photo: { ...mockPhoto, Type: "video", Projection: "equirectangular", getVideoInfo: vi.fn().mockReturnValue("") }, + context: contexts.Photos, + }, + }); + expect(w.vm.mediaIs360).toBe(true); + expect(w.vm.fileIcon).toBe("mdi-panorama-variant-outline"); + }); + it("fileIcon is the panorama icon for a 2:1 panorama video without a projection tag", () => { + const w = mountSidebar({ + props: { + modelValue: { ...mockModel, Type: "video", Panorama: true, Projection: "", Width: 3840, Height: 1920 }, + photo: { ...mockPhoto, Type: "video", Panorama: true, Projection: "", Width: 3840, Height: 1920, getVideoInfo: vi.fn().mockReturnValue("") }, + context: contexts.Photos, + }, + }); + expect(w.vm.mediaIs360).toBe(true); + expect(w.vm.fileIcon).toBe("mdi-panorama-variant-outline"); + }); + it("fileIcon stays the standard video icon for an ultrawide (non-2:1) panorama video", () => { + const w = mountSidebar({ + props: { + modelValue: { ...mockModel, Type: "video", Panorama: true, Projection: "", Width: 3840, Height: 1632 }, + photo: { ...mockPhoto, Type: "video", Panorama: true, Projection: "", Width: 3840, Height: 1632, getVideoInfo: vi.fn().mockReturnValue("") }, + context: contexts.Photos, + }, + }); + expect(w.vm.mediaIs360).toBe(false); + expect(w.vm.fileIcon).toBe("mdi-video"); + }); + it("fileIcon stays the standard image icon for a regular photo", () => { + const w = mountSidebar({ + props: { + modelValue: { ...mockModel, Type: "image" }, + photo: { ...mockPhoto, Type: "image" }, + context: contexts.Photos, + }, + }); + expect(w.vm.mediaIs360).toBe(false); + expect(w.vm.fileIcon).toBe("mdi-image-outline"); + }); + }); + + // Exhaustive matrix: against a fully-populated photo and a photo + // without any metadata, assert which fields the sidebar renders and + // which edit affordances it exposes for each of the two equivalence + // classes that drive the gating today: "library access granted" vs + // "library access denied" (share-link visitors, guests, etc.). + // + // Each gate now flows through $config.allow(resource, perm). The + // matrix mocks the ACL by injecting a $config whose grants flip with + // the `restricted` flag, mirroring what the backend would send in + // the client config payload (internal/config/client_config.go). + describe("role x field visibility matrix", () => { + // Text fragments the tests look for. Keeping them here so a single + // change to the fixture (e.g. a label rename) stays localized. + const TEXT = { + title: "Matrix Title", + caption: "Matrix Caption", + filename: "photos/matrix/IMG_9001.jpg", + camera: "Canon EOS R5", + lens: "RF 50mm F1.2L", + placeName: "Berlin, Germany", + altitude: "128 m", + peopleHeader: ">People<", + labelsHeader: ">Labels<", + albumsHeader: ">Albums<", + namedMarker: "Jane Doe", + labelName: "Nature", + albumTitle: "Vacation 2024", + keywords: "sunset, mountains", + notes: "A short note on this photo", + subject: "Mountains", + artist: "John Photographer", + copyright: "2024 John", + license: "CC BY 4.0", + }; + + // Build a model with just enough for the sidebar header to render. + function buildModel({ withMetadata }) { + const base = { + UID: "matrix-photo", + TakenAtLocal: "2024-05-01T10:00:00Z", + TimeZone: "UTC", + getLatLng: vi.fn().mockReturnValue("52.5200°N 13.4050°E"), + getLatLngShort: vi.fn().mockReturnValue("52.5200°N 13.4050°E"), + copyLatLng: vi.fn(), + }; + if (withMetadata) { + return { + ...base, + Title: TEXT.title, + Caption: TEXT.caption, + Lat: 52.52, + Lng: 13.405, + Altitude: 128, + }; + } + // Empty-metadata photo: no title, no caption, no coordinates. + return { ...base, Title: "", Caption: "", Lat: 0, Lng: 0 }; + } + + function buildPhoto({ withMetadata }) { + if (!withMetadata) { + return { + Type: "image", + // No CameraID, no Lens, no markers, no labels, no albums, no + // Details; the component must suppress the corresponding rows. + getCameraInfo: vi.fn().mockReturnValue(""), + getLensInfo: vi.fn().mockReturnValue(""), + getImageInfo: vi.fn().mockReturnValue(""), + getVideoInfo: vi.fn().mockReturnValue(""), + getVectorInfo: vi.fn().mockReturnValue(""), + getExifInfo: vi.fn().mockReturnValue(""), + locationInfo: vi.fn().mockReturnValue(""), + getMarkers: vi.fn().mockReturnValue([]), + Labels: [], + Albums: [], + Details: null, + FileName: "", + }; + } + return { + UID: "ps6sg6be2lvl0y12", + Type: "image", + Lat: 52.52, + Lng: 13.405, + Altitude: 128, + CameraID: 2, + CameraMake: "Canon", + CameraModel: "EOS R5", + LensID: 2, + LensMake: "Canon", + LensModel: "RF 50mm F1.2L", + Iso: 400, + Exposure: "1/125", + FNumber: 1.2, + FocalLength: 50, + getCameraInfo: vi.fn().mockReturnValue(TEXT.camera), + getLensInfo: vi.fn().mockReturnValue(TEXT.lens), + getImageInfo: vi.fn().mockReturnValue("JPEG, 1920 x 1080, 4.2 MB"), + getVideoInfo: vi.fn().mockReturnValue(""), + getVectorInfo: vi.fn().mockReturnValue(""), + getExifInfo: vi.fn().mockReturnValue("50mm \u2022 f/1.2 \u2022 ISO 400 \u2022 1/125"), + PlaceLabel: TEXT.placeName, + Country: "de", + placeName: vi.fn().mockReturnValue(TEXT.placeName), + locationInfo: vi.fn().mockReturnValue(TEXT.placeName), + getMarkers: vi.fn().mockReturnValue([ + { UID: "m1", CropID: "crop1", Name: TEXT.namedMarker, SubjUID: "subj1", thumbnailUrl: () => "/t/thumb1/public/tile_160" }, + { UID: "m2", CropID: "crop2", Name: "", SubjUID: "", thumbnailUrl: () => "/svg/portrait" }, + ]), + Labels: [ + { Uncertainty: 0, Label: { ID: 1, UID: "lbl1", Name: TEXT.labelName, Slug: "nature", CustomSlug: "" } }, + // One high-uncertainty label the component must suppress. + { Uncertainty: 100, Label: { ID: 9, UID: "lbl9", Name: "HiddenLabel", Slug: "hidden", CustomSlug: "" } }, + ], + Albums: [{ UID: "alb1", Title: TEXT.albumTitle, Slug: "vacation-2024" }], + Details: { + Keywords: TEXT.keywords, + Notes: TEXT.notes, + Subject: TEXT.subject, + Artist: TEXT.artist, + Copyright: TEXT.copyright, + License: TEXT.license, + }, + FileName: TEXT.filename, + }; + } + + // matrixConfig builds a $config mock whose ACL grants follow the + // restricted flag. allow() returns true for every (resource, perm) + // pair when unrestricted; deny() is the boolean inverse so the + // fetchPhoto / preloadNextPhoto gates also resolve correctly. This + // is the substrate that replaced the static-array session check — + // it lets the visibility matrix below pivot on one boolean without + // re-implementing the role table. + const matrixConfig = (restricted) => ({ + feature: () => true, + get: () => false, + getSettings: () => ({ features: { edit: true, favorites: true, download: true, archive: true } }), + allow: () => !restricted, + deny: () => !!restricted, + featExperimental: () => false, + featDevelop: () => false, + values: {}, + dir: () => "ltr", + }); + + function mountFor({ anonymous, restricted, editable }, shape) { + return mountSidebar({ + props: { + modelValue: buildModel(shape), + photo: buildPhoto(shape), + canEdit: editable, + context: contexts.Photos, + }, + global: { + stubs: { PMap: true }, + mocks: { + $config: matrixConfig(restricted), + $session: { + isAnonymous: () => !!anonymous, + }, + }, + }, + }); + } + + describe("editable session (admin/user)", () => { + let w; + beforeEach(() => { + w = mountFor({ anonymous: false, restricted: false, editable: true }, { withMetadata: true }); + }); + + it("renders every metadata section and its content", () => { + expect(w.vm.canViewLibrary).toBe(true); + expect(w.vm.isEditable).toBe(true); + const html = w.html(); + for (const needle of [ + TEXT.title, + TEXT.caption, + "JPEG, 1920 x 1080, 4.2 MB", + "52.5200°N 13.4050°E", + TEXT.filename, + TEXT.camera, + TEXT.lens, + TEXT.placeName, + TEXT.peopleHeader, + TEXT.labelsHeader, + TEXT.albumsHeader, + TEXT.namedMarker, + TEXT.labelName, + TEXT.albumTitle, + TEXT.subject, + TEXT.artist, + TEXT.copyright, + TEXT.license, + TEXT.keywords, + TEXT.notes, + ]) { + expect(html).toContain(needle); + } + // Editable users see the merged file row with both the file + // info (title: type + dimensions + size) and the filename + // (subtitle: path). + const fileRow = w.find(".meta-file"); + expect(fileRow.exists()).toBe(true); + expect(fileRow.text()).toContain(TEXT.filename); + // Keywords/Notes are now part of the single-row icon-prepended + // detailsFields layout (no more text-subtitle-2 header rows). + // Confirm the rows render with their prepend icons and value + // content under the canonical .meta-{key} selector. + const keywordsRow = w.find(".meta-keywords"); + expect(keywordsRow.exists()).toBe(true); + expect(keywordsRow.text()).toContain(TEXT.keywords); + const notesRow = w.find(".meta-notes"); + expect(notesRow.exists()).toBe(true); + expect(notesRow.html()).toContain(TEXT.notes); + }); + + it("renders inline pencils and only the Edit Faces toggle (no eye toggle for editable users)", () => { + expect(w.findAll(".meta-inline-pencil").length).toBeGreaterThanOrEqual(10); + expect(w.find(".meta-faces-edit").exists()).toBe(true); + // Editable users see only the pencil toggle — edit mode is a + // strict superset of display mode for them. The pencil and the eye + // share `.meta-markers-toggle` (the visibility-toggle role); + // `.meta-faces-display` is the eye-only discriminator. + expect(w.find(".meta-faces-display").exists()).toBe(false); + }); + }); + + describe("restricted session (guest/visitor/contributor/share-link)", () => { + let w; + beforeEach(() => { + w = mountFor({ anonymous: false, restricted: true, editable: false }, { withMetadata: true }); + }); + + it("renders only the shared fields and hides every restricted section", () => { + expect(w.vm.canViewLibrary).toBe(false); + expect(w.vm.isEditable).toBe(false); + const html = w.html(); + // Allow-list. + expect(html).toContain(TEXT.title); + expect(html).toContain(TEXT.caption); + expect(html).toContain("JPEG, 1920 x 1080, 4.2 MB"); + expect(html).toContain("52.5200°N 13.4050°E"); + // The merged file row's title (type + dimensions + size) is + // shared with restricted sessions; the filename subtitle is + // gated behind `canViewLibrary` and must not appear here. + const fileRow = w.find(".meta-file"); + expect(fileRow.exists()).toBe(true); + // Deny-list. + expect(fileRow.text()).not.toContain(TEXT.filename); + for (const needle of [ + TEXT.filename, + TEXT.camera, + TEXT.lens, + TEXT.placeName, + TEXT.altitude, + TEXT.peopleHeader, + TEXT.labelsHeader, + TEXT.albumsHeader, + TEXT.namedMarker, + TEXT.labelName, + TEXT.albumTitle, + TEXT.subject, + TEXT.artist, + TEXT.copyright, + TEXT.license, + TEXT.keywords, + TEXT.notes, + ]) { + expect(html).not.toContain(needle); + } + }); + + it("exposes no edit affordances or face-marker controls", () => { + expect(w.find(".meta-inline-pencil").exists()).toBe(false); + expect(w.find(".meta-inline-edit").exists()).toBe(false); + expect(w.find(".meta-add-prompt").exists()).toBe(false); + expect(w.find(".meta-markers-toggle").exists()).toBe(false); + expect(w.find(".meta-faces-edit").exists()).toBe(false); + expect(w.find(".meta-marker-remove").exists()).toBe(false); + }); + }); + + describe("empty metadata", () => { + it("editable session still suppresses rows whose values are empty", () => { + const w = mountFor({ anonymous: false, restricted: false, editable: true }, { withMetadata: false }); + // Details is null for this fixture, which forces isEditable to + // be falsy even for an otherwise-editable session. + expect(w.vm.isEditable).toBeFalsy(); + const html = w.html(); + for (const needle of [TEXT.camera, TEXT.lens, TEXT.placeName, TEXT.peopleHeader, TEXT.labelsHeader]) { + expect(html).not.toContain(needle); + } + expect(w.find(".meta-inline-pencil").exists()).toBe(false); + }); + + it("restricted session renders the minimal shell only", () => { + const w = mountFor({ anonymous: false, restricted: true, editable: false }, { withMetadata: false }); + expect(w.vm.canViewLibrary).toBe(false); + expect(w.find(".meta-inline-pencil").exists()).toBe(false); + expect(w.find(".meta-markers-toggle").exists()).toBe(false); + }); + }); + + // Parent-driven editor (canEdit=true, Details present, library + // access granted, empty fields) must expose "add prompt" + // affordances so admins can populate metadata from scratch. + it("shows add-prompt affordances to admins editing an empty Details object", () => { + const w = mountSidebar({ + props: { + modelValue: buildModel({ withMetadata: false }), + photo: { + ...buildPhoto({ withMetadata: false }), + // A fresh, empty Details object is enough to unblock isEditable. + Details: { Keywords: "", Notes: "", Subject: "", Artist: "", Copyright: "", License: "" }, + }, + canEdit: true, + context: contexts.Photos, + }, + global: { + stubs: { PMap: true }, + mocks: { + $config: matrixConfig(false), + $session: { isAnonymous: () => false }, + }, + }, + }); + expect(w.vm.isEditable).toBe(true); + // Add-prompt spans are the "click to start editing" placeholders. + const prompts = w.findAll(".meta-add-prompt"); + expect(prompts.length).toBeGreaterThanOrEqual(5); + // Structural assertion for the merged details rows: each empty + // field renders exactly one add-prompt under its canonical + // .meta-{key} row. Avoids coupling to the exact label copy + // (which UX iterates on per field). + for (const key of ["subject", "copyright", "artist", "license", "keywords", "notes"]) { + const row = w.find(`.meta-${key}`); + expect(row.exists(), `missing .meta-${key} row`).toBe(true); + expect(row.find(".meta-add-prompt").exists(), `missing add-prompt in .meta-${key}`).toBe(true); + } + // Title and Caption rows don't carry a per-key class on the row + // itself (legacy hand-coded structure); fall back to label match + // for those, since "Add a Title" / "Add a Caption" are stable. + const texts = prompts.map((p) => p.text()); + expect(texts).toContain("Add a Title"); + expect(texts).toContain("Add a Caption"); + }); + + // Explicit share-link (anonymous) case: the sidebar must behave + // identically to any other library-access-denied session even + // though the backing User record is empty. The backend ships an + // ACL with no library-access grant for anonymous sessions, which + // is what matrixConfig(true) simulates here. + it("treats anonymous share-link sessions as library-denied even with canEdit=true", () => { + const w = mountSidebar({ + props: { + modelValue: buildModel({ withMetadata: true }), + photo: buildPhoto({ withMetadata: true }), + // Simulate a lightbox that forgot to flip canEdit off: the + // sidebar must still drop all edit affordances, driven by + // canViewLibrary alone. + canEdit: true, + context: contexts.Photos, + }, + global: { + stubs: { PMap: true }, + mocks: { + $config: matrixConfig(true), + $session: { isAnonymous: () => true }, + }, + }, + }); + expect(w.vm.canViewLibrary).toBe(false); + expect(w.vm.isEditable).toBe(false); + expect(w.find(".meta-inline-pencil").exists()).toBe(false); + expect(w.find(".meta-markers-toggle").exists()).toBe(false); + expect(w.find(".meta-faces-edit").exists()).toBe(false); + }); + + // featPeople = false must hide the People section even for an + // admin on a photo that has markers. + it("hides the People section when featPeople is disabled, regardless of role", () => { + const w = mountSidebar({ + props: { + modelValue: buildModel({ withMetadata: true }), + photo: buildPhoto({ withMetadata: true }), + canEdit: true, + context: contexts.Photos, + }, + global: { + stubs: { PMap: true }, + mocks: { + $config: { ...validationConfig, feature: (k) => k !== "people" }, + $session: { isAnonymous: () => false }, + }, + }, + }); + const html = w.html(); + expect(html).not.toContain(TEXT.peopleHeader); + expect(w.find(".meta-markers-toggle").exists()).toBe(false); + expect(w.find(".meta-faces-edit").exists()).toBe(false); + }); + }); + + // Pins the template bindings on , , + // and . Commit 7a611b6d6 removed the legacy `photo` + // prop on PLightboxSidebar and routed parent state through `$view.getData()` + // (exposed via the `photo` computed). The three dialog tags in the sidebar + // template kept referencing the now-undefined `photo` identifier, so the + // dialogs received `:photo="undefined"` / `:latlng="[0, 0]"` and their + // loadFromPhoto() hooks bailed out — opening every sidebar dialog with + // empty inputs even when the photo had values. These tests fail if the + // bindings ever regress to a name that does not exist on the component. + describe("dialog photo prop bindings", () => { + const dialogStubs = { + PMetaDatetimeDialog: { name: "PMetaDatetimeDialog", template: "
", props: ["visible", "photo"] }, + PMetaCameraDialog: { name: "PMetaCameraDialog", template: "
", props: ["visible", "photo"] }, + PMetaLocationDialog: { name: "PMetaLocationDialog", template: "
", props: ["visible", "latlng"] }, + }; + + function mountWithDialogStubs(photo) { + return mountSidebar({ + props: { modelValue: mockModel, photo, canEdit: true, context: contexts.Photos }, + global: { stubs: { PMap: true, ...dialogStubs } }, + }); + } + + it("passes the current photo to ", () => { + const w = mountWithDialogStubs(mockPhoto); + const dialog = w.findComponent({ name: "PMetaDatetimeDialog" }); + expect(dialog.exists()).toBe(true); + // Vue 3 wraps `view` (data()) in a reactive proxy, so the dialog + // sees a proxy of mockPhoto rather than the raw reference. A + // deep-equality check still pins the regression: the broken + // binding produced `undefined`, not a structurally-equal proxy. + expect(dialog.props("photo")).toEqual(mockPhoto); + }); + + it("passes the current photo to ", () => { + const w = mountWithDialogStubs(mockPhoto); + const dialog = w.findComponent({ name: "PMetaCameraDialog" }); + expect(dialog.exists()).toBe(true); + expect(dialog.props("photo")).toEqual(mockPhoto); + }); + + it("derives latlng from the current photo", () => { + const photo = { ...mockPhoto, Lat: 52.52, Lng: 13.405 }; + const w = mountWithDialogStubs(photo); + const dialog = w.findComponent({ name: "PMetaLocationDialog" }); + expect(dialog.exists()).toBe(true); + expect(dialog.props("latlng")).toEqual([52.52, 13.405]); + }); + + it("falls back to [0, 0] for when the photo has no coordinates", () => { + const w = mountWithDialogStubs(mockPhoto); + const dialog = w.findComponent({ name: "PMetaLocationDialog" }); + expect(dialog.exists()).toBe(true); + expect(dialog.props("latlng")).toEqual([0, 0]); + }); + }); +}); diff --git a/frontend/tests/vitest/component/lightbox/sidebar/toolbar.test.js b/frontend/tests/vitest/component/lightbox/sidebar/toolbar.test.js new file mode 100644 index 000000000..3b8feec76 --- /dev/null +++ b/frontend/tests/vitest/component/lightbox/sidebar/toolbar.test.js @@ -0,0 +1,63 @@ +import { describe, it, expect } from "vitest"; +import { mount } from "@vue/test-utils"; +import PLightboxSidebarToolbar from "component/lightbox/sidebar/toolbar.vue"; + +describe("PLightboxSidebarToolbar", () => { + // Default editing=false / canUndo=false: only the pencil renders. + it("renders the pencil icon when not editing", () => { + const w = mount(PLightboxSidebarToolbar); + expect(w.find(".meta-inline-pencil").exists()).toBe(true); + expect(w.find(".meta-inline-confirm").exists()).toBe(false); + expect(w.find(".meta-inline-undo").exists()).toBe(false); + }); + + // editing=true, canUndo=false: only the check icon renders (inline-text + // editor pattern — pencil ↔ check toggle, no undo). + it("renders the check icon when editing and canUndo is false", () => { + const w = mount(PLightboxSidebarToolbar, { props: { editing: true } }); + expect(w.find(".meta-inline-confirm").exists()).toBe(true); + expect(w.find(".meta-inline-pencil").exists()).toBe(false); + expect(w.find(".meta-inline-undo").exists()).toBe(false); + }); + + // editing=true, canUndo=true: chip-section toolbar pattern — undo icon + // renders alongside the check icon so users can revert pending removals. + it("renders both undo and check icons when editing and canUndo are true", () => { + const w = mount(PLightboxSidebarToolbar, { props: { editing: true, canUndo: true } }); + expect(w.find(".meta-inline-undo").exists()).toBe(true); + expect(w.find(".meta-inline-confirm").exists()).toBe(true); + expect(w.find(".meta-inline-pencil").exists()).toBe(false); + }); + + // canUndo only takes effect while editing — outside edit mode the pencil + // wins so we never show a bare Undo icon with no companion action. + it("suppresses the undo icon when canUndo is true but editing is false", () => { + const w = mount(PLightboxSidebarToolbar, { props: { editing: false, canUndo: true } }); + expect(w.find(".meta-inline-pencil").exists()).toBe(true); + expect(w.find(".meta-inline-undo").exists()).toBe(false); + expect(w.find(".meta-inline-confirm").exists()).toBe(false); + }); + + it("emits confirm when the check icon is clicked", async () => { + const w = mount(PLightboxSidebarToolbar, { props: { editing: true } }); + await w.find(".meta-inline-confirm").trigger("click"); + expect(w.emitted("confirm")).toBeTruthy(); + expect(w.emitted("confirm")).toHaveLength(1); + }); + + it("emits start when the pencil icon is clicked", async () => { + const w = mount(PLightboxSidebarToolbar); + await w.find(".meta-inline-pencil").trigger("click"); + expect(w.emitted("start")).toBeTruthy(); + expect(w.emitted("start")).toHaveLength(1); + }); + + it("emits undo when the undo icon is clicked", async () => { + const w = mount(PLightboxSidebarToolbar, { props: { editing: true, canUndo: true } }); + await w.find(".meta-inline-undo").trigger("click"); + expect(w.emitted("undo")).toBeTruthy(); + expect(w.emitted("undo")).toHaveLength(1); + // Clicking undo must NOT also fire confirm (event handlers carry .stop). + expect(w.emitted("confirm")).toBeFalsy(); + }); +}); diff --git a/frontend/tests/vitest/component/loading-bar.test.js b/frontend/tests/vitest/component/loading-bar.test.js index a4fdad8ee..481ed093b 100644 --- a/frontend/tests/vitest/component/loading-bar.test.js +++ b/frontend/tests/vitest/component/loading-bar.test.js @@ -13,7 +13,9 @@ vi.mock("component/loading-bar.vue", async (importOriginal) => { ...actual, queue: (fn) => { fn((next) => { - if (next) next(); + if (next) { + next(); + } }); }, }; diff --git a/frontend/tests/vitest/component/meta/camera/dialog.test.js b/frontend/tests/vitest/component/meta/camera/dialog.test.js new file mode 100644 index 000000000..b875cc508 --- /dev/null +++ b/frontend/tests/vitest/component/meta/camera/dialog.test.js @@ -0,0 +1,133 @@ +import { describe, it, expect, vi } from "vitest"; +import { mount } from "@vue/test-utils"; +import PMetaCameraDialog from "component/meta/camera/dialog.vue"; + +describe("PMetaCameraDialog component", () => { + const mockPhoto = { + CameraID: 5, + LensID: 3, + Iso: "200", + Exposure: "1/250", + FNumber: "2.8", + FocalLength: "50", + }; + + it("should load values from photo via loadFromPhoto", () => { + const w = mount(PMetaCameraDialog, { + props: { visible: false, photo: mockPhoto }, + }); + + expect(w.vm.cameraID).toBe(0); + + w.vm.loadFromPhoto(); + + expect(w.vm.cameraID).toBe(5); + expect(w.vm.lensID).toBe(3); + expect(w.vm.iso).toBe("200"); + expect(w.vm.exposure).toBe("1/250"); + expect(w.vm.fNumber).toBe("2.8"); + expect(w.vm.focalLength).toBe("50"); + }); + + it("should handle null photo gracefully", () => { + const w = mount(PMetaCameraDialog, { + props: { visible: false, photo: null }, + }); + + w.vm.loadFromPhoto(); + + expect(w.vm.cameraID).toBe(0); + expect(w.vm.lensID).toBe(0); + expect(w.vm.iso).toBe(""); + }); + + it("should emit close event", () => { + const onClose = vi.fn(); + const w = mount(PMetaCameraDialog, { + props: { visible: false, photo: mockPhoto, onClose }, + }); + w.vm.close(); + expect(onClose).toHaveBeenCalledOnce(); + }); + + it("should emit confirm with edited values", async () => { + const onConfirm = vi.fn(); + const w = mount(PMetaCameraDialog, { + props: { visible: false, photo: mockPhoto, onConfirm }, + }); + + w.vm.loadFromPhoto(); + + w.vm.cameraID = 10; + w.vm.lensID = 7; + w.vm.iso = "400"; + w.vm.exposure = "1/125"; + w.vm.fNumber = "1.4"; + w.vm.focalLength = "35"; + + await w.vm.confirm(); + + expect(onConfirm).toHaveBeenCalledOnce(); + expect(onConfirm).toHaveBeenCalledWith({ + CameraID: 10, + LensID: 7, + Iso: "400", + Exposure: "1/125", + FNumber: "1.4", + FocalLength: "35", + }); + }); + + // Regression: confirm() previously emitted the form values without + // running the v-form rules, so an out-of-range ISO/FNumber or an + // overlength Exposure bypassed the inline rules and reached the + // parent's save handler. The new $refs.form.validate() gate blocks + // the emit when any rule fails. + it("blocks confirm and notifies when form validation fails", async () => { + const onConfirm = vi.fn(); + const notifyError = vi.fn(); + const w = mount(PMetaCameraDialog, { + props: { visible: false, photo: mockPhoto, onConfirm }, + global: { mocks: { $notify: { error: notifyError } } }, + }); + + w.vm.loadFromPhoto(); + + // Inject a failing validate() onto the internal instance's $refs. + const validate = vi.fn().mockResolvedValue({ valid: false }); + w.vm.$.refs.form = { validate }; + + await w.vm.confirm(); + + expect(validate).toHaveBeenCalled(); + expect(onConfirm).not.toHaveBeenCalled(); + expect(notifyError).toHaveBeenCalledWith("Changes could not be saved"); + }); + + // Save button is :disabled="!valid"; flipping the v-form-backed + // `valid` flag toggles the button so the user gets a visual cue + // before clicking. Mirrors the datetime dialog's :disabled + // ="invalidDate" pattern. valid starts true so a freshly opened + // dialog on valid data doesn't flash disabled. + it("starts with valid=true so the Save button is enabled by default", () => { + const w = mount(PMetaCameraDialog, { + props: { visible: false, photo: mockPhoto }, + }); + + // The button is :disabled="!valid"; valid: true → button enabled. + expect(w.vm.valid).toBe(true); + }); + + it("should use defaults for missing photo fields", () => { + const w = mount(PMetaCameraDialog, { + props: { visible: false, photo: { CameraID: 2 } }, + }); + + w.vm.loadFromPhoto(); + + expect(w.vm.cameraID).toBe(2); + expect(w.vm.lensID).toBe(0); + expect(w.vm.iso).toBe(""); + expect(w.vm.exposure).toBe(""); + }); +}); diff --git a/frontend/tests/vitest/component/meta/datetime/dialog.test.js b/frontend/tests/vitest/component/meta/datetime/dialog.test.js new file mode 100644 index 000000000..40c17fd7a --- /dev/null +++ b/frontend/tests/vitest/component/meta/datetime/dialog.test.js @@ -0,0 +1,223 @@ +import { describe, it, expect, vi } from "vitest"; +import { mount } from "@vue/test-utils"; +import { DateTime } from "luxon"; +import PMetaDatetimeDialog from "component/meta/datetime/dialog.vue"; + +describe("PMetaDatetimeDialog component", () => { + function mockPhoto(overrides = {}) { + const base = { + Day: 15, + Month: 6, + Year: 2023, + TimeZone: "Europe/Berlin", + TakenAtLocal: "2023-06-15T14:30:00", + TakenAt: "2023-06-15T12:30:00Z", + getDateTime() { + return DateTime.fromISO(this.TakenAtLocal).toUTC(); + }, + timeIsUTC() { + return false; + }, + ...overrides, + }; + return base; + } + + it("should load values from photo via loadFromPhoto", () => { + const photo = mockPhoto(); + const w = mount(PMetaDatetimeDialog, { + props: { visible: false, photo }, + }); + + expect(w.vm.day).toBe(0); + expect(w.vm.year).toBe(0); + + w.vm.loadFromPhoto(); + + expect(w.vm.day).toBe(15); + expect(w.vm.month).toBe(6); + expect(w.vm.year).toBe(2023); + expect(w.vm.timeZone).toBe("Europe/Berlin"); + expect(w.vm.time).toBe("14:30:00"); + expect(w.vm.invalidDate).toBe(false); + }); + + it("should handle null photo gracefully", () => { + const w = mount(PMetaDatetimeDialog, { + props: { visible: false, photo: null }, + }); + + w.vm.loadFromPhoto(); + + expect(w.vm.day).toBe(0); + expect(w.vm.month).toBe(0); + expect(w.vm.year).toBe(0); + expect(w.vm.time).toBe(""); + }); + + it("should emit close event", () => { + const onClose = vi.fn(); + const w = mount(PMetaDatetimeDialog, { + props: { visible: false, photo: mockPhoto(), onClose }, + }); + + w.vm.close(); + expect(onClose).toHaveBeenCalledOnce(); + }); + + it("should emit confirm with edited values", () => { + const onConfirm = vi.fn(); + const w = mount(PMetaDatetimeDialog, { + props: { visible: false, photo: mockPhoto(), onConfirm }, + }); + + w.vm.loadFromPhoto(); + + w.vm.day = 20; + w.vm.month = 3; + w.vm.year = 2024; + w.vm.time = "09:15:00"; + w.vm.timeZone = "America/New_York"; + + w.vm.confirm(); + + expect(onConfirm).toHaveBeenCalledOnce(); + expect(onConfirm).toHaveBeenCalledWith({ + Day: 20, + Month: 3, + Year: 2024, + TimeZone: "America/New_York", + time: "09:15:00", + }); + }); + + it("should not emit confirm when date is invalid", () => { + const onConfirm = vi.fn(); + const w = mount(PMetaDatetimeDialog, { + props: { visible: false, photo: mockPhoto(), onConfirm }, + }); + + w.vm.loadFromPhoto(); + w.vm.invalidDate = true; + + w.vm.confirm(); + + expect(onConfirm).not.toHaveBeenCalled(); + }); + + // Regression: setTime() previously short-circuited on malformed input + // (skipping updateLocalDate), leaving invalidDate stale. Without this + // branch the Confirm button stayed enabled against bad time strings + // and the parent received "25:99:99" as the new time. + it("should mark the date invalid when the time field contains a malformed value", () => { + const onConfirm = vi.fn(); + const w = mount(PMetaDatetimeDialog, { + props: { visible: false, photo: mockPhoto(), onConfirm }, + }); + + w.vm.loadFromPhoto(); + expect(w.vm.invalidDate).toBe(false); + + // Malformed time → setTime flips invalidDate and bails before update. + w.vm.time = "25:99:99"; + w.vm.setTime(); + expect(w.vm.invalidDate).toBe(true); + + // confirm() then refuses to emit. + w.vm.confirm(); + expect(onConfirm).not.toHaveBeenCalled(); + + // Recovering to a valid time clears invalidDate via updateLocalDate. + w.vm.time = "09:15:00"; + w.vm.setTime(); + expect(w.vm.invalidDate).toBe(false); + }); + + it("should show UTC label when photo time is UTC", () => { + const photo = mockPhoto({ + timeIsUTC() { + return true; + }, + }); + const w = mount(PMetaDatetimeDialog, { + props: { visible: false, photo }, + }); + + expect(w.vm.timeLabel).toContain("UTC"); + }); + + it("should show Local Time label when photo time is not UTC", () => { + const w = mount(PMetaDatetimeDialog, { + props: { visible: false, photo: mockPhoto() }, + }); + + expect(w.vm.timeLabel).toContain("Local"); + }); + + it("should clamp day when month changes to shorter month", () => { + const photo = mockPhoto({ Day: 31, Month: 1, Year: 2023 }); + const w = mount(PMetaDatetimeDialog, { + props: { visible: false, photo }, + }); + + w.vm.loadFromPhoto(); + expect(w.vm.day).toBe(31); + + // February has 28 days in 2023 + w.vm.month = 2; + w.vm.clampDayToValidRange(); + expect(w.vm.day).toBe(28); + }); + + it("should handle leap year day clamping", () => { + const photo = mockPhoto({ Day: 31, Month: 1, Year: 2024 }); + const w = mount(PMetaDatetimeDialog, { + props: { visible: false, photo }, + }); + + w.vm.loadFromPhoto(); + + w.vm.month = 2; + w.vm.clampDayToValidRange(); + expect(w.vm.day).toBe(29); + }); + + it("should build correct local date strings", () => { + const w = mount(PMetaDatetimeDialog, { + props: { visible: false, photo: mockPhoto() }, + }); + + w.vm.loadFromPhoto(); + + expect(w.vm.localYearString()).toBe("2023"); + expect(w.vm.localMonthString()).toBe("06"); + expect(w.vm.localDayString()).toBe("15"); + }); + + it("should pad single-digit values in date strings", () => { + const photo = mockPhoto({ Day: 5, Month: 3, Year: 800 }); + const w = mount(PMetaDatetimeDialog, { + props: { visible: false, photo }, + }); + + w.vm.loadFromPhoto(); + + expect(w.vm.localYearString()).toBe("0800"); + expect(w.vm.localMonthString()).toBe("03"); + expect(w.vm.localDayString()).toBe("05"); + }); + + it("should use defaults for missing photo fields", () => { + const photo = mockPhoto({ Day: 0, Month: 0, Year: 2023, TimeZone: "" }); + const w = mount(PMetaDatetimeDialog, { + props: { visible: false, photo }, + }); + + w.vm.loadFromPhoto(); + + expect(w.vm.day).toBe(0); + expect(w.vm.month).toBe(0); + expect(w.vm.year).toBe(2023); + expect(w.vm.timeZone).toBe(""); + }); +}); diff --git a/frontend/tests/vitest/component/meta/face/markers.test.js b/frontend/tests/vitest/component/meta/face/markers.test.js new file mode 100644 index 000000000..c1efbd700 --- /dev/null +++ b/frontend/tests/vitest/component/meta/face/markers.test.js @@ -0,0 +1,1239 @@ +import { describe, it, expect, vi, beforeEach } from "vitest"; +import { mount, flushPromises } from "@vue/test-utils"; +import { nextTick } from "vue"; +import PMetaFaceMarkers from "component/meta/face/markers.vue"; +import { FaceMarkerDisplay, FaceMarkerEdit } from "options/face-marker"; + +// Stub image bounds on the page. +const IMAGE_RECT = { left: 100, top: 50, width: 400, height: 300, right: 500, bottom: 350 }; +const ROOT_RECT = { left: 0, top: 0, width: 800, height: 600, right: 800, bottom: 600 }; + +function createPswpStub() { + // Use a real so `instanceof HTMLImageElement` works. + const img = document.createElement("img"); + img.getBoundingClientRect = () => IMAGE_RECT; + const listeners = {}; + return { + img, + currSlide: { content: { element: img } }, + on: vi.fn((name, fn) => { + listeners[name] = fn; + }), + off: vi.fn((name) => { + delete listeners[name]; + }), + _listeners: listeners, + }; +} + +function mountOverlay(props = {}, listeners = {}) { + const pswp = createPswpStub(); + const wrapper = mount(PMetaFaceMarkers, { + props: { + markers: [], + pswp, + // Default to draw mode so the existing pointer-driven tests work + // unchanged. Display-mode tests pass `mode: FaceMarkerDisplay`. + mode: FaceMarkerEdit, + ...props, + // Forward listeners as props so `wrapper.emitted()` limitations + // don't matter — the component calls `this.$emit(name, ...)`, which + // Vue then dispatches to the `on` prop provided here. + onCreate: listeners.onCreate || (() => {}), + onCancel: listeners.onCancel || (() => {}), + onRemove: listeners.onRemove || (() => {}), + }, + attachTo: document.body, + }); + // Stub the root element bounding rect so toLocal math is predictable. + wrapper.vm.$refs.root.getBoundingClientRect = () => ROOT_RECT; + // Manually populate bounds (the real update path uses requestAnimationFrame). + wrapper.vm.updateBounds(); + return { wrapper, pswp }; +} + +describe("PMetaFaceMarkers", () => { + beforeEach(() => { + // Ensure rAF runs synchronously for predictable tests. + vi.stubGlobal("requestAnimationFrame", (cb) => { + cb(); + return 1; + }); + vi.stubGlobal("cancelAnimationFrame", () => {}); + }); + + it("mounts with image bounds derived from the PhotoSwipe slide", () => { + const { wrapper } = mountOverlay(); + expect(wrapper.vm.bounds).toEqual({ + left: IMAGE_RECT.left - ROOT_RECT.left, + top: IMAGE_RECT.top - ROOT_RECT.top, + width: IMAGE_RECT.width, + height: IMAGE_RECT.height, + }); + }); + + it("attaches and detaches PhotoSwipe event listeners", () => { + const { wrapper, pswp } = mountOverlay(); + expect(pswp.on).toHaveBeenCalledWith("zoomPanUpdate", expect.any(Function)); + expect(pswp.on).toHaveBeenCalledWith("change", expect.any(Function)); + expect(pswp.on).toHaveBeenCalledWith("resize", expect.any(Function)); + wrapper.unmount(); + expect(pswp.off).toHaveBeenCalledWith("zoomPanUpdate", expect.any(Function)); + expect(pswp.off).toHaveBeenCalledWith("change", expect.any(Function)); + expect(pswp.off).toHaveBeenCalledWith("resize", expect.any(Function)); + }); + + it("renders a square rect for each existing marker at the correct pixel size", async () => { + const markers = [ + { UID: "m1", Name: "Jane", X: 0.25, Y: 0.1, W: 0.2, H: 0.2 }, + { UID: "m2", Name: "", X: 0.6, Y: 0.5, W: 0.1, H: 0.1 }, + ]; + const { wrapper } = mountOverlay({ markers }); + await nextTick(); + await flushPromises(); + // SVG elements don't use class selectors reliably in Vue Test Utils, + // so look them up through the DOM. + const rects = wrapper.element.querySelectorAll("rect"); + // 2 marker rects; the draft rect only renders during drawing. + expect(rects.length).toBe(2); + expect(rects[0].getAttribute("x")).toBe(String(0.25 * IMAGE_RECT.width)); + expect(rects[0].getAttribute("y")).toBe(String(0.1 * IMAGE_RECT.height)); + expect(rects[0].getAttribute("width")).toBe(String(0.2 * IMAGE_RECT.width)); + expect(rects[0].getAttribute("height")).toBe(String(0.2 * IMAGE_RECT.height)); + }); + + it("renders a element for named markers (hover tooltip)", async () => { + const markers = [ + { UID: "m1", Name: "Jane Doe", X: 0.1, Y: 0.1, W: 0.2, H: 0.2 }, + { UID: "m2", Name: "", X: 0.5, Y: 0.5, W: 0.1, H: 0.1 }, + ]; + const { wrapper } = mountOverlay({ markers }); + await nextTick(); + await flushPromises(); + const rects = wrapper.element.querySelectorAll("rect"); + const namedTitle = rects[0].querySelector("title"); + const unnamedTitle = rects[1].querySelector("title"); + expect(namedTitle).not.toBeNull(); + expect(namedTitle.textContent).toBe("Jane Doe"); + expect(unnamedTitle).toBeNull(); + }); + + it("highlights named markers with the 'named' modifier", async () => { + const markers = [ + { UID: "m1", Name: "Jane", X: 0.1, Y: 0.1, W: 0.2, H: 0.2 }, + { UID: "m2", Name: "", X: 0.5, Y: 0.5, W: 0.1, H: 0.1 }, + ]; + const { wrapper } = mountOverlay({ markers }); + await nextTick(); + await flushPromises(); + const rects = wrapper.element.querySelectorAll("rect"); + expect(rects[0].classList.contains("p-meta-face-markers__rect--named")).toBe(true); + expect(rects[1].classList.contains("p-meta-face-markers__rect--named")).toBe(false); + }); + + it("commits a draft as pending on pointer up without emitting yet", () => { + const onCreate = vi.fn(); + const { wrapper } = mountOverlay({}, { onCreate }); + // Start the drag at (150, 100) viewport → image-local (50, 50). + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 1, + clientX: 150, + clientY: 100, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + expect(wrapper.vm.interaction).toBe("draw"); + + // Drag to (280, 180) viewport → image-local (180, 130). dx=130 dy=80 → side 130. + wrapper.vm.onPointerMove({ pointerId: 1, clientX: 280, clientY: 180 }); + expect(wrapper.vm.draft).toMatchObject({ x: 50, y: 50, w: 130, h: 130 }); + + wrapper.vm.onPointerUp({ pointerId: 1 }); + // Pointer up stores the draft as "pending"; no create event is emitted + // until the user clicks the overlay confirm button. + expect(onCreate).not.toHaveBeenCalled(); + expect(wrapper.vm.interaction).toBeNull(); + expect(wrapper.vm.draft).toBeNull(); + expect(wrapper.vm.pending).toMatchObject({ x: 50, y: 50, w: 130, h: 130 }); + }); + + it("emits a normalized square marker only after explicit confirmation", () => { + const onCreate = vi.fn(); + const { wrapper } = mountOverlay({}, { onCreate }); + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 10, + clientX: 150, + clientY: 100, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + wrapper.vm.onPointerMove({ pointerId: 10, clientX: 280, clientY: 180 }); + wrapper.vm.onPointerUp({ pointerId: 10 }); + + wrapper.vm.onConfirmPending(); + expect(onCreate).toHaveBeenCalledTimes(1); + const area = onCreate.mock.calls[0][0]; + expect(area.X).toBeCloseTo(50 / IMAGE_RECT.width, 6); + expect(area.Y).toBeCloseTo(50 / IMAGE_RECT.height, 6); + expect(area.W).toBeCloseTo(130 / IMAGE_RECT.width, 6); + expect(area.H).toBeCloseTo(130 / IMAGE_RECT.height, 6); + // The parent (lightbox) is responsible for clearing the pending draft + // via clearPending() after a successful save. The overlay itself must + // keep it visible so a failed save can be retried. + expect(wrapper.vm.pending).not.toBeNull(); + }); + + it("clears the pending draft when the parent calls clearPending (success path)", () => { + const onCreate = vi.fn(); + const { wrapper } = mountOverlay({}, { onCreate }); + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 40, + clientX: 150, + clientY: 100, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + wrapper.vm.onPointerMove({ pointerId: 40, clientX: 280, clientY: 180 }); + wrapper.vm.onPointerUp({ pointerId: 40 }); + wrapper.vm.onConfirmPending(); + expect(wrapper.vm.pending).not.toBeNull(); + + wrapper.vm.clearPending(); + expect(wrapper.vm.pending).toBeNull(); + }); + + it("keeps the pending draft visible after confirm so the user can retry on save failure", () => { + const onCreate = vi.fn(); + const { wrapper } = mountOverlay({}, { onCreate }); + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 41, + clientX: 150, + clientY: 100, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + wrapper.vm.onPointerMove({ pointerId: 41, clientX: 280, clientY: 180 }); + wrapper.vm.onPointerUp({ pointerId: 41 }); + wrapper.vm.onConfirmPending(); + + // Simulate the parent receiving a save failure: it never calls + // clearPending(), so the pending rect must remain on screen. + expect(onCreate).toHaveBeenCalledTimes(1); + expect(wrapper.vm.pending).not.toBeNull(); + expect(wrapper.vm.activeDraft).toBe(wrapper.vm.pending); + }); + + it("discards the pending draft without emitting on cancel", () => { + const onCreate = vi.fn(); + const { wrapper } = mountOverlay({}, { onCreate }); + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 11, + clientX: 150, + clientY: 100, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + wrapper.vm.onPointerMove({ pointerId: 11, clientX: 280, clientY: 180 }); + wrapper.vm.onPointerUp({ pointerId: 11 }); + expect(wrapper.vm.pending).not.toBeNull(); + + wrapper.vm.onCancelPending(); + expect(wrapper.vm.pending).toBeNull(); + expect(onCreate).not.toHaveBeenCalled(); + }); + + it("replaces an unconfirmed pending draft when the user starts a new drag outside it", () => { + const { wrapper } = mountOverlay(); + // Draw a pending rect at image-local (50, 50, 130, 130). + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 12, + clientX: 150, + clientY: 100, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + wrapper.vm.onPointerMove({ pointerId: 12, clientX: 280, clientY: 180 }); + wrapper.vm.onPointerUp({ pointerId: 12 }); + expect(wrapper.vm.pending).not.toBeNull(); + + // Pointerdown far outside the pending body/corners (local 300, 270), + // which must start a fresh draw and clear the previous pending. + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 13, + clientX: 400, + clientY: 320, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + expect(wrapper.vm.pending).toBeNull(); + expect(wrapper.vm.interaction).toBe("draw"); + }); + + it("discards a pending draft on Escape without exiting the mode", () => { + const onCancel = vi.fn(); + const { wrapper } = mountOverlay({}, { onCancel }); + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 14, + clientX: 150, + clientY: 100, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + wrapper.vm.onPointerMove({ pointerId: 14, clientX: 280, clientY: 180 }); + wrapper.vm.onPointerUp({ pointerId: 14 }); + expect(wrapper.vm.pending).not.toBeNull(); + + const consumed = wrapper.vm.handleEscape(); + expect(consumed).toBe(true); + expect(wrapper.vm.pending).toBeNull(); + expect(onCancel).not.toHaveBeenCalled(); + }); + + it("enforces squareness during drag (equal screen-pixel width and height)", () => { + const { wrapper } = mountOverlay(); + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 2, + clientX: 200, + clientY: 150, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + // dx=50, dy=20 → side=50 + wrapper.vm.onPointerMove({ pointerId: 2, clientX: 250, clientY: 170 }); + expect(wrapper.vm.draft.w).toBe(wrapper.vm.draft.h); + }); + + it("ignores drags smaller than the minimum draw size", () => { + const onCreate = vi.fn(); + const { wrapper } = mountOverlay({}, { onCreate }); + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 3, + clientX: 200, + clientY: 150, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + // Tiny move. + wrapper.vm.onPointerMove({ pointerId: 3, clientX: 205, clientY: 155 }); + wrapper.vm.onPointerUp({ pointerId: 3 }); + expect(onCreate).not.toHaveBeenCalled(); + }); + + it("ignores pointer downs outside the image bounds", () => { + const { wrapper } = mountOverlay(); + // clientX=10 → local.x = 10 - 0 - 100 = -90 (outside). + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 4, + clientX: 10, + clientY: 10, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + expect(wrapper.vm.interaction).toBeNull(); + }); + + it("ignores non-left mouse buttons", () => { + const { wrapper } = mountOverlay(); + wrapper.vm.onPointerDown({ + button: 2, + pointerId: 5, + clientX: 200, + clientY: 150, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + expect(wrapper.vm.interaction).toBeNull(); + }); + + it("cancels an in-progress drag on Escape", () => { + const onCreate = vi.fn(); + const { wrapper } = mountOverlay({}, { onCreate }); + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 6, + clientX: 200, + clientY: 150, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + wrapper.vm.onPointerMove({ pointerId: 6, clientX: 300, clientY: 250 }); + expect(wrapper.vm.interaction).toBe("draw"); + + const consumed = wrapper.vm.handleEscape(); + expect(consumed).toBe(true); + expect(wrapper.vm.interaction).toBeNull(); + expect(wrapper.vm.draft).toBeNull(); + expect(onCreate).not.toHaveBeenCalled(); + }); + + // handleEscape returns false when there is no in-flight interaction + // and no pending rect — the lightbox uses this signal to decide + // whether to exit draw mode or close the lightbox. + it("handleEscape returns false when there is nothing to cancel", () => { + const { wrapper } = mountOverlay(); + expect(wrapper.vm.handleEscape()).toBe(false); + }); + + // Letterbox math: when the <img> element's box dimensions don't match + // the image's natural aspect ratio (typical for video / Live / Animated + // slides where the JPG cover is CSS-stretched), updateBounds must inset + // by the letterbox / pillarbox bars so markers render against the + // inscribed image rect, not the full element box. + it("insets bounds for top/bottom letterboxing when image is wider than its box", () => { + const { wrapper, pswp } = mountOverlay(); + // Box is 400×300 (4:3); intrinsic image is 16:9 (e.g. 480×270). + // Inscribed image inside the box: width=400, height=400/(16/9)≈225, + // top offset = (300-225)/2 = 37.5. + pswp.img.getBoundingClientRect = () => ({ left: 100, top: 50, width: 400, height: 300, right: 500, bottom: 350 }); + Object.defineProperty(pswp.img, "naturalWidth", { value: 480, configurable: true }); + Object.defineProperty(pswp.img, "naturalHeight", { value: 270, configurable: true }); + wrapper.vm.updateBounds(); + const b = wrapper.vm.bounds; + expect(b.left).toBe(100); + expect(b.width).toBe(400); + expect(b.top).toBeCloseTo(50 + 37.5, 3); + expect(b.height).toBeCloseTo(225, 3); + }); + + it("insets bounds for left/right pillarboxing when image is taller than its box", () => { + const { wrapper, pswp } = mountOverlay(); + // Box is 400×300 (4:3); intrinsic image is 1:2 portrait (e.g. 200×400). + // Inscribed image inside the box: height=300, width=300*(1/2)=150, + // left offset = (400-150)/2 = 125. + pswp.img.getBoundingClientRect = () => ({ left: 100, top: 50, width: 400, height: 300, right: 500, bottom: 350 }); + Object.defineProperty(pswp.img, "naturalWidth", { value: 200, configurable: true }); + Object.defineProperty(pswp.img, "naturalHeight", { value: 400, configurable: true }); + wrapper.vm.updateBounds(); + const b = wrapper.vm.bounds; + expect(b.top).toBe(50); + expect(b.height).toBe(300); + expect(b.left).toBeCloseTo(100 + 125, 3); + expect(b.width).toBeCloseTo(150, 3); + }); + + it("returns the element box unchanged when natural ratio already matches", () => { + const { wrapper, pswp } = mountOverlay(); + pswp.img.getBoundingClientRect = () => ({ left: 100, top: 50, width: 400, height: 300, right: 500, bottom: 350 }); + Object.defineProperty(pswp.img, "naturalWidth", { value: 800, configurable: true }); + Object.defineProperty(pswp.img, "naturalHeight", { value: 600, configurable: true }); + wrapper.vm.updateBounds(); + expect(wrapper.vm.bounds).toEqual({ left: 100, top: 50, width: 400, height: 300 }); + }); + + it("falls back to the element box when natural dimensions are missing", () => { + const { wrapper, pswp } = mountOverlay(); + pswp.img.getBoundingClientRect = () => ({ left: 100, top: 50, width: 400, height: 300, right: 500, bottom: 350 }); + // naturalWidth/Height default to 0 on freshly created <img>; no setter needed. + wrapper.vm.updateBounds(); + expect(wrapper.vm.bounds).toEqual({ left: 100, top: 50, width: 400, height: 300 }); + }); + + it("clamps the drawn square inside the image bounds", () => { + const { wrapper } = mountOverlay(); + // Start near bottom-right (client 480, 340 → local 380, 290). + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 7, + clientX: 480, + clientY: 340, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + // Drag far past bottom-right. + wrapper.vm.onPointerMove({ pointerId: 7, clientX: 700, clientY: 500 }); + const draft = wrapper.vm.draft; + expect(draft.x + draft.w).toBeLessThanOrEqual(IMAGE_RECT.width + 0.0001); + expect(draft.y + draft.h).toBeLessThanOrEqual(IMAGE_RECT.height + 0.0001); + expect(draft.w).toBe(draft.h); + }); + + // Display mode — the overlay renders existing markers but does not + // capture the pointer, so PhotoSwipe pan/zoom keeps working. + it("does not start drafting on pointer down in display mode", () => { + const onCreate = vi.fn(); + const { wrapper } = mountOverlay({ mode: FaceMarkerDisplay }, { onCreate }); + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 1, + clientX: 200, + clientY: 150, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + expect(wrapper.vm.interaction).toBeNull(); + expect(wrapper.vm.draft).toBeNull(); + expect(onCreate).not.toHaveBeenCalled(); + }); + + it("renders existing markers in display mode", async () => { + const markers = [{ UID: "m1", Name: "Jane", X: 0.1, Y: 0.1, W: 0.2, H: 0.2 }]; + const { wrapper } = mountOverlay({ mode: FaceMarkerDisplay, markers }); + await nextTick(); + await flushPromises(); + const rects = wrapper.element.querySelectorAll("rect"); + expect(rects.length).toBe(1); + }); + + it("renders a visible name label below each named marker in display mode", async () => { + const markers = [ + { UID: "m1", Name: "Jane", X: 0.1, Y: 0.1, W: 0.2, H: 0.2 }, + { UID: "m2", Name: "", X: 0.5, Y: 0.5, W: 0.1, H: 0.1 }, + ]; + const { wrapper } = mountOverlay({ mode: FaceMarkerDisplay, markers }); + await nextTick(); + await flushPromises(); + const labels = wrapper.element.querySelectorAll("text.p-meta-face-markers__label"); + expect(labels.length).toBe(1); + expect(labels[0].textContent).toBe("Jane"); + // Label is positioned below the rect (y > rect's y + height). + const labelY = parseFloat(labels[0].getAttribute("y")); + const rectBottom = (0.1 + 0.2) * IMAGE_RECT.height; + expect(labelY).toBeGreaterThan(rectBottom); + }); + + it("also renders visible name labels in draw / edit mode", async () => { + // Names stay visible during edit mode so the user can distinguish + // named markers (untouchable via overlay-click) from unnamed ones + // (clickable for removal). Previously hidden in draw mode for + // visual quiet; the trade-off flipped once click-to-remove arrived. + const markers = [{ UID: "m1", Name: "Jane", X: 0.1, Y: 0.1, W: 0.2, H: 0.2 }]; + const { wrapper } = mountOverlay({ mode: FaceMarkerEdit, markers }); + await nextTick(); + await flushPromises(); + const labels = wrapper.element.querySelectorAll("text.p-meta-face-markers__label"); + expect(labels.length).toBe(1); + expect(labels[0].textContent).toBe("Jane"); + }); + + it("discards an active draft when the mode changes from draw to display", async () => { + const { wrapper } = mountOverlay(); + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 21, + clientX: 150, + clientY: 100, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + wrapper.vm.onPointerMove({ pointerId: 21, clientX: 280, clientY: 180 }); + wrapper.vm.onPointerUp({ pointerId: 21 }); + expect(wrapper.vm.pending).not.toBeNull(); + + await wrapper.setProps({ mode: FaceMarkerDisplay }); + expect(wrapper.vm.pending).toBeNull(); + expect(wrapper.vm.draft).toBeNull(); + expect(wrapper.vm.interaction).toBeNull(); + }); + + it("does not emit create from confirm when busy is true", () => { + const onCreate = vi.fn(); + const { wrapper } = mountOverlay({ busy: true }, { onCreate }); + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 31, + clientX: 150, + clientY: 100, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + wrapper.vm.onPointerMove({ pointerId: 31, clientX: 280, clientY: 180 }); + wrapper.vm.onPointerUp({ pointerId: 31 }); + wrapper.vm.onConfirmPending(); + expect(onCreate).not.toHaveBeenCalled(); + // Pending stays put so the user can retry once the request settles. + expect(wrapper.vm.pending).not.toBeNull(); + }); + + // ------------------------------------------------------------------ + // Pending reposition (body drag) and corner resize. + // The feature brief Add UC Main Scenario Step 4 requires: "the user + // repositions the marker by dragging its body and resizes it by + // dragging its corners; the marker MUST remain square at all times". + // ------------------------------------------------------------------ + + // Small helper to drop a pending rect at a known image-local position. + // Returns `{ wrapper, pending }` where pending is { x, y, w, h }. + function drawPending(extraProps = {}) { + const { wrapper } = mountOverlay(extraProps); + // client (150, 100) → local (50, 50) start; client (280, 180) → local (180, 130), dx=130 dy=80 → side 130. + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 100, + clientX: 150, + clientY: 100, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + wrapper.vm.onPointerMove({ pointerId: 100, clientX: 280, clientY: 180 }); + wrapper.vm.onPointerUp({ pointerId: 100 }); + return { wrapper, pending: { ...wrapper.vm.pending } }; + } + + it("repositions the pending rect by dragging its body (size unchanged)", () => { + const { wrapper, pending } = drawPending(); + // Start a move from inside the pending body (local ~100, 100 → client 200, 150). + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 101, + clientX: 200, + clientY: 150, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + expect(wrapper.vm.interaction).toBe("move"); + // Drag +30 in both axes → client (230, 180). + wrapper.vm.onPointerMove({ pointerId: 101, clientX: 230, clientY: 180 }); + wrapper.vm.onPointerUp({ pointerId: 101 }); + + expect(wrapper.vm.pending.x).toBeCloseTo(pending.x + 30, 6); + expect(wrapper.vm.pending.y).toBeCloseTo(pending.y + 30, 6); + expect(wrapper.vm.pending.w).toBe(pending.w); + expect(wrapper.vm.pending.h).toBe(pending.h); + expect(wrapper.vm.interaction).toBeNull(); + }); + + it("clamps a body-drag inside the image bounds and preserves size", () => { + const { wrapper, pending } = drawPending(); + // Grab the body and drag far past the bottom-right. + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 102, + clientX: 200, + clientY: 150, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + wrapper.vm.onPointerMove({ pointerId: 102, clientX: 900, clientY: 900 }); + wrapper.vm.onPointerUp({ pointerId: 102 }); + + // Width/height unchanged, rect fully inside image bounds. + expect(wrapper.vm.pending.w).toBe(pending.w); + expect(wrapper.vm.pending.h).toBe(pending.h); + expect(wrapper.vm.pending.x + wrapper.vm.pending.w).toBeLessThanOrEqual(IMAGE_RECT.width + 0.0001); + expect(wrapper.vm.pending.y + wrapper.vm.pending.h).toBeLessThanOrEqual(IMAGE_RECT.height + 0.0001); + expect(wrapper.vm.pending.x).toBe(IMAGE_RECT.width - pending.w); + expect(wrapper.vm.pending.y).toBe(IMAGE_RECT.height - pending.h); + }); + + it("resizes from the br corner with the tl corner as a fixed anchor and stays square", () => { + const { wrapper, pending } = drawPending(); + // br corner is at image-local (180, 180) → client (280, 230). + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 103, + clientX: 280, + clientY: 230, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + expect(wrapper.vm.interaction).toBe("resize"); + expect(wrapper.vm.resizeCorner).toBe("br"); + // Drag br outward to client (350, 300) → local (250, 250). Anchor tl is at (50, 50), + // so dx = 200, dy = 200 → side = 200 → new rect (50, 50, 200, 200). + wrapper.vm.onPointerMove({ pointerId: 103, clientX: 350, clientY: 300 }); + wrapper.vm.onPointerUp({ pointerId: 103 }); + + expect(wrapper.vm.pending.x).toBeCloseTo(pending.x, 6); + expect(wrapper.vm.pending.y).toBeCloseTo(pending.y, 6); + expect(wrapper.vm.pending.w).toBe(wrapper.vm.pending.h); + expect(wrapper.vm.pending.w).toBeCloseTo(200, 6); + }); + + it("resizes from the tl corner with the br corner as a fixed anchor", () => { + const { wrapper, pending } = drawPending(); + // tl corner is at image-local (50, 50) → client (150, 100). Drag inward to shrink. + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 104, + clientX: 150, + clientY: 100, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + expect(wrapper.vm.interaction).toBe("resize"); + expect(wrapper.vm.resizeCorner).toBe("tl"); + // Move tl to local (120, 120) → client (220, 170). Anchor is br at local (180, 180). + // dx = 120 - 180 = -60, dy = 120 - 180 = -60 → side 60. + // Result: x = 180 - 60 = 120, y = 180 - 60 = 120, w = h = 60. + wrapper.vm.onPointerMove({ pointerId: 104, clientX: 220, clientY: 170 }); + wrapper.vm.onPointerUp({ pointerId: 104 }); + + // br corner stays fixed. + expect(wrapper.vm.pending.x + wrapper.vm.pending.w).toBeCloseTo(pending.x + pending.w, 6); + expect(wrapper.vm.pending.y + wrapper.vm.pending.h).toBeCloseTo(pending.y + pending.h, 6); + expect(wrapper.vm.pending.w).toBe(wrapper.vm.pending.h); + expect(wrapper.vm.pending.w).toBeCloseTo(60, 6); + }); + + it("prioritizes a corner hit over body move when the pointer lands near a corner", () => { + const { wrapper } = drawPending(); + // tr corner is at local (180, 50) → client (280, 100). Click 4 px inside the body + // (client 277, 103 → local 177, 53) — still within the 14 px hit radius of tr. + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 105, + clientX: 277, + clientY: 103, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + expect(wrapper.vm.interaction).toBe("resize"); + expect(wrapper.vm.resizeCorner).toBe("tr"); + }); + + it("reverts pending to the pre-interaction snapshot when Escape is pressed during a resize", () => { + const { wrapper, pending } = drawPending(); + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 106, + clientX: 280, + clientY: 230, // br corner + stopPropagation: () => {}, + preventDefault: () => {}, + }); + wrapper.vm.onPointerMove({ pointerId: 106, clientX: 360, clientY: 260 }); + // Pending was mutated mid-resize. + expect(wrapper.vm.pending.w).not.toBe(pending.w); + + wrapper.vm.handleEscape(); + + expect(wrapper.vm.pending).toEqual(pending); + expect(wrapper.vm.interaction).toBeNull(); + expect(wrapper.vm.resizeCorner).toBeNull(); + }); + + it("reverts pending when Escape is pressed during a body move", () => { + const { wrapper, pending } = drawPending(); + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 107, + clientX: 200, + clientY: 150, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + wrapper.vm.onPointerMove({ pointerId: 107, clientX: 260, clientY: 200 }); + expect(wrapper.vm.pending.x).not.toBe(pending.x); + + wrapper.vm.handleEscape(); + + expect(wrapper.vm.pending).toEqual(pending); + expect(wrapper.vm.interaction).toBeNull(); + }); + + it("hides the confirm buttons during an active manipulation and shows them after", async () => { + const { wrapper } = drawPending(); + await nextTick(); + // Before the drag, confirm group is rendered. + expect(wrapper.element.querySelector(".p-meta-face-markers__confirm")).not.toBeNull(); + + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 108, + clientX: 200, + clientY: 150, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + await nextTick(); + // During the move, the confirm group is hidden. + expect(wrapper.element.querySelector(".p-meta-face-markers__confirm")).toBeNull(); + + wrapper.vm.onPointerMove({ pointerId: 108, clientX: 220, clientY: 170 }); + wrapper.vm.onPointerUp({ pointerId: 108 }); + await nextTick(); + // After release the confirm group is back. + expect(wrapper.element.querySelector(".p-meta-face-markers__confirm")).not.toBeNull(); + }); + + it("enforces the minimum square side during a corner resize", () => { + const { wrapper, pending } = drawPending(); + // Grab the br corner and collapse it back toward the tl anchor past zero. + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 109, + clientX: 280, // br corner + clientY: 230, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + wrapper.vm.onPointerMove({ pointerId: 109, clientX: 140, clientY: 90 }); // local (40, 40) — past anchor + wrapper.vm.onPointerUp({ pointerId: 109 }); + + // The square must not collapse below MIN_DRAW_SIZE (16). Anchor was tl at (50, 50). + expect(wrapper.vm.pending.w).toBe(wrapper.vm.pending.h); + expect(wrapper.vm.pending.w).toBeGreaterThanOrEqual(16); + // The anchored tl corner should still sit at (50, 50). + expect(pending.x).toBe(50); + expect(pending.y).toBe(50); + }); + + // Role gating — a full pointer cycle in display mode must never emit + // `create`, and the draft confirm/cancel buttons must not be mounted. + // The complementary display-mode rendering and single-event tests + // live above (lines 404 and 420). + it("is inert for the full pointer cycle in display mode", async () => { + const onCreate = vi.fn(); + const markers = [{ UID: "m1", Name: "Jane", X: 0.1, Y: 0.1, W: 0.2, H: 0.2 }]; + const { wrapper } = mountOverlay({ mode: FaceMarkerDisplay, markers }, { onCreate }); + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 2, + clientX: 200, + clientY: 150, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + wrapper.vm.onPointerMove({ pointerId: 2, clientX: 360, clientY: 260 }); + wrapper.vm.onPointerUp({ pointerId: 2 }); + expect(wrapper.vm.pending).toBeNull(); + expect(wrapper.vm.draft).toBeNull(); + expect(wrapper.vm.interaction).toBeNull(); + expect(onCreate).not.toHaveBeenCalled(); + await nextTick(); + await flushPromises(); + expect(wrapper.element.querySelector("button.p-meta-face-markers__btn--confirm")).toBeNull(); + expect(wrapper.element.querySelector("button.p-meta-face-markers__btn--cancel")).toBeNull(); + }); + + // The Back button is the user-facing exit for face-marker mode while + // the toolbar chrome is hidden by .face-marker-mode CSS. It must be + // present whenever the overlay is mounted (display + draw) and emit + // `cancel` so the lightbox routes through exitFaceMarkerMode. + it("renders the Back button in display mode and emits cancel on click", async () => { + const onCancel = vi.fn(); + const { wrapper } = mountOverlay({ mode: FaceMarkerDisplay, markers: [] }, { onCancel }); + const btn = wrapper.element.querySelector("button.p-meta-face-markers__btn--back"); + expect(btn).not.toBeNull(); + btn.click(); + await nextTick(); + expect(onCancel).toHaveBeenCalledTimes(1); + }); + + it("renders the Back button in draw mode and emits cancel + clears any pending draft on click", async () => { + const onCancel = vi.fn(); + const { wrapper } = mountOverlay({ mode: FaceMarkerEdit, markers: [] }, { onCancel }); + // Stage a pending draft so we can confirm the back click also clears it. + wrapper.vm.pending = { x: 10, y: 10, w: 50, h: 50 }; + await nextTick(); + const btn = wrapper.element.querySelector("button.p-meta-face-markers__btn--back"); + expect(btn).not.toBeNull(); + btn.click(); + await nextTick(); + expect(onCancel).toHaveBeenCalledTimes(1); + expect(wrapper.vm.pending).toBeNull(); + expect(wrapper.vm.draft).toBeNull(); + }); + + // Click-to-remove flow: in edit mode, clicking an unnamed marker rect + // opens an inline confirm pill. ✓ emits `remove` with the marker; ✕ + // dismisses without mutation. Named markers (m.SubjUID truthy) are + // not removable via this path — the backend gate (marker.reject only + // accepts unnamed markers) is mirrored in the overlay's hit-test. + describe("edit-mode click-to-remove", () => { + const unnamed = { UID: "m2", Name: "", X: 0.2, Y: 0.2, W: 0.2, H: 0.2 }; + const named = { UID: "m1", Name: "Jane", SubjUID: "subj1", X: 0.6, Y: 0.6, W: 0.2, H: 0.2 }; + + function clickAt(wrapper, normX, normY) { + // Convert normalized marker coords (0..1 within the image) back to + // client coords on the stubbed image rect. Click the centre of + // the rect at (normX, normY). + const clientX = IMAGE_RECT.left + normX * IMAGE_RECT.width; + const clientY = IMAGE_RECT.top + normY * IMAGE_RECT.height; + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 99, + clientX, + clientY, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + } + + it("clicking an unnamed marker rect sets removingMarker and skips draft start", () => { + const { wrapper } = mountOverlay({ mode: FaceMarkerEdit, markers: [unnamed] }); + clickAt(wrapper, unnamed.X + unnamed.W / 2, unnamed.Y + unnamed.H / 2); + expect(wrapper.vm.removingMarker?.UID).toBe(unnamed.UID); + expect(wrapper.vm.interaction).toBeNull(); + expect(wrapper.vm.draft).toBeNull(); + }); + + it("renders an inline confirm pill anchored to the targeted marker", async () => { + const { wrapper } = mountOverlay({ mode: FaceMarkerEdit, markers: [unnamed] }); + clickAt(wrapper, unnamed.X + unnamed.W / 2, unnamed.Y + unnamed.H / 2); + await nextTick(); + const pill = wrapper.element.querySelector(".p-meta-face-markers__remove-confirm"); + expect(pill).not.toBeNull(); + expect(pill.querySelector("button.p-meta-face-markers__btn--remove")).not.toBeNull(); + }); + + it("highlights the targeted rect with the --removing modifier class", async () => { + const { wrapper } = mountOverlay({ mode: FaceMarkerEdit, markers: [unnamed] }); + clickAt(wrapper, unnamed.X + unnamed.W / 2, unnamed.Y + unnamed.H / 2); + await nextTick(); + const rects = wrapper.element.querySelectorAll("rect.p-meta-face-markers__rect"); + expect(rects[0].classList.contains("p-meta-face-markers__rect--removing")).toBe(true); + }); + + it("✓ click emits remove with the marker and clears removingMarker", async () => { + const onRemove = vi.fn(); + const { wrapper } = mountOverlay({ mode: FaceMarkerEdit, markers: [unnamed] }, { onRemove }); + clickAt(wrapper, unnamed.X + unnamed.W / 2, unnamed.Y + unnamed.H / 2); + await nextTick(); + wrapper.element.querySelector("button.p-meta-face-markers__btn--remove").click(); + await nextTick(); + expect(onRemove).toHaveBeenCalledTimes(1); + expect(onRemove.mock.calls[0][0]?.UID).toBe(unnamed.UID); + expect(wrapper.vm.removingMarker).toBeNull(); + }); + + it("✕ click in the remove pill clears removingMarker without emitting", async () => { + const onRemove = vi.fn(); + const { wrapper } = mountOverlay({ mode: FaceMarkerEdit, markers: [unnamed] }, { onRemove }); + clickAt(wrapper, unnamed.X + unnamed.W / 2, unnamed.Y + unnamed.H / 2); + await nextTick(); + wrapper.element.querySelector("button.p-meta-face-markers__btn--cancel").click(); + await nextTick(); + expect(onRemove).not.toHaveBeenCalled(); + expect(wrapper.vm.removingMarker).toBeNull(); + }); + + it("named markers are not removable via this path — hit-test skips them", () => { + const onRemove = vi.fn(); + const { wrapper } = mountOverlay({ mode: FaceMarkerEdit, markers: [named] }, { onRemove }); + clickAt(wrapper, named.X + named.W / 2, named.Y + named.H / 2); + expect(wrapper.vm.removingMarker).toBeNull(); + // The click falls through to the draft-start path because no + // unnamed marker was hit at that location. + expect(wrapper.vm.interaction).not.toBeNull(); + }); + + it("clicking empty space cancels any pending remove pill", () => { + const { wrapper } = mountOverlay({ mode: FaceMarkerEdit, markers: [unnamed] }); + clickAt(wrapper, unnamed.X + unnamed.W / 2, unnamed.Y + unnamed.H / 2); + expect(wrapper.vm.removingMarker?.UID).toBe(unnamed.UID); + clickAt(wrapper, 0.95, 0.95); + expect(wrapper.vm.removingMarker).toBeNull(); + }); + + it("display mode ignores marker clicks (overlay is read-only)", () => { + const { wrapper } = mountOverlay({ mode: FaceMarkerDisplay, markers: [unnamed] }); + clickAt(wrapper, unnamed.X + unnamed.W / 2, unnamed.Y + unnamed.H / 2); + expect(wrapper.vm.removingMarker).toBeNull(); + }); + + it("handleEscape clears a pending remove first", () => { + const { wrapper } = mountOverlay({ mode: FaceMarkerEdit, markers: [unnamed] }); + clickAt(wrapper, unnamed.X + unnamed.W / 2, unnamed.Y + unnamed.H / 2); + expect(wrapper.vm.removingMarker?.UID).toBe(unnamed.UID); + const consumed = wrapper.vm.handleEscape(); + expect(consumed).toBe(true); + expect(wrapper.vm.removingMarker).toBeNull(); + }); + + it("leaving draw mode clears a pending remove", async () => { + const { wrapper } = mountOverlay({ mode: FaceMarkerEdit, markers: [unnamed] }); + clickAt(wrapper, unnamed.X + unnamed.W / 2, unnamed.Y + unnamed.H / 2); + expect(wrapper.vm.removingMarker?.UID).toBe(unnamed.UID); + await wrapper.setProps({ mode: FaceMarkerDisplay }); + expect(wrapper.vm.removingMarker).toBeNull(); + }); + }); + + // The hover and pointer-down hit-tests reuse the `markerRects` computed + // instead of recomputing every marker's pixel rect per pointer event. + describe("performance — precomputed marker hit-testing", () => { + const unnamed = { UID: "u1", Name: "", X: 0.2, Y: 0.2, W: 0.2, H: 0.2 }; + const named = { UID: "n1", Name: "Jane", SubjUID: "subj1", X: 0.6, Y: 0.6, W: 0.2, H: 0.2 }; + + it("markerRects precomputes pixel rects for unnamed markers only", () => { + const { wrapper } = mountOverlay({ mode: FaceMarkerEdit, markers: [unnamed, named] }); + const rects = wrapper.vm.markerRects; + expect(rects).toHaveLength(1); + expect(rects[0].marker.UID).toBe("u1"); + expect(rects[0]).toMatchObject({ + x: unnamed.X * IMAGE_RECT.width, + y: unnamed.Y * IMAGE_RECT.height, + w: unnamed.W * IMAGE_RECT.width, + h: unnamed.H * IMAGE_RECT.height, + }); + }); + + it("findMarkerAt returns the unnamed marker inside its rect and null elsewhere", () => { + const { wrapper } = mountOverlay({ mode: FaceMarkerEdit, markers: [unnamed, named] }); + const inside = { + x: (unnamed.X + unnamed.W / 2) * IMAGE_RECT.width, + y: (unnamed.Y + unnamed.H / 2) * IMAGE_RECT.height, + }; + expect(wrapper.vm.findMarkerAt(inside)?.UID).toBe("u1"); + // Named markers are skipped — they are not removable via the overlay. + const namedCentre = { + x: (named.X + named.W / 2) * IMAGE_RECT.width, + y: (named.Y + named.H / 2) * IMAGE_RECT.height, + }; + expect(wrapper.vm.findMarkerAt(namedCentre)).toBeNull(); + expect(wrapper.vm.findMarkerAt({ x: IMAGE_RECT.width - 1, y: IMAGE_RECT.height - 1 })).toBeNull(); + }); + + it("markerRects is empty and findMarkerAt null when bounds are unavailable", () => { + const { wrapper } = mountOverlay({ mode: FaceMarkerEdit, markers: [unnamed] }); + wrapper.vm.bounds = null; + expect(wrapper.vm.markerRects).toEqual([]); + expect(wrapper.vm.findMarkerAt({ x: 10, y: 10 })).toBeNull(); + }); + }); + + // Pointer-move draft/pending writes are coalesced through requestAnimationFrame + // so multiple moves per frame collapse into a single SVG re-render; pointer up + // flushes synchronously so the committed rect reflects the final position. + describe("performance — drag coalescing through requestAnimationFrame", () => { + function stubDeferredRaf() { + const frames = []; + vi.stubGlobal("requestAnimationFrame", (cb) => { + frames.push(cb); + return frames.length; + }); + vi.stubGlobal("cancelAnimationFrame", (id) => { + if (id >= 1 && id <= frames.length) { + frames[id - 1] = null; + } + }); + return frames; + } + function startDraw(wrapper, pointerId) { + wrapper.vm.onPointerDown({ + button: 0, + pointerId, + clientX: 150, + clientY: 100, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + } + + it("defers draft writes to the next frame, applying only the latest queued rect", () => { + const frames = stubDeferredRaf(); + const { wrapper } = mountOverlay(); + startDraw(wrapper, 1); + // pointerdown seeds a zero-size draft synchronously. + expect(wrapper.vm.draft).toMatchObject({ x: 50, y: 50, w: 0, h: 0 }); + // Two moves in the same frame both queue without touching reactive draft. + wrapper.vm.onPointerMove({ pointerId: 1, clientX: 280, clientY: 180 }); + wrapper.vm.onPointerMove({ pointerId: 1, clientX: 250, clientY: 150 }); + expect(wrapper.vm.draft).toMatchObject({ w: 0, h: 0 }); + // Running the scheduled frames applies only the latest queued rect. + frames.forEach((cb) => cb && cb()); + expect(wrapper.vm.draft).toMatchObject({ x: 50, y: 50, w: 100, h: 100 }); + }); + + it("flushes the queued rect on pointer up and promotes it to pending", () => { + stubDeferredRaf(); + const { wrapper } = mountOverlay(); + startDraw(wrapper, 2); + wrapper.vm.onPointerMove({ pointerId: 2, clientX: 280, clientY: 180 }); + // Still the seeded draft — the move is queued, not yet applied. + expect(wrapper.vm.draft).toMatchObject({ w: 0, h: 0 }); + wrapper.vm.onPointerUp({ pointerId: 2 }); + expect(wrapper.vm.draft).toBeNull(); + expect(wrapper.vm.pending).toMatchObject({ x: 50, y: 50, w: 130, h: 130 }); + }); + + it("escape during draw cancels the queued frame so the draft stays cleared", () => { + const frames = stubDeferredRaf(); + const { wrapper } = mountOverlay(); + startDraw(wrapper, 3); + wrapper.vm.onPointerMove({ pointerId: 3, clientX: 280, clientY: 180 }); + expect(wrapper.vm.handleEscape()).toBe(true); + expect(wrapper.vm.draft).toBeNull(); + // A leftover frame must not resurrect the cancelled draft. + frames.forEach((cb) => cb && cb()); + expect(wrapper.vm.draft).toBeNull(); + }); + }); + + // The overlay-root rect is cached across pinch-zoom frames (where only the + // image transform changes) and re-read on layout-changing events. + describe("performance — overlay-root rect caching", () => { + it("reads the root rect once, reuses it, and re-reads after invalidation", () => { + const { wrapper } = mountOverlay(); + const spy = vi.fn(() => ROOT_RECT); + wrapper.vm.$refs.root.getBoundingClientRect = spy; + // Prime the cache with a single read. + wrapper.vm._parentRectFresh = false; + wrapper.vm.updateBounds(); + expect(spy).toHaveBeenCalledTimes(1); + // Further recomputes reuse the cache — no extra layout reads. + wrapper.vm.updateBounds(); + wrapper.vm.updateBounds(); + expect(spy).toHaveBeenCalledTimes(1); + // Invalidation forces one fresh read. + wrapper.vm._parentRectFresh = false; + wrapper.vm.updateBounds(); + expect(spy).toHaveBeenCalledTimes(2); + }); + + it("zoomPanUpdate keeps the cache; resize/change invalidate it", () => { + const { wrapper, pswp } = mountOverlay(); + wrapper.vm._parentRectFresh = true; + pswp._listeners.zoomPanUpdate(); + expect(wrapper.vm._parentRectFresh).toBe(true); + pswp._listeners.resize(); + expect(wrapper.vm._parentRectFresh).toBe(false); + }); + }); + + // A brand-new unsaved marker has no UID/CropID (both default to ""), so the + // key must come from the rect geometry to stay stable and unique. + describe("correctness — stable marker keys", () => { + it("markerKey uses the marker UID when present", () => { + const { wrapper } = mountOverlay(); + expect(wrapper.vm.markerKey({ UID: "mabc", X: 0.1, Y: 0.1, W: 0.1, H: 0.1 })).toBe("mabc"); + }); + + it("markerKey derives a stable, non-empty geometry key for UID-less markers", () => { + const { wrapper } = mountOverlay(); + const m = { UID: "", CropID: "", X: 0.2, Y: 0.3, W: 0.1, H: 0.1 }; + const k1 = wrapper.vm.markerKey(m); + // A different object with the same geometry yields the same key (getMarkers + // returns fresh instances each render, so the key can't rely on identity). + const k2 = wrapper.vm.markerKey({ ...m }); + expect(k1).toBe(k2); + expect(k1).not.toBe(""); + expect(k1).not.toBeUndefined(); + }); + + it("markerKey gives distinct keys to distinct UID-less markers", () => { + const { wrapper } = mountOverlay(); + const a = wrapper.vm.markerKey({ UID: "", X: 0.1, Y: 0.1, W: 0.1, H: 0.1 }); + const b = wrapper.vm.markerKey({ UID: "", X: 0.5, Y: 0.5, W: 0.1, H: 0.1 }); + expect(a).not.toBe(b); + }); + + it("renders distinct rows for two UID-less markers (no key collapse)", async () => { + const markers = [ + { UID: "", Name: "", X: 0.1, Y: 0.1, W: 0.1, H: 0.1 }, + { UID: "", Name: "", X: 0.5, Y: 0.5, W: 0.1, H: 0.1 }, + ]; + const { wrapper } = mountOverlay({ markers }); + await nextTick(); + await flushPromises(); + const rects = wrapper.element.querySelectorAll("rect.p-meta-face-markers__rect"); + expect(rects.length).toBe(2); + }); + }); + + // The parent's `busy` lock propagates asynchronously, so a synchronous in-flight + // guard keeps confirm idempotent across rapid double-clicks / ✓ + Enter. + describe("correctness — idempotent confirm", () => { + it("emits create at most once on a rapid double confirm", () => { + const onCreate = vi.fn(); + const { wrapper } = mountOverlay({}, { onCreate }); + wrapper.vm.pending = { x: 50, y: 50, w: 130, h: 130 }; + wrapper.vm.onConfirmPending(); + // Second confirm fires before the parent's busy prop propagates back. + wrapper.vm.onConfirmPending(); + expect(onCreate).toHaveBeenCalledTimes(1); + }); + + it("re-enables confirm after the busy cycle settles (failed-save retry)", async () => { + const onCreate = vi.fn(); + const { wrapper } = mountOverlay({}, { onCreate }); + wrapper.vm.pending = { x: 50, y: 50, w: 130, h: 130 }; + wrapper.vm.onConfirmPending(); + expect(onCreate).toHaveBeenCalledTimes(1); + // Parent toggles busy true→false (e.g. save failed, rect kept for retry). + await wrapper.setProps({ busy: true }); + await wrapper.setProps({ busy: false }); + wrapper.vm.onConfirmPending(); + expect(onCreate).toHaveBeenCalledTimes(2); + }); + + it("allows confirming a new pending after cancel without a busy cycle", () => { + const onCreate = vi.fn(); + const { wrapper } = mountOverlay({}, { onCreate }); + wrapper.vm.pending = { x: 50, y: 50, w: 130, h: 130 }; + wrapper.vm.onConfirmPending(); + expect(onCreate).toHaveBeenCalledTimes(1); + wrapper.vm.onCancelPending(); + wrapper.vm.pending = { x: 20, y: 20, w: 60, h: 60 }; + wrapper.vm.onConfirmPending(); + expect(onCreate).toHaveBeenCalledTimes(2); + }); + }); + + // A cached image is already complete when the overlay attaches its load + // listener, so that listener never fires; bounds must initialize anyway. + describe("correctness — cached-image bounds", () => { + it("initializes bounds for an already-complete image without a load event", () => { + const { wrapper, pswp } = mountOverlay(); + Object.defineProperty(pswp.img, "complete", { value: true, configurable: true }); + Object.defineProperty(pswp.img, "naturalWidth", { value: 480, configurable: true }); + Object.defineProperty(pswp.img, "naturalHeight", { value: 360, configurable: true }); + // Force a re-attach and clear state (mount already attached once). The + // synchronous rAF stub leaves rafHandle truthy, which would dedup the + // scheduled update — reset it so updateBounds actually runs. + wrapper.vm._loadListenedImg = null; + wrapper.vm.rafHandle = null; + wrapper.vm.bounds = null; + wrapper.vm.attachImageLoadListener(); + // No load event was dispatched, yet bounds were recomputed. + expect(wrapper.vm.bounds).not.toBeNull(); + }); + }); + + // Corner handles use a larger grab radius on coarse pointers so they are + // easier to grab on touch, while the mouse radius is unchanged. + describe("ux — touch-friendly resize handles", () => { + it("uses a larger corner hit radius for coarse (touch/pen) pointers", () => { + const { wrapper } = mountOverlay(); + expect(wrapper.vm.handleHitRadius({ pointerType: "mouse" })).toBe(14); + expect(wrapper.vm.handleHitRadius({ pointerType: "touch" })).toBe(22); + expect(wrapper.vm.handleHitRadius({ pointerType: "pen" })).toBe(22); + expect(wrapper.vm.handleHitRadius(undefined)).toBe(14); + }); + + it("grabs a corner on touch from just outside the mouse hit radius", () => { + const { wrapper } = mountOverlay(); + wrapper.vm.pending = { x: 100, y: 100, w: 100, h: 100 }; + // br corner is local (200, 200); click 18 px below → local (200, 218) → + // client (300, 268). 18 px is outside 14 (mouse) but inside 22 (touch). + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 7, + pointerType: "touch", + clientX: 300, + clientY: 268, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + expect(wrapper.vm.interaction).toBe("resize"); + expect(wrapper.vm.resizeCorner).toBe("br"); + }); + + it("does not grab the corner on mouse from outside the 14 px radius", () => { + const { wrapper } = mountOverlay(); + wrapper.vm.pending = { x: 100, y: 100, w: 100, h: 100 }; + wrapper.vm.onPointerDown({ + button: 0, + pointerId: 8, + pointerType: "mouse", + clientX: 300, + clientY: 268, + stopPropagation: () => {}, + preventDefault: () => {}, + }); + expect(wrapper.vm.interaction).not.toBe("resize"); + }); + }); +}); diff --git a/frontend/tests/vitest/component/location/input.test.js b/frontend/tests/vitest/component/meta/location/input.test.js similarity index 98% rename from frontend/tests/vitest/component/location/input.test.js rename to frontend/tests/vitest/component/meta/location/input.test.js index 205df0b2e..abdca4bfc 100644 --- a/frontend/tests/vitest/component/location/input.test.js +++ b/frontend/tests/vitest/component/meta/location/input.test.js @@ -1,9 +1,9 @@ import { describe, it, expect, beforeEach, afterEach, vi } from "vitest"; import { mount } from "@vue/test-utils"; import { nextTick } from "vue"; -import PLocationInput from "component/location/input.vue"; +import PMetaLocationInput from "component/meta/location/input.vue"; -describe("PLocationInput", () => { +describe("PMetaLocationInput", () => { let wrapper; const defaultProps = { @@ -36,7 +36,7 @@ describe("PLocationInput", () => { }); const createWrapper = (props = {}) => { - return mount(PLocationInput, { + return mount(PMetaLocationInput, { props: { ...defaultProps, ...props }, }); }; diff --git a/frontend/tests/vitest/component/navigation.test.js b/frontend/tests/vitest/component/navigation.test.js index 91d2ef995..4cbd92532 100644 --- a/frontend/tests/vitest/component/navigation.test.js +++ b/frontend/tests/vitest/component/navigation.test.js @@ -56,9 +56,15 @@ function mountNavigation({ isPro: baseConfig.isPro || vi.fn(() => false), isSponsor: baseConfig.isSponsor || vi.fn(() => false), get: vi.fn((key) => { - if (key === "demo") return false; - if (key === "public") return isPublic; - if (key === "readonly") return false; + if (key === "demo") { + return false; + } + if (key === "public") { + return isPublic; + } + if (key === "readonly") { + return false; + } return false; }), feature: vi.fn((name) => { @@ -237,25 +243,7 @@ describe("component/navigation", () => { }); }); - describe("account and legal navigation", () => { - it("showAccountSettings routes to account settings when account feature is enabled", () => { - const { wrapper, push } = mountNavigation({ - featureOverrides: { account: true }, - }); - - wrapper.vm.showAccountSettings(); - expect(push).toHaveBeenCalledWith({ name: "settings_account" }); - }); - - it("showAccountSettings falls back to general settings when account feature is disabled", () => { - const { wrapper, push } = mountNavigation({ - featureOverrides: { account: false }, - }); - - wrapper.vm.showAccountSettings(); - expect(push).toHaveBeenCalledWith({ name: "settings" }); - }); - + describe("legal navigation", () => { it("showLegalInfo opens external URL when legalUrl is configured", () => { const { wrapper, util } = mountNavigation({ configValues: { legalUrl: "https://example.com/legal" }, @@ -275,6 +263,20 @@ describe("component/navigation", () => { }); }); + describe("account navigation", () => { + it("onAccount routes to account settings when the account feature is enabled", () => { + const { wrapper, push } = mountNavigation({ featureOverrides: { account: true } }); + wrapper.vm.onAccount(); + expect(push).toHaveBeenCalledWith({ name: "settings_account" }); + }); + + it("onAccount falls back to general settings when the account feature is disabled", () => { + const { wrapper, push } = mountNavigation({ featureOverrides: { account: false } }); + wrapper.vm.onAccount(); + expect(push).toHaveBeenCalledWith({ name: "settings" }); + }); + }); + describe("home and upload actions", () => { it("onHome toggles drawer on small screens and does not navigate", () => { const { wrapper, push } = mountNavigation({ @@ -366,14 +368,14 @@ describe("component/navigation", () => { }); describe("logout", () => { - it("onLogout calls session.logout", () => { - const logout = vi.fn(); + it("onLogout calls session.logoutEverywhere", () => { + const logoutEverywhere = vi.fn(); const { wrapper, session } = mountNavigation({ - sessionOverrides: { logout }, + sessionOverrides: { logoutEverywhere }, }); wrapper.vm.onLogout(); - expect(session.logout).toHaveBeenCalled(); + expect(session.logoutEverywhere).toHaveBeenCalled(); }); }); }); diff --git a/frontend/tests/vitest/component/people/edit/dialog.test.js b/frontend/tests/vitest/component/people/edit/dialog.test.js new file mode 100644 index 000000000..b1a9d85e1 --- /dev/null +++ b/frontend/tests/vitest/component/people/edit/dialog.test.js @@ -0,0 +1,76 @@ +import { describe, it, expect, vi, beforeEach, afterEach } from "vitest"; +import { shallowMount } from "@vue/test-utils"; +import "../../../fixtures"; +import { Subject } from "model/subject"; +import PPeopleEditDialog from "component/people/edit/dialog.vue"; + +const makeWrapper = () => { + const person = new Subject({ UID: "sbj1", Name: "Alice", Favorite: false, Hidden: false }); + + const wrapper = shallowMount(PPeopleEditDialog, { + props: { visible: true, person }, + global: { + mocks: { + $gettext: (s) => s, + $notify: { error: vi.fn(), success: vi.fn() }, + $view: { enter: vi.fn(), leave: vi.fn() }, + $config: { allow: () => true }, + }, + stubs: { + VDialog: { template: "<div><slot /></div>" }, + VForm: { template: "<form><slot /></form>" }, + VCard: { template: "<div><slot /></div>" }, + VCardText: { template: "<div><slot /></div>" }, + VCardActions: { template: "<div><slot /></div>" }, + VToolbar: { template: "<div><slot /></div>" }, + VToolbarTitle: { template: "<div><slot /></div>" }, + VRow: { template: "<div><slot /></div>" }, + VCol: { template: "<div><slot /></div>" }, + VTextField: { template: "<input />" }, + VCheckbox: { template: "<input type='checkbox' />" }, + VBtn: { template: "<button><slot /></button>" }, + VIcon: { template: "<i><slot /></i>" }, + }, + }, + }); + + return wrapper; +}; + +const overrideFormRef = (vm, validate) => { + vm.$.refs.form = { validate }; +}; + +describe("component/people/edit/dialog", () => { + let wrapper; + + beforeEach(() => { + wrapper = makeWrapper(); + }); + + afterEach(() => { + if (wrapper) wrapper.unmount(); + }); + + it("blocks confirm and notifies when form validation fails", async () => { + const validate = vi.fn().mockResolvedValue({ valid: false }); + overrideFormRef(wrapper.vm, validate); + + await wrapper.vm.confirm(); + + expect(validate).toHaveBeenCalled(); + expect(wrapper.emitted("confirm")).toBeFalsy(); + expect(wrapper.vm.$notify.error).toHaveBeenCalledWith("Changes could not be saved"); + }); + + it("emits confirm with the model when form validation passes", async () => { + const validate = vi.fn().mockResolvedValue({ valid: true }); + overrideFormRef(wrapper.vm, validate); + + await wrapper.vm.confirm(); + + expect(validate).toHaveBeenCalled(); + expect(wrapper.emitted("confirm")).toBeTruthy(); + expect(wrapper.emitted("confirm")[0][0]).toBe(wrapper.vm.model); + }); +}); diff --git a/frontend/tests/vitest/component/photo/batch-edit.test.js b/frontend/tests/vitest/component/photo/batch-edit.test.js index 9ba37e166..5bb2400d2 100644 --- a/frontend/tests/vitest/component/photo/batch-edit.test.js +++ b/frontend/tests/vitest/component/photo/batch-edit.test.js @@ -17,6 +17,61 @@ describe("component/photo/batch-edit", () => { let wrapper; let mockBatchInstance; + // mountWithConfig mounts PPhotoBatchEdit with the same stubs as the + // default wrapper but lets callers override the $config feature/allow + // accessors so the per-section gating computeds can be exercised. + const mountWithConfig = ({ feature, allow }) => { + return shallowMount(PPhotoBatchEdit, { + props: { + visible: false, + selection: mockSelection, + openDate: vi.fn(), + openLocation: vi.fn(), + editPhoto: vi.fn(), + }, + global: { + mocks: { + $lightbox: { openView: vi.fn() }, + $vuetify: { display: { mdAndDown: false } }, + $config: { + feature, + allow, + get: () => false, + getSettings: () => ({ features: {} }), + deny: () => false, + featExperimental: () => false, + featDevelop: () => false, + values: {}, + dir: () => "ltr", + }, + }, + stubs: { + VDialog: { + template: '<div class="v-dialog">' + '<slot v-if="modelValue" />' + "</div>", + props: ["modelValue"], + }, + VDataTable: { template: '<div class="v-data-table"></div>', props: ["headers", "items"] }, + PMetaLocationInput: { + template: '<div class="p-meta-location-input"></div>', + props: ["latlng", "label"], + emits: ["update:latlng", "changed", "open-map", "delete", "undo"], + }, + PMetaLocationDialog: { + template: '<div class="p-meta-location-dialog"></div>', + props: ["visible", "latlng"], + emits: ["close", "confirm"], + }, + PInputChipSelector: { + template: '<div class="p-input-chip-selector"></div>', + props: ["items", "availableItems"], + emits: ["update:items"], + }, + IconLivePhoto: { template: '<i class="icon-live-photo"></i>' }, + }, + }, + }); + }; + const mockSelection = ["uid1", "uid2", "uid3"]; const mockModels = [ @@ -133,8 +188,12 @@ describe("component/photo/batch-edit", () => { mockBatchInstance.getLengthOfAllSelected.mockReturnValue(3); mockBatchInstance.isSelected.mockReturnValue(true); - // Mock the Batch constructor to return our mock instance - vi.mocked(Batch).mockImplementation(() => mockBatchInstance); + // Mock the Batch constructor to return our mock instance. Vitest 4 invokes + // the mock as a constructor via `new`, so the implementation must be a + // regular function (an arrow function is not constructable). + vi.mocked(Batch).mockImplementation(function () { + return mockBatchInstance; + }); wrapper = shallowMount(PPhotoBatchEdit, { props: { @@ -160,13 +219,13 @@ describe("component/photo/batch-edit", () => { template: '<div class="v-data-table"></div>', props: ["headers", "items"], }, - PLocationInput: { - template: '<div class="p-location-input"></div>', + PMetaLocationInput: { + template: '<div class="p-meta-location-input"></div>', props: ["latlng", "label"], emits: ["update:latlng", "changed", "open-map", "delete", "undo"], }, - PLocationDialog: { - template: '<div class="p-location-dialog"></div>', + PMetaLocationDialog: { + template: '<div class="p-meta-location-dialog"></div>', props: ["visible", "latlng"], emits: ["close", "confirm"], }, @@ -228,6 +287,113 @@ describe("component/photo/batch-edit", () => { expect(wrapper.vm.isLocationMixed).toBe(true); expect(wrapper.vm.currentCoordinates).toEqual([0, 0]); }); + + // availableLabelOptions / availableAlbumOptions are computeds that + // hide already-selected items from the chip-selector dropdown and + // sort the survivors via locale-aware compare. Raw cache results + // live on cachedLabelOptions / cachedAlbumOptions so the canonical + // resolveLabelFromText path still finds matches for items already + // in labelItems. + it("filters cached label options by labelItems and sorts alphabetically", () => { + wrapper.vm.cachedLabelOptions = [ + { value: "lbl-mountain", title: "Mountain" }, + { value: "lbl-apple", title: "apple" }, + { value: "lbl-beach", title: "Beach" }, + { value: "lbl-earth", title: "Earth" }, + ]; + wrapper.vm.labelItems = [{ value: "lbl-earth", title: "Earth", action: "none" }]; + + const titles = wrapper.vm.availableLabelOptions.map((o) => o.title); + // Earth is filtered (in labelItems); the rest sort case-insensitively. + expect(titles).toEqual(["apple", "Beach", "Mountain"]); + }); + + it("filters labelItems by normalized title (punctuation/case variants collapse)", () => { + wrapper.vm.cachedLabelOptions = [ + { value: "lbl-hc-canonical", title: "hello-cat" }, + { value: "lbl-mountain", title: "Mountain" }, + ]; + wrapper.vm.labelItems = [{ value: "lbl-hc", title: "Hello Cat", action: "add" }]; + + const titles = wrapper.vm.availableLabelOptions.map((o) => o.title); + expect(titles).toEqual(["Mountain"]); + }); + + it("filters cached album options by albumItems and sorts alphabetically", () => { + wrapper.vm.cachedAlbumOptions = [ + { value: "alb-zebra", title: "Zebra" }, + { value: "alb-alpha", title: "alpha" }, + { value: "alb-mango", title: "Mango" }, + ]; + wrapper.vm.albumItems = [{ value: "alb-mango", title: "Mango", action: "add" }]; + + const titles = wrapper.vm.availableAlbumOptions.map((o) => o.title); + expect(titles).toEqual(["alpha", "Zebra"]); + }); + + // canViewLabels / canViewAlbums gate the Labels and Albums sections + // on the deployment's feature flags + the session's resource grants. + // Mirrors the lightbox/sidebar.vue pattern so the dialog and the sidebar + // appear/disappear together. + it("canViewLabels is true when feature and ACL both admit", () => { + const w = mountWithConfig({ + feature: (n) => (n === "labels" ? true : true), + allow: (r, p) => (r === "labels" && p === "search" ? true : true), + }); + expect(w.vm.canViewLabels).toBe(true); + w.unmount(); + }); + + it("canViewLabels is false when feature labels is disabled", () => { + const w = mountWithConfig({ + feature: (n) => (n === "labels" ? false : true), + allow: () => true, + }); + expect(w.vm.canViewLabels).toBe(false); + w.unmount(); + }); + + it("canViewLabels is false when ACL denies labels:search", () => { + const w = mountWithConfig({ + feature: () => true, + allow: (r, p) => !(r === "labels" && p === "search"), + }); + expect(w.vm.canViewLabels).toBe(false); + w.unmount(); + }); + + it("canViewAlbums is false when feature albums is disabled", () => { + const w = mountWithConfig({ + feature: (n) => (n === "albums" ? false : true), + allow: () => true, + }); + expect(w.vm.canViewAlbums).toBe(false); + w.unmount(); + }); + + it("canViewAlbums is false when ACL denies albums:search", () => { + const w = mountWithConfig({ + feature: () => true, + allow: (r, p) => !(r === "albums" && p === "search"), + }); + expect(w.vm.canViewAlbums).toBe(false); + w.unmount(); + }); + + it("fetchAvailableOptions skips both cache fetches when sections are gated off", async () => { + const w = mountWithConfig({ + feature: (n) => (n === "labels" || n === "albums" ? false : true), + allow: () => true, + }); + w.vm.cachedAlbumOptions = [{ value: "alb-stale", title: "Stale" }]; + w.vm.cachedLabelOptions = [{ value: "lbl-stale", title: "Stale" }]; + + await w.vm.fetchAvailableOptions(); + + expect(w.vm.cachedAlbumOptions).toEqual([]); + expect(w.vm.cachedLabelOptions).toEqual([]); + w.unmount(); + }); }); describe("Form Data Management", () => { @@ -329,6 +495,35 @@ describe("component/photo/batch-edit", () => { expect(wrapper.vm.$notify.error).toHaveBeenCalledWith("Failed to save changes"); expect(wrapper.vm.saving).toBe(false); }); + + // Vue 3's component proxy intercepts $refs reads; standard assignment + // doesn't stick. Inject the mock into the internal instance's refs + // object (vm.$.refs) so save()'s `this.$refs.form.validate` resolves + // to the spy. + const overrideFormRef = (vm, validate) => { + vm.$.refs.form = { validate }; + }; + + it("blocks the batch save and notifies when form validation fails", async () => { + const validate = vi.fn().mockResolvedValue({ valid: false }); + overrideFormRef(wrapper.vm, validate); + + await wrapper.vm.save(false); + + expect(validate).toHaveBeenCalled(); + expect(mockBatchInstance.save).not.toHaveBeenCalled(); + expect(wrapper.vm.$notify.error).toHaveBeenCalledWith("Changes could not be saved"); + }); + + it("proceeds with the batch save when form validation passes", async () => { + const validate = vi.fn().mockResolvedValue({ valid: true }); + overrideFormRef(wrapper.vm, validate); + + await wrapper.vm.save(false); + + expect(validate).toHaveBeenCalled(); + expect(mockBatchInstance.save).toHaveBeenCalled(); + }); }); describe("Form Field Updates", () => { @@ -571,4 +766,50 @@ describe("component/photo/batch-edit", () => { expect(wrapper.vm.getIcon("input-field", "Altitude")).toBe("mdi-close-circle"); }); }); + + describe("Validation Rules", () => { + // Locks each inline-text field to the backend VARCHAR cap on + // PhotoMaxLength so a future bare $config.get('clip') regression + // (which would cap at 160 instead of the real ceiling) fails here. + it("exposes PhotoMaxLength and validates each inline-text field at its real cap", () => { + const m = wrapper.vm.PhotoMaxLength; + expect(m).toEqual({ + Title: 200, + Caption: 4096, + Subject: 1024, + Artist: 1024, + Copyright: 1024, + License: 1024, + Keywords: 2048, + Notes: 2048, + Exposure: 64, + }); + + const cases = [ + ["Title", m.Title], + ["Caption", m.Caption], + ["Subject", m.Subject], + ["Copyright", m.Copyright], + ["Artist", m.Artist], + ["License", m.License], + ]; + + for (const [label, cap] of cases) { + const [, rule] = wrapper.vm.rules.text(false, 0, cap, label); + expect(rule("a".repeat(cap))).toBe(true); + expect(rule("a".repeat(cap + 1))).toBe(`${label} is too long`); + } + }); + + // Batch fields can be in Mixed state — getFieldData binds the empty + // string for mixed text inputs. rules.text short-circuits on the + // empty value via maxLen's null-safety, so the rule passes without + // a Mixed-aware branch in the form. + it("passes the rule on empty Mixed-state values", () => { + const [, rule] = wrapper.vm.rules.text(false, 0, wrapper.vm.PhotoMaxLength.Caption, "Caption"); + expect(rule("")).toBe(true); + expect(rule(null)).toBe(true); + expect(rule(undefined)).toBe(true); + }); + }); }); diff --git a/frontend/tests/vitest/component/photo/edit/details.test.js b/frontend/tests/vitest/component/photo/edit/details.test.js index b0530fe7c..c521cfde0 100644 --- a/frontend/tests/vitest/component/photo/edit/details.test.js +++ b/frontend/tests/vitest/component/photo/edit/details.test.js @@ -11,9 +11,15 @@ const createMockModel = (overrides = {}) => ({ localDate: vi.fn().mockReturnValue({ isValid: true, toFormat: (fmt) => { - if (fmt === "d") return "1"; - if (fmt === "L") return "4"; - if (fmt === "y") return "2024"; + if (fmt === "d") { + return "1"; + } + if (fmt === "L") { + return "4"; + } + if (fmt === "y") { + return "2024"; + } return "2024-04-01T11:29:54"; }, toISO: () => "2024-04-01T11:29:54", @@ -80,14 +86,24 @@ const makeWrapper = (overrides = {}) => { $vuetify: { display: { xs: false } }, $config: { feature: vi.fn().mockImplementation((f) => { - if (f === "edit") return true; - if (f === "review") return true; - if (f === "places") return true; + if (f === "edit") { + return true; + } + if (f === "review") { + return true; + } + if (f === "places") { + return true; + } return false; }), get: vi.fn().mockImplementation((k) => { - if (k === "clip") return 255; - if (k === "readonly") return false; + if (k === "clip") { + return 255; + } + if (k === "readonly") { + return false; + } return ""; }), values: { @@ -108,8 +124,8 @@ const makeWrapper = (overrides = {}) => { VAutocomplete: { template: "<select></select>" }, VSelect: { template: "<select></select>" }, VBtn: { template: "<button><slot /></button>" }, - PLocationInput: { template: '<div class="p-location-input"></div>' }, - PLocationDialog: { template: '<div class="p-location-dialog"></div>' }, + PMetaLocationInput: { template: '<div class="p-meta-location-input"></div>' }, + PMetaLocationDialog: { template: '<div class="p-meta-location-dialog"></div>' }, }, }, ...overrides, @@ -124,7 +140,9 @@ describe("component/photo/edit/details", () => { }); afterEach(() => { - if (wrapper) wrapper.unmount(); + if (wrapper) { + wrapper.unmount(); + } }); describe("initialization and data sync", () => { @@ -262,9 +280,15 @@ describe("component/photo/edit/details", () => { const mockLocalDate = { isValid: true, toFormat: vi.fn().mockImplementation((fmt) => { - if (fmt === "d") return "15"; - if (fmt === "L") return "6"; - if (fmt === "y") return "2023"; + if (fmt === "d") { + return "15"; + } + if (fmt === "L") { + return "6"; + } + if (fmt === "y") { + return "2023"; + } return "2023-06-15"; }), toISO: () => "2023-06-15T14:30:00", @@ -362,8 +386,8 @@ describe("component/photo/edit/details", () => { }, stubs: { VAutocomplete: false, - PLocationInput: { template: '<div class="p-location-input"></div>' }, - PLocationDialog: { template: '<div class="p-location-dialog"></div>' }, + PMetaLocationInput: { template: '<div class="p-meta-location-input"></div>' }, + PMetaLocationDialog: { template: '<div class="p-meta-location-dialog"></div>' }, }, }, }); @@ -415,14 +439,94 @@ describe("component/photo/edit/details", () => { expect(wrapper.emitted("close")).toBeTruthy(); }); - it("validates text length with textRule", () => { - const longText = "a".repeat(300); // Longer than clip limit of 255 - const result = wrapper.vm.textRule(longText); - expect(result).toBe("Text too long"); + // Vue 3's component proxy intercepts $refs reads; standard assignment + // doesn't stick. The internal instance (vm.$) exposes the underlying + // `refs` object that the proxy reads from, so injecting the mock + // there lets `this.$refs.form.validate` resolve to the spy when + // save() runs. + const overrideFormRef = (vm, validate) => { + vm.$.refs.form = { validate }; + }; - const shortText = "Valid text"; - const validResult = wrapper.vm.textRule(shortText); - expect(validResult).toBe(true); + it("blocks save and notifies when form validation fails", async () => { + wrapper.vm.invalidDate = false; + const validate = vi.fn().mockResolvedValue({ valid: false }); + overrideFormRef(wrapper.vm, validate); + + await wrapper.vm.save(false); + + expect(validate).toHaveBeenCalled(); + expect(wrapper.vm.view.model.update).not.toHaveBeenCalled(); + expect(wrapper.vm.$notify.error).toHaveBeenCalledWith("Changes could not be saved"); + }); + + it("proceeds with save when form validation passes", async () => { + wrapper.vm.invalidDate = false; + const validate = vi.fn().mockResolvedValue({ valid: true }); + overrideFormRef(wrapper.vm, validate); + + await wrapper.vm.save(false); + + expect(validate).toHaveBeenCalled(); + expect(wrapper.vm.view.model.update).toHaveBeenCalled(); + }); + + it("validates text length via the centralized rules.text factory", () => { + // After migrating the per-component textRule to the shared + // common/form rules.text(...) factory, each :rules attribute + // calls the factory inline. The component exposes `rules` on + // its instance so call sites can invoke it from the template. + const [, maxLenRule] = wrapper.vm.rules.text(false, 0, 255, "Title"); + + // Too long → label-specific localized message. + expect(maxLenRule("a".repeat(300))).toBe("Title is too long"); + + // Short input → passes. + expect(maxLenRule("Valid text")).toBe(true); + + // Defensive: null / undefined / object inputs don't crash, the + // factory's maxLen short-circuits on non-string input. + expect(maxLenRule(null)).toBe(true); + expect(maxLenRule(undefined)).toBe(true); + expect(maxLenRule({ Name: "obj" })).toBe(true); + }); + + // Per-field caps must come from PhotoMaxLength (backend VARCHAR), not + // the historical $config.get('clip') = 160 ceiling. These cases lock + // each field's exposure to its real backend cap so a future bare + // `clip` regression fails loudly here. + it("exposes PhotoMaxLength and wires the per-field caps", () => { + const m = wrapper.vm.PhotoMaxLength; + expect(m).toEqual({ + Title: 200, + Caption: 4096, + Subject: 1024, + Artist: 1024, + Copyright: 1024, + License: 1024, + Keywords: 2048, + Notes: 2048, + Exposure: 64, + }); + + const cases = [ + ["Title", "Title", m.Title], + ["Caption", "Caption", m.Caption], + ["Subject", "Subject", m.Subject], + ["Copyright", "Copyright", m.Copyright], + ["Artist", "Artist", m.Artist], + ["License", "License", m.License], + ["Keywords", "Keywords", m.Keywords], + ["Notes", "Notes", m.Notes], + ]; + + for (const [label, errorLabel, cap] of cases) { + const [, rule] = wrapper.vm.rules.text(false, 0, cap, label); + // At the cap → passes (200 valid for Title, 4096 for Caption, …). + expect(rule("a".repeat(cap))).toBe(true); + // One char beyond → label-specific error. + expect(rule("a".repeat(cap + 1))).toBe(`${errorLabel} is too long`); + } }); }); diff --git a/frontend/tests/vitest/component/photo/edit/files.test.js b/frontend/tests/vitest/component/photo/edit/files.test.js index d3bddfd3f..625eaa07d 100644 --- a/frontend/tests/vitest/component/photo/edit/files.test.js +++ b/frontend/tests/vitest/component/photo/edit/files.test.js @@ -63,7 +63,9 @@ function mountPhotoFiles({ features, })), get: vi.fn((key) => { - if (key === "experimental") return experimental; + if (key === "experimental") { + return experimental; + } if (baseConfig.get) { return baseConfig.get(key); } diff --git a/frontend/tests/vitest/component/photo/edit/labels.test.js b/frontend/tests/vitest/component/photo/edit/labels.test.js index ada18747a..bb8582d64 100644 --- a/frontend/tests/vitest/component/photo/edit/labels.test.js +++ b/frontend/tests/vitest/component/photo/edit/labels.test.js @@ -2,6 +2,8 @@ import { describe, it, expect, vi, afterEach } from "vitest"; import { shallowMount, config as VTUConfig } from "@vue/test-utils"; import PTabPhotoLabels from "component/photo/edit/labels.vue"; import Thumb from "model/thumb"; +import $util from "common/util"; +import typeaheadCache from "common/typeahead-cache"; function mountPhotoLabels({ modelOverrides = {}, routerOverrides = {}, utilOverrides = {}, notifyOverrides = {}, viewHasModel = true } = {}) { const baseConfig = VTUConfig.global.mocks.$config || {}; @@ -10,11 +12,11 @@ function mountPhotoLabels({ modelOverrides = {}, routerOverrides = {}, utilOverr const model = viewHasModel ? { - removeLabel: vi.fn(() => Promise.resolve()), - addLabel: vi.fn(() => Promise.resolve()), - activateLabel: vi.fn(), - ...modelOverrides, - } + removeLabel: vi.fn(() => Promise.resolve()), + addLabel: vi.fn(() => Promise.resolve()), + activateLabel: vi.fn(), + ...modelOverrides, + } : null; const router = { @@ -25,6 +27,10 @@ function mountPhotoLabels({ modelOverrides = {}, routerOverrides = {}, utilOverr const util = { ...baseUtil, sourceName: vi.fn((s) => `source-${s}`), + // Mounted with the real normalizeTitle so the L11 canonical-match + // dedup pipeline runs against the same normalization the component + // uses at runtime (case + punctuation + `+`/`_`/`-` → space). + normalizeTitle: (s) => $util.normalizeTitle(s), ...utilOverrides, }; @@ -77,6 +83,61 @@ describe("component/photo/edit/labels", () => { vi.restoreAllMocks(); }); + describe("name validation rule", () => { + // Regression: the v-combobox initializes with newLabelModel = null + // and Vuetify validates :rules on mount, so the rule must tolerate + // null, strings (free-text entry), and item objects (return-object). + // The shared rules.text(...) factory in common/form.js short-circuits + // on non-string input via maxLen, so all three cases pass without + // throwing the historical "Cannot read properties of null" error. + // + // The cap now comes from LabelMaxLength.Name (160, backend VARCHAR) + // — not the legacy $config.get('clip') 160 ceiling — so a backend + // bump propagates without per-component edits. + const maxLen = (wrapper, cap = wrapper.vm.LabelMaxLength.Name) => { + const [, rule] = wrapper.vm.rules.text(false, 0, cap, "Name"); + return rule; + }; + + it("exposes LabelMaxLength.Name from the model", () => { + const { wrapper } = mountPhotoLabels(); + expect(wrapper.vm.LabelMaxLength).toEqual({ Name: 160, Description: 2048, Notes: 1024 }); + }); + + it("returns valid for null without throwing (initial / cleared combobox)", () => { + const { wrapper } = mountPhotoLabels(); + expect(maxLen(wrapper)(null)).toBe(true); + }); + + it("returns valid for undefined", () => { + const { wrapper } = mountPhotoLabels(); + expect(maxLen(wrapper)(undefined)).toBe(true); + }); + + it("validates a short typed string as valid", () => { + const { wrapper } = mountPhotoLabels(); + expect(maxLen(wrapper)("hello")).toBe(true); + }); + + it("returns the error message when a typed string exceeds the cap", () => { + const { wrapper } = mountPhotoLabels(); + expect(maxLen(wrapper, 5)("toolong")).toBe("Name is too long"); + }); + + it("short-circuits return-object combobox selections (objects pass)", () => { + // Backend caps existing labels at LabelMaxLength.Name (160), so + // every item-object selection already fits — the factory's + // maxLen short-circuit on non-string input is the correct + // behavior here. Trade-off: a synthetic object with an + // overlength .Name would no longer surface a frontend error, + // but in production such objects can't reach the dropdown. + const { wrapper } = mountPhotoLabels(); + expect(maxLen(wrapper, 10)({ Name: "Flower" })).toBe(true); + expect(maxLen(wrapper, 10)({ Name: "a really long name" })).toBe(true); + expect(maxLen(wrapper, 10)({})).toBe(true); + }); + }); + describe("sourceName", () => { it("delegates to $util.sourceName", () => { const sourceNameSpy = vi.fn(() => "Human"); @@ -119,7 +180,7 @@ describe("component/photo/edit/labels", () => { await Promise.resolve(); expect(removeSpy).toHaveBeenCalledWith(5); - expect(notifySuccessSpy).toHaveBeenCalledWith("removed Cat"); + expect(notifySuccessSpy).toHaveBeenCalledWith("Removed Cat"); }); }); @@ -136,6 +197,18 @@ describe("component/photo/edit/labels", () => { expect(addSpy).not.toHaveBeenCalled(); }); + it("does nothing for whitespace-only input", () => { + const addSpy = vi.fn(() => Promise.resolve()); + const { wrapper } = mountPhotoLabels({ + modelOverrides: { addLabel: addSpy }, + }); + + wrapper.vm.newLabel = " "; + wrapper.vm.addLabel(); + + expect(addSpy).not.toHaveBeenCalled(); + }); + it("calls model.addLabel, shows success message and clears newLabel", async () => { const addSpy = vi.fn(() => Promise.resolve()); const notifySuccessSpy = vi.fn(); @@ -147,12 +220,254 @@ describe("component/photo/edit/labels", () => { wrapper.vm.newLabel = "Dog"; wrapper.vm.addLabel(); + // resetInput defers the clear into $nextTick so Vuetify's combobox + // sees the menu close before the search-changed watcher fires. await Promise.resolve(); + await wrapper.vm.$nextTick(); expect(addSpy).toHaveBeenCalledWith("Dog"); - expect(notifySuccessSpy).toHaveBeenCalledWith("added Dog"); + expect(notifySuccessSpy).toHaveBeenCalledWith("Added Dog"); expect(wrapper.vm.newLabel).toBe(""); }); + + // L11: typing a normalized-equal variant of an existing label + // (`Hello Cat` for an existing `hello-cat`) sends the canonical + // server-side name to the backend instead of creating a duplicate. + it("canonicalizes the typed name to an existing labelOption when normalized-equal", async () => { + const addSpy = vi.fn(() => Promise.resolve()); + const { wrapper } = mountPhotoLabels({ + modelOverrides: { addLabel: addSpy }, + }); + + wrapper.vm.cachedLabelOptions = [{ UID: "lbl-canonical", Name: "Hello Cat" }]; + wrapper.vm.newLabel = "hello-cat"; + wrapper.vm.addLabel(); + await Promise.resolve(); + + // Backend receives the canonical existing-label name, not the typed variant. + expect(addSpy).toHaveBeenCalledWith("Hello Cat"); + }); + + it("passes the typed name through when no labelOption matches", async () => { + const addSpy = vi.fn(() => Promise.resolve()); + const { wrapper } = mountPhotoLabels({ + modelOverrides: { addLabel: addSpy }, + }); + + wrapper.vm.cachedLabelOptions = [{ UID: "lbl-canonical", Name: "Hello Cat" }]; + wrapper.vm.newLabel = "Sunset"; + wrapper.vm.addLabel(); + await Promise.resolve(); + + expect(addSpy).toHaveBeenCalledWith("Sunset"); + }); + + it("trims surrounding whitespace before sending to the backend", async () => { + const addSpy = vi.fn(() => Promise.resolve()); + const { wrapper } = mountPhotoLabels({ + modelOverrides: { addLabel: addSpy }, + }); + + wrapper.vm.newLabel = " Beach "; + wrapper.vm.addLabel(); + await Promise.resolve(); + + expect(addSpy).toHaveBeenCalledWith("Beach"); + }); + + // Backend treats an addLabel call for an already-assigned label as + // an update (re-activation), surfacing a stray "Label updated" + + // "added <name>" notification pair. Picking an existing chip from + // the dropdown should be a no-op against the API. + it("skips the API call when the label is already on the photo", async () => { + const addSpy = vi.fn(() => Promise.resolve()); + const notifySuccessSpy = vi.fn(); + const { wrapper } = mountPhotoLabels({ + modelOverrides: { + addLabel: addSpy, + Labels: [{ Uncertainty: 0, Label: { ID: 1, Name: "Earth" } }], + }, + notifyOverrides: { success: notifySuccessSpy }, + }); + + wrapper.vm.newLabel = "Earth"; + wrapper.vm.addLabel(); + await Promise.resolve(); + await wrapper.vm.$nextTick(); + + expect(addSpy).not.toHaveBeenCalled(); + expect(notifySuccessSpy).not.toHaveBeenCalled(); + // Reset still runs so the input/menu state is cleared. + expect(wrapper.vm.newLabel).toBe(""); + }); + + it("skips the API call for normalized-equal duplicates already on the photo", async () => { + const addSpy = vi.fn(() => Promise.resolve()); + const { wrapper } = mountPhotoLabels({ + modelOverrides: { + addLabel: addSpy, + Labels: [{ Uncertainty: 0, Label: { ID: 1, Name: "Hello Cat" } }], + }, + }); + + wrapper.vm.newLabel = "hello-cat"; + wrapper.vm.addLabel(); + await Promise.resolve(); + await wrapper.vm.$nextTick(); + + expect(addSpy).not.toHaveBeenCalled(); + }); + }); + + describe("onLabelSelected", () => { + it("commits the dropdown selection via addLabel", async () => { + const addSpy = vi.fn(() => Promise.resolve()); + const { wrapper } = mountPhotoLabels({ + modelOverrides: { addLabel: addSpy }, + }); + + wrapper.vm.onLabelSelected({ Name: "Mountains", UID: "lbl-mountains" }); + await Promise.resolve(); + + expect(addSpy).toHaveBeenCalledWith("Mountains"); + }); + + it("ignores non-object selections (typed strings)", () => { + const addSpy = vi.fn(() => Promise.resolve()); + const { wrapper } = mountPhotoLabels({ + modelOverrides: { addLabel: addSpy }, + }); + + wrapper.vm.onLabelSelected("just-a-string"); + wrapper.vm.onLabelSelected(null); + + expect(addSpy).not.toHaveBeenCalled(); + }); + }); + + describe("menu suppression after add", () => { + // After committing a selection, clearing newLabel synchronously + // would re-open Vuetify's combobox menu via the search-changed + // watcher. resetInput closes the menu, sets a suppress flag, + // blurs the input, then clears the bound values on the next tick. + it("closes the menu and engages the suppress flag during reset", async () => { + const addSpy = vi.fn(() => Promise.resolve()); + const { wrapper } = mountPhotoLabels({ + modelOverrides: { addLabel: addSpy }, + }); + + wrapper.vm.menuOpen = true; + wrapper.vm.newLabel = "Mountains"; + wrapper.vm.addLabel(); + await Promise.resolve(); + + expect(wrapper.vm.menuOpen).toBe(false); + expect(wrapper.vm.suppressMenuOpen).toBe(true); + + await wrapper.vm.$nextTick(); + expect(wrapper.vm.newLabel).toBe(""); + expect(wrapper.vm.newLabelModel).toBeNull(); + }); + + it("rejects re-open intents while suppressMenuOpen is set", () => { + const { wrapper } = mountPhotoLabels(); + + wrapper.vm.suppressMenuOpen = true; + wrapper.vm.onMenuUpdate(true); + expect(wrapper.vm.menuOpen).toBe(false); + }); + + it("forwards the menu state when the suppress flag is not set", () => { + const { wrapper } = mountPhotoLabels(); + + wrapper.vm.suppressMenuOpen = false; + wrapper.vm.onMenuUpdate(true); + expect(wrapper.vm.menuOpen).toBe(true); + + wrapper.vm.onMenuUpdate(false); + expect(wrapper.vm.menuOpen).toBe(false); + }); + }); + + describe("loadLabelOptions", () => { + it("populates labelOptions from typeaheadCache.getLabels", async () => { + typeaheadCache.clear(); + const cacheSpy = vi.spyOn(typeaheadCache, "getLabels").mockResolvedValueOnce([ + { Name: "Cat", UID: "lbl-cat", Slug: "cat" }, + ]); + const { wrapper } = mountPhotoLabels(); + + wrapper.vm.loadLabelOptions(); + await Promise.resolve(); + await Promise.resolve(); + + expect(cacheSpy).toHaveBeenCalled(); + // Labels tab maps to {Name, UID} just like the sidebar combobox. + expect(wrapper.vm.labelOptions).toEqual([{ Name: "Cat", UID: "lbl-cat" }]); + cacheSpy.mockRestore(); + }); + + it("swallows cache errors so a transient fetch failure doesn't block typing", async () => { + const cacheSpy = vi.spyOn(typeaheadCache, "getLabels").mockRejectedValueOnce(new Error("boom")); + const { wrapper } = mountPhotoLabels(); + + expect(() => wrapper.vm.loadLabelOptions()).not.toThrow(); + await Promise.resolve(); + await Promise.resolve(); + expect(wrapper.vm.labelOptions).toEqual([]); + cacheSpy.mockRestore(); + }); + }); + + describe("labelOptions computed", () => { + // Filters out anything already on the photo so the dropdown only + // shows actionable suggestions, and sorts the remaining items + // alphabetically (locale-aware) so the menu reads naturally. + it("hides labels already assigned to the photo", () => { + const { wrapper } = mountPhotoLabels({ + modelOverrides: { + Labels: [{ Uncertainty: 0, Label: { ID: 1, Name: "Earth" } }], + }, + }); + wrapper.vm.cachedLabelOptions = [ + { Name: "Cat", UID: "lbl-cat" }, + { Name: "Earth", UID: "lbl-earth" }, + { Name: "Mountain", UID: "lbl-mountain" }, + ]; + + expect(wrapper.vm.labelOptions).toEqual([ + { Name: "Cat", UID: "lbl-cat" }, + { Name: "Mountain", UID: "lbl-mountain" }, + ]); + }); + + it("filters by normalized name so case and punctuation variants collapse", () => { + const { wrapper } = mountPhotoLabels({ + modelOverrides: { + Labels: [{ Uncertainty: 0, Label: { ID: 1, Name: "Hello Cat" } }], + }, + }); + wrapper.vm.cachedLabelOptions = [ + { Name: "hello-cat", UID: "lbl-hc-canonical" }, + { Name: "Mountain", UID: "lbl-mountain" }, + ]; + + // hello-cat normalizes to the same key as the assigned `Hello Cat`. + expect(wrapper.vm.labelOptions.map((l) => l.Name)).toEqual(["Mountain"]); + }); + + it("sorts the surviving options alphabetically", () => { + const { wrapper } = mountPhotoLabels(); + wrapper.vm.cachedLabelOptions = [ + { Name: "Mountain", UID: "1" }, + { Name: "apple", UID: "2" }, + { Name: "Beach", UID: "3" }, + ]; + + // Locale-aware compare with sensitivity:base treats case as + // equivalent — `apple` sorts above `Beach` above `Mountain`. + expect(wrapper.vm.labelOptions.map((l) => l.Name)).toEqual(["apple", "Beach", "Mountain"]); + }); }); describe("activateLabel", () => { diff --git a/frontend/tests/vitest/component/photo/people-tab.test.js b/frontend/tests/vitest/component/photo/people-tab.test.js index f63bce6f0..03c4e17e3 100644 --- a/frontend/tests/vitest/component/photo/people-tab.test.js +++ b/frontend/tests/vitest/component/photo/people-tab.test.js @@ -1,7 +1,8 @@ import { describe, it, expect, vi, beforeEach, afterEach } from "vitest"; -import { mount } from "@vue/test-utils"; +import { mount, flushPromises } from "@vue/test-utils"; import PeopleTab from "component/photo/edit/people.vue"; import Subject from "model/subject"; +import typeaheadCache from "common/typeahead-cache"; import { Marker } from "model/marker"; describe("PTabPhotoPeople face actions", () => { @@ -21,13 +22,18 @@ describe("PTabPhotoPeople face actions", () => { }, ]; - beforeEach(() => { + beforeEach(async () => { setCoverSpy = vi.spyOn(Subject.prototype, "setCover").mockImplementation(function (thumb) { this.Thumb = thumb; this.ThumbSrc = "manual"; return Promise.resolve(this); }); + // created() loads name suggestions from the people cache; resolve it + // deterministically so findPerson() sees the seeded people. + typeaheadCache.clear(); + vi.spyOn(typeaheadCache, "getPeople").mockResolvedValue(mockPeople); + openUrlSpy = vi.fn(); assignedMarker = new Marker({ @@ -74,6 +80,9 @@ describe("PTabPhotoPeople face actions", () => { }, $util: { openUrl: openUrlSpy, + // PActionMenu reads this in data(); keep the $util mock complete so + // the suite does not depend on PActionMenu being stubbed to hide it. + shouldOpenOnHover: vi.fn(() => false), }, $view: { getData: vi.fn(() => ({ @@ -98,6 +107,9 @@ describe("PTabPhotoPeople face actions", () => { }; return subject; }); + + // Let created()'s loadPeople() resolve so wrapper.vm.people === mockPeople. + await flushPromises(); }); afterEach(() => { @@ -155,8 +167,6 @@ describe("PTabPhotoPeople face actions", () => { expect(wrapper.vm.$notify.blockUI).toHaveBeenCalledWith("busy"); expect(setCoverSpy).toHaveBeenCalledWith("hash-1234"); - expect(wrapper.vm.$config.values.people[0].Thumb).toBe("hash-1234"); - expect(wrapper.vm.$config.values.people[0].ThumbSrc).toBe("manual"); expect(wrapper.vm.$notify.success).toHaveBeenCalledWith("Person cover updated"); expect(wrapper.vm.busy).toBe(false); }); diff --git a/frontend/tests/vitest/component/service/edit.test.js b/frontend/tests/vitest/component/service/edit.test.js new file mode 100644 index 000000000..305c1ce72 --- /dev/null +++ b/frontend/tests/vitest/component/service/edit.test.js @@ -0,0 +1,150 @@ +import { describe, it, expect, vi } from "vitest"; +import "../../fixtures"; +import { shallowMount } from "@vue/test-utils"; +import PServiceEdit from "component/service/edit.vue"; + +// Builds a stand-in for a Service model. The dialog mutates fields via +// v-model bindings (template) and via this.model.X = … (script) on a +// caller-supplied clone, then calls model.update() in save(). Tests +// verify the prop-rename + computed-alias contract: writes through +// the `model` computed land on the underlying `service` prop, and +// reassigning the prop reactively re-targets the alias. +function buildService(overrides = {}) { + return { + UID: "svc-1", + AccName: "Original Account", + AccType: "webdav", + AccShare: false, + AccSync: false, + SharePath: "/", + ShareSize: "fit_2048", + ShareExpires: 0, + SyncPath: "/", + SyncStatus: "", + update: vi.fn().mockResolvedValue(undefined), + ...overrides, + }; +} + +function mountEdit(props = {}) { + return shallowMount(PServiceEdit, { + props: { + visible: false, + scope: "", + service: buildService(), + ...props, + }, + global: { + mocks: { + $config: { + get: () => false, + values: {}, + }, + $view: { enter: vi.fn(), leave: vi.fn() }, + $notify: { success: vi.fn(), error: vi.fn(), busy: vi.fn() }, + }, + }, + }); +} + +describe("component/service/edit", () => { + describe("model computed alias", () => { + it("aliases the service prop so v-model bindings write through to the same object", () => { + const service = buildService(); + const wrapper = mountEdit({ service }); + + // Vue 3 wraps prop objects in a reactive Proxy, so wrapper.vm.model + // is not strictly === the literal `service` reference. The contract + // we care about is "writes through this.model land on the underlying + // service object" — assert it via mutation flow rather than identity. + wrapper.vm.model.AccShare = true; + wrapper.vm.model.SharePath = "/uploads"; + expect(service.AccShare).toBe(true); + expect(service.SharePath).toBe("/uploads"); + }); + + it("reactively re-targets when the parent reassigns the service prop", async () => { + const first = buildService({ UID: "svc-1", AccName: "First" }); + const wrapper = mountEdit({ service: first }); + expect(wrapper.vm.model.AccName).toBe("First"); + + // services.vue does `this.model = service.clone()` per dialog open; + // the dialog stays mounted, so it must pick up the new prop value. + const second = buildService({ UID: "svc-2", AccName: "Second" }); + await wrapper.setProps({ service: second }); + + expect(wrapper.vm.model.UID).toBe("svc-2"); + expect(wrapper.vm.model.AccName).toBe("Second"); + + // Writes after the swap must now flow to `second`, not `first`. + wrapper.vm.model.AccShare = true; + expect(second.AccShare).toBe(true); + expect(first.AccShare).toBe(false); + }); + }); + + describe("save / confirm / disable / enable", () => { + it("save() calls service.update() and clears loading on success", async () => { + const service = buildService(); + const wrapper = mountEdit({ service }); + + await wrapper.vm.save(); + + expect(service.update).toHaveBeenCalledTimes(1); + expect(wrapper.vm.loading).toBe(false); + expect(wrapper.vm.$notify.success).toHaveBeenCalledTimes(1); + }); + + it("save() short-circuits with $notify.busy when already loading", async () => { + const service = buildService(); + const wrapper = mountEdit({ service }); + + wrapper.vm.loading = true; + wrapper.vm.save(); + + expect(service.update).not.toHaveBeenCalled(); + expect(wrapper.vm.$notify.busy).toHaveBeenCalledTimes(1); + }); + + it("confirm() flips AccShare on the underlying service and calls update", async () => { + const service = buildService({ AccShare: false }); + const wrapper = mountEdit({ service }); + + await wrapper.vm.confirm(); + + expect(service.AccShare).toBe(true); + expect(service.update).toHaveBeenCalledTimes(1); + }); + + it("disable(prop) sets the property to false and saves", async () => { + const service = buildService({ AccShare: true }); + const wrapper = mountEdit({ service }); + + await wrapper.vm.disable("AccShare"); + + expect(service.AccShare).toBe(false); + expect(service.update).toHaveBeenCalledTimes(1); + }); + + it("enable(prop) sets the property to true without auto-saving", () => { + const service = buildService({ AccShare: false }); + const wrapper = mountEdit({ service }); + + wrapper.vm.enable("AccShare"); + + expect(service.AccShare).toBe(true); + expect(service.update).not.toHaveBeenCalled(); + }); + }); + + describe("emits declaration", () => { + // Pin the emits surface so removing a declared event is a visible diff. + // The actual emit-call assertions live in the parent's integration tests + // (settings/services); this codebase's vitest setup does not capture + // component-level $emit() calls in wrapper.emitted() reliably. + it("declares close, remove, and confirm as the dialog's outbound events", () => { + const declared = PServiceEdit.emits || []; + expect(declared).toEqual(expect.arrayContaining(["close", "remove", "confirm"])); + }); + }); +}); diff --git a/frontend/tests/vitest/component/settings/general.test.js b/frontend/tests/vitest/component/settings/general.test.js new file mode 100644 index 000000000..f817de40a --- /dev/null +++ b/frontend/tests/vitest/component/settings/general.test.js @@ -0,0 +1,91 @@ +import { describe, it, expect, vi, beforeEach, afterEach } from "vitest"; +import { shallowMount, flushPromises } from "@vue/test-utils"; +import PSettingsGeneral from "page/settings/general.vue"; + +function makeSettings() { + return { + ui: { + theme: "default", + language: "en", + timeZone: "Local", + startPage: "default", + scrollbar: true, + zoom: false, + openOnHover: true, + reduceMotion: false, + }, + maps: { style: "", animate: 0 }, + features: { places: false, download: true }, + search: { batchSize: -1 }, + }; +} + +function mountGeneral() { + return shallowMount(PSettingsGeneral, { + global: { + mocks: { + $config: { + values: { experimental: false, disable: {}, readonly: false }, + getSettings: () => makeSettings(), + get: () => false, + isDemo: () => false, + isPortal: () => false, + isPublic: () => false, + loading: () => false, + themeName: "default", + load: () => Promise.resolve(), + setSettings: vi.fn(), + }, + $session: { isAdmin: () => true, isSuperAdmin: () => true, hasScope: () => false }, + $event: { subscribe: vi.fn(() => 1), unsubscribe: vi.fn() }, + $notify: { info: vi.fn(), success: vi.fn(), blockUI: vi.fn() }, + $gettext: (s) => s, + $pgettext: (_ctx, s) => s, + $sponsorFeatures: () => Promise.resolve(), + }, + }, + }); +} + +describe("page/settings/general accessibility handlers", () => { + let wrapper; + beforeEach(() => { + wrapper = mountGeneral(); + }); + afterEach(() => { + wrapper.unmount(); + vi.useRealTimers(); + }); + + it("onChangeScrollbar maps the inverted Hide Scrollbar checkbox to ui.scrollbar", () => { + const reload = vi.spyOn(wrapper.vm, "saveAndReload").mockImplementation(() => {}); + wrapper.vm.settings.ui.scrollbar = true; + // "Hide Scrollbar" checked → hide → scrollbar stored as false. + wrapper.vm.onChangeScrollbar(true); + expect(wrapper.vm.settings.ui.scrollbar).toBe(false); + // Unchecked → show → scrollbar stored as true. + wrapper.vm.onChangeScrollbar(false); + expect(wrapper.vm.settings.ui.scrollbar).toBe(true); + expect(reload).toHaveBeenCalledTimes(2); + }); + + it("onChangeZoom triggers a save-and-reload without changing other flags", () => { + const reload = vi.spyOn(wrapper.vm, "saveAndReload").mockImplementation(() => {}); + wrapper.vm.onChangeZoom(); + expect(reload).toHaveBeenCalledTimes(1); + expect(wrapper.vm.settings.ui.scrollbar).toBe(true); + }); + + it("saveAndReload persists the settings and updates the client config", async () => { + // Fake timers keep the deferred window.location.reload() from firing during the test. + vi.useFakeTimers(); + const save = vi.spyOn(wrapper.vm.settings, "save").mockResolvedValue(undefined); + wrapper.vm.saveAndReload(); + expect(wrapper.vm.busy).toBe(true); + await flushPromises(); + expect(save).toHaveBeenCalledTimes(1); + expect(wrapper.vm.$config.setSettings).toHaveBeenCalledTimes(1); + expect(wrapper.vm.$notify.info).toHaveBeenCalled(); + expect(wrapper.vm.$notify.blockUI).toHaveBeenCalled(); + }); +}); diff --git a/frontend/tests/vitest/component/sidebar/info.test.js b/frontend/tests/vitest/component/sidebar/info.test.js deleted file mode 100644 index 0acabdb71..000000000 --- a/frontend/tests/vitest/component/sidebar/info.test.js +++ /dev/null @@ -1,129 +0,0 @@ -import { describe, it, expect, vi, beforeEach } from "vitest"; -import { mount } from "@vue/test-utils"; -import PSidebarInfo from "component/sidebar/info.vue"; -import * as contexts from "options/contexts"; -import { DateTime } from "luxon"; - -// Mock dependencies -vi.mock("component/map.vue", () => ({ - default: { - name: "p-map", - template: "<div class='p-map-stub'></div>", - props: ["lat", "lng"], - }, -})); - -// Mock formats module properly -vi.mock("options/formats", () => ({ - DATETIME_MED: "DATETIME_MED", - DATETIME_MED_TZ: "DATETIME_MED_TZ", -})); - -describe("PSidebarInfo component", () => { - let wrapper; - let originalFromISO; - - const mockModel = { - UID: "abc123", - Title: "Test Title", - Caption: "Test Caption", - TakenAtLocal: "2023-01-01T10:00:00Z", - TimeZone: "UTC", - Lat: 52.52, - Lng: 13.405, - getTypeInfo: vi.fn().mockReturnValue("JPEG, 1920x1080"), - getTypeIcon: vi.fn().mockReturnValue("mdi-file-image"), - getLatLng: vi.fn().mockReturnValue("52.5200, 13.4050"), - copyLatLng: vi.fn(), - }; - - beforeEach(() => { - vi.clearAllMocks(); - - // Store original DateTime.fromISO function - originalFromISO = DateTime.fromISO; - - // Create a mock for DateTime.fromISO - DateTime.fromISO = vi.fn().mockImplementation(() => { - return { - toLocaleString: () => "January 1, 2023, 10:00 AM", - }; - }); - - wrapper = mount(PSidebarInfo, { - props: { - modelValue: mockModel, - context: contexts.Photos, - }, - global: { - stubs: { - PMap: true, - }, - }, - }); - }); - - afterEach(() => { - // Restore original DateTime.fromISO - DateTime.fromISO = originalFromISO; - }); - - it("should render correctly with model data", () => { - expect(wrapper.vm).toBeTruthy(); - expect(wrapper.find(".p-sidebar-info").exists()).toBe(true); - - const html = wrapper.html(); - expect(html).toContain("Test Title"); - expect(html).toContain("Test Caption"); - - expect(mockModel.getTypeInfo).toHaveBeenCalled(); - expect(mockModel.getTypeIcon).toHaveBeenCalled(); - expect(mockModel.getLatLng).toHaveBeenCalled(); - }); - - it("should emit close event when close button is clicked", async () => { - // Try finding close button by various selectors - const closeButtonSelectors = [".close-button", "button[aria-label='Close']", "button[title='Close']"]; - - let closeButton; - for (const selector of closeButtonSelectors) { - closeButton = wrapper.find(selector); - if (closeButton.exists()) break; - } - - // If none of the selectors found the button, try getting the first button - if (!closeButton || !closeButton.exists()) { - const allButtons = wrapper.findAll("button"); - if (allButtons.length > 0) { - closeButton = allButtons[0]; - } - } - - if (closeButton && closeButton.exists()) { - await closeButton.trigger("click"); - expect(wrapper.emitted()).toHaveProperty("close"); - } else { - // If we can't find a button at all, mark this test as pending - console.warn("Could not find close button in component"); - } - }); - - it("should trigger copyLatLng when location is clicked", async () => { - // Find the location item by its class - const clickableItems = wrapper.findAll(".clickable"); - if (clickableItems.length > 0) { - await clickableItems[0].trigger("click"); - expect(mockModel.copyLatLng).toHaveBeenCalled(); - } - }); - - it("should handle model without taken time", () => { - const modelWithoutTime = { - ...mockModel, - TakenAtLocal: null, - }; - - const formattedTime = wrapper.vm.formatTime(modelWithoutTime); - expect(formattedTime).toBe("Unknown"); - }); -}); diff --git a/frontend/tests/vitest/component/upload/dialog.test.js b/frontend/tests/vitest/component/upload/dialog.test.js new file mode 100644 index 000000000..f1380e870 --- /dev/null +++ b/frontend/tests/vitest/component/upload/dialog.test.js @@ -0,0 +1,507 @@ +import { describe, it, expect, vi, beforeEach, afterEach } from "vitest"; +import { mount } from "@vue/test-utils"; +import { nextTick } from "vue"; +import { createVuetify } from "vuetify"; +import * as components from "vuetify/components"; +import * as labsComponents from "vuetify/labs/components"; +import * as directives from "vuetify/directives"; +import PUploadDialog from "component/upload/dialog.vue"; + +// VFileUploadItem calls URL.createObjectURL to build preview src URLs; jsdom does not implement it. +if (typeof URL.createObjectURL === "undefined") { + URL.createObjectURL = () => "blob:mock"; + URL.revokeObjectURL = () => {}; +} + +// Vuetify instance that includes both standard and labs components (for VFileUpload). +const vuetify = createVuetify({ + components: { ...components, ...labsComponents }, + directives, + theme: { defaultTheme: "light" }, +}); + +// Shared file fixture. +const makeFile = (name = "photo.jpg", size = 1024, type = "image/jpeg") => new File(["x".repeat(size)], name, { type }); + +// Stubs for modules that make external calls. +vi.mock("model/album", () => ({ + default: { search: vi.fn(() => Promise.resolve({ models: [] })) }, +})); + +vi.mock("common/albums", () => ({ + createAlbumSelectionWatcher: () => () => {}, +})); + +vi.mock("common/api", () => ({ + default: { + post: vi.fn(() => Promise.resolve({})), + put: vi.fn(() => Promise.resolve({})), + }, +})); + +vi.mock("common/notify", () => ({ + default: { info: vi.fn(), success: vi.fn(), error: vi.fn(), warn: vi.fn() }, +})); + +function buildConfigMock(overrides = {}) { + return { + get: vi.fn((key) => { + if (key === "demo") { + return false; + } + if (key === "uploadAllow") { + return "image/*"; + } + if (key === "uploadNSFW") { + return false; + } + return null; + }), + feature: vi.fn(() => false), + filesQuotaReached: vi.fn(() => false), + storageLow: vi.fn(() => false), + insufficientStorage: vi.fn(() => false), + ...overrides, + }; +} + +function mountDialog({ visible = true, data = {}, configOverrides = {} } = {}) { + return mount(PUploadDialog, { + props: { visible, data }, + attachTo: document.body, + global: { + plugins: [vuetify], + mocks: { + $config: buildConfigMock(configOverrides), + $session: { getUserUID: vi.fn(() => "uid123") }, + $util: { generateToken: vi.fn(() => "tok-abc") }, + $view: { enter: vi.fn(), leave: vi.fn() }, + $notify: { info: vi.fn(), success: vi.fn(), error: vi.fn() }, + $gettext: (msg, params = {}) => msg.replace(/%\{(\w+)\}/g, (_, k) => (params[k] !== undefined ? String(params[k]) : "")), + $isRtl: false, + }, + }, + }); +} + +describe("component/upload/dialog", () => { + let wrapper; + + beforeEach(() => { + wrapper = mountDialog(); + }); + + afterEach(() => { + if (wrapper) { + wrapper.unmount(); + } + vi.clearAllMocks(); + }); + + // ─── Rendering ──────────────────────────────────────────────────────────── + + describe("Rendering", () => { + it("renders the v-file-upload component", () => { + expect(wrapper.findComponent({ name: "VFileUpload" }).exists()).toBe(true); + }); + + it("does not render a hidden native file input", () => { + // The old hidden <input class="input-upload"> should be gone. + expect(wrapper.find("input.input-upload").exists()).toBe(false); + }); + + // v-dialog teleports its content to document.body; query from there. + it("renders the Upload action button in the teleported dialog", () => { + const btn = document.body.querySelector(".action-upload"); + expect(btn).not.toBeNull(); + expect(btn.textContent.trim()).toBe("Upload"); + }); + + it("renders the Close button in the teleported dialog", () => { + expect(document.body.querySelector(".action-close")).not.toBeNull(); + }); + + it("v-file-upload carries the input-file-upload class", () => { + expect(document.body.querySelector(".input-file-upload")).not.toBeNull(); + }); + }); + + // ─── v-file-upload props ────────────────────────────────────────────────── + + describe("v-file-upload binding", () => { + it("passes filterByType from config (the accept value)", () => { + const fu = wrapper.findComponent({ name: "VFileUpload" }); + // accept is mapped to the filterByType prop on VFileUpload. + expect(fu.props("filterByType")).toBe("image/*"); + }); + + it("passes multiple=true", () => { + const fu = wrapper.findComponent({ name: "VFileUpload" }); + expect(fu.props("multiple")).toBe(true); + }); + + it("is disabled when busy is true", async () => { + wrapper.vm.busy = true; + await nextTick(); + const fu = wrapper.findComponent({ name: "VFileUpload" }); + expect(fu.props("disabled")).toBe(true); + }); + + it("is disabled when insufficientStorage is true", async () => { + wrapper.vm.insufficientStorage = true; + await nextTick(); + const fu = wrapper.findComponent({ name: "VFileUpload" }); + expect(fu.props("disabled")).toBe(true); + }); + + it("is initialized as disabled when config reports insufficient storage", () => { + const w = mountDialog({ configOverrides: { insufficientStorage: vi.fn(() => true) } }); + expect(w.vm.insufficientStorage).toBe(true); + const fu = w.findComponent({ name: "VFileUpload" }); + expect(fu.props("disabled")).toBe(true); + }); + + it("is enabled (not disabled) in the default state", () => { + const fu = wrapper.findComponent({ name: "VFileUpload" }); + expect(fu.props("disabled")).toBe(false); + }); + + it("updates selected when v-file-upload emits update:modelValue", async () => { + const fu = wrapper.findComponent({ name: "VFileUpload" }); + const files = [makeFile("a.jpg"), makeFile("b.jpg")]; + await fu.vm.$emit("update:modelValue", files); + await nextTick(); + expect(wrapper.vm.selected).toEqual(files); + }); + }); + + // ─── onFilesSelected — append / remove / dedup ──────────────────────────── + + describe("onFilesSelected()", () => { + it("clears selection when an empty array is emitted", async () => { + wrapper.vm.selected = [makeFile()]; + await nextTick(); + wrapper.vm.onFilesSelected([]); + expect(wrapper.vm.selected).toEqual([]); + }); + + it("appends new files to existing selection on a second browse pass", () => { + const a = makeFile("a.jpg"); + const b = makeFile("b.jpg"); + wrapper.vm.selected = [a]; + // b is a brand-new File object (not in existing by reference) → merge + wrapper.vm.onFilesSelected([b]); + expect(wrapper.vm.selected).toHaveLength(2); + expect(wrapper.vm.selected).toContain(a); + expect(wrapper.vm.selected).toContain(b); + }); + + it("removes a file when the emitted value is a subset of the existing selection", () => { + const a = makeFile("a.jpg"); + const b = makeFile("b.jpg"); + wrapper.vm.selected = [a, b]; + // VFileUploadItem × button emits the remaining files by reference + wrapper.vm.onFilesSelected([b]); + expect(wrapper.vm.selected).toEqual([b]); + }); + + it("skips duplicates identified by name + size + lastModified", () => { + const ts = 1700000000000; + const a = new File(["x".repeat(512)], "a.jpg", { type: "image/jpeg", lastModified: ts }); + wrapper.vm.selected = [a]; + // Second browse produces a different File object but with identical metadata + const aDup = new File(["x".repeat(512)], "a.jpg", { type: "image/jpeg", lastModified: ts }); + wrapper.vm.onFilesSelected([aDup]); + expect(wrapper.vm.selected).toHaveLength(1); + }); + + it("handles a non-array (single File) emitted value by wrapping it", () => { + const f = makeFile("single.jpg"); + wrapper.vm.onFilesSelected(f); + expect(wrapper.vm.selected).toContain(f); + }); + }); + + // ─── hasFiles computed ───────────────────────────────────────────────────── + + describe("hasFiles computed", () => { + it("is false when no files are selected", () => { + expect(wrapper.vm.hasFiles).toBe(false); + }); + + it("is true when at least one file is selected", async () => { + wrapper.vm.selected = [makeFile()]; + await nextTick(); + expect(wrapper.vm.hasFiles).toBe(true); + }); + + it("returns false after selected is reset to empty array", async () => { + wrapper.vm.selected = [makeFile()]; + await nextTick(); + wrapper.vm.selected = []; + await nextTick(); + expect(wrapper.vm.hasFiles).toBe(false); + }); + + it("returns false when selected is not an array", async () => { + wrapper.vm.selected = null; + await nextTick(); + expect(wrapper.vm.hasFiles).toBe(false); + }); + }); + + // ─── Upload button enabled/disabled ─────────────────────────────────────── + + describe("Upload button disabled state", () => { + it("is disabled with no files selected (hasFiles=false)", () => { + expect(wrapper.vm.hasFiles).toBe(false); + }); + + it("reflects hasFiles=true once a file is selected", async () => { + wrapper.vm.selected = [makeFile()]; + await nextTick(); + expect(wrapper.vm.hasFiles).toBe(true); + }); + + it("busy overrides hasFiles for the disabled calculation", async () => { + wrapper.vm.selected = [makeFile()]; + wrapper.vm.busy = true; + await nextTick(); + expect(wrapper.vm.busy).toBe(true); + }); + }); + + // ─── onUpload() guards ──────────────────────────────────────────────────── + + describe("onUpload() — no files selected", () => { + it("does not set busy when selected is empty", () => { + wrapper.vm.selected = []; + wrapper.vm.onUpload(); + expect(wrapper.vm.busy).toBe(false); + }); + }); + + describe("onUpload() — already busy", () => { + it("returns without changing total when already busy", () => { + wrapper.vm.busy = true; + wrapper.vm.selected = [makeFile()]; + const prevTotal = wrapper.vm.total; + wrapper.vm.onUpload(); + expect(wrapper.vm.total).toBe(prevTotal); + }); + }); + + describe("onUpload() — demo file limit", () => { + it("shows error and skips upload when too many files in demo mode", async () => { + const $notify = (await import("common/notify")).default; + const demoWrapper = mountDialog(); + demoWrapper.vm.isDemo = true; + demoWrapper.vm.fileLimit = 3; + demoWrapper.vm.selected = [makeFile("1.jpg"), makeFile("2.jpg"), makeFile("3.jpg"), makeFile("4.jpg")]; + + demoWrapper.vm.onUpload(); + + expect(demoWrapper.vm.busy).toBe(false); + expect($notify.error).toHaveBeenCalledWith("Too many files selected"); + demoWrapper.unmount(); + }); + }); + + // ─── onUpload() — starts upload ─────────────────────────────────────────── + + describe("onUpload() — starts upload", () => { + it("sets busy and initialises total and totalSize", () => { + wrapper.vm.selected = [makeFile("a.jpg", 500), makeFile("b.jpg", 300)]; + wrapper.vm.onUpload(); + + expect(wrapper.vm.busy).toBe(true); + expect(wrapper.vm.total).toBe(2); + expect(wrapper.vm.totalSize).toBe(800); + }); + + it("uses generateToken to set the upload token", () => { + wrapper.vm.selected = [makeFile()]; + wrapper.vm.onUpload(); + expect(wrapper.vm.token).toBe("tok-abc"); + }); + + it("resets eta and remainingTime at start", () => { + wrapper.vm.selected = [makeFile()]; + wrapper.vm.eta = "2 minutes"; + wrapper.vm.remainingTime = 120; + wrapper.vm.onUpload(); + expect(wrapper.vm.eta).toBe(""); + expect(wrapper.vm.remainingTime).toBe(-1); + }); + }); + + // ─── reset() ───────────────────────────────────────────────────────────── + + describe("reset()", () => { + it("clears selected files", () => { + wrapper.vm.selected = [makeFile()]; + wrapper.vm.reset(); + expect(wrapper.vm.selected).toEqual([]); + }); + + it("resets busy, total, and token", () => { + Object.assign(wrapper.vm, { busy: true, total: 5, token: "x" }); + wrapper.vm.reset(); + expect(wrapper.vm.busy).toBe(false); + expect(wrapper.vm.total).toBe(0); + expect(wrapper.vm.token).toBe(""); + }); + + it("resets all size and progress counters", () => { + Object.assign(wrapper.vm, { + completedTotal: 80, + completedSize: 400, + totalSize: 500, + totalFailed: 1, + }); + wrapper.vm.reset(); + expect(wrapper.vm.completedTotal).toBe(0); + expect(wrapper.vm.completedSize).toBe(0); + expect(wrapper.vm.totalSize).toBe(0); + expect(wrapper.vm.totalFailed).toBe(0); + }); + }); + + // ─── onClose() ─────────────────────────────────────────────────────────── + + describe("onClose()", () => { + it("invokes the onClose handler when not busy", () => { + // Pass an event-listener prop (Vue 3 idiomatic alternative to wrapper.emitted()). + const onClose = vi.fn(); + const w = mountDialog({ visible: true }); + // Inject the handler after mount so we can observe call count. + w.vm.$props; // touch props to ensure reactivity is set up + w.vm.busy = false; + // Attach via the component's onClose prop path by mounting a fresh wrapper. + const w2 = mount(PUploadDialog, { + props: { visible: true, data: {}, onClose }, + attachTo: document.body, + global: { + plugins: [vuetify], + mocks: { + $config: buildConfigMock(), + $session: { getUserUID: vi.fn(() => "uid123") }, + $util: { generateToken: vi.fn(() => "tok-abc") }, + $view: { enter: vi.fn(), leave: vi.fn() }, + $notify: { info: vi.fn(), success: vi.fn(), error: vi.fn() }, + $gettext: (msg, params = {}) => msg.replace(/%\{(\w+)\}/g, (_, k) => (params[k] !== undefined ? String(params[k]) : "")), + $isRtl: false, + }, + }, + }); + w2.vm.busy = false; + w2.vm.onClose(); + expect(onClose).toHaveBeenCalledOnce(); + w.unmount(); + w2.unmount(); + }); + + it("does not invoke the onClose handler when busy", () => { + const onClose = vi.fn(); + const w2 = mount(PUploadDialog, { + props: { visible: true, data: {}, onClose }, + attachTo: document.body, + global: { + plugins: [vuetify], + mocks: { + $config: buildConfigMock(), + $session: { getUserUID: vi.fn(() => "uid123") }, + $util: { generateToken: vi.fn(() => "tok-abc") }, + $view: { enter: vi.fn(), leave: vi.fn() }, + $notify: { info: vi.fn(), success: vi.fn(), error: vi.fn() }, + $gettext: (msg, params = {}) => msg.replace(/%\{(\w+)\}/g, (_, k) => (params[k] !== undefined ? String(params[k]) : "")), + $isRtl: false, + }, + }, + }); + w2.vm.busy = true; + w2.vm.onClose(); + expect(onClose).not.toHaveBeenCalled(); + w2.unmount(); + }); + }); + + // ─── onUploadProgress() ─────────────────────────────────────────────────── + + describe("onUploadProgress()", () => { + it("ignores events with missing loaded or total", () => { + wrapper.vm.totalSize = 1000; + wrapper.vm.onUploadProgress({}); + expect(wrapper.vm.completedTotal).toBe(0); + }); + + it("does not update when loaded >= total", () => { + wrapper.vm.totalSize = 1000; + wrapper.vm.completedSize = 0; + wrapper.vm.started = Date.now() - 1000; + wrapper.vm.onUploadProgress({ loaded: 1000, total: 1000 }); + // loaded < total is required; at equality the branch is skipped. + expect(wrapper.vm.completedTotal).toBe(0); + }); + + it("updates completedTotal proportionally", () => { + wrapper.vm.totalSize = 1000; + wrapper.vm.completedSize = 0; + wrapper.vm.started = Date.now() - 1000; + wrapper.vm.onUploadProgress({ loaded: 400, total: 1000 }); + expect(wrapper.vm.completedTotal).toBeGreaterThan(0); + expect(wrapper.vm.completedTotal).toBeLessThanOrEqual(40); + }); + }); + + // ─── onUploadComplete() ─────────────────────────────────────────────────── + + describe("onUploadComplete()", () => { + it("ignores a null file", () => { + wrapper.vm.completedSize = 0; + wrapper.vm.onUploadComplete(null); + expect(wrapper.vm.completedSize).toBe(0); + }); + + it("ignores a file with no size", () => { + wrapper.vm.completedSize = 0; + wrapper.vm.onUploadComplete({ size: 0 }); + expect(wrapper.vm.completedSize).toBe(0); + }); + + it("accumulates completedSize and updates completedTotal", () => { + wrapper.vm.totalSize = 2000; + wrapper.vm.completedSize = 0; + wrapper.vm.onUploadComplete({ size: 750 }); + expect(wrapper.vm.completedSize).toBe(750); + expect(wrapper.vm.completedTotal).toBe(37); + }); + }); + + // ─── visible watcher ───────────────────────────────────────────────────── + + describe("visible watcher", () => { + it("calls reset when dialog becomes hidden", async () => { + const spy = vi.spyOn(wrapper.vm, "reset"); + await wrapper.setProps({ visible: false }); + expect(spy).toHaveBeenCalled(); + }); + + it("pre-populates selectedAlbums from data.albums when shown", async () => { + const albums = [{ UID: "u1", Title: "Holiday" }]; + const w = mountDialog({ visible: false, data: { albums } }); + await w.setProps({ visible: true }); + await nextTick(); + expect(w.vm.selectedAlbums).toEqual(albums); + w.unmount(); + }); + }); + + // ─── title computed ─────────────────────────────────────────────────────── + + describe("title computed", () => { + it("returns Upload", () => { + expect(wrapper.vm.title).toBe("Upload"); + }); + }); +}); diff --git a/frontend/tests/vitest/config.js b/frontend/tests/vitest/config.js index f72512eac..274fe7ee0 100644 --- a/frontend/tests/vitest/config.js +++ b/frontend/tests/vitest/config.js @@ -4,7 +4,7 @@ const clientConfig = { about: "PhotoPrism® CE", edition: "ce", version: "210710-bae1f2d7-Linux-x86_64-DEBUG", - copyright: "(c) 2018-2025 PhotoPrism UG. All rights reserved.", + copyright: "(c) 2018-2026 PhotoPrism UG. All rights reserved.", flags: "public debug develop experimental settings", baseUri: "", frontendUri: "/library", @@ -14,6 +14,7 @@ const clientConfig = { contentUri: "/api/v1", siteUrl: "http://localhost:2342/", sitePreview: "http://localhost:2342/static/img/preview.jpg", + siteName: "Acme Media", siteTitle: "PhotoPrism", siteCaption: "AI-Powered Photos App", siteDescription: "Open-Source Photo Management", diff --git a/frontend/tests/vitest/fixtures.js b/frontend/tests/vitest/fixtures.js index e2013a0ca..3c4cd5aeb 100644 --- a/frontend/tests/vitest/fixtures.js +++ b/frontend/tests/vitest/fixtures.js @@ -50,6 +50,9 @@ Mock.onDelete("api/v1/foo/2").reply(204, deleteEntityResponse, mockHeaders); Mock.onGet("api/v1/error").reply(401, "custom error cat", mockHeaders); Mock.onPost("api/v1/batch/photos/archive").reply(200, { photos: [1, 3] }, mockHeaders); +Mock.onPost("api/v1/batch/photos/restore").reply(200, { photos: [1, 3] }, mockHeaders); +Mock.onDelete(/^albums\/[A-Za-z0-9_-]+\/photos$/).reply(200, { Success: "ok" }, mockHeaders); +Mock.onPost(/^albums\/[A-Za-z0-9_-]+\/photos$/).reply(200, { Success: "ok" }, mockHeaders); Mock.onPost("api/v1/photos/pqbemz8276mhtobh/approve").reply(200, {}, mockHeaders); Mock.onPost("api/v1/photos/pqbemz8276mhtobh/files/fqbfk181n4ca5sud/primary").reply( 200, diff --git a/frontend/tests/vitest/helpers/jsdom-quiet.js b/frontend/tests/vitest/helpers/jsdom-quiet.js new file mode 100644 index 000000000..4fc55118b --- /dev/null +++ b/frontend/tests/vitest/helpers/jsdom-quiet.js @@ -0,0 +1,81 @@ +// Quiet jsdom's known false-positive CSS-parser warnings on +// Vuetify-flavored stylesheets, regardless of where the stylesheet +// is authored. Vuetify components, the Vuetify base styles, and +// PhotoPrism's own CSS all share the same surface (`.v-application`, +// `.v-overlay`, `--v-theme-*`, ...), and jsdom's parser rejects the +// modern rules they use (e.g. @layer, container queries, @scope) the +// same way in all of them. This module treats those warnings as a +// single category of noise and suppresses them across that surface. +// +// jsdom 29 emits a `jsdomError` of `type: "css-parsing"` whenever its +// CSS parser rejects a rule. The default +// `(new VirtualConsole()).forwardTo(console)` forwarder writes a bare +// "Could not parse CSS stylesheet" line per occurrence, with no +// origin, no offending text, and no parser stack — so it cannot point +// to a real regression even when one exists. +// +// This module replaces that default forwarder with one that: +// - Drops "css-parsing" errors whose stylesheet text contains any +// Vuetify-flavored marker (the surface jsdom is known to reject +// non-actionably). The check is heuristic and intentionally broad +// enough to cover Vuetify, Vuetify-derived components, and our +// own Vuetify-themed styles. +// - For every other "css-parsing" error (i.e. CSS that doesn't even +// touch the Vuetify surface), prints the message AND the +// underlying parser cause, so an unrelated regression surfaces +// with strictly more detail than the default forwarder produced. +// - Forwards non-CSS jsdomErrors using the same shape as jsdom 29's +// default forwardTo handler. +// +// Why this reaches into `window._virtualConsole`: Vitest does not +// expose a hook for the JSDOM virtualConsole. The documented config +// path (`environmentOptions.jsdom.virtualConsole`) is unusable under +// `pool: "vmForks"` because options are sent to the worker via +// structured clone and a VirtualConsole instance is not cloneable +// (its EventEmitter listeners are functions). Mutating +// `window._virtualConsole` after JSDOM initialization is a test-only +// workaround and is acknowledged here as such. +// +// MUST be imported before any module that loads CSS so the filter is +// installed when vitest injects stylesheets at import-evaluation time. + +// Substrings whose presence in a stylesheet's text means the warning +// is from the Vuetify-flavored surface jsdom rejects non-actionably. +// Matching is by inclusion, not authorship — PhotoPrism CSS that +// extends Vuetify will (correctly) match. +const VUETIFY_FLAVORED_MARKERS = ["--v-theme-", "--v-medium-emphasis-opacity", ".v-application", ".v-locale-provider", ".v-overlay"]; + +function hasVuetifyFlavoredMarker(text) { + if (typeof text !== "string" || text.length === 0) { + return false; + } + for (const marker of VUETIFY_FLAVORED_MARKERS) { + if (text.includes(marker)) { + return true; + } + } + return false; +} + +if (typeof window !== "undefined" && window._virtualConsole) { + const vc = window._virtualConsole; + vc.removeAllListeners("jsdomError"); + vc.on("jsdomError", (err) => { + if (!err) { + return; + } + if (err.type === "css-parsing") { + if (hasVuetifyFlavoredMarker(err.sheetText)) { + return; + } + const cause = err.cause && err.cause.stack ? `\n${err.cause.stack}` : ""; + console.error(`${err.message}${cause}`); + return; + } + if (err.type === "unhandled-exception" && err.cause) { + console.error(err.cause.stack); + return; + } + console.error(err.message); + }); +} diff --git a/frontend/tests/vitest/helpers/jsdom-quiet.test.js b/frontend/tests/vitest/helpers/jsdom-quiet.test.js new file mode 100644 index 000000000..7be789284 --- /dev/null +++ b/frontend/tests/vitest/helpers/jsdom-quiet.test.js @@ -0,0 +1,78 @@ +import { describe, it, expect, vi, beforeEach, afterEach } from "vitest"; + +// Imported for its side effect: installs the jsdomError filter on +// window._virtualConsole. Already loaded transitively by setup.js, but +// we re-import here for clarity. +import "./jsdom-quiet"; + +describe("helpers/jsdom-quiet", () => { + let errorSpy; + + beforeEach(() => { + errorSpy = vi.spyOn(console, "error").mockImplementation(() => {}); + }); + + afterEach(() => { + errorSpy.mockRestore(); + }); + + function emit(error) { + window._virtualConsole.emit("jsdomError", error); + } + + function makeError({ type, message, sheetText, cause } = {}) { + const e = new Error(message ?? "boom"); + if (type !== undefined) { + e.type = type; + } + if (sheetText !== undefined) { + e.sheetText = sheetText; + } + if (cause !== undefined) { + e.cause = cause; + } + return e; + } + + it("drops css-parsing errors when the stylesheet contains Vuetify-flavored markers", () => { + // Stylesheets on the Vuetify surface — whether shipped by Vuetify + // itself or authored in PhotoPrism — are recognized by their + // selectors / custom properties and treated as the same noise. + emit( + makeError({ + type: "css-parsing", + message: "Could not parse CSS stylesheet", + sheetText: ".v-application { --v-theme-primary: 0,0,0; }", + cause: new Error("rule parse failed"), + }) + ); + expect(errorSpy).not.toHaveBeenCalled(); + }); + + it("logs css-parsing errors when the stylesheet has no Vuetify markers, including the underlying cause", () => { + const cause = new Error("rule parse failed"); + emit( + makeError({ + type: "css-parsing", + message: "Could not parse CSS stylesheet", + sheetText: ".photoprism-foo { color: red; }", + cause, + }) + ); + expect(errorSpy).toHaveBeenCalledTimes(1); + const arg = errorSpy.mock.calls[0][0]; + expect(arg).toContain("Could not parse CSS stylesheet"); + expect(arg).toContain(cause.stack); + }); + + it("logs unhandled-exception jsdomErrors via the cause stack", () => { + const cause = new Error("inner"); + emit(makeError({ type: "unhandled-exception", cause })); + expect(errorSpy).toHaveBeenCalledWith(cause.stack); + }); + + it("logs other jsdomErrors via err.message", () => { + emit(makeError({ message: "something else" })); + expect(errorSpy).toHaveBeenCalledWith("something else"); + }); +}); diff --git a/frontend/tests/vitest/model/album.test.js b/frontend/tests/vitest/model/album.test.js index a5481fba7..1115f6328 100644 --- a/frontend/tests/vitest/model/album.test.js +++ b/frontend/tests/vitest/model/album.test.js @@ -1,6 +1,6 @@ import { describe, it, expect, beforeEach, afterEach } from "vitest"; import "../fixtures"; -import { Album, BatchSize } from "model/album"; +import { Album, BatchSize, MaxLength } from "model/album"; describe("model/album", () => { let originalBatchSize; @@ -13,6 +13,42 @@ describe("model/album", () => { Album.setBatchSize(originalBatchSize); }); + // Pins per-field caps to the backend VARCHAR columns on internal/entity/album.go + // so client-side validation moves in lockstep with the server. + it("MaxLength mirrors the backend VARCHAR caps", () => { + expect(MaxLength).toEqual({ + Title: 160, + Location: 160, + Caption: 1024, + Description: 2048, + }); + expect(Object.isFrozen(MaxLength)).toBe(true); + }); + + // trimInputs mutates the model so post-save the user reads exactly what + // the backend stored; the override fires before getValues() on the + // PUT/POST path. Non-string and unknown fields pass through untouched. + it("trimInputs() strips leading and trailing whitespace from MaxLength string fields", () => { + const album = new Album({ + Title: " Vacation ", + Location: "\tBerlin\n", + Caption: " Sunny day ", + Description: " ", + Slug: " untouched ", + Favorite: true, + }); + + album.trimInputs(); + + expect(album.Title).toBe("Vacation"); + expect(album.Location).toBe("Berlin"); + expect(album.Caption).toBe("Sunny day"); + expect(album.Description).toBe(""); + // Slug isn't in MaxLength and Favorite isn't a string — both pass through. + expect(album.Slug).toBe(" untouched "); + expect(album.Favorite).toBe(true); + }); + it("should get route view", () => { const values = { ID: 5, Title: "Christmas 2019", Slug: "christmas-2019" }; const album = new Album(values); diff --git a/frontend/tests/vitest/model/face.test.js b/frontend/tests/vitest/model/face.test.js index 13c974c98..992316c51 100644 --- a/frontend/tests/vitest/model/face.test.js +++ b/frontend/tests/vitest/model/face.test.js @@ -1,6 +1,7 @@ -import { describe, it, expect, beforeEach, afterEach } from "vitest"; +import { describe, it, expect, beforeEach, afterEach, vi } from "vitest"; import "../fixtures"; import { Face, BatchSize } from "model/face"; +import typeaheadCache from "common/typeahead-cache"; describe("model/face", () => { let originalBatchSize; @@ -152,6 +153,23 @@ describe("model/face", () => { expect(response2.Name).toBe("testname"); }); + it("should seed the people typeahead cache after saving a name", async () => { + const spy = vi.spyOn(typeaheadCache, "upsertPerson"); + const face = new Face({ ID: "f123ghytrfggd", Samples: 5, MarkerUID: "mDC123ghytr", Name: "Jane" }); + await face.setName("testname"); + expect(spy).toHaveBeenCalledTimes(1); + expect(spy.mock.calls[0][0]).toMatchObject({ Name: "testname" }); + spy.mockRestore(); + }); + + it("should not seed the cache when the name is empty", async () => { + const spy = vi.spyOn(typeaheadCache, "upsertPerson"); + const face = new Face({ ID: "f123ghytrfggd", Samples: 5, MarkerUID: "mDC123ghytr", Name: "Jane" }); + await face.setName(""); + expect(spy).not.toHaveBeenCalled(); + spy.mockRestore(); + }); + it("should return batch size", () => { expect(Face.batchSize()).toBe(BatchSize); Face.setBatchSize(30); diff --git a/frontend/tests/vitest/model/file.test.js b/frontend/tests/vitest/model/file.test.js index a3cfbaf54..23ed734dc 100644 --- a/frontend/tests/vitest/model/file.test.js +++ b/frontend/tests/vitest/model/file.test.js @@ -269,6 +269,25 @@ describe("model/file", () => { }; const file = new File(values); expect(file.isAnimated()).toBe(true); + expect(typeof file.isAnimated()).toBe("boolean"); + }); + + // A10 contract: isAnimated() must return a Boolean for every input shape, + // so a future binding to a Vuetify Boolean prop never short-circuits to 0. + it("isAnimated returns Boolean false for an image with no frames or duration", () => { + const file = new File({ MediaType: "image", Frames: 0, Duration: 0 }); + const result = file.isAnimated(); + expect(typeof result).toBe("boolean"); + expect(result).toBe(false); + }); + it("isAnimated returns Boolean false for non-image media types", () => { + expect(new File({ MediaType: "video", Duration: 5000 }).isAnimated()).toBe(false); + expect(new File({ MediaType: "", Duration: 5000 }).isAnimated()).toBe(false); + expect(typeof new File({ MediaType: "video" }).isAnimated()).toBe("boolean"); + }); + it("isAnimated returns Boolean true for a multi-frame image", () => { + const file = new File({ MediaType: "image", Frames: 5, Duration: 0 }); + expect(file.isAnimated()).toBe(true); }); it("should get type info", () => { diff --git a/frontend/tests/vitest/model/label.test.js b/frontend/tests/vitest/model/label.test.js index 913f1dda1..2a12ed9f4 100644 --- a/frontend/tests/vitest/model/label.test.js +++ b/frontend/tests/vitest/model/label.test.js @@ -1,6 +1,6 @@ import { describe, it, expect, beforeEach, afterEach } from "vitest"; import "../fixtures"; -import { Label, BatchSize } from "model/label"; +import { Label, BatchSize, MaxLength } from "model/label"; describe("model/label", () => { let originalBatchSize; @@ -13,6 +13,26 @@ describe("model/label", () => { Label.setBatchSize(originalBatchSize); }); + // Pins per-field caps to the backend VARCHAR columns on internal/entity/label.go. + // A backend bump must move the frontend cap in lockstep so client-side + // validation matches what the server persists. + it("MaxLength mirrors the backend VARCHAR caps", () => { + expect(MaxLength).toEqual({ + Name: 160, + Description: 2048, + Notes: 1024, + }); + expect(Object.isFrozen(MaxLength)).toBe(true); + }); + + it("trimInputs() strips whitespace from MaxLength string fields", () => { + const label = new Label({ Name: " Cat ", Description: "\tfluffy\n", Notes: " " }); + label.trimInputs(); + expect(label.Name).toBe("Cat"); + expect(label.Description).toBe("fluffy"); + expect(label.Notes).toBe(""); + }); + it("should get route view", () => { const values = { ID: 5, UID: "ABC123", Name: "Black Cat", Slug: "black-cat" }; const label = new Label(values); diff --git a/frontend/tests/vitest/model/marker.test.js b/frontend/tests/vitest/model/marker.test.js index ae8d5a48c..c9f254dda 100644 --- a/frontend/tests/vitest/model/marker.test.js +++ b/frontend/tests/vitest/model/marker.test.js @@ -1,6 +1,7 @@ -import { describe, it, expect, beforeEach, afterEach } from "vitest"; +import { describe, it, expect, beforeEach, afterEach, vi } from "vitest"; import "../fixtures"; import { Marker, BatchSize } from "model/marker"; +import typeaheadCache from "common/typeahead-cache"; describe("model/marker", () => { let originalBatchSize; @@ -19,6 +20,17 @@ describe("model/marker", () => { const result = marker.getDefaults(); expect(result.UID).toBe(""); expect(result.FileUID).toBe(""); + // Frontend-instantiated markers are always manual (user-drawn) — backend + // markers overwrite Src via setValues() when they arrive from the API. + expect(result.Src).toBe("manual"); + }); + + it("should default Src to 'manual' when constructed without values", () => { + // getDefaults is only applied when no values are passed to the + // constructor; manual markers in lightbox.onCreateFaceMarker pass + // Src explicitly, but the default guards the no-argument code path. + const marker = new Marker(); + expect(marker.Src).toBe("manual"); }); it("should get route view", () => { @@ -184,6 +196,23 @@ describe("model/marker", () => { expect(response.success).toBe("ok"); }); + it("should seed the people typeahead cache after saving a name", async () => { + const spy = vi.spyOn(typeaheadCache, "upsertPerson"); + const marker = new Marker({ UID: "mDC123ghytr", FileUID: "fhjouohnnmnd", Type: "face", Src: "image", Name: "testname", SubjSrc: "manual" }); + await marker.setName(); + expect(spy).toHaveBeenCalledTimes(1); + expect(spy.mock.calls[0][0]).toMatchObject({ Name: "testname" }); + spy.mockRestore(); + }); + + it("should not seed the cache when the name is empty", async () => { + const spy = vi.spyOn(typeaheadCache, "upsertPerson"); + const marker = new Marker({ UID: "mDC123ghytr", FileUID: "fhjouohnnmnd", Type: "face", Src: "image", Name: "", SubjSrc: "manual" }); + await marker.setName(); + expect(spy).not.toHaveBeenCalled(); + spy.mockRestore(); + }); + it("should clear subject", async () => { const values = { UID: "mEC123ghytr", diff --git a/frontend/tests/vitest/model/model-cache.test.js b/frontend/tests/vitest/model/model-cache.test.js new file mode 100644 index 000000000..c486a8b16 --- /dev/null +++ b/frontend/tests/vitest/model/model-cache.test.js @@ -0,0 +1,465 @@ +import { describe, it, expect, vi } from "vitest"; +import "../fixtures"; +import ModelCache, { ModelCacheStaleFetchError } from "model/model-cache"; + +// Minimal model-shaped object the tests can use without pulling in any +// real subclass. The snapshot is intentionally idempotent — it accepts +// either a fakeModel ({ values: {...} }) or already-snapshotted plain +// values — so the fixture mirrors Photo's "instanceof check, otherwise +// pass through" callback. Set() now routes through snapshot, so a non- +// idempotent callback would break every test that pre-snapshots raw +// values inline. +function buildCache(overrides = {}) { + return new ModelCache({ + max: 3, + ttl: 0, + snapshot: (model) => (model && typeof model === "object" && Object.prototype.hasOwnProperty.call(model, "values") ? { ...model.values } : { ...model }), + hydrate: (values) => ({ hydrated: true, values }), + ...overrides, + }); +} + +function fakeModel(uid, extra = {}) { + return { values: { UID: uid, ...extra } }; +} + +// Lets the suite drive tick-by-tick. flushMicrotasks waits for all +// queued .then() callbacks; flushAndTick advances the manual clock too +// for TTL tests. +const flushMicrotasks = () => Promise.resolve(); + +describe("model/model-cache", () => { + describe("constructor", () => { + it("requires a snapshot callback", () => { + expect(() => new ModelCache({ hydrate: (v) => v })).toThrow(/snapshot/); + }); + + it("requires a hydrate callback", () => { + expect(() => new ModelCache({ snapshot: (m) => m.values })).toThrow(/hydrate/); + }); + + it("accepts numeric max and clamps non-positive values to 0", () => { + const a = new ModelCache({ max: 5, snapshot: (m) => m, hydrate: (v) => v }); + const b = new ModelCache({ max: -1, snapshot: (m) => m, hydrate: (v) => v }); + expect(a.max).toBe(5); + expect(b.max).toBe(0); + }); + + it("treats ttl <= 0 as disabled", () => { + const a = new ModelCache({ ttl: 0, snapshot: (m) => m, hydrate: (v) => v }); + const b = new ModelCache({ ttl: -100, snapshot: (m) => m, hydrate: (v) => v }); + expect(a.ttl).toBe(0); + expect(b.ttl).toBe(0); + }); + }); + + describe("snapshot routing", () => { + // Pin the contract that set() always runs its argument through + // the configured snapshot() callback — so direct callers passing + // a model instance (Photo, anything with getValues()) end up with + // the same normalized cache shape that fetch() would have stored. + // Without this, a future call site like + // Photo._cache.set(uid, photoInstance) + // would store the live instance and leak refs through hydrate(). + it("routes set() through the snapshot callback", () => { + const snapshotCalls = []; + const cache = new ModelCache({ + max: 3, + snapshot: (model) => { + snapshotCalls.push(model); + return { ...model.values, _snapshotted: true }; + }, + hydrate: (values) => values, + }); + cache.set("a", { values: { UID: "a", Title: "Loaded" } }); + expect(snapshotCalls).toHaveLength(1); + const stored = cache.get("a"); + expect(stored.UID).toBe("a"); + expect(stored.Title).toBe("Loaded"); + expect(stored._snapshotted).toBe(true); + }); + + it("routes refreshIfPresent() through the snapshot callback", () => { + const cache = new ModelCache({ + max: 3, + snapshot: (model) => ({ ...model.values, _snapshotted: true }), + hydrate: (values) => values, + }); + cache.set("a", { values: { UID: "a", Title: "Old" } }); + const ok = cache.refreshIfPresent("a", { values: { UID: "a", Title: "New" } }); + expect(ok).toBe(true); + const stored = cache.get("a"); + expect(stored.Title).toBe("New"); + expect(stored._snapshotted).toBe(true); + }); + }); + + describe("set + get", () => { + it("stores a deep clone so caller-side mutations don't bleed into the cache", () => { + const cache = buildCache(); + const model = fakeModel("a", { Title: "Original" }); + cache.set("a", cache.snapshot(model)); + // Mutate the source after set: the cache must hold the snapshot. + model.values.Title = "Tampered"; + const hit = cache.get("a"); + expect(hit.values.Title).toBe("Original"); + }); + + it("hydrates from a clone so caller-side mutations don't bleed back into the cache", () => { + const cache = buildCache(); + cache.set("a", { UID: "a", Title: "Original" }); + const first = cache.get("a"); + first.values.Title = "Mutated"; + const second = cache.get("a"); + expect(second.values.Title).toBe("Original"); + // Different hydrated instances, no aliasing. + expect(first).not.toBe(second); + }); + + it("returns null on miss without throwing", () => { + const cache = buildCache(); + expect(cache.get("missing")).toBeNull(); + }); + + it("get() promotes the entry to the most-recent LRU slot", () => { + const cache = buildCache({ max: 3 }); + cache.set("a", { UID: "a" }); + cache.set("b", { UID: "b" }); + cache.set("c", { UID: "c" }); + // Touching "a" should move it to the tail. + cache.get("a"); + const keys = [...cache.items.keys()]; + expect(keys[keys.length - 1]).toBe("a"); + }); + + it("set() refresh moves the entry to the most-recent LRU slot", () => { + const cache = buildCache({ max: 3 }); + cache.set("a", { UID: "a" }); + cache.set("b", { UID: "b" }); + cache.set("c", { UID: "c" }); + cache.set("a", { UID: "a", Title: "Refreshed" }); + const keys = [...cache.items.keys()]; + expect(keys[keys.length - 1]).toBe("a"); + }); + + it("evicts the oldest entry when max is exceeded", () => { + const cache = buildCache({ max: 3 }); + cache.set("a", { UID: "a" }); + cache.set("b", { UID: "b" }); + cache.set("c", { UID: "c" }); + cache.set("d", { UID: "d" }); + expect(cache.size()).toBe(3); + expect(cache.has("a")).toBe(false); + expect(cache.has("d")).toBe(true); + }); + + it("set() is a no-op when max <= 0", () => { + const cache = buildCache({ max: 0 }); + cache.set("a", { UID: "a" }); + expect(cache.size()).toBe(0); + expect(cache.get("a")).toBeNull(); + }); + }); + + describe("has", () => { + it("returns true for live entries and false after expiration", () => { + let now = 1000; + const cache = buildCache({ ttl: 500, now: () => now }); + cache.set("a", { UID: "a" }); + expect(cache.has("a")).toBe(true); + now += 600; + expect(cache.has("a")).toBe(false); + }); + + it("does not promote the entry to the most-recent slot", () => { + const cache = buildCache({ max: 3 }); + cache.set("a", { UID: "a" }); + cache.set("b", { UID: "b" }); + cache.has("a"); + const keys = [...cache.items.keys()]; + // "b" should still be the most-recent because has() is read-only. + expect(keys[keys.length - 1]).toBe("b"); + }); + }); + + describe("ttl", () => { + it("expires entries after ttl ms and returns null on get", () => { + let now = 1000; + const cache = buildCache({ ttl: 500, now: () => now }); + cache.set("a", { UID: "a", Title: "Fresh" }); + now += 100; + expect(cache.get("a").values.Title).toBe("Fresh"); + now += 500; + expect(cache.get("a")).toBeNull(); + }); + + it("with ttl disabled (0) entries never expire on their own", () => { + let now = 1000; + const cache = buildCache({ ttl: 0, now: () => now }); + cache.set("a", { UID: "a", Title: "Forever" }); + now += 1_000_000_000; + expect(cache.get("a").values.Title).toBe("Forever"); + }); + + // Lazy-prune contract: has() removes the expired entry on probe so + // size() / refreshIfPresent() / oldest-eviction don't keep + // accounting for entries no reader can retrieve. + it("has() lazy-prunes an expired entry and reports it as absent", () => { + let now = 1000; + const cache = buildCache({ ttl: 500, now: () => now }); + cache.set("a", { UID: "a" }); + cache.set("b", { UID: "b" }); + now += 600; + expect(cache.has("a")).toBe(false); + expect(cache.items.has("a")).toBe(false); + // The other entry is also expired and gets pruned on its own probe. + expect(cache.has("b")).toBe(false); + expect(cache.size()).toBe(0); + }); + + // refreshIfPresent must not silently revive an expired entry under + // a fresh expiry window — that would let a background event handler + // resurrect data the user can no longer retrieve. + it("refreshIfPresent() returns false for an expired entry instead of reviving it", () => { + let now = 1000; + const cache = buildCache({ ttl: 500, now: () => now }); + cache.set("a", { UID: "a", Title: "Old" }); + now += 600; + const ok = cache.refreshIfPresent("a", { UID: "a", Title: "New" }); + expect(ok).toBe(false); + // The expired entry should be gone — the probe pruned it. + expect(cache.has("a")).toBe(false); + expect(cache.size()).toBe(0); + }); + + // Without overflow-time pruning, an expired ghost (here "a", whose + // LRU position got pushed past fresher entries by get() promotion) + // would hold a slot through eviction churn — and under non-uniform + // LRU promotion a fresh entry could even be evicted ahead of stale + // ones. set() must reclaim every expired slot before considering + // an oldest-eviction. + it("set() reclaims every expired slot before evicting on overflow", () => { + let now = 1000; + const cache = buildCache({ max: 3, ttl: 500, now: () => now }); + cache.set("a", { UID: "a" }); // expires at 1500 + cache.set("b", { UID: "b" }); // expires at 1500 + cache.set("c", { UID: "c" }); // expires at 1500 + // Promote "a" to most-recent so the natural oldest-eviction + // would drop "b", not "a", on the next overflow. + cache.get("a"); + now = 1700; // a, b, c are all expired + cache.set("d", { UID: "d" }); // fresh insert at the cap + // Without the prune pass we'd evict a single "oldest" ghost ("b") + // and leave "c" + "a" sitting in the LRU as expired ghosts. With + // it, only the newly-inserted "d" survives. + expect(cache.size()).toBe(1); + expect(cache.has("d")).toBe(true); + expect(cache.has("a")).toBe(false); + expect(cache.has("b")).toBe(false); + expect(cache.has("c")).toBe(false); + }); + }); + + describe("fetch", () => { + it("returns a hydrated model on miss and stores a snapshot", async () => { + const cache = buildCache(); + const loader = vi.fn().mockResolvedValue(fakeModel("a", { Title: "Loaded" })); + const result = await cache.fetch("a", loader); + expect(result.hydrated).toBe(true); + expect(result.values.Title).toBe("Loaded"); + expect(cache.has("a")).toBe(true); + expect(loader).toHaveBeenCalledTimes(1); + }); + + it("returns a hydrated model from cache on hit without invoking the loader", async () => { + const cache = buildCache(); + cache.set("a", { UID: "a", Title: "Cached" }); + const loader = vi.fn(); + const result = await cache.fetch("a", loader); + expect(result.values.Title).toBe("Cached"); + expect(loader).not.toHaveBeenCalled(); + }); + + it("coalesces concurrent fetches behind a single in-flight request", async () => { + const cache = buildCache(); + const loader = vi.fn().mockResolvedValue(fakeModel("a", { Title: "Loaded" })); + const [r1, r2, r3] = await Promise.all([cache.fetch("a", loader), cache.fetch("a", loader), cache.fetch("a", loader)]); + expect(loader).toHaveBeenCalledTimes(1); + // Each waiter receives an isolated hydrated instance. + expect(r1).not.toBe(r2); + expect(r2).not.toBe(r3); + expect(r1.values.Title).toBe("Loaded"); + expect(r2.values.Title).toBe("Loaded"); + expect(r3.values.Title).toBe("Loaded"); + }); + + it("clears the pending entry after the loader resolves", async () => { + const cache = buildCache(); + const loader = vi.fn().mockResolvedValue(fakeModel("a")); + await cache.fetch("a", loader); + expect(cache.pending.has("a")).toBe(false); + }); + + it("clears the pending entry even when the loader rejects", async () => { + const cache = buildCache(); + const loader = vi.fn().mockRejectedValue(new Error("boom")); + await expect(cache.fetch("a", loader)).rejects.toThrow("boom"); + expect(cache.pending.has("a")).toBe(false); + expect(cache.has("a")).toBe(false); + }); + + it("hands waiters isolated clones when piggy-backing on an in-flight request", async () => { + const cache = buildCache(); + // Use a deferred loader so the second fetch lands while the first is in flight. + let resolveLoader; + const loader = vi.fn().mockImplementation(() => new Promise((res) => (resolveLoader = res))); + const p1 = cache.fetch("a", loader); + const p2 = cache.fetch("a", loader); + // fetch() invokes the loader inside a microtask, so wait one tick + // before resolving — otherwise resolveLoader hasn't been assigned yet. + await flushMicrotasks(); + resolveLoader(fakeModel("a", { Title: "Loaded" })); + const [r1, r2] = await Promise.all([p1, p2]); + // Mutating one waiter must not affect the other. + r1.values.Title = "Mutated by r1"; + expect(r2.values.Title).toBe("Loaded"); + }); + }); + + describe("refreshIfPresent", () => { + it("updates an existing entry and returns true", () => { + const cache = buildCache(); + cache.set("a", { UID: "a", Title: "Old" }); + const ok = cache.refreshIfPresent("a", { UID: "a", Title: "New" }); + expect(ok).toBe(true); + expect(cache.get("a").values.Title).toBe("New"); + }); + + it("does not seed a new entry and returns false when key is absent", () => { + const cache = buildCache(); + const ok = cache.refreshIfPresent("a", { UID: "a", Title: "New" }); + expect(ok).toBe(false); + expect(cache.has("a")).toBe(false); + }); + + it("promotes the refreshed entry to the most-recent LRU slot", () => { + const cache = buildCache({ max: 3 }); + cache.set("a", { UID: "a" }); + cache.set("b", { UID: "b" }); + cache.set("c", { UID: "c" }); + cache.refreshIfPresent("a", { UID: "a", Title: "Refreshed" }); + const keys = [...cache.items.keys()]; + expect(keys[keys.length - 1]).toBe("a"); + }); + }); + + describe("evict", () => { + it("removes the entry and any pending request for the given key", async () => { + const cache = buildCache(); + cache.set("a", { UID: "a" }); + // Start a pending fetch on a different key so we can confirm evict + // only touches the targeted key. + let resolveLoader; + const loader = () => new Promise((res) => (resolveLoader = res)); + const inFlight = cache.fetch("b", loader); + await flushMicrotasks(); + cache.evict("a"); + expect(cache.has("a")).toBe(false); + expect(cache.pending.has("b")).toBe(true); + resolveLoader(fakeModel("b")); + await inFlight; + }); + }); + + describe("clear", () => { + it("empties items and the pending-request map", () => { + const cache = buildCache(); + cache.set("a", { UID: "a" }); + cache.set("b", { UID: "b" }); + // Seed a pending entry without resolving. + cache.fetch("c", () => new Promise(() => {})); + cache.clear(); + expect(cache.size()).toBe(0); + expect(cache.pending.size).toBe(0); + }); + + it("rejects in-flight fetches that resolve after clear() bumps the epoch", async () => { + // Fetches whose epoch no longer matches must REJECT, not resolve. + // Two guarantees flow from this: (1) the cache stays empty so + // a future read can't serve role-A data; (2) the original + // waiter's .then never fires, so a caller chaining + // "Photo.findCached(uid).then(p => this.photo = p)" can't + // route role-A data into UI mounted under role B during the + // post-logout window before the route-change unmount. + const cache = buildCache(); + let resolveLoader; + const loader = () => new Promise((res) => (resolveLoader = res)); + const inFlight = cache.fetch("a", loader); + await flushMicrotasks(); + cache.clear(); + expect(cache.size()).toBe(0); + resolveLoader(fakeModel("a", { Title: "Late" })); + await expect(inFlight).rejects.toBeInstanceOf(ModelCacheStaleFetchError); + expect(cache.has("a")).toBe(false); + expect(cache.size()).toBe(0); + }); + + it("a fresh fetch after clear() runs under the new epoch and re-seeds normally", async () => { + const cache = buildCache(); + let resolveStale; + const staleLoader = () => new Promise((res) => (resolveStale = res)); + const stale = cache.fetch("a", staleLoader); + await flushMicrotasks(); + cache.clear(); + // Start a second fetch on the same key after clear(). It runs + // under the new epoch, so its result MUST land in the cache. + const freshLoader = vi.fn().mockResolvedValue(fakeModel("a", { Title: "Fresh" })); + const fresh = cache.fetch("a", freshLoader); + // Resolve the stale loader after the new fetch is in flight. + // The stale promise rejects (epoch mismatch); the fresh one runs + // under the new epoch and resolves cleanly. + resolveStale(fakeModel("a", { Title: "Stale" })); + await expect(stale).rejects.toBeInstanceOf(ModelCacheStaleFetchError); + const result = await fresh; + expect(result.values.Title).toBe("Fresh"); + expect(cache.has("a")).toBe(true); + expect(cache.get("a").values.Title).toBe("Fresh"); + }); + + it("rejected in-flight fetches still drop their pending entry across clear()", async () => { + const cache = buildCache(); + let rejectLoader; + const loader = () => new Promise((_res, rej) => (rejectLoader = rej)); + const inFlight = cache.fetch("a", loader); + await flushMicrotasks(); + cache.clear(); + rejectLoader(new Error("offline")); + await expect(inFlight).rejects.toThrow("offline"); + // The stale fetch's pending slot must not linger after clear(). + expect(cache.pending.has("a")).toBe(false); + }); + }); + + describe("epoch", () => { + it("starts at 0 and increments on each clear()", () => { + const cache = buildCache(); + expect(cache._epoch).toBe(0); + cache.clear(); + expect(cache._epoch).toBe(1); + cache.clear(); + expect(cache._epoch).toBe(2); + }); + }); + + describe("size", () => { + it("reports the current item count", () => { + const cache = buildCache(); + expect(cache.size()).toBe(0); + cache.set("a", { UID: "a" }); + cache.set("b", { UID: "b" }); + expect(cache.size()).toBe(2); + cache.evict("a"); + expect(cache.size()).toBe(1); + }); + }); +}); diff --git a/frontend/tests/vitest/model/photo.test.js b/frontend/tests/vitest/model/photo.test.js index 32f3a2866..7f2a947ac 100644 --- a/frontend/tests/vitest/model/photo.test.js +++ b/frontend/tests/vitest/model/photo.test.js @@ -1,9 +1,73 @@ -import { describe, it, expect } from "vitest"; +import { describe, it, expect, beforeEach, vi } from "vitest"; import "../fixtures"; import * as media from "common/media"; -import { Photo, BatchSize } from "model/photo"; +import { Photo, BatchSize, MaxLength } from "model/photo"; +import $event from "common/event"; + +// Drains the pubsub-js async queue so subscribers configured as `async: true` +// have run by the time the test asserts. +const flushEvents = () => new Promise((resolve) => setTimeout(resolve, 0)); describe("model/photo", () => { + // Pins the per-field length caps to the backend VARCHAR + clip ceilings. + // If a backend bump (internal/entity/photo.go or details.go) changes any + // of these, this test fails on purpose so the frontend cap moves with it. + it("MaxLength mirrors the backend VARCHAR + clip caps", () => { + expect(MaxLength).toEqual({ + Title: 200, + Caption: 4096, + Subject: 1024, + Artist: 1024, + Copyright: 1024, + License: 1024, + Keywords: 2048, + Notes: 2048, + Exposure: 64, + }); + // Frozen so consumers can't accidentally mutate per-field caps. + expect(Object.isFrozen(MaxLength)).toBe(true); + }); + + // Title, Caption, and Exposure live directly on the Photo; the Details + // fields (Subject, Artist, etc.) live one level down — the override + // must handle both shapes without crashing on a Photo without Details. + it("trimInputs() trims both direct fields and Details nested fields", () => { + const photo = new Photo({ + Title: " Sunset ", + Caption: "\tBeach\n", + Exposure: " 1/250s ", + Details: { + Subject: " woman walking ", + Artist: "\tAnsel Adams ", + Copyright: " © 2026 ", + License: " CC-BY ", + Keywords: " sunset,beach ", + Notes: " scenic view ", + }, + Slug: " untouched ", + }); + + photo.trimInputs(); + + expect(photo.Title).toBe("Sunset"); + expect(photo.Caption).toBe("Beach"); + expect(photo.Exposure).toBe("1/250s"); + expect(photo.Details.Subject).toBe("woman walking"); + expect(photo.Details.Artist).toBe("Ansel Adams"); + expect(photo.Details.Copyright).toBe("© 2026"); + expect(photo.Details.License).toBe("CC-BY"); + expect(photo.Details.Keywords).toBe("sunset,beach"); + expect(photo.Details.Notes).toBe("scenic view"); + // Slug isn't in MaxLength — passes through. + expect(photo.Slug).toBe(" untouched "); + }); + + it("trimInputs() is safe to call on a Photo without Details", () => { + const photo = new Photo({ Title: " bare " }); + expect(() => photo.trimInputs()).not.toThrow(); + expect(photo.Title).toBe("bare"); + }); + it("should get photo entity name", () => { const values = { UID: 5, Title: "Crazy Cat" }; const photo = new Photo(values); @@ -1091,6 +1155,80 @@ describe("model/photo", () => { expect(photo2.locationInfo()).toBe("Spain"); }); + it("should return empty placeName when the photo has no geocoding", () => { + const photo = new Photo({ ID: 1, UID: "ABC1" }); + expect(photo.placeName()).toBe(""); + }); + + it("should resolve placeName from Place.Label when set", () => { + const photo = new Photo({ + ID: 2, + UID: "ABC2", + PlaceID: "s2:abc", + Country: "de", + Place: { ID: "s2:abc", Label: "Berlin, Germany" }, + }); + expect(photo.placeName()).toBe("Berlin, Germany"); + }); + + it("should fall back to PlaceLabel when Place is not preloaded", () => { + const photo = new Photo({ + ID: 3, + UID: "ABC3", + PlaceID: "s2:def", + Country: "fr", + PlaceLabel: "Paris, France", + }); + expect(photo.placeName()).toBe("Paris, France"); + }); + + it("should resolve placeName to the country name for unknown places with a known country", () => { + const photo = new Photo({ ID: 4, UID: "ABC4", PlaceID: "zz", Country: "es" }); + expect(photo.placeName()).toBe("Spain"); + }); + + it("should strip the UnknownPlace literal so placeName returns empty for unresolved photos", () => { + // Mirrors the join shape PhotoPreloadByUID returns when a photo + // points at UnknownPlace (`internal/entity/place.go`): every text + // column is the English literal "Unknown" and Country is also "zz". + const photo = new Photo({ + ID: 5, + UID: "ABC5", + PlaceID: "zz", + Country: "zz", + PlaceLabel: "Unknown", + Place: { ID: "zz", Label: "Unknown" }, + }); + expect(photo.placeName()).toBe(""); + // locationInfo() still surfaces the localized fallback for callers + // that want a placeholder (cards / list / edit dialog). + expect(photo.locationInfo()).toBe("Unknown"); + }); + + it("should strip a denormalized 'Unknown' PlaceLabel even when Place is not preloaded", () => { + const photo = new Photo({ + ID: 6, + UID: "ABC6", + PlaceID: "zz", + Country: "zz", + PlaceLabel: "Unknown", + }); + expect(photo.placeName()).toBe(""); + }); + + it("should keep a user label that merely contains the substring Unknown", () => { + const photo = new Photo({ + ID: 7, + UID: "ABC7", + PlaceID: "s2:ghi", + Country: "us", + PlaceLabel: "Unknown Trail, Yosemite", + }); + // The filter matches the exact DB sentinel, not substrings — a + // user-curated label like "Unknown Trail" stays put. + expect(photo.placeName()).toBe("Unknown Trail, Yosemite"); + }); + it("should return video info", () => { const values = { ID: 9, @@ -1443,6 +1581,137 @@ describe("model/photo", () => { expect(response.success).toBe("ok"); }); + describe("addToAlbum", () => { + beforeEach(() => { + Photo._cache.clear(); + }); + + it("posts to albums/<uid>/photos, evicts the cache, refinds, and resyncs this.Albums", async () => { + const photo = new Photo({ UID: "pqbemz8276mhtobh", Albums: [{ UID: "axxalbum1", Title: "Existing" }] }); + const refreshed = new Photo({ + UID: "pqbemz8276mhtobh", + Albums: [ + { UID: "axxalbum1", Title: "Existing" }, + { UID: "axxalbum2", Title: "New" }, + ], + }); + Photo._cache.set("pqbemz8276mhtobh", { UID: "pqbemz8276mhtobh", Title: "Cached" }); + const findSpy = vi.spyOn(Photo.prototype, "find").mockResolvedValueOnce(refreshed); + + const result = await photo.addToAlbum("axxalbum2"); + + expect(findSpy).toHaveBeenCalledWith("pqbemz8276mhtobh"); + expect(Photo._cache.has("pqbemz8276mhtobh")).toBe(false); + expect(result).toBe(photo); + expect(photo.Albums.map((a) => a.UID)).toEqual(["axxalbum1", "axxalbum2"]); + + findSpy.mockRestore(); + }); + + it("resolves to this without a request when albumUID is falsy", async () => { + const photo = new Photo({ UID: "pqbemz8276mhtobh" }); + const findSpy = vi.spyOn(Photo.prototype, "find"); + const result = await photo.addToAlbum(""); + expect(result).toBe(photo); + expect(findSpy).not.toHaveBeenCalled(); + findSpy.mockRestore(); + }); + + it("propagates the rejection without evicting or refinding when the POST fails", async () => { + const $api = (await import("common/api")).default; + const err = new Error("offline"); + const postSpy = vi.spyOn($api, "post").mockRejectedValueOnce(err); + const findSpy = vi.spyOn(Photo.prototype, "find"); + Photo._cache.set("pqbemz8276mhtobh", { UID: "pqbemz8276mhtobh", Title: "Cached" }); + const photo = new Photo({ UID: "pqbemz8276mhtobh" }); + + await expect(photo.addToAlbum("axxalbum2")).rejects.toBe(err); + + expect(findSpy).not.toHaveBeenCalled(); + expect(Photo._cache.has("pqbemz8276mhtobh")).toBe(true); + postSpy.mockRestore(); + findSpy.mockRestore(); + }); + + // Pin the layer split: Photo.addToAlbum must NOT toggle a Removed flag + // (that's Thumb's contract). A future "consolidation" PR that tries to + // collapse the two methods into one will trip this assertion. + it("does not flip a Removed flag (Photo layer ≠ Thumb layer)", async () => { + const photo = new Photo({ UID: "pqbemz8276mhtobh" }); + vi.spyOn(Photo.prototype, "find").mockResolvedValueOnce(new Photo({ UID: "pqbemz8276mhtobh", Albums: [] })); + await photo.addToAlbum("axxalbum2"); + expect(photo.Removed).toBeUndefined(); + Photo.prototype.find.mockRestore(); + }); + }); + + describe("removeFromAlbum", () => { + beforeEach(() => { + Photo._cache.clear(); + }); + + it("deletes albums/<uid>/photos, evicts the cache, refinds, and resyncs this.Albums", async () => { + const photo = new Photo({ + UID: "pqbemz8276mhtobh", + Albums: [ + { UID: "axxalbum1", Title: "Existing" }, + { UID: "axxalbum2", Title: "Other" }, + ], + }); + const refreshed = new Photo({ + UID: "pqbemz8276mhtobh", + Albums: [{ UID: "axxalbum1", Title: "Existing" }], + }); + Photo._cache.set("pqbemz8276mhtobh", { UID: "pqbemz8276mhtobh", Title: "Cached" }); + const findSpy = vi.spyOn(Photo.prototype, "find").mockResolvedValueOnce(refreshed); + + const result = await photo.removeFromAlbum("axxalbum2"); + + expect(findSpy).toHaveBeenCalledWith("pqbemz8276mhtobh"); + expect(Photo._cache.has("pqbemz8276mhtobh")).toBe(false); + expect(result).toBe(photo); + expect(photo.Albums.map((a) => a.UID)).toEqual(["axxalbum1"]); + + findSpy.mockRestore(); + }); + + it("resolves to this without a request when albumUID is falsy", async () => { + const photo = new Photo({ UID: "pqbemz8276mhtobh" }); + const findSpy = vi.spyOn(Photo.prototype, "find"); + const result = await photo.removeFromAlbum(null); + expect(result).toBe(photo); + expect(findSpy).not.toHaveBeenCalled(); + findSpy.mockRestore(); + }); + + it("propagates the rejection without evicting or refinding when the DELETE fails", async () => { + const $api = (await import("common/api")).default; + const err = new Error("offline"); + const deleteSpy = vi.spyOn($api, "delete").mockRejectedValueOnce(err); + const findSpy = vi.spyOn(Photo.prototype, "find"); + Photo._cache.set("pqbemz8276mhtobh", { UID: "pqbemz8276mhtobh", Title: "Cached" }); + const photo = new Photo({ UID: "pqbemz8276mhtobh" }); + + await expect(photo.removeFromAlbum("axxalbum2")).rejects.toBe(err); + + expect(findSpy).not.toHaveBeenCalled(); + expect(Photo._cache.has("pqbemz8276mhtobh")).toBe(true); + deleteSpy.mockRestore(); + findSpy.mockRestore(); + }); + + // Pin the layer split: Photo.removeFromAlbum must NOT toggle a Removed + // flag (that's Thumb.removeFromAlbum's contract — see model/thumb.js + // and the matching test in tests/vitest/model/thumb.test.js). + it("does not flip a Removed flag (Photo layer ≠ Thumb layer)", async () => { + const photo = new Photo({ UID: "pqbemz8276mhtobh" }); + vi.spyOn(Photo.prototype, "find").mockResolvedValueOnce(new Photo({ UID: "pqbemz8276mhtobh", Albums: [] })); + await photo.removeFromAlbum("axxalbum2"); + expect(photo.Removed).toBeUndefined(); + Photo.prototype.find.mockRestore(); + }); + }); + it("should test update", async () => { const values = { ID: 10, @@ -1742,4 +2011,520 @@ describe("model/photo", () => { const photo8 = new Photo({ UID: "origName8", Type: media.Raw, Files: files8 }); expect(photo8.getOriginalName()).toBe("original_raw_name8.raw"); }); + + it("should format EXIF info with all fields", () => { + const photo = new Photo({ FocalLength: 50, FNumber: 1.8, Iso: 400, Exposure: "1/125" }); + expect(photo.getExifInfo()).toBe("50mm \u2022 \u0192/1.8 \u2022 ISO 400 \u2022 1/125"); + }); + + it("should format EXIF info with partial fields", () => { + const photo = new Photo({ FocalLength: 35, Iso: 100 }); + expect(photo.getExifInfo()).toBe("35mm \u2022 ISO 100"); + }); + + it("should return empty EXIF info when no fields set", () => { + const photo = new Photo({}); + expect(photo.getExifInfo()).toBe(""); + }); + + // Photo-cache integration tests. The generic LRU semantics are covered + // independently in tests/vitest/model/model-cache.test.js; the cases + // below pin Photo's own wiring on top of ModelCache: that findCached + // returns Photo instances, that mutators don't touch the cache, that + // the photos.updated/photos.deleted subscriptions route through the + // shared helper, and that LRU/dedup behavior survives the extraction. + describe("LRU cache", () => { + // Helper: seed the cache via the public API used by Photo at runtime. + // Avoids poking ModelCache internals in every test. + const seedCache = (uid, values) => { + Photo._cache.set(uid, { UID: uid, ...values }); + }; + + beforeEach(() => { + Photo._cache.clear(); + }); + + it("should cache a photo after findCached resolves", async () => { + const mockPhoto = new Photo({ UID: "cache-test-1", Title: "Cached" }); + vi.spyOn(Photo.prototype, "find").mockResolvedValueOnce(mockPhoto); + + const result = await Photo.findCached("cache-test-1"); + expect(result.Title).toBe("Cached"); + expect(Photo._cache.has("cache-test-1")).toBe(true); + + Photo.prototype.find.mockRestore(); + }); + + it("should return cached photo without API call on second request", async () => { + seedCache("cache-test-2", { Title: "Cached" }); + + const findSpy = vi.spyOn(Photo.prototype, "find"); + const result = await Photo.findCached("cache-test-2"); + + expect(result.Title).toBe("Cached"); + expect(findSpy).not.toHaveBeenCalled(); + + findSpy.mockRestore(); + }); + + it("should hand out isolated Photo instances so consumers cannot mutate the cache", async () => { + seedCache("cache-test-clone", { Title: "Original" }); + + const first = await Photo.findCached("cache-test-clone"); + expect(first).toBeInstanceOf(Photo); + first.Title = "Mutated"; + + const second = await Photo.findCached("cache-test-clone"); + expect(second).not.toBe(first); + expect(second.Title).toBe("Original"); + }); + + it("should evict the oldest entry when the cache exceeds its size cap", async () => { + const cap = Photo._cache.max; + for (let i = 0; i < cap; i++) { + seedCache(`uid-${i}`, {}); + } + expect(Photo._cache.size()).toBe(cap); + + const mockPhoto = new Photo({ UID: "uid-new", Title: "New" }); + vi.spyOn(Photo.prototype, "find").mockResolvedValueOnce(mockPhoto); + + await Photo.findCached("uid-new"); + + expect(Photo._cache.size()).toBe(cap); + expect(Photo._cache.has("uid-0")).toBe(false); + expect(Photo._cache.has("uid-new")).toBe(true); + + Photo.prototype.find.mockRestore(); + }); + + it("should move an accessed entry to the most-recent LRU slot", async () => { + seedCache("uid-a", {}); + seedCache("uid-b", {}); + seedCache("uid-c", {}); + + await Photo.findCached("uid-a"); + + const keys = [...Photo._cache.items.keys()]; + expect(keys[keys.length - 1]).toBe("uid-a"); + }); + + it("should evict the cache entry for a given UID", () => { + seedCache("uid-evict", {}); + expect(Photo._cache.has("uid-evict")).toBe(true); + + Photo.evictCache("uid-evict"); + expect(Photo._cache.has("uid-evict")).toBe(false); + }); + + it("should handle evictCache with a falsy uid gracefully", () => { + seedCache("uid-keep", {}); + Photo.evictCache(null); + Photo.evictCache(undefined); + Photo.evictCache(""); + expect(Photo._cache.has("uid-keep")).toBe(true); + }); + + it("should clearCache() drop every entry", () => { + seedCache("uid-1", {}); + seedCache("uid-2", {}); + Photo.clearCache(); + expect(Photo._cache.size()).toBe(0); + }); + + it("should deduplicate concurrent requests for the same UID", async () => { + const mockPhoto = new Photo({ UID: "uid-dedup", Title: "Dedup" }); + const findSpy = vi.spyOn(Photo.prototype, "find").mockResolvedValueOnce(mockPhoto); + + const p1 = Photo.findCached("uid-dedup"); + const p2 = Photo.findCached("uid-dedup"); + + const [r1, r2] = await Promise.all([p1, p2]); + expect(findSpy).toHaveBeenCalledTimes(1); + expect(r1).not.toBe(r2); + expect(r1.UID).toBe("uid-dedup"); + expect(r2.UID).toBe("uid-dedup"); + expect(r1.Title).toBe("Dedup"); + expect(r2.Title).toBe("Dedup"); + + findSpy.mockRestore(); + }); + + it("should clear the pending entry after a request completes", async () => { + const mockPhoto = new Photo({ UID: "uid-pending", Title: "Pending" }); + vi.spyOn(Photo.prototype, "find").mockResolvedValueOnce(mockPhoto); + + await Photo.findCached("uid-pending"); + expect(Photo._cache.pending.has("uid-pending")).toBe(false); + + Photo.prototype.find.mockRestore(); + }); + + it("should clear the pending entry even if a request fails", async () => { + vi.spyOn(Photo.prototype, "find").mockRejectedValueOnce(new Error("Network error")); + + try { + await Photo.findCached("uid-fail"); + } catch { + // Expected + } + + expect(Photo._cache.pending.has("uid-fail")).toBe(false); + + Photo.prototype.find.mockRestore(); + }); + + describe("websocket-driven invalidation", () => { + it("evicts a cached entry when photos.updated arrives", async () => { + seedCache("uid-ws-1", { Title: "Old" }); + + $event.publish("photos.updated", { + entities: [{ UID: "uid-ws-1", Title: "New" }], + }); + await flushEvents(); + + // Eviction (not refresh): the next read goes back to find() and + // gets the field-complete entity from /photos/:uid. + expect(Photo._cache.has("uid-ws-1")).toBe(false); + }); + + it("does not seed the cache when photos.updated arrives for an entry not currently cached", async () => { + $event.publish("photos.updated", { + entities: [{ UID: "uid-ws-uncached", Title: "Should not seed" }], + }); + await flushEvents(); + + expect(Photo._cache.has("uid-ws-uncached")).toBe(false); + }); + + // The backend sends photos.deleted with a []string of bare UIDs + // (event.EntitiesDeleted("photos", deleted.UIDs()) in + // internal/api/batch_photos.go and internal/photoprism/cleanup.go), + // NOT objects with .UID — pin both shapes so nobody re-introduces + // the silent-no-op the subscriber had before consolidating the + // string/object handling. + it("evicts cached entries when photos.deleted arrives with bare-string UIDs", async () => { + seedCache("uid-ws-del-string", {}); + + $event.publish("photos.deleted", { + entities: ["uid-ws-del-string"], + }); + await flushEvents(); + + expect(Photo._cache.has("uid-ws-del-string")).toBe(false); + }); + + it("also tolerates the legacy object shape on photos.deleted", async () => { + seedCache("uid-ws-del-obj", {}); + + $event.publish("photos.deleted", { + entities: [{ UID: "uid-ws-del-obj" }], + }); + await flushEvents(); + + expect(Photo._cache.has("uid-ws-del-obj")).toBe(false); + }); + + it("evicts cached entries when photos.archived arrives (bare-string payload)", async () => { + // event.EntitiesArchived("photos", frm.Photos) in + // internal/api/batch_photos.go — frm.Photos is []string. + seedCache("uid-ws-arc", {}); + + $event.publish("photos.archived", { + entities: ["uid-ws-arc"], + }); + await flushEvents(); + + expect(Photo._cache.has("uid-ws-arc")).toBe(false); + }); + + it("evicts cached entries when photos.restored arrives (bare-string payload)", async () => { + // event.EntitiesRestored("photos", frm.Photos) — same shape. + seedCache("uid-ws-res", {}); + + $event.publish("photos.restored", { + entities: ["uid-ws-res"], + }); + await flushEvents(); + + expect(Photo._cache.has("uid-ws-res")).toBe(false); + }); + + // event.EntitiesUpdated("photos", savedUIDs) in + // internal/api/batch_photos_edit.go — one event per batch save, + // payload is the full UID list (always []string, not entity + // objects), so the cache stays fresh after batch edits without + // per-UID events. + it("evicts every cached entry when photos.updated arrives with the batch UID list", async () => { + seedCache("uid-edited-1", { Title: "Stale 1" }); + seedCache("uid-edited-2", { Title: "Stale 2" }); + seedCache("uid-edited-keep", { Title: "Untouched" }); + + $event.publish("photos.updated", { + entities: ["uid-edited-1", "uid-edited-2"], + }); + await flushEvents(); + + expect(Photo._cache.has("uid-edited-1")).toBe(false); + expect(Photo._cache.has("uid-edited-2")).toBe(false); + // Entries outside the payload must survive. + expect(Photo._cache.has("uid-edited-keep")).toBe(true); + }); + + it("ignores empty-string entries in archived/restored payloads", async () => { + seedCache("uid-keep-empty", {}); + + $event.publish("photos.archived", { entities: ["", "uid-keep-empty"] }); + await flushEvents(); + // The non-empty string evicts; the empty one is skipped (a + // malformed-payload guard, not a silent no-op for valid data). + expect(Photo._cache.has("uid-keep-empty")).toBe(false); + }); + + // Regression for the edit-then-navigate-back scenario where the + // sidebar lost its editable affordances after Photo.findCached + // returned a hydrated Photo without nested Details. Root cause: + // PublishPhotoEvent serializes search.Photos results, which carry + // DetailsKeywords / DetailsSubject / etc. as flat top-level fields + // and omit the nested Details object that GET /photos/:uid emits. + // refreshIfPresent silently overwrote the cached snapshot with the + // partial shape, so the next findCached() hydrated a Photo with + // Details === undefined and the sidebar's isEditable computed + // collapsed to false. The fix is to evict on photos.updated and + // let the next read repopulate from the field-complete endpoint. + it("must not overwrite the cached snapshot with the partial search-shape WS payload", async () => { + // Seed the cache with what /photos/:uid would have returned: a + // Photo containing the nested Details object the sidebar reads. + const fullEntity = new Photo({ + UID: "uid-shape-bug", + Title: "Edited", + Details: { Subject: "Sunrise", Keywords: "kw" }, + }); + Photo._cache.set("uid-shape-bug", fullEntity); + expect(Photo._cache.has("uid-shape-bug")).toBe(true); + + // Simulate the actual WS payload PublishPhotoEvent emits — flat + // DetailsKeywords / DetailsSubject and NO nested Details. + $event.publish("photos.updated", { + entities: [ + { + UID: "uid-shape-bug", + Title: "Edited", + DetailsKeywords: "kw", + DetailsSubject: "Sunrise", + }, + ], + }); + await flushEvents(); + + // The cached entry must be gone — otherwise the next findCached() + // returns a Photo without Details and the sidebar disables editing. + expect(Photo._cache.has("uid-shape-bug")).toBe(false); + }); + + it("tolerates malformed payloads on every channel", async () => { + seedCache("uid-keep", {}); + + // Each subscribed channel runs the same guard, so malformed + // payloads on any of them must leave the cache untouched. + ["photos.created", "photos.updated", "photos.deleted", "photos.archived", "photos.restored"].forEach((ev) => { + $event.publish(ev, null); + $event.publish(ev, {}); + $event.publish(ev, { entities: "not-an-array" }); + $event.publish(ev, { entities: [null, { Title: "no uid" }, 0, false, undefined] }); + }); + await flushEvents(); + + expect(Photo._cache.has("uid-keep")).toBe(true); + }); + + // photos.created flows through the same subscribeEntityActions + // helper as the other mutation verbs. The cache doesn't usually + // hold a brand-new UID (the indexer creates it fresh), but if a + // call site has seeded one — e.g. an upsert flow where the UID + // already exists in cache — the WS event must evict it so the + // next read returns the post-create state instead of a stale + // snapshot. + it("evicts cached entries when photos.created arrives for a known UID", async () => { + seedCache("uid-created", { Title: "Pre-create" }); + + $event.publish("photos.created", { entities: ["uid-created"] }); + await flushEvents(); + + expect(Photo._cache.has("uid-created")).toBe(false); + }); + + // Forward-compat: a hypothetical new mutation verb (e.g. + // "merged") would auto-evict if added to ENTITY_MUTATIONS in + // common/event.js. Until then it must be a no-op so unrelated + // future events on the photos namespace don't pull the cache + // out from under live consumers. + it("ignores photos.* events whose action is not in ENTITY_MUTATIONS", async () => { + seedCache("uid-merged", { Title: "Keep" }); + + $event.publish("photos.merged", { entities: ["uid-merged"] }); + $event.publish("photos.viewed", { entities: ["uid-merged"] }); + await flushEvents(); + + expect(Photo._cache.has("uid-merged")).toBe(true); + }); + }); + + describe("post-logout race", () => { + // Concrete repro of the spec Open Question #1 race: a fetch + // that started under the previous role must NOT repopulate + // the cache after Photo.clearCache() (called from + // Session.reset()) has already wiped it. Without the epoch + // gate on ModelCache, the resolved Promise's .then chain + // would call set() under the original key and seed data + // fetched for role A into role B's session. + it("findCached resolving after clearCache() rejects so callers discard the stale value", async () => { + let resolveFind; + const findSpy = vi.spyOn(Photo.prototype, "find").mockImplementation( + () => + new Promise((res) => { + resolveFind = res; + }) + ); + + // Issue the fetch — equivalent to a sidebar open under role A. + const inFlight = Photo.findCached("uid-race"); + + // flush microtasks so the loader is actually invoked. + await Promise.resolve(); + + // Logout / role change happens while the request is in flight. + Photo.clearCache(); + expect(Photo._cache.size()).toBe(0); + + // The previous session's response finally lands. + resolveFind(new Photo({ UID: "uid-race", Title: "Leaked" })); + + // The promise REJECTS so a caller chain like + // Photo.findCached(uid).then(p => this.photo = p) + // never fires its .then with stale role-A data — and the + // cache stays empty so the next read under the new role + // reissues the request. + await expect(inFlight).rejects.toThrow(/stale fetch/i); + expect(Photo._cache.has("uid-race")).toBe(false); + expect(Photo._cache.size()).toBe(0); + + findSpy.mockRestore(); + }); + + it("findCached re-seeds the cache normally after clearCache() advanced the epoch", async () => { + let resolveStale; + const findSpy = vi.spyOn(Photo.prototype, "find").mockImplementationOnce( + () => + new Promise((res) => { + resolveStale = res; + }) + ); + + const stale = Photo.findCached("uid-after-clear"); + await Promise.resolve(); + Photo.clearCache(); + + // A fresh fetch under the new epoch should populate the cache + // even if the stale loader resolves later. + findSpy.mockResolvedValueOnce(new Photo({ UID: "uid-after-clear", Title: "Fresh" })); + const fresh = Photo.findCached("uid-after-clear"); + + // The stale fetch rejects (epoch mismatch); the fresh one + // runs under the new epoch and resolves cleanly. + resolveStale(new Photo({ UID: "uid-after-clear", Title: "Stale" })); + await expect(stale).rejects.toThrow(/stale fetch/i); + const result = await fresh; + + expect(result.Title).toBe("Fresh"); + expect(Photo._cache.has("uid-after-clear")).toBe(true); + expect(Photo._cache.size()).toBe(1); + + findSpy.mockRestore(); + }); + }); + + describe("mutators no longer pre-evict the cache", () => { + // Verifies the websocket-driven design: the cached entry survives the + // local mutation request itself; the next photos.updated event is what + // refreshes it. The HTTP requests are fire-and-forget here — only some + // are mocked in fixtures.js, but the cache invariant holds regardless + // of whether the request resolves or rejects. + it.each([ + ["toggleLike", (p) => p.toggleLike()], + ["togglePrivate", (p) => p.togglePrivate()], + ["like", (p) => p.like()], + ["unlike", (p) => p.unlike()], + ["update", (p) => p.update()], + ])("%s leaves the cached entry in place", (_name, run) => { + const photo = new Photo({ UID: "pqbemz8276mhtobh", Title: "Cached" }); + seedCache("pqbemz8276mhtobh", photo.getValues(false)); + + // Swallow rejections from unmocked endpoints; the cache state is what + // we care about, not the API result. + Promise.resolve(run(photo)).catch(() => {}); + + expect(Photo._cache.has("pqbemz8276mhtobh")).toBe(true); + }); + }); + + describe("prefetchAround", () => { + // Lightweight slide stand-ins. prefetchAround only reads UID; the + // actual fetch is mocked at Photo.prototype.find. + const slides = [{ UID: "uid-prev" }, { UID: "uid-curr" }, { UID: "uid-next-1" }, { UID: "uid-next-2" }]; + + it("warms the cache for slides forward of `index` by default", async () => { + const findSpy = vi.spyOn(Photo.prototype, "find").mockImplementation(function () { + return Promise.resolve(this); + }); + + await Photo.prefetchAround(slides, 1); + + const calledUids = findSpy.mock.calls.map((c) => c[0]); + expect(calledUids).toContain("uid-next-1"); + expect(calledUids).not.toContain("uid-curr"); + expect(calledUids).not.toContain("uid-prev"); + expect(calledUids).not.toContain("uid-next-2"); + + findSpy.mockRestore(); + }); + + it("respects the {before, after} window when supplied", async () => { + const findSpy = vi.spyOn(Photo.prototype, "find").mockImplementation(function () { + return Promise.resolve(this); + }); + + await Photo.prefetchAround(slides, 1, { before: 1, after: 2 }); + + const calledUids = findSpy.mock.calls.map((c) => c[0]); + expect(calledUids).toContain("uid-prev"); + expect(calledUids).toContain("uid-next-1"); + expect(calledUids).toContain("uid-next-2"); + expect(calledUids).not.toContain("uid-curr"); + + findSpy.mockRestore(); + }); + + it("does nothing when models is empty or index is invalid", async () => { + const findSpy = vi.spyOn(Photo.prototype, "find"); + + await Photo.prefetchAround([], 0); + await Photo.prefetchAround(null, 0); + await Photo.prefetchAround(slides, -1); + await Photo.prefetchAround(slides, "not-a-number"); + + expect(findSpy).not.toHaveBeenCalled(); + + findSpy.mockRestore(); + }); + + it("absorbs rejected prefetch loaders without throwing", async () => { + vi.spyOn(Photo.prototype, "find").mockRejectedValue(new Error("offline")); + + await expect(Photo.prefetchAround(slides, 1)).resolves.toBeDefined(); + + Photo.prototype.find.mockRestore(); + }); + }); + }); }); diff --git a/frontend/tests/vitest/model/rest.test.js b/frontend/tests/vitest/model/rest.test.js index c7b4856e3..388142bf2 100644 --- a/frontend/tests/vitest/model/rest.test.js +++ b/frontend/tests/vitest/model/rest.test.js @@ -56,6 +56,23 @@ describe("model/abstract", () => { expect(album.Description).toBe("Test description"); }); + // update() / save() route through trimInputs() so user-typed string + // fields are trimmed before they leave the client, matching what the + // backend (txt.Clip / clean.Name) would persist anyway. + it("update() trims string fields via trimInputs()", async () => { + const album = new Album({ UID: "abc", Title: " Vacation ", Location: "\tBerlin\n" }); + await album.update(); + expect(album.Title).toBe("Vacation"); + expect(album.Location).toBe("Berlin"); + }); + + it("save() trims string fields on the new-entity POST path", async () => { + const album = new Album({ Title: " Vacation " }); + expect(album.hasId()).toBe(false); + await album.save(); + expect(album.Title).toBe("Vacation"); + }); + it("should save album", async () => { const values = { UID: "abc", Name: "Christmas 2019", Slug: "christmas-2019" }; const album = new Album(values); @@ -197,4 +214,195 @@ describe("model/abstract", () => { expect(response.count).toBe(2); expect(response.models.length).toBe(2); }); + + describe("setValues", () => { + it("returns the instance so calls can be chained", () => { + const album = new Album({ Name: "First" }); + expect(album.setValues({ Name: "Second" })).toBe(album); + }); + + it("ignores a falsy values argument", () => { + const album = new Album({ Name: "Kept" }); + album.setValues(null); + album.setValues(undefined); + album.setValues(false); + expect(album.Name).toBe("Kept"); + expect(album.wasChanged()).toBe(false); + }); + + it("skips the reserved __originalValues key", () => { + const album = new Album({ Name: "Original" }); + album.setValues({ __originalValues: { Name: "Tampered" } }); + expect(album.__originalValues.Name).toBe("Original"); + }); + + it("snapshots scalars and deep-clones objects so mutations don't bleed into __originalValues", () => { + const link = new Link({ ID: 1, UID: "abc", Token: "tkn", ShareUID: "shr" }); + // Scalar mutation never reaches the snapshot. + link.Token = "changed"; + expect(link.__originalValues.Token).toBe("tkn"); + }); + + it("skips object snapshots when scalarOnly is true", () => { + const album = new Album({ Title: "Trip" }); + const nested = { foo: "bar" }; + album.setValues({ Title: "Trip", Notes: "x", Extras: nested }, true); + expect(album.Extras).toBe(nested); + // scalarOnly: object values are not tracked in __originalValues, so + // wasChanged() can't detect mutations on them — by design. + expect(album.__originalValues.Extras).toBeUndefined(); + expect(album.__originalValues.Title).toBe("Trip"); + }); + }); + + describe("getValues", () => { + it("with changed=true returns only fields that differ from the snapshot", () => { + const album = new Album({ ID: 1, Title: "Trip", Slug: "trip", PhotoCount: 0 }); + album.Title = "Vacation"; + album.PhotoCount = 5; + const diff = album.getValues(true); + expect(diff).toEqual({ Title: "Vacation", PhotoCount: 5 }); + }); + + it("coerces strings, numbers, and booleans according to getDefaults()", () => { + const album = new Album({ Title: "Trip", PhotoCount: 0, Favorite: false }); + // String default => null becomes "". + album.Title = null; + // Number default => parseFloat applied to whatever is on the instance. + album.PhotoCount = "42"; + // Boolean default => coerced via Boolean(). + album.Favorite = 1; + const values = album.getValues(); + expect(values.Title).toBe(""); + expect(values.PhotoCount).toBe(42); + expect(values.Favorite).toBe(true); + }); + + it("passes through fields that have no default verbatim", () => { + // Album.getDefaults() has no `ID`, so ID is tracked in __originalValues + // but bypasses type coercion — getValues() returns it as-is. + const album = new Album({ ID: 7, Title: "Trip" }); + const values = album.getValues(); + expect(values.ID).toBe(7); + }); + }); + + describe("originalValue", () => { + it("returns the snapshot value for a tracked key", () => { + const album = new Album({ Title: "Original", PhotoCount: 3 }); + album.Title = "Mutated"; + album.PhotoCount = 99; + expect(album.originalValue("Title")).toBe("Original"); + expect(album.originalValue("PhotoCount")).toBe(3); + }); + + it("falls back to the live value for an untracked own property", () => { + const album = new Album({ Title: "Trip" }); + album.RuntimeOnly = "ad-hoc"; + // RuntimeOnly was assigned after construction, so it isn't in + // __originalValues; the fallback returns whatever's currently on `this`. + expect(album.originalValue("RuntimeOnly")).toBe("ad-hoc"); + }); + + it("returns null for unknown keys", () => { + const album = new Album({ Title: "Trip" }); + expect(album.originalValue("DoesNotExist")).toBeNull(); + }); + + it("returns null when the reserved __originalValues key is requested", () => { + const album = new Album({ Title: "Trip" }); + expect(album.originalValue("__originalValues")).toBeNull(); + }); + }); + + describe("wasChanged", () => { + it("returns false on a freshly loaded model", () => { + const album = new Album({ ID: 1, Title: "Trip" }); + expect(album.wasChanged()).toBe(false); + }); + + it("returns true after any tracked field is mutated", () => { + const album = new Album({ ID: 1, Title: "Trip" }); + album.Title = "Vacation"; + expect(album.wasChanged()).toBe(true); + }); + + it("flips back to false after rollback() restores the snapshot", () => { + const album = new Album({ ID: 1, Title: "Trip" }); + album.Title = "Vacation"; + album.rollback(); + expect(album.wasChanged()).toBe(false); + }); + }); + + describe("rollback", () => { + it("restores scalar fields to the __originalValues snapshot", () => { + const album = new Album({ ID: 5, Name: "Christmas 2019", Slug: "christmas-2019", UID: 66 }); + album.Name = "Mutated"; + album.Slug = "mutated"; + expect(album.wasChanged()).toBe(true); + album.rollback(); + expect(album.Name).toBe("Christmas 2019"); + expect(album.Slug).toBe("christmas-2019"); + expect(album.wasChanged()).toBe(false); + }); + + it("deep-clones object fields so post-rollback mutations don't bleed into the snapshot", () => { + const link = new Link({ ID: 1, UID: "abc", Token: "tkn", ShareUID: "shr" }); + link.Token = "changed"; + link.rollback(); + expect(link.Token).toBe("tkn"); + // A second mutation must still be rollable — the snapshot wasn't aliased. + link.Token = "changed-again"; + link.rollback(); + expect(link.Token).toBe("tkn"); + }); + + it("returns the model so calls can be chained", () => { + const album = new Album({ Name: "X" }); + album.Name = "Y"; + expect(album.rollback()).toBe(album); + }); + + it("is a no-op on a clean model", () => { + const album = new Album({ ID: 1, Name: "Pristine" }); + expect(album.wasChanged()).toBe(false); + album.rollback(); + expect(album.Name).toBe("Pristine"); + expect(album.wasChanged()).toBe(false); + }); + }); + + describe("getWriteOnly", () => { + it("returns an empty object on the base Model", () => { + const album = new Album({ ID: 1, Name: "Trip" }); + expect(album.getWriteOnly()).toEqual({}); + }); + + it("seeds declared write-only fields into __originalValues on construction", () => { + class WithSecret extends Album { + getWriteOnly() { + return { Secret: "" }; + } + } + const item = new WithSecret({ ID: 1, Name: "Trip" }); + expect(item.Secret).toBe(""); + expect(item.__originalValues.Secret).toBe(""); + // A subsequent edit must show up in the change diff. + item.Secret = "shh"; + expect(item.getValues(true)).toEqual({ Secret: "shh" }); + }); + + it("does not overwrite a write-only field that was provided in values", () => { + class WithSecret extends Album { + getWriteOnly() { + return { Secret: "" }; + } + } + const item = new WithSecret({ ID: 1, Name: "Trip", Secret: "from-api" }); + expect(item.Secret).toBe("from-api"); + expect(item.__originalValues.Secret).toBe("from-api"); + expect(item.wasChanged()).toBe(false); + }); + }); }); diff --git a/frontend/tests/vitest/model/service.test.js b/frontend/tests/vitest/model/service.test.js index a59d66ebf..7324399b6 100644 --- a/frontend/tests/vitest/model/service.test.js +++ b/frontend/tests/vitest/model/service.test.js @@ -56,4 +56,46 @@ describe("model/service", () => { const result = Service.getModelName(); expect(result).toBe("Account"); }); + + describe("write-only credentials", () => { + it("tracks AccPass/AccKey even when the API response omits them", () => { + // The backend tags AccPass/AccKey with `json:"-"`, so responses never + // carry them. The Service constructor must still seed __originalValues + // so a user edit in the dialog reaches getValues(true). + const service = new Service({ ID: 1, AccName: "Nextcloud", AccURL: "https://nc.example/" }); + expect(service.AccPass).toBe(""); + expect(service.AccKey).toBe(""); + expect(service.__originalValues.AccPass).toBe(""); + expect(service.__originalValues.AccKey).toBe(""); + }); + + it("includes AccPass/AccKey in the change diff after a dialog edit", () => { + const service = new Service({ ID: 1, AccName: "Nextcloud", AccURL: "https://nc.example/" }); + service.AccPass = "new-secret"; + service.AccKey = "new-key"; + const diff = service.getValues(true); + expect(diff.AccPass).toBe("new-secret"); + expect(diff.AccKey).toBe("new-key"); + }); + + it("does not include AccPass/AccKey when the user leaves them blank", () => { + const service = new Service({ ID: 1, AccName: "Nextcloud", AccURL: "https://nc.example/" }); + service.AccName = "Renamed"; + const diff = service.getValues(true); + expect(diff.AccName).toBe("Renamed"); + expect(diff).not.toHaveProperty("AccPass"); + expect(diff).not.toHaveProperty("AccKey"); + }); + + it("preserves credentials when the constructor receives them via clone()", () => { + // clone() routes through getValues() → new Service(); AccPass that was + // typed into the original must survive the round-trip on __originalValues + // so subsequent edits keep flowing through the diff. + const original = new Service({ ID: 1, AccName: "Nextcloud" }); + original.AccPass = "typed"; + const copy = new Service(original.getValues()); + expect(copy.AccPass).toBe("typed"); + expect(copy.__originalValues.AccPass).toBe("typed"); + }); + }); }); diff --git a/frontend/tests/vitest/model/subject.test.js b/frontend/tests/vitest/model/subject.test.js index 6c7a0d305..5259189ce 100644 --- a/frontend/tests/vitest/model/subject.test.js +++ b/frontend/tests/vitest/model/subject.test.js @@ -1,6 +1,6 @@ import { describe, it, expect, beforeEach, afterEach } from "vitest"; import "../fixtures"; -import { Subject, BatchSize } from "model/subject"; +import { Subject, BatchSize, MaxLength } from "model/subject"; describe("model/subject", () => { let originalBatchSize; @@ -13,6 +13,21 @@ describe("model/subject", () => { Subject.setBatchSize(originalBatchSize); }); + // Pins per-field caps to the backend VARCHAR columns on internal/entity/subject.go + // so client-side validation moves in lockstep with the server. + it("MaxLength mirrors the backend VARCHAR caps", () => { + expect(MaxLength).toEqual({ + Name: 160, + }); + expect(Object.isFrozen(MaxLength)).toBe(true); + }); + + it("trimInputs() strips whitespace from MaxLength string fields", () => { + const subject = new Subject({ Name: " Alice " }); + subject.trimInputs(); + expect(subject.Name).toBe("Alice"); + }); + it("should get face defaults", () => { const values = {}; const subject = new Subject(values); diff --git a/frontend/tests/vitest/model/thumb.test.js b/frontend/tests/vitest/model/thumb.test.js index 03d30e71a..7ffa11a4e 100644 --- a/frontend/tests/vitest/model/thumb.test.js +++ b/frontend/tests/vitest/model/thumb.test.js @@ -1,5 +1,5 @@ -import { describe, it, expect } from "vitest"; -import "../fixtures"; +import { describe, it, expect, vi, beforeEach } from "vitest"; +import { Mock } from "../fixtures"; import Thumb from "model/thumb"; import Photo from "model/photo"; import File from "model/file"; @@ -321,4 +321,187 @@ describe("model/thumb", () => { expect(result4.width).toBe(750); expect(result4.height).toBe(850); }); + + describe("loadPhoto", () => { + it("delegates to Photo.findCached for thumbs with a UID", async () => { + const result = new Photo({ UID: "abc123", Title: "Loaded" }); + const spy = vi.spyOn(Photo, "findCached").mockResolvedValue(result); + const thumb = new Thumb({ UID: "abc123" }); + const photo = await thumb.loadPhoto(); + expect(spy).toHaveBeenCalledWith("abc123"); + expect(photo).toBe(result); + spy.mockRestore(); + }); + + it("resolves to an empty Photo placeholder when the thumb has no UID", async () => { + const spy = vi.spyOn(Photo, "findCached"); + const thumb = new Thumb({ UID: "" }); + const photo = await thumb.loadPhoto(); + // Returns a Photo (not null/undefined) so consumers can read + // .X without nullable chains; UID stays empty as a "not loaded" + // signal. findCached must NOT be called for an empty UID. + expect(photo).toBeInstanceOf(Photo); + expect(photo.UID).toBe(""); + expect(spy).not.toHaveBeenCalled(); + spy.mockRestore(); + }); + + it("propagates ModelCacheStaleFetchError so callers' .catch handlers fire", async () => { + const err = new Error("ModelCache: discarded stale fetch after clear()"); + err.name = "ModelCacheStaleFetchError"; + const spy = vi.spyOn(Photo, "findCached").mockRejectedValue(err); + const thumb = new Thumb({ UID: "abc123" }); + await expect(thumb.loadPhoto()).rejects.toBe(err); + spy.mockRestore(); + }); + }); + + describe("evictPhoto", () => { + it("calls Photo.evictCache with the thumb UID", () => { + const spy = vi.spyOn(Photo, "evictCache"); + const thumb = new Thumb({ UID: "abc123" }); + thumb.evictPhoto(); + expect(spy).toHaveBeenCalledWith("abc123"); + spy.mockRestore(); + }); + + it("is a no-op when the thumb has no UID", () => { + const spy = vi.spyOn(Photo, "evictCache"); + const thumb = new Thumb({ UID: "" }); + thumb.evictPhoto(); + expect(spy).not.toHaveBeenCalled(); + spy.mockRestore(); + }); + }); + + // archive / restore / removeFromAlbum drive the lightbox menu + // visibility (this.model?.Archived / this.model?.Removed checks + // around lightbox.vue:1437). The tests below pin two contracts: + // 1. Right URL + payload shape — verified through the global Mock + // in fixtures.js plus Mock.history for the request log. + // 2. Optimistic-flip + restore-previous-value rollback — a + // literal `false`/`true` rollback would silently promote an + // undefined tri-state field, and an already-archived re-archive + // must not flip back to "not archived" on failure. + // + // Rapid-fire prevention is intentionally a UI concern (see + // $notify.blockUI("busy") in lightbox.vue onArchive / onRestore / + // onRemoveFromAlbum) — the model stays stateless. + // + // Rejection tests use `vi.spyOn($api, ...).mockRejectedValueOnce` + // because axios-mock-adapter matches handlers in registration + // order (see node_modules/axios-mock-adapter/src/utils.js#find); + // a `replyOnce(500)` registered after the persistent `reply(200)` + // in fixtures.js never wins, so it can't simulate a one-off + // failure for an endpoint that has a global success mock. + describe("archive", () => { + beforeEach(() => { + Mock.history.post.length = 0; + }); + + it("flips Archived to true, posts to batch/photos/archive, and resolves on success", async () => { + const thumb = new Thumb({ UID: "abc123" }); + // Pre-condition: Archived is undefined (not in defaults — see + // the explicit-tri-state checks at lightbox.vue:1437). + expect(thumb.Archived).toBeUndefined(); + const response = await thumb.archive(); + expect(response.status).toBe(200); + expect(thumb.Archived).toBe(true); + const calls = Mock.history.post.filter((r) => r.url === "batch/photos/archive"); + expect(calls).toHaveLength(1); + expect(JSON.parse(calls[0].data)).toEqual({ photos: ["abc123"] }); + }); + + it("restores the pre-call Archived value on rejection (was undefined)", async () => { + const $api = (await import("common/api")).default; + const err = new Error("offline"); + const spy = vi.spyOn($api, "post").mockRejectedValueOnce(err); + const thumb = new Thumb({ UID: "abc123" }); + // Pre-state is undefined (default, since Archived isn't in + // getDefaults()). A literal `false` rollback would silently + // promote the field to a boolean — capturing prev preserves + // the tri-state semantics the menu logic depends on. + await expect(thumb.archive()).rejects.toBe(err); + expect(thumb.Archived).toBeUndefined(); + spy.mockRestore(); + }); + + it("preserves Archived on rejection when called on an already-archived thumb", async () => { + // No-op archive of an already-archived photo: backend may + // succeed or 4xx, but a literal `false` rollback would flip a + // truthful "archived" UI to "not archived" on failure. + const $api = (await import("common/api")).default; + const err = new Error("offline"); + const spy = vi.spyOn($api, "post").mockRejectedValueOnce(err); + const thumb = new Thumb({ UID: "abc123", Archived: true }); + await expect(thumb.archive()).rejects.toBe(err); + expect(thumb.Archived).toBe(true); + spy.mockRestore(); + }); + }); + + describe("restore", () => { + beforeEach(() => { + Mock.history.post.length = 0; + }); + + it("flips Archived to false, posts to batch/photos/restore, and resolves on success", async () => { + const thumb = new Thumb({ UID: "abc123", Archived: true }); + const response = await thumb.restore(); + expect(response.status).toBe(200); + expect(thumb.Archived).toBe(false); + const calls = Mock.history.post.filter((r) => r.url === "batch/photos/restore"); + expect(calls).toHaveLength(1); + expect(JSON.parse(calls[0].data)).toEqual({ photos: ["abc123"] }); + }); + + it("restores the pre-call Archived value on rejection (was true)", async () => { + const $api = (await import("common/api")).default; + const err = new Error("offline"); + const spy = vi.spyOn($api, "post").mockRejectedValueOnce(err); + const thumb = new Thumb({ UID: "abc123", Archived: true }); + await expect(thumb.restore()).rejects.toBe(err); + expect(thumb.Archived).toBe(true); + spy.mockRestore(); + }); + + it("preserves Archived on rejection when called on an already-restored thumb", async () => { + // No-op restore of a non-archived photo: capturing prev + // ensures we don't silently flip undefined → true on failure. + const $api = (await import("common/api")).default; + const err = new Error("offline"); + const spy = vi.spyOn($api, "post").mockRejectedValueOnce(err); + const thumb = new Thumb({ UID: "abc123" }); + await expect(thumb.restore()).rejects.toBe(err); + expect(thumb.Archived).toBeUndefined(); + spy.mockRestore(); + }); + }); + + describe("removeFromAlbum", () => { + beforeEach(() => { + Mock.history.delete.length = 0; + }); + + it("flips Removed to true, DELETEs albums/:albumUID/photos, and resolves on success", async () => { + const thumb = new Thumb({ UID: "abc123" }); + expect(thumb.Removed).toBeUndefined(); + const response = await thumb.removeFromAlbum("album-1"); + expect(response.status).toBe(200); + expect(thumb.Removed).toBe(true); + const calls = Mock.history.delete.filter((r) => r.url === "albums/album-1/photos"); + expect(calls).toHaveLength(1); + expect(JSON.parse(calls[0].data)).toEqual({ photos: ["abc123"] }); + }); + + it("restores the pre-call Removed value on rejection (was undefined)", async () => { + const $api = (await import("common/api")).default; + const err = new Error("offline"); + const spy = vi.spyOn($api, "delete").mockRejectedValueOnce(err); + const thumb = new Thumb({ UID: "abc123" }); + await expect(thumb.removeFromAlbum("album-1")).rejects.toBe(err); + expect(thumb.Removed).toBeUndefined(); + spy.mockRestore(); + }); + }); }); diff --git a/frontend/tests/vitest/model/user.test.js b/frontend/tests/vitest/model/user.test.js index ce84c9c70..ef384e96d 100644 --- a/frontend/tests/vitest/model/user.test.js +++ b/frontend/tests/vitest/model/user.test.js @@ -1,9 +1,10 @@ -import { describe, it, expect } from "vitest"; +import { describe, it, expect, afterEach } from "vitest"; import "../fixtures"; import User from "model/user"; import File from "model/file"; import Config from "common/config"; import StorageShim from "node-storage-shim"; +import { $config, $session } from "app/session"; const defaultConfig = new Config(new StorageShim(), window.__CONFIG__); @@ -322,4 +323,235 @@ describe("model/user", () => { const result = await user.changePassword("old", "new"); expect(result.new_password).toBe("new"); }); + + // A10 contract: isRemote / hasWebDAV must always return a Boolean, so a + // `:disabled` binding to these methods never passes undefined / "" to a + // Vuetify Boolean prop. See specs/frontend/best-practices.md#a10. + describe("isRemote / hasWebDAV Boolean contract", () => { + it("isRemote returns Boolean false when AuthProvider is missing", () => { + const user = new User({ ID: 1, Name: "max" }); + const result = user.isRemote(); + expect(typeof result).toBe("boolean"); + expect(result).toBe(false); + }); + it("isRemote returns Boolean false when AuthProvider is empty string", () => { + const user = new User({ ID: 1, Name: "max", AuthProvider: "" }); + expect(typeof user.isRemote()).toBe("boolean"); + expect(user.isRemote()).toBe(false); + }); + it("hasWebDAV returns Boolean false when WebDAV is missing", () => { + const user = new User({ ID: 1, Name: "max", Role: "admin" }); + const result = user.hasWebDAV(); + expect(typeof result).toBe("boolean"); + expect(result).toBe(false); + }); + it("hasWebDAV returns Boolean false when WebDAV is 0", () => { + const user = new User({ ID: 1, Name: "max", Role: "admin", WebDAV: 0 }); + const result = user.hasWebDAV(); + expect(typeof result).toBe("boolean"); + expect(result).toBe(false); + }); + it("hasWebDAV returns Boolean true when WebDAV is true and role permits", () => { + const user = new User({ ID: 1, Name: "max", Role: "admin", WebDAV: true }); + const result = user.hasWebDAV(); + expect(typeof result).toBe("boolean"); + expect(result).toBe(true); + }); + }); + + // canHavePassword gates the admin "change password" action: visitors, system + // users, and accounts with authentication disabled cannot have a local password, + // mirroring the backend, which only allows passwords for registered accounts. + describe("canHavePassword", () => { + it("returns true for a registered local user", () => { + expect(new User({ ID: 1, Name: "max", Role: "user", AuthProvider: "local" }).canHavePassword()).toBe(true); + }); + it("returns true for a registered user without an explicit provider", () => { + expect(new User({ ID: 1, Name: "max", Role: "admin" }).canHavePassword()).toBe(true); + }); + it("returns false for a visitor, even when named guest", () => { + expect(new User({ ID: 1, Name: "guest", Role: "visitor", AuthProvider: "link" }).canHavePassword()).toBe(false); + }); + it("returns false for an account without a role", () => { + expect(new User({ ID: 1, Name: "max", Role: "", AuthProvider: "local" }).canHavePassword()).toBe(false); + }); + it("returns false for a remote LDAP account (credentials managed by the directory)", () => { + expect(new User({ ID: 1, Name: "max", Role: "user", AuthProvider: "ldap" }).canHavePassword()).toBe(false); + }); + it("returns true for an OIDC account (a local password remains usable)", () => { + expect(new User({ ID: 1, Name: "max", Role: "user", AuthProvider: "oidc" }).canHavePassword()).toBe(true); + }); + it("returns false when authentication is disabled (provider none)", () => { + expect(new User({ ID: 1, Name: "max", Role: "user", AuthProvider: "none" }).canHavePassword()).toBe(false); + }); + it("returns false for a system user with ID below 1", () => { + expect(new User({ ID: 0, Name: "max", Role: "user" }).canHavePassword()).toBe(false); + }); + it("returns false without a username", () => { + expect(new User({ ID: 1, Name: "", Role: "user" }).canHavePassword()).toBe(false); + }); + }); + + // canEnableLogin gates the admin "Web Login" toggle: visitors, system users, role-less + // and deactivated accounts cannot log in, but LDAP and OIDC accounts can (unlike passwords). + describe("canEnableLogin", () => { + it("returns true for a registered local user", () => { + expect(new User({ ID: 1, Name: "max", Role: "user", AuthProvider: "local" }).canEnableLogin()).toBe(true); + }); + it("returns true for an LDAP account, unlike canHavePassword", () => { + const user = new User({ ID: 1, Name: "max", Role: "user", AuthProvider: "ldap" }); + expect(user.canEnableLogin()).toBe(true); + expect(user.canHavePassword()).toBe(false); + }); + it("returns true for an OIDC account", () => { + expect(new User({ ID: 1, Name: "max", Role: "user", AuthProvider: "oidc" }).canEnableLogin()).toBe(true); + }); + it("returns false for a visitor", () => { + expect(new User({ ID: 1, Name: "guest", Role: "visitor", AuthProvider: "link" }).canEnableLogin()).toBe(false); + }); + it("returns false for an account without a role", () => { + expect(new User({ ID: 1, Name: "max", Role: "", AuthProvider: "local" }).canEnableLogin()).toBe(false); + }); + it("returns false when authentication is disabled (provider none)", () => { + expect(new User({ ID: 1, Name: "max", Role: "user", AuthProvider: "none" }).canEnableLogin()).toBe(false); + }); + it("returns false for a system user with ID below 1", () => { + expect(new User({ ID: 0, Name: "max", Role: "user" }).canEnableLogin()).toBe(false); + }); + }); + + // isCurrentUser drives the admin-UI self-lockout guards: the table login + // toggle and the dialog role/auth/login fields lock for the signed-in user so + // an operator cannot lock themselves out. See specs/portal/cluster-admin-ui.md. + describe("isCurrentUser", () => { + it("returns true for the signed-in user and false for others", () => { + $session.setUser({ ID: 5, UID: "us1234567890self", Name: "max", Role: "admin" }); + + const me = new User({ ID: 5, UID: "us1234567890self", Name: "max", Role: "admin" }); + expect(me.isCurrentUser()).toBe(true); + + const other = new User({ ID: 6, UID: "us1234567890othr", Name: "alice", Role: "user" }); + expect(other.isCurrentUser()).toBe(false); + }); + it("returns Boolean false when the account has no UID", () => { + $session.setUser({ ID: 5, UID: "us1234567890self", Name: "max", Role: "admin" }); + + const blank = new User({ ID: 0, Name: "" }); + expect(typeof blank.isCurrentUser()).toBe("boolean"); + expect(blank.isCurrentUser()).toBe(false); + }); + }); + + // isAdmin / isClusterAdmin replace hardcoded role-string checks in the admin + // dialogs (e.g. the Super Admin toggle); isAdmin mirrors the backend admin-tier + // set {admin, cluster_admin}, isClusterAdmin matches only the Portal operator role. + describe("isAdmin / isClusterAdmin", () => { + it("isAdmin is true for admin and cluster_admin, false otherwise", () => { + expect(new User({ ID: 1, Name: "a", Role: "admin" }).isAdmin()).toBe(true); + expect(new User({ ID: 2, Name: "b", Role: "cluster_admin" }).isAdmin()).toBe(true); + expect(new User({ ID: 3, Name: "c", Role: "user" }).isAdmin()).toBe(false); + expect(new User({ ID: 4, Name: "d", Role: "" }).isAdmin()).toBe(false); + }); + it("isClusterAdmin is true only for cluster_admin", () => { + expect(new User({ ID: 2, Name: "b", Role: "cluster_admin" }).isClusterAdmin()).toBe(true); + expect(new User({ ID: 1, Name: "a", Role: "admin" }).isClusterAdmin()).toBe(false); + }); + it("isInitialAdmin is true only for the built-in super admin (ID 1)", () => { + expect(new User({ ID: 1, Name: "admin", Role: "admin", SuperAdmin: true }).isInitialAdmin()).toBe(true); + expect(new User({ ID: 2, Name: "sven", Role: "admin", SuperAdmin: true }).isInitialAdmin()).toBe(false); + expect(new User({ ID: 0, Name: "" }).isInitialAdmin()).toBe(false); + }); + }); + + // Account-dialog auth field gating shared by the Pro and Portal "Add Account" + // dialogs. The external-auth branches read the global $config (ext.oidc/ext.ldap), + // so each case sets and restores it explicitly. + describe("auth field gating", () => { + const setExt = (ext) => { + $config.values.ext = ext; + }; + afterEach(() => { + setExt(undefined); + }); + it("shows the password field for default, local and oidc but not ldap or none", () => { + expect(new User({ AuthProvider: "default" }).showsPasswordField()).toBe(true); + expect(new User({ AuthProvider: "local" }).showsPasswordField()).toBe(true); + expect(new User({ AuthProvider: "oidc" }).showsPasswordField()).toBe(true); + expect(new User({ AuthProvider: "ldap" }).showsPasswordField()).toBe(false); + expect(new User({ AuthProvider: "none" }).showsPasswordField()).toBe(false); + }); + it("requires a password for local, and for default without an external identity", () => { + expect(new User({ AuthProvider: "local" }).passwordIsRequired()).toBe(true); + // "default" with no OIDC/LDAP configured must require a password (regression: + // previously optional, so the ADD button enabled with only a username). + expect(new User({ AuthProvider: "default" }).passwordIsRequired()).toBe(true); + expect(new User({ AuthProvider: "oidc" }).passwordIsRequired()).toBe(false); + expect(new User({ AuthProvider: "ldap" }).passwordIsRequired()).toBe(false); + expect(new User({ AuthProvider: "none" }).passwordIsRequired()).toBe(false); + }); + it("makes the password optional for default when external auth can be supplied", () => { + setExt({ oidc: { enabled: true } }); + expect(new User({ AuthProvider: "default" }).passwordIsRequired()).toBe(false); + expect(new User({ AuthProvider: "default" }).showsAuthIdField()).toBe(true); + }); + it("shows the auth-id field for oidc and ldap, and for default only when configured", () => { + expect(new User({ AuthProvider: "oidc" }).showsAuthIdField()).toBe(true); + expect(new User({ AuthProvider: "ldap" }).showsAuthIdField()).toBe(true); + expect(new User({ AuthProvider: "default" }).showsAuthIdField()).toBe(false); + setExt({ ldap: { enabled: true } }); + expect(new User({ AuthProvider: "default" }).showsAuthIdField()).toBe(true); + expect(new User({ AuthProvider: "local" }).showsAuthIdField()).toBe(false); + expect(new User({ AuthProvider: "none" }).showsAuthIdField()).toBe(false); + }); + it("requires the auth-id only for an explicit oidc account", () => { + expect(new User({ AuthProvider: "oidc" }).authIdIsRequired()).toBe(true); + setExt({ oidc: { enabled: true } }); + expect(new User({ AuthProvider: "default" }).authIdIsRequired()).toBe(false); + expect(new User({ AuthProvider: "ldap" }).authIdIsRequired()).toBe(false); + }); + it("treats the auth-id as a DN for ldap, and for default when only LDAP is configured", () => { + expect(new User({ AuthProvider: "ldap" }).authIdIsDn()).toBe(true); + expect(new User({ AuthProvider: "oidc" }).authIdIsDn()).toBe(false); + setExt({ ldap: { enabled: true } }); + expect(new User({ AuthProvider: "default" }).authIdIsDn()).toBe(true); + setExt({ oidc: { enabled: true }, ldap: { enabled: true } }); + expect(new User({ AuthProvider: "default" }).authIdIsDn()).toBe(false); + }); + it("labels the auth-id field from authIdIsDn", () => { + expect(new User({ AuthProvider: "ldap" }).authIdFieldLabel()).toBe("Distinguished Name (DN)"); + expect(new User({ AuthProvider: "oidc" }).authIdFieldLabel()).toBe("Subject ID"); + }); + it("requires a local password when one is mandatory, independent of form timing", () => { + // "local" always needs a password, so the Add button must stay disabled until it is set. + expect(new User({ AuthProvider: "local" }).hasLoginCredential()).toBe(false); + expect(new User({ AuthProvider: "local", Password: "secret123" }).hasLoginCredential()).toBe(true); + // "default" without external auth behaves like a local account. + expect(new User({ AuthProvider: "default" }).hasLoginCredential()).toBe(false); + expect(new User({ AuthProvider: "default", Password: "secret123" }).hasLoginCredential()).toBe(true); + }); + it("requires a password or Subject ID for default with OIDC configured", () => { + setExt({ oidc: { enabled: true } }); + // default + OIDC, neither password nor Subject ID → inert, blocked. + expect(new User({ AuthProvider: "default" }).hasLoginCredential()).toBe(false); + expect(new User({ AuthProvider: "default", Password: "secret123" }).hasLoginCredential()).toBe(true); + expect(new User({ AuthProvider: "default", AuthID: "sub-123" }).hasLoginCredential()).toBe(true); + }); + it("requires the AuthID (DN) for default authenticating against LDAP", () => { + setExt({ ldap: { enabled: true } }); + // default + LDAP: a globally enabled directory is not enough; a DN (or password) is required. + expect(new User({ AuthProvider: "default" }).hasLoginCredential()).toBe(false); + expect(new User({ AuthProvider: "default", AuthID: "cn=jane,dc=example,dc=com" }).hasLoginCredential()).toBe(true); + expect(new User({ AuthProvider: "default", Password: "secret123" }).hasLoginCredential()).toBe(true); + // explicit ldap: a DN is optional, so a username-only account is allowed. + expect(new User({ AuthProvider: "ldap" }).hasLoginCredential()).toBe(true); + }); + it("requires the Subject ID for an explicit OIDC account, independent of form timing", () => { + expect(new User({ AuthProvider: "oidc" }).hasLoginCredential()).toBe(false); + expect(new User({ AuthProvider: "oidc", AuthID: "sub-123" }).hasLoginCredential()).toBe(true); + }); + it("defers to the per-field rules for the none provider", () => { + setExt({ oidc: { enabled: true } }); + expect(new User({ AuthProvider: "none" }).hasLoginCredential()).toBe(true); + }); + }); }); diff --git a/frontend/tests/vitest/options/auth.test.js b/frontend/tests/vitest/options/auth.test.js new file mode 100644 index 000000000..fe00b5367 --- /dev/null +++ b/frontend/tests/vitest/options/auth.test.js @@ -0,0 +1,71 @@ +import { describe, it, expect } from "vitest"; +import { Roles, Providers, RoleLabel, RoleOptions, ProviderLabel, ProviderOptions } from "options/auth"; + +describe("options/auth RoleLabel", () => { + it("resolves mapped roles from the shared Roles map", () => { + expect(RoleLabel("admin")).toBe(Roles()["admin"]); + expect(RoleLabel("cluster_admin")).toBe(Roles()["cluster_admin"]); + }); + it("falls back to the raw key when unmapped", () => { + expect(RoleLabel("does-not-exist")).toBe("does-not-exist"); + }); +}); + +describe("options/auth RoleOptions", () => { + it("builds {value, text} options in the given order with shared labels", () => { + expect(RoleOptions(["admin", "guest"])).toEqual([ + { value: "admin", text: Roles()["admin"] }, + { value: "guest", text: Roles()["guest"] }, + ]); + }); + it("uses the requested label key (title for Vuetify item-title)", () => { + const [opt] = RoleOptions(["viewer"], "title"); + expect(opt).toEqual({ value: "viewer", title: Roles()["viewer"] }); + }); + it("leaves the list unchanged when the current role is already selectable", () => { + expect(RoleOptions(["admin", "user"], "text", "admin")).toEqual([ + { value: "admin", text: Roles()["admin"] }, + { value: "user", text: Roles()["user"] }, + ]); + }); + it("appends an out-of-list current role as a labeled, disabled option", () => { + const options = RoleOptions(["admin", "user"], "text", "cluster_admin"); + expect(options).toHaveLength(3); + expect(options[2]).toEqual({ value: "cluster_admin", text: Roles()["cluster_admin"], disabled: true }); + }); + it("appends the empty Unauthorized role as a labeled, disabled option", () => { + const options = RoleOptions(["admin"], "text", ""); + expect(options).toHaveLength(2); + expect(options[1]).toEqual({ value: "", text: Roles()[""], disabled: true }); + }); + it("appends nothing when there is no current role (null or omitted)", () => { + expect(RoleOptions(["admin"])).toEqual([{ value: "admin", text: Roles()["admin"] }]); + expect(RoleOptions(["admin"], "text", null)).toEqual([{ value: "admin", text: Roles()["admin"] }]); + }); +}); + +describe("options/auth ProviderLabel", () => { + it("resolves mapped providers from the shared Providers map", () => { + expect(ProviderLabel("oidc")).toBe(Providers()["oidc"]); + expect(ProviderLabel("ldap")).toBe(Providers()["ldap"]); + }); + it("falls back to the raw key when unmapped", () => { + expect(ProviderLabel("does-not-exist")).toBe("does-not-exist"); + }); +}); + +describe("options/auth ProviderOptions", () => { + it("builds {value, text} options with shared labels", () => { + expect(ProviderOptions(["local", "oidc"])).toEqual([ + { value: "local", text: Providers()["local"] }, + { value: "oidc", text: Providers()["oidc"] }, + ]); + }); +}); + +describe("options/auth standardized identifiers stay untranslated", () => { + it("keeps OIDC and Client Credentials as literal labels", () => { + expect(Providers()["oidc"]).toBe("OIDC"); + expect(Providers()["client_credentials"]).toBe("Client Credentials"); + }); +}); diff --git a/frontend/tests/vitest/options/options.test.js b/frontend/tests/vitest/options/options.test.js index dbc279b8d..87eaa053c 100644 --- a/frontend/tests/vitest/options/options.test.js +++ b/frontend/tests/vitest/options/options.test.js @@ -3,7 +3,9 @@ import "../fixtures"; import * as options from "options/options"; import { AccountTypes, + AlbumSortOrder, Colors, + DownloadName, Expires, FallbackLocale, FeedbackCategories, @@ -18,8 +20,8 @@ import { PhotoTypes, RetryLimits, SetDefaultLocale, + SortOrderOptions, StartPages, - ThumbFilters, ThumbSizes, Timeouts, } from "options/options"; @@ -247,10 +249,6 @@ describe("options/options", () => { expect(ThumbSizes()[1].value).toBe("fit_720"); }); - it("should return thumb filters", () => { - expect(ThumbFilters()[0].value).toBe("blackman"); - }); - it("should return gender", () => { expect(Gender()[2].value).toBe("other"); }); @@ -263,4 +261,44 @@ describe("options/options", () => { expect(AccountTypes()[0].value).toBe("webdav"); expect(AccountTypes().length).toBe(1); }); + + it("should return download name options", () => { + const downloadNames = DownloadName(); + expect(downloadNames).toHaveLength(3); + expect(downloadNames[0].value).toBe("file"); + expect(downloadNames[0].text).toBe("Current Name"); + expect(downloadNames[1].value).toBe("original"); + expect(downloadNames[1].text).toBe("Original Name"); + expect(downloadNames[2].value).toBe("share"); + expect(downloadNames[2].text).toBe("Share Friendly"); + }); + + it("should return album sort order options", () => { + const sortOrders = AlbumSortOrder(); + expect(sortOrders).toHaveLength(8); + expect(sortOrders[0].value).toBe("newest"); + expect(sortOrders[0].text).toBe("Newest First"); + expect(sortOrders[1].value).toBe("oldest"); + expect(sortOrders[1].text).toBe("Oldest First"); + expect(sortOrders[2].value).toBe("added"); + expect(sortOrders[3].value).toBe("title"); + expect(sortOrders[4].value).toBe("name"); + expect(sortOrders[5].value).toBe("size"); + expect(sortOrders[6].value).toBe("duration"); + expect(sortOrders[7].value).toBe("relevance"); + }); + + it("should build sort order options for the requested keys, in order", () => { + const opts = SortOrderOptions(["relevance", "newest", "archived"]); + expect(opts).toHaveLength(3); + expect(opts[0]).toEqual({ value: "relevance", text: "Most Relevant" }); + expect(opts[1]).toEqual({ value: "newest", text: "Newest First" }); + expect(opts[2]).toEqual({ value: "archived", text: "Recently Archived" }); + }); + + it("should skip unknown sort order keys", () => { + const opts = SortOrderOptions(["newest", "bogus", "similar"]); + expect(opts.map((o) => o.value)).toEqual(["newest", "similar"]); + expect(opts[1].text).toBe("Visual Similarity"); + }); }); diff --git a/frontend/tests/vitest/page/albums.onupdate.test.js b/frontend/tests/vitest/page/albums.onupdate.test.js new file mode 100644 index 000000000..491e32479 --- /dev/null +++ b/frontend/tests/vitest/page/albums.onupdate.test.js @@ -0,0 +1,152 @@ +// Targets the onUpdate switch and the uid-scoped refetch helpers in +// page/albums.vue. Calling the Options API methods directly with a +// stub `this` exercises the dispatch logic in isolation, pinning the +// contract that albums.created and albums.updated are UID-only signals +// answered by one uid-filtered query instead of a full result refresh. +import { describe, it, expect, beforeEach, afterEach, vi } from "vitest"; + +import PPageAlbums from "page/albums.vue"; +import Album from "model/album"; + +// Captures the surface of `this` that the handlers touch. +function newStub() { + return { + listen: true, + dirty: false, + results: [], + staticFilter: { type: "album" }, + refresh: vi.fn(), + refetchResults: vi.fn(), + insertCreated: vi.fn(), + removeSelection: vi.fn(), + }; +} + +describe("page/albums.vue onUpdate", () => { + const onUpdate = PPageAlbums.methods.onUpdate; + + let warnSpy; + beforeEach(() => { + vi.spyOn(console, "log").mockImplementation(() => {}); + warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {}); + }); + + it("delegates albums.updated to the uid-scoped refetch", () => { + const stub = newStub(); + + onUpdate.call(stub, "albums.updated", { entities: ["album-1"] }); + + expect(stub.refetchResults).toHaveBeenCalledWith(["album-1"]); + expect(stub.refresh).not.toHaveBeenCalled(); + expect(warnSpy).not.toHaveBeenCalled(); + }); + + it("inserts created albums without a full refresh", () => { + const stub = newStub(); + + onUpdate.call(stub, "albums.created", { entities: ["album-2"] }); + + expect(stub.dirty).toBe(true); + expect(stub.insertCreated).toHaveBeenCalledWith(["album-2"]); + expect(stub.refresh).not.toHaveBeenCalled(); + }); + + it("removes deleted albums from results and selection", () => { + const stub = newStub(); + stub.results = [{ UID: "album-1" }, { UID: "album-2" }]; + + onUpdate.call(stub, "albums.deleted", { entities: ["album-1"] }); + + expect(stub.dirty).toBe(true); + expect(stub.results.map((m) => m.UID)).toEqual(["album-2"]); + expect(stub.removeSelection).toHaveBeenCalledWith("album-1"); + }); + + it("ignores events when listen=false", () => { + const stub = newStub(); + stub.listen = false; + + onUpdate.call(stub, "albums.updated", { entities: ["album-1"] }); + + expect(stub.refetchResults).not.toHaveBeenCalled(); + }); +}); + +describe("page/albums.vue refetchResults", () => { + const refetchResults = PPageAlbums.methods.refetchResults; + + let searchSpy; + afterEach(() => { + searchSpy?.mockRestore(); + }); + + it("patches affected loaded albums through one uid-scoped search", async () => { + const stub = newStub(); + stub.results = [{ UID: "album-1", Title: "Old" }]; + searchSpy = vi.spyOn(Album, "search").mockResolvedValue({ models: [{ UID: "album-1", Title: "New" }] }); + + refetchResults.call(stub, ["album-1", "album-not-loaded"]); + await Promise.resolve(); + await Promise.resolve(); + + expect(searchSpy).toHaveBeenCalledTimes(1); + expect(searchSpy).toHaveBeenCalledWith({ uid: "album-1", count: 1 }); + expect(stub.results[0].Title).toBe("New"); + expect(stub.dirty).toBe(false); + }); + + it("removes albums the scoped search no longer returns", async () => { + const stub = newStub(); + stub.results = [{ UID: "album-gone" }]; + searchSpy = vi.spyOn(Album, "search").mockResolvedValue({ models: [] }); + + refetchResults.call(stub, ["album-gone"]); + await Promise.resolve(); + await Promise.resolve(); + + expect(stub.results).toEqual([]); + expect(stub.removeSelection).toHaveBeenCalledWith("album-gone"); + }); + + it("does nothing when no affected album is loaded", () => { + const stub = newStub(); + searchSpy = vi.spyOn(Album, "search").mockResolvedValue({ models: [] }); + + refetchResults.call(stub, ["album-1"]); + + expect(searchSpy).not.toHaveBeenCalled(); + }); +}); + +describe("page/albums.vue insertCreated", () => { + const insertCreated = PPageAlbums.methods.insertCreated; + + let searchSpy; + afterEach(() => { + searchSpy?.mockRestore(); + }); + + it("prepends new albums matching the current view type", async () => { + const stub = newStub(); + searchSpy = vi.spyOn(Album, "search").mockResolvedValue({ models: [{ UID: "album-new", Title: "New Album" }] }); + + insertCreated.call(stub, ["album-new"]); + await Promise.resolve(); + await Promise.resolve(); + + expect(searchSpy).toHaveBeenCalledWith({ uid: "album-new", count: 1, type: "album" }); + expect(stub.results.map((m) => m.UID)).toEqual(["album-new"]); + }); + + it("does not duplicate albums that are already loaded", async () => { + const stub = newStub(); + stub.results = [{ UID: "album-new" }]; + searchSpy = vi.spyOn(Album, "search").mockResolvedValue({ models: [{ UID: "album-new" }] }); + + insertCreated.call(stub, ["album-new"]); + await Promise.resolve(); + await Promise.resolve(); + + expect(stub.results).toHaveLength(1); + }); +}); diff --git a/frontend/tests/vitest/page/auth/login.test.js b/frontend/tests/vitest/page/auth/login.test.js new file mode 100644 index 000000000..ebd8b5d5a --- /dev/null +++ b/frontend/tests/vitest/page/auth/login.test.js @@ -0,0 +1,222 @@ +import { describe, it, expect, beforeEach, vi } from "vitest"; +import { shallowMount, flushPromises, config as VTUConfig } from "@vue/test-utils"; +import PPageLogin from "page/auth/login.vue"; +import { buildNamespace } from "common/storage"; +import clientConfig from "../../config"; + +const storagePrefix = buildNamespace(clientConfig.storageNamespace); + +function mountLogin({ oidcEnabled = false, oidcRedirect = false, sessionOverrides = {}, configOverrides = {} } = {}) { + const baseConfig = VTUConfig.global.mocks.$config || {}; + const baseSession = VTUConfig.global.mocks.$session || {}; + const baseNotify = VTUConfig.global.mocks.$notify || {}; + const baseView = VTUConfig.global.mocks.$view || {}; + + const session = { + login: vi.fn(() => Promise.resolve(false)), + followRedirect: vi.fn(), + followLoginRedirectUrl: vi.fn(), + useLocalStorage: vi.fn(), + useSessionStorage: vi.fn(), + usesSessionStorage: vi.fn(() => false), + getDefaultRoute: vi.fn(() => "browse"), + isAuthenticated: vi.fn(() => false), + consumeLogoutSignal: vi.fn(() => false), + markLoginRedirectAttempt: vi.fn(), + markOidcAttempt: vi.fn(), + ...baseSession, + ...sessionOverrides, + }; + + const configMock = { + ...baseConfig, + isSponsor: vi.fn(() => false), + getSiteDescription: vi.fn(() => "Open-Source Photo Management"), + getSettings: vi.fn(() => ({ ui: { language: "en" }, features: {} })), + isRtl: vi.fn(() => false), + values: { + ...clientConfig, + registerUri: "", + passwordResetUri: "", + wallpaperUri: "", + ext: { + oidc: { + enabled: oidcEnabled, + redirect: oidcRedirect, + loginUri: oidcEnabled ? "/api/v1/oidc/login" : "", + provider: "OIDC", + icon: "/oidc.svg", + }, + }, + ...configOverrides, + }, + }; + + return { + wrapper: shallowMount(PPageLogin, { + global: { + mocks: { + $config: configMock, + $session: session, + $router: { resolve: vi.fn(() => ({ href: "/library/browse" })) }, + $view: { + ...baseView, + enter: vi.fn(), + leave: vi.fn(), + focus: vi.fn(), + redirect: vi.fn(), + }, + $notify: { + ...baseNotify, + warn: vi.fn(), + error: vi.fn(), + }, + }, + stubs: { + PAuthHeader: true, + PAuthFooter: true, + }, + }, + }), + session, + }; +} + +describe("page/auth/login", () => { + beforeEach(() => { + window.localStorage.clear(); + window.sessionStorage.clear(); + }); + + it("defaults to staying signed in when no session preference is stored", () => { + const { wrapper } = mountLogin(); + expect(wrapper.vm.staySignedIn).toBe(true); + }); + + it("initializes from the current session state when sessionStorage is active", () => { + const { wrapper } = mountLogin({ + sessionOverrides: { + usesSessionStorage: vi.fn(() => true), + }, + }); + + expect(wrapper.vm.staySignedIn).toBe(false); + }); + + it("falls back to namespaced localStorage when session state is unavailable", () => { + window.localStorage.setItem(`${storagePrefix}session`, "true"); + const { wrapper } = mountLogin({ + sessionOverrides: { + usesSessionStorage: undefined, + }, + }); + + expect(wrapper.vm.staySignedIn).toBe(false); + }); + + it("uses localStorage-backed sessions for password login when stay signed in is enabled", async () => { + const { wrapper, session } = mountLogin(); + + wrapper.vm.username = " admin "; + wrapper.vm.password = " photoprism "; + wrapper.vm.code = " 123456 "; + wrapper.vm.staySignedIn = true; + wrapper.vm.onLogin(); + + await flushPromises(); + + expect(session.useLocalStorage).toHaveBeenCalledTimes(1); + expect(session.useSessionStorage).not.toHaveBeenCalled(); + expect(session.login).toHaveBeenCalledWith("admin", "photoprism", "123456"); + }); + + it("uses sessionStorage-backed sessions for OIDC login when stay signed in is disabled", () => { + const { wrapper, session } = mountLogin({ oidcEnabled: true }); + + wrapper.vm.staySignedIn = false; + wrapper.vm.onOidcLogin(); + + expect(session.useSessionStorage).toHaveBeenCalledTimes(1); + expect(session.useLocalStorage).not.toHaveBeenCalled(); + expect(session.followRedirect).toHaveBeenCalledWith("/api/v1/oidc/login"); + // The manual OIDC button arms the per-tab OIDC attempt guard, like the + // auto-redirect in the /login route guard does. It must NOT arm the + // post-login redirect-loop guard, or an authenticated return within the + // loop window would discard the stored deep link / Portal return_to. + expect(session.markOidcAttempt).toHaveBeenCalledTimes(1); + expect(session.markLoginRedirectAttempt).not.toHaveBeenCalled(); + }); + + it("reset clears the inputs and code-entry state", () => { + const { wrapper } = mountLogin(); + + Object.assign(wrapper.vm, { + username: "x", + password: "y", + showPassword: true, + useRecoveryCode: true, + code: "123456", + enterCode: true, + }); + wrapper.vm.reset(); + + expect(wrapper.vm.username).toBe(""); + expect(wrapper.vm.password).toBe(""); + expect(wrapper.vm.showPassword).toBe(false); + expect(wrapper.vm.useRecoveryCode).toBe(false); + expect(wrapper.vm.code).toBe(""); + expect(wrapper.vm.enterCode).toBe(false); + }); + + it("surfaces a stored OIDC sign-in error via the notification toast and consumes it", () => { + window.localStorage.setItem(`${storagePrefix}session.error`, "You do not have access to this instance."); + + const { wrapper } = mountLogin({ oidcEnabled: true }); + + // Consumed on mount so it does not reappear on the next reload. With no + // messageId, the server-rendered fallback string is surfaced as-is. + expect(window.localStorage.getItem(`${storagePrefix}session.error`)).toBeNull(); + expect(wrapper.vm.$notify.error).toHaveBeenCalledWith("You do not have access to this instance.", null, []); + }); + + it("forwards a stored OIDC error by message key so it renders in the current UI locale", () => { + window.localStorage.setItem(`${storagePrefix}session.error`, "Registration disabled"); + window.localStorage.setItem(`${storagePrefix}session.messageId`, "Registration disabled"); + window.localStorage.setItem(`${storagePrefix}session.messageParams`, JSON.stringify([])); + + const { wrapper } = mountLogin({ oidcEnabled: true }); + + // All three keys are consumed on mount so the toast does not reappear. + expect(window.localStorage.getItem(`${storagePrefix}session.error`)).toBeNull(); + expect(window.localStorage.getItem(`${storagePrefix}session.messageId`)).toBeNull(); + expect(window.localStorage.getItem(`${storagePrefix}session.messageParams`)).toBeNull(); + // The message key is forwarded so notify.vue translates it via Tp. + expect(wrapper.vm.$notify.error).toHaveBeenCalledWith("Registration disabled", "Registration disabled", []); + }); + + // Auto-OIDC redirect for unauthenticated visitors now lives in the + // /login route guard (see frontend/tests/vitest/app/routes.test.js). + // Mounting the component must NEVER bounce the user — manual visits + // to /library/login have to keep working when PHOTOPRISM_OIDC_REDIRECT + // is on, so users can still authenticate with local or LDAP/AD + // credentials. + describe("does not auto-redirect on mount", () => { + it("never calls followRedirect when oidc.redirect is enabled and the user is unauthenticated", () => { + const { session } = mountLogin({ oidcEnabled: true, oidcRedirect: true }); + + expect(session.followRedirect).not.toHaveBeenCalled(); + }); + + it("never calls followRedirect when oidc.redirect is disabled", () => { + const { session } = mountLogin({ oidcEnabled: true, oidcRedirect: false }); + + expect(session.followRedirect).not.toHaveBeenCalled(); + }); + + it("never reads the logout signal during mount (route guard owns it)", () => { + const { session } = mountLogin({ oidcEnabled: true, oidcRedirect: true }); + + expect(session.consumeLogoutSignal).not.toHaveBeenCalled(); + }); + }); +}); diff --git a/frontend/tests/vitest/page/labels-subjects.onupdate.test.js b/frontend/tests/vitest/page/labels-subjects.onupdate.test.js new file mode 100644 index 000000000..4078b8a98 --- /dev/null +++ b/frontend/tests/vitest/page/labels-subjects.onupdate.test.js @@ -0,0 +1,234 @@ +// Targets the onUpdate switch and the refetchResults helper in +// page/labels.vue and page/people/recognized.vue. Calling the Options +// API methods directly with a stub `this` exercises the dispatch logic +// in isolation, pinning the contract that labels.updated and +// subjects.updated are UID-only signals answered by one uid-filtered +// query instead of a full result refresh. +import { describe, it, expect, beforeEach, afterEach, vi } from "vitest"; + +import PPageLabels from "page/labels.vue"; +import PPageSubjects from "page/people/recognized.vue"; +import Label from "model/label"; +import Subject from "model/subject"; + +// Captures the surface of `this` that the handlers touch. +function newStub() { + return { + listen: true, + dirty: false, + results: [], + refresh: vi.fn(), + refetchResults: vi.fn(), + removeSelection: vi.fn(), + }; +} + +describe("page/labels.vue onUpdate", () => { + const onUpdate = PPageLabels.methods.onUpdate; + + let warnSpy; + beforeEach(() => { + warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {}); + }); + + it("delegates labels.updated to the uid-scoped refetch", () => { + const stub = newStub(); + + onUpdate.call(stub, "labels.updated", { entities: ["label-1"] }); + + expect(stub.refetchResults).toHaveBeenCalledWith(["label-1"]); + expect(stub.refresh).not.toHaveBeenCalled(); + expect(warnSpy).not.toHaveBeenCalled(); + }); + + it("marks the list dirty on labels.created", () => { + const stub = newStub(); + + onUpdate.call(stub, "labels.created", { entities: ["label-2"] }); + + expect(stub.dirty).toBe(true); + expect(stub.refetchResults).not.toHaveBeenCalled(); + }); + + it("removes deleted labels from results and selection", () => { + const stub = newStub(); + stub.results = [{ UID: "label-1" }, { UID: "label-2" }]; + + onUpdate.call(stub, "labels.deleted", { entities: ["label-1"] }); + + expect(stub.dirty).toBe(true); + expect(stub.results.map((m) => m.UID)).toEqual(["label-2"]); + expect(stub.removeSelection).toHaveBeenCalledWith("label-1"); + }); + + it("ignores events when listen=false", () => { + const stub = newStub(); + stub.listen = false; + + onUpdate.call(stub, "labels.updated", { entities: ["label-1"] }); + + expect(stub.refetchResults).not.toHaveBeenCalled(); + }); +}); + +describe("page/labels.vue refetchResults", () => { + const refetchResults = PPageLabels.methods.refetchResults; + + let searchSpy; + afterEach(() => { + searchSpy?.mockRestore(); + }); + + it("patches affected loaded labels through one uid-scoped search", async () => { + const stub = newStub(); + stub.results = [{ UID: "label-1", Name: "Old", PhotoCount: 1 }]; + searchSpy = vi.spyOn(Label, "search").mockResolvedValue({ models: [{ UID: "label-1", Name: "New", PhotoCount: 2 }] }); + + refetchResults.call(stub, ["label-1", "label-not-loaded"]); + await Promise.resolve(); + await Promise.resolve(); + + expect(searchSpy).toHaveBeenCalledTimes(1); + expect(searchSpy).toHaveBeenCalledWith({ uid: "label-1", count: 1 }); + expect(stub.results[0].Name).toBe("New"); + expect(stub.results[0].PhotoCount).toBe(2); + expect(stub.dirty).toBe(false); + }); + + it("removes labels the scoped search no longer returns", async () => { + const stub = newStub(); + stub.results = [{ UID: "label-gone" }]; + searchSpy = vi.spyOn(Label, "search").mockResolvedValue({ models: [] }); + + refetchResults.call(stub, ["label-gone"]); + await Promise.resolve(); + await Promise.resolve(); + + expect(stub.results).toEqual([]); + expect(stub.removeSelection).toHaveBeenCalledWith("label-gone"); + }); + + it("does nothing when no affected label is loaded", () => { + const stub = newStub(); + searchSpy = vi.spyOn(Label, "search").mockResolvedValue({ models: [] }); + + refetchResults.call(stub, ["label-1"]); + + expect(searchSpy).not.toHaveBeenCalled(); + }); + + it("falls back to the dirty flag for oversized batches", () => { + const stub = newStub(); + const uids = Array.from({ length: 51 }, (_, i) => `label-${i}`); + stub.results = uids.map((uid) => ({ UID: uid })); + searchSpy = vi.spyOn(Label, "search").mockResolvedValue({ models: [] }); + + refetchResults.call(stub, uids); + + expect(searchSpy).not.toHaveBeenCalled(); + expect(stub.dirty).toBe(true); + }); + + it("marks the results dirty when the refetch fails", async () => { + const stub = newStub(); + stub.results = [{ UID: "label-1" }]; + searchSpy = vi.spyOn(Label, "search").mockRejectedValue(new Error("offline")); + + refetchResults.call(stub, ["label-1"]); + await Promise.resolve(); + await Promise.resolve(); + + expect(stub.dirty).toBe(true); + }); +}); + +describe("page/people/recognized.vue onUpdate", () => { + const onUpdate = PPageSubjects.methods.onUpdate; + + it("delegates subjects.updated to the uid-scoped refetch", () => { + const stub = newStub(); + + onUpdate.call(stub, "subjects.updated", { entities: ["subj-1"] }); + + expect(stub.refetchResults).toHaveBeenCalledWith(["subj-1"]); + expect(stub.refresh).not.toHaveBeenCalled(); + }); + + it("marks the list dirty on subjects.created", () => { + const stub = newStub(); + + onUpdate.call(stub, "subjects.created", { entities: ["subj-2"] }); + + expect(stub.dirty).toBe(true); + expect(stub.refetchResults).not.toHaveBeenCalled(); + }); + + it("removes deleted subjects from results and selection", () => { + const stub = newStub(); + stub.results = [{ UID: "subj-1" }, { UID: "subj-2" }]; + + onUpdate.call(stub, "subjects.deleted", { entities: ["subj-1"] }); + + expect(stub.dirty).toBe(true); + expect(stub.results.map((m) => m.UID)).toEqual(["subj-2"]); + expect(stub.removeSelection).toHaveBeenCalledWith("subj-1"); + }); + + it("ignores events when listen=false", () => { + const stub = newStub(); + stub.listen = false; + + onUpdate.call(stub, "subjects.updated", { entities: ["subj-1"] }); + + expect(stub.refetchResults).not.toHaveBeenCalled(); + }); +}); + +describe("page/people/recognized.vue refetchResults", () => { + const refetchResults = PPageSubjects.methods.refetchResults; + + let searchSpy; + afterEach(() => { + searchSpy?.mockRestore(); + }); + + it("patches affected loaded subjects through one uid-scoped search", async () => { + const stub = newStub(); + stub.results = [{ UID: "subj-1", Name: "Old Name", Favorite: false }]; + searchSpy = vi.spyOn(Subject, "search").mockResolvedValue({ models: [{ UID: "subj-1", Name: "New Name", Favorite: true }] }); + + refetchResults.call(stub, ["subj-1"]); + await Promise.resolve(); + await Promise.resolve(); + + expect(searchSpy).toHaveBeenCalledWith({ uid: "subj-1", count: 1 }); + expect(stub.results[0].Name).toBe("New Name"); + expect(stub.results[0].Favorite).toBe(true); + expect(stub.dirty).toBe(false); + }); + + it("removes subjects the scoped search no longer returns", async () => { + const stub = newStub(); + stub.results = [{ UID: "subj-gone" }]; + searchSpy = vi.spyOn(Subject, "search").mockResolvedValue({ models: [] }); + + refetchResults.call(stub, ["subj-gone"]); + await Promise.resolve(); + await Promise.resolve(); + + expect(stub.results).toEqual([]); + expect(stub.removeSelection).toHaveBeenCalledWith("subj-gone"); + }); + + it("marks the results dirty when the refetch fails", async () => { + const stub = newStub(); + stub.results = [{ UID: "subj-1" }]; + searchSpy = vi.spyOn(Subject, "search").mockRejectedValue(new Error("offline")); + + refetchResults.call(stub, ["subj-1"]); + await Promise.resolve(); + await Promise.resolve(); + + expect(stub.dirty).toBe(true); + }); +}); diff --git a/frontend/tests/vitest/page/photos.onupdate.test.js b/frontend/tests/vitest/page/photos.onupdate.test.js new file mode 100644 index 000000000..1066a8015 --- /dev/null +++ b/frontend/tests/vitest/page/photos.onupdate.test.js @@ -0,0 +1,298 @@ +// Targets the onUpdate switch and the refetchResults helper in +// page/photos.vue and page/album/photos.vue. Booting the full SFC via +// @vue/test-utils would require Vuetify, the router, and the page's +// data() initial state — overkill for verifying dispatch on a single +// event type. Calling the Options API methods directly with a stub +// `this` exercises the branch logic in isolation and pins the contract +// that photos.updated patches affected loaded rows through one +// uid-scoped search instead of re-running the full result query. +import { describe, it, expect, beforeEach, afterEach, vi } from "vitest"; + +import PPagePhotos from "page/photos.vue"; +import PAlbumPhotos from "page/album/photos.vue"; +import { Photo } from "model/photo"; + +// Captures the surface of `this` that onUpdate touches. Lets us +// assert dirty/complete transitions without instantiating Vue. +function newStub() { + return { + listen: true, + context: "photos", + dirty: false, + complete: true, + scrollDisabled: true, + results: [], + lightbox: { results: [] }, + $clipboard: { removeId: vi.fn() }, + $forceUpdate: vi.fn(), + removeResult: vi.fn(), + updateResults: vi.fn(), + refetchResults: vi.fn(), + loadMore: vi.fn(), + refresh: vi.fn(), + }; +} + +describe("page/photos.vue onUpdate", () => { + const onUpdate = PPagePhotos.methods.onUpdate; + + let warnSpy; + beforeEach(() => { + warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {}); + }); + + it("delegates photos.updated to the uid-scoped refetch", () => { + const stub = newStub(); + + onUpdate.call(stub, "photos.updated", { entities: ["uid-1", "uid-2"] }); + + expect(stub.refetchResults).toHaveBeenCalledWith(["uid-1", "uid-2"]); + // photos.updated must not re-run the full result query. + expect(stub.refresh).not.toHaveBeenCalled(); + expect(warnSpy).not.toHaveBeenCalled(); + }); + + it("ignores photos.updated when listen=false", () => { + const stub = newStub(); + stub.listen = false; + + onUpdate.call(stub, "photos.updated", { entities: ["uid-1"] }); + + expect(stub.refetchResults).not.toHaveBeenCalled(); + }); + + it("short-circuits on malformed payloads without warning", () => { + const stub = newStub(); + onUpdate.call(stub, "photos.updated", null); + onUpdate.call(stub, "photos.updated", {}); + onUpdate.call(stub, "photos.updated", { entities: "not-an-array" }); + + expect(stub.refetchResults).not.toHaveBeenCalled(); + expect(warnSpy).not.toHaveBeenCalled(); + }); + + it("still warns on unknown event types", () => { + const stub = newStub(); + onUpdate.call(stub, "photos.unknown", { entities: ["uid-1"] }); + + expect(warnSpy).toHaveBeenCalledTimes(1); + }); +}); + +describe("page/photos.vue refetchResults", () => { + const refetchResults = PPagePhotos.methods.refetchResults; + + let searchSpy; + afterEach(() => { + searchSpy?.mockRestore(); + }); + + it("patches affected loaded photos through one uid-scoped search", async () => { + const stub = newStub(); + stub.results = [{ UID: "uid-1", Title: "Old" }]; + stub.updateResults = PPagePhotos.methods.updateResults.bind(stub); + searchSpy = vi.spyOn(Photo, "search").mockResolvedValue({ models: [{ UID: "uid-1", Title: "New", Quality: 2 }] }); + + refetchResults.call(stub, ["uid-1", "uid-not-loaded"]); + await Promise.resolve(); + await Promise.resolve(); + + // Only the loaded UID is requested, in one query. + expect(searchSpy).toHaveBeenCalledTimes(1); + expect(searchSpy).toHaveBeenCalledWith({ uid: "uid-1", merged: true, count: 1 }); + expect(stub.results[0].Title).toBe("New"); + expect(stub.dirty).toBe(false); + }); + + it("does nothing when no affected photo is loaded", () => { + const stub = newStub(); + searchSpy = vi.spyOn(Photo, "search").mockResolvedValue({ models: [] }); + + refetchResults.call(stub, ["uid-1"]); + + expect(searchSpy).not.toHaveBeenCalled(); + expect(stub.dirty).toBe(false); + }); + + it("falls back to the dirty flag for oversized batches", () => { + const stub = newStub(); + const uids = Array.from({ length: 51 }, (_, i) => `uid-${i}`); + stub.results = uids.map((uid) => ({ UID: uid })); + searchSpy = vi.spyOn(Photo, "search").mockResolvedValue({ models: [] }); + + refetchResults.call(stub, uids); + + expect(searchSpy).not.toHaveBeenCalled(); + expect(stub.dirty).toBe(true); + expect(stub.complete).toBe(false); + }); + + it("removes photos the scoped search no longer returns", async () => { + const stub = newStub(); + stub.results = [{ UID: "uid-gone" }]; + searchSpy = vi.spyOn(Photo, "search").mockResolvedValue({ models: [] }); + + refetchResults.call(stub, ["uid-gone"]); + await Promise.resolve(); + await Promise.resolve(); + + expect(stub.removeResult).toHaveBeenCalledWith(stub.results, "uid-gone"); + expect(stub.$clipboard.removeId).toHaveBeenCalledWith("uid-gone"); + }); + + it("removes approved photos from the review context", async () => { + const stub = newStub(); + stub.context = "review"; + stub.results = [{ UID: "uid-1", Quality: 1 }]; + searchSpy = vi.spyOn(Photo, "search").mockResolvedValue({ models: [{ UID: "uid-1", Quality: 3 }] }); + + refetchResults.call(stub, ["uid-1"]); + await Promise.resolve(); + await Promise.resolve(); + + expect(stub.removeResult).toHaveBeenCalledWith(stub.results, "uid-1"); + expect(stub.$clipboard.removeId).toHaveBeenCalledWith("uid-1"); + }); + + it("marks the results dirty when the refetch fails", async () => { + const stub = newStub(); + stub.results = [{ UID: "uid-1" }]; + searchSpy = vi.spyOn(Photo, "search").mockRejectedValue(new Error("offline")); + + refetchResults.call(stub, ["uid-1"]); + await Promise.resolve(); + await Promise.resolve(); + + expect(stub.dirty).toBe(true); + expect(stub.complete).toBe(false); + }); +}); + +describe("page/album/photos.vue onUpdate", () => { + const onUpdate = PAlbumPhotos.methods.onUpdate; + + it("delegates photos.updated to the uid-scoped refetch", () => { + const stub = newStub(); + + onUpdate.call(stub, "photos.updated", { entities: ["uid-1"] }); + + expect(stub.refetchResults).toHaveBeenCalledWith(["uid-1"]); + expect(stub.refresh).not.toHaveBeenCalled(); + }); + + it("ignores photos.updated when listen=false", () => { + const stub = newStub(); + stub.listen = false; + + onUpdate.call(stub, "photos.updated", { entities: ["uid-1"] }); + + expect(stub.refetchResults).not.toHaveBeenCalled(); + }); +}); + +describe("page/album/photos.vue refetchResults", () => { + const refetchResults = PAlbumPhotos.methods.refetchResults; + + let searchSpy; + afterEach(() => { + searchSpy?.mockRestore(); + }); + + it("patches affected loaded photos through one uid-scoped search", async () => { + const stub = newStub(); + stub.results = [{ UID: "uid-1", Title: "Old" }]; + stub.updateResults = PAlbumPhotos.methods.updateResults.bind(stub); + searchSpy = vi.spyOn(Photo, "search").mockResolvedValue({ models: [{ UID: "uid-1", Title: "New" }] }); + + refetchResults.call(stub, ["uid-1"]); + await Promise.resolve(); + await Promise.resolve(); + + expect(searchSpy).toHaveBeenCalledWith({ uid: "uid-1", merged: true, count: 1 }); + expect(stub.results[0].Title).toBe("New"); + }); +}); + +describe("page/album/photos.vue onAlbumsUpdated", () => { + const onAlbumsUpdated = PAlbumPhotos.methods.onAlbumsUpdated; + + // Captures the surface of `this` that onAlbumsUpdated touches; the + // album model reload resolves synchronously via a stubbed load(). + function newAlbumStub() { + return { + listen: true, + dirty: false, + complete: true, + scrollDisabled: true, + lastParams: { order: "oldest" }, + collectionRoute: "albums", + model: { UID: "album-1", Title: "Album", Order: "oldest", load: vi.fn(() => Promise.resolve()) }, + $config: { get: () => "PhotoPrism" }, + $router: { push: vi.fn() }, + updateQuery: vi.fn(), + loadMore: vi.fn(), + }; + } + + it("reloads the open album when reported as updated", async () => { + const stub = newAlbumStub(); + + onAlbumsUpdated.call(stub, "albums.updated", { entities: ["album-1"] }); + await Promise.resolve(); + + expect(stub.model.load).toHaveBeenCalledTimes(1); + expect(stub.dirty).toBe(true); + expect(stub.complete).toBe(false); + expect(stub.updateQuery).not.toHaveBeenCalled(); + expect(stub.loadMore).toHaveBeenCalledWith(true); + }); + + it("updates the query when the album order changed", async () => { + const stub = newAlbumStub(); + stub.model.load = vi.fn(() => { + stub.model.Order = "newest"; + return Promise.resolve(); + }); + + onAlbumsUpdated.call(stub, "albums.updated", { entities: ["album-1"] }); + await Promise.resolve(); + + expect(stub.updateQuery).toHaveBeenCalledTimes(1); + expect(stub.loadMore).toHaveBeenCalledWith(true); + }); + + it("ignores events for other albums", () => { + const stub = newAlbumStub(); + + onAlbumsUpdated.call(stub, "albums.updated", { entities: ["album-2"] }); + + expect(stub.model.load).not.toHaveBeenCalled(); + expect(stub.dirty).toBe(false); + }); + + it("leaves the view when the scoped reload returns 404", async () => { + const stub = newAlbumStub(); + stub.model.load = vi.fn(() => Promise.reject({ response: { status: 404 } })); + + onAlbumsUpdated.call(stub, "albums.updated", { entities: ["album-1"] }); + await Promise.resolve(); + await Promise.resolve(); + + expect(stub.$router.push).toHaveBeenCalledWith({ name: "albums" }); + expect(stub.loadMore).not.toHaveBeenCalled(); + }); + + it("marks the view dirty when the reload fails transiently", async () => { + const stub = newAlbumStub(); + stub.model.load = vi.fn(() => Promise.reject(new Error("offline"))); + + onAlbumsUpdated.call(stub, "albums.updated", { entities: ["album-1"] }); + await Promise.resolve(); + await Promise.resolve(); + + expect(stub.$router.push).not.toHaveBeenCalled(); + expect(stub.dirty).toBe(true); + expect(stub.complete).toBe(false); + expect(stub.loadMore).not.toHaveBeenCalled(); + }); +}); diff --git a/frontend/tests/vitest/setup.js b/frontend/tests/vitest/setup.js index 3a0e9854b..6c00c533b 100644 --- a/frontend/tests/vitest/setup.js +++ b/frontend/tests/vitest/setup.js @@ -1,9 +1,15 @@ +// MUST be the first import: filters jsdom's known false-positive +// "Could not parse CSS stylesheet" warnings on Vuetify-flavored +// stylesheets before any subsequent import injects CSS. +import "./helpers/jsdom-quiet"; + import { afterEach, vi } from "vitest"; import "@testing-library/jest-dom"; import { config } from "@vue/test-utils"; import { createVuetify } from "vuetify"; import * as components from "vuetify/components"; import * as directives from "vuetify/directives"; +import { VFileUpload } from "vuetify/labs/VFileUpload"; import "vuetify/styles"; import clientConfig from "./config"; @@ -17,7 +23,7 @@ window.__CONFIG__ = clientConfig; // Create a proper Vuetify instance with all components and styles const vuetify = createVuetify({ - components, + components: { ...components, VFileUpload }, directives, theme: { defaultTheme: "light", @@ -30,12 +36,36 @@ if (typeof global.ResizeObserver === "undefined") { constructor(callback) { this.callback = callback; } - observe() { } - unobserve() { } - disconnect() { } + observe() {} + unobserve() {} + disconnect() {} }; } +// jsdom does not implement window.visualViewport, which Vuetify's VOverlay +// location strategies read eagerly via `watch(..., { immediate: true })` — +// any overlay-backed component (v-combobox, v-menu, v-dialog...) throws +// ReferenceError without this shim. +if (!window.visualViewport) { + Object.defineProperty(window, "visualViewport", { + configurable: true, + value: { + width: 1024, + height: 768, + offsetLeft: 0, + offsetTop: 0, + pageLeft: 0, + pageTop: 0, + scale: 1, + addEventListener() {}, + removeEventListener() {}, + dispatchEvent() { + return true; + }, + }, + }); +} + // Configure Vue Test Utils global configuration config.global.mocks = { $gettext: mockGettext, @@ -46,6 +76,7 @@ config.global.mocks = { get: () => false, getSettings: () => ({ features: { edit: true, favorites: true, download: true, archive: true } }), allow: () => true, + deny: () => false, featExperimental: () => false, featDevelop: () => false, values: {}, @@ -54,12 +85,12 @@ config.global.mocks = { $event: { subscribe: () => "sub-id", subscribeOnce: () => "sub-id-once", - unsubscribe: () => { }, - publish: () => { }, + unsubscribe: () => {}, + publish: () => {}, }, $view: { - enter: () => { }, - leave: () => { }, + enter: () => {}, + leave: () => {}, isActive: () => true, }, $notify: { success: vi.fn(), error: vi.fn(), warn: vi.fn(), info: vi.fn() }, @@ -69,18 +100,22 @@ config.global.mocks = { request: () => Promise.resolve(), exit: () => Promise.resolve(), }, - $clipboard: { selection: [], has: () => false, toggle: () => { } }, + $clipboard: { selection: [], has: () => false, toggle: () => {} }, $util: { hasTouch: () => false, encodeHTML: (s) => s, sanitizeHtml: (s) => s, formatSeconds: (n) => String(n), formatRemainingSeconds: () => "0", + formatCamera: (camera, id, make, model) => [make, model].filter(Boolean).join(" "), + normalizeTitle: (s) => (s || "").toLowerCase().trim(), + typeName: (type, defaultValue) => (type ? String(type) : defaultValue !== undefined ? defaultValue : ""), videoFormat: () => "avc", videoFormatUrl: () => "/v.mp4", thumb: () => ({ src: "/t.jpg", w: 100, h: 100 }), }, $api: { post: vi.fn(), delete: vi.fn(), get: vi.fn() }, + $session: {}, }; config.global.plugins = [vuetify]; diff --git a/frontend/vitest.config.js b/frontend/vitest.config.js index c09a107e2..15d998c9c 100644 --- a/frontend/vitest.config.js +++ b/frontend/vitest.config.js @@ -35,18 +35,6 @@ export default defineConfig({ testTimeout: 10000, watch: false, silent: true, - browser: { - enabled: false, - provider: "playwright", - headless: true, - isolate: false, - instances: [ - { - browser: "chromium", - headless: true, - }, - ], - }, coverage: { provider: "v8", diff --git a/frontend/vitest.config.portal.js b/frontend/vitest.config.portal.js new file mode 100644 index 000000000..eb001dd17 --- /dev/null +++ b/frontend/vitest.config.portal.js @@ -0,0 +1,69 @@ +import { defineConfig } from "vitest/config"; +import path from "path"; +import { createRequire } from "node:module"; +import vue from "@vitejs/plugin-vue"; + +const require = createRequire(import.meta.url); + +// Portal vitest configuration - runs ONLY portal-specific tests. +// Tests portal overlay models and components in ../portal/frontend/tests/vitest/. +// Portal overlay files are aliased ahead of the shared CE sources so the tested +// components resolve to the Portal versions (mirrors vitest.config.pro.js). +export default defineConfig({ + plugins: [vue()], + server: { + fs: { + allow: [ + path.resolve(__dirname, ".."), // Allow access to parent directory (includes portal/) + ], + }, + }, + resolve: { + alias: [ + { find: "component/auth/header.vue", replacement: path.resolve(__dirname, "../portal/frontend/component/auth/header.vue") }, + { find: "component/auth/footer.vue", replacement: path.resolve(__dirname, "../portal/frontend/component/auth/footer.vue") }, + { find: "component/about/footer.vue", replacement: path.resolve(__dirname, "../portal/frontend/component/about/footer.vue") }, + { find: "component/navigation.vue", replacement: path.resolve(__dirname, "../portal/frontend/component/navigation.vue") }, + { find: "component/cluster/instance-access.vue", replacement: path.resolve(__dirname, "../portal/frontend/component/cluster/instance-access.vue") }, + { find: "component/session/remove/dialog.vue", replacement: path.resolve(__dirname, "../portal/frontend/component/session/remove/dialog.vue") }, + { find: "component/user/add/dialog.vue", replacement: path.resolve(__dirname, "../portal/frontend/component/user/add/dialog.vue") }, + { find: "component/user/edit/dialog.vue", replacement: path.resolve(__dirname, "../portal/frontend/component/user/edit/dialog.vue") }, + { find: "component/user/remove/dialog.vue", replacement: path.resolve(__dirname, "../portal/frontend/component/user/remove/dialog.vue") }, + { find: "options/admin", replacement: path.resolve(__dirname, "../portal/frontend/options/admin.js") }, + { find: "model/cluster-instance", replacement: path.resolve(__dirname, "../portal/frontend/model/cluster-instance.js") }, + { find: "model/cluster-node", replacement: path.resolve(__dirname, "../portal/frontend/model/cluster-node.js") }, + { find: "common/instance-grants", replacement: path.resolve(__dirname, "../portal/frontend/common/instance-grants.js") }, + { find: "common/user-format", replacement: path.resolve(__dirname, "../portal/frontend/common/user-format.js") }, + { find: "app.vue", replacement: path.resolve(__dirname, "./src/app.vue") }, + { find: "app", replacement: path.resolve(__dirname, "./src/app") }, + { find: "common", replacement: path.resolve(__dirname, "./src/common") }, + { find: "component", replacement: path.resolve(__dirname, "./src/component") }, + { find: "model", replacement: path.resolve(__dirname, "./src/model") }, + { find: "options", replacement: path.resolve(__dirname, "./src/options") }, + { find: "page", replacement: path.resolve(__dirname, "./src/page") }, + { find: "ui", replacement: path.resolve(__dirname, "./src/options/ui.js") }, + { find: "model.js", replacement: path.resolve(__dirname, "./src/model/model.js") }, + { find: "link.js", replacement: path.resolve(__dirname, "./src/model/link.js") }, + { find: "websocket.js", replacement: path.resolve(__dirname, "./src/common/websocket.js") }, + { find: "luxon", replacement: path.dirname(require.resolve("luxon/package.json")) }, + ], + }, + + optimizeDeps: { + include: ["vuetify"], + }, + + test: { + globals: true, + setupFiles: "./tests/vitest/setup.js", + include: ["../portal/frontend/tests/vitest/**/*.{test,spec}.{js,jsx,ts,tsx,vue}"], + exclude: ["**/node_modules/**", "**/dist/**"], + + environment: "jsdom", + css: true, + pool: "vmForks", + testTimeout: 10000, + watch: false, + silent: true, + }, +}); diff --git a/frontend/vitest.config.pro.js b/frontend/vitest.config.pro.js index f28bbad50..253fc3780 100644 --- a/frontend/vitest.config.pro.js +++ b/frontend/vitest.config.pro.js @@ -12,7 +12,7 @@ export default defineConfig({ server: { fs: { allow: [ - path.resolve(__dirname, ".."), // Allow access to parent directory (includes pro/) + path.resolve(__dirname, ".."), // Allow access to parent directory (includes pro/) ], }, }, diff --git a/frontend/webpack.config.js b/frontend/webpack.config.js index a03411ae2..93586a92f 100644 --- a/frontend/webpack.config.js +++ b/frontend/webpack.config.js @@ -1,6 +1,6 @@ /* -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -13,7 +13,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/go.mod b/go.mod index 445cc2b99..034b10a6e 100644 --- a/go.mod +++ b/go.mod @@ -1,7 +1,6 @@ module github.com/photoprism/photoprism require ( - github.com/disintegration/imaging v1.6.2 github.com/djherbis/times v1.6.0 github.com/dsoprea/go-exif/v3 v3.0.1 github.com/dsoprea/go-heic-exif-extractor/v2 v2.0.0-20210512044107-62067e44c235 @@ -11,10 +10,9 @@ require ( github.com/dsoprea/go-png-image-structure/v2 v2.0.0-20210512210324-29b889a6093d github.com/dsoprea/go-tiff-image-structure/v2 v2.0.0-20221003165014-8ecc4f52edca github.com/dustin/go-humanize v1.0.1 - github.com/esimov/pigo v1.4.6 - github.com/gin-contrib/gzip v1.2.5 + github.com/gin-contrib/gzip v1.2.6 // indirect github.com/gin-gonic/gin v1.12.0 - github.com/golang/geo v0.0.0-20260302211937-87f5a40ea07a + github.com/golang/geo v0.0.0-20260706204034-7a8d33c78269 github.com/google/open-location-code/go v0.0.0-20250620134813-83986da0156b github.com/gorilla/websocket v1.5.3 github.com/gosimple/slug v1.15.0 @@ -22,124 +20,125 @@ require ( github.com/jinzhu/inflection v1.0.0 github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0 // indirect github.com/karrick/godirwalk v1.17.0 - github.com/klauspost/cpuid/v2 v2.3.0 + github.com/klauspost/cpuid/v2 v2.4.0 github.com/leandro-lugaresi/hub v1.1.1 github.com/leonelquinteros/gotext v1.7.2 - github.com/lib/pq v1.10.9 // indirect - github.com/lucasb-eyer/go-colorful v1.3.0 + github.com/lib/pq v1.12.1 // indirect + github.com/lucasb-eyer/go-colorful v1.4.0 github.com/mandykoh/prism v0.35.3 github.com/manifoldco/promptui v0.9.0 - github.com/mattn/go-sqlite3 v1.14.34 // indirect - github.com/montanaflynn/stats v0.7.1 + github.com/mattn/go-sqlite3 v1.14.44 // indirect + github.com/montanaflynn/stats v0.9.0 github.com/patrickmn/go-cache v2.1.0+incompatible github.com/paulmach/go.geojson v1.5.0 github.com/pbnjay/memory v0.0.0-20210728143218-7b4eea64cf58 github.com/sevlyar/go-daemon v0.1.6 github.com/sirupsen/logrus v1.9.4 github.com/stretchr/testify v1.11.1 - github.com/tidwall/gjson v1.18.0 + github.com/tidwall/gjson v1.19.0 github.com/ulule/deepcopier v0.0.0-20200430083143-45decc6639b6 go4.org v0.0.0-20260112195520-a5071408f32f // indirect - golang.org/x/crypto v0.48.0 - golang.org/x/net v0.51.0 + golang.org/x/crypto v0.54.0 + golang.org/x/net v0.57.0 gonum.org/v1/gonum v0.17.0 gopkg.in/yaml.v2 v2.4.0 ) require ( github.com/go-xmlfmt/xmlfmt v1.1.3 // indirect - golang.org/x/image v0.36.0 + golang.org/x/image v0.44.0 ) -require github.com/olekukonko/tablewriter v1.1.3 +require github.com/olekukonko/tablewriter v1.1.4 require github.com/google/uuid v1.6.0 -require github.com/chzyer/readline v1.5.1 // indirect +require ( + github.com/chzyer/readline v1.5.1 // indirect + github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect +) require github.com/gabriel-vasile/mimetype v1.4.13 require ( - golang.org/x/sync v0.19.0 - golang.org/x/time v0.14.0 + golang.org/x/sync v0.22.0 + golang.org/x/time v0.15.0 ) -require github.com/go-ldap/ldap/v3 v3.4.12 +require github.com/go-ldap/ldap/v3 v3.4.13 require ( github.com/prometheus/client_golang v1.23.2 - github.com/prometheus/common v0.67.5 + github.com/prometheus/common v0.69.0 ) require github.com/dustinkirkland/golang-petname v0.0.0-20260215035315-f0c533e9ce9b -require golang.org/x/text v0.34.0 +require golang.org/x/text v0.40.0 require ( github.com/IGLOU-EU/go-wildcard v1.0.3 - github.com/davidbyttow/govips/v2 v2.17.0 - github.com/go-co-op/gocron/v2 v2.19.1 - github.com/go-sql-driver/mysql v1.9.3 + github.com/antchfx/xmlquery v1.5.1 + github.com/antchfx/xpath v1.3.6 + github.com/davidbyttow/govips/v2 v2.18.0 + github.com/go-co-op/gocron/v2 v2.21.2 + github.com/go-sql-driver/mysql v1.10.0 github.com/golang-jwt/jwt/v5 v5.3.1 + github.com/klauspost/compress v1.19.0 github.com/pquerna/otp v1.5.0 github.com/prometheus/client_model v0.6.2 github.com/robfig/cron/v3 v3.0.1 github.com/swaggo/files v1.0.1 github.com/swaggo/gin-swagger v1.6.1 - github.com/ugjka/go-tz/v2 v2.2.7 + github.com/ugjka/go-tz/v2 v2.2.8 github.com/urfave/cli/v2 v2.27.7 github.com/wamuir/graft v0.10.0 - github.com/yalue/onnxruntime_go v1.26.0 - github.com/zitadel/oidc/v3 v3.45.5 - golang.org/x/mod v0.33.0 - golang.org/x/sys v0.41.0 + github.com/yalue/onnxruntime_go v1.31.0 + github.com/zitadel/oidc/v3 v3.47.5 + golang.org/x/mod v0.38.0 + golang.org/x/sys v0.47.0 google.golang.org/protobuf v1.36.11 ) require ( filippo.io/edwards25519 v1.2.0 // indirect - github.com/Azure/go-ntlmssp v0.1.0 // indirect + github.com/Azure/go-ntlmssp v0.1.1 // indirect github.com/KyleBanks/depth v1.2.1 // indirect github.com/beorn7/perks v1.0.1 // indirect github.com/boombuler/barcode v1.1.0 // indirect - github.com/bytedance/gopkg v0.1.3 // indirect - github.com/bytedance/sonic/loader v0.5.0 // indirect + github.com/bytedance/gopkg v0.1.4 // indirect + github.com/bytedance/sonic/loader v0.5.1 // indirect github.com/cespare/xxhash/v2 v2.3.0 // indirect - github.com/clipperhouse/displaywidth v0.7.0 // indirect - github.com/clipperhouse/stringish v0.1.1 // indirect - github.com/clipperhouse/uax29/v2 v2.3.1 // indirect - github.com/cloudwego/base64x v0.1.6 // indirect + github.com/clipperhouse/displaywidth v0.11.0 // indirect + github.com/clipperhouse/uax29/v2 v2.7.0 // indirect + github.com/cloudwego/base64x v0.1.7 // indirect github.com/cpuguy83/go-md2man/v2 v2.0.7 // indirect github.com/davecgh/go-spew v1.1.1 // indirect github.com/denisenkom/go-mssqldb v0.12.3 // indirect github.com/dsoprea/go-logging v0.0.0-20200710184922-b02d349568dd // indirect github.com/dsoprea/go-utility/v2 v2.0.0-20221003172846-a3e1774ef349 // indirect - github.com/fatih/color v1.18.0 // indirect - github.com/gin-contrib/sse v1.1.0 // indirect + github.com/fatih/color v1.19.0 // indirect + github.com/gin-contrib/sse v1.1.1 // indirect github.com/go-asn1-ber/asn1-ber v1.5.8-0.20250403174932-29230038a667 // indirect - github.com/go-jose/go-jose/v4 v4.1.3 // indirect + github.com/go-jose/go-jose/v4 v4.1.4 // indirect github.com/go-logr/logr v1.4.3 // indirect github.com/go-logr/stdr v1.2.2 // indirect - github.com/go-openapi/jsonpointer v0.22.4 // indirect - github.com/go-openapi/jsonreference v0.21.4 // indirect - github.com/go-openapi/spec v0.21.0 // indirect - github.com/go-openapi/swag v0.25.4 // indirect - github.com/go-openapi/swag/cmdutils v0.25.4 // indirect - github.com/go-openapi/swag/conv v0.25.4 // indirect - github.com/go-openapi/swag/fileutils v0.25.4 // indirect - github.com/go-openapi/swag/jsonname v0.25.4 // indirect - github.com/go-openapi/swag/jsonutils v0.25.4 // indirect - github.com/go-openapi/swag/loading v0.25.4 // indirect - github.com/go-openapi/swag/mangling v0.25.4 // indirect - github.com/go-openapi/swag/netutils v0.25.4 // indirect - github.com/go-openapi/swag/stringutils v0.25.4 // indirect - github.com/go-openapi/swag/typeutils v0.25.4 // indirect - github.com/go-openapi/swag/yamlutils v0.25.4 // indirect + github.com/go-openapi/jsonpointer v0.23.1 // indirect + github.com/go-openapi/jsonreference v0.21.5 // indirect + github.com/go-openapi/spec v0.22.4 // indirect + github.com/go-openapi/swag/conv v0.26.0 // indirect + github.com/go-openapi/swag/jsonname v0.26.0 // indirect + github.com/go-openapi/swag/jsonutils v0.26.0 // indirect + github.com/go-openapi/swag/loading v0.26.0 // indirect + github.com/go-openapi/swag/stringutils v0.26.0 // indirect + github.com/go-openapi/swag/typeutils v0.26.0 // indirect + github.com/go-openapi/swag/yamlutils v0.26.0 // indirect github.com/go-playground/locales v0.14.1 // indirect github.com/go-playground/universal-translator v0.18.1 // indirect - github.com/goccy/go-json v0.10.5 // indirect + github.com/goccy/go-json v0.10.6 // indirect github.com/goccy/go-yaml v1.19.2 // indirect github.com/golang-sql/civil v0.0.0-20220223132316-b832511892a9 // indirect + github.com/google/jsonschema-go v0.4.3 // indirect github.com/gorilla/securecookie v1.1.2 // indirect github.com/gosimple/unidecode v1.0.1 // indirect github.com/jinzhu/now v1.1.5 // indirect @@ -148,52 +147,57 @@ require ( github.com/leodido/go-urn v1.4.0 // indirect github.com/mandykoh/go-parallel v0.1.0 // indirect github.com/mattn/go-colorable v0.1.14 // indirect - github.com/mattn/go-isatty v0.0.20 // indirect + github.com/mattn/go-isatty v0.0.22 // indirect + github.com/modelcontextprotocol/go-sdk v1.6.1 github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect github.com/modern-go/reflect2 v1.0.2 // indirect github.com/muhlemmer/gu v0.3.1 // indirect github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect github.com/olekukonko/cat v0.0.0-20250911104152-50322a0618f6 // indirect - github.com/olekukonko/errors v1.2.0 // indirect - github.com/olekukonko/ll v0.1.4-0.20260115111900-9e59c2286df0 // indirect + github.com/olekukonko/errors v1.3.0 // indirect + github.com/olekukonko/ll v0.1.8 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect - github.com/prometheus/procfs v0.17.0 // indirect + github.com/prometheus/procfs v0.20.1 // indirect github.com/quic-go/qpack v0.6.0 // indirect - github.com/quic-go/quic-go v0.59.0 // indirect + github.com/quic-go/quic-go v0.59.1 // indirect github.com/russross/blackfriday/v2 v2.1.0 // indirect + github.com/segmentio/asm v1.1.5 // indirect + github.com/segmentio/encoding v0.5.4 // indirect github.com/swaggo/swag v1.16.6 // indirect github.com/tidwall/match v1.2.0 // indirect github.com/twitchyliquid64/golang-asm v0.15.1 // indirect github.com/ugorji/go/codec v1.3.1 // indirect github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342 // indirect + github.com/yosida95/uritemplate/v3 v3.0.2 // indirect github.com/zitadel/logging v0.7.0 // indirect github.com/zitadel/schema v1.3.2 // indirect - go.mongodb.org/mongo-driver/v2 v2.5.0 // indirect + go.mongodb.org/mongo-driver/v2 v2.6.0 // indirect go.opentelemetry.io/auto/sdk v1.2.1 // indirect - go.opentelemetry.io/otel v1.40.0 // indirect - go.opentelemetry.io/otel/metric v1.40.0 // indirect - go.opentelemetry.io/otel/trace v1.40.0 // indirect - go.yaml.in/yaml/v2 v2.4.3 // indirect + go.opentelemetry.io/otel v1.43.0 // indirect + go.opentelemetry.io/otel/metric v1.43.0 // indirect + go.opentelemetry.io/otel/trace v1.43.0 // indirect go.yaml.in/yaml/v3 v3.0.4 // indirect - golang.org/x/oauth2 v0.35.0 // indirect - golang.org/x/tools v0.41.0 // indirect + golang.org/x/oauth2 v0.36.0 + golang.org/x/tools v0.47.0 // indirect gopkg.in/yaml.v3 v3.0.1 // indirect ) require ( - github.com/abema/go-mp4 v1.4.1 - github.com/bytedance/sonic v1.15.0 // indirect + github.com/abema/go-mp4 v1.7.1 + github.com/bytedance/sonic v1.15.1 // indirect github.com/go-errors/errors v1.5.1 // indirect - github.com/go-playground/validator/v10 v10.30.1 // indirect - github.com/pelletier/go-toml/v2 v2.2.4 // indirect + github.com/go-playground/validator/v10 v10.30.2 // indirect + github.com/pelletier/go-toml/v2 v2.3.1 // indirect github.com/sunfish-shogi/bufseekio v0.1.0 - golang.org/x/arch v0.24.0 // indirect + golang.org/x/arch v0.27.0 // indirect ) require ( github.com/emersion/go-webdav v0.7.0 - github.com/mattn/go-runewidth v0.0.20 // indirect + github.com/mattn/go-runewidth v0.0.23 // indirect github.com/tidwall/pretty v1.2.1 // indirect ) go 1.25.0 + +toolchain go1.26.4 diff --git a/go.sum b/go.sum index 62a3c1fee..ba20d671c 100644 --- a/go.sum +++ b/go.sum @@ -20,8 +20,8 @@ filippo.io/edwards25519 v1.2.0/go.mod h1:xzAOLCNug/yB62zG1bQ8uziwrIqIuxhctzJT18Q github.com/Azure/azure-sdk-for-go/sdk/azcore v0.19.0/go.mod h1:h6H6c8enJmmocHUbLiiGY6sx7f9i+X3m1CHdd5c6Rdw= github.com/Azure/azure-sdk-for-go/sdk/azidentity v0.11.0/go.mod h1:HcM1YX14R7CJcghJGOYCgdezslRSVzqwLf/q+4Y2r/0= github.com/Azure/azure-sdk-for-go/sdk/internal v0.7.0/go.mod h1:yqy467j36fJxcRV2TzfVZ1pCb5vxm4BtZPUdYWe/Xo8= -github.com/Azure/go-ntlmssp v0.1.0 h1:DjFo6YtWzNqNvQdrwEyr/e4nhU3vRiwenz5QX7sFz+A= -github.com/Azure/go-ntlmssp v0.1.0/go.mod h1:NYqdhxd/8aAct/s4qSYZEerdPuH1liG2/X9DiVTbhpk= +github.com/Azure/go-ntlmssp v0.1.1 h1:l+FM/EEMb0U9QZE7mKNEDw5Mu3mFiaa2GKOoTSsNDPw= +github.com/Azure/go-ntlmssp v0.1.1/go.mod h1:NYqdhxd/8aAct/s4qSYZEerdPuH1liG2/X9DiVTbhpk= github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo= github.com/IGLOU-EU/go-wildcard v1.0.3 h1:r8T46+8/9V1STciXJomTWRpPEv4nGJATDbJkdU0Nou0= @@ -29,11 +29,15 @@ github.com/IGLOU-EU/go-wildcard v1.0.3/go.mod h1:/qeV4QLmydCbwH0UMQJmXDryrFKJknW github.com/KyleBanks/depth v1.2.1 h1:5h8fQADFrWtarTdtDudMmGsC7GPbOAu6RVB3ffsVFHc= github.com/KyleBanks/depth v1.2.1/go.mod h1:jzSb9d0L43HxTQfT+oSA1EEp2q+ne2uh6XgeJcm8brE= github.com/PuerkitoBio/goquery v1.5.1/go.mod h1:GsLWisAFVj4WgDibEWF4pvYnkVQBpKBKeU+7zCJoLcc= -github.com/abema/go-mp4 v1.4.1 h1:YoS4VRqd+pAmddRPLFf8vMk74kuGl6ULSjzhsIqwr6M= -github.com/abema/go-mp4 v1.4.1/go.mod h1:vPl9t5ZK7K0x68jh12/+ECWBCXoWuIDtNgPtU2f04ws= +github.com/abema/go-mp4 v1.7.1 h1:2nFaCWSXLiqyr6LfH16knVsVfvP4QRHdNEA6P5rnz5w= +github.com/abema/go-mp4 v1.7.1/go.mod h1:vPl9t5ZK7K0x68jh12/+ECWBCXoWuIDtNgPtU2f04ws= github.com/alexbrainman/sspi v0.0.0-20250919150558-7d374ff0d59e h1:4dAU9FXIyQktpoUAgOJK3OTFc/xug0PCXYCqU0FgDKI= github.com/alexbrainman/sspi v0.0.0-20250919150558-7d374ff0d59e/go.mod h1:cEWa1LVoE5KvSD9ONXsZrj0z6KqySlCCNKHlLzbqAt4= github.com/andybalholm/cascadia v1.1.0/go.mod h1:GsXiBklL0woXo1j/WYWtSYYC4ouU9PqHO0sqidkEA4Y= +github.com/antchfx/xmlquery v1.5.1 h1:T9I4Ns1EXiWHy0IqKupGhnfTQtJwlGrpXtauYOoNv78= +github.com/antchfx/xmlquery v1.5.1/go.mod h1:bVqnl7TaDXSReKINrhZz+2E/PbCu2tUahb+wZ7WZNT8= +github.com/antchfx/xpath v1.3.6 h1:s0y+ElRRtTQdfHP609qFu0+c6bglDv20pqOViQjjdPI= +github.com/antchfx/xpath v1.3.6/go.mod h1:i54GszH55fYfBmoZXapTHN8T8tkcHfRgLyVwwqzXNcs= github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM= github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw= github.com/bmatcuk/doublestar/v4 v4.10.0 h1:zU9WiOla1YA122oLM6i4EXvGW62DvKZVxIe6TYWexEs= @@ -41,12 +45,12 @@ github.com/bmatcuk/doublestar/v4 v4.10.0/go.mod h1:xBQ8jztBU6kakFMg+8WGxn0c6z1fT github.com/boombuler/barcode v1.0.1-0.20190219062509-6c824513bacc/go.mod h1:paBWMcWSl3LHKBqUq+rly7CNSldXjb2rDl3JlRe0mD8= github.com/boombuler/barcode v1.1.0 h1:ChaYjBR63fr4LFyGn8E8nt7dBSt3MiU3zMOZqFvVkHo= github.com/boombuler/barcode v1.1.0/go.mod h1:paBWMcWSl3LHKBqUq+rly7CNSldXjb2rDl3JlRe0mD8= -github.com/bytedance/gopkg v0.1.3 h1:TPBSwH8RsouGCBcMBktLt1AymVo2TVsBVCY4b6TnZ/M= -github.com/bytedance/gopkg v0.1.3/go.mod h1:576VvJ+eJgyCzdjS+c4+77QF3p7ubbtiKARP3TxducM= -github.com/bytedance/sonic v1.15.0 h1:/PXeWFaR5ElNcVE84U0dOHjiMHQOwNIx3K4ymzh/uSE= -github.com/bytedance/sonic v1.15.0/go.mod h1:tFkWrPz0/CUCLEF4ri4UkHekCIcdnkqXw9VduqpJh0k= -github.com/bytedance/sonic/loader v0.5.0 h1:gXH3KVnatgY7loH5/TkeVyXPfESoqSBSBEiDd5VjlgE= -github.com/bytedance/sonic/loader v0.5.0/go.mod h1:AR4NYCk5DdzZizZ5djGqQ92eEhCCcdf5x77udYiSJRo= +github.com/bytedance/gopkg v0.1.4 h1:oZnQwnX82KAIWb7033bEwtxvTqXcYMxDBaQxo5JJHWM= +github.com/bytedance/gopkg v0.1.4/go.mod h1:v1zWfPm21Fb+OsyXN2VAHdL6TBb2L88anLQgdyje6R4= +github.com/bytedance/sonic v1.15.1 h1:nJD5PmM0vY7J8CT6MxoqbVAAMhkSmV2HgRAUrrpLoOw= +github.com/bytedance/sonic v1.15.1/go.mod h1:mT2NbXunuaEbnZ+mRIX/vYqKISmgEuHFDI4UzmKx2SA= +github.com/bytedance/sonic/loader v0.5.1 h1:Ygpfa9zwRCCKSlrp5bBP/b/Xzc3VxsAW+5NIYXrOOpI= +github.com/bytedance/sonic/loader v0.5.1/go.mod h1:AR4NYCk5DdzZizZ5djGqQ92eEhCCcdf5x77udYiSJRo= github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU= github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs= github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= @@ -60,27 +64,23 @@ github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMn github.com/chzyer/test v1.0.0 h1:p3BQDXSxOhOG0P9z6/hGnII4LGiEPOYBhs8asl/fC04= github.com/chzyer/test v1.0.0/go.mod h1:2JlltgoNkt4TW/z9V/IzDdFaMTM2JPIi26O1pF38GC8= github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw= -github.com/clipperhouse/displaywidth v0.7.0 h1:QNv1GYsnLX9QBrcWUtMlogpTXuM5FVnBwKWp1O5NwmE= -github.com/clipperhouse/displaywidth v0.7.0/go.mod h1:R+kHuzaYWFkTm7xoMmK1lFydbci4X2CicfbGstSGg0o= -github.com/clipperhouse/stringish v0.1.1 h1:+NSqMOr3GR6k1FdRhhnXrLfztGzuG+VuFDfatpWHKCs= -github.com/clipperhouse/stringish v0.1.1/go.mod h1:v/WhFtE1q0ovMta2+m+UbpZ+2/HEXNWYXQgCt4hdOzA= -github.com/clipperhouse/uax29/v2 v2.3.1 h1:RjM8gnVbFbgI67SBekIC7ihFpyXwRPYWXn9BZActHbw= -github.com/clipperhouse/uax29/v2 v2.3.1/go.mod h1:Wn1g7MK6OoeDT0vL+Q0SQLDz/KpfsVRgg6W7ihQeh4g= -github.com/cloudwego/base64x v0.1.6 h1:t11wG9AECkCDk5fMSoxmufanudBtJ+/HemLstXDLI2M= -github.com/cloudwego/base64x v0.1.6/go.mod h1:OFcloc187FXDaYHvrNIjxSe8ncn0OOM8gEHfghB2IPU= +github.com/clipperhouse/displaywidth v0.11.0 h1:lBc6kY44VFw+TDx4I8opi/EtL9m20WSEFgwIwO+UVM8= +github.com/clipperhouse/displaywidth v0.11.0/go.mod h1:bkrFNkf81G8HyVqmKGxsPufD3JhNl3dSqnGhOoSD/o0= +github.com/clipperhouse/uax29/v2 v2.7.0 h1:+gs4oBZ2gPfVrKPthwbMzWZDaAFPGYK72F0NJv2v7Vk= +github.com/clipperhouse/uax29/v2 v2.7.0/go.mod h1:EFJ2TJMRUaplDxHKj1qAEhCtQPW2tJSwu5BF98AuoVM= +github.com/cloudwego/base64x v0.1.7 h1:NppS+Fgzg5ovhn4NkUXaDT3x9jldgH5ToMCqzBSi2zI= +github.com/cloudwego/base64x v0.1.7/go.mod h1:Cu1PV9zfrSf7ET2tIbWbbEy7jO7HHJ13q4X2SQ8aWYg= github.com/cpuguy83/go-md2man/v2 v2.0.7 h1:zbFlGlXEAKlwXpmvle3d8Oe3YnkKIK4xSRTd3sHPnBo= github.com/cpuguy83/go-md2man/v2 v2.0.7/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g= github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= -github.com/davidbyttow/govips/v2 v2.17.0 h1:TFAjcaEqYpumRoIz2m1Ptr9Fhdg3H0R3FKixKS+4Jo8= -github.com/davidbyttow/govips/v2 v2.17.0/go.mod h1:HF7B5oTeNolUjdBAYVIZQ8S5nhQd1CfDf0rMlYSMJv8= +github.com/davidbyttow/govips/v2 v2.18.0 h1:pZRshWVYvewP/TZx3yZ7YeC42WyLXg53tHy5Qt8nT9E= +github.com/davidbyttow/govips/v2 v2.18.0/go.mod h1:8+nst5zfMoats12PgmmAPh6p5OfjDaXK0BXMFl/vOcM= github.com/denisenkom/go-mssqldb v0.0.0-20191124224453-732737034ffd/go.mod h1:xbL0rPBG9cCiLr28tMa8zpbdarY27NDyej4t/EjAShU= github.com/denisenkom/go-mssqldb v0.12.3 h1:pBSGx9Tq67pBOTLmxNuirNTeB8Vjmf886Kx+8Y+8shw= github.com/denisenkom/go-mssqldb v0.12.3/go.mod h1:k0mtMFOnU+AihqFxPMiF05rtiDrorD1Vrm1KEz5hxDo= -github.com/disintegration/imaging v1.6.2 h1:w1LecBlG2Lnp8B3jk5zSuNqd7b4DXhcjwek1ei82L+c= -github.com/disintegration/imaging v1.6.2/go.mod h1:44/5580QXChDfwIclfc/PCwrr44amcmDAg8hxG0Ewe4= github.com/djherbis/times v1.6.0 h1:w2ctJ92J8fBvWPxugmXIv7Nz7Q3iDMKNx9v5ocVH20c= github.com/djherbis/times v1.6.0/go.mod h1:gOHeRAz2h+VJNZ5Gmc/o7iD9k4wW7NMVqieYCY99oc0= github.com/dnaeon/go-vcr v1.2.0/go.mod h1:R4UdLID7HZT3taECzJs4YgbbH6PIGXB6W/sc5OLb6RQ= @@ -129,25 +129,22 @@ github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.m github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c= github.com/erikstmartin/go-testdb v0.0.0-20160219214506-8d10e4a1bae5 h1:Yzb9+7DPaBjB8zlTR87/ElzFsnQfuHnVUVqpZZIcV5Y= github.com/erikstmartin/go-testdb v0.0.0-20160219214506-8d10e4a1bae5/go.mod h1:a2zkGnVExMxdzMo3M0Hi/3sEU+cWnZpSni0O6/Yb/P0= -github.com/esimov/pigo v1.4.6 h1:wpB9FstbqeGP/CZP+nTR52tUJe7XErq8buG+k4xCXlw= -github.com/esimov/pigo v1.4.6/go.mod h1:uqj9Y3+3IRYhFK071rxz1QYq0ePhA6+R9jrUZavi46M= -github.com/fatih/color v1.18.0 h1:S8gINlzdQ840/4pfAwic/ZE0djQEH3wM94VfqLTZcOM= -github.com/fatih/color v1.18.0/go.mod h1:4FelSpRwEGDpQ12mAdzqdOukCy4u8WUtOY6lkT/6HfU= -github.com/fogleman/gg v1.3.0/go.mod h1:R/bRT+9gY/C5z7JzPU0zXsXHKM4/ayA+zqcVNZzPa1k= +github.com/fatih/color v1.19.0 h1:Zp3PiM21/9Ld6FzSKyL5c/BULoe/ONr9KlbYVOfG8+w= +github.com/fatih/color v1.19.0/go.mod h1:zNk67I0ZUT1bEGsSGyCZYZNrHuTkJJB+r6Q9VuMi0LE= github.com/gabriel-vasile/mimetype v1.4.13 h1:46nXokslUBsAJE/wMsp5gtO500a4F3Nkz9Ufpk2AcUM= github.com/gabriel-vasile/mimetype v1.4.13/go.mod h1:d+9Oxyo1wTzWdyVUPMmXFvp4F9tea18J8ufA774AB3s= -github.com/gin-contrib/gzip v1.2.5 h1:fIZs0S+l17pIu1P5XRJOo/YNqfIuPCrZZ3TWB7pjckI= -github.com/gin-contrib/gzip v1.2.5/go.mod h1:aomRgR7ftdZV3uWY0gW/m8rChfxau0n8YVvwlOHONzw= -github.com/gin-contrib/sse v1.1.0 h1:n0w2GMuUpWDVp7qSpvze6fAu9iRxJY4Hmj6AmBOU05w= -github.com/gin-contrib/sse v1.1.0/go.mod h1:hxRZ5gVpWMT7Z0B0gSNYqqsSCNIJMjzvm6fqCz9vjwM= +github.com/gin-contrib/gzip v1.2.6 h1:OtN8DplD5DNZCSLAnQ5HxRkD2qZ5VU+JhOrcfJrcRvg= +github.com/gin-contrib/gzip v1.2.6/go.mod h1:BQy8/+JApnRjAVUplSGZiVtD2k8GmIE2e9rYu/hLzzU= +github.com/gin-contrib/sse v1.1.1 h1:uGYpNwTacv5R68bSGMapo62iLTRa9l5zxGCps4hK6ko= +github.com/gin-contrib/sse v1.1.1/go.mod h1:QXzuVkA0YO7o/gun03UI1Q+FTI8ZV/n5t03kIQAI89s= github.com/gin-gonic/gin v1.12.0 h1:b3YAbrZtnf8N//yjKeU2+MQsh2mY5htkZidOM7O0wG8= github.com/gin-gonic/gin v1.12.0/go.mod h1:VxccKfsSllpKshkBWgVgRniFFAzFb9csfngsqANjnLc= github.com/go-asn1-ber/asn1-ber v1.5.8-0.20250403174932-29230038a667 h1:BP4M0CvQ4S3TGls2FvczZtj5Re/2ZzkV9VwqPHH/3Bo= github.com/go-asn1-ber/asn1-ber v1.5.8-0.20250403174932-29230038a667/go.mod h1:hEBeB/ic+5LoWskz+yKT7vGhhPYkProFKoKdwZRWMe0= github.com/go-chi/chi/v5 v5.2.5 h1:Eg4myHZBjyvJmAFjFvWgrqDTXFyOzjj7YIm3L3mu6Ug= github.com/go-chi/chi/v5 v5.2.5/go.mod h1:X7Gx4mteadT3eDOMTsXzmI4/rwUpOwBHLpAfupzFJP0= -github.com/go-co-op/gocron/v2 v2.19.1 h1:B4iLeA0NB/2iO3EKQ7NfKn5KsQgZfjb2fkvoZJU3yBI= -github.com/go-co-op/gocron/v2 v2.19.1/go.mod h1:5lEiCKk1oVJV39Zg7/YG10OnaVrDAV5GGR6O0663k6U= +github.com/go-co-op/gocron/v2 v2.21.2 h1:bD8/YwkojYHgXFr3iEulL148KBdTbKVxUZzFKpXcdbY= +github.com/go-co-op/gocron/v2 v2.21.2/go.mod h1:5lEiCKk1oVJV39Zg7/YG10OnaVrDAV5GGR6O0663k6U= github.com/go-errors/errors v1.0.1/go.mod h1:f4zRHt4oKfwPJE5k8C9vpYG+aDHdBFUsgrm6/TyX73Q= github.com/go-errors/errors v1.0.2/go.mod h1:psDX2osz5VnTOnFWbDeWwS7yejl+uV3FEWEp4lssFEs= github.com/go-errors/errors v1.1.1/go.mod h1:psDX2osz5VnTOnFWbDeWwS7yejl+uV3FEWEp4lssFEs= @@ -156,67 +153,58 @@ github.com/go-errors/errors v1.5.1 h1:ZwEMSLRCapFLflTpT7NKaAc7ukJ8ZPEjzlxt8rPN8b github.com/go-errors/errors v1.5.1/go.mod h1:sIVyrIiJhuEF+Pj9Ebtd6P/rEYROXFi3BopGUQ5a5Og= github.com/go-gl/glfw v0.0.0-20190409004039-e6da0acd62b1/go.mod h1:vR7hzQXu2zJy9AVAgeJqvqgH9Q5CA+iKCZ2gyEVpxRU= github.com/go-gl/glfw/v3.3/glfw v0.0.0-20191125211704-12ad95a8df72/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8= -github.com/go-jose/go-jose/v4 v4.1.3 h1:CVLmWDhDVRa6Mi/IgCgaopNosCaHz7zrMeF9MlZRkrs= -github.com/go-jose/go-jose/v4 v4.1.3/go.mod h1:x4oUasVrzR7071A4TnHLGSPpNOm2a21K9Kf04k1rs08= -github.com/go-ldap/ldap/v3 v3.4.12 h1:1b81mv7MagXZ7+1r7cLTWmyuTqVqdwbtJSjC0DAp9s4= -github.com/go-ldap/ldap/v3 v3.4.12/go.mod h1:+SPAGcTtOfmGsCb3h1RFiq4xpp4N636G75OEace8lNo= +github.com/go-jose/go-jose/v4 v4.1.4 h1:moDMcTHmvE6Groj34emNPLs/qtYXRVcd6S7NHbHz3kA= +github.com/go-jose/go-jose/v4 v4.1.4/go.mod h1:x4oUasVrzR7071A4TnHLGSPpNOm2a21K9Kf04k1rs08= +github.com/go-ldap/ldap/v3 v3.4.13 h1:+x1nG9h+MZN7h/lUi5Q3UZ0fJ1GyDQYbPvbuH38baDQ= +github.com/go-ldap/ldap/v3 v3.4.13/go.mod h1:LxsGZV6vbaK0sIvYfsv47rfh4ca0JXokCoKjZxsszv0= github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI= github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag= github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE= -github.com/go-openapi/jsonpointer v0.22.4 h1:dZtK82WlNpVLDW2jlA1YCiVJFVqkED1MegOUy9kR5T4= -github.com/go-openapi/jsonpointer v0.22.4/go.mod h1:elX9+UgznpFhgBuaMQ7iu4lvvX1nvNsesQ3oxmYTw80= -github.com/go-openapi/jsonreference v0.21.4 h1:24qaE2y9bx/q3uRK/qN+TDwbok1NhbSmGjjySRCHtC8= -github.com/go-openapi/jsonreference v0.21.4/go.mod h1:rIENPTjDbLpzQmQWCj5kKj3ZlmEh+EFVbz3RTUh30/4= -github.com/go-openapi/spec v0.21.0 h1:LTVzPc3p/RzRnkQqLRndbAzjY0d0BCL72A6j3CdL9ZY= -github.com/go-openapi/spec v0.21.0/go.mod h1:78u6VdPw81XU44qEWGhtr982gJ5BWg2c0I5XwVMotYk= -github.com/go-openapi/swag v0.25.4 h1:OyUPUFYDPDBMkqyxOTkqDYFnrhuhi9NR6QVUvIochMU= -github.com/go-openapi/swag v0.25.4/go.mod h1:zNfJ9WZABGHCFg2RnY0S4IOkAcVTzJ6z2Bi+Q4i6qFQ= -github.com/go-openapi/swag/cmdutils v0.25.4 h1:8rYhB5n6WawR192/BfUu2iVlxqVR9aRgGJP6WaBoW+4= -github.com/go-openapi/swag/cmdutils v0.25.4/go.mod h1:pdae/AFo6WxLl5L0rq87eRzVPm/XRHM3MoYgRMvG4A0= -github.com/go-openapi/swag/conv v0.25.4 h1:/Dd7p0LZXczgUcC/Ikm1+YqVzkEeCc9LnOWjfkpkfe4= -github.com/go-openapi/swag/conv v0.25.4/go.mod h1:3LXfie/lwoAv0NHoEuY1hjoFAYkvlqI/Bn5EQDD3PPU= -github.com/go-openapi/swag/fileutils v0.25.4 h1:2oI0XNW5y6UWZTC7vAxC8hmsK/tOkWXHJQH4lKjqw+Y= -github.com/go-openapi/swag/fileutils v0.25.4/go.mod h1:cdOT/PKbwcysVQ9Tpr0q20lQKH7MGhOEb6EwmHOirUk= -github.com/go-openapi/swag/jsonname v0.25.4 h1:bZH0+MsS03MbnwBXYhuTttMOqk+5KcQ9869Vye1bNHI= -github.com/go-openapi/swag/jsonname v0.25.4/go.mod h1:GPVEk9CWVhNvWhZgrnvRA6utbAltopbKwDu8mXNUMag= -github.com/go-openapi/swag/jsonutils v0.25.4 h1:VSchfbGhD4UTf4vCdR2F4TLBdLwHyUDTd1/q4i+jGZA= -github.com/go-openapi/swag/jsonutils v0.25.4/go.mod h1:7OYGXpvVFPn4PpaSdPHJBtF0iGnbEaTk8AvBkoWnaAY= -github.com/go-openapi/swag/jsonutils/fixtures_test v0.25.4 h1:IACsSvBhiNJwlDix7wq39SS2Fh7lUOCJRmx/4SN4sVo= -github.com/go-openapi/swag/jsonutils/fixtures_test v0.25.4/go.mod h1:Mt0Ost9l3cUzVv4OEZG+WSeoHwjWLnarzMePNDAOBiM= -github.com/go-openapi/swag/loading v0.25.4 h1:jN4MvLj0X6yhCDduRsxDDw1aHe+ZWoLjW+9ZQWIKn2s= -github.com/go-openapi/swag/loading v0.25.4/go.mod h1:rpUM1ZiyEP9+mNLIQUdMiD7dCETXvkkC30z53i+ftTE= -github.com/go-openapi/swag/mangling v0.25.4 h1:2b9kBJk9JvPgxr36V23FxJLdwBrpijI26Bx5JH4Hp48= -github.com/go-openapi/swag/mangling v0.25.4/go.mod h1:6dxwu6QyORHpIIApsdZgb6wBk/DPU15MdyYj/ikn0Hg= -github.com/go-openapi/swag/netutils v0.25.4 h1:Gqe6K71bGRb3ZQLusdI8p/y1KLgV4M/k+/HzVSqT8H0= -github.com/go-openapi/swag/netutils v0.25.4/go.mod h1:m2W8dtdaoX7oj9rEttLyTeEFFEBvnAx9qHd5nJEBzYg= -github.com/go-openapi/swag/stringutils v0.25.4 h1:O6dU1Rd8bej4HPA3/CLPciNBBDwZj9HiEpdVsb8B5A8= -github.com/go-openapi/swag/stringutils v0.25.4/go.mod h1:GTsRvhJW5xM5gkgiFe0fV3PUlFm0dr8vki6/VSRaZK0= -github.com/go-openapi/swag/typeutils v0.25.4 h1:1/fbZOUN472NTc39zpa+YGHn3jzHWhv42wAJSN91wRw= -github.com/go-openapi/swag/typeutils v0.25.4/go.mod h1:Ou7g//Wx8tTLS9vG0UmzfCsjZjKhpjxayRKTHXf2pTE= -github.com/go-openapi/swag/yamlutils v0.25.4 h1:6jdaeSItEUb7ioS9lFoCZ65Cne1/RZtPBZ9A56h92Sw= -github.com/go-openapi/swag/yamlutils v0.25.4/go.mod h1:MNzq1ulQu+yd8Kl7wPOut/YHAAU/H6hL91fF+E2RFwc= -github.com/go-openapi/testify/enable/yaml/v2 v2.0.2 h1:0+Y41Pz1NkbTHz8NngxTuAXxEodtNSI1WG1c/m5Akw4= -github.com/go-openapi/testify/enable/yaml/v2 v2.0.2/go.mod h1:kme83333GCtJQHXQ8UKX3IBZu6z8T5Dvy5+CW3NLUUg= -github.com/go-openapi/testify/v2 v2.0.2 h1:X999g3jeLcoY8qctY/c/Z8iBHTbwLz7R2WXd6Ub6wls= -github.com/go-openapi/testify/v2 v2.0.2/go.mod h1:HCPmvFFnheKK2BuwSA0TbbdxJ3I16pjwMkYkP4Ywn54= +github.com/go-openapi/jsonpointer v0.23.1 h1:1HBACs7XIwR2RcmItfdSFlALhGbe6S92p0ry4d1GWg4= +github.com/go-openapi/jsonpointer v0.23.1/go.mod h1:iWRmZTrGn7XwYhtPt/fvdSFj1OfNBngqRT2UG3BxSqY= +github.com/go-openapi/jsonreference v0.21.5 h1:6uCGVXU/aNF13AQNggxfysJ+5ZcU4nEAe+pJyVWRdiE= +github.com/go-openapi/jsonreference v0.21.5/go.mod h1:u25Bw85sX4E2jzFodh1FOKMTZLcfifd1Q+iKKOUxExw= +github.com/go-openapi/spec v0.22.4 h1:4pxGjipMKu0FzFiu/DPwN3CTBRlVM2yLf/YTWorYfDQ= +github.com/go-openapi/spec v0.22.4/go.mod h1:WQ6Ai0VPWMZgMT4XySjlRIE6GP1bGQOtEThn3gcWLtQ= +github.com/go-openapi/swag v0.19.15 h1:D2NRCBzS9/pEY3gP9Nl8aDqGUcPFrwG2p+CNFrLyrCM= +github.com/go-openapi/swag/conv v0.26.0 h1:5yGGsPYI1ZCva93U0AoKi/iZrNhaJEjr324YVsiD89I= +github.com/go-openapi/swag/conv v0.26.0/go.mod h1:tpAmIL7X58VPnHHiSO4uE3jBeRamGsFsfdDeDtb5ECE= +github.com/go-openapi/swag/jsonname v0.26.0 h1:gV1NFX9M8avo0YSpmWogqfQISigCmpaiNci8cGECU5w= +github.com/go-openapi/swag/jsonname v0.26.0/go.mod h1:urBBR8bZNoDYGr653ynhIx+gTeIz0ARZxHkAPktJK2M= +github.com/go-openapi/swag/jsonutils v0.26.0 h1:FawFML2iAXsPqmERscuMPIHmFsoP1tOqWkxBaKNMsnA= +github.com/go-openapi/swag/jsonutils v0.26.0/go.mod h1:2VmA0CJlyFqgawOaPI9psnjFDqzyivIqLYN34t9p91E= +github.com/go-openapi/swag/jsonutils/fixtures_test v0.26.0 h1:apqeINu/ICHouqiRZbyFvuDge5jCmmLTqGQ9V95EaOM= +github.com/go-openapi/swag/jsonutils/fixtures_test v0.26.0/go.mod h1:AyM6QT8uz5IdKxk5akv0y6u4QvcL9GWERt0Jx/F/R8Y= +github.com/go-openapi/swag/loading v0.26.0 h1:Apg6zaKhCJurpJer0DCxq99qwmhFddBhaMX7kilDcko= +github.com/go-openapi/swag/loading v0.26.0/go.mod h1:dBxQ/6V2uBaAQdevN18VELE6xSpJWZxLX4txe12JwDg= +github.com/go-openapi/swag/stringutils v0.26.0 h1:qZQngLxs5s7SLijc3N2ZO+fUq2o8LjuWAASSrJuh+xg= +github.com/go-openapi/swag/stringutils v0.26.0/go.mod h1:sWn5uY+QIIspwPhvgnqJsH8xqFT2ZbYcvbcFanRyhFE= +github.com/go-openapi/swag/typeutils v0.26.0 h1:2kdEwdiNWy+JJdOvu5MA2IIg2SylWAFuuyQIKYybfq4= +github.com/go-openapi/swag/typeutils v0.26.0/go.mod h1:oovDuIUvTrEHVMqWilQzKzV4YlSKgyZmFh7AlfABNVE= +github.com/go-openapi/swag/yamlutils v0.26.0 h1:H7O8l/8NJJQ/oiReEN+oMpnGMyt8G0hl460nRZxhLMQ= +github.com/go-openapi/swag/yamlutils v0.26.0/go.mod h1:1evKEGAtP37Pkwcc7EWMF0hedX0/x3Rkvei2wtG/TbU= +github.com/go-openapi/testify/enable/yaml/v2 v2.4.2 h1:5zRca5jw7lzVREKCZVNBpysDNBjj74rBh0N2BGQbSR0= +github.com/go-openapi/testify/enable/yaml/v2 v2.4.2/go.mod h1:XVevPw5hUXuV+5AkI1u1PeAm27EQVrhXTTCPAF85LmE= +github.com/go-openapi/testify/v2 v2.4.2 h1:tiByHpvE9uHrrKjOszax7ZvKB7QOgizBWGBLuq0ePx4= +github.com/go-openapi/testify/v2 v2.4.2/go.mod h1:SgsVHtfooshd0tublTtJ50FPKhujf47YRqauXXOUxfw= github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s= github.com/go-playground/assert/v2 v2.2.0/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4= github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA= github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY= github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY= github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY= -github.com/go-playground/validator/v10 v10.30.1 h1:f3zDSN/zOma+w6+1Wswgd9fLkdwy06ntQJp0BBvFG0w= -github.com/go-playground/validator/v10 v10.30.1/go.mod h1:oSuBIQzuJxL//3MelwSLD5hc2Tu889bF0Idm9Dg26cM= +github.com/go-playground/validator/v10 v10.30.2 h1:JiFIMtSSHb2/XBUbWM4i/MpeQm9ZK2xqPNk8vgvu5JQ= +github.com/go-playground/validator/v10 v10.30.2/go.mod h1:mAf2pIOVXjTEBrwUMGKkCWKKPs9NheYGabeB04txQSc= github.com/go-sql-driver/mysql v1.5.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg= -github.com/go-sql-driver/mysql v1.9.3 h1:U/N249h2WzJ3Ukj8SowVFjdtZKfu9vlLZxjPXV1aweo= -github.com/go-sql-driver/mysql v1.9.3/go.mod h1:qn46aNg1333BRMNU69Lq93t8du/dwxI64Gl8i5p1WMU= +github.com/go-sql-driver/mysql v1.10.0 h1:Q+1LV8DkHJvSYAdR83XzuhDaTykuDx0l6fkXxoWCWfw= +github.com/go-sql-driver/mysql v1.10.0/go.mod h1:M+cqaI7+xxXGG9swrdeUIoPG3Y3KCkF0pZej+SK+nWk= github.com/go-xmlfmt/xmlfmt v0.0.0-20191208150333-d5b6f63a941b/go.mod h1:aUCEOzzezBEjDBbFBoSiya/gduyIiWYRP6CnSFIV8AM= github.com/go-xmlfmt/xmlfmt v1.1.3 h1:t8Ey3Uy7jDSEisW2K3somuMKIpzktkWptA0iFCnRUWY= github.com/go-xmlfmt/xmlfmt v1.1.3/go.mod h1:aUCEOzzezBEjDBbFBoSiya/gduyIiWYRP6CnSFIV8AM= -github.com/goccy/go-json v0.10.5 h1:Fq85nIqj+gXn/S5ahsiTlK3TmC85qgirsdTP/+DeaC4= -github.com/goccy/go-json v0.10.5/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M= +github.com/goccy/go-json v0.10.6 h1:p8HrPJzOakx/mn/bQtjgNjdTcN+/S6FcG2CTtQOrHVU= +github.com/goccy/go-json v0.10.6/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M= github.com/goccy/go-yaml v1.19.2 h1:PmFC1S6h8ljIz6gMRBopkjP1TVT7xuwrButHID66PoM= github.com/goccy/go-yaml v1.19.2/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA= github.com/golang-jwt/jwt/v5 v5.3.1 h1:kYf81DTWFe7t+1VvL7eS+jKFVWaUnK9cB1qbwn63YCY= @@ -226,16 +214,17 @@ github.com/golang-sql/civil v0.0.0-20220223132316-b832511892a9 h1:au07oEsX2xN0kt github.com/golang-sql/civil v0.0.0-20220223132316-b832511892a9/go.mod h1:8vg3r2VgvsThLBIFL93Qb5yWzgyZWhEmBwUJWevAkK0= github.com/golang-sql/sqlexp v0.1.0 h1:ZCD6MBpcuOVfGVqsEmY5/4FtYiKz6tSyUv9LPEDei6A= github.com/golang-sql/sqlexp v0.1.0/go.mod h1:J4ad9Vo8ZCWQ2GMrC4UCQy1JpCbwU9m3EOqtpKwwwHI= -github.com/golang/freetype v0.0.0-20170609003504-e2365dfdc4a0/go.mod h1:E/TSTwGwJL78qG/PmXZO1EjYhfJinVAhrmmHX6Z8B9k= github.com/golang/geo v0.0.0-20190916061304-5b978397cfec/go.mod h1:QZ0nwyI2jOfgRAoBvP+ab5aRr7c9x7lhGEJrKvBwjWI= github.com/golang/geo v0.0.0-20200319012246-673a6f80352d/go.mod h1:QZ0nwyI2jOfgRAoBvP+ab5aRr7c9x7lhGEJrKvBwjWI= github.com/golang/geo v0.0.0-20210211234256-740aa86cb551/go.mod h1:QZ0nwyI2jOfgRAoBvP+ab5aRr7c9x7lhGEJrKvBwjWI= -github.com/golang/geo v0.0.0-20260302211937-87f5a40ea07a h1:7f/cr+n7Jtd7mzCLrx47sdVIGabpSSxCHrf6fJczDp0= -github.com/golang/geo v0.0.0-20260302211937-87f5a40ea07a/go.mod h1:Mymr9kRGDc64JPr03TSZmuIBODZ3KyswLzm1xL0HFA8= +github.com/golang/geo v0.0.0-20260706204034-7a8d33c78269 h1:fJm1E0s1rwe6ff7IgGNwleI7dX5Cyd6s17P7rQMjJks= +github.com/golang/geo v0.0.0-20260706204034-7a8d33c78269/go.mod h1:Mymr9kRGDc64JPr03TSZmuIBODZ3KyswLzm1xL0HFA8= github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= github.com/golang/groupcache v0.0.0-20190702054246-869f871628b6/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= github.com/golang/groupcache v0.0.0-20191227052852-215e87163ea7/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= +github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da h1:oI5xCqsCo564l8iNU+DwB5epxmsaqB+rhGL0m5jtYqE= +github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= github.com/golang/mock v1.2.0/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= github.com/golang/mock v1.3.1/go.mod h1:sBzyDLLjw3U8JLTeZvSv8jJB+tU5PVekmnlKIyFUx0Y= @@ -256,6 +245,8 @@ github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= github.com/google/gofuzz v1.2.0 h1:xRy4A+RhZaiKjJ1bPfwQ8sedCA+YS2YcCHW6ec7JMi0= github.com/google/gofuzz v1.2.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= +github.com/google/jsonschema-go v0.4.3 h1:/DBOLZTfDow7pe2GmaJNhltueGTtDKICi8V8p+DQPd0= +github.com/google/jsonschema-go v0.4.3/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE= github.com/google/martian v2.1.0+incompatible/go.mod h1:9I4somxYTbIHy5NJKHRl3wXiIaQGbYVAs8BPL6v8lEs= github.com/google/open-location-code/go v0.0.0-20250620134813-83986da0156b h1:MQ/kiBq8Vl8huvJFEBZGDURueIzCLwqB9g5EfrRQYes= github.com/google/open-location-code/go v0.0.0-20250620134813-83986da0156b/go.mod h1:eJfRN6aj+kR/rnua/rw9jAgYhqoMHldQkdTi+sePRKk= @@ -316,8 +307,10 @@ github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0/go.mod h1:1NbS8ALr github.com/karrick/godirwalk v1.17.0 h1:b4kY7nqDdioR/6qnbHQyDvmA17u5G1cZ6J+CZXwSWoI= github.com/karrick/godirwalk v1.17.0/go.mod h1:j4mkqPuvaLI8mp1DroR3P6ad7cyYd4c1qeJ3RV7ULlk= github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= -github.com/klauspost/cpuid/v2 v2.3.0 h1:S4CRMLnYUhGeDFDqkGriYKdfoFlDnMtqTiI/sFzhA9Y= -github.com/klauspost/cpuid/v2 v2.3.0/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0= +github.com/klauspost/compress v1.19.0 h1:sXLILfc9jV2QYWkzFOPWStmcUVH2RHEB1JCdY2oVvCQ= +github.com/klauspost/compress v1.19.0/go.mod h1:cwPg85FWrGar70rWktvGQj8/hthj3wpl0PGDogxkrSQ= +github.com/klauspost/cpuid/v2 v2.4.0 h1:S6Hrbc7+ywsr0r+RLapfGBHfyefhCTwEh3A0tV913Dw= +github.com/klauspost/cpuid/v2 v2.4.0/go.mod h1:19jmZ9mjzoF//ddRSUsv0zfBTJWh3QJh9FNxZTMrGxU= github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= @@ -333,10 +326,10 @@ github.com/leodido/go-urn v1.4.0/go.mod h1:bvxc+MVxLKB4z00jd1z+Dvzr47oO32F/QSNjS github.com/leonelquinteros/gotext v1.7.2 h1:bDPndU8nt+/kRo1m4l/1OXiiy2v7Z7dfPQ9+YP7G1Mc= github.com/leonelquinteros/gotext v1.7.2/go.mod h1:9/haCkm5P7Jay1sxKDGJ5WIg4zkz8oZKw4ekNpALob8= github.com/lib/pq v1.1.1/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo= -github.com/lib/pq v1.10.9 h1:YXG7RB+JIjhP29X+OtkiDnYaXQwpS4JEWq7dtCCRUEw= -github.com/lib/pq v1.10.9/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o= -github.com/lucasb-eyer/go-colorful v1.3.0 h1:2/yBRLdWBZKrf7gB40FoiKfAWYQ0lqNcbuQwVHXptag= -github.com/lucasb-eyer/go-colorful v1.3.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= +github.com/lib/pq v1.12.1 h1:x1nbl/338GLqeDJ/FAiILallhAsqubLzEZu/pXtHUow= +github.com/lib/pq v1.12.1/go.mod h1:/p+8NSbOcwzAEI7wiMXFlgydTwcgTr3OSKMsD2BitpA= +github.com/lucasb-eyer/go-colorful v1.4.0 h1:UtrWVfLdarDgc44HcS7pYloGHJUjHV/4FwW4TvVgFr4= +github.com/lucasb-eyer/go-colorful v1.4.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= github.com/mandykoh/go-parallel v0.1.0 h1:7vJMNMC4dsbgZdkAb2A8tV5ENY1v7VxIO1wzQWZoT8k= github.com/mandykoh/go-parallel v0.1.0/go.mod h1:lkYHqG1JNTaSS6lG+PgFCnyMd2VDy8pH9jN9pY899ig= github.com/mandykoh/prism v0.35.3 h1:H9althbP8zJFC+0kuv1EMmSB3/QsAUYwnttKXNmROsI= @@ -345,21 +338,23 @@ github.com/manifoldco/promptui v0.9.0 h1:3V4HzJk1TtXW1MTZMP7mdlwbBpIinw3HztaIlYt github.com/manifoldco/promptui v0.9.0/go.mod h1:ka04sppxSGFAtxX0qhlYQjISsg9mR4GWtQEhdbn6Pgg= github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= -github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= -github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= -github.com/mattn/go-runewidth v0.0.20 h1:WcT52H91ZUAwy8+HUkdM3THM6gXqXuLJi9O3rjcQQaQ= -github.com/mattn/go-runewidth v0.0.20/go.mod h1:XBkDxAl56ILZc9knddidhrOlY5R/pDhgLpndooCuJAs= +github.com/mattn/go-isatty v0.0.22 h1:j8l17JJ9i6VGPUFUYoTUKPSgKe/83EYU2zBC7YNKMw4= +github.com/mattn/go-isatty v0.0.22/go.mod h1:ZXfXG4SQHsB/w3ZeOYbR0PrPwLy+n6xiMrJlRFqopa4= +github.com/mattn/go-runewidth v0.0.23 h1:7ykA0T0jkPpzSvMS5i9uoNn2Xy3R383f9HDx3RybWcw= +github.com/mattn/go-runewidth v0.0.23/go.mod h1:XBkDxAl56ILZc9knddidhrOlY5R/pDhgLpndooCuJAs= github.com/mattn/go-sqlite3 v1.14.0/go.mod h1:JIl7NbARA7phWnGvh0LKTyg7S9BA+6gx71ShQilpsus= -github.com/mattn/go-sqlite3 v1.14.34 h1:3NtcvcUnFBPsuRcno8pUtupspG/GM+9nZ88zgJcp6Zk= -github.com/mattn/go-sqlite3 v1.14.34/go.mod h1:Uh1q+B4BYcTPb+yiD3kU8Ct7aC0hY9fxUwlHK0RXw+Y= +github.com/mattn/go-sqlite3 v1.14.44 h1:3VSe+xafpbzsLbdr2AWlAZk9yRHiBhTBakioXaCKTF8= +github.com/mattn/go-sqlite3 v1.14.44/go.mod h1:pjEuOr8IwzLJP2MfGeTb0A35jauH+C2kbHKBr7yXKVQ= +github.com/modelcontextprotocol/go-sdk v1.6.1 h1:0zOSupjKUxPKSocPT1Wtago+mUHU2/uZ4xSOY0FGReU= +github.com/modelcontextprotocol/go-sdk v1.6.1/go.mod h1:kzm3kzFL1/+AziGOE0nUs3gvPoNxMCvkxokMkuFapXQ= github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg= github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9Gz0M= github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk= github.com/modocache/gover v0.0.0-20171022184752-b58185e213c5/go.mod h1:caMODM3PzxT8aQXRPkAt8xlV/e7d7w8GM5g0fa5F0D8= -github.com/montanaflynn/stats v0.7.1 h1:etflOAAHORrCC44V+aR6Ftzort912ZU+YLiSTuV8eaE= -github.com/montanaflynn/stats v0.7.1/go.mod h1:etXPPgVO6n31NxCd9KQUMvCM+ve0ruNzt6R8Bnaayow= +github.com/montanaflynn/stats v0.9.0 h1:tsBJ0RXwph9BmAuFoCmqGv6e8xa0MENQ8m0ptKq29mQ= +github.com/montanaflynn/stats v0.9.0/go.mod h1:etXPPgVO6n31NxCd9KQUMvCM+ve0ruNzt6R8Bnaayow= github.com/muhlemmer/gu v0.3.1 h1:7EAqmFrW7n3hETvuAdmFmn4hS8W+z3LgKtrnow+YzNM= github.com/muhlemmer/gu v0.3.1/go.mod h1:YHtHR+gxM+bKEIIs7Hmi9sPT3ZDUvTN/i88wQpZkrdM= github.com/muhlemmer/httpforwarded v0.1.0 h1:x4DLrzXdliq8mprgUMR0olDvHGkou5BJsK/vWUetyzY= @@ -368,12 +363,12 @@ github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ= github.com/olekukonko/cat v0.0.0-20250911104152-50322a0618f6 h1:zrbMGy9YXpIeTnGj4EljqMiZsIcE09mmF8XsD5AYOJc= github.com/olekukonko/cat v0.0.0-20250911104152-50322a0618f6/go.mod h1:rEKTHC9roVVicUIfZK7DYrdIoM0EOr8mK1Hj5s3JjH0= -github.com/olekukonko/errors v1.2.0 h1:10Zcn4GeV59t/EGqJc8fUjtFT/FuUh5bTMzZ1XwmCRo= -github.com/olekukonko/errors v1.2.0/go.mod h1:ppzxA5jBKcO1vIpCXQ9ZqgDh8iwODz6OXIGKU8r5m4Y= -github.com/olekukonko/ll v0.1.4-0.20260115111900-9e59c2286df0 h1:jrYnow5+hy3WRDCBypUFvVKNSPPCdqgSXIE9eJDD8LM= -github.com/olekukonko/ll v0.1.4-0.20260115111900-9e59c2286df0/go.mod h1:b52bVQRRPObe+yyBl0TxNfhesL0nedD4Cht0/zx55Ew= -github.com/olekukonko/tablewriter v1.1.3 h1:VSHhghXxrP0JHl+0NnKid7WoEmd9/urKRJLysb70nnA= -github.com/olekukonko/tablewriter v1.1.3/go.mod h1:9VU0knjhmMkXjnMKrZ3+L2JhhtsQ/L38BbL3CRNE8tM= +github.com/olekukonko/errors v1.3.0 h1:teJvgLGUEqMzBUms+Dj3/3szNqCG/Jdw9iDbum8fR6U= +github.com/olekukonko/errors v1.3.0/go.mod h1:ppzxA5jBKcO1vIpCXQ9ZqgDh8iwODz6OXIGKU8r5m4Y= +github.com/olekukonko/ll v0.1.8 h1:ysHCJRGHYKzmBSdz9w5AySztx7lG8SQY+naTGYUbsz8= +github.com/olekukonko/ll v0.1.8/go.mod h1:RPRC6UcscfFZgjo1nulkfMH5IM0QAYim0LfnMvUuozw= +github.com/olekukonko/tablewriter v1.1.4 h1:ORUMI3dXbMnRlRggJX3+q7OzQFDdvgbN9nVWj1drm6I= +github.com/olekukonko/tablewriter v1.1.4/go.mod h1:+kedxuyTtgoZLwif3P1Em4hARJs+mVnzKxmsCL/C5RY= github.com/orcaman/writerseeker v0.0.0-20200621085525-1d3f536ff85e h1:s2RNOM/IGdY0Y6qfTeUKhDawdHDpK9RGBdx80qN4Ttw= github.com/orcaman/writerseeker v0.0.0-20200621085525-1d3f536ff85e/go.mod h1:nBdnFKj15wFbf94Rwfq4m30eAcyY9V/IyKAGQFtqkW0= github.com/patrickmn/go-cache v2.1.0+incompatible h1:HRMgzkcYKYpi3C8ajMPV8OFXaaRUnok+kx1WdO15EQc= @@ -382,8 +377,8 @@ github.com/paulmach/go.geojson v1.5.0 h1:7mhpMK89SQdHFcEGomT7/LuJhwhEgfmpWYVlVmL github.com/paulmach/go.geojson v1.5.0/go.mod h1:DgdUy2rRVDDVgKqrjMe2vZAHMfhDTrjVKt3LmHIXGbU= github.com/pbnjay/memory v0.0.0-20210728143218-7b4eea64cf58 h1:onHthvaw9LFnH4t2DcNVpwGmV9E1BkGknEliJkfwQj0= github.com/pbnjay/memory v0.0.0-20210728143218-7b4eea64cf58/go.mod h1:DXv8WO4yhMYhSNPKjeNKa5WY9YCIEBRbNzFFPJbWO6Y= -github.com/pelletier/go-toml/v2 v2.2.4 h1:mye9XuhQ6gvn5h28+VilKrrPoQVanw5PMw/TB0t5Ec4= -github.com/pelletier/go-toml/v2 v2.2.4/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY= +github.com/pelletier/go-toml/v2 v2.3.1 h1:MYEvvGnQjeNkRF1qUuGolNtNExTDwct51yp7olPtrEc= +github.com/pelletier/go-toml/v2 v2.3.1/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY= github.com/pkg/browser v0.0.0-20180916011732-0a3d74bf9ce4/go.mod h1:4OwLy04Bl9Ef3GJJCoec+30X3LQs/0/m4HFRt/2LUSA= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= @@ -394,14 +389,14 @@ github.com/prometheus/client_golang v1.23.2/go.mod h1:Tb1a6LWHB3/SPIzCoaDXI4I8UH github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= github.com/prometheus/client_model v0.6.2 h1:oBsgwpGs7iVziMvrGhE53c/GrLUsZdHnqNwqPLxwZyk= github.com/prometheus/client_model v0.6.2/go.mod h1:y3m2F6Gdpfy6Ut/GBsUqTWZqCUvMVzSfMLjcu6wAwpE= -github.com/prometheus/common v0.67.5 h1:pIgK94WWlQt1WLwAC5j2ynLaBRDiinoAb86HZHTUGI4= -github.com/prometheus/common v0.67.5/go.mod h1:SjE/0MzDEEAyrdr5Gqc6G+sXI67maCxzaT3A2+HqjUw= -github.com/prometheus/procfs v0.17.0 h1:FuLQ+05u4ZI+SS/w9+BWEM2TXiHKsUQ9TADiRH7DuK0= -github.com/prometheus/procfs v0.17.0/go.mod h1:oPQLaDAMRbA+u8H5Pbfq+dl3VDAvHxMUOVhe0wYB2zw= +github.com/prometheus/common v0.69.0 h1:OA85nJQS/T/MaYh/Q2CcgDKSGWqNIgrBDvDH85CuiNk= +github.com/prometheus/common v0.69.0/go.mod h1:ZzL3f6u94qUxh9p+tJTrF+FvBS1XXbbRAZCQkytAL0Y= +github.com/prometheus/procfs v0.20.1 h1:XwbrGOIplXW/AU3YhIhLODXMJYyC1isLFfYCsTEycfc= +github.com/prometheus/procfs v0.20.1/go.mod h1:o9EMBZGRyvDrSPH1RqdxhojkuXstoe4UlK79eF5TGGo= github.com/quic-go/qpack v0.6.0 h1:g7W+BMYynC1LbYLSqRt8PBg5Tgwxn214ZZR34VIOjz8= github.com/quic-go/qpack v0.6.0/go.mod h1:lUpLKChi8njB4ty2bFLX2x4gzDqXwUpaO1DP9qMDZII= -github.com/quic-go/quic-go v0.59.0 h1:OLJkp1Mlm/aS7dpKgTc6cnpynnD2Xg7C1pwL6vy/SAw= -github.com/quic-go/quic-go v0.59.0/go.mod h1:upnsH4Ju1YkqpLXC305eW3yDZ4NfnNbmQRCMWS58IKU= +github.com/quic-go/quic-go v0.59.1 h1:0Gmua0HW1Tv7ANR7hUYwRyD0MG5OJfgvYSZasGZzBic= +github.com/quic-go/quic-go v0.59.1/go.mod h1:upnsH4Ju1YkqpLXC305eW3yDZ4NfnNbmQRCMWS58IKU= github.com/robfig/cron/v3 v3.0.1 h1:WdRxkvbJztn8LMz/QEvLN5sBU+xKpSqwwUO1Pjr4qDs= github.com/robfig/cron/v3 v3.0.1/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzGIFLtro= github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4= @@ -413,6 +408,10 @@ github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/rwcarlsen/goexif v0.0.0-20190401172101-9e8deecbddbd h1:CmH9+J6ZSsIjUK3dcGsnCnO41eRBOnY12zwkn5qVwgc= github.com/rwcarlsen/goexif v0.0.0-20190401172101-9e8deecbddbd/go.mod h1:hPqNNc0+uJM6H+SuU8sEs5K5IQeKccPqeSjfgcKGgPk= +github.com/segmentio/asm v1.1.5 h1:uLB9KKH+yHiJhy2Vbpot55fbImOk/bpUUVuy+M5m+wE= +github.com/segmentio/asm v1.1.5/go.mod h1:BqMnlJP91P8d+4ibuonYZw9mfnzI9HfxselHZr5aAcs= +github.com/segmentio/encoding v0.5.4 h1:OW1VRern8Nw6ITAtwSZ7Idrl3MXCFwXHPgqESYfvNt0= +github.com/segmentio/encoding v0.5.4/go.mod h1:HS1ZKa3kSN32ZHVZ7ZLPLXWvOVIiZtyJnO1gPH1sKt0= github.com/sevlyar/go-daemon v0.1.6 h1:EUh1MDjEM4BI109Jign0EaknA2izkOyi0LV3ro3QQGs= github.com/sevlyar/go-daemon v0.1.6/go.mod h1:6dJpPatBT9eUwM5VCw9Bt6CdX9Tk6UWvhW3MebLDRKE= github.com/sirupsen/logrus v1.9.4 h1:TsZE7l11zFCLZnZ+teH4Umoq5BhEIfIzfRDZ1Uzql2w= @@ -440,18 +439,16 @@ github.com/swaggo/gin-swagger v1.6.1/go.mod h1:LQ+hJStHakCWRiK/YNYtJOu4mR2FP+pxL github.com/swaggo/swag v1.16.6 h1:qBNcx53ZaX+M5dxVyTrgQ0PJ/ACK+NzhwcbieTt+9yI= github.com/swaggo/swag v1.16.6/go.mod h1:ngP2etMK5a0P3QBizic5MEwpRmluJZPHjXcMoj4Xesg= github.com/teambition/rrule-go v1.8.2/go.mod h1:Ieq5AbrKGciP1V//Wq8ktsTXwSwJHDD5mD/wLBGl3p4= -github.com/tidwall/gjson v1.18.0 h1:FIDeeyB800efLX89e5a8Y0BNH+LOngJyGrIWxG2FKQY= -github.com/tidwall/gjson v1.18.0/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk= -github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM= +github.com/tidwall/gjson v1.19.0 h1:xwxm7n691Uf3u5OFjzngavjGTh55KX5q/9w9xHW88JU= +github.com/tidwall/gjson v1.19.0/go.mod h1:V37/opeE/JbLUOfH0QTXiNez2l0RUjYUhpT4szFQAfc= github.com/tidwall/match v1.2.0 h1:0pt8FlkOwjN2fPt4bIl4BoNxb98gGHN2ObFEDkrfZnM= github.com/tidwall/match v1.2.0/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM= -github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU= github.com/tidwall/pretty v1.2.1 h1:qjsOFOWWQl+N3RsoF5/ssm1pHmJJwhjlSbZ51I6wMl4= github.com/tidwall/pretty v1.2.1/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU= github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS4MhqMhdFk5YI= github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08= -github.com/ugjka/go-tz/v2 v2.2.7 h1:ibg9vEPF0NUd7nd1fzxguVaSBkYQ5qWQPPEopDZvKlc= -github.com/ugjka/go-tz/v2 v2.2.7/go.mod h1:Jh35OKbERtwjZLWDZ2KgjD+bm5hb9Lx8nVD9Mv9NVzs= +github.com/ugjka/go-tz/v2 v2.2.8 h1:HXlZnkNvNAkAzcLYQ3V3GP/QqVKTGFU6lmqxUZcZnAE= +github.com/ugjka/go-tz/v2 v2.2.8/go.mod h1:Jh35OKbERtwjZLWDZ2KgjD+bm5hb9Lx8nVD9Mv9NVzs= github.com/ugorji/go/codec v1.3.1 h1:waO7eEiFDwidsBN6agj1vJQ4AG7lh2yqXyOXqhgQuyY= github.com/ugorji/go/codec v1.3.1/go.mod h1:pRBVtBSKl77K30Bv8R2P+cLSGaTtex6fsA2Wjqmfxj4= github.com/ulule/deepcopier v0.0.0-20200430083143-45decc6639b6 h1:TtyC78WMafNW8QFfv3TeP3yWNDG+uxNkk9vOrnDu6JA= @@ -462,42 +459,44 @@ github.com/wamuir/graft v0.10.0 h1:HSpBUvm7O+jwsRIuDQlw80xW4xMXRFkOiVLtWaZCU2s= github.com/wamuir/graft v0.10.0/go.mod h1:k6NJX3fCM/xzh5NtHky9USdgHTcz2vAvHp4c23I6UK4= github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342 h1:FnBeRrxr7OU4VvAzt5X7s6266i6cSVkkFPS0TuXWbIg= github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342/go.mod h1:Ohn+xnUBiLI6FVj/9LpzZWtj1/D6lUovWYBkxHVV3aM= -github.com/yalue/onnxruntime_go v1.26.0 h1:ucYOpoJRe40UCdv5QyIBx3wun1tEmID8eiZqVLJt9vc= -github.com/yalue/onnxruntime_go v1.26.0/go.mod h1:b4X26A8pekNb1ACJ58wAXgNKeUCGEAQ9dmACut9Sm/4= +github.com/yalue/onnxruntime_go v1.31.0 h1:1ln4YW1SFOFfGJZXe3jNOb2JUSt+l2pEneZfV8HdtFA= +github.com/yalue/onnxruntime_go v1.31.0/go.mod h1:b4X26A8pekNb1ACJ58wAXgNKeUCGEAQ9dmACut9Sm/4= +github.com/yosida95/uritemplate/v3 v3.0.2 h1:Ed3Oyj9yrmi9087+NczuL5BwkIc4wvTb5zIM+UJPGz4= +github.com/yosida95/uritemplate/v3 v3.0.2/go.mod h1:ILOh0sOhIJR3+L/8afwt/kE++YT040gmv5BQTMR2HP4= github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= github.com/zitadel/logging v0.7.0 h1:eugftwMM95Wgqwftsvj81isL0JK/hoScVqp/7iA2adQ= github.com/zitadel/logging v0.7.0/go.mod h1:9A6h9feBF/3u0IhA4uffdzSDY7mBaf7RE78H5sFMINQ= -github.com/zitadel/oidc/v3 v3.45.5 h1:CubfcXQiqtysk+FZyIcvj1+1ayvdSV89v5xWu5asrDQ= -github.com/zitadel/oidc/v3 v3.45.5/go.mod h1:MKHUazeiNX/jxRc6HD/Dv9qhL/wNuzrJAadBEGXiBeE= +github.com/zitadel/oidc/v3 v3.47.5 h1:cR2z0oqa5XZkwpXQiPCUGqKtndrjHgEXb81y3oXocK4= +github.com/zitadel/oidc/v3 v3.47.5/go.mod h1:XxFh0666HRXycyrKmono+3gY0RACpYJLgy4r/+kliKY= github.com/zitadel/schema v1.3.2 h1:gfJvt7dOMfTmxzhscZ9KkapKo3Nei3B6cAxjav+lyjI= github.com/zitadel/schema v1.3.2/go.mod h1:IZmdfF9Wu62Zu6tJJTH3UsArevs3Y4smfJIj3L8fzxw= -go.mongodb.org/mongo-driver/v2 v2.5.0 h1:yXUhImUjjAInNcpTcAlPHiT7bIXhshCTL3jVBkF3xaE= -go.mongodb.org/mongo-driver/v2 v2.5.0/go.mod h1:yOI9kBsufol30iFsl1slpdq1I0eHPzybRWdyYUs8K/0= +go.mongodb.org/mongo-driver/v2 v2.6.0 h1:b9sJOYrkmt4l8bY43ZenFBcPlhYIjaOfYHLtbB/5qi8= +go.mongodb.org/mongo-driver/v2 v2.6.0/go.mod h1:yOI9kBsufol30iFsl1slpdq1I0eHPzybRWdyYUs8K/0= go.opencensus.io v0.21.0/go.mod h1:mSImk1erAIZhrmZN+AvHh14ztQfjbGwt4TtuofqLduU= go.opencensus.io v0.22.0/go.mod h1:+kGneAE2xo2IficOXnaByMWTGM9T73dGwxeWcUqIpI8= go.opencensus.io v0.22.2/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw= go.opencensus.io v0.22.3/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw= go.opentelemetry.io/auto/sdk v1.2.1 h1:jXsnJ4Lmnqd11kwkBV2LgLoFMZKizbCi5fNZ/ipaZ64= go.opentelemetry.io/auto/sdk v1.2.1/go.mod h1:KRTj+aOaElaLi+wW1kO/DZRXwkF4C5xPbEe3ZiIhN7Y= -go.opentelemetry.io/otel v1.40.0 h1:oA5YeOcpRTXq6NN7frwmwFR0Cn3RhTVZvXsP4duvCms= -go.opentelemetry.io/otel v1.40.0/go.mod h1:IMb+uXZUKkMXdPddhwAHm6UfOwJyh4ct1ybIlV14J0g= -go.opentelemetry.io/otel/metric v1.40.0 h1:rcZe317KPftE2rstWIBitCdVp89A2HqjkxR3c11+p9g= -go.opentelemetry.io/otel/metric v1.40.0/go.mod h1:ib/crwQH7N3r5kfiBZQbwrTge743UDc7DTFVZrrXnqc= -go.opentelemetry.io/otel/trace v1.40.0 h1:WA4etStDttCSYuhwvEa8OP8I5EWu24lkOzp+ZYblVjw= -go.opentelemetry.io/otel/trace v1.40.0/go.mod h1:zeAhriXecNGP/s2SEG3+Y8X9ujcJOTqQ5RgdEJcawiA= +go.opentelemetry.io/otel v1.43.0 h1:mYIM03dnh5zfN7HautFE4ieIig9amkNANT+xcVxAj9I= +go.opentelemetry.io/otel v1.43.0/go.mod h1:JuG+u74mvjvcm8vj8pI5XiHy1zDeoCS2LB1spIq7Ay0= +go.opentelemetry.io/otel/metric v1.43.0 h1:d7638QeInOnuwOONPp4JAOGfbCEpYb+K6DVWvdxGzgM= +go.opentelemetry.io/otel/metric v1.43.0/go.mod h1:RDnPtIxvqlgO8GRW18W6Z/4P462ldprJtfxHxyKd2PY= +go.opentelemetry.io/otel/trace v1.43.0 h1:BkNrHpup+4k4w+ZZ86CZoHHEkohws8AY+WTX09nk+3A= +go.opentelemetry.io/otel/trace v1.43.0/go.mod h1:/QJhyVBUUswCphDVxq+8mld+AvhXZLhe+8WVFxiFff0= go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto= go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE= go.uber.org/mock v0.6.0 h1:hyF9dfmbgIX5EfOdasqLsWD6xqpNZlXblLB/Dbnwv3Y= go.uber.org/mock v0.6.0/go.mod h1:KiVJ4BqZJaMj4svdfmHM0AUx4NJYO8ZNpPnZn1Z+BBU= -go.yaml.in/yaml/v2 v2.4.3 h1:6gvOSjQoTB3vt1l+CU+tSyi/HOjfOjRLJ4YwYZGwRO0= -go.yaml.in/yaml/v2 v2.4.3/go.mod h1:zSxWcmIDjOzPXpjlTTbAsKokqkDNAVtZO0WOMiT90s8= +go.yaml.in/yaml/v2 v2.4.4 h1:tuyd0P+2Ont/d6e2rl3be67goVK4R6deVxCUX5vyPaQ= +go.yaml.in/yaml/v2 v2.4.4/go.mod h1:gMZqIpDtDqOfM0uNfy0SkpRhvUryYH0Z6wdMYcacYXQ= go.yaml.in/yaml/v3 v3.0.4 h1:tfq32ie2Jv2UxXFdLJdh3jXuOzWiL1fo0bu/FbuKpbc= go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg= go4.org v0.0.0-20200411211856-f5505b9728dd/go.mod h1:CIiUVy99QCPfoE13bO4EZaz5GZMZXMSBGhxRdsvzbkg= go4.org v0.0.0-20260112195520-a5071408f32f h1:ziUVAjmTPwQMBmYR1tbdRFJPtTcQUI12fH9QQjfb0Sw= go4.org v0.0.0-20260112195520-a5071408f32f/go.mod h1:ZRJnO5ZI4zAwMFp+dS1+V6J6MSyAowhRqAE+DPa1Xp0= -golang.org/x/arch v0.24.0 h1:qlJ3M9upxvFfwRM51tTg3Yl+8CP9vCC1E7vlFpgv99Y= -golang.org/x/arch v0.24.0/go.mod h1:dNHoOeKiyja7GTvF9NJS1l3Z2yntpQNzgrjh1cU103A= +golang.org/x/arch v0.27.0 h1:0WNVcR8u9yFz8j5FvdHpgwNp3FS5U4guYdzHwEiGjoU= +golang.org/x/arch v0.27.0/go.mod h1:0X+GdSIP+kL5wPmpK7sdkEVTt2XoYP0cSjQSbZBwOi8= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20190325154230-a5d413f7728c/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= @@ -511,8 +510,9 @@ golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0 golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc= golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU= golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8= -golang.org/x/crypto v0.48.0 h1:/VRzVqiRSggnhY7gNRxPauEQ5Drw9haKdM0jqfcCFts= -golang.org/x/crypto v0.48.0/go.mod h1:r0kV5h3qnFPlQnBSrULhlsRfryS2pmewsg+XfMgkVos= +golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk= +golang.org/x/crypto v0.54.0 h1:YLIA59K4fiNzHzjnZt2tUJQjQtUWfWbeHBqKtk3eScw= +golang.org/x/crypto v0.54.0/go.mod h1:KWL8ny2AZdGR2cWmzeHrp2azQPGogOv+HeQaVEXC2dk= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8= @@ -523,12 +523,10 @@ golang.org/x/exp v0.0.0-20191227195350-da58074b4299/go.mod h1:2RIsYlXP63K8oxa1u0 golang.org/x/exp v0.0.0-20200207192155-f17229e696bd/go.mod h1:J/WKrq2StrnmMY6+EHIKF9dgMWnmCNThgcyBT1FY9mM= golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js= golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= -golang.org/x/image v0.0.0-20191009234506-e7c1f5e7dbb8/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= -golang.org/x/image v0.0.0-20200927104501-e162460cd6b5/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= golang.org/x/image v0.0.0-20220902085622-e7cb96979f69/go.mod h1:doUCurBvlfPMKfmIpRIywoHmhN3VyhnoFDbvIEWF4hY= golang.org/x/image v0.18.0/go.mod h1:4yyo5vMFQjVjUcVk4jEQcU9MGy/rulF5WvUILseCM2E= -golang.org/x/image v0.36.0 h1:Iknbfm1afbgtwPTmHnS2gTM/6PPZfH+z2EFuOkSbqwc= -golang.org/x/image v0.36.0/go.mod h1:YsWD2TyyGKiIX1kZlu9QfKIsQ4nAAK9bdgdrIsE7xy4= +golang.org/x/image v0.44.0 h1:+tDekMZED9+LrtB3G5xzRggpVh9CARjZqROla3R3R+I= +golang.org/x/image v0.44.0/go.mod h1:V8K3KE9KKKE+pLpQDOeN18w9oacNSvy1tDOirTu4xtY= golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU= golang.org/x/lint v0.0.0-20190301231843-5614ed5bae6f/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= @@ -549,8 +547,8 @@ golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= golang.org/x/mod v0.15.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= -golang.org/x/mod v0.33.0 h1:tHFzIWbBifEmbwtGz65eaWyGiGZatSrT9prnU8DbVL8= -golang.org/x/mod v0.33.0/go.mod h1:swjeQEj+6r7fODbD2cqrnje9PnziFuw4bmLbBZFrQ5w= +golang.org/x/mod v0.38.0 h1:MECBjubtXD7yj4HrhIUcywNaGeNVUdfVnxmPajOk4yk= +golang.org/x/mod v0.38.0/go.mod h1:V6Xz0pq8TQ3dGqVQ1FVHuelZpAL0uNhSkk9ogYP3c40= golang.org/x/net v0.0.0-20180218175443-cbe0f9307d01/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= @@ -583,15 +581,16 @@ golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk= golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44= golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM= -golang.org/x/net v0.51.0 h1:94R/GTO7mt3/4wIKpcR5gkGmRLOuE/2hNGeWq/GBIFo= -golang.org/x/net v0.51.0/go.mod h1:aamm+2QF5ogm02fjy5Bb7CQ0WMt1/WVM7FtyaTLlA9Y= +golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4= +golang.org/x/net v0.57.0 h1:K5+3DljvIuDG9/Jv9rvyMywYNFCQ9RSUY6OOTTkT+tE= +golang.org/x/net v0.57.0/go.mod h1:KpXc8iv+r3XplLAG/f7Jsf9RPszJzdR0f58q9vGOuEU= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/oauth2 v0.0.0-20191202225959-858c2ad4c8b6/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= -golang.org/x/oauth2 v0.35.0 h1:Mv2mzuHuZuY2+bkyWXIHMfhNdJAdwW3FuWeCPYN5GVQ= -golang.org/x/oauth2 v0.35.0/go.mod h1:lzm5WQJQwKZ3nwavOZ3IS5Aulzxi68dUSgRHujetwEA= +golang.org/x/oauth2 v0.36.0 h1:peZ/1z27fi9hUOFCAZaHyrpWG5lwe0RJEEEeH0ThlIs= +golang.org/x/oauth2 v0.36.0/go.mod h1:YDBUJMTkDnJS+A4BP4eZBjCqtokkg1hODuPjwiGPO7Q= golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= @@ -603,8 +602,9 @@ golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y= golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= -golang.org/x/sync v0.19.0 h1:vV+1eWNmZ5geRlYjzm2adRgW2/mcpevXNg50YZtPCE4= -golang.org/x/sync v0.19.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI= +golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sync v0.22.0 h1:SZjpbeLmrCk4xhRSZFNZW5gFUeCeFgjekvI/+gfScek= +golang.org/x/sync v0.22.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0= golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20181122145206-62eef0e2fa9b/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= @@ -615,13 +615,11 @@ golang.org/x/sys v0.0.0-20190507160741-ecd444e8653b/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20190606165138-5da285871e9c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190624142023-c5567b49c5d0/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190726091711-fc99dfbffb4e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191204072324-ce4227a45e2e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191228213918-04cbcbbfeed8/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200212091648-12a6c2dcc1e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20201107080550-4d91cf3a1aaf/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= @@ -633,15 +631,14 @@ golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBc golang.org/x/sys v0.0.0-20220728004956-3c1f35247d10/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220928140112-f11e5e49a4ec/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= -golang.org/x/sys v0.41.0 h1:Ivj+2Cp/ylzLiEU89QhWblYnOE9zerudt9Ftecq2C6k= -golang.org/x/sys v0.41.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= +golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.47.0 h1:o7XGOvZQCADBQQ4Y7VNq2dRWQR7JmOUW8Kxx4ZsNgWs= +golang.org/x/sys v0.47.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw= golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE= -golang.org/x/term v0.0.0-20191110171634-ad39bd3f0407/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= @@ -649,6 +646,7 @@ golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo= golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU= golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk= golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY= +golang.org/x/term v0.27.0/go.mod h1:iMsnZpn0cago0GOrHO2+Y7u7JPn5AylBrcoWkElMTSM= golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= @@ -662,12 +660,13 @@ golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= golang.org/x/text v0.16.0/go.mod h1:GhwF1Be+LQoKShO3cGOHzqOgRrGaYc9AvblQOmPVHnI= -golang.org/x/text v0.34.0 h1:oL/Qq0Kdaqxa1KbNeMKwQq0reLCCaFtqu2eNuSeNHbk= -golang.org/x/text v0.34.0/go.mod h1:homfLqTYRFyVYemLBFl5GgL/DWEiH5wcsQ5gSh1yziA= +golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ= +golang.org/x/text v0.40.0 h1:Ub2Z6/xjgF1WrYQz2nuITOEegKFtiIy+rieRJ5lHZKs= +golang.org/x/text v0.40.0/go.mod h1:hpnzDAfGV753zIKo+wk3u1bVKCGPbrnF7+7LBF/UHVY= golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= -golang.org/x/time v0.14.0 h1:MRx4UaLrDotUKUdCIqzPC48t1Y9hANFKIRpNx+Te8PI= -golang.org/x/time v0.14.0/go.mod h1:eL/Oa2bBBK0TkX57Fyni+NgnyQQN4LitPmob2Hjnqw4= +golang.org/x/time v0.15.0 h1:bbrp8t3bGUeFOx08pvsMYRTCVSMk89u4tKbNOZbp88U= +golang.org/x/time v0.15.0/go.mod h1:Y4YMaQmXwGQZoFaVFk4YpCt4FLQMYKZe9oeV/f4MSno= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY= @@ -696,8 +695,8 @@ golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58= golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk= -golang.org/x/tools v0.41.0 h1:a9b8iMweWG+S0OBnlU36rzLp20z1Rp10w+IY2czHTQc= -golang.org/x/tools v0.41.0/go.mod h1:XSY6eDqxVNiYgezAVqqCeihT4j1U2CCsqvH3WhQpnlg= +golang.org/x/tools v0.47.0 h1:7Kn5x/d1svx/PzryTsqeoZN4TZwqeH5pGWjefhLi/1Q= +golang.org/x/tools v0.47.0/go.mod h1:dFHnyTvFWY212G+h7ZY4Vsp/K3U4/7W9TyVaAul8uCA= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/internal/AGENTS.md b/internal/AGENTS.md new file mode 100644 index 000000000..757ae9077 --- /dev/null +++ b/internal/AGENTS.md @@ -0,0 +1,43 @@ +# Internal Go Guidelines + +**Last Updated:** April 9, 2026 + +This file applies to `internal/` and defers subtree-specific rules to the narrower guides under `internal/api/`, `internal/config/`, `internal/commands/`, `internal/photoprism/`, and `internal/service/cluster/`. + +## Internal Linting + +- Run `make lint-go` after Go changes; for focused work, prefer `golangci-lint run ./internal/<pkg>/...`. + +## Logging, Naming & Status + +- When adding GORM struct fields with uppercase abbreviations such as `LabelNSFW`, `UserID`, or `URLHash`, set an explicit `gorm:"column:<name>"` tag so column names stay stable. +- Use the shared logger via the package-level `log` variable backed by `event.Log`; avoid `fmt.Print*` and ad-hoc loggers. +- In human-readable log text, prefer `instance` and `service`; reserve `node` for contract-bound names such as `/cluster/nodes`, `Node*`, and `PHOTOPRISM_NODE_*`. +- End every `event.Audit*` slice with exactly one status token from `pkg/log/status`, such as `status.Succeeded`, `status.Failed`, or `status.Denied`. +- When the outcome should be a sanitized error string, use `status.Error(err)` instead of hand-building it. + +## Internal Tests & Fixtures + +- Keep Go scratch work inside `internal/...`; Go rejects imports from `internal/` when helpers live under paths such as `/tmp`. +- Heavy packages such as `internal/entity` and `internal/photoprism` run migrations and fixtures; expect slower first runs and narrow them with `-run`. +- For database updates, prefer `entity.Values` over raw `map[string]interface{}`. +- When adding persistent fixtures, generate IDs with `rnd.GenerateUID(...)` and the matching prefix instead of inventing manual strings. +- Prefer `config.NewMinimalTestConfig(t.TempDir())` for filesystem or config scaffolding and `config.NewMinimalTestConfigWithDb("<name>", t.TempDir())` for isolated SQLite schemas. +- `internal/config` test helpers now auto-discover the repository `assets/` directory; do not set `PHOTOPRISM_ASSETS_PATH` manually in `init()` unless you truly have a non-standard layout. +- Hub API traffic is disabled in tests by default via `hub.ApplyTestConfig()`; opt back in with `PHOTOPRISM_TEST_HUB=test`. +- Avoid `config.TestConfig()` in new tests unless you need the fully seeded singleton fixture set; tests that write to Originals or Import should use isolated minimal configs plus `conf.CreateDirectories()`. +- `config.NewTestConfig("<pkg>")` defaults to SQLite with a per-suite DSN such as `.<pkg>.db`; do not assert an empty DSN, and clean up captured DSNs with `t.Cleanup(...)` if needed. +- `NewTestConfig("<pkg>")` already calls `InitializeTestData()`. If you build a custom config, call `c.InitializeTestData()` and optionally `c.AssertTestData(t)` so Originals, Import, cache, and temp exist. +- `PhotoFixtures.Get()` and similar helpers return value copies; re-query with helpers such as `entity.FindPhoto(...)` when a test needs the persisted row with associations. +- Reuse shared `Example*` constants for illustrative credentials in tests and docs. + +## Focused Internal Test Runs + +- Thumbnails: `go test ./internal/thumb/... -count=1` +- FFmpeg command builders: `go test ./internal/ffmpeg -run 'Remux|Transcode|Extract' -count=1` + +## FFmpeg Hardware Gating + +- Do not run GPU or hardware encoder integrations in CI by default; gate them with `PHOTOPRISM_FFMPEG_ENCODER` set to `vaapi`, `intel`, or `nvidia`. +- Keep negative-path ffmpeg tests fast and always runnable: missing ffmpeg should fail immediately, and unwritable destinations should fail without creating files. +- When hardware is unavailable, prefer command-string assertions; enable full hardware runs locally only when a device is configured. diff --git a/internal/ai/classify/README.md b/internal/ai/classify/README.md index 37d9b543f..a1304fe24 100644 --- a/internal/ai/classify/README.md +++ b/internal/ai/classify/README.md @@ -1,6 +1,6 @@ ## PhotoPrism — Classification Package -**Last Updated:** February 20, 2026 +**Last Updated:** April 1, 2026 ### Overview @@ -9,7 +9,7 @@ ### How It Works - **Model Loading** — The classifier loads a SavedModel under `assets/models/<name>` and resolves model tags and input/output ops (see `vision.yml` overrides for custom models). -- **Input Preparation** — JPEGs are decoded and resized/cropped to the model’s expected input resolution. +- **Input Preparation** — Input images are decoded through PhotoPrism’s bounded image helpers and resized/cropped to the model’s expected input resolution. - **Inference** — The model outputs probabilities; `Rules` apply thresholds and priority to produce final labels. ### Memory & Performance @@ -24,14 +24,15 @@ TensorFlow tensors allocate C memory and are freed by Go GC finalizers. To keep After the base image and toolchain upgrade on February 20, 2026, we observed measurable drift in TensorFlow label uncertainty values caused by changes in Go's `image/jpeg` implementation: - **Direct Evidence** — The `ChameleonLimeJpg` fixture shifted from uncertainty `7` with Go `1.25.4` to `8` with Go `1.26.0` for the same model and inputs. -- **Pipeline Relevance** — Classification input decoding goes through `imaging.Decode(...)` in `model.go`, which uses Go's registered JPEG decoder. -- **Fixture Scan Result** — 55/55 JPEG fixtures in `assets/examples` decoded successfully on both versions (no compatibility failures), but all produced different decoded pixel hashes between Go `1.25.4` and `1.26.0`. +- **Pipeline Relevance** — Classification input decoding now goes through `pkg/fs` direct dispatch helpers, while in-memory resize/pad work uses PhotoPrism's stdlib/x-image thumbnail helpers. JPEG and PNG continue to use direct Go decoders, while TIFF goes through an explicit header/IFD validation path before `tiff.Decode`. +- **Fixture Scan Result** — 55/55 JPEG fixtures in `assets/samples` decoded successfully on both versions (no compatibility failures), but all produced different decoded pixel hashes between Go `1.25.4` and `1.26.0`. - **Output Stability** — In sampled tests, top labels remained stable (`chameleon`, `cat`, etc.), while confidence and uncertainty values moved slightly. Operational notes: - Prefer tolerance-based assertions (`assert.InDelta`) for JPEG-derived uncertainty/confidence tests instead of exact integer equality. - Avoid bit-for-bit JPEG expectations in tests unless the codec/toolchain is pinned and intentionally version-locked. +- Classification no longer relies on generic Go image decoder registration for TIFF input handling. ### Troubleshooting Tips diff --git a/internal/ai/classify/classify.go b/internal/ai/classify/classify.go index d799dee22..83da749c7 100644 --- a/internal/ai/classify/classify.go +++ b/internal/ai/classify/classify.go @@ -1,7 +1,7 @@ /* Package classify encapsulates image classification using TensorFlow. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/ai/classify/model.go b/internal/ai/classify/model.go index 5615d7255..863925b97 100644 --- a/internal/ai/classify/model.go +++ b/internal/ai/classify/model.go @@ -1,9 +1,10 @@ package classify import ( - "bytes" "fmt" + "image" "image/color" + "image/draw" "math" "os" "path" @@ -12,11 +13,12 @@ import ( "strings" "sync" - "github.com/disintegration/imaging" tf "github.com/wamuir/graft/tensorflow" "github.com/photoprism/photoprism/internal/ai/tensorflow" + "github.com/photoprism/photoprism/internal/thumb" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/fs" "github.com/photoprism/photoprism/pkg/http/scheme" "github.com/photoprism/photoprism/pkg/media" ) @@ -30,7 +32,7 @@ type Model struct { labels []string disabled bool meta *tensorflow.ModelInfo - builder *tensorflow.ImageTensorBuilder + builderPool sync.Pool mutex sync.Mutex } @@ -247,11 +249,23 @@ func (m *Model) loadModel() (err error) { } } - m.builder, err = tensorflow.NewImageTensorBuilder(m.meta.Input) - if err != nil { + // Validate the input shape up front and pool per-call tensor builders. + // A single shared builder corrupts results when indexing workers + // classify the same model in parallel. + if _, err = tensorflow.NewImageTensorBuilder(m.meta.Input); err != nil { return fmt.Errorf("classify: could not create the tensor builder (%s)", clean.Error(err)) } + input := m.meta.Input + m.builderPool.New = func() any { + builder, builderErr := tensorflow.NewImageTensorBuilder(input) + if builderErr != nil { + log.Errorf("classify: %s (create tensor builder)", clean.Error(builderErr)) + return nil + } + return builder + } + return m.loadLabels(modelPath) } @@ -301,9 +315,9 @@ func (m *Model) bestLabels(probabilities []float32, confidenceThreshold int) Lab } } -// createTensor converts bytes jpeg image in a tensor object required as tensorflow model input -func (m *Model) createTensor(image []byte) (*tf.Tensor, error) { - img, err := imaging.Decode(bytes.NewReader(image), imaging.AutoOrientation(true)) +// createTensor converts image bytes into the tensor format required by the TensorFlow model. +func (m *Model) createTensor(data []byte) (*tf.Tensor, error) { + img, _, err := fs.DecodeImageData(data) if err != nil { return nil, err @@ -313,17 +327,28 @@ func (m *Model) createTensor(image []byte) (*tf.Tensor, error) { if img.Bounds().Dx() != m.meta.Input.Resolution() || img.Bounds().Dy() != m.meta.Input.Resolution() { switch m.meta.Input.ResizeOperation { case tensorflow.ResizeBreakAspectRatio: - img = imaging.Resize(img, m.meta.Input.Resolution(), m.meta.Input.Resolution(), imaging.Lanczos) + img = thumb.Resample(img, m.meta.Input.Resolution(), m.meta.Input.Resolution(), thumb.ResampleResize) case tensorflow.CenterCrop: - img = imaging.Fill(img, m.meta.Input.Resolution(), m.meta.Input.Resolution(), imaging.Center, imaging.Lanczos) + img = thumb.Resample(img, m.meta.Input.Resolution(), m.meta.Input.Resolution(), thumb.ResampleFillCenter) case tensorflow.Padding: - resized := imaging.Fit(img, m.meta.Input.Resolution(), m.meta.Input.Resolution(), imaging.Lanczos) - dst := imaging.New(m.meta.Input.Resolution(), m.meta.Input.Resolution(), color.NRGBA{0, 0, 0, 255}) - img = imaging.PasteCenter(dst, resized) + resized := thumb.Resample(img, m.meta.Input.Resolution(), m.meta.Input.Resolution(), thumb.ResampleFit) + dst := image.NewNRGBA(image.Rect(0, 0, m.meta.Input.Resolution(), m.meta.Input.Resolution())) + draw.Draw(dst, dst.Bounds(), &image.Uniform{C: color.NRGBA{0, 0, 0, 255}}, image.Point{}, draw.Src) + offset := image.Pt((dst.Bounds().Dx()-resized.Bounds().Dx())/2, (dst.Bounds().Dy()-resized.Bounds().Dy())/2) + draw.Draw(dst, image.Rectangle{Min: offset, Max: offset.Add(resized.Bounds().Size())}, resized, resized.Bounds().Min, draw.Over) + img = dst default: - img = imaging.Fill(img, m.meta.Input.Resolution(), m.meta.Input.Resolution(), imaging.Center, imaging.Lanczos) + img = thumb.Resample(img, m.meta.Input.Resolution(), m.meta.Input.Resolution(), thumb.ResampleFillCenter) } } - return tensorflow.Image(img, m.meta.Input, m.builder) + // Use a per-call tensor builder so concurrent indexing workers never share + // the same pixel buffer, which would corrupt classification results. + builder, ok := m.builderPool.Get().(*tensorflow.ImageTensorBuilder) + if !ok || builder == nil { + return nil, fmt.Errorf("classify: tensor builder unavailable") + } + defer m.builderPool.Put(builder) + + return tensorflow.Image(img, m.meta.Input, builder) } diff --git a/internal/ai/classify/model_concurrency_test.go b/internal/ai/classify/model_concurrency_test.go new file mode 100644 index 000000000..b7f52364c --- /dev/null +++ b/internal/ai/classify/model_concurrency_test.go @@ -0,0 +1,86 @@ +package classify + +import ( + "os" + "path/filepath" + "sync" + "testing" + + "github.com/stretchr/testify/assert" +) + +// TestModel_RunConcurrent verifies that a single model instance can classify +// images from multiple goroutines without corrupting results, as happens during +// parallel indexing. Run with -race to deterministically catch the data race. +func TestModel_RunConcurrent(t *testing.T) { + if testing.Short() { + t.Skip("skipping test in short mode.") + } + + model := NewNasnet(modelsPath, false) + if err := model.loadModel(); err != nil { + t.Fatal(err) + } + + // Distinct subjects with stable top labels; if the shared input buffer is + // clobbered by a concurrent worker, the produced label no longer matches. + cases := []struct { + file string + label string + }{ + {"chameleon_lime.jpg", "chameleon"}, + {"dog_orange.jpg", "dog"}, + {"cat_224.jpeg", "cat"}, + {"zebra_green_brown.jpg", "zebra"}, + } + + images := make([][]byte, len(cases)) + for i := range cases { + data, err := os.ReadFile(filepath.Join(samplesPath, cases[i].file)) //nolint:gosec // reading bundled test fixture + if err != nil { + t.Fatal(err) + } + images[i] = data + } + + const goroutinesPerCase = 2 + const rounds = 3 + + var wg sync.WaitGroup + start := make(chan struct{}) + var mu sync.Mutex + var mismatches []string + + for i := range cases { + for g := 0; g < goroutinesPerCase; g++ { + wg.Add(1) + go func(idx int) { + defer wg.Done() + <-start + for r := 0; r < rounds; r++ { + result, err := model.Run(images[idx], 10) + if err != nil { + mu.Lock() + mismatches = append(mismatches, cases[idx].file+": "+err.Error()) + mu.Unlock() + return + } + if len(result) == 0 || result[0].Name != cases[idx].label { + got := "<none>" + if len(result) > 0 { + got = result[0].Name + } + mu.Lock() + mismatches = append(mismatches, cases[idx].file+": expected "+cases[idx].label+", got "+got) + mu.Unlock() + } + } + }(i) + } + } + + close(start) + wg.Wait() + + assert.Empty(t, mismatches, "concurrent classification corrupted labels: %v", mismatches) +} diff --git a/internal/ai/classify/model_external_test.go b/internal/ai/classify/model_external_test.go index 2b4751500..4610d8f8a 100644 --- a/internal/ai/classify/model_external_test.go +++ b/internal/ai/classify/model_external_test.go @@ -335,7 +335,7 @@ func testModelLabelsFromFile(t *testing.T, tensorFlow *Model) { } t.Run(testName("chameleon_lime.jpg"), func(t *testing.T) { - result, err := tensorFlow.File(examplesPath+"/chameleon_lime.jpg", 10) + result, err := tensorFlow.File(samplesPath+"/chameleon_lime.jpg", 10) assert.NoError(t, err) assert.NotNil(t, result) @@ -353,7 +353,7 @@ func testModelLabelsFromFile(t *testing.T, tensorFlow *Model) { } }) t.Run(testName("cat_224.jpeg"), func(t *testing.T) { - result, err := tensorFlow.File(examplesPath+"/cat_224.jpeg", 10) + result, err := tensorFlow.File(samplesPath+"/cat_224.jpeg", 10) assert.NoError(t, err) assert.NotNil(t, result) @@ -370,7 +370,7 @@ func testModelLabelsFromFile(t *testing.T, tensorFlow *Model) { } }) t.Run(testName("cat_720.jpeg"), func(t *testing.T) { - result, err := tensorFlow.File(examplesPath+"/cat_720.jpeg", 10) + result, err := tensorFlow.File(samplesPath+"/cat_720.jpeg", 10) assert.NoError(t, err) assert.NotNil(t, result) @@ -389,7 +389,7 @@ func testModelLabelsFromFile(t *testing.T, tensorFlow *Model) { } }) t.Run(testName("green.jpg"), func(t *testing.T) { - result, err := tensorFlow.File(examplesPath+"/green.jpg", 10) + result, err := tensorFlow.File(samplesPath+"/green.jpg", 10) t.Logf("labels: %#v", result) assert.NoError(t, err) @@ -407,7 +407,7 @@ func testModelLabelsFromFile(t *testing.T, tensorFlow *Model) { } }) t.Run(testName("not existing file"), func(t *testing.T) { - result, err := tensorFlow.File(examplesPath+"/notexisting.jpg", 10) + result, err := tensorFlow.File(samplesPath+"/notexisting.jpg", 10) assert.Contains(t, err.Error(), "no such file or directory") assert.Empty(t, result) }) @@ -415,7 +415,7 @@ func testModelLabelsFromFile(t *testing.T, tensorFlow *Model) { tensorFlow.disabled = true defer func() { tensorFlow.disabled = false }() - result, err := tensorFlow.File(examplesPath+"/chameleon_lime.jpg", 10) + result, err := tensorFlow.File(samplesPath+"/chameleon_lime.jpg", 10) assert.Nil(t, err) if err != nil { @@ -440,7 +440,7 @@ func testModelRun(t *testing.T, tensorFlow *Model) { } t.Run(testName("chameleon_lime.jpg"), func(t *testing.T) { - if imageBuffer, err := os.ReadFile(examplesPath + "/chameleon_lime.jpg"); err != nil { + if imageBuffer, err := os.ReadFile(samplesPath + "/chameleon_lime.jpg"); err != nil { t.Error(err) } else { result, err := tensorFlow.Run(imageBuffer, 10) @@ -467,7 +467,7 @@ func testModelRun(t *testing.T, tensorFlow *Model) { } }) t.Run(testName("dog_orange.jpg"), func(t *testing.T) { - if imageBuffer, err := os.ReadFile(examplesPath + "/dog_orange.jpg"); err != nil { + if imageBuffer, err := os.ReadFile(samplesPath + "/dog_orange.jpg"); err != nil { t.Error(err) } else { result, err := tensorFlow.Run(imageBuffer, 10) @@ -494,7 +494,7 @@ func testModelRun(t *testing.T, tensorFlow *Model) { } }) t.Run(testName("Random.docx"), func(t *testing.T) { - if imageBuffer, err := os.ReadFile(examplesPath + "/Random.docx"); err != nil { + if imageBuffer, err := os.ReadFile(samplesPath + "/Random.docx"); err != nil { t.Error(err) } else { result, err := tensorFlow.Run(imageBuffer, 10) @@ -503,7 +503,7 @@ func testModelRun(t *testing.T, tensorFlow *Model) { } }) t.Run(testName("6720px_white.jpg"), func(t *testing.T) { - if imageBuffer, err := os.ReadFile(examplesPath + "/6720px_white.jpg"); err != nil { + if imageBuffer, err := os.ReadFile(samplesPath + "/6720px_white.jpg"); err != nil { t.Error(err) } else { result, err := tensorFlow.Run(imageBuffer, 10) @@ -518,7 +518,7 @@ func testModelRun(t *testing.T, tensorFlow *Model) { t.Run(testName("disabled true"), func(t *testing.T) { tensorFlow.disabled = true defer func() { tensorFlow.disabled = false }() - if imageBuffer, err := os.ReadFile(examplesPath + "/dog_orange.jpg"); err != nil { + if imageBuffer, err := os.ReadFile(samplesPath + "/dog_orange.jpg"); err != nil { t.Error(err) } else { result, err := tensorFlow.Run(imageBuffer, 10) diff --git a/internal/ai/classify/model_test.go b/internal/ai/classify/model_test.go index 4f082c486..050a67c89 100644 --- a/internal/ai/classify/model_test.go +++ b/internal/ai/classify/model_test.go @@ -13,7 +13,7 @@ import ( ) var assetsPath = fs.Abs("../../../assets") -var examplesPath = filepath.Join(assetsPath, "examples") +var samplesPath = filepath.Join(assetsPath, "samples") var modelsPath = filepath.Join(assetsPath, "models") var modelPath = modelsPath + "/nasnet" var once sync.Once @@ -70,7 +70,7 @@ func TestModel_ResizeBreakAspectRatio(t *testing.T) { } func runBasicLabelsTest(t *testing.T, model *Model, expectedUncertainty int) { - result, err := model.File(examplesPath+"/zebra_green_brown.jpg", 10) + result, err := model.File(samplesPath+"/zebra_green_brown.jpg", 10) assert.NoError(t, err) assert.NotNil(t, result) @@ -79,15 +79,14 @@ func runBasicLabelsTest(t *testing.T, model *Model, expectedUncertainty int) { if len(result) > 0 { assert.Equal(t, "zebra", result[0].Name) - - assert.Equal(t, expectedUncertainty, result[0].Uncertainty) + assert.InDelta(t, expectedUncertainty, result[0].Uncertainty, 1) } } func TestModel_LabelsFromFile(t *testing.T) { t.Run("ChameleonLimeJpg", func(t *testing.T) { tensorFlow := NewModelTest(t) - result, err := tensorFlow.File(examplesPath+"/chameleon_lime.jpg", 10) + result, err := tensorFlow.File(samplesPath+"/chameleon_lime.jpg", 10) assert.NoError(t, err) assert.NotNil(t, result) @@ -103,7 +102,7 @@ func TestModel_LabelsFromFile(t *testing.T) { }) t.Run("CatNum224Jpeg", func(t *testing.T) { tensorFlow := NewModelTest(t) - result, err := tensorFlow.File(examplesPath+"/cat_224.jpeg", 10) + result, err := tensorFlow.File(samplesPath+"/cat_224.jpeg", 10) assert.NoError(t, err) assert.NotNil(t, result) @@ -112,13 +111,12 @@ func TestModel_LabelsFromFile(t *testing.T) { if len(result) > 0 { assert.Equal(t, "cat", result[0].Name) - - assert.Equal(t, 59, result[0].Uncertainty) + assert.InDelta(t, 59, result[0].Uncertainty, 2) } }) t.Run("CatNum720Jpeg", func(t *testing.T) { tensorFlow := NewModelTest(t) - result, err := tensorFlow.File(examplesPath+"/cat_720.jpeg", 10) + result, err := tensorFlow.File(samplesPath+"/cat_720.jpeg", 10) assert.NoError(t, err) assert.NotNil(t, result) @@ -129,12 +127,12 @@ func TestModel_LabelsFromFile(t *testing.T) { if len(result) > 0 { assert.Equal(t, "cat", result[0].Name) - assert.Equal(t, 60, result[0].Uncertainty) + assert.InDelta(t, 60, result[0].Uncertainty, 2) } }) t.Run("GreenJpg", func(t *testing.T) { tensorFlow := NewModelTest(t) - result, err := tensorFlow.File(examplesPath+"/green.jpg", 10) + result, err := tensorFlow.File(samplesPath+"/green.jpg", 10) t.Logf("labels: %#v", result) assert.NoError(t, err) @@ -144,21 +142,20 @@ func TestModel_LabelsFromFile(t *testing.T) { if len(result) > 0 { assert.Equal(t, "outdoor", result[0].Name) - - assert.Equal(t, 70, result[0].Uncertainty) + assert.InDelta(t, 70, result[0].Uncertainty, 5) } }) t.Run("NotExistingFile", func(t *testing.T) { tensorFlow := NewModelTest(t) - result, err := tensorFlow.File(examplesPath+"/notexisting.jpg", 10) + result, err := tensorFlow.File(samplesPath+"/notexisting.jpg", 10) assert.Contains(t, err.Error(), "no such file or directory") assert.Empty(t, result) }) t.Run("Disabled", func(t *testing.T) { tensorFlow := NewNasnet(modelsPath, true) - result, err := tensorFlow.File(examplesPath+"/chameleon_lime.jpg", 10) + result, err := tensorFlow.File(samplesPath+"/chameleon_lime.jpg", 10) assert.Nil(t, err) if err != nil { @@ -181,7 +178,7 @@ func TestModel_Run(t *testing.T) { t.Run("ChameleonLimeJpg", func(t *testing.T) { tensorFlow := NewModelTest(t) - if imageBuffer, err := os.ReadFile(filepath.Join(examplesPath, "chameleon_lime.jpg")); err != nil { //nolint:gosec // reading bundled test fixture + if imageBuffer, err := os.ReadFile(filepath.Join(samplesPath, "chameleon_lime.jpg")); err != nil { //nolint:gosec // reading bundled test fixture t.Error(err) } else { result, err := tensorFlow.Run(imageBuffer, 10) @@ -206,7 +203,7 @@ func TestModel_Run(t *testing.T) { t.Run("DogOrangeJpg", func(t *testing.T) { tensorFlow := NewModelTest(t) - if imageBuffer, err := os.ReadFile(filepath.Join(examplesPath, "dog_orange.jpg")); err != nil { //nolint:gosec // reading bundled test fixture + if imageBuffer, err := os.ReadFile(filepath.Join(samplesPath, "dog_orange.jpg")); err != nil { //nolint:gosec // reading bundled test fixture t.Error(err) } else { result, err := tensorFlow.Run(imageBuffer, 10) @@ -224,14 +221,15 @@ func TestModel_Run(t *testing.T) { if len(result) > 0 { assert.Equal(t, "dog", result[0].Name) - assert.Equal(t, 34, result[0].Uncertainty) + assert.GreaterOrEqual(t, result[0].Uncertainty, 25) + assert.LessOrEqual(t, result[0].Uncertainty, 50) } } }) t.Run("RandomDocx", func(t *testing.T) { tensorFlow := NewModelTest(t) - if imageBuffer, err := os.ReadFile(filepath.Join(examplesPath, "Random.docx")); err != nil { //nolint:gosec // reading bundled test fixture + if imageBuffer, err := os.ReadFile(filepath.Join(samplesPath, "Random.docx")); err != nil { //nolint:gosec // reading bundled test fixture t.Error(err) } else { result, err := tensorFlow.Run(imageBuffer, 10) @@ -242,7 +240,7 @@ func TestModel_Run(t *testing.T) { t.Run("Num6720PxWhiteJpg", func(t *testing.T) { tensorFlow := NewModelTest(t) - if imageBuffer, err := os.ReadFile(filepath.Join(examplesPath, "6720px_white.jpg")); err != nil { //nolint:gosec // reading bundled test fixture + if imageBuffer, err := os.ReadFile(filepath.Join(samplesPath, "6720px_white.jpg")); err != nil { //nolint:gosec // reading bundled test fixture t.Error(err) } else { result, err := tensorFlow.Run(imageBuffer, 10) @@ -257,7 +255,7 @@ func TestModel_Run(t *testing.T) { t.Run("Disabled", func(t *testing.T) { tensorFlow := NewNasnet(modelsPath, true) - if imageBuffer, err := os.ReadFile(filepath.Join(examplesPath, "dog_orange.jpg")); err != nil { //nolint:gosec // reading bundled test fixture + if imageBuffer, err := os.ReadFile(filepath.Join(samplesPath, "dog_orange.jpg")); err != nil { //nolint:gosec // reading bundled test fixture t.Error(err) } else { result, err := tensorFlow.Run(imageBuffer, 10) @@ -321,35 +319,14 @@ func TestModel_BestLabels(t *testing.T) { }) } -func BenchmarkModel_BestLabelWithOptimization(b *testing.B) { - model := NewNasnet(assetsPath, false) +func BenchmarkModel_Run(b *testing.B) { + model := NewNasnet(modelsPath, false) err := model.loadModel() if err != nil { b.Fatal(err) } - imageBuffer, err := os.ReadFile(filepath.Join(examplesPath, "dog_orange.jpg")) //nolint:gosec // reading bundled test fixture - if err != nil { - b.Fatal(err) - } - - for b.Loop() { - _, err := model.Run(imageBuffer, 10) - if err != nil { - b.Fatal(err) - } - } -} - -func BenchmarkModel_BestLabelsNoOptimization(b *testing.B) { - model := NewNasnet(assetsPath, false) - err := model.loadModel() - if err != nil { - b.Fatal(err) - } - model.builder = nil - - imageBuffer, err := os.ReadFile(filepath.Join(examplesPath, "dog_orange.jpg")) //nolint:gosec // reading bundled test fixture + imageBuffer, err := os.ReadFile(filepath.Join(samplesPath, "dog_orange.jpg")) //nolint:gosec // reading bundled test fixture if err != nil { b.Fatal(err) } diff --git a/internal/ai/face/README.md b/internal/ai/face/README.md index 0d62ce266..a9449ef8c 100644 --- a/internal/ai/face/README.md +++ b/internal/ai/face/README.md @@ -1,6 +1,6 @@ ## Face Detection & Embedding Guidelines -**Last Updated:** March 3, 2026 +**Last Updated:** April 1, 2026 ### Overview @@ -8,30 +8,19 @@ This document captures the current state of PhotoPrism's face detection and embe Key changes: -- Multi-angle scanning is enabled by default and can be tuned via configuration. - Detection thresholds were relaxed to improve recall, while overlap handling was adjusted to preserve historical behaviour. - All face embeddings are now L2-normalized at creation, midpoint calculation, and deserialization time to keep cosine and Euclidean comparisons consistent. - Benchmarks were added to track the cost of hotspot routines (`Embedding.Dist` and `EmbeddingsMidpoint`). -> **TODO:** Persist detector provenance in `FaceSrc` (e.g., use `entity.SrcONNX` for SCRFD detections) so hybrid libraries can toggle background filtering per embedding source when upgrading from Pigo. +> **TODO:** Persist detector provenance in `FaceSrc` (for example `entity.SrcONNX`) so ONNX-generated detections remain auditable after future model upgrades. ### Detection Pipeline -PhotoPrism now supports two interchangeable detection engines: +PhotoPrism now uses a single detector: -- **Pigo** — CPU-only cascade classifier, retains historical behaviour. -- **ONNX SCRFD 0.5g** — ONNX Runtime-backed CNN that delivers higher recall on occluded or off-axis faces. The ONNX engine consumes 720 px thumbnails (model input 640 px), schedules work on the meta/vision workers, and defaults to half the available CPUs (minimum 1 thread). The engine is enabled automatically when `FACE_ENGINE=auto` and the bundled [SCRFD model](https://yakhyo.github.io/facial-analysis/) is present (the prebuilt runtime targets glibc ≥ 2.27 on x86_64/arm64). Operators can switch at runtime via `photoprism --face-engine=<auto|pigo|onnx>` or `photoprism faces reset --engine=<auto|pigo|onnx>` for a full re-index. +- **ONNX SCRFD 0.5g** — ONNX Runtime-backed CNN that delivers higher recall on occluded or off-axis faces. The detector consumes 720 px thumbnails (model input 640 px), schedules work on the meta/vision workers, and defaults to half the available CPUs (minimum 1 thread). Operators can select `FACE_ENGINE=onnx` explicitly or leave `FACE_ENGINE=auto`, which resolves to ONNX when the bundled [SCRFD model](https://yakhyo.github.io/facial-analysis/) is present and otherwise disables detection rather than picking another engine. -Runtime selection lives in `Config.FaceEngine()`; `auto` resolves to ONNX when the SCRFD assets are available, otherwise Pigo. Scheduling is controlled by the face model entry in `vision.yml`: `Config.FaceEngineRunType()` simply forwards to `vision.Config.RunType(ModelTypeFace)` and returns `never` if no detector is configured. This keeps face detection aligned with embedding generation so both always run together. - -#### Angle Sweep - -- The detector now evaluates the Pigo cascade at **-0.3, 0, and +0.3 radians**. These angles are exposed via the new `FACE_ANGLE` option. -- Configuration entry points: - - CLI flag: `--face-angle=<rad>` (repeatable). - - Environment variable: `FACE_ANGLE` (comma-separated list). - - Options API: `Config.FaceAngles()`. -- At start-up the detector receives a copy of `face.DetectionAngles`, so runtime overrides do not mutate the global defaults. +Runtime selection lives in `Config.FaceEngine()`. Scheduling is controlled by the face model entry in `vision.yml`: `Config.FaceEngineRunType()` simply forwards to `vision.Config.RunType(ModelTypeFace)` and returns `never` when no detector is configured. This keeps face detection aligned with embedding generation so both always run together. #### Quality & Overlap Thresholds @@ -39,11 +28,6 @@ Runtime selection lives in `Config.FaceEngine()`; `auto` resolves to ONNX when t - +12 for scales <26, +8 for <32, +6 for <40, +4 for <50, +2 for <80, +1 for <110. - The face overlap floor remains **42 %** to preserve legacy marker behaviour (`OverlapThresholdFloor = 41`). Tests rely on that value (e.g., `Markers.Contains/SameFace`). -#### Landmark Handling - -- Landmarks are only evaluated when both eyes are successfully detected for a given face. Eye candidates and cascades respect the configurable perturbation budget. -- The primary detection angles (`FACE_ANGLE`) do **not** affect landmark estimation, which continues to run at 0° to match the cascade assumptions. - ### Embedding Handling #### Memory Management @@ -62,7 +46,7 @@ All embeddings, regardless of origin, are normalized to unit length (‖x‖₂ - `Faces.Match` pre-filters matchable clusters, keeps an in-memory veto list for freshly cleared markers, and caches embeddings to avoid redundant distance checks; `BenchmarkSelectBestFace` (1024 faces) now reports a bucket size of ~16 candidates out of 1024 (≈98 % fewer distance evaluations) at ≈0.55 ms/op with zero allocations. - Face clusters update their sample statistics (`Samples`, `ClusterRadius`) from the latest matches via `Face.UpdateMatchStats`, avoiding stale radii during optimize loops. The radius is capped at **0.42** so automatic matches accept new embeddings up to `ClusterRadius + MatchDist` (≈0.88) away from the centroid. - Child and background embeddings remain opt-in for automated matching. Set `PHOTOPRISM_FACE_MATCH_CHILDREN=true` (or the `FaceMatchChildren` option) to include children, and `PHOTOPRISM_FACE_MATCH_BACKGROUND=true` to include background samples; both default to `false` so operators explicitly choose when these categories participate. -- Cluster materialisation now pre-sizes buffers; `BenchmarkClusterMaterialize` reports ~14.8 µs/op with 64 allocations (≈56 KB) versus the legacy ~29.8 µs/op with 384 allocations (≈105 KB). +- Cluster materialisation pre-sizes buffers; `BenchmarkClusterMaterialize` reports ~14.8 µs/op with 64 allocations (≈56 KB). This guarantees that Euclidean distance comparisons are equivalent to cosine comparisons, aligning our thresholds with [FaceNet](https://maucher.pages.mi.hdm-stuttgart.de/orbook/face/faceRecognition.html) literature. @@ -85,15 +69,15 @@ faces: retained manual clusters after merge: kept 4 candidate cluster(s) [...] f This is informational—the optimiser skips that merge and progresses. To reduce noise, consider: -- Running `photoprism faces reset --engine=<pigo|onnx>` to regenerate markers with consistent embeddings. +- Running `photoprism faces reset --engine=<auto|onnx>` to regenerate markers with consistent embeddings. - Reviewing the subject’s manual clusters in the UI and trimming outliers or reassigning photos to other people. - Confirming that the remaining clusters genuinely represent different appearances (lighting, age); in that case it is safe to ignore the warning. No automatic data cleanup runs in this scenario, so operators remain in control of manual edits. -Additional safeguards were introduced in October 2025 so stubborn clusters are only retried a limited number of times: +Additional safeguards limit how often stubborn clusters are retried: -- Every manual cluster now stores a retry counter (`faces.merge_retry`) and optional note (`merge_notes`). The optimiser skips clusters once the retry count reaches `MergeMaxRetry` (default **1**). The limit may be raised or disabled with the environment variable `PHOTOPRISM_FACE_MERGE_MAX_RETRY` (`0` = unlimited retries). +- Every manual cluster stores a retry counter (`faces.merge_retry`) and optional note (`merge_notes`). The optimiser skips clusters once the retry count reaches `MergeMaxRetry` (default **1**). The limit may be raised or disabled with the environment variable `PHOTOPRISM_FACE_MERGE_MAX_RETRY` (`0` = unlimited retries). - Warnings surface only when the retry counter is incremented. Subsequent optimise runs log at debug level until counters are reset. - `photoprism faces optimize --retry` clears retry counters before running the optimiser, allowing administrators to reprocess clusters after manual cleanup. - `photoprism faces audit --subject=<uid>` focuses the audit report on a specific person and prints retry counts, sample statistics, and outstanding clusters so operators know which photos still need attention. @@ -133,13 +117,12 @@ Recovery steps: ### Configuration Summary -| Setting | Default | Description | -|:----------------------|:-----------------------------|:------------------------------------------------------------------------------------------------| -| `FACE_ENGINE` | `auto` | Detection engine (`auto`, `pigo`, `onnx`). `auto` resolves to ONNX when the SCRFD model exists. | -| `FACE_ENGINE_THREADS` | `runtime.NumCPU()/2` (≥1) | ONNX inference threads; ignored by Pigo. | -| `FACE_ANGLE` | `-0.3,0,0.3` | Detection angles (radians) swept by Pigo. | -| `FACE_SCORE` | `9.0` (with dynamic offsets) | Base quality threshold before scale adjustments. | -| `FACE_OVERLAP` | `42` | Maximum allowed IoU when deduplicating markers. | +| Setting | Default | Description | +|:----------------------|:-----------------------------|:----------------------------------------------------------------------------------------| +| `FACE_ENGINE` | `auto` | Detection engine (`auto`, `onnx`). `auto` resolves to ONNX when the SCRFD model exists. | +| `FACE_ENGINE_THREADS` | `runtime.NumCPU()/2` (≥1) | ONNX inference threads. | +| `FACE_SCORE` | `9.0` (with dynamic offsets) | Base quality threshold before scale adjustments. | +| `FACE_OVERLAP` | `42` | Maximum allowed IoU when deduplicating markers. | Run scheduling is configured through the face model entry in `vision.yml`. Adjust the model’s `Run` value (for example `on-schedule`, `manual`, or `never`) to control when detection and embedding jobs execute—no separate `FACE_ENGINE_RUN` flag is required. When the model is left on the default `auto` run mode, face detection participates in manual, auto, and on-demand workflows but skips scheduled cron runs so background jobs do not trigger unexpectedly; the same applies to an explicit `on-demand` run mode, which now skips cron executions by default. Set `Run` to `on-schedule` explicitly if you want faces processed during scheduled vision passes. diff --git a/internal/ai/face/background.go b/internal/ai/face/background.go index 87cb19b02..f5100e385 100644 --- a/internal/ai/face/background.go +++ b/internal/ai/face/background.go @@ -9,20 +9,10 @@ func (m Embedding) IsBackground() bool { return Background.Contains(m) } -// Background contains out-of-distribution (OOD) embeddings -// of inputs that are not faces, such as plants, the sky, etc. -// -// NOTE: Checking an embedding against this list requires ~3–4 µs when it -// fails to match (BenchmarkIsBackgroundMiss, temporary bench) because every -// call scans all 24 clusters. We currently invoke IsBackground from: -// - Embedding.CanMatch() -> NewEmbeddings() at ingest time -// - Embeddings.Kind() / Embedding.SkipMatching() via entity.Face.SetEmbeddings() -// - buildFaceIndex() in internal/photoprism/faces_match.go -// -// Enabling IgnoreBackground therefore shortens index rebuilds roughly 5×, -// but also removes the legacy guard that filtered Pigo false positives. When -// we add detector provenance (TODO: record entity.SrcONNX on SCRFD detections), -// we can conditionally skip this scan for ONNX-derived embeddings only. +// Background contains out-of-distribution (OOD) embeddings of inputs that are +// not faces, such as plants, the sky, etc. Each IsBackground check scans all +// 24 clusters (~3–4 µs on a miss), so IgnoreBackground roughly 5× shortens +// face-index rebuilds at the cost of the Pigo false-positive guard. var Background = Clusters{ { Radius: ClusterRadius, diff --git a/internal/ai/face/cascade/facefinder b/internal/ai/face/cascade/facefinder deleted file mode 100644 index 340d0f5ae..000000000 Binary files a/internal/ai/face/cascade/facefinder and /dev/null differ diff --git a/internal/ai/face/cascade/lps/lp312 b/internal/ai/face/cascade/lps/lp312 deleted file mode 100644 index af33fa79b..000000000 Binary files a/internal/ai/face/cascade/lps/lp312 and /dev/null differ diff --git a/internal/ai/face/cascade/lps/lp38 b/internal/ai/face/cascade/lps/lp38 deleted file mode 100644 index ac843d33c..000000000 Binary files a/internal/ai/face/cascade/lps/lp38 and /dev/null differ diff --git a/internal/ai/face/cascade/lps/lp42 b/internal/ai/face/cascade/lps/lp42 deleted file mode 100644 index 25aef5880..000000000 Binary files a/internal/ai/face/cascade/lps/lp42 and /dev/null differ diff --git a/internal/ai/face/cascade/lps/lp44 b/internal/ai/face/cascade/lps/lp44 deleted file mode 100644 index 281e441e3..000000000 Binary files a/internal/ai/face/cascade/lps/lp44 and /dev/null differ diff --git a/internal/ai/face/cascade/lps/lp46 b/internal/ai/face/cascade/lps/lp46 deleted file mode 100644 index 4d0ae7d14..000000000 Binary files a/internal/ai/face/cascade/lps/lp46 and /dev/null differ diff --git a/internal/ai/face/cascade/lps/lp81 b/internal/ai/face/cascade/lps/lp81 deleted file mode 100644 index f6acf1a5e..000000000 Binary files a/internal/ai/face/cascade/lps/lp81 and /dev/null differ diff --git a/internal/ai/face/cascade/lps/lp82 b/internal/ai/face/cascade/lps/lp82 deleted file mode 100644 index 5210cf789..000000000 Binary files a/internal/ai/face/cascade/lps/lp82 and /dev/null differ diff --git a/internal/ai/face/cascade/lps/lp84 b/internal/ai/face/cascade/lps/lp84 deleted file mode 100644 index b22eb3bd9..000000000 Binary files a/internal/ai/face/cascade/lps/lp84 and /dev/null differ diff --git a/internal/ai/face/cascade/lps/lp93 b/internal/ai/face/cascade/lps/lp93 deleted file mode 100644 index b131380ff..000000000 Binary files a/internal/ai/face/cascade/lps/lp93 and /dev/null differ diff --git a/internal/ai/face/cascade/puploc b/internal/ai/face/cascade/puploc deleted file mode 100644 index 0447dcf93..000000000 Binary files a/internal/ai/face/cascade/puploc and /dev/null differ diff --git a/internal/ai/face/config.go b/internal/ai/face/config.go index cd418c822..144917002 100644 --- a/internal/ai/face/config.go +++ b/internal/ai/face/config.go @@ -41,37 +41,3 @@ var ( // IgnoreBackground determines whether background faces are ignored when generating matches. IgnoreBackground = true ) - -var ( - // LandmarkQualityFloor is the minimum score accepted when both eyes are located by the landmark detector. - LandmarkQualityFloor = float32(5.0) - // LandmarkQualityScaleMin is the minimum face size eligible for the landmark-assisted quality fallback. - LandmarkQualityScaleMin = 60 - // LandmarkQualityScaleMax is the maximum face size eligible for the landmark-assisted quality fallback. - LandmarkQualityScaleMax = 90 - // LandmarkQualitySlack is the maximum allowed difference between the quality threshold and the detected score. - LandmarkQualitySlack = float32(4.0) -) - -// PigoQualityThreshold returns the scale-adjusted minimum Pigo quality score threshold for the provided detection scale. -func PigoQualityThreshold(scale int) (score float32) { - score = float32(ScoreThreshold) - - // Smaller faces require higher quality. - switch { - case scale < 26: - score += 12.0 - case scale < 32: - score += 8.0 - case scale < 40: - score += 6.0 - case scale < 50: - score += 4.0 - case scale < 80: - score += 2.0 - case scale < 110: - score += 1.0 - } - - return score -} diff --git a/internal/ai/face/config_test.go b/internal/ai/face/config_test.go deleted file mode 100644 index f932bf776..000000000 --- a/internal/ai/face/config_test.go +++ /dev/null @@ -1,31 +0,0 @@ -package face - -import ( - "testing" - - "github.com/stretchr/testify/assert" -) - -func TestPigoQualityThreshold(t *testing.T) { - t.Run("XXS", func(t *testing.T) { - assert.Equal(t, float32(21), PigoQualityThreshold(21)) - }) - t.Run("XS", func(t *testing.T) { - assert.Equal(t, float32(17), PigoQualityThreshold(27)) - }) - t.Run("S", func(t *testing.T) { - assert.Equal(t, float32(15), PigoQualityThreshold(33)) - }) - t.Run("M", func(t *testing.T) { - assert.Equal(t, float32(13), PigoQualityThreshold(45)) - }) - t.Run("L", func(t *testing.T) { - assert.Equal(t, float32(11), PigoQualityThreshold(75)) - }) - t.Run("XL", func(t *testing.T) { - assert.Equal(t, float32(10), PigoQualityThreshold(100)) - }) - t.Run("XXL", func(t *testing.T) { - assert.Equal(t, float32(9), PigoQualityThreshold(250)) - }) -} diff --git a/internal/ai/face/detector.go b/internal/ai/face/detector.go deleted file mode 100644 index c34545bbe..000000000 --- a/internal/ai/face/detector.go +++ /dev/null @@ -1,391 +0,0 @@ -package face - -import ( - _ "embed" - "fmt" - _ "image/jpeg" // register JPEG decoder for pigo image decoding - "os" - "path/filepath" - "runtime/debug" - "sort" - - pigo "github.com/esimov/pigo/core" - - "github.com/photoprism/photoprism/pkg/clean" - "github.com/photoprism/photoprism/pkg/fs" -) - -//go:embed cascade/facefinder -var cascadeFile []byte - -//go:embed cascade/puploc -var puplocFile []byte - -var ( - classifier *pigo.Pigo - plc *pigo.PuplocCascade - flpcs map[string][]*FlpCascade -) - -// DefaultAngles contains the canonical detection angles in radians. -var DefaultAngles = []float64{-0.3, 0, 0.3} - -// DetectionAngles holds the active detection angles configured at runtime. -var DetectionAngles = append([]float64(nil), DefaultAngles...) - -func init() { - var err error - - p := pigo.NewPigo() - // Unpack the binary file. This will return the number of cascade trees, - // the tree depth, the threshold and the prediction from tree's leaf nodes. - classifier, err = p.Unpack(cascadeFile) - - if err != nil { - log.Errorf("faces: %s", err) - } - - pl := pigo.NewPuplocCascade() - plc, err = pl.UnpackCascade(puplocFile) - - if err != nil { - log.Errorf("faces: %s", err) - } - - flpcs, err = ReadCascadeDir(pl, "cascade/lps") - - if err != nil { - log.Errorf("faces: %s", err) - } -} - -var ( - eyeCascades = []string{"lp46", "lp44", "lp42", "lp38", "lp312"} - mouthCascades = []string{"lp93", "lp84", "lp82", "lp81"} -) - -// pigoEngine implements DetectionEngine using the bundled Pigo cascades. -type pigoEngine struct{} - -// newPigoEngine constructs a Pigo-backed DetectionEngine instance. -func newPigoEngine() *pigoEngine { - return &pigoEngine{} -} - -func (p *pigoEngine) Name() string { - return EnginePigo -} - -// Close releases resources held by the Pigo engine (none at the moment). -func (p *pigoEngine) Close() error { - return nil -} - -// pigoDetector contains Pigo face detector general settings. -type pigoDetector struct { - minSize int - shiftFactor float64 - scaleFactor float64 - iouThreshold float64 - perturb int - landmarkAngle float64 - angles []float64 -} - -// Detect runs the detection algorithm over the provided source image. -func (p *pigoEngine) Detect(fileName string, findLandmarks bool, minSize int) (faces Faces, err error) { - defer func() { - if r := recover(); r != nil { - log.Errorf("faces: %s (panic)\nstack: %s", r, debug.Stack()) - } - }() - - if minSize < 20 { - minSize = 20 - } - - angles := append([]float64(nil), DetectionAngles...) - - d := &pigoDetector{ - minSize: minSize, - shiftFactor: 0.1, - scaleFactor: 1.1, - iouThreshold: float64(OverlapThresholdFloor) / 100, - perturb: 63, - landmarkAngle: 0.0, - angles: angles, - } - - if !fs.FileExists(fileName) { - return faces, fmt.Errorf("faces: file '%s' not found", clean.Log(filepath.Base(fileName))) - } - - det, params, err := d.Detect(fileName) - - if err != nil { - return faces, fmt.Errorf("faces: %s (detect faces)", err) - } - - if len(det) == 0 { - return faces, nil - } - - faces, err = d.Faces(det, params, findLandmarks) - - if err != nil { - return faces, fmt.Errorf("faces: %s", err) - } - - return faces, nil -} - -// Detect runs the detection algorithm over the provided source image. -func (d *pigoDetector) Detect(fileName string) (faces []pigo.Detection, params pigo.CascadeParams, err error) { - if len(d.angles) == 0 { - // Fallback to defaults when the detector is constructed manually (e.g. tests). - d.angles = append([]float64(nil), DetectionAngles...) - } - - file, err := os.Open(fileName) //nolint:gosec // fileName comes from caller; reading local images is expected - - if err != nil { - return faces, params, err - } - - defer func() { - if cerr := file.Close(); err == nil && cerr != nil { - err = cerr - } - }() - - src, err := pigo.DecodeImage(file) - - if err != nil { - return faces, params, err - } - - pixels := pigo.RgbToGrayscale(src) - cols, rows := src.Bounds().Max.X, src.Bounds().Max.Y - - var maxSize int - - switch { - case cols < 20 || rows < 20 || cols < d.minSize || rows < d.minSize: - return faces, params, fmt.Errorf("image size %dx%d is too small", cols, rows) - case cols < rows: - maxSize = cols - 4 - default: - maxSize = rows - 4 - } - - imageParams := pigo.ImageParams{ - Pixels: pixels, - Rows: rows, - Cols: cols, - Dim: cols, - } - - params = pigo.CascadeParams{ - MinSize: d.minSize, - MaxSize: maxSize, - ShiftFactor: d.shiftFactor, - ScaleFactor: d.scaleFactor, - ImageParams: imageParams, - } - - log.Tracef("faces: image size %dx%d, face size min %d, max %d", cols, rows, params.MinSize, params.MaxSize) - - // Run the classifier over the obtained leaf nodes for each configured angle and merge the results. - var detections []pigo.Detection - for _, angle := range d.angles { - result := classifier.RunCascade(params, angle) - if len(result) == 0 { - continue - } - - detections = append(detections, result...) - } - - if len(detections) == 0 { - return detections, params, nil - } - - // Calculate the intersection over union (IoU) of two clusters. - faces = classifier.ClusterDetections(detections, d.iouThreshold) - - return faces, params, nil -} - -// Faces adds landmark coordinates to detected faces and returns the results. -func (d *pigoDetector) Faces(det []pigo.Detection, params pigo.CascadeParams, findLandmarks bool) (results Faces, err error) { - // Sort results by size. - sort.Slice(det, func(i, j int) bool { - return det[i].Scale > det[j].Scale - }) - - results = make(Faces, 0, len(det)) - - for _, face := range det { - score := face.Q - scale := face.Scale - requiredScore := PigoQualityThreshold(scale) - scaleMin := LandmarkQualityScaleMin - scaleMax := LandmarkQualityScaleMax - fallbackCandidate := false - if !findLandmarks && score < requiredScore && score >= LandmarkQualityFloor && scale >= scaleMin && scale <= scaleMax && requiredScore-score <= LandmarkQualitySlack { - fallbackCandidate = true - } - - faceCoord := NewArea( - "face", - face.Row, - face.Col, - scale, - ) - - var eyesCoords []Area - var landmarkCoords []Area - var eyesFound bool - - needLandmarks := (findLandmarks || fallbackCandidate) && scale > 50 - - if needLandmarks { - if findLandmarks { - eyesCoords = make([]Area, 0, 2) - } - - scaleF := float32(scale) - leftCandidate := pigo.Puploc{ - Row: face.Row - int(0.075*scaleF), - Col: face.Col - int(0.175*scaleF), - Scale: scaleF * 0.25, - Perturbs: d.perturb, - } - - leftEye := plc.RunDetector(leftCandidate, params.ImageParams, d.landmarkAngle, false) - leftEyeFound := leftEye.Row > 0 && leftEye.Col > 0 - if leftEyeFound && findLandmarks { - eyesCoords = append(eyesCoords, NewArea( - "eye_l", - leftEye.Row, - leftEye.Col, - int(leftEye.Scale), - )) - } - - rightCandidate := pigo.Puploc{ - Row: face.Row - int(0.075*scaleF), - Col: face.Col + int(0.185*scaleF), - Scale: scaleF * 0.25, - Perturbs: d.perturb, - } - - rightEye := plc.RunDetector(rightCandidate, params.ImageParams, d.landmarkAngle, false) - rightEyeFound := rightEye.Row > 0 && rightEye.Col > 0 - if rightEyeFound && findLandmarks { - eyesCoords = append(eyesCoords, NewArea( - "eye_r", - rightEye.Row, - rightEye.Col, - int(rightEye.Scale), - )) - } - - if leftEyeFound && rightEyeFound { - eyesFound = true - - if findLandmarks { - landmarkCapacity := len(eyeCascades)*2 + len(mouthCascades) + 1 - landmarkCoords = make([]Area, 0, landmarkCapacity) - - for _, eye := range eyeCascades { - for _, flpc := range flpcs[eye] { - if flpc == nil { - continue - } - - flp := flpc.GetLandmarkPoint(leftEye, rightEye, params.ImageParams, d.perturb, false) - if flp.Row > 0 && flp.Col > 0 { - landmarkCoords = append(landmarkCoords, NewArea( - eye, - flp.Row, - flp.Col, - int(flp.Scale), - )) - } - - flp = flpc.GetLandmarkPoint(leftEye, rightEye, params.ImageParams, d.perturb, true) - if flp.Row > 0 && flp.Col > 0 { - landmarkCoords = append(landmarkCoords, NewArea( - eye+"_v", - flp.Row, - flp.Col, - int(flp.Scale), - )) - } - } - } - - for _, mouth := range mouthCascades { - for _, flpc := range flpcs[mouth] { - if flpc == nil { - continue - } - - flp := flpc.GetLandmarkPoint(leftEye, rightEye, params.ImageParams, d.perturb, false) - if flp.Row > 0 && flp.Col > 0 { - landmarkCoords = append(landmarkCoords, NewArea( - "mouth_"+mouth, - flp.Row, - flp.Col, - int(flp.Scale), - )) - } - } - } - - if cascades := flpcs["lp84"]; len(cascades) > 0 { - if flpc := cascades[0]; flpc != nil { - flp := flpc.GetLandmarkPoint(leftEye, rightEye, params.ImageParams, d.perturb, true) - if flp.Row > 0 && flp.Col > 0 { - landmarkCoords = append(landmarkCoords, NewArea( - "lp84", - flp.Row, - flp.Col, - int(flp.Scale), - )) - } - } - } - } - } - } - - if eyesFound && fallbackCandidate && requiredScore > LandmarkQualityFloor { - requiredScore = LandmarkQualityFloor - } - - if score < requiredScore { - continue - } - - // Create face. - f := Face{ - Rows: params.Rows, - Cols: params.Cols, - Score: int(face.Q), - Area: faceCoord, - Eyes: eyesCoords, - Landmarks: landmarkCoords, - } - - // Does the face significantly overlap with previous results? - if results.Contains(f) { - continue - } - - results.Append(f) - } - - return results, nil -} diff --git a/internal/ai/face/detector_test.go b/internal/ai/face/detector_test.go deleted file mode 100644 index bb5eab695..000000000 --- a/internal/ai/face/detector_test.go +++ /dev/null @@ -1,212 +0,0 @@ -package face - -import ( - "fmt" - "os" - "path/filepath" - "testing" - - "github.com/dustin/go-humanize/english" - pigo "github.com/esimov/pigo/core" - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" - - "github.com/photoprism/photoprism/pkg/fs/fastwalk" -) - -var benchmarkFacesCount int - -func TestDetect(t *testing.T) { - expected := map[string]int{ - "1.jpg": 1, - "2.jpg": 1, - "3.jpg": 1, - "4.jpg": 1, - "5.jpg": 1, - "6.jpg": 1, - "7.jpg": 0, - "8.jpg": 0, - "9.jpg": 0, - "10.jpg": 0, - "11.jpg": 0, - "12.jpg": 1, - "13.jpg": 0, - "14.jpg": 0, - "15.jpg": 0, - "16.jpg": 1, - "17.jpg": 2, - "18.jpg": 2, - "19.jpg": 1, - } - - if err := fastwalk.Walk("testdata", func(fileName string, info os.FileMode) error { - if info.IsDir() || filepath.Base(filepath.Dir(fileName)) != "testdata" { - return nil - } - - t.Run(fileName, func(t *testing.T) { - baseName := filepath.Base(fileName) - - faces, err := Detect(fileName, true, 20) - - if err != nil { - t.Fatal(err) - } - - t.Logf("found %s in '%s'", english.Plural(len(faces), "face", "faces"), baseName) - - if len(faces) > 0 { - // t.Logf("results: %#v", faces) - - for i, f := range faces { - t.Logf("marker[%d]: %#v %#v", i, f.CropArea(), f.Area) - t.Logf("landmarks[%d]: %s", i, f.RelativeLandmarksJSON()) - } - } - - if i, ok := expected[baseName]; ok { - assert.Equal(t, i, faces.Count()) - - if faces.Count() == 0 { - assert.Equal(t, 100, faces.Uncertainty()) - } else { - assert.Truef(t, faces.Uncertainty() >= 0 && faces.Uncertainty() <= 50, "uncertainty should be between 0 and 50") - } - t.Logf("uncertainty: %d", faces.Uncertainty()) - } else { - t.Logf("unknown test result for %s", baseName) - } - }) - - return nil - }); err != nil { - t.Fatal(err) - } -} - -func TestDetectOverlap(t *testing.T) { - expected := map[string]int{ - "1.jpg": 2, - "2.jpg": 2, - "3.jpg": 2, - "4.jpg": 1, - } - - if err := fastwalk.Walk("testdata/overlap", func(fileName string, info os.FileMode) error { - if info.IsDir() || filepath.Base(filepath.Dir(fileName)) != "overlap" { - return nil - } - - t.Run(fileName, func(t *testing.T) { - baseName := filepath.Base(fileName) - - faces, err := Detect(fileName, true, 20) - - if err != nil { - t.Fatal(err) - } - - t.Logf("found %s in '%s'", english.Plural(len(faces), "face", "faces"), baseName) - - if len(faces) > 0 { - // t.Logf("results: %#v", faces) - - for i, f := range faces { - t.Logf("marker[%d]: %#v %#v", i, f.CropArea(), f.Area) - t.Logf("landmarks[%d]: %s", i, f.RelativeLandmarksJSON()) - } - } - - if i, ok := expected[baseName]; ok { - assert.Equal(t, i, faces.Count()) - - if faces.Count() == 0 { - assert.Equal(t, 100, faces.Uncertainty()) - } else { - assert.Truef(t, faces.Uncertainty() >= 0 && faces.Uncertainty() <= 50, "uncertainty should be between 0 and 50") - } - t.Logf("uncertainty: %d", faces.Uncertainty()) - } else { - t.Logf("unknown test result for %s", baseName) - } - }) - - return nil - }); err != nil { - t.Fatal(err) - } -} - -func TestDetectLandmarkCounts(t *testing.T) { - faces, err := Detect("testdata/18.jpg", true, 20) - require.NoError(t, err) - require.Equal(t, 2, faces.Count()) - - expectedEyes := []int{2, 0} - expectedLandmarks := []int{15, 0} - - for i, face := range faces { - t.Run(fmt.Sprintf("face-%d", i), func(t *testing.T) { - t.Logf("eyes=%d landmarks=%d", len(face.Eyes), len(face.Landmarks)) - require.Equal(t, expectedEyes[i], len(face.Eyes)) - require.Equal(t, expectedLandmarks[i], len(face.Landmarks)) - }) - } -} - -func TestDetectQualityFallback(t *testing.T) { - t.SkipNow() - faces, err := Detect("testdata/<no public test image available>.jpg", false, 20) - require.NoError(t, err) - require.NotEmpty(t, faces) - - found := false - - for _, face := range faces { - if face.Score < int(PigoQualityThreshold(face.Area.Scale)) { - found = true - break - } - } - - require.Truef(t, found, "expected at least one face below the quality threshold, got %+v", faces) -} - -func BenchmarkDetectorFacesLandmarks(b *testing.B) { - const sample = "testdata/18.jpg" - - d := &pigoDetector{ - minSize: 20, - shiftFactor: 0.1, - scaleFactor: 1.1, - iouThreshold: float64(OverlapThresholdFloor) / 100, - perturb: 63, - landmarkAngle: 0.0, - angles: append([]float64(nil), DetectionAngles...), - } - - det, params, err := d.Detect(sample) - if err != nil { - b.Fatal(err) - } - - if len(det) == 0 { - b.Fatalf("no detections found for %s", sample) - } - - b.ReportAllocs() - b.ResetTimer() - - detections := make([]pigo.Detection, len(det)) - - for b.Loop() { - copy(detections, det) - - faces, err := d.Faces(detections, params, true) - if err != nil { - b.Fatal(err) - } - - benchmarkFacesCount = faces.Count() - } -} diff --git a/internal/ai/face/engine.go b/internal/ai/face/engine.go index 316465ba2..5e9008f8e 100644 --- a/internal/ai/face/engine.go +++ b/internal/ai/face/engine.go @@ -1,7 +1,6 @@ package face import ( - "errors" "fmt" "strings" "sync" @@ -13,8 +12,6 @@ type EngineName = string const ( // EngineAuto selects the default engine based on availability. EngineAuto EngineName = "auto" - // EnginePigo enables the built-in Pigo cascade detector. - EnginePigo EngineName = "pigo" // EngineONNX enables the ONNX runtime-powered SCRFD detector. EngineONNX EngineName = "onnx" // EngineNone disables face detection. @@ -22,11 +19,14 @@ const ( ) // ParseEngine normalizes user input and returns a supported engine name or EngineAuto when unknown. +// Legacy "pigo" values map to EngineONNX so older configs continue to work after detector removal. func ParseEngine(s string) EngineName { s = strings.ToLower(strings.TrimSpace(s)) switch s { - case EnginePigo, EngineONNX, EngineNone: + case "pigo": + return EngineONNX + case EngineONNX, EngineNone: return s default: return EngineAuto @@ -36,7 +36,7 @@ func ParseEngine(s string) EngineName { // DetectionEngine represents a strategy for locating faces in an image. type DetectionEngine interface { Name() EngineName - Detect(fileName string, findLandmarks bool, minSize int) (Faces, error) + Detect(fileName string, minSize int) (Faces, error) Close() error } @@ -51,19 +51,11 @@ var ( activeEngine DetectionEngine ) -func init() { - activeEngine = newPigoEngine() -} - // UseEngine replaces the active detection engine and returns the previous instance. func UseEngine(engine DetectionEngine) (previous DetectionEngine) { engineMu.Lock() prev := activeEngine - if engine == nil { - activeEngine = newPigoEngine() - } else { - activeEngine = engine - } + activeEngine = engine engineMu.Unlock() return prev } @@ -73,7 +65,7 @@ func ConfigureEngine(settings EngineSettings) error { desired := ParseEngine(settings.Name) if desired == EngineAuto { - desired = EnginePigo + desired = EngineONNX } var ( @@ -83,24 +75,16 @@ func ConfigureEngine(settings EngineSettings) error { switch desired { case EngineNone: - return errors.New("no engine selected") + newEngine = nil case EngineONNX: if settings.ONNX.ModelPath == "" { - initErr = fmt.Errorf("ONNX model path is empty") - newEngine = newPigoEngine() + initErr = fmt.Errorf("faces: ONNX model path is empty") break } - if newEngine, initErr = NewONNXEngine(settings.ONNX); initErr != nil { - newEngine = newPigoEngine() - } - case EnginePigo: - fallthrough + newEngine, initErr = NewONNXEngine(settings.ONNX) default: - if desired != EnginePigo { - log.Warnf("faces: unknown detection engine %q, falling back to pigo", desired) - } - newEngine = newPigoEngine() + initErr = fmt.Errorf("faces: unsupported detection engine %q", desired) } prev := UseEngine(newEngine) @@ -130,10 +114,10 @@ func ActiveEngineName() EngineName { } // Detect runs the active engine on the provided file and returns the detected faces. -func Detect(fileName string, findLandmarks bool, minSize int) (Faces, error) { +func Detect(fileName string, minSize int) (Faces, error) { engine := ActiveEngine() if engine == nil { return Faces{}, fmt.Errorf("faces: detection engine not configured") } - return engine.Detect(fileName, findLandmarks, minSize) + return engine.Detect(fileName, minSize) } diff --git a/internal/ai/face/engine_onnx.go b/internal/ai/face/engine_onnx.go index 8c9508ad0..725b0d896 100644 --- a/internal/ai/face/engine_onnx.go +++ b/internal/ai/face/engine_onnx.go @@ -4,6 +4,7 @@ import ( "errors" "fmt" "image" + "image/draw" _ "image/jpeg" // register JPEG decoder for ONNX engine input "math" "os" @@ -13,8 +14,10 @@ import ( "strings" "sync" - "github.com/disintegration/imaging" onnxruntime "github.com/yalue/onnxruntime_go" + xdraw "golang.org/x/image/draw" + + "github.com/photoprism/photoprism/pkg/fs" ) // ONNXOptions configures how the ONNX runtime-backed detector is initialized. @@ -53,7 +56,6 @@ type onnxEngine struct { inputHeight int featStrides []int numAnchors int - useKps bool batched bool scoreThreshold float32 nmsThreshold float32 @@ -222,7 +224,7 @@ func NewONNXEngine(opts ONNXOptions) (DetectionEngine, error) { outputNames[i] = out.Name } - fmc, numAnchors, useKps, batched, err := deriveONNXLayout(outputInfos) + fmc, numAnchors, _, batched, err := deriveONNXLayout(outputInfos) if err != nil { return nil, err } @@ -242,7 +244,6 @@ func NewONNXEngine(opts ONNXOptions) (DetectionEngine, error) { inputHeight: height, featStrides: featStrides, numAnchors: numAnchors, - useKps: useKps, batched: batched, scoreThreshold: opts.ScoreThreshold, nmsThreshold: opts.NMSThreshold, @@ -308,18 +309,8 @@ func (o *onnxEngine) Close() error { } // Detect identifies faces in the provided image using the ONNX runtime session. -func (o *onnxEngine) Detect(fileName string, findLandmarks bool, minSize int) (Faces, error) { - file, err := os.Open(fileName) //nolint:gosec // fileName provided by caller; reading local images is required for detection - if err != nil { - return Faces{}, err - } - defer func() { - if closeErr := file.Close(); closeErr != nil { - log.Debugf("faces: %s (close image file)", closeErr) - } - }() - - img, _, err := image.Decode(file) +func (o *onnxEngine) Detect(fileName string, minSize int) (Faces, error) { + img, _, err := fs.DecodeImageFile(fileName) if err != nil { return Faces{}, err } @@ -400,7 +391,7 @@ func (o *onnxEngine) Detect(fileName string, findLandmarks bool, minSize int) (F return result, nil } -// buildBlob normalises the input image into the tensor layout expected by SCRFD. +// buildBlob normalizes the input image into the tensor layout expected by SCRFD. func (o *onnxEngine) buildBlob(img image.Image) ([]float32, float32, error) { inputWidth := o.inputWidth inputHeight := o.inputHeight @@ -440,7 +431,7 @@ func (o *onnxEngine) buildBlob(img image.Image) ([]float32, float32, error) { newHeight = 1 } - resized := imaging.Resize(img, newWidth, newHeight, imaging.Linear) + resized := resizeLinearImage(img, newWidth, newHeight) planeSize := inputWidth * inputHeight blob := make([]float32, planeSize*3) @@ -467,6 +458,13 @@ func (o *onnxEngine) buildBlob(img image.Image) ([]float32, float32, error) { return blob, detScale, nil } +// resizeLinearImage rescales an image with a lightweight linear filter for ONNX preprocessing. +func resizeLinearImage(img image.Image, width, height int) image.Image { + dst := image.NewNRGBA(image.Rect(0, 0, width, height)) + xdraw.ApproxBiLinear.Scale(dst, dst.Bounds(), img, img.Bounds(), draw.Src, nil) + return dst +} + // parseDetections decodes model outputs into bounding boxes in the original image space. func (o *onnxEngine) parseDetections(values []onnxruntime.Value, detScale float32, origWidth, origHeight int) ([]onnxDetection, error) { fmc := len(o.featStrides) diff --git a/internal/ai/face/engine_onnx_test.go b/internal/ai/face/engine_onnx_test.go index 804fbdffb..025c565ce 100644 --- a/internal/ai/face/engine_onnx_test.go +++ b/internal/ai/face/engine_onnx_test.go @@ -7,8 +7,11 @@ import ( "path/filepath" "testing" + "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" onnxruntime "github.com/yalue/onnxruntime_go" + + "github.com/photoprism/photoprism/pkg/fs" ) // TestONNXSharedLibraryCandidates_Defaults verifies default search ordering when no explicit path is provided. @@ -76,3 +79,16 @@ func TestONNXEngineBuildBlob(t *testing.T) { require.InDelta(t, (0-onnxInputMean)/onnxInputStd, blob[16], 1e-3) require.Equal(t, float32(4), scale) } + +func TestONNXEngineDetect(t *testing.T) { + t.Run("MalformedTiffIfdOffset", func(t *testing.T) { + fileName := filepath.Join(t.TempDir(), "evil.tiff") + require.NoError(t, os.WriteFile(fileName, []byte{0x49, 0x49, 0x2a, 0x00, 0xff, 0xff, 0xff, 0xff}, fs.ModeFile)) + + faces, err := (&onnxEngine{}).Detect(fileName, 20) + + assert.Empty(t, faces) + require.Error(t, err) + assert.Contains(t, err.Error(), "invalid TIFF: IFD offset") + }) +} diff --git a/internal/ai/face/engine_test.go b/internal/ai/face/engine_test.go index 2b0168792..20c99652b 100644 --- a/internal/ai/face/engine_test.go +++ b/internal/ai/face/engine_test.go @@ -10,8 +10,8 @@ func TestParseEngine(t *testing.T) { cases := map[string]EngineName{ "": EngineAuto, "AUTO": EngineAuto, - "pigo": EnginePigo, - " PIGO ": EnginePigo, + "pigo": EngineONNX, + " PIGO ": EngineONNX, "onnx": EngineONNX, "OnNx": EngineONNX, "unknown": EngineAuto, @@ -26,5 +26,5 @@ func TestParseEngine(t *testing.T) { } func TestActiveEngineName(t *testing.T) { - assert.Equal(t, EnginePigo, ActiveEngineName()) + assert.Equal(t, EngineNone, ActiveEngineName()) } diff --git a/internal/ai/face/face.go b/internal/ai/face/face.go index c9001435d..1fb0bce56 100644 --- a/internal/ai/face/face.go +++ b/internal/ai/face/face.go @@ -1,7 +1,7 @@ /* Package face provides face recognition. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/ai/face/landmarks.go b/internal/ai/face/landmarks.go deleted file mode 100644 index 62a200b2a..000000000 --- a/internal/ai/face/landmarks.go +++ /dev/null @@ -1,52 +0,0 @@ -package face - -import ( - "embed" - "errors" - "path/filepath" - - pigo "github.com/esimov/pigo/core" -) - -//go:embed cascade/lps -var efs embed.FS - -// FlpCascade holds the binary representation of the facial landmark points cascade files. -type FlpCascade struct { - *pigo.PuplocCascade - error -} - -// ReadCascadeDir reads the facial landmark points cascade files from the provided directory. -func ReadCascadeDir(plc *pigo.PuplocCascade, path string) (result map[string][]*FlpCascade, err error) { - result = make(map[string][]*FlpCascade) - cascades, err := efs.ReadDir(path) - - if len(cascades) == 0 { - return result, errors.New("the cascade directory is empty") - } - - if err != nil { - return nil, err - } - - for _, cascade := range cascades { - cf := filepath.Join(path, cascade.Name()) - - f, err := efs.ReadFile(cf) - - if err != nil { - return result, err - } - - flpc, err := plc.UnpackCascade(f) - - if err != nil { - return result, err - } - - result[cascade.Name()] = append(result[cascade.Name()], &FlpCascade{flpc, err}) - } - - return result, err -} diff --git a/internal/ai/face/landmarks_test.go b/internal/ai/face/landmarks_test.go deleted file mode 100644 index 512e0e2c5..000000000 --- a/internal/ai/face/landmarks_test.go +++ /dev/null @@ -1,46 +0,0 @@ -package face - -import ( - "testing" - - pigo "github.com/esimov/pigo/core" - - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" -) - -func TestReadCascadeDir(t *testing.T) { - t.Parallel() - - plc := pigo.NewPuplocCascade() - - cascades, err := ReadCascadeDir(plc, "cascade/lps") - require.NoError(t, err) - require.NotNil(t, cascades) - - expected := []string{"lp312", "lp38", "lp42", "lp44", "lp46", "lp81", "lp82", "lp84", "lp93"} - - for _, name := range expected { - entries, ok := cascades[name] - require.Truef(t, ok, "expected cascade %s", name) - require.NotEmptyf(t, entries, "cascade %s should contain entries", name) - - for _, entry := range entries { - require.NotNil(t, entry) - assert.NotNilf(t, entry.PuplocCascade, "expected cascade %s to include unpacked data", name) - assert.Nilf(t, entry.error, "expected cascade %s to unpack without error", name) - } - } -} - -func TestReadCascadeDirMissing(t *testing.T) { - t.Parallel() - - plc := pigo.NewPuplocCascade() - - cascades, err := ReadCascadeDir(plc, "cascade/missing") - require.Error(t, err) - assert.EqualError(t, err, "the cascade directory is empty") - assert.NotNil(t, cascades) - assert.Len(t, cascades, 0) -} diff --git a/internal/ai/face/model.go b/internal/ai/face/model.go index dc355af82..3e01aa157 100644 --- a/internal/ai/face/model.go +++ b/internal/ai/face/model.go @@ -8,10 +8,10 @@ import ( "runtime/debug" "sync" - "github.com/disintegration/imaging" tf "github.com/wamuir/graft/tensorflow" "github.com/photoprism/photoprism/internal/ai/tensorflow" + "github.com/photoprism/photoprism/internal/thumb" "github.com/photoprism/photoprism/internal/thumb/crop" "github.com/photoprism/photoprism/pkg/clean" ) @@ -52,7 +52,7 @@ func NewModel(modelPath, cachePath string, resolution int, meta *tensorflow.Mode // Detect runs the detection and facenet algorithms over the provided source image. func (m *Model) Detect(fileName string, minSize int, cacheCrop bool, expected int) (faces Faces, err error) { - faces, err = Detect(fileName, false, minSize) + faces, err = Detect(fileName, minSize) if err != nil { return faces, err @@ -182,7 +182,7 @@ func imageToTensor(img image.Image, resolution int) (tfTensor *tf.Tensor, err er // Resize the image only if its resolution does not match the model. if img.Bounds().Dx() != resolution || img.Bounds().Dy() != resolution { - img = imaging.Fill(img, resolution, resolution, imaging.Center, imaging.Lanczos) + img = thumb.Resample(img, resolution, resolution, thumb.ResampleFillCenter) } var tfImage [1][][][3]float32 diff --git a/internal/ai/face/model_test.go b/internal/ai/face/model_test.go index 608273ac0..6d5e2a809 100644 --- a/internal/ai/face/model_test.go +++ b/internal/ai/face/model_test.go @@ -6,55 +6,38 @@ import ( "testing" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" "github.com/photoprism/photoprism/pkg/fs/fastwalk" ) var modelPath, _ = filepath.Abs("../../../assets/models/facenet") +var detectorModelPath, _ = filepath.Abs("../../../assets/models/scrfd/" + DefaultONNXModelFilename) func TestNet(t *testing.T) { - expected := map[string]int{ - "1.jpg": 1, - "2.jpg": 1, - "3.jpg": 1, - "4.jpg": 1, - "5.jpg": 1, - "6.jpg": 1, - "7.jpg": 0, - "8.jpg": 0, - "9.jpg": 0, - "10.jpg": 0, - "11.jpg": 0, - "12.jpg": 1, - "13.jpg": 0, - "14.jpg": 0, - "15.jpg": 0, - "16.jpg": 1, - "17.jpg": 2, - "18.jpg": 2, - "19.jpg": 1, - } + prev := UseEngine(nil) + t.Cleanup(func() { + current := UseEngine(prev) + if current != nil { + _ = current.Close() + } + }) - faceIndices := map[string][]int{ - "18.jpg": {1, 0}, - "1.jpg": {2}, - "4.jpg": {3}, - "5.jpg": {4}, - "6.jpg": {5}, - "2.jpg": {6}, - "12.jpg": {7}, - "16.jpg": {8}, - "17.jpg": {9}, - "3.jpg": {10}, + err := ConfigureEngine(EngineSettings{ + Name: EngineONNX, + ONNX: ONNXOptions{ + ModelPath: detectorModelPath, + Threads: 1, + }, + }) + if err != nil { + t.Skipf("faces: skipping detector-dependent test: %s", err) } - - faceIndexToPersonID := [11]int{ - 0, 1, 1, 1, 2, 0, 1, 0, 0, 1, 0, - } - - var embeddings = make(Embeddings, 11) + require.Equal(t, EngineONNX, ActiveEngineName()) faceNet := NewModel(modelPath, "testdata/cache", 160, nil, false) + detectedFiles := 0 + embeddedFaces := 0 if err := fastwalk.Walk("testdata", func(fileName string, info os.FileMode) error { if info.IsDir() || filepath.Base(filepath.Dir(fileName)) != "testdata" { @@ -70,37 +53,18 @@ func TestNet(t *testing.T) { t.Fatal(err) } - // for i, f := range faces { - // t.Logf("FACE %d IN %s: %#v", i, fileName, f.Area) - // } - if len(faces) > 0 { - indices, ok := faceIndices[baseName] - for i, f := range faces { - if !ok || i >= len(indices) { - continue - } - - if len(f.Embeddings) > 0 { - // t.Logf("FACE %d IN %s: %#v", i, fileName, f.Embeddings) - embeddings[indices[i]] = f.Embeddings[0] - } else { - embeddings[indices[i]] = nil - } - } + detectedFiles++ } - if i, ok := expected[baseName]; ok { - assert.Equal(t, i, faces.Count()) - - if faces.Count() == 0 { - assert.Equal(t, 100, faces.Uncertainty()) - } else { - assert.Truef(t, faces.Uncertainty() >= 0 && faces.Uncertainty() <= 50, "uncertainty should be between 0 and 50") + for i, f := range faces { + if len(f.Embeddings) == 0 { + continue } - t.Logf("uncertainty: %d", faces.Uncertainty()) - } else { - t.Logf("unknown test result for %s", baseName) + + embeddedFaces++ + magnitude := f.Embeddings[0].Magnitude() + assert.InDeltaf(t, 1.0, magnitude, 0.02, "embedding %d in %s should stay normalized", i, baseName) } }) @@ -109,33 +73,6 @@ func TestNet(t *testing.T) { t.Fatal(err) } - // Dist Matrix - correct := 0 - - for i := range embeddings { - for j := range embeddings { - if i >= j { - continue - } - - dist := embeddings[i].Dist(embeddings[j]) - - t.Logf("Dist for %d %d (faces are %d %d) is %f", i, j, faceIndexToPersonID[i], faceIndexToPersonID[j], dist) - if faceIndexToPersonID[i] == faceIndexToPersonID[j] { - if dist < 1.21 { - correct++ - } - } else { - if dist >= 1.21 { - correct++ - } - } - } - } - - t.Logf("Correct for %d", correct) - - // there are a few incorrect results - // 3 out of 55 with the 1.21 threshold - assert.Equal(t, 52, correct) + assert.Greater(t, detectedFiles, 0) + assert.Greater(t, embeddedFaces, 0) } diff --git a/internal/ai/nsfw/README.md b/internal/ai/nsfw/README.md index cb35e7cdf..7deb129ba 100644 --- a/internal/ai/nsfw/README.md +++ b/internal/ai/nsfw/README.md @@ -1,17 +1,42 @@ ## PhotoPrism — NSFW Package -**Last Updated:** December 23, 2025 +**Last Updated:** May 21, 2026 ### Overview -`internal/ai/nsfw` runs the built-in TensorFlow NSFW classifier to score images for drawing, hentai, neutral, porn, and sexy content. It is used during indexing and metadata workflows when the NSFW model is enabled. +`internal/ai/nsfw` runs the built-in TensorFlow NSFW classifier to score images for drawing, hentai, neutral, porn, and sexy content. It is the default backend that powers the `Type: nsfw` model entry in [`internal/ai/vision`](../vision/README.md) and is the only NSFW engine that ships with PhotoPrism out of the box; operators can override it through `vision.yml` with an Ollama or OpenAI endpoint when they prefer to run NSFW detection on a remote LLM. + +### Where It Gets Called + +The package itself only exposes the model loader and a thin scoring API (`Result.IsSafe`, `Result.IsNsfw(threshold)`). Two upstream callers wire it into the runtime: + +1. **Upload handler — [`internal/api/users_upload.go`](../../api/users_upload.go).** When `PHOTOPRISM_UPLOAD_NSFW=false` (default `true`), every accepted upload is screened by `vision.DetectNSFW` before indexing. Files that score above the threshold are deleted on the spot — they never reach `originals/`. When `UPLOAD_NSFW=true`, the upload path skips the check entirely. + +2. **Index + vision-worker pipelines — [`internal/photoprism/index_mediafile.go`](../../photoprism/index_mediafile.go), [`internal/workers/vision.go`](../../workers/vision.go), [`internal/workers/meta.go`](../../workers/meta.go).** When `PHOTOPRISM_DETECT_NSFW=true` (default `false`), the indexer marks new photos as `PhotoPrivate = true` if the NSFW model flags them. Both code paths short-circuit when `DetectNSFW()` is false — the model is then neither loaded nor invoked. + +Both flags are independent: you can reject uploads without flagging existing imports, flag existing imports without policing uploads, or both. The user-facing matrix lives at [docs.photoprism.app/user-guide/ai/nsfw/](https://docs.photoprism.app/user-guide/ai/nsfw/). + +### Detection Through the Labels Model + +When `Type: labels` is served by an Ollama or OpenAI engine and **both** `PHOTOPRISM_DETECT_NSFW=true` and `PHOTOPRISM_EXPERIMENTAL=true` are set, [`internal/config/config.go`](../../config/config.go) flips the package-level global `vision.DetectNSFWLabels` to `true`. The Ollama and OpenAI engine builders then swap their default label prompts for `LabelPromptNSFW` and the JSON schema generators add `nsfw` + `nsfw_confidence` fields, so NSFW classification piggybacks on the label-generation call instead of running as a separate inference pass. + +When the shortcut is active, the labels-path check in `index_mediafile.go` (`labels.IsNSFW(threshold)`) can promote a photo to private without this package being touched. The dedicated TensorFlow model in `internal/ai/nsfw` is still used as a fallback whenever the labels path either does not run or does not return NSFW signals, and whenever `vision run --models nsfw` is invoked directly. ### How It Works - **Model Loading** — Loads the NSFW SavedModel from `assets/models/` and resolves input/output ops (inferred if missing). -- **Input Preparation** — JPEG images are decoded and transformed to the configured input resolution. +- **Input Preparation** — JPEG thumbnails (default size `Fit720`, see `MediaFile.DetectNSFW`) are decoded and transformed to the configured input resolution. - **Inference & Output** — Produces five class probabilities mapped into a `Result` struct for downstream thresholds and UI badges. +### Threshold + +`vision.yml` carries a `Thresholds.NSFW` value (default `75`, range `0-100`) that controls how confident the model must be before a picture is flagged. Lower values are more aggressive; higher values more permissive. The threshold applies to both the dedicated NSFW model and the NSFW fields returned via the label-generation shortcut. + +```yaml +Thresholds: + NSFW: 75 +``` + ### Memory & Performance TensorFlow tensors allocate C memory and are freed by Go GC finalizers. To keep RSS bounded during long runs, PhotoPrism periodically triggers garbage collection to return freed tensor memory to the OS. Tune with: @@ -24,8 +49,13 @@ TensorFlow tensors allocate C memory and are freed by Go GC finalizers. To keep - **Model fails to load:** Verify `saved_model.pb` and `variables/` exist under the model path. - **Unexpected scores:** Confirm the input resolution matches the model and that logits are handled correctly. - **High memory usage:** Adjust `PHOTOPRISM_TF_GC_EVERY` or reduce concurrent indexing load. +- **NSFW detection appears to stop working after switching labels to an LLM:** Confirm both `PHOTOPRISM_DETECT_NSFW=true` and `PHOTOPRISM_EXPERIMENTAL=true` are set. Without both, the labels-path shortcut is disabled and only an explicit `vision run --models nsfw` (or another caller that goes through this package directly) will produce NSFW flags. ### Related Docs -- [`internal/ai/vision/README.md`](../vision/README.md) — model registry and run scheduling +- [`internal/ai/vision/README.md`](../vision/README.md) — model registry, run scheduling, and the `DetectNSFWLabels` global +- [`internal/ai/vision/ollama/README.md`](../vision/ollama/README.md) — Ollama engine: `LabelPromptNSFW` swap-in +- [`internal/ai/vision/openai/README.md`](../vision/openai/README.md) — OpenAI engine: NSFW-aware prompt and schema +- [`internal/ai/vision/schema/README.md`](../vision/schema/README.md) — JSON schema variants used when NSFW is enabled - [`internal/ai/tensorflow/README.md`](../tensorflow/README.md) — TensorFlow helpers, GC behavior, and model loading +- [docs.photoprism.app/user-guide/ai/nsfw/](https://docs.photoprism.app/user-guide/ai/nsfw/) — user-facing reference + flag matrix diff --git a/internal/ai/nsfw/nsfw.go b/internal/ai/nsfw/nsfw.go index 7b7d9f3b1..75ffcc4b3 100644 --- a/internal/ai/nsfw/nsfw.go +++ b/internal/ai/nsfw/nsfw.go @@ -1,7 +1,7 @@ /* Package nsfw provides detection of images that are "not safe for work" based on various categories. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/ai/tensorflow/image.go b/internal/ai/tensorflow/image.go index 4fdd17f71..b9b463f87 100644 --- a/internal/ai/tensorflow/image.go +++ b/internal/ai/tensorflow/image.go @@ -1,13 +1,9 @@ package tensorflow import ( - "bytes" "fmt" "image" - _ "image/jpeg" // register JPEG decoder - _ "image/png" // register PNG decoder "math" - "os" "runtime/debug" tf "github.com/wamuir/graft/tensorflow" @@ -32,25 +28,15 @@ func ImageFromFile(fileName string, input *PhotoInput) (*tf.Tensor, error) { } } -// OpenImage opens an image file and decodes it using the registered decoders. +// OpenImage opens a natively supported image file and decodes it with PhotoPrism's direct dispatch helpers. func OpenImage(fileName string) (image.Image, error) { - f, err := os.Open(fileName) //nolint:gosec // fileName supplied by trusted caller; reading local images is expected - if err != nil { - return nil, err - } - defer func() { - if closeErr := f.Close(); closeErr != nil { - log.Debugf("tensorflow: %s (close image file)", closeErr) - } - }() - img, _, err := image.Decode(f) - + img, _, err := fs.DecodeImageFile(fileName) return img, err } // ImageFromBytes converts raw image bytes into a tensor using the provided input definition. func ImageFromBytes(b []byte, input *PhotoInput, builder *ImageTensorBuilder) (*tf.Tensor, error) { - img, _, imgErr := image.Decode(bytes.NewReader(b)) + img, _, imgErr := fs.DecodeImageData(b) if imgErr != nil { return nil, imgErr diff --git a/internal/ai/tensorflow/image_test.go b/internal/ai/tensorflow/image_test.go index 7bc0511ae..6774f51a5 100644 --- a/internal/ai/tensorflow/image_test.go +++ b/internal/ai/tensorflow/image_test.go @@ -1,12 +1,16 @@ package tensorflow import ( + "io" "os" "path/filepath" "testing" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" "github.com/wamuir/graft/tensorflow" + + "github.com/photoprism/photoprism/pkg/fs" ) var defaultImageInput = &PhotoInput{ @@ -15,7 +19,7 @@ var defaultImageInput = &PhotoInput{ Shape: DefaultPhotoInputShape(), } -var examplesPath = filepath.Join(assetsPath, "examples") +var samplesPath = filepath.Join(assetsPath, "samples") func TestConvertValue(t *testing.T) { result := convertValue(uint32(98765432), &Interval{Start: -1, End: 1}) @@ -32,7 +36,7 @@ func TestConvertStdMean(t *testing.T) { func TestImageFromBytes(t *testing.T) { t.Run("CatJpeg", func(t *testing.T) { - imageBuffer, err := os.ReadFile(filepath.Join(examplesPath, "cat_brown.jpg")) //nolint:gosec // reading bundled test fixture + imageBuffer, err := os.ReadFile(filepath.Join(samplesPath, "cat_brown.jpg")) //nolint:gosec // reading bundled test fixture if err != nil { t.Fatal(err) @@ -48,11 +52,42 @@ func TestImageFromBytes(t *testing.T) { assert.Equal(t, int64(224), result.Shape()[2]) }) t.Run("Document", func(t *testing.T) { - imageBuffer, err := os.ReadFile(filepath.Join(examplesPath, "Random.docx")) //nolint:gosec // reading bundled test fixture + imageBuffer, err := os.ReadFile(filepath.Join(samplesPath, "Random.docx")) //nolint:gosec // reading bundled test fixture assert.Nil(t, err) result, err := ImageFromBytes(imageBuffer, defaultImageInput, nil) assert.Empty(t, result) - assert.EqualError(t, err, "image: unknown format") + assert.EqualError(t, err, "unsupported image format") + }) + t.Run("MalformedTiffIfdOffset", func(t *testing.T) { + imageBuffer := []byte{0x49, 0x49, 0x2a, 0x00, 0xff, 0xff, 0xff, 0xff} + + result, err := ImageFromBytes(imageBuffer, defaultImageInput, nil) + + assert.Nil(t, result) + require.Error(t, err) + assert.Contains(t, err.Error(), "invalid TIFF: IFD offset") + }) + t.Run("TruncatedTiffBody", func(t *testing.T) { + imageBuffer := []byte{0x49, 0x49, 0x2a, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00} + + result, err := ImageFromBytes(imageBuffer, defaultImageInput, nil) + + assert.Nil(t, result) + require.Error(t, err) + assert.ErrorIs(t, err, io.EOF) + }) +} + +func TestOpenImage(t *testing.T) { + t.Run("MalformedTiffIfdOffset", func(t *testing.T) { + fileName := filepath.Join(t.TempDir(), "evil.tiff") + require.NoError(t, os.WriteFile(fileName, []byte{0x49, 0x49, 0x2a, 0x00, 0xff, 0xff, 0xff, 0xff}, fs.ModeFile)) + + result, err := OpenImage(fileName) + + assert.Nil(t, result) + require.Error(t, err) + assert.Contains(t, err.Error(), "invalid TIFF: IFD offset") }) } diff --git a/internal/ai/tensorflow/tensorflow.go b/internal/ai/tensorflow/tensorflow.go index 329617c15..b3495c73c 100644 --- a/internal/ai/tensorflow/tensorflow.go +++ b/internal/ai/tensorflow/tensorflow.go @@ -1,7 +1,7 @@ /* Package tensorflow provides TensorFlow utility functions. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/ai/vision/README.md b/internal/ai/vision/README.md index 2cd862f62..1334b2fd2 100644 --- a/internal/ai/vision/README.md +++ b/internal/ai/vision/README.md @@ -1,13 +1,13 @@ ## PhotoPrism — Vision Package -**Last Updated:** March 3, 2026 +**Last Updated:** July 16, 2026 ### Overview `internal/ai/vision` provides the shared model registry, request builders, and parsers that power PhotoPrism’s caption, label, face, NSFW, and future generate workflows. It reads `vision.yml`, normalizes models, and dispatches calls to one of three engines: - **TensorFlow (built‑in)** — default Nasnet / NSFW / Facenet models, no remote service required. Long-running TensorFlow inference can accumulate C-allocated tensor memory until GC finalizers run, so PhotoPrism periodically triggers garbage collection to return that memory to the OS; tune with `PHOTOPRISM_TF_GC_EVERY` (default **200**, `0` disables). Lower values reduce peak RSS but increase GC overhead and can slow indexing, so keep the default unless memory pressure is severe. -- **Ollama** — local or proxied multimodal LLMs. See [`ollama/README.md`](ollama/README.md) for tuning and schema details. The engine defaults to `${OLLAMA_BASE_URL:-http://ollama:11434}/api/generate`, trimming any trailing slash on the base URL; set `OLLAMA_BASE_URL=https://ollama.com` to opt into cloud defaults. +- **Ollama** — local or proxied multimodal LLMs. See [`ollama/README.md`](ollama/README.md) for tuning and schema details. The engine defaults to `${OLLAMA_BASE_URL:-http://ollama:11434}/api/generate`, trimming any trailing slash on the base URL; set `OLLAMA_BASE_URL=https://ollama.com` to opt into cloud defaults. The default model is `gemma4:latest` (self-hosted) or `minimax-m3:cloud` (cloud), and reasoning is disabled by default (`Service.Think: "false"`) so thinking-capable models do not leak reasoning into results. - **OpenAI** — cloud Responses API. See [`openai/README.md`](openai/README.md) for prompts, schema variants, and header requirements. ### Configuration @@ -93,18 +93,19 @@ The model `Options` adjust model parameters such as temperature, top-p, and sche Configures the endpoint URL, method, format, and authentication for [Ollama](ollama/README.md), [OpenAI](openai/README.md), and other engines that perform remote HTTP requests: -| Field | Default | Notes | -|:-----------------------------------|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Uri` | required for remote | Endpoint base. Empty keeps model local (TensorFlow). Ollama alias fills `${OLLAMA_BASE_URL}/api/generate`, defaulting to `http://ollama:11434`. | -| `Method` | `POST` | Override verb if provider needs it. | -| `Key` | `""` | Bearer token; prefer env expansion (OpenAI: `OPENAI_API_KEY`, Ollama: `OLLAMA_API_KEY`). | -| `Username` / `Password` | `""` | Injected as basic auth when URI lacks userinfo. | -| `Model` | `""` | Endpoint-specific override; wins over model/name. | -| `Org` / `Project` | `""` | OpenAI headers (org/proj IDs). | -| `Think` | `""` | Optional reasoning hint passed as `think` in service requests. Supports levels like `low`, `medium`, `high`; string values `true`/`false` are normalized to JSON booleans on output. Omitted when empty. | -| `RequestFormat` / `ResponseFormat` | set by engine alias | Explicit values win over alias defaults. | -| `FileScheme` | set by engine alias (`data` or `base64`) | Controls image transport. | -| `Disabled` | `false` | Disable the endpoint without removing the model. | +| Field | Default | Notes | +|:-----------------------------------|:-----------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `Uri` | required for remote | Endpoint base. Empty keeps model local (TensorFlow). Ollama alias fills `${OLLAMA_BASE_URL}/api/generate`, defaulting to `http://ollama:11434`. | +| `Method` | `POST` | Override verb if provider needs it. | +| `Key` | `""` | Bearer token; prefer env expansion (OpenAI: `OPENAI_API_KEY`, Ollama: `OLLAMA_API_KEY`). | +| `Username` / `Password` | `""` | Injected as basic auth when URI lacks userinfo. | +| `Model` | `""` | Endpoint-specific override; wins over model/name. | +| `Org` / `Project` | `""` | OpenAI headers (org/proj IDs). | +| `Tier` | `""` | OpenAI service tier sent as top-level `service_tier` in the request body (e.g. `flex` for cheaper, slower processing). OpenAI-only; supports `${ENV}` expansion. Omitted when empty (OpenAI default `auto`). | +| `Think` | `""` (Ollama engine: `"false"`) | Optional reasoning hint passed as `think` in service requests. The Ollama engine defaults it to `"false"` (reasoning off); re-enable with `"true"`. Supports levels like `low`, `medium`, `high`; string values `true`/`false` are normalized to JSON booleans on output. Omitted when empty. | +| `RequestFormat` / `ResponseFormat` | set by engine alias | Explicit values win over alias defaults. | +| `FileScheme` | set by engine alias (`data` or `base64`) | Controls image transport. | +| `Disabled` | `false` | Disable the endpoint without removing the model. | > **Authentication:** All credentials and identifiers support `${ENV_VAR}` expansion. `Service.Key` sets `Authorization: Bearer <token>`; `Username`/`Password` injects HTTP basic authentication into the service URI when it is not already present. When `Service.Key` is empty, PhotoPrism defaults to `OPENAI_API_KEY` (OpenAI engine) or `OLLAMA_API_KEY` (Ollama engine), also honoring their `_FILE` counterparts. Key and schema file paths must reference readable regular files (directories are ignored/rejected). @@ -114,7 +115,7 @@ Configures the endpoint URL, method, format, and authentication for [Ollama](oll - Env expansion runs for all `Service` credentials and `Model` overrides; empty or disabled models return empty identifiers. - Options merging: engine defaults fill missing fields; explicit values always win. Temperature is capped at `MaxTemperature`. - Authentication: `Service.Key` sets `Authorization: Bearer <token>`; `Username`/`Password` inject HTTP basic auth into the service URI when not already present. -- Reasoning control: `Service.Think` maps to `ApiRequest.Think` and is serialized only when non-empty (`omitempty`). During JSON encoding, `"true"` / `"false"` are converted to boolean `true` / `false`; other non-empty values are sent as strings. +- Reasoning control: `Service.Think` maps to `ApiRequest.Think` and is serialized only when non-empty (`omitempty`). The Ollama engine defaults it to `"false"` via its engine alias (applied when `Service.Think` is empty), so reasoning is off out of the box; other engines leave it empty. During JSON encoding, `"true"` / `"false"` are converted to boolean `true` / `false`; other non-empty values are sent as strings. ### Minimal Examples @@ -201,6 +202,14 @@ Models: - **Ollama**: private, GPU/CPU-hosted multimodal LLMs; best for richer captions/labels without cloud traffic. - **OpenAI**: highest quality reasoning and multimodal support; requires API key and network access. +### NSFW Detection + +NSFW is wired through the same model registry as labels, captions, and faces — `Type: nsfw` resolves to the built-in TensorFlow classifier by default, and can be overridden in `vision.yml` to point at an Ollama or OpenAI endpoint. + +There is also a fast-path: when `Type: labels` is served by an LLM, PhotoPrism can ask the labels call to include `nsfw` + `nsfw_confidence` in the same response. This is gated by the package-level global `DetectNSFWLabels`, set from `config.go` as `DetectNSFW() && Experimental()` — both `PHOTOPRISM_DETECT_NSFW=true` **and** `PHOTOPRISM_EXPERIMENTAL=true` are required. When either flag is off, the labels prompt stays on `LabelPromptDefault` (no NSFW fields), and `labels.IsNSFW()` cannot trigger. + +The runtime guards in `internal/photoprism/index_mediafile.go` and `internal/workers/vision.go` additionally short-circuit any NSFW promotion on `conf.DetectNSFW()`. The dedicated `Type: nsfw` model is filtered out of scheduled runs by `VisionModelShouldRun` whenever `DetectNSFW()` is false. See [`internal/ai/nsfw/README.md`](../nsfw/README.md) for the full call-graph and the user-facing matrix at [docs.photoprism.app/user-guide/ai/nsfw/](https://docs.photoprism.app/user-guide/ai/nsfw/). + ### Model Unload on Idle PhotoPrism currently keeps TensorFlow models resident for the lifetime of the process to avoid repeated load costs. A future “model unload on idle” mode would track last-use timestamps and close the TensorFlow session/graph after a configurable idle period, releasing the model’s memory footprint back to the OS. The trade-off is higher latency and CPU overhead when a model is used again, plus extra I/O to reload weights. This may be attractive for low-frequency or memory-constrained deployments but would slow continuous indexing jobs, so it is not enabled today. diff --git a/internal/ai/vision/api_client.go b/internal/ai/vision/api_client.go index d015831e7..3bf9f0019 100644 --- a/internal/ai/vision/api_client.go +++ b/internal/ai/vision/api_client.go @@ -65,9 +65,11 @@ func PerformApiRequest(apiRequest *ApiRequest, uri, method, key string) (apiResp _ = clientResp.Body.Close() }() - body, apiErr := io.ReadAll(clientResp.Body) + body, apiErr := io.ReadAll(io.LimitReader(clientResp.Body, MaxResponseBytes+1)) if apiErr != nil { return nil, apiErr + } else if int64(len(body)) > MaxResponseBytes { + return nil, fmt.Errorf("vision: response exceeds the maximum size of %d bytes", MaxResponseBytes) } format := apiRequest.GetResponseFormat() diff --git a/internal/ai/vision/api_client_test.go b/internal/ai/vision/api_client_test.go index f63353cef..462f5fef7 100644 --- a/internal/ai/vision/api_client_test.go +++ b/internal/ai/vision/api_client_test.go @@ -15,7 +15,7 @@ import ( func TestNewApiRequest(t *testing.T) { t.Run("Data", func(t *testing.T) { - thumbnails := Files{examplesPath + "/chameleon_lime.jpg"} + thumbnails := Files{samplesPath + "/chameleon_lime.jpg"} result, err := NewApiRequestImages(thumbnails, scheme.Data) assert.NoError(t, err) @@ -30,7 +30,7 @@ func TestNewApiRequest(t *testing.T) { } }) t.Run("Https", func(t *testing.T) { - thumbnails := Files{examplesPath + "/chameleon_lime.jpg"} + thumbnails := Files{samplesPath + "/chameleon_lime.jpg"} result, err := NewApiRequestImages(thumbnails, scheme.Https) assert.NoError(t, err) @@ -199,3 +199,30 @@ func TestValidateApiRequestURL(t *testing.T) { assert.Error(t, validateApiRequestURL("https:///v1")) }) } + +func TestPerformApiRequestResponseLimit(t *testing.T) { + // Shrink the cap so the test does not allocate the 32 MiB default. + prev := MaxResponseBytes + MaxResponseBytes = 1024 + t.Cleanup(func() { MaxResponseBytes = prev }) + + server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(http.StatusOK) + //nolint:gosec // test fixture writes a locally generated payload only + _, _ = w.Write(make([]byte, int(MaxResponseBytes)+512)) + })) + defer server.Close() + + apiRequest := &ApiRequest{ + Id: "toolarge", + Model: "qwen2.5vl:latest", + Format: FormatJSON, + Images: []string{"data:image/jpeg;base64,AA=="}, + ResponseFormat: ApiFormatOllama, + } + + resp, err := PerformApiRequest(apiRequest, server.URL, http.MethodPost, "") + assert.Error(t, err) + assert.Nil(t, resp) + assert.Contains(t, err.Error(), "exceeds the maximum size") +} diff --git a/internal/ai/vision/api_request.go b/internal/ai/vision/api_request.go index 9c83ebda1..d4fc7046b 100644 --- a/internal/ai/vision/api_request.go +++ b/internal/ai/vision/api_request.go @@ -47,6 +47,7 @@ type ApiRequest struct { Url string `form:"url" yaml:"Url,omitempty" json:"url,omitempty"` Org string `form:"org" yaml:"Org,omitempty" json:"org,omitempty"` Project string `form:"project" yaml:"Project,omitempty" json:"project,omitempty"` + Tier string `form:"tier" yaml:"Tier,omitempty" json:"tier,omitempty"` Think string `form:"think" yaml:"Think,omitempty" json:"think,omitempty"` Options *ModelOptions `form:"options" yaml:"Options,omitempty" json:"options,omitempty"` Context *ApiRequestContext `form:"context" yaml:"Context,omitempty" json:"context,omitempty"` @@ -414,6 +415,10 @@ func (r *ApiRequest) openAIJSON() ([]byte, error) { } } + if tier := strings.TrimSpace(r.Tier); tier != "" { + payload.ServiceTier = tier + } + return json.Marshal(payload) } diff --git a/internal/ai/vision/config.go b/internal/ai/vision/config.go index b77e89808..0a68a8f9f 100644 --- a/internal/ai/vision/config.go +++ b/internal/ai/vision/config.go @@ -30,6 +30,9 @@ var ( ServiceKey = "" // ServiceTimeout sets the maximum duration for service API requests. ServiceTimeout = 10 * time.Minute + // MaxResponseBytes bounds how much of a service response is read so a + // malicious or compromised endpoint cannot exhaust memory. + MaxResponseBytes int64 = 32 * 1024 * 1024 // ServiceMethod defines the HTTP verb used when calling the vision service. ServiceMethod = http.MethodPost // ServiceFileScheme specifies how local files are encoded when sent to the service. diff --git a/internal/ai/vision/config_test.go b/internal/ai/vision/config_test.go index f12ab5951..1878bc570 100644 --- a/internal/ai/vision/config_test.go +++ b/internal/ai/vision/config_test.go @@ -3,10 +3,12 @@ package vision import ( "os" "path/filepath" + "sync" "testing" "github.com/stretchr/testify/assert" + "github.com/photoprism/photoprism/internal/ai/vision/ollama" "github.com/photoprism/photoprism/pkg/fs" ) @@ -15,6 +17,23 @@ func TestOptions(t *testing.T) { var configFile = filepath.Join(configPath, "vision.yml") t.Run("Save", func(t *testing.T) { + // Regenerate the committed fixture deterministically, independent of any ambient + // OLLAMA_* env, so it always reflects the self-hosted defaults (gemma4 + Think: "false"). + origModel := CaptionModel.Model + origService := CaptionModel.Service + t.Cleanup(func() { + CaptionModel.Model = origModel + CaptionModel.Service = origService + ensureEnvOnce = sync.Once{} + registerOllamaEngineDefaults() + }) + t.Setenv(ollama.APIKeyEnv, "") + t.Setenv(ollama.BaseUrlEnv, ollama.DefaultBaseUrl) + ensureEnvOnce = sync.Once{} + CaptionModel.Model = "" + CaptionModel.Service = Service{} + registerOllamaEngineDefaults() + _ = os.Remove(configFile) options := NewConfig() err := options.Save(configFile) diff --git a/internal/ai/vision/engine.go b/internal/ai/vision/engine.go index b2f852bca..77e1fdb06 100644 --- a/internal/ai/vision/engine.go +++ b/internal/ai/vision/engine.go @@ -78,6 +78,7 @@ type EngineInfo struct { DefaultModel string DefaultResolution int DefaultKey string // Optional placeholder key (e.g., ${OPENAI_API_KEY}); applied only when Service.Key is empty. + DefaultThink string // Optional reasoning hint (e.g., "false"); applied only when Service.Think is empty. } // RegisterEngineAlias maps a logical engine name (e.g., "ollama") to a diff --git a/internal/ai/vision/engine_ollama.go b/internal/ai/vision/engine_ollama.go index bc413cbec..34f7b0865 100644 --- a/internal/ai/vision/engine_ollama.go +++ b/internal/ai/vision/engine_ollama.go @@ -2,6 +2,7 @@ package vision import ( "context" + "net/http" "os" "strings" @@ -53,6 +54,7 @@ func registerOllamaEngineDefaults() { DefaultModel: defaultModel, DefaultResolution: ollama.DefaultResolution, DefaultKey: ollama.APIKeyPlaceholder, + DefaultThink: ollama.DefaultThink, }) // Keep the default caption model config aligned with the defaults. @@ -156,6 +158,16 @@ func (ollamaParser) Parse(ctx context.Context, req *ApiRequest, raw []byte, stat return nil, err } + // Surface upstream failures so they are diagnosable instead of silently yielding no labels or caption. + if status >= http.StatusBadRequest { + switch status { + case http.StatusNotFound, http.StatusGone: + log.Warnf("vision: ollama model %s is unavailable (status %d), it may have been retired or renamed", clean.Log(req.Model), status) + default: + log.Warnf("vision: ollama request for model %s failed (status %d)", clean.Log(req.Model), status) + } + } + response := &ApiResponse{ Id: req.GetId(), Code: status, @@ -169,7 +181,7 @@ func (ollamaParser) Parse(ctx context.Context, req *ApiRequest, raw []byte, stat parsedLabels := len(response.Result.Labels) > 0 // Qwen3-VL models stream their JSON payload in the "Thinking" field. - fallbackResponse := strings.TrimSpace(ollamaResp.Response) + fallbackResponse := strings.TrimSpace(stripReasoningBlock(ollamaResp.Response)) fallbackThinking := strings.TrimSpace(ollamaResp.Thinking) fallbackJSON := fallbackResponse @@ -226,6 +238,27 @@ func (ollamaParser) Parse(ctx context.Context, req *ApiRequest, raw []byte, stat return response, nil } +// stripReasoningBlock removes a single leading, well-delimited <think>...</think> block from s and +// returns the trimmed remainder. It is a defensive fallback for thinking-capable models that ignore +// the think=false hint and emit tagged reasoning inline; untagged text and an unterminated opening tag +// are left unchanged so a legitimate caption is never truncated. +func stripReasoningBlock(s string) string { + trimmed := strings.TrimSpace(s) + + const openTag = "<think>" + + if len(trimmed) < len(openTag) || !strings.EqualFold(trimmed[:len(openTag)], openTag) { + return s + } + + end := strings.Index(strings.ToLower(trimmed), "</think>") + if end < 0 { + return s + } + + return strings.TrimSpace(trimmed[end+len("</think>"):]) +} + func convertOllamaLabels(payload []ollama.LabelPayload) []LabelResult { if len(payload) == 0 { return nil diff --git a/internal/ai/vision/engine_ollama_test.go b/internal/ai/vision/engine_ollama_test.go index 6d335ff32..f1633e0a4 100644 --- a/internal/ai/vision/engine_ollama_test.go +++ b/internal/ai/vision/engine_ollama_test.go @@ -3,6 +3,7 @@ package vision import ( "context" "encoding/json" + "net/http" "os" "sync" "testing" @@ -17,6 +18,7 @@ func TestRegisterOllamaEngineDefaults(t *testing.T) { testCaptionModel := CaptionModel.Clone() testCaptionModel.Model = "" testCaptionModel.Service.Uri = "" + testCaptionModel.Service.Think = "" cloudToken := "moo9yaiS4ShoKiojiathie2vuejiec2X.Mahl7ewaej4ebi7afq8f_vwe" //nolint:gosec t.Cleanup(func() { @@ -31,7 +33,8 @@ func TestRegisterOllamaEngineDefaults(t *testing.T) { t.Run("SelfHosted", func(t *testing.T) { ensureEnvOnce = sync.Once{} CaptionModel = testCaptionModel.Clone() - _ = os.Unsetenv(ollama.APIKeyEnv) + t.Setenv(ollama.APIKeyEnv, "") + t.Setenv(ollama.BaseUrlEnv, ollama.DefaultBaseUrl) registerOllamaEngineDefaults() @@ -55,6 +58,10 @@ func TestRegisterOllamaEngineDefaults(t *testing.T) { if CaptionModel.Service.Uri != ollama.DefaultUri { t.Fatalf("expected caption model uri %s, got %s", ollama.DefaultUri, CaptionModel.Service.Uri) } + + if CaptionModel.Service.Think != ollama.DefaultThink { + t.Fatalf("expected caption model think %s, got %s", ollama.DefaultThink, CaptionModel.Service.Think) + } }) t.Run("Cloud", func(t *testing.T) { ensureEnvOnce = sync.Once{} @@ -83,11 +90,16 @@ func TestRegisterOllamaEngineDefaults(t *testing.T) { if CaptionModel.Service.Uri != ollama.DefaultUri { t.Fatalf("expected caption model uri %s, got %s", ollama.DefaultUri, CaptionModel.Service.Uri) } + + if CaptionModel.Service.Think != ollama.DefaultThink { + t.Fatalf("expected caption model think %s, got %s", ollama.DefaultThink, CaptionModel.Service.Think) + } }) t.Run("ApiKeyAloneKeepsLocalDefaults", func(t *testing.T) { ensureEnvOnce = sync.Once{} CaptionModel = testCaptionModel.Clone() t.Setenv(ollama.APIKeyEnv, cloudToken) + t.Setenv(ollama.BaseUrlEnv, ollama.DefaultBaseUrl) registerOllamaEngineDefaults() @@ -129,6 +141,10 @@ func TestRegisterOllamaEngineDefaults(t *testing.T) { if model.Resolution != ollama.DefaultResolution { t.Fatalf("expected resolution %d, got %d", ollama.DefaultResolution, model.Resolution) } + + if model.Service.Think != ollama.DefaultThink { + t.Fatalf("expected service think %s, got %s", ollama.DefaultThink, model.Service.Think) + } }) } @@ -251,4 +267,72 @@ func TestOllamaParserFallbacks(t *testing.T) { t.Fatalf("expected response field caption, got %q", resp.Result.Caption.Text) } }) + t.Run("StripsLeadingReasoningBlock", func(t *testing.T) { + req := &ApiRequest{} + payload := ollama.Response{ + Response: "<think>The user wants a concise caption.</think>A tabby cat stares upward.", + } + raw, err := json.Marshal(payload) + if err != nil { + t.Fatalf("marshal: %v", err) + } + + parser := ollamaParser{} + resp, err := parser.Parse(context.Background(), req, raw, 200) + if err != nil { + t.Fatalf("parse failed: %v", err) + } + + if resp.Result.Caption == nil { + t.Fatal("expected caption result") + } + if resp.Result.Caption.Text != "A tabby cat stares upward." { + t.Fatalf("expected reasoning block to be stripped, got %q", resp.Result.Caption.Text) + } + }) +} + +func TestOllamaParserUnavailableStatus(t *testing.T) { + t.Run("Gone", func(t *testing.T) { + req := &ApiRequest{Model: ollama.CloudModel} + payload := ollama.Response{} + raw, err := json.Marshal(payload) + if err != nil { + t.Fatalf("marshal: %v", err) + } + + parser := ollamaParser{} + resp, err := parser.Parse(context.Background(), req, raw, http.StatusGone) + if err != nil { + t.Fatalf("parse should not error on upstream status, got %v", err) + } + + if resp.Code != http.StatusGone { + t.Fatalf("expected code %d, got %d", http.StatusGone, resp.Code) + } + if len(resp.Result.Labels) != 0 || resp.Result.Caption != nil { + t.Fatalf("expected empty result, got %+v", resp.Result) + } + }) +} + +func TestStripReasoningBlock(t *testing.T) { + cases := []struct { + name string + in string + want string + }{ + {"LeadingBlock", "<think>reasoning here</think>Actual caption.", "Actual caption."}, + {"CaseInsensitive", "<THINK>reasoning</THINK>\n Caption text.", "Caption text."}, + {"UntaggedUnchanged", "The user wants a concise description of the image.", "The user wants a concise description of the image."}, + {"UnterminatedUnchanged", "<think>reasoning without a close tag and no caption", "<think>reasoning without a close tag and no caption"}, + {"Empty", "", ""}, + } + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + if got := stripReasoningBlock(tc.in); got != tc.want { + t.Fatalf("stripReasoningBlock(%q) = %q, want %q", tc.in, got, tc.want) + } + }) + } } diff --git a/internal/ai/vision/engine_openai_test.go b/internal/ai/vision/engine_openai_test.go index 38a50e52a..be1eb945b 100644 --- a/internal/ai/vision/engine_openai_test.go +++ b/internal/ai/vision/engine_openai_test.go @@ -23,7 +23,7 @@ func TestOpenAIBuilderBuild(t *testing.T) { } model.ApplyEngineDefaults() - request, err := openaiBuilder{}.Build(context.Background(), model, Files{examplesPath + "/chameleon_lime.jpg"}) + request, err := openaiBuilder{}.Build(context.Background(), model, Files{samplesPath + "/chameleon_lime.jpg"}) require.NoError(t, err) require.NotNil(t, request) @@ -44,7 +44,7 @@ func TestOpenAIBuilderBuildCaptionDisablesForceJSON(t *testing.T) { } model.ApplyEngineDefaults() - request, err := openaiBuilder{}.Build(context.Background(), model, Files{examplesPath + "/chameleon_lime.jpg"}) + request, err := openaiBuilder{}.Build(context.Background(), model, Files{samplesPath + "/chameleon_lime.jpg"}) require.NoError(t, err) require.NotNil(t, request) require.NotNil(t, request.Options) @@ -134,6 +134,33 @@ func TestApiRequestJSONForOpenAIDefaultSchemaName(t *testing.T) { assert.Equal(t, schema.JsonSchemaName(req.Schema, openai.DefaultSchemaVersion), decoded.Text.Format.Name) } +func TestApiRequestJSONForOpenAIServiceTier(t *testing.T) { + newReq := func(tier string) *ApiRequest { + return &ApiRequest{ + Model: "gpt-5-mini", + Images: []string{"data:image/jpeg;base64,AA=="}, + ResponseFormat: ApiFormatOpenAI, + Tier: tier, + } + } + t.Run("SentWhenSet", func(t *testing.T) { + payload, err := newReq("flex").JSON() + require.NoError(t, err) + + var decoded map[string]any + require.NoError(t, json.Unmarshal(payload, &decoded)) + assert.Equal(t, "flex", decoded["service_tier"]) + }) + t.Run("OmittedWhenEmpty", func(t *testing.T) { + payload, err := newReq(" ").JSON() + require.NoError(t, err) + + var decoded map[string]any + require.NoError(t, json.Unmarshal(payload, &decoded)) + assert.NotContains(t, decoded, "service_tier") + }) +} + func TestOpenAIParserParsesJSONFromTextPayload(t *testing.T) { respPayload := `{ "id": "resp_123", diff --git a/internal/ai/vision/faces.go b/internal/ai/vision/faces.go index fea722476..e8e0682df 100644 --- a/internal/ai/vision/faces.go +++ b/internal/ai/vision/faces.go @@ -17,7 +17,7 @@ func DetectFaces(fileName string, minSize int, cacheCrop bool, expected int) (re if Config == nil { return result, errors.New("vision service is not configured") } else if model := Config.Model(ModelTypeFace); model != nil { - result, err = face.Detect(fileName, false, minSize) + result, err = face.Detect(fileName, minSize) if err != nil { return result, err diff --git a/internal/ai/vision/labels_test.go b/internal/ai/vision/labels_test.go index e3aa2639f..16e4febd0 100644 --- a/internal/ai/vision/labels_test.go +++ b/internal/ai/vision/labels_test.go @@ -20,7 +20,7 @@ import ( func TestGenerateLabels(t *testing.T) { t.Run("Success", func(t *testing.T) { - result, err := GenerateLabels(Files{examplesPath + "/chameleon_lime.jpg"}, media.SrcLocal, entity.SrcAuto) + result, err := GenerateLabels(Files{samplesPath + "/chameleon_lime.jpg"}, media.SrcLocal, entity.SrcAuto) assert.NoError(t, err) assert.IsType(t, classify.Labels{}, result) @@ -32,7 +32,7 @@ func TestGenerateLabels(t *testing.T) { assert.InDelta(t, 7, result[0].Uncertainty, 3) }) t.Run("Cat224", func(t *testing.T) { - result, err := GenerateLabels(Files{examplesPath + "/cat_224.jpeg"}, media.SrcLocal, entity.SrcAuto) + result, err := GenerateLabels(Files{samplesPath + "/cat_224.jpeg"}, media.SrcLocal, entity.SrcAuto) assert.NoError(t, err) assert.IsType(t, classify.Labels{}, result) @@ -45,7 +45,7 @@ func TestGenerateLabels(t *testing.T) { assert.InDelta(t, float32(0.41), result[0].Confidence(), 0.1) }) t.Run("Cat720", func(t *testing.T) { - result, err := GenerateLabels(Files{examplesPath + "/cat_720.jpeg"}, media.SrcLocal, entity.SrcAuto) + result, err := GenerateLabels(Files{samplesPath + "/cat_720.jpeg"}, media.SrcLocal, entity.SrcAuto) assert.NoError(t, err) assert.IsType(t, classify.Labels{}, result) @@ -58,7 +58,7 @@ func TestGenerateLabels(t *testing.T) { assert.InDelta(t, float32(0.4), result[0].Confidence(), 0.1) }) t.Run("CustomSourceLocal", func(t *testing.T) { - labels, err := GenerateLabels(Files{examplesPath + "/cat_224.jpeg"}, media.SrcLocal, entity.SrcManual) + labels, err := GenerateLabels(Files{samplesPath + "/cat_224.jpeg"}, media.SrcLocal, entity.SrcManual) if err != nil { t.Fatalf("GenerateLabels error: %v", err) } @@ -69,7 +69,7 @@ func TestGenerateLabels(t *testing.T) { } }) t.Run("InvalidFile", func(t *testing.T) { - _, err := GenerateLabels(Files{examplesPath + "/notexisting.jpg"}, media.SrcLocal, entity.SrcAuto) + _, err := GenerateLabels(Files{samplesPath + "/notexisting.jpg"}, media.SrcLocal, entity.SrcAuto) assert.Error(t, err) }) } @@ -81,12 +81,15 @@ func TestGenerateLabelsRequestShapingForStructuredOutputIdea(t *testing.T) { }) t.Run("OllamaUsesJsonFormatWithSchemaPromptInstructions", func(t *testing.T) { server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - var req ApiRequest + // Decode into a map because the serialized "think" value is a JSON boolean + // (the Ollama engine now disables reasoning by default), not the string form. + var req map[string]any require.NoError(t, json.NewDecoder(r.Body).Decode(&req)) - assert.Equal(t, FormatJSON, req.Format) - assert.Contains(t, req.Prompt, "Return JSON that matches this schema:") - assert.Empty(t, req.Schema, "Ollama structured schema payload is not sent yet") + assert.Equal(t, FormatJSON, req["format"]) + assert.Contains(t, req["prompt"], "Return JSON that matches this schema:") + assert.NotContains(t, req, "schema", "Ollama structured schema payload is not sent yet") + assert.Equal(t, false, req["think"], "reasoning is disabled by default for the Ollama engine") require.NoError(t, json.NewEncoder(w).Encode(ollama.Response{ Model: "gemma3:4b", @@ -114,7 +117,7 @@ func TestGenerateLabelsRequestShapingForStructuredOutputIdea(t *testing.T) { Thresholds: DefaultThresholds, } - labels, err := GenerateLabels(Files{examplesPath + "/cat_224.jpeg"}, media.SrcLocal, entity.SrcAuto) + labels, err := GenerateLabels(Files{samplesPath + "/cat_224.jpeg"}, media.SrcLocal, entity.SrcAuto) require.NoError(t, err) require.Len(t, labels, 1) assert.Equal(t, "Cat", labels[0].Name) @@ -197,7 +200,7 @@ func TestGenerateLabelsRequestShapingForStructuredOutputIdea(t *testing.T) { Thresholds: DefaultThresholds, } - labels, err := GenerateLabels(Files{examplesPath + "/cat_224.jpeg"}, media.SrcLocal, entity.SrcAuto) + labels, err := GenerateLabels(Files{samplesPath + "/cat_224.jpeg"}, media.SrcLocal, entity.SrcAuto) require.NoError(t, err) require.Len(t, labels, 1) assert.Equal(t, "Cat", labels[0].Name) diff --git a/internal/ai/vision/model.go b/internal/ai/vision/model.go index 2e7b7354f..afa9e7eec 100644 --- a/internal/ai/vision/model.go +++ b/internal/ai/vision/model.go @@ -69,9 +69,11 @@ func (m *Model) GetModel() (model, name, version string) { return "", "", "" } - // Normalise the configured values. - name = clean.TypeLower(m.Name) - version = clean.TypeLowerDash(m.Version) + // Sanitize the configured values without lowercasing: upstream catalogs + // (Ollama tags, Hugging Face IDs served by OpenAI-compatible endpoints) + // match identifiers verbatim, so case must round-trip from vision.yml. + name = clean.Type(m.Name) + version = clean.Type(m.Version) // Build a base name from the highest-priority override: // 1) Service-specific override (expanded for env vars) @@ -82,7 +84,7 @@ func (m *Model) GetModel() (model, name, version string) { case serviceModel != "": name = serviceModel case strings.TrimSpace(m.Model) != "": - name = clean.TypeLower(m.Model) + name = clean.Type(m.Model) } // Return if no model is configured. @@ -167,6 +169,7 @@ func (m *Model) ApplyService(apiRequest *ApiRequest) { if m.Engine == openai.EngineName { apiRequest.Org = m.Service.EndpointOrg() apiRequest.Project = m.Service.EndpointProject() + apiRequest.Tier = m.Service.EndpointTier() } if think := m.Service.EndpointThink(); think != "" { @@ -503,6 +506,10 @@ func (m *Model) ApplyEngineDefaults() { if strings.TrimSpace(m.Service.Key) == "" && info.DefaultKey != "" { m.Service.Key = info.DefaultKey } + + if strings.TrimSpace(m.Service.Think) == "" && info.DefaultThink != "" { + m.Service.Think = info.DefaultThink + } } m.Engine = engine diff --git a/internal/ai/vision/model_test.go b/internal/ai/vision/model_test.go index 2b90af333..015931695 100644 --- a/internal/ai/vision/model_test.go +++ b/internal/ai/vision/model_test.go @@ -139,10 +139,20 @@ func TestModel_GetModel(t *testing.T) { Model: "CUSTOM-MODEL", Engine: ollama.EngineName, }, - wantModel: "custom-model:latest", - wantName: "custom-model", + wantModel: "CUSTOM-MODEL:latest", + wantName: "CUSTOM-MODEL", wantVersion: "latest", }, + { + name: "OpenAIPreservesHuggingFaceCase", + model: &Model{ + Engine: openai.EngineName, + Service: Service{Model: "QuantTrio/Qwen3-VL-30B-A3B-Instruct-AWQ"}, + }, + wantModel: "QuantTrio/Qwen3-VL-30B-A3B-Instruct-AWQ", + wantName: "QuantTrio/Qwen3-VL-30B-A3B-Instruct-AWQ", + wantVersion: "", + }, { name: "ServiceOverrideWithVersion", model: &Model{ @@ -264,6 +274,18 @@ func TestModelApplyEngineDefaultsSetsServiceDefaults(t *testing.T) { assert.Equal(t, ApiFormatOllama, model.Service.ResponseFormat) assert.Equal(t, scheme.Base64, model.Service.FileScheme) assert.Equal(t, ollama.APIKeyPlaceholder, model.Service.Key) + assert.Equal(t, ollama.DefaultThink, model.Service.Think) + }) + t.Run("OllamaPreservesExplicitThink", func(t *testing.T) { + model := &Model{ + Type: ModelTypeLabels, + Engine: ollama.EngineName, + Service: Service{Think: "true"}, + } + + model.ApplyEngineDefaults() + + assert.Equal(t, "true", model.Service.Think) }) t.Run("PreserveExistingService", func(t *testing.T) { model := &Model{ @@ -399,23 +421,25 @@ func TestModelApplyService(t *testing.T) { req := &ApiRequest{} model := &Model{ Engine: openai.EngineName, - Service: Service{Org: "org-123", Project: "proj-abc", Think: "medium"}, + Service: Service{Org: "org-123", Project: "proj-abc", Tier: "flex", Think: "medium"}, } model.ApplyService(req) assert.Equal(t, "org-123", req.Org) assert.Equal(t, "proj-abc", req.Project) + assert.Equal(t, "flex", req.Tier) assert.Equal(t, "medium", req.Think) }) t.Run("OtherEngineIgnoresOpenAIHeadersButAppliesThink", func(t *testing.T) { - req := &ApiRequest{Org: "keep", Project: "keep"} - model := &Model{Engine: ollama.EngineName, Service: Service{Org: "new", Project: "new", Think: "false"}} + req := &ApiRequest{Org: "keep", Project: "keep", Tier: "keep"} + model := &Model{Engine: ollama.EngineName, Service: Service{Org: "new", Project: "new", Tier: "new", Think: "false"}} model.ApplyService(req) assert.Equal(t, "keep", req.Org) assert.Equal(t, "keep", req.Project) + assert.Equal(t, "keep", req.Tier) assert.Equal(t, "false", req.Think) }) } diff --git a/internal/ai/vision/nsfw.go b/internal/ai/vision/nsfw.go index 2f7139f20..fcfc20860 100644 --- a/internal/ai/vision/nsfw.go +++ b/internal/ai/vision/nsfw.go @@ -84,7 +84,9 @@ func nsfwInternal(images Files, mediaSrc media.Src) (result []nsfw.Result, err e } if err != nil { - log.Errorf("nsfw: %s", err) + // Non-JPEG uploads return "not a jpeg file" by design; real + // model failures still surface via len(labels) < 1 at the caller. + log.Debugf("nsfw: %s", err) } result[i] = labels diff --git a/internal/ai/vision/ollama/README.md b/internal/ai/vision/ollama/README.md index e9293e8d8..7ceb473af 100644 --- a/internal/ai/vision/ollama/README.md +++ b/internal/ai/vision/ollama/README.md @@ -1,6 +1,6 @@ ## PhotoPrism — Ollama Engine Integration -**Last Updated:** February 23, 2026 +**Last Updated:** July 16, 2026 ### Overview @@ -8,8 +8,9 @@ This package provides PhotoPrism’s native adapter for Ollama-compatible multim #### Constraints -- Engine defaults live in `internal/ai/vision/ollama` and are applied whenever a model sets `Engine: ollama`. Aliases map to `ApiFormatOllama`, `scheme.Base64`, and a default 720 px thumbnail. Cloud defaults are only selected when `OLLAMA_BASE_URL` equals `https://ollama.com`. -- Responses may arrive as newline-delimited JSON chunks. `decodeOllamaResponse` keeps the most recent chunk, while the parser now supports both `response` and `thinking` fallbacks for captions and labels. +- Engine defaults live in `internal/ai/vision/ollama` and are applied whenever a model sets `Engine: ollama`. Aliases map to `ApiFormatOllama`, `scheme.Base64`, and a default 720 px thumbnail. The default model is `gemma4:latest` for self-hosted instances and `minimax-m3:cloud` when `OLLAMA_BASE_URL` equals `https://ollama.com` (cloud defaults are only selected on that exact match). +- Reasoning is disabled by default (`DefaultThink = "false"`, applied to `Service.Think` when empty) so thinking-capable models do not leak their reasoning into captions or invalidate label JSON. Re-enable it explicitly with `Service.Think: "true"`. +- Responses may arrive as newline-delimited JSON chunks. `decodeOllamaResponse` keeps the most recent chunk, while the parser supports both `response` and `thinking` fallbacks for captions and labels and strips a leading, well-delimited `<think>...</think>` block from the response body as a defensive fallback. - Structured JSON is optional for captions but enforced for labels when `Format: json` (default for label models targeting the Ollama engine). - The adapter never overwrites TensorFlow defaults. If an Ollama call fails, downstream code still has Nasnet, NSFW, and Face models available. - Workers assume a single-image payload per request. Run `photoprism vision run` to validate multi-image prompts before changing that invariant. @@ -41,7 +42,7 @@ This package provides PhotoPrism’s native adapter for Ollama-compatible multim - Captions: no system prompt by default; rely on user prompt or set one explicitly for stylistic needs. - **User Prompts** - Captions use `CaptionPrompt`, which requests one sentence in active voice. - - Labels default to `LabelPromptDefault`; when `DetectNSFWLabels` is true, the adapter swaps in `LabelPromptNSFW`. + - Labels default to `LabelPromptDefault`; when the package-level `DetectNSFWLabels` global is true, the adapter swaps in `LabelPromptNSFW`. The global is set by `config.go` to `DetectNSFW() && Experimental()`, so both `PHOTOPRISM_DETECT_NSFW=true` and `PHOTOPRISM_EXPERIMENTAL=true` are required to enable the NSFW-aware prompt. - For stricter noun enforcement, set `Prompt` to `LabelPromptStrict`. - **Schemas** - Labels rely on `schema.LabelsJson(nsfw)` (simple JSON template). Setting `Format: json` auto-attaches a reminder (`model.SchemaInstructions()`). @@ -53,18 +54,32 @@ This package provides PhotoPrism’s native adapter for Ollama-compatible multim ### Supported Ollama Vision Models -| Model (Ollama Tag) | Size & Footprint | Strengths | JSON & Language Notes | When To Use | -|:------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `gemma3:4b / 12b / 27b` | 4B/12B/27B parameters, ~3.3 GB → 17 GB downloads, 128 K context | Multimodal text+image reasoning with SigLIP encoder, handles OCR/long documents, supports tool/function calling | Emits structured JSON reliably; >140 languages with strong default English output | High-quality captions + multilingual labels when you have ≥12 GB VRAM (4B works on 8 GB with Q4_K_M) | -| `qwen2.5vl:7b` | 8.29 B params (Q4_K_M) ≈6 GB download, 125 K context | Excellent charts, GUI grounding, DocVQA, multi-image reasoning, agentic tool use | JSON mode tuned for schema compliance; supports 20+ languages with strong Chinese/English parity | Label extraction for mixed-language archives or UI/diagram analysis | -| `qwen3-vl:2b / 4b / 8b` | Dense 2B/4B/8B tiers (~3 GB, ~3.5 GB, ~6 GB downloads) with native 256 K context extendable to 1 M; fits single 12–24 GB GPUs or high-end CPUs (2B) | Spatial + video reasoning upgrades (Interleaved-MRoPE, DeepStack), 32-language OCR, GUI/agent control, long-document ingest | Emits JSON reliably when prompts specify schema; multilingual captions/labels with Thinking variants boosting STEM reasoning | General-purpose captions/labels when you need long-context doc/video support without cloud APIs; 2B for CPU/edge, 4B as balanced default, 8B when accuracy outweighs latency | -| `llama3.2-vision:11b` | 11 B params, ~7.8 GB download, requires ≥8 GB VRAM; 90 B variant needs ≥64 GB | Strong general reasoning, captioning, OCR, supported by Meta ecosystem tooling | Vision tasks officially supported in English; text-only tasks cover eight major languages | Keep captions consistent with Meta-compatible prompts or when teams already standardize on Llama 3.x | -| `minicpm-v:8b-2.6` | 8 B params, ~5.5 GB download, 32 K context | Optimized for edge GPUs, high OCR accuracy, multi-image/video support, low token count (≈640 tokens for 1.8 MP) | Multilingual (EN/ZH/DE/FR/IT/KR). Emits concise JSON but may need stricter stopping sequences | Memory-constrained deployments that still require NSFW/OCR-aware label output | +> Recommended defaults: `gemma4:latest` for self-hosted instances (a drop-in replacement for `gemma3` at similar latency) and `minimax-m3:cloud` for Ollama Cloud. Both return reliable JSON and handle multiple languages well. The table below lists additional models that work well for specific use cases. + +| Model (Ollama Tag) | Size & Footprint | Strengths | JSON & Language Notes | When To Use | +|:----------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `gemma4:e2b / e4b (latest)` | ~7.2 GB (e2b) / ~9.6 GB (e4b) downloads; e2b fits 8 GB VRAM, e4b needs >=10 GB VRAM or CPU offload | Multimodal successor to Gemma 3; very consistent, reliable JSON; drop-in replacement at similar latency (~2 s labels on an RTX 4060) | Emits clean JSON (any code fences stripped by `clean.JSON`); strong multilingual output | **Recommended self-hosted default.** General captions + labels; `gemma4:latest` (e4b) for best quality, `gemma4:e2b` for a faster single-primary-subject classifier | +| `gemma3:4b / 12b / 27b` | 4B/12B/27B parameters, ~3.3 GB → 17 GB downloads, 128 K context | Multimodal text+image reasoning with SigLIP encoder, handles OCR/long documents, supports tool/function calling | Emits structured JSON reliably; >140 languages with strong default English output | High-quality captions + multilingual labels when you have ≥12 GB VRAM (4B works on 8 GB with Q4_K_M) | +| `qwen2.5vl:7b` | 8.29 B params (Q4_K_M) ≈6 GB download, 125 K context | Excellent charts, GUI grounding, DocVQA, multi-image reasoning, agentic tool use | JSON mode tuned for schema compliance; supports 20+ languages with strong Chinese/English parity | Label extraction for mixed-language archives or UI/diagram analysis | +| `qwen3-vl:2b / 4b / 8b` | Dense 2B/4B/8B tiers (~3 GB, ~3.5 GB, ~6 GB downloads) with native 256 K context extendable to 1 M; fits single 12–24 GB GPUs or high-end CPUs (2B) | Spatial + video reasoning upgrades (Interleaved-MRoPE, DeepStack), 32-language OCR, GUI/agent control, long-document ingest | Emits JSON reliably when prompts specify schema; multilingual captions/labels with Thinking variants boosting STEM reasoning | General-purpose captions/labels when you need long-context doc/video support without cloud APIs; 2B for CPU/edge, 4B as balanced default, 8B when accuracy outweighs latency | +| `llama3.2-vision:11b` | 11 B params, ~7.8 GB download, requires ≥8 GB VRAM; 90 B variant needs ≥64 GB | Strong general reasoning, captioning, OCR, supported by Meta ecosystem tooling | Vision tasks officially supported in English; text-only tasks cover eight major languages | Keep captions consistent with Meta-compatible prompts or when teams already standardize on Llama 3.x | +| `minicpm-v:8b-2.6` | 8 B params, ~5.5 GB download, 32 K context | Optimized for edge GPUs, high OCR accuracy, multi-image/video support, low token count (≈640 tokens for 1.8 MP) | Multilingual (EN/ZH/DE/FR/IT/KR). Emits concise JSON but may need stricter stopping sequences | Memory-constrained deployments that still require NSFW/OCR-aware label output | +| `qwen3.5:4b` | ~3.4 GB download, fits 8 GB VRAM | Qwen3.5 family; accepts images in recent Ollama builds; fast, clean single-pass `response` | Thinking-capable, so keep `Service.Think: "false"` (the default); concise JSON labels | Smaller Qwen-family alternative to Gemma 4; verify multimodal support on your Ollama version | > Tip: pull models inside the dev container with `docker compose --profile ollama up -d` and then `docker compose exec ollama ollama pull gemma3:4b`. Keep the profile stopped when you do not need extra GPU/CPU load. > Qwen3-VL models can stream structured output via `thinking` while leaving `response` empty. The parser checks `response` first and falls back to `thinking`, so captions/labels continue to work with either field. +#### Ollama Cloud Models + +Set `OLLAMA_BASE_URL=https://ollama.com` and provide `OLLAMA_API_KEY` to use hosted models (no local download or GPU required). The default cloud model is `minimax-m3:cloud`. The cloud catalog changes over time and models are occasionally retired without notice, so treat this as a snapshot and consult <https://ollama.com/search?c=cloud> for the current list; PhotoPrism logs a clear warning when a configured cloud model returns HTTP 404/410. Latencies below are approximate single-image timings observed on the hosted service. + +| Model (Cloud Tag) | Latency (caption / labels) | Strengths | Notes | +|:-------------------|:---------------------------|:-----------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------| +| `minimax-m3:cloud` | ~3 s / ~7 s | Fast, multilingual (verified English, German, Arabic), 12-17 labels | **Recommended default.** Streams reasoning into the separate `thinking` field; `response` stays clean | +| `gemma4:31b` | ~2 s / ~15-19 s | Consistent Gemma-family JSON, cloud sibling of the self-hosted default | Slower on labels than `minimax-m3:cloud`; good when you prefer Gemma output | +| `qwen3.5:397b` | ~4-5 s / ~5-7 s | Strong multilingual captions and labels | Large Qwen3.5 MoE; thinking-capable, so keep `Service.Think: "false"` (the default) | + ### Configuration #### Environment Variables @@ -112,8 +127,8 @@ Guidelines: - Place new entries after the default TensorFlow models so they take precedence while Nasnet/NSFW remain as fallbacks. - Always specify the exact Ollama tag (`model:version`) so upgrades are deliberate. -- `Service.Think` is optional and is sent only when non-empty. Keep it quoted (for example `"false"` or `"low"`) so YAML preserves it as a string; PhotoPrism serializes `"true"` / `"false"` as JSON booleans for Ollama compatibility. -- Model support is not universal: `think:true` may fail on models that do not implement reasoning, and `think:false` can still yield empty `response` fields on some reasoning-capable models. +- `Service.Think` defaults to `"false"` for the Ollama engine (reasoning off) and is sent whenever non-empty. Keep it quoted (for example `"false"`, `"true"`, or `"low"`) so YAML preserves it as a string; PhotoPrism serializes `"true"` / `"false"` as JSON booleans for Ollama compatibility. Set `Service.Think: "true"` to re-enable reasoning for a model that benefits from it. +- Model support is not universal: `think:true` may fail on models that do not implement reasoning, and `think:false` can still yield empty `response` fields on some reasoning-capable models (which then stream their JSON via the `thinking` field — the parser handles this). - Keep option flags before positional arguments in CLI snippets (`photoprism vision run -m labels --count 1`). - If you proxy requests (e.g., through Traefik), set `Service.Key` to `Bearer <token>` and configure the proxy to inject/validate it. @@ -146,7 +161,7 @@ Guidelines: - `internal/ai/vision/engine_ollama.go` — Builder/parser glue plus label/caption normalization. - `internal/ai/vision/api_ollama.go` — Base64 payload builder. - `internal/ai/vision/api_client.go` — Streaming decoder shared among engines. -- `internal/ai/vision/models.go` — Default caption model definition (`gemma3`). +- `internal/ai/vision/models.go` — Default caption model definition (`gemma4:latest`, `minimax-m3:cloud` for Ollama Cloud). - `compose*.yaml` — Ollama service profile, Traefik labels, and persistent volume wiring. - `frontend/src/common/util.js` — Maps `src="ollama"` to the correct badge; keep it updated when adding new source strings. diff --git a/internal/ai/vision/ollama/const.go b/internal/ai/vision/ollama/const.go index 1d9538c49..dd683e101 100644 --- a/internal/ai/vision/ollama/const.go +++ b/internal/ai/vision/ollama/const.go @@ -21,10 +21,14 @@ const ( CloudBaseUrl = "https://ollama.com" // DefaultUri is the default service URI for self-hosted Ollama instances. DefaultUri = BaseUrlPlaceholder + "/api/generate" - // DefaultModel names the default caption model bundled with our adapter defaults. - DefaultModel = "gemma3:latest" - // CloudModel names the default caption for the Ollama cloud service, see https://ollama.com/cloud. - CloudModel = "qwen3-vl:235b-instruct" + // DefaultModel names the default vision model bundled with our adapter defaults, see https://ollama.com/library/gemma4. + DefaultModel = "gemma4:latest" + // CloudModel names the default vision model for the Ollama cloud service, see https://ollama.com/cloud. + CloudModel = "minimax-m3:cloud" + // DefaultThink is the default reasoning hint for the Ollama engine. Reasoning is disabled by default so + // thinking-capable models do not leak their reasoning into captions or invalidate label JSON; users can + // re-enable it explicitly with Service.Think: "true". + DefaultThink = "false" // CaptionPrompt instructs Ollama caption models to emit a single, active-voice sentence. CaptionPrompt = "Create a caption with exactly one sentence in the active voice that describes the main visual content. Begin with the main subject and clear action. Avoid text formatting, meta-language, and filler words." // LabelConfidenceDefault is used when the model omits the confidence field. diff --git a/internal/ai/vision/ollama/ollama.go b/internal/ai/vision/ollama/ollama.go index 3bef6c5e3..42d434b05 100644 --- a/internal/ai/vision/ollama/ollama.go +++ b/internal/ai/vision/ollama/ollama.go @@ -2,7 +2,7 @@ Package ollama integrates PhotoPrism's vision pipeline with Ollama-compatible multi-modal models so adapters can share logging and engine helpers. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -15,7 +15,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/ai/vision/openai/README.md b/internal/ai/vision/openai/README.md index ff0dfdae5..fa59328dd 100644 --- a/internal/ai/vision/openai/README.md +++ b/internal/ai/vision/openai/README.md @@ -1,6 +1,6 @@ ## PhotoPrism — OpenAI API Integration -**Last Updated:** November 14, 2025 +**Last Updated:** July 16, 2026 ### Overview @@ -28,7 +28,7 @@ This package contains PhotoPrism’s adapter for the OpenAI Responses API. It en ### Prompt, Model, & Schema Guidance - **Models:** The adapter targets GPT‑5 vision tiers (e.g. `gpt-5-nano`, `gpt-5-mini`). These models support image inputs, structured outputs, and deterministic settings. Set `Name` to the exact provider identifier so defaults are applied correctly. Caption models share the same configuration surface and run through the same adapter. -- **Prompts:** Defaults live in `defaults.go`. Captions use a single-sentence instruction; labels use `LabelPromptDefault` (or `LabelPromptNSFW` when PhotoPrism requests NSFW metadata). Custom prompts should retain schema reminders so structured outputs stay valid. +- **Prompts:** Defaults live in `defaults.go`. Captions use a single-sentence instruction; labels use `LabelPromptDefault` (or `LabelPromptNSFW` when the package-level `vision.DetectNSFWLabels` global is true, which requires both `PHOTOPRISM_DETECT_NSFW=true` and `PHOTOPRISM_EXPERIMENTAL=true`). Custom prompts should retain schema reminders so structured outputs stay valid. - **Schemas:** Labels use the JSON schema returned by `schema.LabelsJsonSchema(nsfw)`; the response format name is derived via `schema.JsonSchemaName` (e.g. `photoprism_vision_labels_v1`). Captions omit schemas unless operators explicitly request a structured format. - **When to keep defaults:** For most deployments, leaving `System`, `Prompt`, `Schema`, and `Options` unset yields stable output with minimal configuration. Override them only when domain-specific language or custom scoring is necessary, and add regression tests alongside. @@ -77,10 +77,13 @@ Models: Uri: https://api.openai.com/v1/responses FileScheme: data Key: ${OPENAI_API_KEY} + Tier: flex # optional; sent as top-level "service_tier" (e.g. cheaper, slower "flex") ``` Keep TensorFlow entries in place so PhotoPrism falls back when the external service is unavailable. +> `Service.Tier` is passed through verbatim as the top-level `service_tier` field in the request body (values follow OpenAI: `auto`, `default`, `flex`, `priority`, …). It is omitted when empty (OpenAI default `auto`) and supports `${ENV}` expansion. The `flex` tier bills at roughly half the standard rate and suits the metadata worker and scheduled runs, which tolerate higher latency; such requests are more likely to return `HTTP 429` when capacity is short, in which case the item retries on the next worker pass. + #### Defaults - File scheme: `data:` URLs (base64) for all OpenAI models. diff --git a/internal/ai/vision/openai/openai.go b/internal/ai/vision/openai/openai.go index f3b8ce412..4b180bd9a 100644 --- a/internal/ai/vision/openai/openai.go +++ b/internal/ai/vision/openai/openai.go @@ -2,7 +2,7 @@ Package openai implements the PhotoPrism vision adapter that calls the OpenAI Responses API for captions, labels, and optional markers. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -15,7 +15,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/ai/vision/openai/transport.go b/internal/ai/vision/openai/transport.go index ee061e149..16d6e57e7 100644 --- a/internal/ai/vision/openai/transport.go +++ b/internal/ai/vision/openai/transport.go @@ -28,6 +28,7 @@ type HTTPRequest struct { TopP float64 `json:"top_p,omitempty"` PresencePenalty float64 `json:"presence_penalty,omitempty"` FrequencyPenalty float64 `json:"frequency_penalty,omitempty"` + ServiceTier string `json:"service_tier,omitempty"` } // TextOptions carries formatting preferences for textual responses. diff --git a/internal/ai/vision/schema/README.md b/internal/ai/vision/schema/README.md index 4c8222cd6..8f6c2c92d 100644 --- a/internal/ai/vision/schema/README.md +++ b/internal/ai/vision/schema/README.md @@ -1,6 +1,6 @@ ## PhotoPrism — Vision Schema Reference -**Last Updated:** November 14, 2025 +**Last Updated:** May 21, 2026 ### Overview @@ -13,12 +13,12 @@ Both helpers build on the same field set (`name`, `confidence`, `topicality`, an ### Schema Types & Differences -| Helper | Target Engine | Format | Validation Style | When To Use | -|:--------------------------|:-------------------------|:-------------------------------------------------------|:------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------| -| `LabelsJsonSchema(false)` | OpenAI (standard labels) | JSON Schema Draft | Strong: OpenAI enforces field types/ranges server-side before returning a response. | When calling GPT‑vision models via `ApiFormatOpenAI` to ensure PhotoPrism receives well-formed label arrays. | -| `LabelsJsonSchema(true)` | OpenAI (labels + NSFW) | JSON Schema Draft with additional boolean/float fields | Strong: same enforcement plus required NSFW fields. | When `DetectNSFWLabels` or NSFW-specific prompts are active and the model must emit `nsfw` + `nsfw_confidence`. | -| `LabelsJson(false)` | Ollama (standard labels) | Plain JSON example | Soft: model is nudged to mimic the structure through prompt instructions. | When running self-hosted Ollama models that support “JSON mode” but do not consume JSON Schema definitions. | -| `LabelsJson(true)` | Ollama (labels + NSFW) | Plain JSON example with NSFW keys | Soft: prompts describe the required keys; the adapter validates after parsing. | When Ollama prompts mention NSFW scoring or PhotoPrism sets `DetectNSFWLabels=true`. | +| Helper | Target Engine | Format | Validation Style | When To Use | +|:--------------------------|:-------------------------|:-------------------------------------------------------|:------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `LabelsJsonSchema(false)` | OpenAI (standard labels) | JSON Schema Draft | Strong: OpenAI enforces field types/ranges server-side before returning a response. | When calling GPT‑vision models via `ApiFormatOpenAI` to ensure PhotoPrism receives well-formed label arrays. | +| `LabelsJsonSchema(true)` | OpenAI (labels + NSFW) | JSON Schema Draft with additional boolean/float fields | Strong: same enforcement plus required NSFW fields. | When `DetectNSFWLabels` (gated on `DETECT_NSFW=true && EXPERIMENTAL=true`) or NSFW-specific prompts are active and the model must emit `nsfw` + `nsfw_confidence`. | +| `LabelsJson(false)` | Ollama (standard labels) | Plain JSON example | Soft: model is nudged to mimic the structure through prompt instructions. | When running self-hosted Ollama models that support “JSON mode” but do not consume JSON Schema definitions. | +| `LabelsJson(true)` | Ollama (labels + NSFW) | Plain JSON example with NSFW keys | Soft: prompts describe the required keys; the adapter validates after parsing. | When Ollama prompts mention NSFW scoring or PhotoPrism sets `DetectNSFWLabels=true`. | **Key technical distinction:** OpenAI’s Responses API accepts a JSON Schema (see `LabelsJsonSchema*`) and guarantees compliance by rejecting invalid responses, while Ollama currently relies on prompt-directed output. For Ollama integrations we provide a representative JSON document (`LabelsJson*`) that models can imitate; PhotoPrism then normalizes and validates the results in Go. diff --git a/internal/ai/vision/schema/schema.go b/internal/ai/vision/schema/schema.go index 4801a8477..2dbb74380 100644 --- a/internal/ai/vision/schema/schema.go +++ b/internal/ai/vision/schema/schema.go @@ -1,7 +1,7 @@ /* Package schema defines canonical JSON and JSON Schema templates shared by PhotoPrism's AI vision engines. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/ai/vision/service.go b/internal/ai/vision/service.go index 623a92d81..c14051201 100644 --- a/internal/ai/vision/service.go +++ b/internal/ai/vision/service.go @@ -19,7 +19,8 @@ type Service struct { Key string `yaml:"Key,omitempty" json:"-"` Org string `yaml:"Org,omitempty" json:"org,omitempty"` // Optional organization header (e.g. OpenAI). Project string `yaml:"Project,omitempty" json:"project,omitempty"` // Optional project header (e.g. OpenAI). - Think string `yaml:"Think,omitempty" json:"think,omitempty"` // Optional reasoning hint for compatible engines (e.g. Ollama, GPT-OSS). + Tier string `yaml:"Tier,omitempty" json:"tier,omitempty"` // Optional service tier sent as service_tier in the request body (OpenAI, e.g. "flex"). + Think string `yaml:"Think,omitempty" json:"think,omitempty"` // Optional reasoning hint for compatible engines (e.g. Ollama, GPT-OSS); defaults to "false" for the Ollama engine. FileScheme string `yaml:"FileScheme,omitempty" json:"fileScheme,omitempty"` RequestFormat ApiFormat `yaml:"RequestFormat,omitempty" json:"requestFormat,omitempty"` ResponseFormat ApiFormat `yaml:"ResponseFormat,omitempty" json:"responseFormat,omitempty"` @@ -65,6 +66,8 @@ func (m *Service) Endpoint() (uri, method string) { } // GetModel returns the model identifier override for the endpoint, if any. +// Case is preserved because upstream catalogs (e.g. Hugging Face IDs on +// OpenAI-compatible servers) match identifiers verbatim. func (m *Service) GetModel() string { if m.Disabled { return "" @@ -72,7 +75,7 @@ func (m *Service) GetModel() string { ensureEnv() - return clean.TypeLower(os.ExpandEnv(m.Model)) + return clean.Type(os.ExpandEnv(m.Model)) } // EndpointKey returns the access token belonging to the remote service endpoint, if any. @@ -108,6 +111,17 @@ func (m *Service) EndpointProject() string { return strings.TrimSpace(os.ExpandEnv(m.Project)) } +// EndpointTier returns the optional service tier for the endpoint, if any. +func (m *Service) EndpointTier() string { + if m.Disabled { + return "" + } + + ensureEnv() + + return strings.TrimSpace(os.ExpandEnv(m.Tier)) +} + // EndpointThink returns the optional thinking/reasoning setting for the endpoint, if any. func (m *Service) EndpointThink() string { if m.Disabled { diff --git a/internal/ai/vision/service_test.go b/internal/ai/vision/service_test.go index 981382005..2cddccb0f 100644 --- a/internal/ai/vision/service_test.go +++ b/internal/ai/vision/service_test.go @@ -1,6 +1,8 @@ package vision -import "testing" +import ( + "testing" +) func TestServiceEndpoint(t *testing.T) { //nolint:gosec // G101: Credential-style URLs are intentional test fixtures. @@ -50,8 +52,11 @@ func TestServiceEndpoint(t *testing.T) { for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - if tt.name == "ExpandsBaseUrlEnv" { + switch tt.name { + case "ExpandsBaseUrlEnv": t.Setenv("OLLAMA_BASE_URL", "http://custom:11434") + case "FallbacksWhenEnvMissing": + t.Setenv("OLLAMA_BASE_URL", "http://ollama:11434") } uri, method := tt.svc.Endpoint() @@ -68,10 +73,11 @@ func TestServiceEndpoint(t *testing.T) { func TestServiceCredentialsAndHeaders(t *testing.T) { t.Setenv("VISION_USER", "alice") t.Setenv("VISION_PASS", "hunter2") - t.Setenv("VISION_MODEL", "GEMMA3:Latest") + t.Setenv("VISION_MODEL", "QuantTrio/Qwen3-VL-30B-A3B-Instruct-AWQ") t.Setenv("VISION_ORG", "org-123") t.Setenv("VISION_PROJECT", "proj-abc") t.Setenv("VISION_THINK", "false") + t.Setenv("VISION_TIER", "flex") svc := Service{ Username: "${VISION_USER}", @@ -80,6 +86,7 @@ func TestServiceCredentialsAndHeaders(t *testing.T) { Org: "${VISION_ORG}", Project: "${VISION_PROJECT}", Think: "${VISION_THINK}", + Tier: "${VISION_TIER}", } user, pass := svc.BasicAuth() @@ -87,7 +94,7 @@ func TestServiceCredentialsAndHeaders(t *testing.T) { t.Fatalf("basic auth: got %q/%q", user, pass) } - if got := svc.GetModel(); got != "gemma3:latest" { + if got := svc.GetModel(); got != "QuantTrio/Qwen3-VL-30B-A3B-Instruct-AWQ" { t.Fatalf("model override: got %q", got) } @@ -102,4 +109,8 @@ func TestServiceCredentialsAndHeaders(t *testing.T) { if got := svc.EndpointThink(); got != "false" { t.Fatalf("think: got %q", got) } + + if got := svc.EndpointTier(); got != "flex" { + t.Fatalf("tier: got %q", got) + } } diff --git a/internal/ai/vision/testdata/vision.yml b/internal/ai/vision/testdata/vision.yml index 91b0d8058..148cf3073 100644 --- a/internal/ai/vision/testdata/vision.yml +++ b/internal/ai/vision/testdata/vision.yml @@ -65,13 +65,14 @@ Models: Name: embeddings Outputs: 512 - Type: caption - Model: gemma3:latest + Model: gemma4:latest Engine: ollama Run: manual Resolution: 720 Service: Uri: ${OLLAMA_BASE_URL}/api/generate Key: ${OLLAMA_API_KEY} + Think: "false" FileScheme: base64 RequestFormat: ollama ResponseFormat: ollama diff --git a/internal/ai/vision/vision.go b/internal/ai/vision/vision.go index d1caadecf..1d52f5bf3 100644 --- a/internal/ai/vision/vision.go +++ b/internal/ai/vision/vision.go @@ -1,7 +1,7 @@ /* Package vision provides a computer vision request handler and a client for using external APIs. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/ai/vision/vision_test.go b/internal/ai/vision/vision_test.go index 8e84c3b03..df9ef1002 100644 --- a/internal/ai/vision/vision_test.go +++ b/internal/ai/vision/vision_test.go @@ -13,9 +13,14 @@ import ( ) var assetsPath = fs.Abs("../../../assets") -var examplesPath = filepath.Join(assetsPath, "examples") +var samplesPath = filepath.Join(assetsPath, "samples") +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) int { // Init test logger. log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) @@ -27,7 +32,5 @@ func TestMain(m *testing.M) { ServiceUri = "" // Run unit tests. - code := m.Run() - - os.Exit(code) + return m.Run() } diff --git a/internal/api/AGENTS.md b/internal/api/AGENTS.md new file mode 100644 index 000000000..ef02daba3 --- /dev/null +++ b/internal/api/AGENTS.md @@ -0,0 +1,31 @@ +# API Guidelines + +**Last Updated:** April 9, 2026 + +## Handler Conventions + +- Reuse limiter stacks such as `limiter.Auth` and `limiter.Login`, and use `limiter.AbortJSON` for `429` responses. +- Lean on `api.ClientIP`, `header.BearerToken`, and the shared `Abort*` helpers instead of duplicating request parsing. +- Compare secrets in constant time and set `Cache-Control: no-store` on sensitive responses. +- Register routes in `internal/server/routes.go`. +- New list endpoints should default to `count=100`, cap at `1000`, require `offset >= 0`, and document their parameters explicitly. +- When a test or fixture needs portal mode, set `PHOTOPRISM_NODE_ROLE=portal` together with `PHOTOPRISM_JOIN_TOKEN`. + +## Roles, Scopes & Sessions + +- Map user roles through `acl.ParseRole(s)` and `acl.UserRoles[...]`; map client roles through `acl.ClientRoles[...]`. +- Treat `RoleAliasNone` (`none`) and the empty string as `RoleNone`; default unknown client roles to `RoleClient`. +- When checking JWT or client scopes, use `acl.ScopePermits` and `acl.ScopeAttrPermits` instead of handwritten parsing. +- Use `AuthenticateAdmin`, `AuthenticateUser`, or `OAuthToken` helpers in tests rather than building auth flows manually. +- Build client-session requests with `entity.AddClientSession(..., authn.GrantClientCredentials, nil)` and `AuthenticatedRequest(...)`. +- Admin sessions may see `AdvertiseUrl` and `Database`; client and user sessions must not. `SiteUrl` and the client `storageNamespace` derived from it are safe to expose. + +## Swagger & API Tests + +- Annotate only routed handlers in `internal/api/*.go`; use full `/api/v1/...` paths and skip helper functions. +- Regenerate API docs with `make fmt-go swag-fmt swag` or `make swag-json`; `make swag` may fetch modules, so confirm network access first. +- While iterating, prefer focused runs such as `go test ./internal/api -run Cluster -count=1`. +- Isolate config paths with `t.TempDir()` and reuse `NewConfig`, `CliTestContext`, and `NewApiTest()` helpers. +- For negative permission checks, prefer OAuth client tokens over non-admin user fixtures. +- Register `CreateSession(router)` only once per test router; a second registration panics on duplicate routes. + diff --git a/internal/api/README.md b/internal/api/README.md index 59858d9ba..dbee74898 100644 --- a/internal/api/README.md +++ b/internal/api/README.md @@ -20,14 +20,18 @@ The API package exposes PhotoPrism’s HTTP endpoints via Gin handlers. Each fil - Query and persist data through the corresponding services or repositories; avoid ad-hoc SQL or GORM usage in handlers when dedicated functions exist elsewhere. - Surface pagination consistently with `count`, `offset`, and `limit` following the defaults (100 max 1000). Validate `offset >= 0` and clamp `count` to the allowed range. - When responses need role-specific fields, build DTOs that redact sensitive data for non-admin roles so the handler stays deterministic. +- **JSON field casing:** use **TitleCase** field names (`UUID`, `Name`, `SiteUrl`, `CreatedAt`) for request/response bodies that correspond to a database entity (mirroring the entity/model, e.g. the cluster `Node` and `ClusterInstance` DTOs), and **camelCase** (`storageNamespace`, `redirectUri`) for generated or artificial payloads that do not map to a specific entity — client config, session responses, and action/RPC bodies. A filtered or computed projection of an entity stays TitleCase; an action payload that operates on an entity stays camelCase but MAY TitleCase the single identity field that mirrors the entity (e.g. a `UUID`). ### Security & Middleware - Authenticate requests using the standard middleware (`AuthRequired`) and check roles via helpers in `internal/auth/acl` (`acl.ParseRole`, `acl.ScopePermits`, `acl.ScopeAttrPermits`). +- Bound request bodies before parsing JSON or multipart payloads. Use `LimitRequestBodyBytes(...)` with a route-appropriate cap before `BindJSON(...)` / `ShouldBindJSON(...)`, detect `IsRequestBodyTooLarge(err)`, and return `413 Request Entity Too Large` via `AbortRequestTooLarge(...)`. +- Keep new JSON binding sites on the shared request-limit path by running `make check-api-request-limits` (also included in `make lint`) after adding or refactoring API handlers in the root repo or private overlays. - Never log secrets or tokens. Prefer structured logging through `event.Log` and redact sensitive values before logging. - Enforce rate limiting with the shared limiters (`limiter.Auth`, `limiter.Login`) and respond with `limiter.AbortJSON` to maintain consistent 429 JSON payloads. - Derive client IPs through `api.ClientIP` and extract bearer tokens with `header.BearerToken` or the helper setters. Use constant-time comparison for tokens and secrets. - For downloads or proxy endpoints, validate URLs against allowed schemes (`http`, `https`) and reject private or loopback addresses unless explicitly required. +- **Upload-time NSFW screening (`users_upload.go`)** — when `PHOTOPRISM_UPLOAD_NSFW=false`, the upload handler runs `vision.DetectNSFW` against every accepted file and deletes any file flagged above the NSFW threshold before it reaches `originals/`. The check is skipped entirely when `UPLOAD_NSFW=true` (default). See [`internal/ai/nsfw/README.md`](../ai/nsfw/README.md) for the full NSFW call-graph and flag matrix. ### Audit Logging @@ -54,7 +58,28 @@ The API package exposes PhotoPrism’s HTTP endpoints via Gin handlers. Each fil status.Error(err), }, refID) ``` -- See `specs/common/audit-logs.md` for the full conventions and additional examples that agents should follow. + +### User-Visible Notifications vs Audit Log + +`event.AuditInfo` / `AuditWarn` / `AuditErr` write to the audit log and broadcast on `audit.log.<level>` — the toast component on the frontend does NOT subscribe to that channel, so an audit entry alone produces no UI feedback. To raise a red or green toast in the browser, publish on the `notify.*` channel via `event.Error(msg)` / `event.ErrorMsg(id, …)` (red) or `event.Success(msg)` (green). + +The two helpers have distinct subscribers; choose based on who the message is for: + +- **Short endpoints whose response the frontend reads** (single-shot CRUD, login, settings updates). The calling component renders the response, so `AuditErr` plus an HTTP error is enough — the UI gets the error string from the response body. +- **Long-running endpoints that the UI drives via the event hub** (`POST /api/v1/index`, `POST /api/v1/import/*path`, and similar). The frontend cancels the in-flight HTTP request on the first `index.*` / `import.*` wire event, so the response body is invisible in normal operation. In-flight failures that need a specific toast MUST be published via `event.ErrorMsg(...)` on `notify.error`; an HTTP error alone produces only the frontend's generic fallback toast (or nothing, if the cancel has already fired). +- **Forensic events that don't need UI surfacing** (rate limiting, ACL denials, internal aborts whose user-visible signal comes from a sibling channel). `AuditErr` alone is the right call. + +When in doubt, ask: "after this handler returns, what does the user see?" If the answer is "the frontend will read the response", `AuditErr` covers it. If the answer is "the page is already subscribed to wire events and the response is discarded", publish on `notify.*` as well. + +```go +// Forensic audit only — frontend will read the response body and render the error. +event.AuditErr([]string{ClientIP(c), "session %s", "delete album", status.Failed}, s.RefID) +AbortBadRequest(c, err) + +// Forensic audit + specific red toast — needed when the request was already canceled by the wire. +event.AuditErr([]string{ClientIP(c), "session %s", "index files", status.Failed}, s.RefID) +event.ErrorMsg(i18n.ErrIndexingFailed) +``` ### Swagger Documentation @@ -70,6 +95,7 @@ The API package exposes PhotoPrism’s HTTP endpoints via Gin handlers. Each fil - When handlers interact with the database, initialize fixtures through config helpers such as `config.NewTestConfig("api")` or `config.NewMinimalTestConfigWithDb("api", t.TempDir())` depending on fixture needs. - Stub external dependencies (`httptest.Server`) for remote calls and set `AllowPrivate=true` explicitly when the test server binds to loopback addresses. - Structure tests with table-driven subtests (`t.Run("CaseName", ...)`) and use PascalCase names. Provide cleanup functions (`t.Cleanup`) to remove temporary files or databases created during tests. +- Do not run `internal/api` tests in parallel. These suites share fixture files, temporary assets, and database state, so parallel `go test` invocations can cause false failures and readonly/fixture-conflict errors. ### Focused Test Runs @@ -77,6 +103,7 @@ The API package exposes PhotoPrism’s HTTP endpoints via Gin handlers. Each fil - Cluster endpoints: `go test ./internal/api -run 'Cluster' -count=1` - Downloads and zip streaming: `go test ./internal/api -run 'Download|Archive' -count=1` - Combined CLI and API validation: pair `go test ./internal/commands -run 'Cluster' -count=1` with the matching API suite to ensure DTOs remain compatible. +- Keep focused `internal/api` runs sequential. Do not launch multiple `go test ./internal/api ...` commands at the same time. ### Preflight Checklist diff --git a/internal/api/albums.go b/internal/api/albums.go index bb08b8c54..ef34e8bd9 100644 --- a/internal/api/albums.go +++ b/internal/api/albums.go @@ -90,9 +90,10 @@ func GetAlbum(router *gin.RouterGroup) { // Get sanitized album UID from request path. uid := clean.UID(c.Param("uid")) - // Visitors can only access shared content. + // Limit access to albums within the session's shared scope; albums outside it are reported + // as not found, consistent with how photos and files are read. if (s.NotRegistered()) && !s.HasShare(uid) { - AbortForbidden(c) + AbortAlbumNotFound(c) return } @@ -106,7 +107,7 @@ func GetAlbum(router *gin.RouterGroup) { // Other restricted users can only access their own or shared content. if s.GetUser().HasSharedAccessOnly(acl.ResourceAlbums) && album.CreatedBy != s.UserUID && !s.HasShare(uid) { - AbortForbidden(c) + AbortAlbumNotFound(c) return } @@ -138,7 +139,14 @@ func CreateAlbum(router *gin.RouterGroup) { var frm form.Album // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxAlbumRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -238,7 +246,14 @@ func UpdateAlbum(router *gin.RouterGroup) { } // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxAlbumRequestBytes) + if err = c.BindJSON(frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -387,7 +402,7 @@ func LikeAlbum(router *gin.RouterGroup) { UpdateClientConfig() - PublishAlbumEvent(StatusUpdated, uid, c) + PublishAlbumEvent(StatusUpdated, uid) // Update album YAML backup. SaveAlbumYaml(&album) @@ -438,7 +453,7 @@ func DislikeAlbum(router *gin.RouterGroup) { UpdateClientConfig() - PublishAlbumEvent(StatusUpdated, uid, c) + PublishAlbumEvent(StatusUpdated, uid) // Update album YAML backup. SaveAlbumYaml(&album) @@ -487,7 +502,14 @@ func CloneAlbums(router *gin.RouterGroup) { var frm form.Selection // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxAlbumRequestBytes) + if err = c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -515,7 +537,7 @@ func CloneAlbums(router *gin.RouterGroup) { if len(added) > 0 { event.SuccessMsg(i18n.MsgSelectionAddedTo, clean.Log(album.Title())) - PublishAlbumEvent(StatusUpdated, album.AlbumUID, c) + PublishAlbumEvent(StatusUpdated, album.AlbumUID) // Update album YAML backup. SaveAlbumYaml(&album) @@ -548,7 +570,14 @@ func AddPhotosToAlbum(router *gin.RouterGroup) { var frm form.Selection // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxAlbumRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -595,7 +624,7 @@ func AddPhotosToAlbum(router *gin.RouterGroup) { RemoveFromAlbumCoverCache(album.AlbumUID) - PublishAlbumEvent(StatusUpdated, album.AlbumUID, c) + PublishAlbumEvent(StatusUpdated, album.AlbumUID) // Update album YAML backup. SaveAlbumYaml(&album) @@ -624,7 +653,7 @@ func AddPhotosToAlbum(router *gin.RouterGroup) { if len(approved) > 0 { UpdateClientConfig() - event.EntitiesUpdated("photos", approved) + event.EntitiesUpdated("photos", approved.UIDs()) } } } @@ -656,7 +685,14 @@ func RemovePhotosFromAlbum(router *gin.RouterGroup) { var frm form.Selection // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxAlbumRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -697,7 +733,7 @@ func RemovePhotosFromAlbum(router *gin.RouterGroup) { RemoveFromAlbumCoverCache(album.AlbumUID) - PublishAlbumEvent(StatusUpdated, album.AlbumUID, c) + PublishAlbumEvent(StatusUpdated, album.AlbumUID) // Update album YAML backup. SaveAlbumYaml(&album) diff --git a/internal/api/albums_search.go b/internal/api/albums_search.go index 4361f16d5..5965c4848 100644 --- a/internal/api/albums_search.go +++ b/internal/api/albums_search.go @@ -22,6 +22,9 @@ import ( // @Tags Albums // @Produce json // @Success 200 {object} search.AlbumResults +// @Header 200 {number} X-Count "The actual number of albums returned" +// @Header 200 {number} X-Limit "The limit of the number of albums to be returned" +// @Header 200 {number} X-Offset "The offset that was used" // @Failure 400,404 {object} i18n.Response // @Param count query int true "maximum number of results" minimum(1) maximum(100000) // @Param offset query int false "search result offset" minimum(0) maximum(100000) diff --git a/internal/api/albums_test.go b/internal/api/albums_test.go index 8159b1397..2af8da3bb 100644 --- a/internal/api/albums_test.go +++ b/internal/api/albums_test.go @@ -2,8 +2,10 @@ package api import ( "net/http" + "strings" "testing" + "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/entity/query" "github.com/stretchr/testify/assert" @@ -29,6 +31,17 @@ func TestGetAlbum(t *testing.T) { assert.Equal(t, "Album not found", val.String()) assert.Equal(t, http.StatusNotFound, r.Code) }) + t.Run("GuestDeniedNotShared", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + GetAlbum(router) + sessId := AuthenticateUser(app, router, "gandalf", "Gandalf123!") + // An album outside the guest's shared scope is reported as not found. + r := AuthenticatedRequest(app, "GET", "/api/v1/albums/as6sg6bxpogaaba8", sessId) + assert.Equal(t, http.StatusNotFound, r.Code) + }) } func TestCreateAlbum(t *testing.T) { @@ -51,6 +64,13 @@ func TestCreateAlbum(t *testing.T) { r := PerformRequestWithBody(app, "POST", "/api/v1/albums", `{"Title": 333, "Description": "Created via unit test", "Notes": "", "Favorite": true}`) assert.Equal(t, http.StatusBadRequest, r.Code) }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, _ := NewApiTest() + CreateAlbum(router) + body := `{"Title":"` + strings.Repeat("a", 300*1024) + `"}` + r := PerformRequestWithBody(app, "POST", "/api/v1/albums", body) + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) + }) } func TestUpdateAlbum(t *testing.T) { app, router, _ := NewApiTest() @@ -77,6 +97,13 @@ func TestUpdateAlbum(t *testing.T) { r := PerformRequestWithBody(app, "PUT", "/api/v1/albums"+uid, `{"Title": 333, "Description": "Created via unit test", "Notes": "", "Favorite": true}`) assert.Equal(t, http.StatusNotFound, r.Code) }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, _ := NewApiTest() + UpdateAlbum(router) + body := `{"Title":"` + strings.Repeat("a", 300*1024) + `"}` + r := PerformRequestWithBody(app, "PUT", "/api/v1/albums/"+uid, body) + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) + }) t.Run("NotFound", func(t *testing.T) { app, router, _ := NewApiTest() UpdateAlbum(router) diff --git a/internal/api/api.go b/internal/api/api.go index 08cfd33ef..0d1b95e5a 100644 --- a/internal/api/api.go +++ b/internal/api/api.go @@ -1,7 +1,7 @@ /* Package api provides REST-API authentication and request handlers. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/api/api_auth.go b/internal/api/api_auth.go index 1b9bd11f4..91908e4c2 100644 --- a/internal/api/api_auth.go +++ b/internal/api/api_auth.go @@ -7,6 +7,7 @@ import ( "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/event" + "github.com/photoprism/photoprism/internal/photoprism/get" "github.com/photoprism/photoprism/pkg/authn" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/http/header" @@ -47,16 +48,39 @@ func AuthAny(c *gin.Context, resource acl.Resource, perms acl.Permissions) (s *e event.AuditInfo([]string{clientIp, "session %s", "%s %s as %s", status.Granted}, s.RefID, perms.First(), string(resource), s.GetClientRole().String()) return s } - event.AuditWarn([]string{clientIp, "%s %s without authentication", status.Denied}, perms.String(), string(resource)) + + // Log routine anonymous requests at debug level; warn only on a rejected token. + if authToken == "" { + event.AuditDebug([]string{clientIp, "%s %s without authentication", status.Denied}, perms.String(), string(resource)) + } else { + event.AuditWarn([]string{clientIp, "%s %s with invalid authentication", status.Denied}, perms.String(), string(resource)) + } + return entity.SessionStatusUnauthorized() } // Set client IP. s.SetClientIP(clientIp) - // If the request is from a client application, check its authorization based - // on the allowed scope, the ACL, and the user account it belongs to (if any). + // Enforce restrictions for app password sessions, identified by the "application" auth provider. + if s.IsApplication() { + // Reject app passwords when the feature is disabled. + if get.Config().DisableAppPasswords() { + event.AuditWarn([]string{clientIp, "session %s", "%s %s with app password", status.Disabled}, s.RefID, perms.String(), string(resource)) + return entity.SessionStatusForbidden() + } + + // Reject app passwords when the user is denied access to the Web UI/API. + if u := s.GetUser(); u.DenyLogIn() { + event.AuditWarn([]string{clientIp, "session %s", "%s %s with app password", status.Denied}, s.RefID, perms.String(), string(resource)) + return entity.SessionStatusForbidden() + } + } + if s.IsClient() { + // If the request is from a client application, check its authorization based + // on the allowed scope, the ACL, and the user account it belongs to (if any). + // Check the resource and required permissions against the session scope. if s.InsufficientScope(resource, perms) { event.AuditErr([]string{clientIp, "client %s", "session %s", "access %s", status.Error(authn.ErrInsufficientScope)}, clean.Log(s.GetClientInfo()), s.RefID, string(resource)) @@ -123,3 +147,16 @@ func AuthAny(c *gin.Context, resource acl.Resource, perms acl.Permissions) (s *e func AuthToken(c *gin.Context) string { return header.AuthToken(c) } + +// SessionRefID returns the current session ref ID for audit logs, or "unknown" if unavailable. +func SessionRefID(c *gin.Context) string { + if c == nil { + return "unknown" + } + + if s := Session(ClientIP(c), AuthToken(c)); s != nil && s.RefID != "" { + return s.RefID + } + + return "unknown" +} diff --git a/internal/api/api_auth_jwt_test.go b/internal/api/api_auth_jwt_test.go index 5e377ad46..2c987ed8f 100644 --- a/internal/api/api_auth_jwt_test.go +++ b/internal/api/api_auth_jwt_test.go @@ -441,3 +441,40 @@ func TestVerifyTokenFromPortal(t *testing.T) { nilClaims := verifyTokenFromPortal(context.Background(), token, expected, []string{"wrong"}) assert.Nil(t, nilClaims) } + +func TestAuthAnyJWT_UsersManageScope(t *testing.T) { + // A Portal cluster JWT scoped for user management authenticates as a service + // principal with no end-user identity. UpdateUser authorizes exactly this + // condition (GrantJwtBearer + users-manage scope) so the Portal can sync + // cluster user state, bypassing the per-user owner check a user-less token + // can never satisfy. + fx := newPortalJWTFixture(t, "users-jwt-manage") + spec := fx.defaultClaimsSpec() + spec.Scope = []string{"cluster", "users"} + token := fx.issue(t, spec) + + origScope := fx.nodeConf.Options().JWTScope + fx.nodeConf.Options().JWTScope = "cluster vision metrics users" + get.SetConfig(fx.nodeConf) + t.Cleanup(func() { + fx.nodeConf.Options().JWTScope = origScope + get.SetConfig(fx.nodeConf) + }) + + gin.SetMode(gin.TestMode) + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + req, _ := http.NewRequest(http.MethodPut, "/api/v1/users/uqxetse3cy5eo9z2", nil) + req.Header.Set("Authorization", "Bearer "+token) + req.RemoteAddr = "192.0.2.10:12345" + c.Request = req + + s := authAnyJWT(c, "192.0.2.10", token, acl.ResourceUsers, acl.Permissions{acl.ActionManage, acl.AccessOwn, acl.ActionUpdate, acl.ActionUpdateOwn}) + require.NotNil(t, s) + assert.Equal(t, http.StatusOK, s.HttpStatus()) + // No end-user identity (the per-user owner check in UpdateUser would 403)... + assert.True(t, s.GetUser().IsUnknown()) + // ...but it is a manage-scoped cluster JWT, so UpdateUser treats it as admin. + assert.Equal(t, authn.GrantJwtBearer.String(), s.GrantType) + assert.True(t, s.ValidateScope(acl.ResourceUsers, acl.Permissions{acl.ActionManage})) +} diff --git a/internal/api/api_auth_test.go b/internal/api/api_auth_test.go index 9f2f0e615..c15cadfba 100644 --- a/internal/api/api_auth_test.go +++ b/internal/api/api_auth_test.go @@ -16,6 +16,7 @@ import ( clusterjwt "github.com/photoprism/photoprism/internal/auth/jwt" "github.com/photoprism/photoprism/internal/auth/session" "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/photoprism/get" "github.com/photoprism/photoprism/internal/service/cluster" "github.com/photoprism/photoprism/pkg/authn" @@ -99,6 +100,192 @@ func TestAuthAny(t *testing.T) { }) } +func TestAuthAny_AppPasswordsDisabled(t *testing.T) { + conf := config.TestConfig() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + defer func() { conf.Settings().Features.AppPasswords = true }() + + user := entity.FindUserByName("alice") + require.NotNil(t, user) + + // App passwords are minted with different grant types (password for local users, + // session for OIDC-only users, cli for "auth add"); the gate must reject all of them. + for _, grant := range []authn.GrantType{authn.GrantPassword, authn.GrantSession, authn.GrantCLI} { + t.Run(grant.String(), func(t *testing.T) { + sess, err := entity.AddClientSession("alice-app-"+grant.String(), conf.SessionMaxAge(), "*", grant, user) + require.NoError(t, err) + require.True(t, sess.IsApplication()) + token := sess.AuthToken() + + authPhotos := func() *entity.Session { + gin.SetMode(gin.TestMode) + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + req, _ := http.NewRequest(http.MethodGet, "/api/v1/photos", nil) + header.SetAuthorization(req, token) + req.RemoteAddr = "10.9.8.7:4321" + c.Request = req + return AuthAny(c, acl.ResourcePhotos, acl.Permissions{acl.ActionView}) + } + + // Enabled: the app password authorizes within its scope. + conf.Settings().Features.AppPasswords = true + s := authPhotos() + require.NotNil(t, s) + assert.Equal(t, http.StatusOK, s.HttpStatus()) + + // Disabled: the same app password is rejected before any ACL check. + conf.Settings().Features.AppPasswords = false + s2 := authPhotos() + require.NotNil(t, s2) + assert.Equal(t, http.StatusForbidden, s2.HttpStatus()) + }) + } + + // Negative control: the gate keys on IsApplication(), so a non-application + // session (here a client-credentials grant) must keep authorizing whether or + // not app passwords are disabled, proving the flag does not over-reject. + t.Run("NonApplicationSessionUnaffected", func(t *testing.T) { + sess, err := entity.AddClientSession("alice-client-cred", conf.SessionMaxAge(), "*", authn.GrantClientCredentials, nil) + require.NoError(t, err) + require.False(t, sess.IsApplication()) + token := sess.AuthToken() + + authPhotos := func() *entity.Session { + gin.SetMode(gin.TestMode) + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + req, _ := http.NewRequest(http.MethodGet, "/api/v1/photos", nil) + header.SetAuthorization(req, token) + req.RemoteAddr = "10.9.8.7:4321" + c.Request = req + return AuthAny(c, acl.ResourcePhotos, acl.Permissions{acl.ActionView}) + } + + conf.Settings().Features.AppPasswords = true + s := authPhotos() + require.NotNil(t, s) + assert.Equal(t, http.StatusOK, s.HttpStatus()) + + conf.Settings().Features.AppPasswords = false + s2 := authPhotos() + require.NotNil(t, s2) + assert.Equal(t, http.StatusOK, s2.HttpStatus(), "disabling app passwords must not reject non-application sessions") + }) +} + +func TestAuthAny_AppPasswordWebLoginDisabled(t *testing.T) { + conf := config.TestConfig() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + // Use a non-super-admin account; super admins keep web login regardless of CanLogin. + user := entity.FindUserByName("bob") + require.NotNil(t, user) + require.False(t, user.SuperAdmin) + + sess, err := entity.AddClientSession("bob-app-pw", conf.SessionMaxAge(), "*", authn.GrantPassword, user) + require.NoError(t, err) + require.True(t, sess.IsApplication()) + token := sess.AuthToken() + + authPhotos := func() *entity.Session { + gin.SetMode(gin.TestMode) + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + req, _ := http.NewRequest(http.MethodGet, "/api/v1/photos", nil) + header.SetAuthorization(req, token) + req.RemoteAddr = "10.9.8.7:4321" + c.Request = req + return AuthAny(c, acl.ResourcePhotos, acl.Permissions{acl.ActionView}) + } + + // Restore the fixture's web login state after the test. + defer func() { + if m := entity.FindLocalUser("bob"); m != nil { + m.CanLogin = true + _ = m.Save() + } + entity.FlushSessionCache() + }() + + // Web login enabled: the app password authorizes within its scope. + s := authPhotos() + require.NotNil(t, s) + assert.Equal(t, http.StatusOK, s.HttpStatus()) + + // Web login disabled: the same app password is rejected on the REST API. WebDAV + // access stays governed by CanUseWebDAV (verified in the entity tests). + m := entity.FindLocalUser("bob") + require.NotNil(t, m) + m.CanLogin = false + require.NoError(t, m.Save()) + entity.FlushSessionCache() + + s2 := authPhotos() + require.NotNil(t, s2) + assert.Equal(t, http.StatusForbidden, s2.HttpStatus()) +} + +func TestAuthAny_AppPasswordDeactivated(t *testing.T) { + conf := config.TestConfig() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + user := entity.FindUserByName("bob") + require.NotNil(t, user) + + sess, err := entity.AddClientSession("bob-app-deact", conf.SessionMaxAge(), "*", authn.GrantPassword, user) + require.NoError(t, err) + require.True(t, sess.IsApplication()) + token := sess.AuthToken() + + authPhotos := func() *entity.Session { + gin.SetMode(gin.TestMode) + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + req, _ := http.NewRequest(http.MethodGet, "/api/v1/photos", nil) + header.SetAuthorization(req, token) + req.RemoteAddr = "10.9.8.7:4321" + c.Request = req + return AuthAny(c, acl.ResourcePhotos, acl.Permissions{acl.ActionView}) + } + + // Restore the fixture's auth provider after the test. + defer func() { + if m := entity.FindLocalUser("bob"); m != nil { + m.SetProvider(authn.ProviderLocal) + m.CanLogin = true + _ = m.Save() + } + entity.FlushSessionCache() + }() + + // Active account: the app password authorizes within its scope. + s := authPhotos() + require.NotNil(t, s) + assert.Equal(t, http.StatusOK, s.HttpStatus()) + + // Deactivated (auth provider set to none): the app password is rejected on the REST + // API by the per-request DenyLogIn gate, even though the record is not revoked. + m := entity.FindLocalUser("bob") + require.NotNil(t, m) + m.SetProvider(authn.ProviderNone) + require.NoError(t, m.Save()) + entity.FlushSessionCache() + + s2 := authPhotos() + require.NotNil(t, s2) + assert.Equal(t, http.StatusForbidden, s2.HttpStatus()) + + // The app password record itself is preserved, so reactivating the account restores + // access without reconfiguring devices. + rec, err := entity.FindSession(sess.ID) + require.NoError(t, err) + assert.NotNil(t, rec) +} + func TestAuthToken(t *testing.T) { t.Run("None", func(t *testing.T) { gin.SetMode(gin.TestMode) @@ -148,6 +335,48 @@ func TestAuthToken(t *testing.T) { }) } +func TestSessionRefID(t *testing.T) { + origConf := get.Config() + t.Cleanup(func() { get.SetConfig(origConf) }) + + t.Run("Nil", func(t *testing.T) { + assert.Equal(t, "unknown", SessionRefID(nil)) + }) + t.Run("UnknownWithoutSession", func(t *testing.T) { + conf := config.NewMinimalTestConfig(t.TempDir()) + conf.Options().Public = false + get.SetConfig(conf) + + gin.SetMode(gin.TestMode) + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + req := httptest.NewRequest(http.MethodGet, "/api/v1/session", nil) + req.RemoteAddr = "198.51.100.25:1234" + c.Request = req + + assert.Equal(t, "unknown", SessionRefID(c)) + }) + t.Run("PublicSession", func(t *testing.T) { + conf := config.NewMinimalTestConfig(t.TempDir()) + conf.Options().Public = true + get.SetConfig(conf) + + gin.SetMode(gin.TestMode) + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + req := httptest.NewRequest(http.MethodGet, "/api/v1/session", nil) + req.RemoteAddr = "198.51.100.26:1234" + header.SetAuthorization(req, session.PublicAuthToken) + c.Request = req + + expected := get.Session().Public().RefID + actual := SessionRefID(c) + + assert.Equal(t, expected, actual) + assert.True(t, rnd.IsRefID(actual)) + }) +} + func TestAuthAnyVisionServiceKey(t *testing.T) { origAPI := vision.ServiceApi origKey := vision.ServiceKey diff --git a/internal/api/api_client_config.go b/internal/api/api_client_config.go index ece673dd3..974155a89 100644 --- a/internal/api/api_client_config.go +++ b/internal/api/api_client_config.go @@ -25,6 +25,13 @@ func UpdateClientConfig() { clientConfig := conf.ClientUser(false) + // Do not broadcast session-specific tokens via the config.updated event, + // as this is a global broadcast to all connected clients and may overwrite + // individual session tokens with the wrong values. Session tokens are + // updated via the X-Preview-Token and X-Download-Token response headers. + clientConfig.PreviewToken = "" + clientConfig.DownloadToken = "" + go func() { defer func() { if r := recover(); r != nil { diff --git a/internal/api/api_client_config_test.go b/internal/api/api_client_config_test.go index 7b6aa1572..a8ed9cfa7 100644 --- a/internal/api/api_client_config_test.go +++ b/internal/api/api_client_config_test.go @@ -4,12 +4,15 @@ import ( "net/http" "net/http/httptest" "testing" + "time" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" "github.com/tidwall/gjson" "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/pkg/http/header" ) @@ -81,3 +84,40 @@ func TestGetClientConfig(t *testing.T) { assert.Equal(t, http.StatusNotFound, w.Code) }) } + +// TestUpdateClientConfig pins the contract that PreviewToken and +// DownloadToken are stripped from the global "config.updated" broadcast +// so a per-session value cannot overwrite another session's tokens. The +// session-bound copy still carries the live tokens via ClientSession; +// see internal/config/client_config.go and the docs/comments on +// UpdateClientConfig. +func TestUpdateClientConfig(t *testing.T) { + t.Run("OmitsTokensFromBroadcast", func(t *testing.T) { + _, _, conf := NewApiTest() + + // Sanity-check that the un-redacted user config would carry + // non-empty tokens, so the assertion below proves the strip is + // the load-bearing control rather than an empty default. + direct := conf.ClientUser(false) + require.NotEmpty(t, direct.PreviewToken) + require.NotEmpty(t, direct.DownloadToken) + + sub := event.Subscribe("config.updated") + defer event.Unsubscribe(sub) + + UpdateClientConfig() + + select { + case msg := <-sub.Receiver: + assert.Equal(t, "config.updated", msg.Topic()) + + payload, ok := msg.Fields["config"].(*config.ClientConfig) + require.True(t, ok, "config field must be *config.ClientConfig, got %T", msg.Fields["config"]) + + assert.Empty(t, payload.PreviewToken, "PreviewToken must be stripped from the global config.updated broadcast") + assert.Empty(t, payload.DownloadToken, "DownloadToken must be stripped from the global config.updated broadcast") + case <-time.After(5 * time.Second): + t.Fatal("timed out waiting for config.updated event") + } + }) +} diff --git a/internal/api/api_event.go b/internal/api/api_event.go index 7c7996ba3..f4c7b9a8d 100644 --- a/internal/api/api_event.go +++ b/internal/api/api_event.go @@ -1,12 +1,8 @@ package api import ( - "github.com/gin-gonic/gin" - - "github.com/photoprism/photoprism/internal/entity/search" "github.com/photoprism/photoprism/internal/event" - "github.com/photoprism/photoprism/internal/form" - "github.com/photoprism/photoprism/pkg/log/status" + "github.com/photoprism/photoprism/pkg/rnd" ) // Event represents an api event type. @@ -26,41 +22,32 @@ func (ev Event) String() string { return string(ev) } -// PublishPhotoEvent publishes updated photo data after changes have been made. -func PublishPhotoEvent(ev Event, uid string, c *gin.Context) { - if result, _, err := search.Photos(form.SearchPhotos{UID: uid, Merged: true}); err != nil { - event.AuditErr([]string{ClientIP(c), "session %s", "%s photo %s", status.Error(err)}, AuthToken(c), string(ev), uid) - } else { - event.PublishEntities("photos", string(ev), result) +// publishEntityEvent notifies subscribed clients that entity data has changed. +// Only the affected UID is broadcast; clients refetch entity details through +// the REST API, which scopes and filters results per session. +func publishEntityEvent(channel string, ev Event, uid string) { + if rnd.InvalidUID(uid, 0) { + return } + event.PublishEntities(channel, ev.String(), []string{uid}) } -// PublishAlbumEvent publishes updated album data after changes have been made. -func PublishAlbumEvent(ev Event, uid string, c *gin.Context) { - f := form.SearchAlbums{UID: uid} - if result, err := search.Albums(f); err != nil { - event.AuditErr([]string{ClientIP(c), "session %s", "%s album %s", status.Error(err)}, AuthToken(c), string(ev), uid) - } else { - event.PublishEntities("albums", string(ev), result) - } +// PublishPhotoEvent notifies subscribed clients that photo data has changed. +func PublishPhotoEvent(ev Event, uid string) { + publishEntityEvent("photos", ev, uid) } -// PublishLabelEvent publishes updated label data after changes have been made. -func PublishLabelEvent(ev Event, uid string, c *gin.Context) { - f := form.SearchLabels{UID: uid} - if result, err := search.Labels(f); err != nil { - event.AuditErr([]string{ClientIP(c), "session %s", "%s label %s", status.Error(err)}, AuthToken(c), string(ev), uid) - } else { - event.PublishEntities("labels", string(ev), result) - } +// PublishAlbumEvent notifies subscribed clients that album data has changed. +func PublishAlbumEvent(ev Event, uid string) { + publishEntityEvent("albums", ev, uid) } -// PublishSubjectEvent publishes updated subject data after changes have been made. -func PublishSubjectEvent(ev Event, uid string, c *gin.Context) { - f := form.SearchSubjects{UID: uid} - if result, err := search.Subjects(f); err != nil { - event.AuditErr([]string{ClientIP(c), "session %s", "%s subject %s", status.Error(err)}, AuthToken(c), string(ev), uid) - } else { - event.PublishEntities("subjects", string(ev), result) - } +// PublishLabelEvent notifies subscribed clients that label data has changed. +func PublishLabelEvent(ev Event, uid string) { + publishEntityEvent("labels", ev, uid) +} + +// PublishSubjectEvent notifies subscribed clients that subject data has changed. +func PublishSubjectEvent(ev Event, uid string) { + publishEntityEvent("subjects", ev, uid) } diff --git a/internal/api/api_event_test.go b/internal/api/api_event_test.go new file mode 100644 index 000000000..56e88ba7b --- /dev/null +++ b/internal/api/api_event_test.go @@ -0,0 +1,177 @@ +package api + +import ( + "testing" + "time" + + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/event" +) + +func TestEventString(t *testing.T) { + t.Run("Success", func(t *testing.T) { + assert.Equal(t, "updated", StatusUpdated.String()) + assert.Equal(t, "created", StatusCreated.String()) + }) +} + +func TestPublishEntityEvent(t *testing.T) { + t.Run("Success", func(t *testing.T) { + sub := event.Subscribe("photos.updated") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + publishEntityEvent("photos", StatusUpdated, "pqkm36fjqvset9uy") + + select { + case msg := <-sub.Receiver: + assert.Equal(t, "photos.updated", msg.Name) + uids, ok := msg.Fields["entities"].([]string) + assert.True(t, ok, "entities payload should be []string, got %T", msg.Fields["entities"]) + assert.Equal(t, []string{"pqkm36fjqvset9uy"}, uids) + case <-time.After(2 * time.Second): + t.Fatal("expected one photos.updated event") + } + }) + t.Run("InvalidUID", func(t *testing.T) { + sub := event.Subscribe("photos.updated") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + publishEntityEvent("photos", StatusUpdated, "not a uid!") + + select { + case msg := <-sub.Receiver: + t.Fatalf("unexpected event for invalid uid: %s %v", msg.Name, msg.Fields) + case <-time.After(200 * time.Millisecond): + // expected: nothing published. + } + }) +} + +func TestPublishPhotoEvent(t *testing.T) { + t.Run("Success", func(t *testing.T) { + sub := event.Subscribe("photos.updated") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + PublishPhotoEvent(StatusUpdated, "pqkm36fjqvset9uy") + + select { + case msg := <-sub.Receiver: + assert.Equal(t, "photos.updated", msg.Name) + uids, ok := msg.Fields["entities"].([]string) + assert.True(t, ok, "entities payload should be []string, got %T", msg.Fields["entities"]) + assert.Equal(t, []string{"pqkm36fjqvset9uy"}, uids) + case <-time.After(2 * time.Second): + t.Fatal("expected one photos.updated event") + } + }) + t.Run("InvalidUID", func(t *testing.T) { + sub := event.Subscribe("photos.updated") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + PublishPhotoEvent(StatusUpdated, "") + + select { + case msg := <-sub.Receiver: + t.Fatalf("unexpected event for empty uid: %s %v", msg.Name, msg.Fields) + case <-time.After(200 * time.Millisecond): + // expected: nothing published. + } + }) +} + +func TestPublishAlbumEvent(t *testing.T) { + t.Run("Success", func(t *testing.T) { + sub := event.Subscribe("albums.updated") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + PublishAlbumEvent(StatusUpdated, "as6sg6bxpogaaba7") + + select { + case msg := <-sub.Receiver: + assert.Equal(t, "albums.updated", msg.Name) + uids, ok := msg.Fields["entities"].([]string) + assert.True(t, ok, "entities payload should be []string, got %T", msg.Fields["entities"]) + assert.Equal(t, []string{"as6sg6bxpogaaba7"}, uids) + case <-time.After(2 * time.Second): + t.Fatal("expected one albums.updated event") + } + }) + t.Run("InvalidUID", func(t *testing.T) { + sub := event.Subscribe("albums.updated") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + PublishAlbumEvent(StatusUpdated, "not a uid!") + + select { + case msg := <-sub.Receiver: + t.Fatalf("unexpected event for invalid uid: %s %v", msg.Name, msg.Fields) + case <-time.After(200 * time.Millisecond): + // expected: nothing published. + } + }) +} + +func TestPublishLabelEvent(t *testing.T) { + t.Run("Success", func(t *testing.T) { + sub := event.Subscribe("labels.updated") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + PublishLabelEvent(StatusUpdated, "ls6sg6b1wowuy3c2") + + select { + case msg := <-sub.Receiver: + assert.Equal(t, "labels.updated", msg.Name) + uids, ok := msg.Fields["entities"].([]string) + assert.True(t, ok, "entities payload should be []string, got %T", msg.Fields["entities"]) + assert.Equal(t, []string{"ls6sg6b1wowuy3c2"}, uids) + case <-time.After(2 * time.Second): + t.Fatal("expected one labels.updated event") + } + }) + t.Run("InvalidUID", func(t *testing.T) { + sub := event.Subscribe("labels.updated") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + PublishLabelEvent(StatusUpdated, "") + + select { + case msg := <-sub.Receiver: + t.Fatalf("unexpected event for empty uid: %s %v", msg.Name, msg.Fields) + case <-time.After(200 * time.Millisecond): + // expected: nothing published. + } + }) +} + +func TestPublishSubjectEvent(t *testing.T) { + t.Run("Success", func(t *testing.T) { + sub := event.Subscribe("subjects.updated") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + PublishSubjectEvent(StatusUpdated, "js6sg6b1qekk9jx8") + + select { + case msg := <-sub.Receiver: + assert.Equal(t, "subjects.updated", msg.Name) + uids, ok := msg.Fields["entities"].([]string) + assert.True(t, ok, "entities payload should be []string, got %T", msg.Fields["entities"]) + assert.Equal(t, []string{"js6sg6b1qekk9jx8"}, uids) + case <-time.After(2 * time.Second): + t.Fatal("expected one subjects.updated event") + } + }) + t.Run("InvalidUID", func(t *testing.T) { + sub := event.Subscribe("subjects.updated") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + PublishSubjectEvent(StatusUpdated, "not a uid!") + + select { + case msg := <-sub.Receiver: + t.Fatalf("unexpected event for invalid uid: %s %v", msg.Name, msg.Fields) + case <-time.After(200 * time.Millisecond): + // expected: nothing published. + } + }) +} diff --git a/internal/api/api_test.go b/internal/api/api_test.go index 496f5a877..a48fc02d5 100644 --- a/internal/api/api_test.go +++ b/internal/api/api_test.go @@ -20,7 +20,12 @@ import ( "github.com/photoprism/photoprism/pkg/http/header" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) int { // Init test logger. log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) @@ -31,22 +36,24 @@ func TestMain(m *testing.M) { // Init test config. c := config.TestConfig() + defer c.CleanupTestFolder() + defer func() { + if err := c.CloseDb(); err != nil { + log.Warnf("close db: %v", err) + } + // Remove temporary SQLite files after running the tests. + fs.PurgeTestDbFiles(".", false) + }() + get.SetConfig(c) - // Increase login rate limit for testing. + // Increase the login and authentication rate limits for testing so the many + // failed-auth cases across the suite don't exhaust the shared per-IP buckets. limiter.Login = limiter.NewLimit(1, 10000) + limiter.Auth = limiter.NewLimit(1, 10000) // Run unit tests. - code := m.Run() - - if err := c.CloseDb(); err != nil { - log.Warnf("close db: %v", err) - } - - // Remove temporary SQLite files after running the tests. - fs.PurgeTestDbFiles(".", false) - - os.Exit(code) + return m.Run() } type CloseableResponseRecorder struct { diff --git a/internal/api/batch_albums.go b/internal/api/batch_albums.go index 5ff59879f..2337eb874 100644 --- a/internal/api/batch_albums.go +++ b/internal/api/batch_albums.go @@ -34,7 +34,14 @@ func BatchAlbumsDelete(router *gin.RouterGroup) { var frm form.Selection + LimitRequestBodyBytes(c, MaxSelectionRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } diff --git a/internal/api/batch_labels.go b/internal/api/batch_labels.go index a98ac915c..d0a68b893 100644 --- a/internal/api/batch_labels.go +++ b/internal/api/batch_labels.go @@ -34,7 +34,14 @@ func BatchLabelsDelete(router *gin.RouterGroup) { var frm form.Selection + LimitRequestBodyBytes(c, MaxSelectionRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } diff --git a/internal/api/batch_photos.go b/internal/api/batch_photos.go index 65bab6f25..5ad91c8be 100644 --- a/internal/api/batch_photos.go +++ b/internal/api/batch_photos.go @@ -22,6 +22,24 @@ import ( "github.com/photoprism/photoprism/pkg/i18n" ) +// restrictPhotoSelection narrows frm.Photos to the pictures the session may access, so a batch +// action stays within the session's shared scope, mirroring the single-photo and album update +// gates. SelectedPhotoUIDsForSession is client and user role aware and returns the input without a +// query for full-access sessions, so admins incur no overhead. It returns false and reports the +// selection as not found when the scoped selection is empty or the lookup fails. +func restrictPhotoSelection(c *gin.Context, s *entity.Session, frm *form.Selection) bool { + scoped, err := query.SelectedPhotoUIDsForSession(frm.Photos, s) + + if err != nil || len(scoped) == 0 { + AbortEntityNotFound(c) + return false + } + + frm.Photos = scoped + + return true +} + // BatchPhotosArchive moves multiple photos to the archive. // // @Summary moves multiple photos to the archive @@ -44,7 +62,14 @@ func BatchPhotosArchive(router *gin.RouterGroup) { var frm form.Selection // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxSelectionRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -54,6 +79,11 @@ func BatchPhotosArchive(router *gin.RouterGroup) { return } + // Restrict the selection to the session's shared scope. + if !restrictPhotoSelection(c, s, &frm) { + return + } + log.Infof("photos: archiving %s", clean.Log(frm.String())) if get.Config().SidecarYaml() { @@ -115,7 +145,14 @@ func BatchPhotosRestore(router *gin.RouterGroup) { var frm form.Selection + LimitRequestBodyBytes(c, MaxSelectionRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -125,6 +162,11 @@ func BatchPhotosRestore(router *gin.RouterGroup) { return } + // Restrict the selection to the session's shared scope. + if !restrictPhotoSelection(c, s, &frm) { + return + } + log.Infof("photos: restoring %s", clean.Log(frm.String())) if get.Config().SidecarYaml() { @@ -185,7 +227,14 @@ func BatchPhotosApprove(router *gin.RouterGroup) { var frm form.Selection + LimitRequestBodyBytes(c, MaxSelectionRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -195,6 +244,11 @@ func BatchPhotosApprove(router *gin.RouterGroup) { return } + // Restrict the selection to the session's shared scope. + if !restrictPhotoSelection(c, s, &frm) { + return + } + log.Infof("photos: approving %s", clean.Log(frm.String())) // Fetch selection from index. @@ -218,7 +272,7 @@ func BatchPhotosApprove(router *gin.RouterGroup) { UpdateClientConfig() - event.EntitiesUpdated("photos", approved) + event.EntitiesUpdated("photos", approved.UIDs()) c.JSON(http.StatusOK, i18n.NewResponse(http.StatusOK, i18n.MsgSelectionApproved)) }) @@ -245,7 +299,14 @@ func BatchPhotosPrivate(router *gin.RouterGroup) { var frm form.Selection + LimitRequestBodyBytes(c, MaxSelectionRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -255,6 +316,11 @@ func BatchPhotosPrivate(router *gin.RouterGroup) { return } + // Restrict the selection to the session's shared scope. + if !restrictPhotoSelection(c, s, &frm) { + return + } + log.Infof("photos: updating private flag for %s", clean.Log(frm.String())) if err := entity.Db().Model(entity.Photo{}).Where("photo_uid IN (?)", frm.Photos).UpdateColumn("photo_private", @@ -273,7 +339,7 @@ func BatchPhotosPrivate(router *gin.RouterGroup) { SaveSidecarYaml(p) } - event.EntitiesUpdated("photos", photos) + event.EntitiesUpdated("photos", photos.UIDs()) } UpdateClientConfig() @@ -312,7 +378,14 @@ func BatchPhotosDelete(router *gin.RouterGroup) { var frm form.Selection + LimitRequestBodyBytes(c, MaxSelectionRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -328,6 +401,11 @@ func BatchPhotosDelete(router *gin.RouterGroup) { return } + // Restrict an explicit selection to the session's shared scope. + if !frm.All && len(frm.Photos) > 0 && !restrictPhotoSelection(c, s, &frm) { + return + } + // Get selection or all archived photos if f.All is true. switch { case len(frm.Photos) == 0 && !frm.All: diff --git a/internal/api/batch_photos_edit.go b/internal/api/batch_photos_edit.go index 94674fec1..bc6d6d9ff 100644 --- a/internal/api/batch_photos_edit.go +++ b/internal/api/batch_photos_edit.go @@ -54,7 +54,14 @@ func BatchPhotosEdit(router *gin.RouterGroup) { var frm batch.PhotosRequest // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxBatchPhotosEditBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -90,6 +97,7 @@ func BatchPhotosEdit(router *gin.RouterGroup) { saveRequests []*batch.PhotoSaveRequest saveResults []bool savedAny bool + mutated bool ) if frm.Values != nil { @@ -111,8 +119,9 @@ func BatchPhotosEdit(router *gin.RouterGroup) { saveResults = outcome.Results preloadedPhotos = outcome.Preloaded savedAny = outcome.SavedAny + mutated = savedAny || outcome.Stats.AlbumMutations > 0 || outcome.Stats.LabelMutations > 0 - if n := len(saveRequests); n > 0 && (savedAny || outcome.Stats.AlbumMutations > 0 || outcome.Stats.LabelMutations > 0) { + if n := len(saveRequests); n > 0 && mutated { event.AuditInfo([]string{ClientIP(c), "session %s", "batch edit", "update %s", status.Succeeded}, s.RefID, english.Plural(n, "picture", "pictures")) } @@ -141,7 +150,6 @@ func BatchPhotosEdit(router *gin.RouterGroup) { photo = saveRequests[i].Photo } - // PublishPhotoEvent(StatusUpdated, photo.PhotoUID, c) SaveSidecarYaml(photo) } @@ -151,6 +159,25 @@ func BatchPhotosEdit(router *gin.RouterGroup) { } } + // Signal frontend caches (Photo._cache LRU and any future per-UID + // consumers) to drop the affected entries; emitting one event for + // the whole batch avoids the per-UID event storm that calling + // PublishPhotoEvent for each photo would produce. Fires whenever any + // mutation landed — including label/album-only changes that leave + // SaveBatchResult.Results[i] false but still alter visible state. + if mutated && len(saveRequests) > 0 { + affectedUIDs := make([]string, 0, len(saveRequests)) + for _, req := range saveRequests { + if req != nil && req.Photo != nil && req.Photo.PhotoUID != "" { + affectedUIDs = append(affectedUIDs, req.Photo.PhotoUID) + } + } + + if len(affectedUIDs) > 0 { + event.EntitiesUpdated("photos", affectedUIDs) + } + } + // Return models and form values. data := batch.PhotosResponse{ Models: photos, diff --git a/internal/api/batch_photos_edit_test.go b/internal/api/batch_photos_edit_test.go index 5ee16a080..458a89f9a 100644 --- a/internal/api/batch_photos_edit_test.go +++ b/internal/api/batch_photos_edit_test.go @@ -5,6 +5,7 @@ import ( "net/http" "strings" "testing" + "time" "github.com/stretchr/testify/assert" "github.com/tidwall/gjson" @@ -12,6 +13,7 @@ import ( "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/entity/query" + "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/i18n" ) @@ -35,6 +37,15 @@ func TestBatchPhotosEdit(t *testing.T) { assert.Equal(t, http.StatusForbidden, resp.Code) assert.Contains(t, resp.Body.String(), i18n.Msg(i18n.ErrFeatureDisabled)) }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, _ := NewApiTest() + BatchPhotosEdit(router) + + body := `{"photos":["pqkm36fjqvset9uy"],"values":{"Title":{"value":"` + strings.Repeat("a", 2*1024*1024) + `"}}}` + resp := PerformRequestWithBody(app, "POST", "/api/v1/batch/photos/edit", body) + + assert.Equal(t, http.StatusRequestEntityTooLarge, resp.Code) + }) t.Run("SuccessNoChange", func(t *testing.T) { // Create new API test instance. app, router, _ := NewApiTest() @@ -959,4 +970,57 @@ func TestBatchPhotosEdit(t *testing.T) { t.Fatalf("removed label reappeared unexpectedly (src=%s uncertainty=%d)", re.LabelSrc, re.Uncertainty) } }) + t.Run("EmitsPhotosUpdatedAfterSave", func(t *testing.T) { + app, router, _ := NewApiTest() + BatchPhotosEdit(router) + + // Subscribe to photos.updated before mutating; drain on cleanup. + sub := event.Subscribe("photos.updated") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + photoUIDs := `["pqkm36fjqvset9uy", "pqkm36fjqvset9uz"]` + body := fmt.Sprintf(`{"photos": %s, "values": {"Labels":{"action":"update","items":[{"action":"add","value":"","title":"BatchEditedLabel"}]}}}`, photoUIDs) + + resp := PerformRequestWithBody(app, "POST", "/api/v1/batch/photos/edit", body) + assert.Equal(t, http.StatusOK, resp.Code) + + // One event for the whole batch with the full UID list — never per UID. + select { + case msg := <-sub.Receiver: + assert.Equal(t, "photos.updated", msg.Name) + uids, ok := msg.Fields["entities"].([]string) + assert.True(t, ok, "entities payload should be []string, got %T", msg.Fields["entities"]) + assert.ElementsMatch(t, []string{"pqkm36fjqvset9uy", "pqkm36fjqvset9uz"}, uids) + case <-time.After(2 * time.Second): + t.Fatal("expected one photos.updated event after batch save") + } + + // No further events for this batch — pin the one-event-per-batch contract. + select { + case extra := <-sub.Receiver: + t.Fatalf("unexpected extra photos.updated event: %s %v", extra.Name, extra.Fields) + case <-time.After(200 * time.Millisecond): + // expected: queue drained. + } + }) + t.Run("NoUpdatedEventWhenNothingSaved", func(t *testing.T) { + app, router, _ := NewApiTest() + BatchPhotosEdit(router) + + sub := event.Subscribe("photos.updated") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + // SuccessNoChange path: photos selected but no Values supplied, + // so PrepareAndSavePhotos runs no save requests and savedAny stays false. + photoUIDs := `["pqkm36fjqvset9uy", "pqkm36fjqvset9uz"]` + resp := PerformRequestWithBody(app, "POST", "/api/v1/batch/photos/edit", fmt.Sprintf(`{"photos": %s}`, photoUIDs)) + assert.Equal(t, http.StatusOK, resp.Code) + + select { + case msg := <-sub.Receiver: + t.Fatalf("unexpected photos.updated on no-change request: %s %v", msg.Name, msg.Fields) + case <-time.After(200 * time.Millisecond): + // expected: nothing saved, nothing published. + } + }) } diff --git a/internal/api/batch_photos_test.go b/internal/api/batch_photos_test.go index 42619021c..713d9d226 100644 --- a/internal/api/batch_photos_test.go +++ b/internal/api/batch_photos_test.go @@ -4,6 +4,7 @@ import ( "encoding/json" "fmt" "net/http" + "strings" "testing" "github.com/stretchr/testify/assert" @@ -46,6 +47,15 @@ func TestBatchPhotosArchive(t *testing.T) { r := PerformRequestWithBody(app, "POST", "/api/v1/batch/photos/archive", `{"photos": 123}`) assert.Equal(t, http.StatusBadRequest, r.Code) }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, _ := NewApiTest() + BatchPhotosArchive(router) + + body := `{"photos":["` + strings.Repeat("p", int(MaxSelectionRequestBytes)) + `"]}` + r := PerformRequestWithBody(app, http.MethodPost, "/api/v1/batch/photos/archive", body) + + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) + }) } func TestBatchPhotosRestore(t *testing.T) { @@ -135,6 +145,15 @@ func TestBatchAlbumsDelete(t *testing.T) { r := PerformRequestWithBody(app, "POST", "/api/v1/batch/albums/delete", `{"albums": 123}`) assert.Equal(t, http.StatusBadRequest, r.Code) }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, _ := NewApiTest() + BatchAlbumsDelete(router) + + body := `{"albums":["` + strings.Repeat("a", int(MaxSelectionRequestBytes)) + `"]}` + r := PerformRequestWithBody(app, http.MethodPost, "/api/v1/batch/albums/delete", body) + + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) + }) } func TestBatchPhotosPrivate(t *testing.T) { @@ -197,7 +216,7 @@ func TestBatchLabelsDelete(t *testing.T) { } assert.True(t, resp.Success()) - assert.Equal(t, i18n.Msg(i18n.MsgLabelsDeleted), resp.Msg) + assert.Equal(t, i18n.Msg(i18n.MsgLabelsDeleted), resp.Message) assert.Equal(t, i18n.Msg(i18n.MsgLabelsDeleted), resp.String()) assert.Equal(t, http.StatusOK, r2.Code) assert.Equal(t, http.StatusOK, resp.Code) @@ -220,6 +239,15 @@ func TestBatchLabelsDelete(t *testing.T) { r := PerformRequestWithBody(app, "POST", "/api/v1/batch/labels/delete", `{"labels": 123}`) assert.Equal(t, http.StatusBadRequest, r.Code) }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, _ := NewApiTest() + BatchLabelsDelete(router) + + body := `{"labels":["` + strings.Repeat("l", int(MaxSelectionRequestBytes)) + `"]}` + r := PerformRequestWithBody(app, http.MethodPost, "/api/v1/batch/labels/delete", body) + + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) + }) } func TestBatchPhotosApprove(t *testing.T) { diff --git a/internal/api/cache_test.go b/internal/api/cache_test.go index 141470329..a7cbe48cc 100644 --- a/internal/api/cache_test.go +++ b/internal/api/cache_test.go @@ -59,7 +59,7 @@ func TestRemoveFromAlbumCoverCache(t *testing.T) { cache.Flush() var album entity.Album - if err := query.UnscopedDb().Where("album_type = ? AND thumb_src = ?", entity.AlbumManual, entity.SrcAuto).First(&album).Error; err != nil { + if err := query.Db().Where("album_type = ? AND thumb_src = ?", entity.AlbumManual, entity.SrcAuto).First(&album).Error; err != nil { t.Skipf("no auto-managed manual album available: %v", err) } diff --git a/internal/api/cameras.go b/internal/api/cameras.go new file mode 100644 index 000000000..1c44f1523 --- /dev/null +++ b/internal/api/cameras.go @@ -0,0 +1,81 @@ +package api + +import ( + "net/http" + "strconv" + + "github.com/gin-gonic/gin" + + "github.com/photoprism/photoprism/internal/auth/acl" + "github.com/photoprism/photoprism/internal/entity/query" + "github.com/photoprism/photoprism/internal/form" + "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/i18n" +) + +// UpdateCamera updates camera make and model properties. +// +// PUT /api/v1/cameras/:id +// +// @Summary updates camera name +// @Id UpdateCamera +// @Tags Cameras +// @Accept json +// @Produce json +// @Success 200 {object} entity.Camera +// @Failure 401,403,404,429 {object} i18n.Response +// @Param id path string true "Camera ID" +// @Param camera body form.Camera true "Properties to be updated, only Make and Model supported" +// @Router /api/v1/cameras/{id} [put] +func UpdateCamera(router *gin.RouterGroup) { + router.PUT("/cameras/:id", func(c *gin.Context) { + s := Auth(c, acl.ResourceCameras, acl.ActionUpdate) + + if s.Abort(c) { + return + } + + // Find camera by ID. A non-numeric id parses to 0 and is rejected as not found below, + // so the parse error is intentionally ignored. + cameraId, _ := strconv.ParseUint(clean.Token(c.Param("id")), 10, 32) + m := query.FindCameraByID(uint(cameraId)) + + if m == nil { + Abort(c, http.StatusNotFound, i18n.ErrCameraNotFound) + return + } + + // Create new camera form. + frm, frmErr := form.NewCamera(m) + + if frmErr != nil { + Abort(c, http.StatusBadRequest, i18n.ErrBadRequest) + return + } + + // Set form values from request. + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + + if frmErr = c.BindJSON(frm); frmErr != nil { + if IsRequestBodyTooLarge(frmErr) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + + AbortBadRequest(c, frmErr) + return + } else if frmErr = frm.Validate(); frmErr != nil { + AbortInvalidName(c) + return + } + + // Save camera and return new model values if successful. + if err := m.SaveForm(frm); err != nil { + log.Errorf("camera: %s", clean.Error(err)) + AbortSaveFailed(c) + return + } + + c.JSON(http.StatusOK, m) + }) +} diff --git a/internal/api/cameras_search.go b/internal/api/cameras_search.go new file mode 100644 index 000000000..01a0b054b --- /dev/null +++ b/internal/api/cameras_search.go @@ -0,0 +1,63 @@ +package api + +import ( + "net/http" + + "github.com/gin-gonic/gin" + "github.com/gin-gonic/gin/binding" + + "github.com/photoprism/photoprism/internal/auth/acl" + "github.com/photoprism/photoprism/internal/entity/search" + "github.com/photoprism/photoprism/internal/form" + "github.com/photoprism/photoprism/pkg/txt" +) + +// SearchCameras finds and returns cameras as JSON. +// +// @Summary finds and returns cameras as JSON +// @Id SearchCameras +// @Tags Cameras +// @Produce json +// @Success 200 {array} search.Camera +// @Header 200 {number} X-Count "The actual number of cameras returned" +// @Header 200 {number} X-Limit "The limit of the number of cameras to be returned" +// @Header 200 {number} X-Offset "The offset that was used" +// @Failure 401,429,403,400 {object} i18n.Response +// @Param count query int true "maximum number of results" minimum(1) maximum(100000) +// @Param offset query int false "search result offset" minimum(0) maximum(100000) +// @Param nomake query bool false "show where make is blank" +// @Param q query string false "search query" +// @Router /api/v1/cameras [get] +func SearchCameras(router *gin.RouterGroup) { + router.GET("/cameras", func(c *gin.Context) { + s := Auth(c, acl.ResourceCameras, acl.ActionSearch) + + if s.Abort(c) { + return + } + + var frm form.SearchCameras + + err := c.MustBindWith(&frm, binding.Form) + + if err != nil { + AbortBadRequest(c, err) + return + } + + // Search matching cameras. + result, err := search.Cameras(frm) + + if err != nil { + c.AbortWithStatusJSON(400, gin.H{"error": txt.UpperFirst(err.Error())}) + return + } + + AddCountHeader(c, len(result)) + AddLimitHeader(c, frm.Count) + AddOffsetHeader(c, frm.Offset) + AddTokenHeaders(c, s) + + c.JSON(http.StatusOK, result) + }) +} diff --git a/internal/api/cameras_search_test.go b/internal/api/cameras_search_test.go new file mode 100644 index 000000000..aa099a067 --- /dev/null +++ b/internal/api/cameras_search_test.go @@ -0,0 +1,33 @@ +package api + +import ( + "net/http" + "strconv" + "testing" + + "github.com/tidwall/gjson" + + "github.com/stretchr/testify/assert" +) + +func TestSearchCameras(t *testing.T) { + t.Run("Success", func(t *testing.T) { + app, router, _ := NewApiTest() + SearchCameras(router) + r := PerformRequest(app, "GET", "/api/v1/cameras?count=15") + count := gjson.Get(r.Body.String(), "#") + assert.Greater(t, count.Int(), int64(0)) + assert.Equal(t, http.StatusOK, r.Code) + result := r.Result() + xCount, err := strconv.Atoi(result.Header.Get("X-Count")) + assert.NoError(t, err, "strconv for X-Count failed") + // X-Count must equal the number of records in the body. + assert.Equal(t, int(count.Int()), xCount) + }) + t.Run("InvalidRequest", func(t *testing.T) { + app, router, _ := NewApiTest() + SearchCameras(router) + r := PerformRequest(app, "GET", "/api/v1/cameras?xxx=15") + assert.Equal(t, http.StatusBadRequest, r.Code) + }) +} diff --git a/internal/api/cameras_test.go b/internal/api/cameras_test.go new file mode 100644 index 000000000..11f361255 --- /dev/null +++ b/internal/api/cameras_test.go @@ -0,0 +1,55 @@ +package api + +import ( + "net/http" + "testing" + + "github.com/tidwall/gjson" + + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/entity" +) + +func TestUpdateCamera(t *testing.T) { + t.Run("Success", func(t *testing.T) { + defer func() { + entity.FlushCameraCache() + assert.NoError(t, entity.UnscopedDb().Save(entity.CameraFixtures.Pointer("canon-eos-7d")).Error) + }() + app, router, _ := NewApiTest() + UpdateCamera(router) + r := PerformRequestWithBody(app, "PUT", "/api/v1/cameras/1000002", `{"Make": "Pentax", "Model": "K-1"}`) + val := gjson.Get(r.Body.String(), "Name") + assert.Equal(t, "PENTAX K-1", val.String()) + val2 := gjson.Get(r.Body.String(), "Model") + assert.Equal(t, "K-1", val2.String()) + val3 := gjson.Get(r.Body.String(), "Make") + assert.Equal(t, "PENTAX", val3.String()) + assert.Equal(t, http.StatusOK, r.Code) + }) + t.Run("InvalidRequest", func(t *testing.T) { + app, router, _ := NewApiTest() + UpdateCamera(router) + r := PerformRequestWithBody(app, "PUT", "/api/v1/cameras/1000002", `{"Make": 123, "Model": ""}`) + val := gjson.Get(r.Body.String(), "error") + assert.Equal(t, "Unable to do that", val.String()) + assert.Equal(t, http.StatusBadRequest, r.Code) + }) + t.Run("BadModel", func(t *testing.T) { + app, router, _ := NewApiTest() + UpdateCamera(router) + r := PerformRequestWithBody(app, "PUT", "/api/v1/cameras/1000002", `{"Make": "123", "Model": ""}`) + val := gjson.Get(r.Body.String(), "error") + assert.Equal(t, "Invalid name", val.String()) + assert.Equal(t, http.StatusBadRequest, r.Code) + }) + t.Run("NotFound", func(t *testing.T) { + app, router, _ := NewApiTest() + UpdateCamera(router) + r := PerformRequestWithBody(app, "PUT", "/api/v1/cameras/199000002", `{"Make": "Pentax", "Model": "K-1"}`) + val := gjson.Get(r.Body.String(), "error") + assert.Equal(t, "Camera not found", val.String()) + assert.Equal(t, http.StatusNotFound, r.Code) + }) +} diff --git a/internal/api/cluster_nodes.go b/internal/api/cluster_nodes.go index 54ee05553..74f742325 100644 --- a/internal/api/cluster_nodes.go +++ b/internal/api/cluster_nodes.go @@ -9,10 +9,14 @@ import ( "github.com/gin-gonic/gin" "github.com/photoprism/photoprism/internal/auth/acl" + "github.com/photoprism/photoprism/internal/auth/oidc" + "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/internal/photoprism/get" "github.com/photoprism/photoprism/internal/service/cluster" reg "github.com/photoprism/photoprism/internal/service/cluster/registry" + "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/i18n" "github.com/photoprism/photoprism/pkg/log/status" "github.com/photoprism/photoprism/pkg/txt" ) @@ -188,7 +192,7 @@ func ClusterGetNode(router *gin.RouterGroup) { // @Accept json // @Produce json // @Param uuid path string true "node uuid" -// @Param node body object true "properties to update (Role, Labels, AdvertiseUrl, SiteUrl)" +// @Param node body object true "properties to update (Role, DisplayName, Labels, AdvertiseUrl, SiteUrl, RedirectURIs, AllowGroups, AllowGroupRoles, GroupsFullView)" // @Success 200 {object} cluster.StatusResponse // @Failure 400,401,403,404,429 {object} i18n.Response // @Router /api/v1/cluster/nodes/{uuid} [patch] @@ -216,13 +220,25 @@ func ClusterUpdateNode(router *gin.RouterGroup) { } var req struct { - Role *string `json:"Role"` - Labels map[string]string `json:"Labels"` - AdvertiseUrl *string `json:"AdvertiseUrl"` - SiteUrl *string `json:"SiteUrl"` + Role *string `json:"Role"` + DisplayName *string `json:"DisplayName"` + Labels map[string]string `json:"Labels"` + AdvertiseUrl *string `json:"AdvertiseUrl"` + SiteUrl *string `json:"SiteUrl"` + RedirectURIs *[]string `json:"RedirectURIs"` + AllowGroups *[]string `json:"AllowGroups"` + AllowGroupRoles *map[string]string `json:"AllowGroupRoles"` + GroupsFullView *bool `json:"GroupsFullView"` } + LimitRequestBodyBytes(c, MaxClusterRegisterBytes) + if err := c.ShouldBindJSON(&req); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -252,6 +268,14 @@ func ClusterUpdateNode(router *gin.RouterGroup) { n.Role = role } + // An admin-set DisplayName (SrcManual) pins the value so it survives + // later instance registrations; an empty value un-pins and falls back to + // the instance-reported name. + if req.DisplayName != nil { + n.DisplayName = clean.TypeUnicode(strings.TrimSpace(*req.DisplayName)) + n.NameSrc = entity.SrcManual + } + if req.Labels != nil { n.Labels = req.Labels } @@ -286,6 +310,45 @@ func ClusterUpdateNode(router *gin.RouterGroup) { } } + if req.RedirectURIs != nil { + normalized, err := normalizeRedirectURIs(*req.RedirectURIs) + if err != nil { + AbortBadRequest(c, err) + return + } + // Non-nil slice (even empty) replaces the persisted set; nil is "no change". + n.RedirectURIs = normalized + } + + if req.AllowGroups != nil { + // Non-nil slice (even empty) replaces the persisted set; nil is "no change". + normalized := oidc.MergeGroups(*req.AllowGroups) + if normalized == nil { + normalized = []string{} + } + n.AllowGroups = normalized + } + + if req.AllowGroupRoles != nil { + normalized, err := normalizeAllowGroupRoles(*req.AllowGroupRoles) + if err != nil { + AbortBadRequest(c, err) + return + } + // Non-nil map (even empty) replaces the persisted mapping; nil is "no change". + n.AllowGroupRoles = normalized + } + + if req.GroupsFullView != nil { + n.GroupsFullView = req.GroupsFullView + } + + // An admin edit pins the group config so instance registrations can't + // revert it; clearing all of it un-pins (see registry.applyGroupConfig). + if req.AllowGroups != nil || req.AllowGroupRoles != nil || req.GroupsFullView != nil { + n.GroupsSrc = entity.ClientGroupsSrcManual + } + n.UpdatedAt = time.Now().UTC().Format(time.RFC3339) if err = regy.Put(n); err != nil { @@ -303,6 +366,31 @@ func ClusterUpdateNode(router *gin.RouterGroup) { }) } +// normalizeAllowGroupRoles validates a group → role mapping for an admin node +// PATCH: keys normalize via oidc.NormalizeGroupID (empty dropped) and roles must +// be cluster instance roles, so cluster_admin/visitor/unknown are rejected with an error. +func normalizeAllowGroupRoles(in map[string]string) (map[string]string, error) { + out := make(map[string]string, len(in)) + + for group, roleName := range in { + g := oidc.NormalizeGroupID(group) + + if g == "" { + continue + } + + role, ok := acl.ClusterInstanceRole(roleName) + + if !ok { + return nil, fmt.Errorf("invalid role %s for group %s", clean.LogQuote(roleName), clean.LogQuote(group)) + } + + out[g] = role.String() + } + + return out, nil +} + // ClusterDeleteNode removes a node entry from the registry. // // @Summary delete node by uuid diff --git a/internal/api/cluster_nodes_register.go b/internal/api/cluster_nodes_register.go index db0690294..6c3d12ec3 100644 --- a/internal/api/cluster_nodes_register.go +++ b/internal/api/cluster_nodes_register.go @@ -11,7 +11,9 @@ import ( "github.com/gin-gonic/gin" "github.com/photoprism/photoprism/internal/auth/acl" + "github.com/photoprism/photoprism/internal/auth/oidc" "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/internal/photoprism/get" "github.com/photoprism/photoprism/internal/server/limiter" @@ -21,6 +23,8 @@ import ( "github.com/photoprism/photoprism/internal/service/cluster/theme" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/http/header" + "github.com/photoprism/photoprism/pkg/http/scheme" + "github.com/photoprism/photoprism/pkg/i18n" "github.com/photoprism/photoprism/pkg/log/status" "github.com/photoprism/photoprism/pkg/rnd" ) @@ -78,7 +82,15 @@ func ClusterNodesRegister(router *gin.RouterGroup) { // Parse request. var req cluster.RegisterRequest + LimitRequestBodyBytes(c, MaxClusterRegisterBytes) + if err := c.ShouldBindJSON(&req); err != nil { + if IsRequestBodyTooLarge(err) { + event.AuditWarn([]string{clientIp, string(acl.ResourceCluster), "register", "request too large", status.Error(err)}) + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + event.AuditWarn([]string{clientIp, string(acl.ResourceCluster), "register", "invalid form", status.Error(err)}) AbortBadRequest(c) return @@ -226,6 +238,10 @@ func ClusterNodesRegister(router *gin.RouterGroup) { if s := normalizeSiteURL(req.SiteUrl); s != "" { node.SiteUrl = s } + if dn := clean.TypeUnicode(req.DisplayName); dn != "" { + // Instance-reported name; NameSrc defaults to SrcAuto (""). + node.DisplayName = dn + } if appName != "" { node.AppName = appName } @@ -236,6 +252,8 @@ func ClusterNodesRegister(router *gin.RouterGroup) { node.Theme = nodeTheme } + applyRequestGroupConfig(node, &req) + if requestedUUID != "" { oldUUID := node.UUID if oldUUID != requestedUUID { @@ -318,6 +336,7 @@ func ClusterNodesRegister(router *gin.RouterGroup) { Node: reg.BuildClusterNode(*node, reg.NodeOptsForSession(nil)), Secrets: respSecret, JWKSUrl: buildJWKSURL(conf), + PortalLoginUrl: buildPortalLoginURL(conf), AlreadyRegistered: true, AlreadyProvisioned: node.Database != nil && node.Database.Name != "", } @@ -381,6 +400,13 @@ func ClusterNodesRegister(router *gin.RouterGroup) { n.SiteUrl = s } + if dn := clean.TypeUnicode(req.DisplayName); dn != "" { + // Instance-reported name; NameSrc defaults to SrcAuto (""). + n.DisplayName = dn + } + + applyRequestGroupConfig(n, &req) + // Generate node secret (must satisfy client secret format for entity.Client). n.ClientSecret = rnd.ClientSecret() n.RotatedAt = nowRFC3339() @@ -416,6 +442,7 @@ func ClusterNodesRegister(router *gin.RouterGroup) { Node: reg.BuildClusterNode(*n, reg.NodeOptsForSession(nil)), Secrets: &cluster.RegisterSecrets{ClientSecret: n.ClientSecret, RotatedAt: n.RotatedAt}, JWKSUrl: buildJWKSURL(conf), + PortalLoginUrl: buildPortalLoginURL(conf), AlreadyRegistered: false, AlreadyProvisioned: shouldProvisionDB, } @@ -534,6 +561,139 @@ func validateSiteURL(u string) bool { return false } +// applyRequestGroupConfig copies the instance-declared group admission config +// from the registration request onto the node, normalizing identifiers and +// dropping non-federatable roles. GroupsSrc is set to ClientGroupsSrcNode so +// the registry applies admin-override-wins source precedence, and an instance +// that declares nothing clears only values it previously declared. +func applyRequestGroupConfig(n *reg.Node, req *cluster.RegisterRequest) { + n.AllowGroups = oidc.MergeGroups(req.AllowGroups) + n.AllowGroupRoles = sanitizeAllowGroupRoles(req.AllowGroupRoles) + + if req.GroupsFullView { + v := true + n.GroupsFullView = &v + } else { + n.GroupsFullView = nil + } + + n.GroupsSrc = entity.ClientGroupsSrcNode +} + +// sanitizeAllowGroupRoles normalizes an instance-declared group → role mapping, +// dropping malformed keys and non-instance roles instead of failing the +// registration — declarative env config must not turn a typo into a boot loop. +func sanitizeAllowGroupRoles(in map[string]string) map[string]string { + if len(in) == 0 { + return nil + } + + out := make(map[string]string, len(in)) + + for group, roleName := range in { + g := oidc.NormalizeGroupID(group) + + if g == "" { + continue + } + + role, ok := acl.ClusterInstanceRole(roleName) + + if !ok { + continue + } + + out[g] = role.String() + } + + if len(out) == 0 { + return nil + } + + return out +} + +// buildPortalLoginURL returns the Portal's browser-facing login page URL +// (SiteUrl origin + login route) reported to nodes at registration, so an +// instance can land cluster sign-outs on the Portal login without pinning a +// return_to. A custom absolute LoginUri is returned as-is. +func buildPortalLoginURL(conf *config.Config) string { + if conf == nil { + return "" + } + + path := conf.LoginUri() + + if strings.Contains(path, "://") { + return path + } + + origin := scheme.OriginURL(conf.SiteUrl()) + + if origin == "" { + return "" + } + + if !strings.HasPrefix(path, "/") { + path = "/" + path + } + + return strings.TrimRight(origin, "/") + path +} + +// normalizeRedirectURIs validates each entry and returns a deduplicated slice. +// nil in = nil out ("no change"); non-nil in = non-nil out (replaces the persisted set). +func normalizeRedirectURIs(in []string) ([]string, error) { + if in == nil { + return nil, nil + } + + out := make([]string, 0, len(in)) + seen := make(map[string]struct{}, len(in)) + + for _, raw := range in { + uri := strings.TrimSpace(raw) + if uri == "" { + continue + } + if !validateRedirectURI(uri) { + return nil, fmt.Errorf("invalid redirect uri: %s", clean.Log(uri)) + } + if _, dup := seen[uri]; dup { + continue + } + seen[uri] = struct{}{} + out = append(out, uri) + } + + return out, nil +} + +// validateRedirectURI accepts HTTPS or loopback / cluster-internal HTTP, with a host and no fragment. +func validateRedirectURI(u string) bool { + parsed, err := url.Parse(strings.TrimSpace(u)) + if err != nil || parsed.Scheme == "" || parsed.Host == "" { + return false + } + if parsed.Fragment != "" { + return false + } + + host := strings.ToLower(parsed.Hostname()) + + if parsed.Scheme == "https" { + return true + } + + if parsed.Scheme == "http" { + if host == "localhost" || host == "127.0.0.1" || host == "::1" || isClusterServiceHost(host) { + return true + } + } + + return false +} + // isClusterServiceHost reports whether the host refers to a cluster-internal // service DNS name so that HTTP can be permitted for intra-cluster traffic. func isClusterServiceHost(host string) bool { diff --git a/internal/api/cluster_nodes_register_test.go b/internal/api/cluster_nodes_register_test.go index 7ebfa5873..0240b43cd 100644 --- a/internal/api/cluster_nodes_register_test.go +++ b/internal/api/cluster_nodes_register_test.go @@ -73,6 +73,16 @@ func TestClusterNodesRegister(t *testing.T) { r := PerformRequestWithBody(app, http.MethodPost, "/api/v1/cluster/nodes/register", `{"NodeName":"pp-node-01"}`) assert.Equal(t, http.StatusUnauthorized, r.Code) }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, conf := NewApiTest() + enablePortalAPIs(t, conf) + conf.Options().JoinToken = cluster.ExampleJoinToken + ClusterNodesRegister(router) + + body := `{"NodeName":"pp-node-big","Labels":{"env":"` + strings.Repeat("a", 300*1024) + `"}}` + r := AuthenticatedRequestWithBody(app, http.MethodPost, "/api/v1/cluster/nodes/register", body, cluster.ExampleJoinToken) + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) + }) t.Run("ClusterCIDRBlocksClientIPOutsideRange", func(t *testing.T) { app, router, conf := NewApiTest() enablePortalAPIs(t, conf) @@ -552,6 +562,158 @@ func oauthNodeAccessTokenWithScope(t testing.TB, app http.Handler, router *gin.R return gjson.Get(w.Body.String(), "access_token").String() } +// TestBuildPortalLoginURL covers the browser-facing Portal login URL reported +// to nodes at registration: SiteUrl origin + login route, with an absolute +// custom LoginUri returned as-is. +func TestBuildPortalLoginURL(t *testing.T) { + t.Run("Success", func(t *testing.T) { + _, _, conf := NewApiTest() + prevSite, prevLogin := conf.Options().SiteUrl, conf.Options().LoginUri + t.Cleanup(func() { conf.Options().SiteUrl, conf.Options().LoginUri = prevSite, prevLogin }) + + conf.Options().SiteUrl = "https://app.example.com/" + conf.Options().LoginUri = "" + assert.Equal(t, "https://app.example.com"+conf.LoginUri(), buildPortalLoginURL(conf)) + }) + t.Run("AbsoluteLoginUri", func(t *testing.T) { + _, _, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + prevLogin := conf.Options().LoginUri + t.Cleanup(func() { + conf.Options().LoginUri = prevLogin + conf.SetAuthMode(config.AuthModePublic) + }) + + conf.Options().LoginUri = "https://sso.example.com/login" + assert.Equal(t, "https://sso.example.com/login", buildPortalLoginURL(conf)) + }) + t.Run("Nil", func(t *testing.T) { + assert.Equal(t, "", buildPortalLoginURL(nil)) + }) +} + +// TestSanitizeAllowGroupRoles validates the lenient registration-time mapping +// sanitizer: malformed keys and non-federatable roles are dropped, not errors. +func TestSanitizeAllowGroupRoles(t *testing.T) { + t.Run("AcceptsAllInstanceRoles", func(t *testing.T) { + out := sanitizeAllowGroupRoles(map[string]string{ + "g-admin": "admin", "g-manager": "manager", "g-user": "user", + "g-contributor": "contributor", "g-viewer": "viewer", "g-guest": "guest", + }) + assert.Equal(t, map[string]string{ + "g-admin": "admin", "g-manager": "manager", "g-user": "user", + "g-contributor": "contributor", "g-viewer": "viewer", "g-guest": "guest", + }, out) + }) + t.Run("DropsInvalidEntries", func(t *testing.T) { + out := sanitizeAllowGroupRoles(map[string]string{"a": "cluster_admin", "b": "visitor", "c": "bogus", " ": "admin"}) + assert.Nil(t, out) + }) + t.Run("Empty", func(t *testing.T) { + assert.Nil(t, sanitizeAllowGroupRoles(nil)) + }) +} + +// TestClusterNodesRegister_GroupConfig covers the declarative per-node group +// config: a registration declares the policy, an admin PATCH pins it against +// re-registration, and clearing the admin override lets the declared config +// repopulate on the next registration. +func TestClusterNodesRegister_GroupConfig(t *testing.T) { + app, router, conf := NewApiTest() + enablePortalAPIs(t, conf) + conf.Options().JoinToken = cluster.ExampleJoinToken + ClusterNodesRegister(router) + ClusterUpdateNode(router) + + groupData := func(uuid string) *entity.ClientData { + client := entity.FindClientByNodeUUID(uuid) + if client == nil { + t.Fatalf("client for node %s not found", uuid) + } + return client.GetData() + } + + // A new node declares its group config at join; invalid roles are dropped. + body := `{"NodeName":"pp-groups","AllowGroups":["Media-Acme-Viewer"],"AllowGroupRoles":{"Media-Acme-Admin":"admin","Bad":"cluster_admin"},"GroupsFullView":true}` + r := AuthenticatedRequestWithBody(app, http.MethodPost, "/api/v1/cluster/nodes/register", body, cluster.ExampleJoinToken) + assert.Equal(t, http.StatusCreated, r.Code, "body=%s", r.Body.String()) + cleanupRegisterProvisioning(t, conf, r) + + regy, err := reg.NewClientRegistryWithConfig(conf) + assert.NoError(t, err) + n, err := regy.FindByName("pp-groups") + assert.NoError(t, err) + + t.Run("DeclaredAtJoin", func(t *testing.T) { + data := groupData(n.UUID) + assert.Equal(t, []string{"media-acme-viewer"}, data.AllowGroups) + assert.Equal(t, map[string]string{"media-acme-admin": "admin"}, data.AllowGroupRoles, "non-federatable roles must be dropped") + assert.True(t, data.GroupsFullView) + assert.Equal(t, entity.ClientGroupsSrcNode, data.GroupsSrc) + }) + + // Subsequent registrations need the node's own OAuth credentials, and the + // admin PATCH calls need a session since the token helper switches the + // test config to password-auth mode. + nr, err := regy.RotateSecret(n.UUID) + assert.NoError(t, err) + token := oauthNodeAccessToken(t, app, router, conf, nr.ClientID, nr.ClientSecret) + adminToken := AuthenticateAdmin(app, router) + + t.Run("RedeclaredOnReRegister", func(t *testing.T) { + body := `{"NodeName":"pp-groups","AllowGroups":["Media-Acme-User"]}` + r := AuthenticatedRequestWithBody(app, http.MethodPost, "/api/v1/cluster/nodes/register", body, token) + assert.Equal(t, http.StatusOK, r.Code, "body=%s", r.Body.String()) + cleanupRegisterProvisioning(t, conf, r) + + data := groupData(n.UUID) + assert.Equal(t, []string{"media-acme-user"}, data.AllowGroups) + assert.Empty(t, data.AllowGroupRoles, "a declaration replaces the config wholesale") + assert.False(t, data.GroupsFullView) + }) + t.Run("AdminOverrideSurvivesReRegister", func(t *testing.T) { + r := AuthenticatedRequestWithBody(app, http.MethodPatch, "/api/v1/cluster/nodes/"+n.UUID, + `{"AllowGroups":["media-acme-pinned"],"AllowGroupRoles":{"media-acme-pinned":"guest"}}`, adminToken) + assert.Equal(t, http.StatusOK, r.Code, "body=%s", r.Body.String()) + + body := `{"NodeName":"pp-groups","AllowGroups":["Media-Acme-User"],"GroupsFullView":true}` + r = AuthenticatedRequestWithBody(app, http.MethodPost, "/api/v1/cluster/nodes/register", body, token) + assert.Equal(t, http.StatusOK, r.Code, "body=%s", r.Body.String()) + cleanupRegisterProvisioning(t, conf, r) + + data := groupData(n.UUID) + assert.Equal(t, []string{"media-acme-pinned"}, data.AllowGroups, "re-registration must not clobber an admin override") + assert.Equal(t, map[string]string{"media-acme-pinned": "guest"}, data.AllowGroupRoles) + assert.False(t, data.GroupsFullView) + assert.Equal(t, entity.ClientGroupsSrcManual, data.GroupsSrc) + }) + t.Run("ClearedOverrideRepopulates", func(t *testing.T) { + r := AuthenticatedRequestWithBody(app, http.MethodPatch, "/api/v1/cluster/nodes/"+n.UUID, + `{"AllowGroups":[],"AllowGroupRoles":{},"GroupsFullView":false}`, adminToken) + assert.Equal(t, http.StatusOK, r.Code, "body=%s", r.Body.String()) + assert.Equal(t, "", groupData(n.UUID).GroupsSrc, "a fully cleared manual config must un-pin") + + body := `{"NodeName":"pp-groups","AllowGroups":["Media-Acme-User"]}` + r = AuthenticatedRequestWithBody(app, http.MethodPost, "/api/v1/cluster/nodes/register", body, token) + assert.Equal(t, http.StatusOK, r.Code, "body=%s", r.Body.String()) + cleanupRegisterProvisioning(t, conf, r) + + data := groupData(n.UUID) + assert.Equal(t, []string{"media-acme-user"}, data.AllowGroups) + assert.Equal(t, entity.ClientGroupsSrcNode, data.GroupsSrc) + }) + t.Run("EmptyDeclarationClears", func(t *testing.T) { + body := `{"NodeName":"pp-groups"}` + r := AuthenticatedRequestWithBody(app, http.MethodPost, "/api/v1/cluster/nodes/register", body, token) + assert.Equal(t, http.StatusOK, r.Code, "body=%s", r.Body.String()) + cleanupRegisterProvisioning(t, conf, r) + + data := groupData(n.UUID) + assert.Empty(t, data.AllowGroups, "an instance that stops declaring a config clears it") + assert.Equal(t, "", data.GroupsSrc) + }) +} + // TestValidateAdvertiseURL ensures the validator accepts HTTP and HTTPS for advertise URLs. func TestValidateAdvertiseURL(t *testing.T) { cases := []struct { diff --git a/internal/api/cluster_nodes_test.go b/internal/api/cluster_nodes_test.go index bcca5b869..7982d8aa5 100644 --- a/internal/api/cluster_nodes_test.go +++ b/internal/api/cluster_nodes_test.go @@ -2,10 +2,12 @@ package api import ( "net/http" + "strings" "testing" "github.com/stretchr/testify/assert" + "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/service/cluster" reg "github.com/photoprism/photoprism/internal/service/cluster/registry" "github.com/photoprism/photoprism/pkg/rnd" @@ -140,3 +142,279 @@ func TestClusterUpdateNode_UUIDValidation(t *testing.T) { r = PerformRequestWithBody(app, http.MethodPatch, "/api/v1/cluster/nodes/BadID", `{"SiteUrl":"https://photos.example.com"}`) assert.Equal(t, http.StatusNotFound, r.Code) } + +// TestClusterUpdateNode_RedirectURIs_Apply exercises the v1 path where the +// Portal admin writes a fresh RedirectURIs set to a registered node. After +// the PATCH lands, GET must echo the persisted set so the OIDC OP authorize +// handler can find them via client.GetData().RedirectURIs. +func TestClusterUpdateNode_RedirectURIs_Apply(t *testing.T) { + app, router, conf := NewApiTest() + enablePortalAPIs(t, conf) + + ClusterGetNode(router) + ClusterUpdateNode(router) + + regy, err := reg.NewClientRegistryWithConfig(conf) + assert.NoError(t, err) + + n := ®.Node{Node: cluster.Node{Name: "pp-node-redirects", Role: cluster.RoleInstance, UUID: rnd.UUIDv7()}} + assert.NoError(t, regy.Put(n)) + n, err = regy.FindByName("pp-node-redirects") + assert.NoError(t, err) + + body := `{"RedirectURIs":["https://photos.example.com/api/v1/oidc/redirect","http://127.0.0.1:2342/api/v1/oidc/redirect"]}` + r := PerformRequestWithBody(app, http.MethodPatch, "/api/v1/cluster/nodes/"+n.UUID, body) + assert.Equal(t, http.StatusOK, r.Code, "body=%s", r.Body.String()) + + r = PerformRequest(app, http.MethodGet, "/api/v1/cluster/nodes/"+n.UUID) + assert.Equal(t, http.StatusOK, r.Code) + assert.Contains(t, r.Body.String(), `"https://photos.example.com/api/v1/oidc/redirect"`) + assert.Contains(t, r.Body.String(), `"http://127.0.0.1:2342/api/v1/oidc/redirect"`) +} + +// TestClusterUpdateNode_RedirectURIs_Replace_And_Clear confirms that a +// non-nil slice replaces the persisted set (including the cleared case +// where the slice is empty). +func TestClusterUpdateNode_RedirectURIs_Replace_And_Clear(t *testing.T) { + app, router, conf := NewApiTest() + enablePortalAPIs(t, conf) + + ClusterGetNode(router) + ClusterUpdateNode(router) + + regy, err := reg.NewClientRegistryWithConfig(conf) + assert.NoError(t, err) + + n := ®.Node{Node: cluster.Node{Name: "pp-node-replace", Role: cluster.RoleInstance, UUID: rnd.UUIDv7()}} + assert.NoError(t, regy.Put(n)) + n, err = regy.FindByName("pp-node-replace") + assert.NoError(t, err) + + // Seed two redirect URIs. + r := PerformRequestWithBody(app, http.MethodPatch, "/api/v1/cluster/nodes/"+n.UUID, + `{"RedirectURIs":["https://a.example.com/cb","https://b.example.com/cb"]}`) + assert.Equal(t, http.StatusOK, r.Code) + + // Replace with a single entry — the old ones must be gone. + r = PerformRequestWithBody(app, http.MethodPatch, "/api/v1/cluster/nodes/"+n.UUID, + `{"RedirectURIs":["https://c.example.com/cb"]}`) + assert.Equal(t, http.StatusOK, r.Code) + + r = PerformRequest(app, http.MethodGet, "/api/v1/cluster/nodes/"+n.UUID) + assert.Equal(t, http.StatusOK, r.Code) + assert.Contains(t, r.Body.String(), `"https://c.example.com/cb"`) + assert.NotContains(t, r.Body.String(), `"https://a.example.com/cb"`) + assert.NotContains(t, r.Body.String(), `"https://b.example.com/cb"`) + + // Clear via empty slice. Non-nil, zero length means "remove all". + r = PerformRequestWithBody(app, http.MethodPatch, "/api/v1/cluster/nodes/"+n.UUID, + `{"RedirectURIs":[]}`) + assert.Equal(t, http.StatusOK, r.Code) + + r = PerformRequest(app, http.MethodGet, "/api/v1/cluster/nodes/"+n.UUID) + assert.Equal(t, http.StatusOK, r.Code) + assert.NotContains(t, r.Body.String(), `"RedirectURIs"`, "empty slice must drop the field via omitempty") +} + +// TestNormalizeAllowGroupRoles validates the PATCH-time group → role mapping +// helper: keys are normalized, empty keys dropped, and role values must be +// federatable instance roles. +func TestNormalizeAllowGroupRoles(t *testing.T) { + t.Run("AcceptsAllInstanceRoles", func(t *testing.T) { + out, err := normalizeAllowGroupRoles(map[string]string{ + "Media-Acme-Admin": "admin", "Media-Acme-Manager": "manager", "Media-Acme-User": "user", + "Media-Acme-Contributor": "contributor", "Media-Acme-Viewer": "viewer", "Media-Acme-Guest": "guest", + " ": "admin", + }) + assert.NoError(t, err) + assert.Equal(t, map[string]string{ + "media-acme-admin": "admin", "media-acme-manager": "manager", "media-acme-user": "user", + "media-acme-contributor": "contributor", "media-acme-viewer": "viewer", "media-acme-guest": "guest", + }, out) + }) + t.Run("InvalidRole", func(t *testing.T) { + for _, role := range []string{"cluster_admin", "visitor", "none", "bogus", ""} { + _, err := normalizeAllowGroupRoles(map[string]string{"media-acme-x": role}) + assert.Error(t, err, "role %q must be rejected", role) + } + }) +} + +// TestClusterUpdateNode_GroupRules covers the group-based admission config on +// PATCH: AllowGroups apply/replace/clear with normalization, AllowGroupRoles +// role validation, and the GroupsFullView opt-in round-trip. +func TestClusterUpdateNode_GroupRules(t *testing.T) { + app, router, conf := NewApiTest() + enablePortalAPIs(t, conf) + + ClusterGetNode(router) + ClusterUpdateNode(router) + + regy, err := reg.NewClientRegistryWithConfig(conf) + assert.NoError(t, err) + + n := ®.Node{Node: cluster.Node{Name: "pp-node-groups", Role: cluster.RoleInstance, UUID: rnd.UUIDv7()}} + assert.NoError(t, regy.Put(n)) + n, err = regy.FindByName("pp-node-groups") + assert.NoError(t, err) + + t.Run("Apply", func(t *testing.T) { + body := `{"AllowGroups":["Media-Acme-Admin","Media-Acme-Viewer"],"AllowGroupRoles":{"Media-Acme-Admin":"admin"},"GroupsFullView":true}` + r := PerformRequestWithBody(app, http.MethodPatch, "/api/v1/cluster/nodes/"+n.UUID, body) + assert.Equal(t, http.StatusOK, r.Code, "body=%s", r.Body.String()) + + client := entity.FindClientByNodeUUID(n.UUID) + assert.NotNil(t, client) + data := client.GetData() + assert.Equal(t, []string{"media-acme-admin", "media-acme-viewer"}, data.AllowGroups, "stored groups must be normalized") + assert.Equal(t, map[string]string{"media-acme-admin": "admin"}, data.AllowGroupRoles) + assert.True(t, data.GroupsFullView) + + r = PerformRequest(app, http.MethodGet, "/api/v1/cluster/nodes/"+n.UUID) + assert.Equal(t, http.StatusOK, r.Code) + assert.Contains(t, r.Body.String(), `"media-acme-admin"`) + assert.Contains(t, r.Body.String(), `"GroupsFullView":true`) + }) + t.Run("OmittedFieldsUnchanged", func(t *testing.T) { + r := PerformRequestWithBody(app, http.MethodPatch, "/api/v1/cluster/nodes/"+n.UUID, `{"DisplayName":"Groups Node"}`) + assert.Equal(t, http.StatusOK, r.Code) + + data := entity.FindClientByNodeUUID(n.UUID).GetData() + assert.Equal(t, []string{"media-acme-admin", "media-acme-viewer"}, data.AllowGroups) + assert.True(t, data.GroupsFullView) + }) + t.Run("ReplaceAndClear", func(t *testing.T) { + r := PerformRequestWithBody(app, http.MethodPatch, "/api/v1/cluster/nodes/"+n.UUID, + `{"AllowGroups":["Media-Acme-User"],"AllowGroupRoles":{},"GroupsFullView":false}`) + assert.Equal(t, http.StatusOK, r.Code) + + data := entity.FindClientByNodeUUID(n.UUID).GetData() + assert.Equal(t, []string{"media-acme-user"}, data.AllowGroups) + assert.Empty(t, data.AllowGroupRoles) + assert.False(t, data.GroupsFullView) + + r = PerformRequestWithBody(app, http.MethodPatch, "/api/v1/cluster/nodes/"+n.UUID, `{"AllowGroups":[]}`) + assert.Equal(t, http.StatusOK, r.Code) + + data = entity.FindClientByNodeUUID(n.UUID).GetData() + assert.Empty(t, data.AllowGroups, "empty slice must clear the persisted set") + + r = PerformRequest(app, http.MethodGet, "/api/v1/cluster/nodes/"+n.UUID) + assert.Equal(t, http.StatusOK, r.Code) + assert.NotContains(t, r.Body.String(), `"AllowGroups"`, "cleared set must drop the field via omitempty") + assert.NotContains(t, r.Body.String(), `"GroupsFullView"`, "false opt-in must drop the field via omitempty") + }) + t.Run("InvalidRole", func(t *testing.T) { + r := PerformRequestWithBody(app, http.MethodPatch, "/api/v1/cluster/nodes/"+n.UUID, + `{"AllowGroupRoles":{"Media-Acme-Operators":"cluster_admin"}}`) + assert.Equal(t, http.StatusBadRequest, r.Code, "body=%s", r.Body.String()) + }) +} + +// TestClusterUpdateNode_RedirectURIs_Invalid rejects malformed entries with +// 400. Validation policy mirrors validateSiteURL: HTTPS always, HTTP only +// on loopback / cluster-internal hosts, no fragment. +func TestClusterUpdateNode_RedirectURIs_Invalid(t *testing.T) { + app, router, conf := NewApiTest() + enablePortalAPIs(t, conf) + + ClusterUpdateNode(router) + + regy, err := reg.NewClientRegistryWithConfig(conf) + assert.NoError(t, err) + n := ®.Node{Node: cluster.Node{Name: "pp-node-invalid", Role: cluster.RoleInstance, UUID: rnd.UUIDv7()}} + assert.NoError(t, regy.Put(n)) + n, _ = regy.FindByName("pp-node-invalid") + + cases := []struct { + name string + body string + }{ + {"NotAbsolute", `{"RedirectURIs":["/relative/cb"]}`}, + {"FtpScheme", `{"RedirectURIs":["ftp://example.com/cb"]}`}, + {"HttpNonLoopback", `{"RedirectURIs":["http://photos.example.com/cb"]}`}, + {"WithFragment", `{"RedirectURIs":["https://example.com/cb#frag"]}`}, + {"NoHost", `{"RedirectURIs":["https://"]}`}, + } + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + r := PerformRequestWithBody(app, http.MethodPatch, "/api/v1/cluster/nodes/"+n.UUID, tc.body) + assert.Equal(t, http.StatusBadRequest, r.Code, "body=%s", r.Body.String()) + }) + } +} + +func TestNormalizeRedirectURIs(t *testing.T) { + t.Run("NilInputNoChange", func(t *testing.T) { + out, err := normalizeRedirectURIs(nil) + assert.NoError(t, err) + assert.Nil(t, out) + }) + t.Run("EmptyInputReturnsEmpty", func(t *testing.T) { + out, err := normalizeRedirectURIs([]string{}) + assert.NoError(t, err) + assert.NotNil(t, out) + assert.Len(t, out, 0) + }) + t.Run("WhitespaceTrimmed", func(t *testing.T) { + out, err := normalizeRedirectURIs([]string{" https://example.com/cb "}) + assert.NoError(t, err) + assert.Equal(t, []string{"https://example.com/cb"}, out) + }) + t.Run("DropsDuplicates", func(t *testing.T) { + out, err := normalizeRedirectURIs([]string{ + "https://example.com/cb", + "https://example.com/cb", + }) + assert.NoError(t, err) + assert.Equal(t, []string{"https://example.com/cb"}, out) + }) + t.Run("AllowsLoopbackHTTP", func(t *testing.T) { + out, err := normalizeRedirectURIs([]string{"http://127.0.0.1:2342/cb"}) + assert.NoError(t, err) + assert.Equal(t, []string{"http://127.0.0.1:2342/cb"}, out) + }) + t.Run("AllowsClusterInternalHTTP", func(t *testing.T) { + out, err := normalizeRedirectURIs([]string{"http://photoprism.svc.cluster.local/cb"}) + assert.NoError(t, err) + assert.Equal(t, []string{"http://photoprism.svc.cluster.local/cb"}, out) + }) +} + +func TestValidateRedirectURI(t *testing.T) { + cases := []struct { + uri string + ok bool + }{ + {"https://example.com/cb", true}, + {"http://localhost:2342/cb", true}, + {"http://127.0.0.1/cb", true}, + {"http://photoprism.svc/cb", true}, + {"http://example.com/cb", false}, + {"https://example.com/cb#frag", false}, + {"ftp://example.com/cb", false}, + {"/relative", false}, + {"", false}, + } + for _, tc := range cases { + assert.Equal(t, tc.ok, validateRedirectURI(tc.uri), "uri=%q", tc.uri) + } +} + +func TestClusterUpdateNode_RequestTooLarge(t *testing.T) { + app, router, conf := NewApiTest() + enablePortalAPIs(t, conf) + + ClusterUpdateNode(router) + + regy, err := reg.NewClientRegistryWithConfig(conf) + assert.NoError(t, err) + + n := ®.Node{Node: cluster.Node{Name: "pp-node-request-limit", Role: cluster.RoleInstance, UUID: rnd.UUIDv7()}} + assert.NoError(t, regy.Put(n)) + + body := `{"Labels":{"oversized":"` + strings.Repeat("a", int(MaxClusterRegisterBytes)) + `"}}` + r := PerformRequestWithBody(app, http.MethodPatch, "/api/v1/cluster/nodes/"+n.UUID, body) + + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) +} diff --git a/internal/api/config_options.go b/internal/api/config_options.go index ac5783ec8..f07be28ce 100644 --- a/internal/api/config_options.go +++ b/internal/api/config_options.go @@ -9,6 +9,7 @@ import ( "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/mutex" "github.com/photoprism/photoprism/internal/photoprism/get" + "github.com/photoprism/photoprism/pkg/i18n" ) // GetConfigOptions returns backend config options. @@ -58,7 +59,14 @@ func SaveConfigOptions(router *gin.RouterGroup) { v := make(entity.Values) + LimitRequestBodyBytes(c, MaxSettingsRequestBytes) + if err := c.BindJSON(&v); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } diff --git a/internal/api/config_options_test.go b/internal/api/config_options_test.go index c57262bf4..fa9e56974 100644 --- a/internal/api/config_options_test.go +++ b/internal/api/config_options_test.go @@ -4,6 +4,7 @@ import ( "net/http" "os" "path/filepath" + "strings" "testing" "github.com/tidwall/gjson" @@ -101,6 +102,19 @@ func TestSaveConfigOptions(t *testing.T) { assert.Equal(t, "https://photos.example.com/", merged["SiteUrl"]) assert.Equal(t, true, merged["HttpCachePublic"]) }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, conf := NewApiTest() + + SaveConfigOptions(router) + + prepareConfigOptionsSuccessTest(t, conf) + + authToken := AuthenticateAdmin(app, router) + body := `{"SiteUrl":"https://photos.example.com/","LogLevel":"` + strings.Repeat("a", int(MaxSettingsRequestBytes)) + `"}` + r := AuthenticatedRequestWithBody(app, "POST", "/api/v1/config/options", body, authToken) + + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) + }) } // prepareConfigOptionsSuccessTest normalizes shared config state so the success diff --git a/internal/api/config_settings.go b/internal/api/config_settings.go index f0dddf154..fb154be47 100644 --- a/internal/api/config_settings.go +++ b/internal/api/config_settings.go @@ -85,7 +85,14 @@ func SaveSettings(router *gin.RouterGroup) { settings = conf.Settings() // Set values from request. + LimitRequestBodyBytes(c, MaxSettingsRequestBytes) + if err := c.BindJSON(settings); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -112,7 +119,14 @@ func SaveSettings(router *gin.RouterGroup) { settings = &customize.Settings{} // Set values from request. + LimitRequestBodyBytes(c, MaxSettingsRequestBytes) + if err := c.BindJSON(settings); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } diff --git a/internal/api/config_settings_test.go b/internal/api/config_settings_test.go index 032867c8c..52444e2c0 100644 --- a/internal/api/config_settings_test.go +++ b/internal/api/config_settings_test.go @@ -2,6 +2,7 @@ package api import ( "net/http" + "strings" "testing" "github.com/stretchr/testify/assert" @@ -50,4 +51,13 @@ func TestSaveSettings(t *testing.T) { r := PerformRequestWithBody(app, "POST", "/api/v1/settings", `{"ui":{"language":123}}`) assert.Equal(t, http.StatusBadRequest, r.Code) }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, _ := NewApiTest() + + SaveSettings(router) + + body := `{"ui":{"language":"` + strings.Repeat("a", 300*1024) + `"}}` + r := PerformRequestWithBody(app, "POST", "/api/v1/settings", body) + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) + }) } diff --git a/internal/api/connect.go b/internal/api/connect.go index 434c3f2d7..874dcf7a2 100644 --- a/internal/api/connect.go +++ b/internal/api/connect.go @@ -38,14 +38,22 @@ func Connect(router *gin.RouterGroup) { var frm form.Connect // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxAuthRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + log.Warnf("connect: request too large (%s)", clean.Log(name)) + AbortRequestTooLarge(c, i18n.ErrAccountConnect) + return + } + log.Warnf("connect: invalid form values (%s)", clean.Log(name)) Abort(c, http.StatusBadRequest, i18n.ErrAccountConnect) return } if frm.Invalid() { - log.Warnf("connect: invalid token %s", clean.Log(frm.Token)) + log.Warnf("connect: invalid connect token (%s)", clean.Log(name)) Abort(c, http.StatusBadRequest, i18n.ErrAccountConnect) return } diff --git a/internal/api/connect_test.go b/internal/api/connect_test.go index fb24bfc6c..120b666c2 100644 --- a/internal/api/connect_test.go +++ b/internal/api/connect_test.go @@ -1,6 +1,8 @@ package api import ( + "net/http" + "strings" "testing" "github.com/stretchr/testify/assert" @@ -43,4 +45,13 @@ func TestConnect(t *testing.T) { r := PerformRequestWithBody(app, "PUT", "/api/v1/connect/hub/", `{"Token": "foobar123"}`) assert.NotEqual(t, 200, r.Code) }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, _ := NewApiTest() + Connect(router) + + body := `{"Token":"` + strings.Repeat("a", int(MaxAuthRequestBytes)) + `"}` + r := PerformRequestWithBody(app, http.MethodPut, "/api/v1/connect/hub", body) + + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) + }) } diff --git a/internal/api/download.go b/internal/api/download.go index 5fb90e9a6..601d584cf 100644 --- a/internal/api/download.go +++ b/internal/api/download.go @@ -13,6 +13,7 @@ import ( "github.com/photoprism/photoprism/internal/photoprism/get" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/i18n" "github.com/photoprism/photoprism/pkg/rnd" ) @@ -73,7 +74,7 @@ func GetDownload(router *gin.RouterGroup) { f, err := query.FileByHash(id) if err != nil { - c.AbortWithStatusJSON(404, gin.H{"error": err.Error()}) + Abort(c, http.StatusNotFound, i18n.ErrFileNotFound) return } diff --git a/internal/api/download/download.go b/internal/api/download/download.go index 3c73497fd..269024cef 100644 --- a/internal/api/download/download.go +++ b/internal/api/download/download.go @@ -1,7 +1,7 @@ /* Package download allows to register files so that they can be temporarily made available for download. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/api/download/download_test.go b/internal/api/download/download_test.go index dd273bba7..481cbaada 100644 --- a/internal/api/download/download_test.go +++ b/internal/api/download/download_test.go @@ -10,7 +10,12 @@ import ( "github.com/photoprism/photoprism/pkg/fs" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) int { // Init test logger. log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) @@ -18,7 +23,5 @@ func TestMain(m *testing.M) { AllowedPaths = append(AllowedPaths, fs.Abs("./testdata")) // Run unit tests. - code := m.Run() - - os.Exit(code) + return m.Run() } diff --git a/internal/api/download_test.go b/internal/api/download_test.go index 7d7d9b5a4..c34ec9bbf 100644 --- a/internal/api/download_test.go +++ b/internal/api/download_test.go @@ -51,7 +51,7 @@ func TestGetDownload(t *testing.T) { GetDownload(router) r := PerformRequest(app, "GET", "/api/v1/dl/123xxx?t="+conf.DownloadToken()) val := gjson.Get(r.Body.String(), "error") - assert.Equal(t, "record not found", val.String()) + assert.Equal(t, "File not found", val.String()) assert.Equal(t, http.StatusNotFound, r.Code) }) t.Run("MissingOriginal", func(t *testing.T) { diff --git a/internal/api/errors.go b/internal/api/errors.go index 5d8338c75..57694e7f8 100644 --- a/internal/api/errors.go +++ b/internal/api/errors.go @@ -19,6 +19,9 @@ import ( // @Tags Logs // @Produce json // @Success 200 {object} entity.Error +// @Header 200 {number} X-Count "The actual number of errors returned" +// @Header 200 {number} X-Limit "The limit of the number of errors to be returned" +// @Header 200 {number} X-Offset "The offset that was used" // @Failure 401,403,429,400 {object} i18n.Response // @Param count query int true "maximum number of results" minimum(1) maximum(100000) // @Param offset query int false "search result offset" minimum(0) maximum(100000) diff --git a/internal/api/faces.go b/internal/api/faces.go index bd3832148..b068de669 100644 --- a/internal/api/faces.go +++ b/internal/api/faces.go @@ -69,7 +69,14 @@ func UpdateFace(router *gin.RouterGroup) { var frm form.Face // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } diff --git a/internal/api/faces_search.go b/internal/api/faces_search.go index 76923d539..36b986382 100644 --- a/internal/api/faces_search.go +++ b/internal/api/faces_search.go @@ -19,6 +19,9 @@ import ( // @Tags Faces // @Produce json // @Success 200 {object} search.FaceResults +// @Header 200 {number} X-Count "The actual number of faces returned" +// @Header 200 {number} X-Limit "The limit of the number of faces to be returned" +// @Header 200 {number} X-Offset "The offset that was used" // @Failure 400,401,403,429,404 {object} i18n.Response // @Param count query int true "maximum number of results" minimum(1) maximum(100000) // @Param offset query int false "search result offset" minimum(0) maximum(100000) diff --git a/internal/api/file_delete.go b/internal/api/file_delete.go index 2c88875e9..ee00f8b98 100644 --- a/internal/api/file_delete.go +++ b/internal/api/file_delete.go @@ -8,6 +8,7 @@ import ( "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/internal/entity/query" + "github.com/photoprism/photoprism/internal/entity/search" "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/internal/photoprism" "github.com/photoprism/photoprism/internal/photoprism/get" @@ -54,6 +55,15 @@ func DeleteFile(router *gin.RouterGroup) { return } + // Limit the deletion to the file's photo within the session's shared scope. Gating on the + // file's own PhotoUID (not the path :uid) prevents pairing an in-scope :uid with an out-of-scope file. + if !search.PhotoSessionSeesEverything(s) { + if visible, vErr := search.PhotoVisibleToSession(file.PhotoUID, s); vErr != nil || !visible { + AbortForbidden(c) + return + } + } + // Primary file? if file.FilePrimary { log.Errorf("files: cannot delete primary file") @@ -93,7 +103,7 @@ func DeleteFile(router *gin.RouterGroup) { } // Notify clients by publishing events. - PublishPhotoEvent(StatusUpdated, photoUid, c) + PublishPhotoEvent(StatusUpdated, photoUid) // Show translated success message. event.SuccessMsg(i18n.MsgFileDeleted) diff --git a/internal/api/file_orientation.go b/internal/api/file_orientation.go index d0316478a..e37616e45 100644 --- a/internal/api/file_orientation.go +++ b/internal/api/file_orientation.go @@ -7,6 +7,7 @@ import ( "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/internal/entity/query" + "github.com/photoprism/photoprism/internal/entity/search" "github.com/photoprism/photoprism/internal/form" "github.com/photoprism/photoprism/internal/photoprism" "github.com/photoprism/photoprism/internal/photoprism/get" @@ -57,6 +58,15 @@ func ChangeFileOrientation(router *gin.RouterGroup) { return } + // Limit the edit to the file's photo within the session's shared scope. Gating on the file's + // own PhotoUID (not the path :uid) prevents pairing an in-scope :uid with an out-of-scope file. + if !search.PhotoSessionSeesEverything(s) { + if visible, vErr := search.PhotoVisibleToSession(m.PhotoUID, s); vErr != nil || !visible { + AbortForbidden(c) + return + } + } + // Init form with model values frm, err := form.NewFile(m) @@ -66,7 +76,14 @@ func ChangeFileOrientation(router *gin.RouterGroup) { } // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + if err = c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + Abort(c, http.StatusBadRequest, i18n.ErrBadRequest) return } @@ -106,7 +123,7 @@ func ChangeFileOrientation(router *gin.RouterGroup) { return } - PublishPhotoEvent(StatusUpdated, m.PhotoUID, c) + PublishPhotoEvent(StatusUpdated, m.PhotoUID) c.JSON(http.StatusOK, p) }) diff --git a/internal/api/files.go b/internal/api/files.go index 0ebb929d8..a671a456a 100644 --- a/internal/api/files.go +++ b/internal/api/files.go @@ -7,6 +7,7 @@ import ( "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/internal/entity/query" + "github.com/photoprism/photoprism/internal/entity/search" "github.com/photoprism/photoprism/pkg/clean" ) @@ -29,7 +30,16 @@ func GetFile(router *gin.RouterGroup) { return } - p, err := query.FileByHash(clean.Token(c.Param("hash"))) + hash := clean.Token(c.Param("hash")) + + // Limit results to files within the session's shared scope, consistent with how photo + // search filters results. Files outside the scope are reported as not found. + if visible, err := search.FileVisibleToSession(hash, s); err != nil || !visible { + AbortEntityNotFound(c) + return + } + + p, err := query.FileByHash(hash) if err != nil { AbortEntityNotFound(c) diff --git a/internal/api/files_test.go b/internal/api/files_test.go index 4473fdf98..be20790e3 100644 --- a/internal/api/files_test.go +++ b/internal/api/files_test.go @@ -7,6 +7,8 @@ import ( "github.com/tidwall/gjson" "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/config" ) func TestGetFile(t *testing.T) { @@ -25,4 +27,19 @@ func TestGetFile(t *testing.T) { r := PerformRequest(app, "GET", "/api/v1/files/111") assert.Equal(t, http.StatusNotFound, r.Code) }) + t.Run("SharedOnlySessionDenied", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + GetFile(router) + + // A shared-only (guest) session has no files access, so the endpoint denies the request + // at the ACL check before the visibility gate. Per-photo file scope (the gate that returns + // 404 for an out-of-scope file when the role does have files access, e.g. a viewer in + // Plus/Pro) is covered by search.TestFileVisibleToSession. + authToken := AuthenticateUser(app, router, "gandalf", "Gandalf123!") + r := AuthenticatedRequest(app, "GET", "/api/v1/files/2cad9168fa6acc5c5c2965ddf6ec465ca42fd818", authToken) + assert.Equal(t, http.StatusForbidden, r.Code) + }) } diff --git a/internal/api/folders_search.go b/internal/api/folders_search.go index c3c80644b..f8478b78f 100644 --- a/internal/api/folders_search.go +++ b/internal/api/folders_search.go @@ -47,6 +47,11 @@ func SearchFoldersOriginals(router *gin.RouterGroup) { // @Tags Folders // @Produce json // @Success 200 {object} api.FoldersResponse +// @Header 200 {number} X-Folders "The actual number of folders returned. Do not use for determining if all the results have been returned." +// @Header 200 {number} X-Files "The actual number of files returned. Use this for comparing to X-Limit to determine if all the results have been returned." +// @Header 200 {number} X-Count "The actual number of files and folders returned. Do not use for determining if all the results have been returned." +// @Header 200 {number} X-Limit "The limit of the number of files to be returned" +// @Header 200 {number} X-Offset "The offset that was used" // @Failure 401,403 {object} i18n.Response // @Router /api/v1/folders/import [get] func SearchFoldersImport(router *gin.RouterGroup) { diff --git a/internal/api/folders_search_test.go b/internal/api/folders_search_test.go index 38a1ef43f..43cec9667 100644 --- a/internal/api/folders_search_test.go +++ b/internal/api/folders_search_test.go @@ -2,6 +2,8 @@ package api import ( "encoding/json" + "net/http" + "strconv" "testing" "github.com/stretchr/testify/assert" @@ -94,6 +96,32 @@ func TestGetFoldersOriginals(t *testing.T) { }) } +func TestSearchFolders_Headers(t *testing.T) { + app, router, conf := NewApiTest() + _ = conf.CreateDirectories() + SearchFoldersOriginals(router) + + // Request uncached results so the count headers are always written + // (a cache hit returns early before the headers are added). + r := PerformRequest(app, "GET", "/api/v1/folders/originals?uncached=true") + assert.Equal(t, http.StatusOK, r.Code) + result := r.Result() + + xFiles, err := strconv.Atoi(result.Header.Get("X-Files")) + assert.NoError(t, err, "X-Files header should be an integer") + xFolders, err := strconv.Atoi(result.Header.Get("X-Folders")) + assert.NoError(t, err, "X-Folders header should be an integer") + xCount, err := strconv.Atoi(result.Header.Get("X-Count")) + assert.NoError(t, err, "X-Count header should be an integer") + + // X-Count is the combined number of files and folders returned. + assert.Equal(t, xFiles+xFolders, xCount) + + // An unpaginated request reports the form's zero-value count and offset. + assert.Equal(t, "0", result.Header.Get("X-Limit")) + assert.Equal(t, "0", result.Header.Get("X-Offset")) +} + func TestGetFoldersImport(t *testing.T) { t.Run("Flat", func(t *testing.T) { app, router, conf := NewApiTest() diff --git a/internal/api/import.go b/internal/api/import.go index 73801fb0b..d797eb8c2 100644 --- a/internal/api/import.go +++ b/internal/api/import.go @@ -57,7 +57,7 @@ func StartImport(router *gin.RouterGroup) { } // Abort if there is not enough free storage to import new files. - if conf.FilesQuotaReached() { + if conf.InsufficientStorage() { event.AuditErr([]string{ClientIP(c), "session %s", "import files", status.InsufficientStorage}, s.RefID) Abort(c, http.StatusInsufficientStorage, i18n.ErrInsufficientStorage) return @@ -68,7 +68,14 @@ func StartImport(router *gin.RouterGroup) { var frm form.ImportOptions // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -170,7 +177,7 @@ func StartImport(router *gin.RouterGroup) { event.Publish("index.completed", eventData) for _, uid := range frm.Albums { - PublishAlbumEvent(StatusUpdated, uid, c) + PublishAlbumEvent(StatusUpdated, uid) } // Update the user interface. @@ -181,7 +188,7 @@ func StartImport(router *gin.RouterGroup) { log.Warnf("index: %s (update covers)", err) } - c.JSON(http.StatusOK, i18n.Response{Code: http.StatusOK, Msg: msg}) + c.JSON(http.StatusOK, i18n.Response{Code: http.StatusOK, Message: msg}) }) } diff --git a/internal/api/import_test.go b/internal/api/import_test.go index 3779b58d4..51309ddbf 100644 --- a/internal/api/import_test.go +++ b/internal/api/import_test.go @@ -23,7 +23,7 @@ func TestCancelImport(t *testing.T) { } assert.True(t, resp.Success()) - assert.Equal(t, i18n.Msg(i18n.MsgImportCanceled), resp.Msg) + assert.Equal(t, i18n.Msg(i18n.MsgImportCanceled), resp.Message) assert.Equal(t, i18n.Msg(i18n.MsgImportCanceled), resp.String()) assert.Equal(t, http.StatusOK, r.Code) assert.Equal(t, http.StatusOK, resp.Code) diff --git a/internal/api/index.go b/internal/api/index.go index 53a01bb75..9f45d2947 100644 --- a/internal/api/index.go +++ b/internal/api/index.go @@ -16,6 +16,7 @@ import ( "github.com/photoprism/photoprism/internal/photoprism/get" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/i18n" + "github.com/photoprism/photoprism/pkg/log/status" "github.com/photoprism/photoprism/pkg/txt" ) @@ -46,12 +47,29 @@ func StartIndexing(router *gin.RouterGroup) { return } + // Abort if the storage filesystem is critically low on free space. Indexing only + // writes sidecars and thumbnails, so the disk-low check is sufficient here; the + // FilesQuota gate used by import/upload/avatar/zip/video does not apply because + // indexing catalogs existing files rather than adding to the quota. + if _, low, _ := conf.StorageLow(); low { + event.AuditErr([]string{ClientIP(c), "session %s", "index files", status.InsufficientStorage}, s.RefID) + Abort(c, http.StatusInsufficientStorage, i18n.ErrInsufficientStorage) + return + } + start := time.Now() var frm form.IndexOptions // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -163,7 +181,11 @@ func StartIndexing(router *gin.RouterGroup) { msg := i18n.Msg(i18n.MsgIndexingCompletedIn, elapsed) - event.Success(msg) + // Report success only if at least one file was indexed. + if indexed > 0 { + event.Success(msg) + } + event.Publish("index.completed", event.Data{ "uid": indOpt.UID, "action": indOpt.Action, @@ -173,7 +195,7 @@ func StartIndexing(router *gin.RouterGroup) { UpdateClientConfig() - c.JSON(http.StatusOK, i18n.Response{Code: http.StatusOK, Msg: msg}) + c.JSON(http.StatusOK, i18n.Response{Code: http.StatusOK, Message: msg}) }) } diff --git a/internal/api/index_test.go b/internal/api/index_test.go index 3f1842bc9..e70fd495e 100644 --- a/internal/api/index_test.go +++ b/internal/api/index_test.go @@ -7,6 +7,8 @@ import ( "github.com/stretchr/testify/assert" + "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/pkg/fs/disk" "github.com/photoprism/photoprism/pkg/i18n" ) @@ -23,9 +25,27 @@ func TestCancelIndex(t *testing.T) { } assert.True(t, resp.Success()) - assert.Equal(t, i18n.Msg(i18n.MsgIndexingCanceled), resp.Msg) + assert.Equal(t, i18n.Msg(i18n.MsgIndexingCanceled), resp.Message) assert.Equal(t, i18n.Msg(i18n.MsgIndexingCanceled), resp.String()) assert.Equal(t, http.StatusOK, r.Code) assert.Equal(t, http.StatusOK, resp.Code) }) } + +func TestStartIndexing(t *testing.T) { + t.Run("InsufficientStorage", func(t *testing.T) { + app, router, conf := NewApiTest() + + disk.FlushFree() + t.Cleanup(disk.FlushFree) + disk.SetFree(conf.StoragePath(), 1*disk.MB, 1000*disk.MB) + // Reset the storage-check latch, which an earlier test may have tripped by probing a + // temp path that duf cannot resolve to a mount point. + config.DisableStorageCheck.Store(false) + + StartIndexing(router) + r := PerformRequestWithBody(app, "POST", "/api/v1/index", "{}") + + assert.Equal(t, http.StatusInsufficientStorage, r.Code) + }) +} diff --git a/internal/api/labels.go b/internal/api/labels.go index ea13f8e03..261ace7cd 100644 --- a/internal/api/labels.go +++ b/internal/api/labels.go @@ -54,7 +54,14 @@ func UpdateLabel(router *gin.RouterGroup) { } // Set form values from request. + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + if frmErr = c.BindJSON(frm); frmErr != nil { + if IsRequestBodyTooLarge(frmErr) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, frmErr) return } else if frmErr = frm.Validate(); frmErr != nil { @@ -73,7 +80,7 @@ func UpdateLabel(router *gin.RouterGroup) { event.SuccessMsg(i18n.MsgLabelSaved) - PublishLabelEvent(StatusUpdated, id, c) + PublishLabelEvent(StatusUpdated, id) c.JSON(http.StatusOK, m) }) @@ -101,7 +108,7 @@ func LikeLabel(router *gin.RouterGroup) { label, err := query.LabelByUID(id) if err != nil { - c.AbortWithStatusJSON(http.StatusNotFound, gin.H{"error": txt.UpperFirst(err.Error())}) + Abort(c, http.StatusNotFound, i18n.ErrLabelNotFound) return } @@ -116,7 +123,7 @@ func LikeLabel(router *gin.RouterGroup) { }) } - PublishLabelEvent(StatusUpdated, id, c) + PublishLabelEvent(StatusUpdated, id) c.JSON(http.StatusOK, http.Response{}) }) @@ -144,7 +151,7 @@ func DislikeLabel(router *gin.RouterGroup) { label, err := query.LabelByUID(id) if err != nil { - c.AbortWithStatusJSON(http.StatusNotFound, gin.H{"error": txt.UpperFirst(err.Error())}) + Abort(c, http.StatusNotFound, i18n.ErrLabelNotFound) return } @@ -159,7 +166,7 @@ func DislikeLabel(router *gin.RouterGroup) { }) } - PublishLabelEvent(StatusUpdated, id, c) + PublishLabelEvent(StatusUpdated, id) c.JSON(http.StatusOK, http.Response{}) }) diff --git a/internal/api/labels_search.go b/internal/api/labels_search.go index a5e640221..c14031ea1 100644 --- a/internal/api/labels_search.go +++ b/internal/api/labels_search.go @@ -19,13 +19,16 @@ import ( // @Id SearchLabels // @Tags Labels // @Produce json -// @Success 200 {object} search.Label +// @Success 200 {array} search.Label +// @Header 200 {number} X-Count "The actual number of labels returned" +// @Header 200 {number} X-Limit "The limit of the number of labels to be returned" +// @Header 200 {number} X-Offset "The offset that was used" // @Failure 401,429,403,400 {object} i18n.Response // @Param count query int true "maximum number of results" minimum(1) maximum(100000) // @Param offset query int false "search result offset" minimum(0) maximum(100000) // @Param all query bool false "show all" // @Param q query string false "search query" -// @Router /api/v1/labels [get] +// @Router /api/v1/labels [get] func SearchLabels(router *gin.RouterGroup) { router.GET("/labels", func(c *gin.Context) { s := Auth(c, acl.ResourceLabels, acl.ActionSearch) @@ -61,7 +64,7 @@ func SearchLabels(router *gin.RouterGroup) { return } - // TODO c.Header("X-Count", strconv.Itoa(count)) + AddCountHeader(c, len(result)) AddLimitHeader(c, frm.Count) AddOffsetHeader(c, frm.Offset) AddTokenHeaders(c, s) diff --git a/internal/api/labels_search_test.go b/internal/api/labels_search_test.go index 3efe32af9..c9fa12c71 100644 --- a/internal/api/labels_search_test.go +++ b/internal/api/labels_search_test.go @@ -2,6 +2,7 @@ package api import ( "net/http" + "strconv" "testing" "github.com/tidwall/gjson" @@ -17,6 +18,10 @@ func TestSearchLabels(t *testing.T) { count := gjson.Get(r.Body.String(), "#") assert.LessOrEqual(t, int64(4), count.Int()) assert.Equal(t, http.StatusOK, r.Code) + result := r.Result() + xCount, err := strconv.Atoi(result.Header.Get("X-Count")) + assert.NoError(t, err, "strconv for X-Count failed") + assert.LessOrEqual(t, 4, xCount) }) t.Run("InvalidRequest", func(t *testing.T) { app, router, _ := NewApiTest() diff --git a/internal/api/lenses.go b/internal/api/lenses.go new file mode 100644 index 000000000..51f8a310e --- /dev/null +++ b/internal/api/lenses.go @@ -0,0 +1,81 @@ +package api + +import ( + "net/http" + "strconv" + + "github.com/gin-gonic/gin" + + "github.com/photoprism/photoprism/internal/auth/acl" + "github.com/photoprism/photoprism/internal/entity/query" + "github.com/photoprism/photoprism/internal/form" + "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/i18n" +) + +// UpdateLens updates lens make and model properties. +// +// PUT /api/v1/lenses/:id +// +// @Summary updates lens name +// @Id UpdateLens +// @Tags Lenses +// @Accept json +// @Produce json +// @Success 200 {object} entity.Lens +// @Failure 401,403,404,429 {object} i18n.Response +// @Param id path string true "Lens ID" +// @Param lens body form.Lens true "Properties to be updated, only Make and Model supported" +// @Router /api/v1/lenses/{id} [put] +func UpdateLens(router *gin.RouterGroup) { + router.PUT("/lenses/:id", func(c *gin.Context) { + s := Auth(c, acl.ResourceLenses, acl.ActionUpdate) + + if s.Abort(c) { + return + } + + // Find lens by ID. A non-numeric id parses to 0 and is rejected as not found below, + // so the parse error is intentionally ignored. + lensId, _ := strconv.ParseUint(clean.Token(c.Param("id")), 10, 32) + m := query.FindLensByID(uint(lensId)) + + if m == nil { + Abort(c, http.StatusNotFound, i18n.ErrLensNotFound) + return + } + + // Create new lens form. + frm, frmErr := form.NewLens(m) + + if frmErr != nil { + Abort(c, http.StatusBadRequest, i18n.ErrBadRequest) + return + } + + // Set form values from request. + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + + if frmErr = c.BindJSON(frm); frmErr != nil { + if IsRequestBodyTooLarge(frmErr) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + + AbortBadRequest(c, frmErr) + return + } else if frmErr = frm.Validate(); frmErr != nil { + AbortInvalidName(c) + return + } + + // Save lens and return new model values if successful. + if err := m.SaveForm(frm); err != nil { + log.Errorf("lens: %s", clean.Error(err)) + AbortSaveFailed(c) + return + } + + c.JSON(http.StatusOK, m) + }) +} diff --git a/internal/api/lenses_search.go b/internal/api/lenses_search.go new file mode 100644 index 000000000..5f36e9333 --- /dev/null +++ b/internal/api/lenses_search.go @@ -0,0 +1,63 @@ +package api + +import ( + "net/http" + + "github.com/gin-gonic/gin" + "github.com/gin-gonic/gin/binding" + + "github.com/photoprism/photoprism/internal/auth/acl" + "github.com/photoprism/photoprism/internal/entity/search" + "github.com/photoprism/photoprism/internal/form" + "github.com/photoprism/photoprism/pkg/txt" +) + +// SearchLenses finds and returns lenses as JSON. +// +// @Summary finds and returns lenses as JSON +// @Id SearchLenses +// @Tags Lenses +// @Produce json +// @Success 200 {array} search.Lens +// @Header 200 {number} X-Count "The actual number of lenses returned" +// @Header 200 {number} X-Limit "The limit of the number of lenses to be returned" +// @Header 200 {number} X-Offset "The offset that was used" +// @Failure 401,429,403,400 {object} i18n.Response +// @Param count query int true "maximum number of results" minimum(1) maximum(100000) +// @Param offset query int false "search result offset" minimum(0) maximum(100000) +// @Param nomake query bool false "show where make is blank" +// @Param q query string false "search query" +// @Router /api/v1/lenses [get] +func SearchLenses(router *gin.RouterGroup) { + router.GET("/lenses", func(c *gin.Context) { + s := Auth(c, acl.ResourceLenses, acl.ActionSearch) + + if s.Abort(c) { + return + } + + var frm form.SearchLenses + + err := c.MustBindWith(&frm, binding.Form) + + if err != nil { + AbortBadRequest(c, err) + return + } + + // Search matching lenses. + result, err := search.Lenses(frm) + + if err != nil { + c.AbortWithStatusJSON(400, gin.H{"error": txt.UpperFirst(err.Error())}) + return + } + + AddCountHeader(c, len(result)) + AddLimitHeader(c, frm.Count) + AddOffsetHeader(c, frm.Offset) + AddTokenHeaders(c, s) + + c.JSON(http.StatusOK, result) + }) +} diff --git a/internal/api/lenses_search_test.go b/internal/api/lenses_search_test.go new file mode 100644 index 000000000..afda98349 --- /dev/null +++ b/internal/api/lenses_search_test.go @@ -0,0 +1,33 @@ +package api + +import ( + "net/http" + "strconv" + "testing" + + "github.com/tidwall/gjson" + + "github.com/stretchr/testify/assert" +) + +func TestSearchLenses(t *testing.T) { + t.Run("Success", func(t *testing.T) { + app, router, _ := NewApiTest() + SearchLenses(router) + r := PerformRequest(app, "GET", "/api/v1/lenses?count=15") + count := gjson.Get(r.Body.String(), "#") + assert.Greater(t, count.Int(), int64(0)) + assert.Equal(t, http.StatusOK, r.Code) + result := r.Result() + xCount, err := strconv.Atoi(result.Header.Get("X-Count")) + assert.NoError(t, err, "strconv for X-Count failed") + // X-Count must equal the number of records in the body. + assert.Equal(t, int(count.Int()), xCount) + }) + t.Run("InvalidRequest", func(t *testing.T) { + app, router, _ := NewApiTest() + SearchLenses(router) + r := PerformRequest(app, "GET", "/api/v1/lenses?xxx=15") + assert.Equal(t, http.StatusBadRequest, r.Code) + }) +} diff --git a/internal/api/lenses_test.go b/internal/api/lenses_test.go new file mode 100644 index 000000000..1e1d5459d --- /dev/null +++ b/internal/api/lenses_test.go @@ -0,0 +1,47 @@ +package api + +import ( + "net/http" + "testing" + + "github.com/tidwall/gjson" + + "github.com/stretchr/testify/assert" +) + +func TestUpdateLens(t *testing.T) { + t.Run("Success", func(t *testing.T) { + app, router, _ := NewApiTest() + UpdateLens(router) + r := PerformRequestWithBody(app, "PUT", "/api/v1/lenses/1000002", `{"Make": "Tamron", "Model": "Tamron SP AF 24-135mm F3.5-5.6 AD AL (190D)"}`) + val := gjson.Get(r.Body.String(), "Name") + assert.Equal(t, "Tamron SP AF 24-135mm F3.5-5.6 AD AL (190D)", val.String()) + val2 := gjson.Get(r.Body.String(), "Model") + assert.Equal(t, "SP AF 24-135mm F3.5-5.6 AD AL (190D)", val2.String()) + assert.Equal(t, http.StatusOK, r.Code) + }) + t.Run("InvalidRequest", func(t *testing.T) { + app, router, _ := NewApiTest() + UpdateLens(router) + r := PerformRequestWithBody(app, "PUT", "/api/v1/lenses/1000002", `{"Make": 123, "Model": ""}`) + val := gjson.Get(r.Body.String(), "error") + assert.Equal(t, "Unable to do that", val.String()) + assert.Equal(t, http.StatusBadRequest, r.Code) + }) + t.Run("BadModel", func(t *testing.T) { + app, router, _ := NewApiTest() + UpdateLens(router) + r := PerformRequestWithBody(app, "PUT", "/api/v1/lenses/1000002", `{"Make": "123", "Model": ""}`) + val := gjson.Get(r.Body.String(), "error") + assert.Equal(t, "Invalid name", val.String()) + assert.Equal(t, http.StatusBadRequest, r.Code) + }) + t.Run("NotFound", func(t *testing.T) { + app, router, _ := NewApiTest() + UpdateLens(router) + r := PerformRequestWithBody(app, "PUT", "/api/v1/lenses/199000002", `{"Make": "Pentax", "Model": "Tamron SP AF 24-135mm F3.5-5.6 AD AL (190D)"}`) + val := gjson.Get(r.Body.String(), "error") + assert.Equal(t, "Lens not found", val.String()) + assert.Equal(t, http.StatusNotFound, r.Code) + }) +} diff --git a/internal/api/links.go b/internal/api/links.go index 8407f8371..f293052b1 100644 --- a/internal/api/links.go +++ b/internal/api/links.go @@ -11,7 +11,7 @@ import ( "github.com/photoprism/photoprism/internal/entity/query" "github.com/photoprism/photoprism/internal/form" "github.com/photoprism/photoprism/pkg/clean" - "github.com/photoprism/photoprism/pkg/txt" + "github.com/photoprism/photoprism/pkg/i18n" ) // UpdateLink updates a share link and return it as JSON. @@ -28,7 +28,14 @@ func UpdateLink(c *gin.Context) { var frm form.Link // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -45,19 +52,19 @@ func UpdateLink(c *gin.Context) { if frm.Password != "" { if err := link.SetPassword(frm.Password); err != nil { - c.AbortWithStatusJSON(http.StatusConflict, gin.H{"error": txt.UpperFirst(err.Error())}) + Abort(c, http.StatusConflict, i18n.ErrSaveFailed) return } } if err := link.Save(); err != nil { - c.AbortWithStatusJSON(http.StatusConflict, gin.H{"error": txt.UpperFirst(err.Error())}) + Abort(c, http.StatusConflict, i18n.ErrSaveFailed) return } UpdateClientConfig() - PublishAlbumEvent(StatusUpdated, link.ShareUID, c) + PublishAlbumEvent(StatusUpdated, link.ShareUID) c.JSON(http.StatusOK, link) } @@ -76,13 +83,13 @@ func DeleteLink(c *gin.Context) { link := entity.FindLink(clean.Token(c.Param("link"))) if err := link.Delete(); err != nil { - c.AbortWithStatusJSON(http.StatusConflict, gin.H{"error": txt.UpperFirst(err.Error())}) + Abort(c, http.StatusConflict, i18n.ErrDeleteFailed) return } UpdateClientConfig() - PublishAlbumEvent(StatusUpdated, link.ShareUID, c) + PublishAlbumEvent(StatusUpdated, link.ShareUID) c.JSON(http.StatusOK, link) } @@ -107,7 +114,14 @@ func CreateLink(c *gin.Context) { var frm form.Link + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -120,19 +134,19 @@ func CreateLink(c *gin.Context) { if frm.Password != "" { if err := link.SetPassword(frm.Password); err != nil { - c.AbortWithStatusJSON(http.StatusConflict, gin.H{"error": txt.UpperFirst(err.Error())}) + Abort(c, http.StatusConflict, i18n.ErrSaveFailed) return } } if err := link.Save(); err != nil { - c.AbortWithStatusJSON(http.StatusConflict, gin.H{"error": txt.UpperFirst(err.Error())}) + Abort(c, http.StatusConflict, i18n.ErrSaveFailed) return } UpdateClientConfig() - PublishAlbumEvent(StatusUpdated, link.ShareUID, c) + PublishAlbumEvent(StatusUpdated, link.ShareUID) c.JSON(http.StatusOK, link) } @@ -221,7 +235,7 @@ func DeleteAlbumLink(router *gin.RouterGroup) { // @Id GetAlbumLinks // @Tags Links, Albums // @Produce json -// @Success 200 {object} entity.Link +// @Success 200 {array} entity.Link // @Failure 401,403,404,429 {object} i18n.Response // @Param uid path string true "album uid" // @Router /api/v1/albums/{uid}/links [get] diff --git a/internal/api/markers.go b/internal/api/markers.go index c0666d55d..8166a7642 100644 --- a/internal/api/markers.go +++ b/internal/api/markers.go @@ -13,6 +13,7 @@ import ( "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/entity/query" + "github.com/photoprism/photoprism/internal/entity/search" "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/internal/form" "github.com/photoprism/photoprism/internal/mutex" @@ -69,6 +70,15 @@ func findFileMarker(c *gin.Context) (file *entity.File, marker *entity.Marker, e return file, marker, fmt.Errorf("file %s %s", marker.FileUID, err) } + // Limit the edit to the file's photo within the session's shared scope. PhotoSessionSeesEverything + // is query-free and client and user role aware, so full-access sessions skip the check. + if !search.PhotoSessionSeesEverything(s) { + if visible, vErr := search.PhotoVisibleToSession(file.PhotoUID, s); vErr != nil || !visible { + AbortForbidden(c) + return file, marker, errors.New("forbidden") + } + } + return file, marker, nil } @@ -99,7 +109,14 @@ func CreateMarker(router *gin.RouterGroup) { } // Initialize form. + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -113,6 +130,15 @@ func CreateMarker(router *gin.RouterGroup) { return } + // Limit the edit to the file's photo within the session's shared scope. PhotoSessionSeesEverything + // is query-free and client and user role aware, so full-access sessions skip the check. + if !search.PhotoSessionSeesEverything(s) { + if visible, vErr := search.PhotoVisibleToSession(file.PhotoUID, s); vErr != nil || !visible { + AbortForbidden(c) + return + } + } + // Validate form values. if err = frm.Validate(); err != nil { AbortBadRequest(c, err) @@ -161,7 +187,7 @@ func CreateMarker(router *gin.RouterGroup) { log.Errorf("faces: %s (update photo title)", err) } else { // Publish updated photo entity. - PublishPhotoEvent(StatusUpdated, file.PhotoUID, c) + PublishPhotoEvent(StatusUpdated, file.PhotoUID) } // Display success message. @@ -214,7 +240,16 @@ func UpdateMarker(router *gin.RouterGroup) { log.Errorf("faces: %s (create marker form)", err) AbortSaveFailed(c) return - } else if err = c.BindJSON(&frm); err != nil { + } + + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + + if err = c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + log.Errorf("faces: %s (bind marker form)", err) AbortBadRequest(c, err) return @@ -259,7 +294,7 @@ func UpdateMarker(router *gin.RouterGroup) { log.Errorf("faces: %s (update photo title)", err) } else { // Notify clients. - PublishPhotoEvent(StatusUpdated, file.PhotoUID, c) + PublishPhotoEvent(StatusUpdated, file.PhotoUID) } // Display success message. @@ -321,7 +356,7 @@ func ClearMarkerSubject(router *gin.RouterGroup) { log.Errorf("faces: %s (update photo title)", err) } else { // Notify clients. - PublishPhotoEvent(StatusUpdated, file.PhotoUID, c) + PublishPhotoEvent(StatusUpdated, file.PhotoUID) } event.SuccessMsg(i18n.MsgChangesSaved) diff --git a/internal/api/mcp.go b/internal/api/mcp.go new file mode 100644 index 000000000..cd0aedfbd --- /dev/null +++ b/internal/api/mcp.go @@ -0,0 +1,183 @@ +package api + +import ( + "errors" + "io" + "log/slog" + "net/http" + "os" + "sync/atomic" + "time" + + "github.com/gin-gonic/gin" + sdkmcp "github.com/modelcontextprotocol/go-sdk/mcp" + + "github.com/photoprism/photoprism/internal/auth/acl" + "github.com/photoprism/photoprism/internal/event" + "github.com/photoprism/photoprism/internal/mcp" + "github.com/photoprism/photoprism/internal/photoprism/get" + "github.com/photoprism/photoprism/pkg/i18n" + "github.com/photoprism/photoprism/pkg/log/status" +) + +// McpSessionTimeout configures the idle lifetime of MCP Streamable HTTP +// sessions. It is shorter than a typical IDE editing window so that sessions +// abandoned without a DELETE tear-down do not accumulate SDK-side bookkeeping +// for long periods; active clients renew the idle timer on every request, so +// interactive use is unaffected. +var McpSessionTimeout = 5 * time.Minute + +// ServeMCP registers the Model Context Protocol (MCP) Streamable HTTP +// endpoint at /api/v1/mcp. +// +// @Summary model context protocol endpoint +// @Id ServeMCP +// @Tags MCP +// @Accept json +// @Produce json +// @Success 200 {string} string "JSON-RPC 2.0 response" +// @Failure 401,403,404,413,429 {object} i18n.Response +// @Router /api/v1/mcp [post] +func ServeMCP(router *gin.RouterGroup) { + if router == nil { + return + } + + conf := get.Config() + + // Skip registration when no config is available, so + // /api/v1/mcp returns the standard 404 in that case. + if conf == nil { + return + } + + // Skip registration when the MCP endpoint has been disabled via + // --disable-mcp / PHOTOPRISM_DISABLE_MCP / DisableMCP, so requests + // to /api/v1/mcp return the standard 404 response. + if conf.DisableMCP() { + log.Info("mcp: disabled") + return + } + + // One server instance is shared across all HTTP requests. The SDK + // isolates concurrent callers through its own session bookkeeping, + // keyed by the Mcp-Session-Id response header. + mcpServer := mcp.NewServer(&sdkmcp.Implementation{ + Name: "photoprism-mcp", + Version: conf.Version(), + }, conf.Edition()) + + // Streamable HTTP handler with warn-level logging and an explicit + // CrossOriginProtection (go-sdk no longer enables it implicitly). + handler := sdkmcp.NewStreamableHTTPHandler( + func(r *http.Request) *sdkmcp.Server { return mcpServer }, + &sdkmcp.StreamableHTTPOptions{ + SessionTimeout: McpSessionTimeout, + Logger: slog.New(slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{Level: slog.LevelWarn})), + CrossOriginProtection: &http.CrossOriginProtection{}, + }, + ) + + // mcpHandler authenticates each request, caps the JSON-RPC payload size, + // and surfaces 413 on overflow. Public mode reaches read-only tools as + // the default public session; any tool that touches per-user state must + // add an explicit gate before being registered on this shared server. + mcpHandler := func(c *gin.Context) { + s := Auth(c, acl.ResourceMCP, acl.ActionView) + + // Abort writes the matching 401/403/429 response if the session + // is invalid and returns true so the handler can exit early. + if s.Abort(c) { + return + } + + // Reject oversized requests up front when Content-Length is + // known; chunked or unknown-length bodies fall through to + // MaxBytesReader below. + if c.Request.ContentLength > MaxMCPRequestBytes { + event.AuditWarn([]string{ClientIP(c), "session %s", "mcp", "request body too large", status.Failed}, s.RefID) + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + + // Cap the body before the SDK reads it; the wrapper rewrites the + // SDK's "failed to read body" 400 into a standard 413 on overflow. + LimitRequestBodyBytes(c, MaxMCPRequestBytes) + + tripped := &atomic.Bool{} + c.Request.Body = &mcpLimitReader{ReadCloser: c.Request.Body, tripped: tripped} + writer := &mcpLimitWriter{ResponseWriter: c.Writer, tripped: tripped} + + handler.ServeHTTP(writer, c.Request) + + // Audit the rewritten 413 so the audit log reflects the final + // status the client received, not the SDK's internal 400. + if writer.suppress.Load() { + event.AuditWarn([]string{ClientIP(c), "session %s", "mcp", "request body too large", status.Failed}, s.RefID) + } + } + + // Streamable HTTP uses POST for requests, GET for the event stream, + // and DELETE to tear down a session; register the same handler for + // all three verbs. + router.POST("/mcp", mcpHandler) + router.GET("/mcp", mcpHandler) + router.DELETE("/mcp", mcpHandler) +} + +// mcpLimitReader wraps an http.MaxBytesReader-bounded body and records +// whether the read failed with *http.MaxBytesError so the paired writer +// can translate the SDK's 400 response into the standard 413. +type mcpLimitReader struct { + io.ReadCloser + tripped *atomic.Bool +} + +// Read delegates to the wrapped body and flips the shared flag when the +// MaxBytesReader cap is exceeded. +func (r *mcpLimitReader) Read(p []byte) (int, error) { + n, err := r.ReadCloser.Read(p) + + if err != nil { + var maxBytesErr *http.MaxBytesError + if errors.As(err, &maxBytesErr) { + r.tripped.Store(true) + } + } + + return n, err +} + +// mcpLimitWriter wraps the outgoing response so the SDK's 400 "failed to +// read body" is rewritten to 413 when the body cap was exceeded. Body +// writes that arrive after the rewrite are suppressed so the SDK's +// internal error phrasing does not replace PhotoPrism's standard 413 +// payload. +type mcpLimitWriter struct { + gin.ResponseWriter + tripped *atomic.Bool + suppress atomic.Bool +} + +// WriteHeader rewrites 400 to 413 when the request body exceeded the cap +// and marks the response body as suppressed so subsequent Write calls +// cannot leak the SDK's 400 payload. +func (w *mcpLimitWriter) WriteHeader(statusCode int) { + if statusCode == http.StatusBadRequest && w.tripped.Load() { + statusCode = http.StatusRequestEntityTooLarge + w.suppress.Store(true) + } + + w.ResponseWriter.WriteHeader(statusCode) +} + +// Write forwards payload bytes unless the response is a rewritten 413, +// in which case the SDK's body is silently dropped so the final response +// stays consistent with AbortRequestTooLarge. +func (w *mcpLimitWriter) Write(b []byte) (int, error) { + if w.suppress.Load() { + return len(b), nil + } + + return w.ResponseWriter.Write(b) +} diff --git a/internal/api/mcp_test.go b/internal/api/mcp_test.go new file mode 100644 index 000000000..5c0d33d03 --- /dev/null +++ b/internal/api/mcp_test.go @@ -0,0 +1,314 @@ +package api + +import ( + "io" + "net/http" + "net/http/httptest" + "strings" + "sync/atomic" + "testing" + + "github.com/gin-gonic/gin" + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/internal/photoprism/get" + "github.com/photoprism/photoprism/pkg/authn" + "github.com/photoprism/photoprism/pkg/http/header" +) + +// prepareMCPTest sets auth mode to password and disables public mode so that +// MCP auth checks behave as in production. +func prepareMCPTest(t *testing.T) *config.Config { + t.Helper() + + conf := get.Config() + originalOptions := *conf.Options() + + t.Cleanup(func() { + *conf.Options() = originalOptions + }) + + conf.Options().AuthMode = config.AuthModePasswd + conf.Options().Public = false + + return conf +} + +// mcpPost sends a JSON-RPC POST to /api/v1/mcp with MCP-required headers. +func mcpPost(app http.Handler, body, authToken, sessionID string) *httptest.ResponseRecorder { + req, _ := http.NewRequest(http.MethodPost, "/api/v1/mcp", strings.NewReader(body)) + + if authToken != "" { + header.SetAuthorization(req, authToken) + } + + req.Header.Set(header.ContentType, header.ContentTypeJson) + req.Header.Set(header.Accept, header.ContentTypeJson+", "+header.ContentTypeEventStream) + + if sessionID != "" { + req.Header.Set("Mcp-Session-Id", sessionID) + } + + w := httptest.NewRecorder() + app.ServeHTTP(w, req) + + return w +} + +// TestServeMCP exercises the HTTP handler installed by ServeMCP: the +// public-mode anonymous path, unauthenticated and non-admin denial, and +// the full admin round-trip through initialize, notifications/initialized, +// and tools/call. +func TestServeMCP(t *testing.T) { + t.Run("AllowedPublicMode", func(t *testing.T) { + // In public mode, Session() returns the default public session and + // the currently registered MCP tools only surface static reference + // data. Anonymous callers must therefore be able to initialize an + // MCP session and call both tools without a token — this is what + // lets the MCP server run on demo.photoprism.app. Guard the policy + // here so it regresses loudly if a future change tightens it. + app, router, _ := NewApiTest() + conf := prepareMCPTest(t) + conf.Options().Public = true + ServeMCP(router) + + initBody := `{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-03-26","capabilities":{},"clientInfo":{"name":"test-client","version":"1.0"}}}` + w := mcpPost(app, initBody, "", "") + + assert.Equal(t, http.StatusOK, w.Code) + sessionID := w.Header().Get("Mcp-Session-Id") + assert.NotEmpty(t, sessionID) + assert.Contains(t, w.Body.String(), "photoprism-mcp") + + w2 := mcpPost(app, `{"jsonrpc":"2.0","method":"notifications/initialized"}`, "", sessionID) + assert.Less(t, w2.Code, 300, "notification should succeed, got %d: %s", w2.Code, w2.Body.String()) + + w3 := mcpPost(app, `{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"list_config_keys","arguments":{"query":"database","limit":5}}}`, "", sessionID) + assert.Equal(t, http.StatusOK, w3.Code) + assert.Contains(t, w3.Body.String(), "matches") + + w4 := mcpPost(app, `{"jsonrpc":"2.0","id":3,"method":"tools/call","params":{"name":"find_search_filters","arguments":{"query":"color","limit":5}}}`, "", sessionID) + assert.Equal(t, http.StatusOK, w4.Code) + assert.Contains(t, w4.Body.String(), "matches") + }) + t.Run("DisabledViaConfig", func(t *testing.T) { + // When DisableMCP is set, ServeMCP must skip route registration so + // the endpoint responds with the standard 404 — mirroring how the + // other Disable* flags short-circuit route setup. + app, router, _ := NewApiTest() + conf := prepareMCPTest(t) + conf.Options().DisableMCP = true + ServeMCP(router) + + r := mcpPost(app, `{"jsonrpc":"2.0","id":1,"method":"initialize"}`, "", "") + assert.Equal(t, http.StatusNotFound, r.Code) + }) + t.Run("UnauthorizedAnonymous", func(t *testing.T) { + app, router, _ := NewApiTest() + prepareMCPTest(t) + ServeMCP(router) + + r := mcpPost(app, `{"jsonrpc":"2.0","id":1,"method":"initialize"}`, "", "") + assert.Equal(t, http.StatusUnauthorized, r.Code) + }) + t.Run("ForbiddenNonAdmin", func(t *testing.T) { + app, router, _ := NewApiTest() + prepareMCPTest(t) + ServeMCP(router) + + authToken := AuthenticateUser(app, router, "gandalf", "Gandalf123!") + r := mcpPost(app, `{"jsonrpc":"2.0","id":1,"method":"initialize"}`, authToken, "") + assert.Equal(t, http.StatusForbidden, r.Code) + }) + t.Run("AdminAppPasswordWithoutMCPScope", func(t *testing.T) { + app, router, _ := NewApiTest() + prepareMCPTest(t) + ServeMCP(router) + + user := entity.FindUserByName("alice") + if user == nil { + t.Fatal("admin fixture user 'alice' must not be nil") + } + + sess, err := entity.AddClientSession("mcp-test-wrong-scope", 3600, "webdav", authn.GrantCLI, user) + assert.NoError(t, err) + if err != nil { + return + } + + r := mcpPost(app, `{"jsonrpc":"2.0","id":1,"method":"initialize"}`, sess.AuthToken(), "") + assert.Equal(t, http.StatusForbidden, r.Code) + }) + t.Run("AdminAppPasswordWithMCPScope", func(t *testing.T) { + app, router, _ := NewApiTest() + prepareMCPTest(t) + ServeMCP(router) + + user := entity.FindUserByName("alice") + if user == nil { + t.Fatal("admin fixture user 'alice' must not be nil") + } + + sess, err := entity.AddClientSession("mcp-test-right-scope", 3600, "mcp", authn.GrantCLI, user) + assert.NoError(t, err) + if err != nil { + return + } + + initBody := `{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-03-26","capabilities":{},"clientInfo":{"name":"qa","version":"1.0"}}}` + r := mcpPost(app, initBody, sess.AuthToken(), "") + assert.Equal(t, http.StatusOK, r.Code) + }) + t.Run("RequestTooLargeContentLength", func(t *testing.T) { + // The handler must reject oversized POST bodies with a 413 before + // the MCP SDK reads them into memory. This branch covers the + // early-reject path that fires when the client sends a + // Content-Length header larger than MaxMCPRequestBytes. + app, router, _ := NewApiTest() + prepareMCPTest(t) + ServeMCP(router) + + authToken := AuthenticateAdmin(app, router) + + req, _ := http.NewRequest(http.MethodPost, "/api/v1/mcp", strings.NewReader("")) + header.SetAuthorization(req, authToken) + req.Header.Set(header.ContentType, header.ContentTypeJson) + req.Header.Set(header.Accept, header.ContentTypeJson+", "+header.ContentTypeEventStream) + req.ContentLength = MaxMCPRequestBytes + 1 + + w := httptest.NewRecorder() + app.ServeHTTP(w, req) + + assert.Equal(t, http.StatusRequestEntityTooLarge, w.Code) + }) + t.Run("RequestTooLargeStreamed", func(t *testing.T) { + // MaxBytesReader plus the response-writer wrapper must convert the + // SDK's 400 "failed to read body" into the standard 413 when the + // client streams a body larger than the cap without a + // Content-Length header. This path is what protects deployments + // that sit behind proxies using chunked transfer encoding. + app, router, _ := NewApiTest() + prepareMCPTest(t) + ServeMCP(router) + + authToken := AuthenticateAdmin(app, router) + + oversizedBody := strings.Repeat("a", int(MaxMCPRequestBytes)+1024) + req, _ := http.NewRequest(http.MethodPost, "/api/v1/mcp", strings.NewReader(oversizedBody)) + header.SetAuthorization(req, authToken) + req.Header.Set(header.ContentType, header.ContentTypeJson) + req.Header.Set(header.Accept, header.ContentTypeJson+", "+header.ContentTypeEventStream) + // Force chunked transfer encoding semantics by clearing the + // Content-Length signal, matching the behavior of a streaming + // upstream proxy or client that sends Transfer-Encoding: chunked. + req.ContentLength = -1 + + w := httptest.NewRecorder() + app.ServeHTTP(w, req) + + assert.Equal(t, http.StatusRequestEntityTooLarge, w.Code) + // The rewritten response must not leak the SDK's 400 phrasing. + assert.NotContains(t, w.Body.String(), "failed to read body") + }) + t.Run("InitializeAndCallTools", func(t *testing.T) { + app, router, _ := NewApiTest() + prepareMCPTest(t) + ServeMCP(router) + + authToken := AuthenticateAdmin(app, router) + + // Initialize MCP session. + initBody := `{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-03-26","capabilities":{},"clientInfo":{"name":"test-client","version":"1.0"}}}` + w := mcpPost(app, initBody, authToken, "") + + assert.Equal(t, http.StatusOK, w.Code) + sessionID := w.Header().Get("Mcp-Session-Id") + assert.NotEmpty(t, sessionID) + assert.Contains(t, w.Body.String(), "photoprism-mcp") + + // Send initialized notification (status varies by SDK version). + w2 := mcpPost(app, `{"jsonrpc":"2.0","method":"notifications/initialized"}`, authToken, sessionID) + assert.Less(t, w2.Code, 300, "notification should succeed, got %d: %s", w2.Code, w2.Body.String()) + + // Call list_config_keys. + w3 := mcpPost(app, `{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"list_config_keys","arguments":{"query":"database","limit":5}}}`, authToken, sessionID) + assert.Equal(t, http.StatusOK, w3.Code) + assert.Contains(t, w3.Body.String(), "matches") + + // Call find_search_filters. + w4 := mcpPost(app, `{"jsonrpc":"2.0","id":3,"method":"tools/call","params":{"name":"find_search_filters","arguments":{"query":"color","limit":5}}}`, authToken, sessionID) + assert.Equal(t, http.StatusOK, w4.Code) + assert.Contains(t, w4.Body.String(), "matches") + }) +} + +// TestMcpLimitReader exercises the body wrapper that sets the shared +// "tripped" flag when http.MaxBytesReader returns its sentinel error. +func TestMcpLimitReader(t *testing.T) { + t.Run("FlagsOnMaxBytesError", func(t *testing.T) { + rec := httptest.NewRecorder() + body := io.NopCloser(strings.NewReader("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")) + tripped := &atomic.Bool{} + r := &mcpLimitReader{ + ReadCloser: http.MaxBytesReader(rec, body, 4), + tripped: tripped, + } + buf := make([]byte, 16) + n, err := r.Read(buf) + assert.Less(t, n, 16) + assert.Error(t, err) + assert.True(t, tripped.Load()) + }) + t.Run("NoFlagOnNormalRead", func(t *testing.T) { + rec := httptest.NewRecorder() + body := io.NopCloser(strings.NewReader("hello")) + tripped := &atomic.Bool{} + r := &mcpLimitReader{ + ReadCloser: http.MaxBytesReader(rec, body, 1024), + tripped: tripped, + } + buf := make([]byte, 64) + n, _ := r.Read(buf) + assert.Equal(t, 5, n) + assert.False(t, tripped.Load()) + }) +} + +// TestMcpLimitWriter exercises the response-writer wrapper that translates +// the SDK's 400 into a 413 once the paired reader has tripped. +func TestMcpLimitWriter(t *testing.T) { + t.Run("RewritesBadRequestWhenTripped", func(t *testing.T) { + rec := httptest.NewRecorder() + c, _ := gin.CreateTestContext(rec) + tripped := &atomic.Bool{} + tripped.Store(true) + w := &mcpLimitWriter{ResponseWriter: c.Writer, tripped: tripped} + w.WriteHeader(http.StatusBadRequest) + _, _ = w.Write([]byte("failed to read body\n")) + assert.Equal(t, http.StatusRequestEntityTooLarge, c.Writer.Status()) + assert.True(t, w.suppress.Load()) + // The SDK-provided body must not reach the client on the 413 + // rewrite path; only the status code is preserved. + assert.NotContains(t, rec.Body.String(), "failed to read body") + }) + t.Run("PassesThroughWhenNotTripped", func(t *testing.T) { + c, _ := gin.CreateTestContext(httptest.NewRecorder()) + tripped := &atomic.Bool{} + w := &mcpLimitWriter{ResponseWriter: c.Writer, tripped: tripped} + w.WriteHeader(http.StatusOK) + _, _ = w.Write([]byte("ok")) + assert.Equal(t, http.StatusOK, c.Writer.Status()) + assert.False(t, w.suppress.Load()) + }) + t.Run("LeavesNonBadRequestAlone", func(t *testing.T) { + c, _ := gin.CreateTestContext(httptest.NewRecorder()) + tripped := &atomic.Bool{} + tripped.Store(true) + w := &mcpLimitWriter{ResponseWriter: c.Writer, tripped: tripped} + w.WriteHeader(http.StatusInternalServerError) + assert.Equal(t, http.StatusInternalServerError, c.Writer.Status()) + assert.False(t, w.suppress.Load()) + }) +} diff --git a/internal/api/moments_time.go b/internal/api/moments_time.go index 1ef8011e2..308cb066f 100644 --- a/internal/api/moments_time.go +++ b/internal/api/moments_time.go @@ -17,7 +17,7 @@ import ( // @Id GetMomentsTime // @Tags Albums // @Produce json -// @Success 200 {object} entity.Album +// @Success 200 {array} query.Moment // @Failure 401,403,429,500 {object} i18n.Response // @Router /api/v1/moments/time [get] func GetMomentsTime(router *gin.RouterGroup) { diff --git a/internal/api/oauth_authorize.go b/internal/api/oauth_authorize.go index 0823ad1f5..8b8161c2d 100644 --- a/internal/api/oauth_authorize.go +++ b/internal/api/oauth_authorize.go @@ -12,40 +12,48 @@ import ( "github.com/photoprism/photoprism/pkg/i18n" ) -// OAuthAuthorize (placeholder) for Authorization Code Grant consent. +// OAuthAuthorize registers the OAuth2/OIDC authorization endpoint. The behavior +// is provided by OAuthAuthorizeHandler, which defaults to a placeholder and is +// replaced by Portal builds with the OIDC OP authorize flow (see +// oauth_handlers.go and portal/internal/server/register.go). // -// @Summary OAuth2 authorization endpoint (not implemented) +// @Summary OAuth2/OIDC authorization endpoint // @Id OAuthAuthorize // @Tags Authentication // @Produce json -// @Failure 405 {object} i18n.Response +// @Success 302 {string} string "redirect to the client redirect_uri with an authorization code" +// @Failure 403,405 {object} i18n.Response // @Router /api/v1/oauth/authorize [get] func OAuthAuthorize(router *gin.RouterGroup) { router.GET("/oauth/authorize", func(c *gin.Context) { - // Prevent CDNs from caching this endpoint. - if header.IsCdn(c.Request) { - AbortNotFound(c) - return - } - - // Disable caching of responses. - c.Header(header.CacheControl, header.CacheControlNoStore) - - // Get client IP address for logs and rate limiting checks. - clientIp := ClientIP(c) - actor := "unknown client" - action := "authorize" - - // Abort if running in public mode. - if get.Config().Public() { - event.AuditErr([]string{clientIp, "oauth2", actor, action, authn.ErrDisabledInPublicMode.Error()}) - Abort(c, http.StatusForbidden, i18n.ErrForbidden) - return - } - - // TODO: see https://github.com/photoprism/photoprism/issues/4368 - - // Send response. - c.JSON(http.StatusMethodNotAllowed, gin.H{"status": StatusFailed}) + OAuthAuthorizeHandler(c) }) } + +// defaultOAuthAuthorize is the placeholder authorization handler used unless a +// Portal build overrides OAuthAuthorizeHandler with the OIDC OP authorize flow. +func defaultOAuthAuthorize(c *gin.Context) { + // Prevent CDNs from caching this endpoint. + if header.IsCdn(c.Request) { + AbortNotFound(c) + return + } + + // Disable caching of responses. + c.Header(header.CacheControl, header.CacheControlNoStore) + + // Get client IP address for logs and rate limiting checks. + clientIp := ClientIP(c) + actor := "unknown client" + action := "authorize" + + // Abort if running in public mode. + if get.Config().Public() { + event.AuditErr([]string{clientIp, "oauth2", actor, action, authn.ErrDisabledInPublicMode.Error()}) + Abort(c, http.StatusForbidden, i18n.ErrForbidden) + return + } + + // The OIDC OP authorization endpoint is only available on Portal builds. + c.JSON(http.StatusMethodNotAllowed, gin.H{"status": StatusFailed}) +} diff --git a/internal/api/oauth_authorize_test.go b/internal/api/oauth_authorize_test.go index 6cb3aa446..557fc71b5 100644 --- a/internal/api/oauth_authorize_test.go +++ b/internal/api/oauth_authorize_test.go @@ -4,7 +4,10 @@ import ( "net/http" "testing" + "github.com/gin-gonic/gin" "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/config" ) func TestOAuthAuthorize(t *testing.T) { @@ -16,4 +19,27 @@ func TestOAuthAuthorize(t *testing.T) { r := PerformRequest(app, http.MethodGet, "/api/v1/oauth/authorize") assert.Equal(t, http.StatusForbidden, r.Code) }) + t.Run("DefaultNotImplemented", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + OAuthAuthorize(router) + + r := PerformRequest(app, http.MethodGet, "/api/v1/oauth/authorize") + assert.Equal(t, http.StatusMethodNotAllowed, r.Code) + }) + t.Run("OverrideHookDelegates", func(t *testing.T) { + app, router, _ := NewApiTest() + + OAuthAuthorize(router) + + prev := OAuthAuthorizeHandler + OAuthAuthorizeHandler = func(c *gin.Context) { c.String(http.StatusOK, "delegated") } + defer func() { OAuthAuthorizeHandler = prev }() + + r := PerformRequest(app, http.MethodGet, "/api/v1/oauth/authorize") + assert.Equal(t, http.StatusOK, r.Code) + assert.Equal(t, "delegated", r.Body.String()) + }) } diff --git a/internal/api/oauth_error.go b/internal/api/oauth_error.go new file mode 100644 index 000000000..f6dacb9f3 --- /dev/null +++ b/internal/api/oauth_error.go @@ -0,0 +1,91 @@ +package api + +import ( + "net/http" + "net/url" + "strings" + + "github.com/gin-gonic/gin" + + "github.com/photoprism/photoprism/internal/photoprism/get" + "github.com/photoprism/photoprism/pkg/http/header" +) + +// oauthWantsHTML reports whether an OAuth/OIDC error should render as a branded +// HTML page rather than JSON: true for a top-level browser navigation +// (Sec-Fetch-Mode: navigate or Accept: text/html), false for API clients. +func oauthWantsHTML(c *gin.Context) bool { + if c == nil || c.Request == nil { + return false + } + if strings.Contains(strings.ToLower(c.GetHeader(header.FetchMode)), "navigate") { + return true + } + return strings.Contains(strings.ToLower(c.GetHeader(header.Accept)), gin.MIMEHTML) +} + +// OAuthWantsHTML reports whether the request is a top-level browser navigation +// that should receive an HTML response instead of JSON, so OP handlers in +// extension builds can apply the same content negotiation as the shared +// OAuth/OIDC error helpers. +func OAuthWantsHTML(c *gin.Context) bool { + return oauthWantsHTML(c) +} + +// RenderOAuthError responds to a non-redirectable OAuth/OIDC error with a branded +// HTML page for browsers or the standard JSON body for API clients. Use it only +// when there is no trusted redirect_uri (RFC 6749 §4.1.2.1 forbids redirecting to +// an unverified URI). +func RenderOAuthError(c *gin.Context, statusCode int, errCode, errDescription string) { + if c == nil { + return + } + + c.Header(header.CacheControl, header.CacheControlNoStore) + + if oauthWantsHTML(c) { + c.HTML(statusCode, "oauth-error.gohtml", gin.H{ + "config": get.Config().ClientPublic(), + "code": statusCode, + "error": errCode, + "error_description": errDescription, + }) + c.Abort() + return + } + + c.AbortWithStatusJSON(statusCode, gin.H{ + "error": errCode, + "error_description": errDescription, + }) +} + +// RedirectOAuthError sends the browser back to a validated redirect_uri with the +// standard error, error_description, and echoed state (RFC 6749 §4.1.2.1). Callers +// MUST have validated redirectURI first; an unparseable URI falls back to +// RenderOAuthError rather than being followed. +func RedirectOAuthError(c *gin.Context, redirectURI, state, errCode, errDescription string) { + if c == nil { + return + } + + u, err := url.Parse(redirectURI) + if err != nil || u.Scheme == "" || u.Host == "" { + RenderOAuthError(c, http.StatusBadRequest, "invalid_request", "invalid redirect_uri") + return + } + + q := u.Query() + q.Set("error", errCode) + if errDescription != "" { + q.Set("error_description", errDescription) + } + if state != "" { + q.Set("state", state) + } + u.RawQuery = q.Encode() + + c.Header(header.CacheControl, header.CacheControlNoStore) + c.Redirect(http.StatusFound, u.String()) + c.Abort() +} diff --git a/internal/api/oauth_error_test.go b/internal/api/oauth_error_test.go new file mode 100644 index 000000000..9e9efa16f --- /dev/null +++ b/internal/api/oauth_error_test.go @@ -0,0 +1,120 @@ +package api + +import ( + "net/http" + "net/http/httptest" + "net/url" + "testing" + + "github.com/gin-gonic/gin" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/internal/photoprism/get" + "github.com/photoprism/photoprism/pkg/http/header" +) + +func TestOAuthWantsHTML(t *testing.T) { + newCtx := func(headers map[string]string) *gin.Context { + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + req, _ := http.NewRequest(http.MethodGet, "/api/v1/oauth/authorize", nil) + for k, v := range headers { + req.Header.Set(k, v) + } + c.Request = req + return c + } + t.Run("NavigateHeader", func(t *testing.T) { + assert.True(t, oauthWantsHTML(newCtx(map[string]string{header.FetchMode: "navigate"}))) + }) + t.Run("AcceptHTML", func(t *testing.T) { + assert.True(t, oauthWantsHTML(newCtx(map[string]string{header.Accept: "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"}))) + }) + t.Run("AcceptJSON", func(t *testing.T) { + assert.False(t, oauthWantsHTML(newCtx(map[string]string{header.Accept: "application/json"}))) + }) + t.Run("NoHeaders", func(t *testing.T) { + assert.False(t, oauthWantsHTML(newCtx(nil))) + }) + t.Run("NilContext", func(t *testing.T) { + assert.False(t, oauthWantsHTML(nil)) + }) + t.Run("ExportedWrapper", func(t *testing.T) { + assert.True(t, OAuthWantsHTML(newCtx(map[string]string{header.FetchMode: "navigate"}))) + assert.False(t, OAuthWantsHTML(nil)) + }) +} + +func TestRenderOAuthError(t *testing.T) { + t.Run("JSONForApiClient", func(t *testing.T) { + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + req, _ := http.NewRequest(http.MethodGet, "/api/v1/oauth/authorize", nil) + req.Header.Set(header.Accept, "application/json") + c.Request = req + RenderOAuthError(c, http.StatusNotFound, "invalid_client", "unknown client") + assert.Equal(t, http.StatusNotFound, w.Code) + assert.Contains(t, w.Body.String(), "invalid_client") + assert.Contains(t, w.Body.String(), "unknown client") + assert.Contains(t, w.Header().Get("Content-Type"), "application/json") + assert.Equal(t, header.CacheControlNoStore, w.Header().Get(header.CacheControl)) + }) + t.Run("HTMLForBrowser", func(t *testing.T) { + app := gin.New() + app.LoadHTMLFiles(get.Config().TemplateFiles()...) + app.GET("/x", func(c *gin.Context) { + RenderOAuthError(c, http.StatusForbidden, "access_denied", "redirect_uri not registered") + }) + req, _ := http.NewRequest(http.MethodGet, "/x", nil) + req.Header.Set(header.FetchMode, "navigate") + w := httptest.NewRecorder() + app.ServeHTTP(w, req) + assert.Equal(t, http.StatusForbidden, w.Code) + assert.Contains(t, w.Header().Get("Content-Type"), "text/html") + assert.Contains(t, w.Body.String(), "redirect_uri not registered") + assert.Contains(t, w.Body.String(), "access_denied") + }) + t.Run("NilContext", func(t *testing.T) { + assert.NotPanics(t, func() { RenderOAuthError(nil, http.StatusBadRequest, "x", "y") }) + }) +} + +func TestRedirectOAuthError(t *testing.T) { + newCtx := func() (*gin.Context, *httptest.ResponseRecorder) { + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + req, _ := http.NewRequest(http.MethodGet, "/api/v1/oauth/authorize", nil) + c.Request = req + return c, w + } + t.Run("RedirectsWithErrorAndState", func(t *testing.T) { + c, w := newCtx() + RedirectOAuthError(c, "https://photos.example.com/api/v1/oidc/redirect", "s-123", "access_denied", "no access to the requested instance") + require.Equal(t, http.StatusFound, w.Code) + loc, err := url.Parse(w.Header().Get("Location")) + require.NoError(t, err) + assert.Equal(t, "photos.example.com", loc.Host) + assert.Equal(t, "access_denied", loc.Query().Get("error")) + assert.Equal(t, "no access to the requested instance", loc.Query().Get("error_description")) + assert.Equal(t, "s-123", loc.Query().Get("state")) + }) + t.Run("PreservesExistingQueryAndOmitsEmptyState", func(t *testing.T) { + c, w := newCtx() + RedirectOAuthError(c, "https://photos.example.com/cb?tenant=acme", "", "server_error", "") + loc, _ := url.Parse(w.Header().Get("Location")) + assert.Equal(t, "acme", loc.Query().Get("tenant")) + assert.Equal(t, "server_error", loc.Query().Get("error")) + assert.False(t, loc.Query().Has("state"), "an empty state must not be echoed") + assert.False(t, loc.Query().Has("error_description"), "an empty description must not be added") + }) + t.Run("MalformedURIFallsBackToJSON", func(t *testing.T) { + c, w := newCtx() // no Accept header → JSON branch + RedirectOAuthError(c, "://not-a-url", "s1", "access_denied", "x") + assert.Equal(t, http.StatusBadRequest, w.Code) + assert.Contains(t, w.Body.String(), "invalid_request") + }) + t.Run("NilContext", func(t *testing.T) { + assert.NotPanics(t, func() { RedirectOAuthError(nil, "https://x/", "s", "e", "d") }) + }) +} diff --git a/internal/api/oauth_handlers.go b/internal/api/oauth_handlers.go new file mode 100644 index 000000000..97890dc30 --- /dev/null +++ b/internal/api/oauth_handlers.go @@ -0,0 +1,30 @@ +package api + +import ( + "github.com/gin-gonic/gin" +) + +// Override hooks for the OAuth2/OIDC endpoints, following the server.WebDAVHandler +// pattern: CE owns the /api/v1/oauth/* routes, and Portal builds (which cannot +// re-register the same gin paths and which CE cannot import) swap in the OIDC OP +// behavior by reassigning these variables before the server starts serving. + +// OAuthAuthorizeHandler handles GET /api/v1/oauth/authorize. Defaults to a 405 +// placeholder; Portal builds set it to the OIDC OP authorize handler. +var OAuthAuthorizeHandler gin.HandlerFunc = defaultOAuthAuthorize + +// OAuthUserinfoHandler handles GET and POST /api/v1/oauth/userinfo. Defaults to +// a 405 placeholder; Portal builds set it to the OIDC OP userinfo handler. +var OAuthUserinfoHandler gin.HandlerFunc = defaultOAuthUserinfo + +// OAuthLogoutHandler handles GET and POST /api/v1/oauth/logout (OIDC RP-initiated +// logout end-session endpoint). Defaults to a 405 placeholder; Portal builds set it +// to the OIDC OP end-session handler. +var OAuthLogoutHandler gin.HandlerFunc = defaultOAuthLogout + +// OAuthAuthorizationCodeHandler handles the authorization_code grant on the +// shared POST /api/v1/oauth/token endpoint. Nil on CE/Pro builds (the grant is +// then reported as unsupported); Portal builds set it to the OIDC OP token +// handler. The client_credentials, password, and session grants are always +// handled by OAuthToken itself and stay DB-backed. +var OAuthAuthorizationCodeHandler gin.HandlerFunc diff --git a/internal/api/oauth_logout.go b/internal/api/oauth_logout.go new file mode 100644 index 000000000..78a64eded --- /dev/null +++ b/internal/api/oauth_logout.go @@ -0,0 +1,64 @@ +package api + +import ( + "net/http" + + "github.com/gin-gonic/gin" + + "github.com/photoprism/photoprism/internal/event" + "github.com/photoprism/photoprism/internal/photoprism/get" + "github.com/photoprism/photoprism/pkg/authn" + "github.com/photoprism/photoprism/pkg/http/header" + "github.com/photoprism/photoprism/pkg/i18n" +) + +// OAuthLogout registers the OAuth2/OIDC end-session endpoint for RP-initiated logout. +// The behavior is provided by OAuthLogoutHandler, which defaults to a placeholder and is +// replaced by Portal builds with the OIDC OP end-session handler (see oauth_handlers.go +// and portal/internal/server/register.go). Both GET and POST are registered per the +// OpenID Connect RP-Initiated Logout specification. +// +// @Summary OAuth2/OIDC end-session endpoint (RP-initiated logout) +// @Id OAuthLogout +// @Tags Authentication +// @Produce json +// @Success 302 {string} string "redirect to post_logout_redirect_uri" +// @Failure 403,405 {object} i18n.Response +// @Router /api/v1/oauth/logout [get] +// @Router /api/v1/oauth/logout [post] +func OAuthLogout(router *gin.RouterGroup) { + router.GET("/oauth/logout", func(c *gin.Context) { + OAuthLogoutHandler(c) + }) + router.POST("/oauth/logout", func(c *gin.Context) { + OAuthLogoutHandler(c) + }) +} + +// defaultOAuthLogout is the placeholder end-session handler used unless a Portal build +// overrides OAuthLogoutHandler with the OIDC OP end-session handler. +func defaultOAuthLogout(c *gin.Context) { + // Prevent CDNs from caching this endpoint. + if header.IsCdn(c.Request) { + AbortNotFound(c) + return + } + + // Disable caching of responses. + c.Header(header.CacheControl, header.CacheControlNoStore) + + // Get client IP address for logs and rate limiting checks. + clientIp := ClientIP(c) + actor := "unknown client" + action := "logout" + + // Abort if running in public mode. + if get.Config().Public() { + event.AuditErr([]string{clientIp, "oauth2", actor, action, authn.ErrDisabledInPublicMode.Error()}) + Abort(c, http.StatusForbidden, i18n.ErrForbidden) + return + } + + // The OIDC OP end-session endpoint is only available on Portal builds. + c.JSON(http.StatusMethodNotAllowed, gin.H{"status": StatusFailed}) +} diff --git a/internal/api/oauth_logout_test.go b/internal/api/oauth_logout_test.go new file mode 100644 index 000000000..a62f6c784 --- /dev/null +++ b/internal/api/oauth_logout_test.go @@ -0,0 +1,59 @@ +package api + +import ( + "net/http" + "testing" + + "github.com/gin-gonic/gin" + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/config" +) + +func TestOAuthLogout(t *testing.T) { + t.Run("PublicMode", func(t *testing.T) { + app, router, _ := NewApiTest() + + OAuthLogout(router) + + r := PerformRequest(app, http.MethodGet, "/api/v1/oauth/logout") + assert.Equal(t, http.StatusForbidden, r.Code) + }) + t.Run("DefaultNotImplemented", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + OAuthLogout(router) + + r := PerformRequest(app, http.MethodGet, "/api/v1/oauth/logout") + assert.Equal(t, http.StatusMethodNotAllowed, r.Code) + }) + t.Run("PostRouteRegistered", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + OAuthLogout(router) + + r := PerformRequest(app, http.MethodPost, "/api/v1/oauth/logout") + assert.Equal(t, http.StatusMethodNotAllowed, r.Code) + }) + t.Run("OverrideHookDelegates", func(t *testing.T) { + app, router, _ := NewApiTest() + + OAuthLogout(router) + + prev := OAuthLogoutHandler + OAuthLogoutHandler = func(c *gin.Context) { c.String(http.StatusOK, "delegated:"+c.Request.Method) } + defer func() { OAuthLogoutHandler = prev }() + + get := PerformRequest(app, http.MethodGet, "/api/v1/oauth/logout") + assert.Equal(t, http.StatusOK, get.Code) + assert.Equal(t, "delegated:GET", get.Body.String()) + + post := PerformRequest(app, http.MethodPost, "/api/v1/oauth/logout") + assert.Equal(t, http.StatusOK, post.Code) + assert.Equal(t, "delegated:POST", post.Body.String()) + }) +} diff --git a/internal/api/oauth_token.go b/internal/api/oauth_token.go index a0c1002c4..e592660a2 100644 --- a/internal/api/oauth_token.go +++ b/internal/api/oauth_token.go @@ -26,9 +26,9 @@ import ( // @Tags Authentication // @Accept json // @Produce json -// @Param request body form.OAuthCreateToken true "token request (supports client_credentials, password, or session grant)" -// @Success 200 {object} gin.H -// @Failure 400,401,429 {object} i18n.Response +// @Param request body form.OAuthCreateToken true "token request (supports client_credentials, password, or session grant)" +// @Success 200 {object} gin.H +// @Failure 400,401,403,429 {object} i18n.Response // @Router /api/v1/oauth/token [post] func OAuthToken(router *gin.RouterGroup) { router.POST("/oauth/token", func(c *gin.Context) { @@ -53,6 +53,30 @@ func OAuthToken(router *gin.RouterGroup) { // Disable caching of responses. c.Header(header.CacheControl, header.CacheControlNoStore) + // The OIDC authorization_code grant is handled by the Portal OIDC OP, which + // parses and validates the request itself. Delegating here keeps a single + // OIDC-compliant token_endpoint while the client_credentials, password, and + // session grants below stay unchanged and DB-backed. The check runs before + // the form binding because form.OAuthCreateToken.Validate rejects this grant + // and a client_secret_basic request would otherwise be read as + // client_credentials. It is gated on a form content type so that peeking at + // the body here does not consume it in a way that masks the missing-body + // error the binding below relies on, and because per RFC 6749 the token + // endpoint is always form-encoded. Builds without the OP report the grant as + // unsupported. + if c.ContentType() == header.ContentTypeForm && authn.Grant(c.PostForm("grant_type")) == authn.GrantAuthorizationCode { + if OAuthAuthorizationCodeHandler != nil { + OAuthAuthorizationCodeHandler(c) + return + } + event.AuditWarn([]string{clientIp, "oauth2", actor, action, authn.ErrInvalidGrantType.Error()}) + c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{ + "error": "unsupported_grant_type", + "error_description": "grant_type is not supported", + }) + return + } + // Token create request form. var frm form.OAuthCreateToken var sess *entity.Session @@ -129,6 +153,13 @@ func OAuthToken(router *gin.RouterGroup) { // Create new client session. sess = client.NewSession(c, authn.GrantClientCredentials) case authn.GrantPassword, authn.GrantSession: + // Reject minting app passwords when the feature is disabled. + if get.Config().DisableAppPasswords() { + event.AuditWarn([]string{clientIp, "oauth2", actor, action, "app passwords disabled", status.Denied}) + AbortFeatureDisabled(c) + return + } + // Generate an app password for a user account and check the password for confirmation. s := Session(clientIp, AuthToken(c)) diff --git a/internal/api/oauth_token_test.go b/internal/api/oauth_token_test.go index e35604ce3..9166c1fc4 100644 --- a/internal/api/oauth_token_test.go +++ b/internal/api/oauth_token_test.go @@ -7,6 +7,7 @@ import ( "strings" "testing" + "github.com/gin-gonic/gin" "github.com/stretchr/testify/assert" "github.com/photoprism/photoprism/internal/config" @@ -14,6 +15,101 @@ import ( "github.com/photoprism/photoprism/pkg/http/header" ) +// TestOAuthToken_AuthorizationCode covers the authorization_code grant branch +// that OAuthToken delegates to OAuthAuthorizationCodeHandler (the Portal OIDC OP +// token handler in production). The branch runs before the CE form binding, so +// it must also work with client_secret_basic credentials. +func TestOAuthToken_AuthorizationCode(t *testing.T) { + t.Run("UnsupportedWhenNoHook", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + prev := OAuthAuthorizationCodeHandler + OAuthAuthorizationCodeHandler = nil + defer func() { OAuthAuthorizationCodeHandler = prev }() + + OAuthToken(router) + + data := url.Values{ + "grant_type": {authn.GrantAuthorizationCode.String()}, + "code": {"raw-code"}, + "redirect_uri": {"https://photos.example.com/cb"}, + "code_verifier": {"verifier"}, + "client_id": {"cs5cpu17n6gj2qo5"}, + } + req, _ := http.NewRequest(http.MethodPost, "/api/v1/oauth/token", strings.NewReader(data.Encode())) + req.Header.Set(header.ContentType, header.ContentTypeForm) + w := httptest.NewRecorder() + app.ServeHTTP(w, req) + + assert.Equal(t, http.StatusBadRequest, w.Code) + assert.Contains(t, w.Body.String(), "unsupported_grant_type") + }) + t.Run("DelegatesToHook", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + prev := OAuthAuthorizationCodeHandler + OAuthAuthorizationCodeHandler = func(c *gin.Context) { + c.String(http.StatusOK, "delegated:"+c.PostForm("grant_type")) + } + defer func() { OAuthAuthorizationCodeHandler = prev }() + + OAuthToken(router) + + data := url.Values{ + "grant_type": {authn.GrantAuthorizationCode.String()}, + "code": {"raw-code"}, + } + req, _ := http.NewRequest(http.MethodPost, "/api/v1/oauth/token", strings.NewReader(data.Encode())) + req.Header.Set(header.ContentType, header.ContentTypeForm) + w := httptest.NewRecorder() + app.ServeHTTP(w, req) + + assert.Equal(t, http.StatusOK, w.Code) + assert.Equal(t, "delegated:authorization_code", w.Body.String()) + }) + t.Run("DelegatesWithBasicAuthCredentials", func(t *testing.T) { + // client_secret_basic puts the credentials in the Authorization header + // while grant_type stays in the body. The delegation must trigger off the + // body grant_type (not be hijacked into the client_credentials path) and + // leave the Basic credentials readable by the delegated handler. + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + var gotID, gotSecret string + var gotBasic bool + prev := OAuthAuthorizationCodeHandler + OAuthAuthorizationCodeHandler = func(c *gin.Context) { + gotID, gotSecret, gotBasic = c.Request.BasicAuth() + c.String(http.StatusOK, "ok") + } + defer func() { OAuthAuthorizationCodeHandler = prev }() + + OAuthToken(router) + + data := url.Values{ + "grant_type": {authn.GrantAuthorizationCode.String()}, + "code": {"raw-code"}, + "code_verifier": {"verifier"}, + "redirect_uri": {"https://photos.example.com/cb"}, + } + req, _ := http.NewRequest(http.MethodPost, "/api/v1/oauth/token", strings.NewReader(data.Encode())) + req.Header.Set(header.ContentType, header.ContentTypeForm) + req.SetBasicAuth("cs5cpu17n6gj2qo5", "client-secret") + w := httptest.NewRecorder() + app.ServeHTTP(w, req) + + assert.Equal(t, http.StatusOK, w.Code) + assert.True(t, gotBasic, "BasicAuth must stay readable by the delegated handler") + assert.Equal(t, "cs5cpu17n6gj2qo5", gotID) + assert.Equal(t, "client-secret", gotSecret) + }) +} + func TestOAuthToken(t *testing.T) { t.Run("ClientSuccess", func(t *testing.T) { app, router, conf := NewApiTest() @@ -259,6 +355,36 @@ func TestOAuthToken(t *testing.T) { t.Logf("BODY: %s", w.Body.String()) assert.Equal(t, http.StatusOK, w.Code) }) + t.Run("AppPasswordsDisabled", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + sessId := AuthenticateUser(app, router, "alice", "Alice123!") + + conf.Settings().Features.AppPasswords = false + defer func() { conf.Settings().Features.AppPasswords = true }() + + OAuthToken(router) + + data := url.Values{ + "grant_type": {authn.GrantPassword.String()}, + "client_name": {"AppPasswordAlice"}, + "username": {"alice"}, + "password": {"Alice123!"}, + "scope": {"*"}, + } + + req, _ := http.NewRequest("POST", "/api/v1/oauth/token", strings.NewReader(data.Encode())) + req.Header.Add(header.ContentType, header.ContentTypeForm) + req.Header.Add(header.XAuthToken, sessId) + + w := httptest.NewRecorder() + app.ServeHTTP(w, req) + + t.Logf("BODY: %s", w.Body.String()) + assert.Equal(t, http.StatusForbidden, w.Code) + }) t.Run("UnregisteredUser", func(t *testing.T) { app, router, conf := NewApiTest() conf.SetAuthMode(config.AuthModePasswd) diff --git a/internal/api/oauth_userinfo.go b/internal/api/oauth_userinfo.go index f94a96031..0e8288150 100644 --- a/internal/api/oauth_userinfo.go +++ b/internal/api/oauth_userinfo.go @@ -12,41 +12,53 @@ import ( "github.com/photoprism/photoprism/pkg/i18n" ) -// OAuthUserinfo should return information about the authenticated user, -// see https://github.com/photoprism/photoprism/issues/4369. +// OAuthUserinfo registers the OAuth2/OIDC userinfo endpoint. The behavior is +// provided by OAuthUserinfoHandler, which defaults to a placeholder and is +// replaced by Portal builds with the OIDC OP userinfo handler (see +// oauth_handlers.go and portal/internal/server/register.go). Both GET and POST +// are registered per OIDC Core §5.3.1. // -// @Summary OAuth2 userinfo endpoint (not implemented) +// @Summary OAuth2/OIDC userinfo endpoint // @Id OAuthUserinfo // @Tags Authentication // @Produce json -// @Failure 405 {object} i18n.Response +// @Success 200 {object} gin.H +// @Failure 401,405 {object} i18n.Response // @Router /api/v1/oauth/userinfo [get] +// @Router /api/v1/oauth/userinfo [post] func OAuthUserinfo(router *gin.RouterGroup) { router.GET("/oauth/userinfo", func(c *gin.Context) { - // Prevent CDNs from caching this endpoint. - if header.IsCdn(c.Request) { - AbortNotFound(c) - return - } - - // Disable caching of responses. - c.Header(header.CacheControl, header.CacheControlNoStore) - - // Get client IP address for logs and rate limiting checks. - clientIp := ClientIP(c) - actor := "unknown client" - action := "userinfo" - - // Abort if running in public mode. - if get.Config().Public() { - event.AuditErr([]string{clientIp, "oauth2", actor, action, authn.ErrDisabledInPublicMode.Error()}) - Abort(c, http.StatusForbidden, i18n.ErrForbidden) - return - } - - // TODO: see https://github.com/photoprism/photoprism/issues/4369 - - // Send response. - c.JSON(http.StatusMethodNotAllowed, gin.H{"status": StatusFailed}) + OAuthUserinfoHandler(c) + }) + router.POST("/oauth/userinfo", func(c *gin.Context) { + OAuthUserinfoHandler(c) }) } + +// defaultOAuthUserinfo is the placeholder userinfo handler used unless a Portal +// build overrides OAuthUserinfoHandler with the OIDC OP userinfo handler. +func defaultOAuthUserinfo(c *gin.Context) { + // Prevent CDNs from caching this endpoint. + if header.IsCdn(c.Request) { + AbortNotFound(c) + return + } + + // Disable caching of responses. + c.Header(header.CacheControl, header.CacheControlNoStore) + + // Get client IP address for logs and rate limiting checks. + clientIp := ClientIP(c) + actor := "unknown client" + action := "userinfo" + + // Abort if running in public mode. + if get.Config().Public() { + event.AuditErr([]string{clientIp, "oauth2", actor, action, authn.ErrDisabledInPublicMode.Error()}) + Abort(c, http.StatusForbidden, i18n.ErrForbidden) + return + } + + // The OIDC OP userinfo endpoint is only available on Portal builds. + c.JSON(http.StatusMethodNotAllowed, gin.H{"status": StatusFailed}) +} diff --git a/internal/api/oauth_userinfo_test.go b/internal/api/oauth_userinfo_test.go index f36f6f9de..eb0ba7798 100644 --- a/internal/api/oauth_userinfo_test.go +++ b/internal/api/oauth_userinfo_test.go @@ -4,7 +4,10 @@ import ( "net/http" "testing" + "github.com/gin-gonic/gin" "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/config" ) func TestOAuthUserinfo(t *testing.T) { @@ -16,4 +19,42 @@ func TestOAuthUserinfo(t *testing.T) { r := PerformRequest(app, http.MethodGet, "/api/v1/oauth/userinfo") assert.Equal(t, http.StatusForbidden, r.Code) }) + t.Run("DefaultNotImplemented", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + OAuthUserinfo(router) + + r := PerformRequest(app, http.MethodGet, "/api/v1/oauth/userinfo") + assert.Equal(t, http.StatusMethodNotAllowed, r.Code) + }) + t.Run("PostRouteRegistered", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + OAuthUserinfo(router) + + // POST must route to the same handler per OIDC Core §5.3.1. + r := PerformRequest(app, http.MethodPost, "/api/v1/oauth/userinfo") + assert.Equal(t, http.StatusMethodNotAllowed, r.Code) + }) + t.Run("OverrideHookDelegates", func(t *testing.T) { + app, router, _ := NewApiTest() + + OAuthUserinfo(router) + + prev := OAuthUserinfoHandler + OAuthUserinfoHandler = func(c *gin.Context) { c.String(http.StatusOK, "delegated:"+c.Request.Method) } + defer func() { OAuthUserinfoHandler = prev }() + + get := PerformRequest(app, http.MethodGet, "/api/v1/oauth/userinfo") + assert.Equal(t, http.StatusOK, get.Code) + assert.Equal(t, "delegated:GET", get.Body.String()) + + post := PerformRequest(app, http.MethodPost, "/api/v1/oauth/userinfo") + assert.Equal(t, http.StatusOK, post.Code) + assert.Equal(t, "delegated:POST", post.Body.String()) + }) } diff --git a/internal/api/oidc_login.go b/internal/api/oidc_login.go index 615802450..d48299486 100644 --- a/internal/api/oidc_login.go +++ b/internal/api/oidc_login.go @@ -55,7 +55,7 @@ func OIDCLogin(router *gin.RouterGroup) { // Abort if failure rate limit is exceeded. if r.Reject() || limiter.Auth.Reject(clientIp) { - c.HTML(http.StatusTooManyRequests, "auth.gohtml", CreateSessionError(http.StatusTooManyRequests, i18n.Error(i18n.ErrTooManyRequests))) + c.HTML(http.StatusTooManyRequests, "auth.gohtml", CreateSessionError(http.StatusTooManyRequests, i18n.ErrTooManyRequests)) return } @@ -64,7 +64,7 @@ func OIDCLogin(router *gin.RouterGroup) { if provider == nil { event.AuditErr([]string{clientIp, "create session", "oidc", authn.ErrInvalidProviderConfiguration.Error()}) - c.HTML(http.StatusInternalServerError, "auth.gohtml", CreateSessionError(http.StatusInternalServerError, i18n.Error(i18n.ErrConnectionFailed))) + c.HTML(http.StatusInternalServerError, "auth.gohtml", CreateSessionError(http.StatusInternalServerError, i18n.ErrConnectionFailed)) return } diff --git a/internal/api/oidc_redirect.go b/internal/api/oidc_redirect.go index 16ed71cf6..ee7c83ca0 100644 --- a/internal/api/oidc_redirect.go +++ b/internal/api/oidc_redirect.go @@ -7,6 +7,7 @@ import ( "github.com/gin-gonic/gin" + "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/internal/auth/oidc" "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/event" @@ -24,6 +25,35 @@ import ( "github.com/photoprism/photoprism/pkg/txt" ) +// oidcRedirectErrorMessage maps a standard OAuth/OIDC error code received on the +// RP callback to a branded, translatable message shown to the user. +func oidcRedirectErrorMessage(code string) i18n.Message { + switch code { + case "access_denied": + return i18n.ErrForbidden + case "login_required": + return i18n.ErrUnauthorized + case "server_error", "temporarily_unavailable": + // Provider-side failures are operational, not credential problems. + return i18n.ErrUnexpected + default: + return i18n.ErrInvalidCredentials + } +} + +// oidcReconcileHint returns an operator-facing message explaining how to adopt a +// pre-existing account into the OIDC identity it collided with at login. Linking +// stays manual on purpose: auto-binding an OIDC subject onto an existing local or +// 2FA account would be an account-takeover vector. +func oidcReconcileHint(userName, provider, subject string) string { + if provider == "" { + provider = authn.ProviderDefault.String() + } + + return fmt.Sprintf("account %s uses %s authentication and must be linked before it can sign in via oidc; adopt it with 'photoprism users mod %s --auth oidc --auth-id %s' or sign in locally", + clean.LogQuote(userName), clean.LogQuote(provider), userName, clean.Log(subject)) +} + // OIDCRedirect completes the OIDC flow, creates a session, and renders a page that stores the token client-side. // // @Summary complete OIDC login (callback) @@ -70,7 +100,15 @@ func OIDCRedirect(router *gin.RouterGroup) { // Abort if failure rate limit is exceeded. if r.Reject() || limiter.Auth.Reject(clientIp) { - c.HTML(http.StatusTooManyRequests, "auth.gohtml", CreateSessionError(http.StatusTooManyRequests, i18n.Error(i18n.ErrTooManyRequests))) + c.HTML(http.StatusTooManyRequests, "auth.gohtml", CreateSessionError(http.StatusTooManyRequests, i18n.ErrTooManyRequests)) + return + } + + // The provider may redirect back with an OAuth error instead of a code (e.g. + // access_denied). Surface it in the instance's branded UI, not a silent bounce. + if oauthErr := c.Query("error"); oauthErr != "" { + event.AuditWarn([]string{clientIp, "create session", "oidc", "provider returned error", clean.Log(oauthErr), clean.Log(c.Query("error_description"))}) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, oidcRedirectErrorMessage(oauthErr))) return } @@ -86,7 +124,7 @@ func OIDCRedirect(router *gin.RouterGroup) { if provider == nil { event.AuditErr([]string{clientIp, "create session", "oidc", authn.ErrInvalidProviderConfiguration.Error()}) - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrInvalidCredentials))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrInvalidCredentials)) return } @@ -94,7 +132,12 @@ func OIDCRedirect(router *gin.RouterGroup) { userInfo, tokens, claimErr := provider.CodeExchangeUserInfo(c) if claimErr != nil { + // The code exchange failed (e.g. a missing/expired state cookie). Render a + // branded page that returns the user to login instead of leaving them on a + // raw, dead-end error with no way forward. event.AuditErr([]string{clientIp, "create session", "oidc", claimErr.Error()}) + event.LoginError(clientIp, "oidc", userName, userAgent, claimErr.Error()) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrUnexpected)) return } @@ -128,13 +171,13 @@ func OIDCRedirect(router *gin.RouterGroup) { message := "IdP omitted some or all groups; cannot validate required groups" event.AuditErr([]string{clientIp, "create session", "oidc", message}) event.LoginError(clientIp, "oidc", userName, userAgent, message) - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrForbidden))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrForbidden)) return case !oidc.HasAnyGroup(groups, requiredGroups): message := "missing required group membership" event.AuditErr([]string{clientIp, "create session", "oidc", message}) event.LoginError(clientIp, "oidc", userName, userAgent, message) - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrForbidden))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrForbidden)) return } } @@ -142,6 +185,14 @@ func OIDCRedirect(router *gin.RouterGroup) { mappedRole, hasMappedRole := oidc.MapGroupsToRole(groups, conf.OIDCGroupRoles()) defaultRole := conf.OIDCRole() + // A PhotoPrism Portal OP grants the instance login role via the pp_role + // claim (gated by pp_issuer_kind); prefer the verified ID token, then user + // info. It takes precedence over the group mapping below. + portalRole, hasPortalRole := oidc.PortalGrantedRole(idTokenClaims) + if !hasPortalRole { + portalRole, hasPortalRole = oidc.PortalGrantedRole(userInfo.Claims) + } + // Step 1: Create user account if it does not exist yet. var user *entity.User var err error @@ -154,13 +205,13 @@ func OIDCRedirect(router *gin.RouterGroup) { } else if _, emailDomain, _ := strings.Cut(userEmail, "@"); emailDomain == "" || !userInfo.EmailVerified { event.AuditErr([]string{clientIp, "create session", "oidc", authn.ErrVerifiedEmailRequired.Error()}) event.LoginError(clientIp, "oidc", userEmail, userAgent, authn.ErrVerifiedEmailRequired.Error()) - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrForbidden))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrVerifiedEmailRequired)) return } else if !strings.HasSuffix("."+emailDomain, "."+domain) { message := fmt.Sprintf("domain must match '%s'", domain) event.AuditErr([]string{clientIp, "create session", "oidc", userEmail, message}) event.LoginError(clientIp, "oidc", userEmail, userAgent, message) - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrForbidden))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrForbidden)) return } @@ -168,19 +219,19 @@ func OIDCRedirect(router *gin.RouterGroup) { if oidcUser := entity.OidcUser(userInfo, provider.Issuer(), oidc.Username(userInfo, conf.OIDCUsername())); authn.ProviderOIDC.NotEqual(oidcUser.AuthProvider) { event.AuditErr([]string{clientIp, "create session", "oidc", authn.ErrAuthProviderIsNotOIDC.Error()}) event.LoginError(clientIp, "oidc", oidcUser.UserName, userAgent, authn.ErrAuthProviderIsNotOIDC.Error()) - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrInvalidCredentials))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrInvalidCredentials)) return } else if oidcUser.UserName == "" { event.AuditErr([]string{clientIp, "create session", "oidc", authn.ErrUsernameRequiredToRegister.Error()}) event.LoginError(clientIp, "oidc", oidcUser.UserName, userAgent, authn.ErrUsernameRequiredToRegister.Error()) - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrInvalidCredentials))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrInvalidCredentials)) return } else if user = entity.FindUser(oidcUser); user != nil { // Ensure user has a username. if user.Username() == "" { event.AuditErr([]string{clientIp, "create session", "oidc", oidcUser.UserName, authn.ErrUsernameRequired.Error()}) event.LoginError(clientIp, "oidc", oidcUser.UserName, userAgent, authn.ErrUsernameRequired.Error()) - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrInvalidCredentials))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrInvalidCredentials)) return } @@ -192,17 +243,22 @@ func OIDCRedirect(router *gin.RouterGroup) { case !user.CanLogIn(): event.AuditErr([]string{clientIp, "create session", "oidc", userName, authn.ErrAccountDisabled.Error()}) event.LoginError(clientIp, "oidc", userName, userAgent, authn.ErrAccountDisabled.Error()) - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrInvalidCredentials))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrInvalidCredentials)) return case authn.ProviderOIDC.NotEqual(user.AuthProvider): - event.AuditErr([]string{clientIp, "create session", "oidc", userName, authn.ErrAuthProviderIsNotOIDC.Error()}) - event.LoginError(clientIp, "oidc", userName, userAgent, authn.ErrAuthProviderIsNotOIDC.Error()) - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrInvalidCredentials))) + // Claimable collision: a non-OIDC account matched the login. Log the + // specific remedy so the denial is actionable instead of a bare + // "provider is not oidc"; the user-facing message stays generic to + // avoid disclosing the account exists. + hint := oidcReconcileHint(userName, user.AuthProvider, oidcUser.AuthID) + event.AuditErr([]string{clientIp, "create session", "oidc", userName, authn.ErrAuthProviderIsNotOIDC.Error(), hint}) + event.LoginError(clientIp, "oidc", userName, userAgent, authn.ErrAuthProviderIsNotOIDC.Error()+": "+hint) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrInvalidCredentials)) return case user.AuthID == "" || oidcUser.AuthID == "" || user.AuthID != oidcUser.AuthID: event.AuditErr([]string{clientIp, "create session", "oidc", userName, authn.ErrInvalidAuthID.Error()}) event.LoginError(clientIp, "oidc", userName, userAgent, authn.ErrInvalidAuthID.Error()) - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrInvalidCredentials))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrInvalidCredentials)) return } @@ -254,14 +310,27 @@ func OIDCRedirect(router *gin.RouterGroup) { user.Details().BirthYear = birthDate.Year() } - // Update email, if verified. - if userInfo.EmailVerified { + // Update email only when the IdP marks it verified and no other account + // holds it. The email is informational, so a clash never blocks login; the + // Portal OP forwards real verification state, so unverified cluster emails + // are simply not stored. + if bool(userInfo.EmailVerified) && entity.UserEmailAvailable(userInfo.Email, user.UserUID) { user.UserEmail = clean.Email(userInfo.Email) user.VerifiedAt = entity.TimeStamp() } - if hasMappedRole && !user.HasRole(mappedRole) { - user.SetRole(mappedRole.String()) + // Apply a federated role only when federation may set it: an existing + // cluster_admin/visitor account is never touched, and the IdP can never + // escalate to a non-federatable role. A Portal-granted pp_role takes + // precedence over the group mapping. + if hasPortalRole { + if role, ok := acl.FederatedRoleUpdate(user.AclRole(), portalRole); ok { + user.SetRole(role.String()) + } + } else if hasMappedRole { + if role, ok := acl.FederatedRoleUpdate(user.AclRole(), mappedRole); ok { + user.SetRole(role.String()) + } } // Update Subject ID and Issuer URI. @@ -271,7 +340,7 @@ func OIDCRedirect(router *gin.RouterGroup) { if err = user.Save(); err != nil { event.AuditErr([]string{clientIp, "create session", "oidc", userName, authn.ErrAccountUpdateFailed.Error(), err.Error()}) event.LoginError(clientIp, "oidc", userName, userAgent, authn.ErrAccountUpdateFailed.Error()+" ("+err.Error()+")") - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrInvalidCredentials))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrInvalidCredentials)) return } @@ -285,7 +354,7 @@ func OIDCRedirect(router *gin.RouterGroup) { userName = oidcUser.Username() event.AuditWarn([]string{clientIp, "create session", "oidc", "create user", userName, authn.ErrUsersQuotaExceeded.Error()}) event.LoginError(clientIp, "oidc", userName, userAgent, authn.ErrUsersQuotaExceeded.Error()) - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrQuotaExceeded))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrQuotaExceeded)) return } else if conf.OIDCRegister() { // Create new user record. @@ -335,14 +404,21 @@ func OIDCRedirect(router *gin.RouterGroup) { user.Details().BirthYear = birthDate.Year() } - // Set email, if verified. - if userInfo.EmailVerified { + // Set email only when the IdP marks it verified and no other account + // holds it. The email is informational (not an auth identifier), so a + // clash never blocks provisioning; the Portal OP forwards real + // verification state, so unverified cluster emails are simply not stored. + if bool(userInfo.EmailVerified) && entity.UserEmailAvailable(userInfo.Email, user.UserUID) { user.UserEmail = clean.Email(userInfo.Email) user.VerifiedAt = entity.TimeStamp() } - // Set user role and permissions. - if hasMappedRole { + // Set user role and permissions. A Portal-granted pp_role wins, then a + // group-mapped role when federation may set it, else the configured + // default; all are filtered to federatable roles (no cluster_admin/visitor). + if hasPortalRole { + user.SetRole(portalRole.String()) + } else if hasMappedRole && acl.IsFederatedRole(mappedRole) { user.SetRole(mappedRole.String()) } else { user.SetRole(defaultRole.String()) @@ -354,12 +430,12 @@ func OIDCRedirect(router *gin.RouterGroup) { if err = user.Create(); err != nil { event.AuditErr([]string{clientIp, "create session", "oidc", userName, authn.ErrAccountCreateFailed.Error(), err.Error()}) event.LoginError(clientIp, "oidc", userName, userAgent, authn.ErrAccountCreateFailed.Error()+" ("+err.Error()+")") - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrInvalidCredentials))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrInvalidCredentials)) return } else if err = user.UpdateAuthID(userInfo.Subject, provider.Issuer()); err != nil { event.AuditErr([]string{clientIp, "create session", "oidc", userName, authn.ErrAccountUpdateFailed.Error(), err.Error()}) event.LoginError(clientIp, "oidc", userName, userAgent, authn.ErrAccountUpdateFailed.Error()+" ("+err.Error()+")") - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrInvalidCredentials))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrInvalidCredentials)) return } @@ -372,7 +448,7 @@ func OIDCRedirect(router *gin.RouterGroup) { } else { event.AuditErr([]string{clientIp, "create session", "oidc", userName, authn.ErrRegistrationDisabled.Error()}) event.LoginError(clientIp, "oidc", userName, userAgent, authn.ErrRegistrationDisabled.Error()) - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrInvalidCredentials))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrRegistrationDisabled)) return } @@ -380,7 +456,7 @@ func OIDCRedirect(router *gin.RouterGroup) { if !user.CanLogIn() { event.AuditErr([]string{clientIp, "create session", "oidc", userName, authn.ErrAccountDisabled.Error()}) event.LoginError(clientIp, "oidc", userName, userAgent, authn.ErrAccountDisabled.Error()) - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrInvalidCredentials))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrInvalidCredentials)) return } @@ -392,6 +468,18 @@ func OIDCRedirect(router *gin.RouterGroup) { sess.SetUser(user) sess.SetGrantType(authn.GrantAuthorizationCode) + // On Portal builds, persist the normalized login-time group set on the + // session so group-based instance access resolves at authorize time + // without a second IdP round-trip. Overage with no groups stores an + // empty set, so group-based grants deny rather than admit blindly. + // Instance/CE sessions don't store groups — they have no resolver and + // the session API must not become a group-membership side channel. + if conf.Portal() { + if merged := oidc.MergeGroups(groups); len(merged) > 0 { + sess.SetData(sess.GetData().SetGroups(merged)) + } + } + // Ensure that the ID token fits into the existing // database column; otherwise, truncate it. if n := len(tokens.IDToken); n > 2048 { @@ -407,11 +495,11 @@ func OIDCRedirect(router *gin.RouterGroup) { // Save session after successful authentication. if sess, err = get.Session().Save(sess); err != nil { event.AuditErr([]string{clientIp, "create session", "oidc", userName, status.Error(err)}) - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrInvalidCredentials))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrInvalidCredentials)) return } else if sess == nil { event.AuditErr([]string{clientIp, "create session", "oidc", userName, status.Failed}) - c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.Error(i18n.ErrUnexpected))) + c.HTML(http.StatusUnauthorized, "auth.gohtml", CreateSessionError(http.StatusUnauthorized, i18n.ErrUnexpected)) return } diff --git a/internal/api/oidc_redirect_test.go b/internal/api/oidc_redirect_test.go index 57833d492..8333ddaa8 100644 --- a/internal/api/oidc_redirect_test.go +++ b/internal/api/oidc_redirect_test.go @@ -2,13 +2,32 @@ package api import ( "net/http" + "strings" "testing" + "github.com/gin-gonic/gin" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/pkg/i18n" ) +func TestOidcReconcileHint(t *testing.T) { + t.Run("LocalProvider", func(t *testing.T) { + hint := oidcReconcileHint("alice", "local", "us12345") + assert.Contains(t, hint, "account 'alice'") + assert.Contains(t, hint, "'local' authentication") + assert.Contains(t, hint, "photoprism users mod alice --auth oidc --auth-id us12345") + assert.Contains(t, hint, "sign in locally") + }) + t.Run("EmptyProviderDefaults", func(t *testing.T) { + hint := oidcReconcileHint("admin", "", "us67890") + assert.Contains(t, hint, "'default' authentication") + assert.Contains(t, hint, "photoprism users mod admin --auth oidc --auth-id us67890") + }) +} + func TestOIDCRedirect(t *testing.T) { t.Run("PublicMode", func(t *testing.T) { app, router, _ := NewApiTest() @@ -43,4 +62,89 @@ func TestOIDCRedirect(t *testing.T) { r := PerformRequest(app, http.MethodGet, "/api/v1/oidc/redirect") assert.Equal(t, http.StatusTemporaryRedirect, r.Code) }) + t.Run("AuthTemplatePreservesSessionStoragePreference", func(t *testing.T) { + app := gin.New() + conf := config.TestConfig() + app.LoadHTMLFiles(conf.TemplateFiles()...) + app.GET("/oidc-auth-template", func(c *gin.Context) { + c.HTML(http.StatusOK, "auth.gohtml", gin.H{ + "status": StatusSuccess, + "session_id": "sess1example", + "access_token": "token1example", + "provider": "oidc", + "user": gin.H{ + "ID": 1, + "Name": "alice", + "DisplayName": "Alice", + }, + "config": conf.ClientPublic(), + }) + }) + + r := PerformRequest(app, http.MethodGet, "/oidc-auth-template") + require.Equal(t, http.StatusOK, r.Code) + + body := r.Body.String() + sessionDataKeys := extractTemplateList(t, body, "const sessionDataKeys = [", "];") + assert.Contains(t, sessionDataKeys, `"session.token"`) + assert.NotContains(t, sessionDataKeys, `"session"`) + assert.Contains(t, body, `localStorage.getItem(namespacedKey("session")) === "true"`) + }) +} + +func TestOIDCRedirectErrorMessage(t *testing.T) { + assert.Equal(t, i18n.ErrForbidden, oidcRedirectErrorMessage("access_denied")) + assert.Equal(t, i18n.ErrUnauthorized, oidcRedirectErrorMessage("login_required")) + assert.Equal(t, i18n.ErrUnexpected, oidcRedirectErrorMessage("server_error")) + assert.Equal(t, i18n.ErrUnexpected, oidcRedirectErrorMessage("temporarily_unavailable")) + assert.Equal(t, i18n.ErrInvalidCredentials, oidcRedirectErrorMessage("")) +} + +// TestOIDCRedirect_ProviderError covers the RP callback receiving an OAuth error +// (no code) from the OP — it must render the instance's branded error page, not +// silently bounce to the login form. +func TestOIDCRedirect_ProviderError(t *testing.T) { + _, _, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + conf.Options().OIDCUri = "https://dummy-oidc.example.com/" + conf.Options().SiteUrl = "https://app.localssl.dev/" + conf.Options().OIDCClient = "photoprism-develop" + conf.Options().OIDCSecret = "9d8351a0-ca01-4556-9c37-85eb634869b9" + t.Cleanup(func() { + conf.SetAuthMode(config.AuthModePublic) + conf.Options().OIDCUri = "" + conf.Options().OIDCClient = "" + conf.Options().OIDCSecret = "" + }) + require.True(t, conf.OIDCEnabled()) + + app := gin.New() + app.LoadHTMLFiles(conf.TemplateFiles()...) + router := app.Group("/api/v1") + OIDCRedirect(router) + + r := PerformRequest(app, http.MethodGet, "/api/v1/oidc/redirect?error=access_denied&error_description=no+access+to+the+requested+instance&state=s1") + require.Equal(t, http.StatusUnauthorized, r.Code, "an OAuth error redirect must render the branded error page; body=%s", r.Body.String()) + body := r.Body.String() + // auth.gohtml renders the failed-status branch and stores the branded message. + assert.Contains(t, body, `setItem("session.error"`) + assert.Contains(t, body, i18n.Error(i18n.ErrForbidden).Error()) + // The page also carries the message key (messageId) so the Web UI can render + // it in the current UI locale; notify.vue applies Tp to the source string. + assert.Contains(t, body, `setItem("session.messageId"`) + assert.Contains(t, body, i18n.Source(i18n.ErrForbidden)) +} + +// extractTemplateList returns the template source between the provided markers. +func extractTemplateList(t *testing.T, body string, start string, end string) string { + t.Helper() + + startIndex := strings.Index(body, start) + require.NotEqual(t, -1, startIndex) + + listStart := startIndex + len(start) + endIndex := strings.Index(body[listStart:], end) + require.NotEqual(t, -1, endIndex) + + return body[listStart : listStart+endIndex] } diff --git a/internal/api/oidc_session_cookie.go b/internal/api/oidc_session_cookie.go new file mode 100644 index 000000000..e001a4ce1 --- /dev/null +++ b/internal/api/oidc_session_cookie.go @@ -0,0 +1,259 @@ +package api + +import ( + "crypto/hmac" + "crypto/rand" + "crypto/sha256" + "encoding/base64" + "net/http" + "os" + "path/filepath" + "strconv" + "strings" + "sync" + "time" + + "github.com/gin-gonic/gin" + + "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/internal/photoprism/get" + "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/rnd" +) + +// OIDCSessionCookie is the name of the narrowly-scoped cookie that lets the +// Portal OIDC OP authenticate a browser on a top-level navigation to +// /api/v1/oauth/authorize, which carries no Authorization or X-Auth-Token header. +const OIDCSessionCookie = "oidc_session" + +// OIDCSessionCookieTTL bounds how long the OP session-signal cookie stays valid. +// It is short because the cookie only needs to bridge the brief window between a +// header-less top-level navigation to /api/v1/oauth/authorize and the SPA +// re-presenting its session; it is refreshed on every authenticated session GET. +const OIDCSessionCookieTTL = 10 * time.Minute + +const ( + oidcSessionKeyFile = "oidc_session.key" + oidcSessionKeyLen = 32 +) + +var ( + oidcSessionKeyOnce sync.Once + oidcSessionKey []byte +) + +// OIDCSessionCookiePath returns the URL path the OP session cookie is scoped to, +// derived from where the OAuth endpoints are mounted (the APIv1 base path plus +// "/oauth"). Scoping to the OAuth subtree keeps the cookie off the general API +// surface, so it adds no CSRF vector to state-changing endpoints, while still +// covering the /oauth/authorize endpoint a top-level browser navigation hits. +func OIDCSessionCookiePath(conf *config.Config) string { + if conf == nil { + return config.ApiUri + "/oauth" + } + return conf.BaseUri(config.ApiUri) + "/oauth" +} + +// OIDCSessionCookieClearPath returns the path at which the OP session cookie is +// cleared on logout, or "" when this node has no OP cookie to clear. On the Portal +// it is the local OP path; on an instance whose OIDC OP is the Portal it is derived +// from the issuer (the cookie lives at the Portal's shared-domain path, not the +// instance's /i/<tenant> base), so a cluster-wide Sign-Out works from any node. +func OIDCSessionCookieClearPath(conf *config.Config) string { + if conf == nil { + return "" + } + if conf.Portal() { + return OIDCSessionCookiePath(conf) + } + if conf.OIDCIssuerOnSiteDomain() { + return strings.TrimRight(conf.OIDCUri().Path, "/") + config.ApiUri + "/oauth" + } + return "" +} + +// oidcSessionSignalKey loads (or generates and persists) the HMAC key used to +// sign the OP session-signal cookie, kept under the Portal config keys +// directory. It falls back to a process-local random key when persistence is +// unavailable so sign and verify still agree within a single process. +func oidcSessionSignalKey() []byte { + oidcSessionKeyOnce.Do(func() { + if key := loadOrCreateOIDCSessionKey(); len(key) >= oidcSessionKeyLen { + oidcSessionKey = key + return + } + key := make([]byte, oidcSessionKeyLen) + _, _ = rand.Read(key) + oidcSessionKey = key + log.Warnf("oidc: using a process-local session-signal key because the persistent key could not be loaded or stored; OP session cookies will not verify across restarts or replicas") + }) + return oidcSessionKey +} + +// loadOrCreateOIDCSessionKey reads the persisted HMAC key, creating it on first +// use. Returns nil when no config or writable key path is available. +func loadOrCreateOIDCSessionKey() []byte { + conf := get.Config() + if conf == nil { + return nil + } + dir := filepath.Join(conf.PortalConfigPath(), "keys") + path := filepath.Join(dir, oidcSessionKeyFile) + if b, err := os.ReadFile(path); err == nil && len(b) >= oidcSessionKeyLen { + return b + } + if err := fs.MkdirAll(dir); err != nil { + return nil + } + key := make([]byte, oidcSessionKeyLen) + if _, err := rand.Read(key); err != nil { + return nil + } + if err := os.WriteFile(path, key, fs.ModeSecretFile); err != nil { + return nil + } + return key +} + +// signOIDCSession returns a URL-safe, HMAC-signed value binding sessionID to +// exp. The payload is authenticated but not secret: it carries the session id +// (a hash of the bearer token, not the token itself), so the value is opaque to +// the browser and cannot be replayed against any other endpoint. +func signOIDCSession(sessionID string, exp time.Time) string { + payload := sessionID + "|" + strconv.FormatInt(exp.Unix(), 10) + mac := hmac.New(sha256.New, oidcSessionSignalKey()) + mac.Write([]byte(payload)) + return base64.RawURLEncoding.EncodeToString([]byte(payload)) + "." + + base64.RawURLEncoding.EncodeToString(mac.Sum(nil)) +} + +// parseOIDCSession verifies a signed value and returns the embedded session id +// when the signature is valid and the value has not expired. The HMAC check is +// constant-time, so a forged or tampered value cannot be distinguished by +// response timing. +func parseOIDCSession(value string) (sessionID string, ok bool) { + encPayload, encSig, found := strings.Cut(value, ".") + if !found { + return "", false + } + payload, err := base64.RawURLEncoding.DecodeString(encPayload) + if err != nil { + return "", false + } + sig, err := base64.RawURLEncoding.DecodeString(encSig) + if err != nil { + return "", false + } + mac := hmac.New(sha256.New, oidcSessionSignalKey()) + mac.Write(payload) + if !hmac.Equal(sig, mac.Sum(nil)) { + return "", false + } + id, expStr, found := strings.Cut(string(payload), "|") + if !found { + return "", false + } + expUnix, err := strconv.ParseInt(expStr, 10, 64) + if err != nil || time.Now().After(time.Unix(expUnix, 0)) { + return "", false + } + if !rnd.IsSessionID(id) { + return "", false + } + return id, true +} + +// SetOIDCSessionCookie writes the OP session-signal cookie for sess: a +// short-lived, HMAC-signed reference to the session id, NOT the bearer token. +// The OIDC OP /api/v1/oauth/authorize endpoint reads it to resume an +// authenticated browser on a top-level navigation that carries no Authorization +// header. Because the value is the session id (a hash of the token) rather than +// the token, a leaked cookie cannot authenticate any other API endpoint, and +// the HMAC signature plus short TTL prevent forging or extending it. +func SetOIDCSessionCookie(c *gin.Context, sess *entity.Session, cookiePath string, secure bool) { + // Only user sessions are eligible: the OP authorize endpoint resumes a user, + // and the reader rejects user-less (client/service) sessions via NoUser(), so + // setting the cookie for them would only emit a signal that can never resolve. + if c == nil || sess == nil || !rnd.IsSessionID(sess.ID) || sess.NoUser() { + return + } + + if cookiePath == "" { + cookiePath = config.ApiUri + "/oauth" + } + + value := signOIDCSession(sess.ID, time.Now().Add(OIDCSessionCookieTTL)) + + http.SetCookie(c.Writer, &http.Cookie{ + Name: OIDCSessionCookie, + Value: value, + Path: cookiePath, + MaxAge: int(OIDCSessionCookieTTL.Seconds()), + Secure: secure, + HttpOnly: true, + SameSite: http.SameSiteLaxMode, + }) +} + +// ClearOIDCSessionCookie removes the OP session cookie, e.g. on logout. The +// cookiePath must match the value used by SetOIDCSessionCookie so the browser +// overwrites the same cookie. +func ClearOIDCSessionCookie(c *gin.Context, cookiePath string, secure bool) { + if c == nil { + return + } + + if cookiePath == "" { + cookiePath = config.ApiUri + "/oauth" + } + + http.SetCookie(c.Writer, &http.Cookie{ + Name: OIDCSessionCookie, + Value: "", + Path: cookiePath, + MaxAge: -1, + Secure: secure, + HttpOnly: true, + SameSite: http.SameSiteLaxMode, + }) +} + +// OIDCSessionCookieSession resolves the Portal session referenced by the OP +// session-signal cookie, or nil when the cookie is absent, invalid, expired, or +// no longer maps to an active user session. A present-but-unresolvable cookie is +// cleared so the browser stops sending a stale signal. It is the only reader of +// the cookie and must be used solely by the OIDC OP authorize handler as a +// fallback when no Authorization/X-Auth-Token header is present. +func OIDCSessionCookieSession(c *gin.Context) *entity.Session { + if c == nil { + return nil + } + + raw, err := c.Cookie(OIDCSessionCookie) + if err != nil || raw == "" { + return nil + } + + conf := get.Config() + cookiePath := config.ApiUri + "/oauth" + secure := false + if conf != nil { + cookiePath = OIDCSessionCookiePath(conf) + secure = conf.SiteHttps() + } + + sessionID, ok := parseOIDCSession(raw) + if !ok { + ClearOIDCSessionCookie(c, cookiePath, secure) + return nil + } + + sess, err := entity.FindSession(sessionID) + if err != nil || sess == nil || sess.Invalid() || sess.NoUser() { + ClearOIDCSessionCookie(c, cookiePath, secure) + return nil + } + + return sess +} diff --git a/internal/api/oidc_session_cookie_test.go b/internal/api/oidc_session_cookie_test.go new file mode 100644 index 000000000..1912d1fc4 --- /dev/null +++ b/internal/api/oidc_session_cookie_test.go @@ -0,0 +1,261 @@ +package api + +import ( + "net/http" + "net/http/httptest" + "os" + "path/filepath" + "testing" + "time" + + "github.com/gin-gonic/gin" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/internal/photoprism/get" + "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/rnd" +) + +// findCookie returns the named cookie from the recorder, or nil if absent. +func findCookie(w *httptest.ResponseRecorder, name string) *http.Cookie { + for _, ck := range w.Result().Cookies() { + if ck.Name == name { + return ck + } + } + return nil +} + +func TestOIDCSessionCookiePath(t *testing.T) { + t.Run("FromConfig", func(t *testing.T) { + // APIv1 is mounted at conf.BaseUri(config.ApiUri); the cookie must be + // scoped to that path + "/oauth" so the browser sends it to the moved + // /api/v1/oauth/authorize endpoint. + assert.Equal(t, get.Config().BaseUri(config.ApiUri)+"/oauth", OIDCSessionCookiePath(get.Config())) + }) + t.Run("NilConfigFallsBackToBareApiUri", func(t *testing.T) { + assert.Equal(t, config.ApiUri+"/oauth", OIDCSessionCookiePath(nil)) + }) +} + +func TestOIDCSessionCookieClearPath(t *testing.T) { + // mk builds an isolated instance config (NodeRole defaults to instance) with + // the given OIDC issuer and SiteUrl so the derivation can be exercised. + mk := func(issuer, siteURL string) *config.Config { + c := config.NewConfig(config.CliTestContext()) + c.Options().OIDCUri = issuer + c.Options().SiteUrl = siteURL + return c + } + t.Run("NilConfig", func(t *testing.T) { + assert.Equal(t, "", OIDCSessionCookieClearPath(nil)) + }) + t.Run("SharedDomainIssuerAtRoot", func(t *testing.T) { + // Shared-domain Portal at the origin root: the cookie lives at /api/v1/oauth, + // not under the instance's /i/<tenant> base. + c := mk("https://app.localssl.dev/", "https://app.localssl.dev/i/pro-1/") + assert.Equal(t, config.ApiUri+"/oauth", OIDCSessionCookieClearPath(c)) + }) + t.Run("SharedDomainIssuerWithBasePath", func(t *testing.T) { + c := mk("https://app.localssl.dev/portal/", "https://app.localssl.dev/i/pro-1/") + assert.Equal(t, "/portal"+config.ApiUri+"/oauth", OIDCSessionCookieClearPath(c)) + }) + t.Run("SubdomainIsolatedReturnsEmpty", func(t *testing.T) { + // Issuer on a different host than the instance: the host-only OP cookie is + // unreachable, so the instance must not attempt to clear it. + c := mk("https://portal.example.com/", "https://node1.example.com/") + assert.Equal(t, "", OIDCSessionCookieClearPath(c)) + }) + t.Run("ExternalIdPReturnsEmpty", func(t *testing.T) { + c := mk("https://keycloak.example.com/realms/main", "https://app.localssl.dev/i/pro-1/") + assert.Equal(t, "", OIDCSessionCookieClearPath(c)) + }) + t.Run("NoOIDCReturnsEmpty", func(t *testing.T) { + c := mk("", "https://app.localssl.dev/i/pro-1/") + assert.Equal(t, "", OIDCSessionCookieClearPath(c)) + }) +} + +func TestSignParseOIDCSession(t *testing.T) { + id := rnd.SessionID(rnd.AuthToken()) + t.Run("RoundTrip", func(t *testing.T) { + v := signOIDCSession(id, time.Now().Add(time.Minute)) + got, ok := parseOIDCSession(v) + assert.True(t, ok) + assert.Equal(t, id, got) + }) + t.Run("Expired", func(t *testing.T) { + v := signOIDCSession(id, time.Now().Add(-time.Minute)) + _, ok := parseOIDCSession(v) + assert.False(t, ok) + }) + t.Run("Tampered", func(t *testing.T) { + v := signOIDCSession(id, time.Now().Add(time.Minute)) + _, ok := parseOIDCSession(v + "x") + assert.False(t, ok, "a tampered signature must not verify") + }) + t.Run("Malformed", func(t *testing.T) { + for _, in := range []string{"", "no-dot", "a.b", "tooshort.sig"} { + _, ok := parseOIDCSession(in) + assert.False(t, ok, "malformed value %q must not verify", in) + } + }) + t.Run("NonSessionIDPayloadRejected", func(t *testing.T) { + // A correctly-signed value whose payload id is not a session id must + // still be rejected, so the cookie can only ever carry a real session ref. + v := signOIDCSession("not-a-session-id", time.Now().Add(time.Minute)) + _, ok := parseOIDCSession(v) + assert.False(t, ok) + }) +} + +func TestSetOIDCSessionCookie(t *testing.T) { + t.Run("SignsSessionReferenceNotToken", func(t *testing.T) { + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + sess := &entity.Session{ID: rnd.SessionID(rnd.AuthToken()), UserUID: "uqxetse3cy5eo9z2"} + SetOIDCSessionCookie(c, sess, "/api/v1/oauth", true) + ck := findCookie(w, OIDCSessionCookie) + if assert.NotNil(t, ck) { + assert.False(t, rnd.IsAuthToken(ck.Value), "the cookie must not store a usable bearer token") + id, ok := parseOIDCSession(ck.Value) + assert.True(t, ok) + assert.Equal(t, sess.ID, id, "the cookie value must resolve back to the session id") + assert.Equal(t, "/api/v1/oauth", ck.Path) + assert.True(t, ck.HttpOnly) + assert.True(t, ck.Secure) + assert.Equal(t, http.SameSiteLaxMode, ck.SameSite) + assert.Equal(t, int(OIDCSessionCookieTTL.Seconds()), ck.MaxAge) + } + }) + t.Run("EmptyPathFallsBackToBareApiUri", func(t *testing.T) { + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + SetOIDCSessionCookie(c, &entity.Session{ID: rnd.SessionID(rnd.AuthToken()), UserUID: "uqxetse3cy5eo9z2"}, "", true) + ck := findCookie(w, OIDCSessionCookie) + if assert.NotNil(t, ck) { + assert.Equal(t, config.ApiUri+"/oauth", ck.Path) + } + }) + t.Run("InsecureOmitsSecureFlag", func(t *testing.T) { + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + SetOIDCSessionCookie(c, &entity.Session{ID: rnd.SessionID(rnd.AuthToken()), UserUID: "uqxetse3cy5eo9z2"}, "/api/v1/oauth", false) + ck := findCookie(w, OIDCSessionCookie) + if assert.NotNil(t, ck) { + assert.False(t, ck.Secure) + } + }) + t.Run("UserlessSessionSetsNothing", func(t *testing.T) { + // Client/service sessions have no user; the OP cookie would only emit a + // signal the reader rejects via NoUser(), so none is written. + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + SetOIDCSessionCookie(c, &entity.Session{ID: rnd.SessionID(rnd.AuthToken())}, "/api/v1/oauth", true) + assert.Nil(t, findCookie(w, OIDCSessionCookie)) + }) + t.Run("InvalidSessionSetsNothing", func(t *testing.T) { + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + SetOIDCSessionCookie(c, &entity.Session{ID: "tooshort"}, "/api/v1/oauth", true) + assert.Nil(t, findCookie(w, OIDCSessionCookie)) + }) + t.Run("NilSessionSetsNothing", func(t *testing.T) { + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + SetOIDCSessionCookie(c, nil, "/api/v1/oauth", true) + assert.Nil(t, findCookie(w, OIDCSessionCookie)) + }) + t.Run("NilContext", func(t *testing.T) { + assert.NotPanics(t, func() { + SetOIDCSessionCookie(nil, &entity.Session{ID: rnd.SessionID(rnd.AuthToken())}, "/api/v1/oauth", true) + }) + }) +} + +func TestClearOIDCSessionCookie(t *testing.T) { + t.Run("Success", func(t *testing.T) { + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + ClearOIDCSessionCookie(c, "/api/v1/oauth", false) + ck := findCookie(w, OIDCSessionCookie) + if assert.NotNil(t, ck) { + assert.Equal(t, "", ck.Value) + assert.Equal(t, "/api/v1/oauth", ck.Path) + assert.True(t, ck.MaxAge < 0) + } + }) + t.Run("NilContext", func(t *testing.T) { + assert.NotPanics(t, func() { ClearOIDCSessionCookie(nil, "/api/v1/oauth", false) }) + }) +} + +func TestOIDCSessionCookieSession(t *testing.T) { + newCtx := func(ck *http.Cookie) *gin.Context { + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + req, _ := http.NewRequest(http.MethodGet, "/api/v1/oauth/authorize", nil) + if ck != nil { + req.AddCookie(ck) + } + c.Request = req + return c + } + t.Run("AbsentReturnsNil", func(t *testing.T) { + assert.Nil(t, OIDCSessionCookieSession(newCtx(nil))) + }) + t.Run("MalformedReturnsNil", func(t *testing.T) { + c := newCtx(&http.Cookie{Name: OIDCSessionCookie, Value: "garbage"}) + assert.Nil(t, OIDCSessionCookieSession(c)) + }) + t.Run("UnknownSessionReturnsNil", func(t *testing.T) { + // A correctly-signed reference to a session that does not exist resolves + // to nil (and the stale cookie is cleared). + v := signOIDCSession(rnd.SessionID(rnd.AuthToken()), time.Now().Add(time.Minute)) + c := newCtx(&http.Cookie{Name: OIDCSessionCookie, Value: v}) + assert.Nil(t, OIDCSessionCookieSession(c)) + }) + t.Run("NilContext", func(t *testing.T) { + assert.Nil(t, OIDCSessionCookieSession(nil)) + }) +} + +func TestLoadOrCreateOIDCSessionKey(t *testing.T) { + // Use a DB-backed isolated config and restore the global afterwards, matching + // newPortalJWTFixture; a DB-less config would leave the global entity DB unusable + // for later tests in this package. + withTempConfig := func(t *testing.T, suffix string) *config.Config { + conf := config.NewMinimalTestConfigWithDb("oidc-session-key-"+suffix, t.TempDir()) + orig := get.Config() + get.SetConfig(conf) + t.Cleanup(func() { get.SetConfig(orig) }) + return conf + } + t.Run("PersistsAndReloads", func(t *testing.T) { + conf := withTempConfig(t, "persist") + + k1 := loadOrCreateOIDCSessionKey() + require.Len(t, k1, oidcSessionKeyLen) + + // A second call returns the same persisted key, kept at 0600. + k2 := loadOrCreateOIDCSessionKey() + assert.Equal(t, k1, k2, "the key must be stable across calls") + + path := filepath.Join(conf.PortalConfigPath(), "keys", oidcSessionKeyFile) + info, err := os.Stat(path) + require.NoError(t, err) + assert.Equal(t, os.FileMode(0o600), info.Mode().Perm()) + }) + t.Run("UnwritableKeysDirReturnsNil", func(t *testing.T) { + conf := withTempConfig(t, "unwritable") + + // Place a regular file where the keys directory must be created so the + // MkdirAll inside loadOrCreateOIDCSessionKey fails and it returns nil. + require.NoError(t, fs.MkdirAll(conf.PortalConfigPath())) + require.NoError(t, os.WriteFile(filepath.Join(conf.PortalConfigPath(), "keys"), []byte("x"), fs.ModeSecretFile)) + assert.Nil(t, loadOrCreateOIDCSessionKey()) + }) +} diff --git a/internal/api/photo_label.go b/internal/api/photo_label.go index c59057254..6b8bcb7ed 100644 --- a/internal/api/photo_label.go +++ b/internal/api/photo_label.go @@ -11,9 +11,10 @@ import ( "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/entity/query" - "github.com/photoprism/photoprism/internal/event" + "github.com/photoprism/photoprism/internal/entity/search" "github.com/photoprism/photoprism/internal/form" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/i18n" "github.com/photoprism/photoprism/pkg/txt" ) @@ -37,7 +38,19 @@ func AddPhotoLabel(router *gin.RouterGroup) { return } - m, err := query.PhotoByUID(clean.UID(c.Param("uid"))) + uid := clean.UID(c.Param("uid")) + + // Limit by-UID edits to pictures within the session's shared scope, mirroring UpdatePhoto. + // PhotoSessionSeesEverything is query-free and client and user role aware, so full-access + // sessions skip the check and restricted sessions stay within their scope. + if !search.PhotoSessionSeesEverything(s) { + if visible, vErr := search.PhotoVisibleToSession(uid, s); vErr != nil || !visible { + AbortForbidden(c) + return + } + } + + m, err := query.PhotoByUID(uid) if err != nil { AbortEntityNotFound(c) @@ -47,7 +60,14 @@ func AddPhotoLabel(router *gin.RouterGroup) { frm := &form.Label{} // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + if err = c.BindJSON(frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } else if err = frm.Validate(); err != nil { @@ -95,9 +115,7 @@ func AddPhotoLabel(router *gin.RouterGroup) { return } - PublishPhotoEvent(StatusUpdated, c.Param("uid"), c) - - event.Success("label updated") + PublishPhotoEvent(StatusUpdated, clean.UID(c.Param("uid"))) c.JSON(http.StatusOK, p) }) @@ -123,7 +141,19 @@ func RemovePhotoLabel(router *gin.RouterGroup) { return } - m, err := query.PhotoByUID(clean.UID(c.Param("uid"))) + uid := clean.UID(c.Param("uid")) + + // Limit by-UID edits to pictures within the session's shared scope, mirroring UpdatePhoto. + // PhotoSessionSeesEverything is query-free and client and user role aware, so full-access + // sessions skip the check and restricted sessions stay within their scope. + if !search.PhotoSessionSeesEverything(s) { + if visible, vErr := search.PhotoVisibleToSession(uid, s); vErr != nil || !visible { + AbortForbidden(c) + return + } + } + + m, err := query.PhotoByUID(uid) if err != nil { AbortEntityNotFound(c) @@ -133,7 +163,7 @@ func RemovePhotoLabel(router *gin.RouterGroup) { labelId, err := strconv.Atoi(clean.Token(c.Param("id"))) if err != nil { - c.AbortWithStatusJSON(http.StatusNotFound, gin.H{"error": txt.UpperFirst(err.Error())}) + Abort(c, http.StatusNotFound, i18n.ErrLabelNotFound) return } @@ -145,7 +175,7 @@ func RemovePhotoLabel(router *gin.RouterGroup) { label, err := query.PhotoLabel(m.ID, uint(labelId)) if err != nil { - c.AbortWithStatusJSON(http.StatusNotFound, gin.H{"error": txt.UpperFirst(err.Error())}) + Abort(c, http.StatusNotFound, i18n.ErrLabelNotFound) return } @@ -174,9 +204,7 @@ func RemovePhotoLabel(router *gin.RouterGroup) { return } - PublishPhotoEvent(StatusUpdated, clean.UID(c.Param("uid")), c) - - event.Success("label removed") + PublishPhotoEvent(StatusUpdated, clean.UID(c.Param("uid"))) c.JSON(http.StatusOK, p) }) @@ -205,7 +233,19 @@ func UpdatePhotoLabel(router *gin.RouterGroup) { // TODO: Clean up and simplify this. - m, err := query.PhotoByUID(clean.UID(c.Param("uid"))) + uid := clean.UID(c.Param("uid")) + + // Limit by-UID edits to pictures within the session's shared scope, mirroring UpdatePhoto. + // PhotoSessionSeesEverything is query-free and client and user role aware, so full-access + // sessions skip the check and restricted sessions stay within their scope. + if !search.PhotoSessionSeesEverything(s) { + if visible, vErr := search.PhotoVisibleToSession(uid, s); vErr != nil || !visible { + AbortForbidden(c) + return + } + } + + m, err := query.PhotoByUID(uid) if err != nil { AbortEntityNotFound(c) @@ -215,7 +255,7 @@ func UpdatePhotoLabel(router *gin.RouterGroup) { labelId, err := strconv.Atoi(clean.Token(c.Param("id"))) if err != nil { - c.AbortWithStatusJSON(http.StatusNotFound, gin.H{"error": txt.UpperFirst(err.Error())}) + Abort(c, http.StatusNotFound, i18n.ErrLabelNotFound) return } @@ -227,11 +267,18 @@ func UpdatePhotoLabel(router *gin.RouterGroup) { label, err := query.PhotoLabel(m.ID, uint(labelId)) if err != nil { - c.AbortWithStatusJSON(http.StatusNotFound, gin.H{"error": txt.UpperFirst(err.Error())}) + Abort(c, http.StatusNotFound, i18n.ErrLabelNotFound) return } + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + if err = c.BindJSON(label); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -258,9 +305,7 @@ func UpdatePhotoLabel(router *gin.RouterGroup) { return } - PublishPhotoEvent(StatusUpdated, clean.UID(c.Param("uid")), c) - - event.Success("label saved") + PublishPhotoEvent(StatusUpdated, clean.UID(c.Param("uid"))) c.JSON(http.StatusOK, p) }) diff --git a/internal/api/photo_label_test.go b/internal/api/photo_label_test.go index 1414bb05e..a2bade9b1 100644 --- a/internal/api/photo_label_test.go +++ b/internal/api/photo_label_test.go @@ -84,7 +84,7 @@ func TestRemovePhotoLabel(t *testing.T) { RemovePhotoLabel(router) r := PerformRequest(app, "DELETE", "/api/v1/photos/ps6sg6be2lvl0yh7/label/1000000") val := gjson.Get(r.Body.String(), "error") - assert.Equal(t, "Record not found", val.String()) + assert.Equal(t, "Label not found", val.String()) assert.Equal(t, http.StatusNotFound, r.Code) }) t.Run("NotExistingPhoto", func(t *testing.T) { diff --git a/internal/api/photo_unstack.go b/internal/api/photo_unstack.go index b90d88fe4..a3f76800b 100644 --- a/internal/api/photo_unstack.go +++ b/internal/api/photo_unstack.go @@ -10,6 +10,7 @@ import ( "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/entity/query" + "github.com/photoprism/photoprism/internal/entity/search" "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/internal/photoprism" "github.com/photoprism/photoprism/internal/photoprism/get" @@ -47,6 +48,15 @@ func PhotoUnstack(router *gin.RouterGroup) { return } + // Limit the edit to the file's photo within the session's shared scope. Gating on the file's + // own PhotoUID (not the path :uid) prevents pairing an in-scope :uid with an out-of-scope file. + if !search.PhotoSessionSeesEverything(s) { + if visible, vErr := search.PhotoVisibleToSession(file.PhotoUID, s); vErr != nil || !visible { + AbortForbidden(c) + return + } + } + switch { case file.FilePrimary: log.Errorf("photo: cannot unstack primary file") @@ -206,8 +216,8 @@ func PhotoUnstack(router *gin.RouterGroup) { } // Notify clients by publishing events. - PublishPhotoEvent(StatusCreated, newPhoto.PhotoUID, c) - PublishPhotoEvent(StatusUpdated, stackPhoto.PhotoUID, c) + PublishPhotoEvent(StatusCreated, newPhoto.PhotoUID) + PublishPhotoEvent(StatusUpdated, stackPhoto.PhotoUID) event.SuccessMsg(i18n.MsgFileUnstacked) diff --git a/internal/api/photos.go b/internal/api/photos.go index 840c13ad2..fd4b8ecc2 100644 --- a/internal/api/photos.go +++ b/internal/api/photos.go @@ -8,6 +8,7 @@ import ( "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/entity/query" + "github.com/photoprism/photoprism/internal/entity/search" "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/internal/form" "github.com/photoprism/photoprism/internal/photoprism" @@ -56,13 +57,26 @@ func GetPhoto(router *gin.RouterGroup) { return } - p, err := query.PhotoPreloadByUID(clean.UID(c.Param("uid"))) + uid := clean.UID(c.Param("uid")) + + // Limit access to pictures within the session's shared scope, consistent with how photo + // search filters results. Pictures outside the scope are reported as not found. + if visible, err := search.PhotoVisibleToSession(uid, s); err != nil || !visible { + AbortEntityNotFound(c) + return + } + + p, err := query.PhotoPreloadByUID(uid) if err != nil { AbortEntityNotFound(c) return } + // Limit the response to what the session is entitled to see; shared-only sessions get a + // reduced view (full-access sessions are unaffected). + p.RedactForSession(s) + c.IndentedJSON(http.StatusOK, p) }) } @@ -88,6 +102,18 @@ func UpdatePhoto(router *gin.RouterGroup) { } uid := clean.UID(c.Param("uid")) + + // Limit access to pictures within the session's shared scope, mirroring album updates. This + // runs before the lookup and form binding so out-of-scope requests have no side effects. + // PhotoSessionSeesEverything is query-free and client and user role aware, so full-access + // sessions skip the per-photo check and restricted sessions stay within their shared scope. + if !search.PhotoSessionSeesEverything(s) { + if visible, vErr := search.PhotoVisibleToSession(uid, s); vErr != nil || !visible { + AbortForbidden(c) + return + } + } + m, err := query.PhotoByUID(uid) if err != nil { @@ -104,7 +130,14 @@ func UpdatePhoto(router *gin.RouterGroup) { } // 2) Assign and validate request form values. + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + if err = c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + Abort(c, http.StatusBadRequest, i18n.ErrBadRequest) return } @@ -117,7 +150,7 @@ func UpdatePhoto(router *gin.RouterGroup) { FlushCoverCache() } - PublishPhotoEvent(StatusUpdated, uid, c) + PublishPhotoEvent(StatusUpdated, uid) event.SuccessMsg(i18n.MsgChangesSaved) @@ -194,7 +227,15 @@ func GetPhotoYaml(router *gin.RouterGroup) { return } - p, err := query.PhotoPreloadByUID(clean.UID(c.Param("uid"))) + uid := clean.UID(c.Param("uid")) + + // Limit access to pictures within the session's shared scope, consistent with photo search. + if visible, err := search.PhotoVisibleToSession(uid, s); err != nil || !visible { + c.AbortWithStatus(http.StatusNotFound) + return + } + + p, err := query.PhotoPreloadByUID(uid) if err != nil { c.AbortWithStatus(http.StatusNotFound) @@ -236,6 +277,17 @@ func ApprovePhoto(router *gin.RouterGroup) { } id := clean.UID(c.Param("uid")) + + // Limit access to pictures within the session's shared scope, mirroring photo and album + // updates. The query-free PhotoSessionSeesEverything check lets full-access sessions skip the + // per-photo lookup; restricted sessions (client and user role aware) stay within their scope. + if !search.PhotoSessionSeesEverything(s) { + if visible, vErr := search.PhotoVisibleToSession(id, s); vErr != nil || !visible { + AbortForbidden(c) + return + } + } + m, err := query.PhotoByUID(id) if err != nil { @@ -251,7 +303,7 @@ func ApprovePhoto(router *gin.RouterGroup) { SaveSidecarYaml(&m) - PublishPhotoEvent(StatusUpdated, id, c) + PublishPhotoEvent(StatusUpdated, id) c.JSON(http.StatusOK, gin.H{"photo": m}) }) @@ -279,6 +331,16 @@ func PhotoPrimary(router *gin.RouterGroup) { uid := clean.UID(c.Param("uid")) fileUid := clean.UID(c.Param("file_uid")) + + // Limit access to pictures within the session's shared scope. Full-access sessions skip the + // query-free PhotoSessionSeesEverything check; restricted sessions stay within their scope. + if !search.PhotoSessionSeesEverything(s) { + if visible, vErr := search.PhotoVisibleToSession(uid, s); vErr != nil || !visible { + AbortForbidden(c) + return + } + } + err := query.SetPhotoPrimary(uid, fileUid) if err != nil { @@ -286,7 +348,7 @@ func PhotoPrimary(router *gin.RouterGroup) { return } - PublishPhotoEvent(StatusUpdated, uid, c) + PublishPhotoEvent(StatusUpdated, uid) event.SuccessMsg(i18n.MsgChangesSaved) diff --git a/internal/api/photos_search.go b/internal/api/photos_search.go index 8e54b77ae..c678cec1b 100644 --- a/internal/api/photos_search.go +++ b/internal/api/photos_search.go @@ -16,15 +16,51 @@ import ( "github.com/photoprism/photoprism/pkg/log/status" ) +// searchPhotosForm checks authorization and parses the photo search request. +func searchPhotosForm(c *gin.Context) (frm form.SearchPhotos, s *entity.Session, err error) { + s = AuthAny(c, acl.ResourcePhotos, acl.Permissions{acl.ActionSearch, acl.ActionView, acl.AccessShared}) + + // Abort if permission is not granted. + if s.Abort(c) { + return frm, s, i18n.Error(i18n.ErrForbidden) + } + + // Abort if request params are invalid. + if err = c.MustBindWith(&frm, binding.Form); err != nil { + event.AuditWarn([]string{ClientIP(c), "session %s", string(acl.ResourcePhotos), "form invalid", status.Error(err)}, s.RefID) + AbortBadRequest(c, err) + return frm, s, err + } + + settings := get.Config().Settings() + + // Ignore private flag if feature is disabled. + if !settings.Features.Private { + frm.Public = false + } + + // Ignore private flag if feature is disabled. + if frm.Scope == "" && + settings.Features.Review && + acl.Rules.Deny(acl.ResourcePhotos, s.GetUserRole(), acl.ActionManage) { + frm.Quality = 3 + } + + return frm, s, nil +} + // SearchPhotos finds pictures and returns them as JSON. // // @Summary finds pictures and returns them as JSON -// @Description Fore more information see: +// @Description For more information see: // @Description - https://docs.photoprism.app/developer-guide/api/search/#get-apiv1photos // @Id SearchPhotos // @Tags Photos // @Produce json // @Success 200 {object} search.PhotoResults +// @Header 200 {number} X-Count "The actual number of files returned" +// @Header 200 {number} X-Limit "The limit of the number of files to be returned" +// @Header 200 {number} X-Offset "The offset that was used" // @Failure 400,401,403,404 {object} i18n.Response // @Param count query int true "maximum number of files" minimum(1) maximum(100000) // @Param offset query int false "file offset" minimum(0) maximum(100000) @@ -38,42 +74,8 @@ import ( // @Param video query bool false "is type video" // @Router /api/v1/photos [get] func SearchPhotos(router *gin.RouterGroup) { - // searchPhotos checking authorization and parses the search request. - searchForm := func(c *gin.Context) (frm form.SearchPhotos, s *entity.Session, err error) { - s = AuthAny(c, acl.ResourcePhotos, acl.Permissions{acl.ActionSearch, acl.ActionView, acl.AccessShared}) - - // Abort if permission is not granted. - if s.Abort(c) { - return frm, s, i18n.Error(i18n.ErrForbidden) - } - - // Abort if request params are invalid. - if err = c.MustBindWith(&frm, binding.Form); err != nil { - event.AuditWarn([]string{ClientIP(c), "session %s", string(acl.ResourcePhotos), "form invalid", status.Error(err)}, s.RefID) - AbortBadRequest(c, err) - return frm, s, err - } - - settings := get.Config().Settings() - - // Ignore private flag if feature is disabled. - if !settings.Features.Private { - frm.Public = false - } - - // Ignore private flag if feature is disabled. - if frm.Scope == "" && - settings.Features.Review && - acl.Rules.Deny(acl.ResourcePhotos, s.GetUserRole(), acl.ActionManage) { - frm.Quality = 3 - } - - return frm, s, nil - } - - // defaultHandler a standard JSON result with all fields. - defaultHandler := func(c *gin.Context) { - f, s, err := searchForm(c) + router.GET("/photos", func(c *gin.Context) { + f, s, err := searchPhotosForm(c) // Abort if authorization or form are invalid. if err != nil { @@ -98,11 +100,38 @@ func SearchPhotos(router *gin.RouterGroup) { // Return as JSON. c.JSON(http.StatusOK, result) - } + }) +} - // viewHandler returns a photo viewer formatted result. - viewHandler := func(c *gin.Context) { - f, s, err := searchForm(c) +// SearchPhotosView finds pictures and returns a viewer-formatted JSON result for the lightbox. +// +// @Summary finds pictures and returns a viewer-formatted JSON result for the lightbox +// @Description Returns search results formatted for the photo viewer (lightbox) in the web UI, +// @Description including resolved content URLs and preview/download tokens. +// @Description For more information see: +// @Description - https://docs.photoprism.app/developer-guide/api/search/#get-apiv1photos +// @Id SearchPhotosView +// @Tags Photos +// @Produce json +// @Success 200 {object} viewer.Results +// @Header 200 {number} X-Count "The actual number of files returned" +// @Header 200 {number} X-Limit "The limit of the number of files to be returned" +// @Header 200 {number} X-Offset "The offset that was used" +// @Failure 400,401,403,404 {object} i18n.Response +// @Param count query int true "maximum number of files" minimum(1) maximum(100000) +// @Param offset query int false "file offset" minimum(0) maximum(100000) +// @Param order query string false "sort order" Enums(name, title, added, edited, newest, oldest, size, random, duration, relevance) +// @Param merged query bool false "groups consecutive files that belong to the same photo" +// @Param public query bool false "excludes private pictures" +// @Param quality query int false "minimum quality score (1-7)" Enums(0, 1, 2, 3, 4, 5, 6, 7) +// @Param q query string false "search query" +// @Param s query string false "album uid" +// @Param path query string false "photo path" +// @Param video query bool false "is type video" +// @Router /api/v1/photos/view [get] +func SearchPhotosView(router *gin.RouterGroup) { + router.GET("/photos/view", func(c *gin.Context) { + f, s, err := searchPhotosForm(c) // Abort if authorization or form are invalid. if err != nil { @@ -127,9 +156,5 @@ func SearchPhotos(router *gin.RouterGroup) { // Return as JSON. c.JSON(http.StatusOK, result) - } - - // Register route handlers. - router.GET("/photos", defaultHandler) - router.GET("/photos/view", viewHandler) + }) } diff --git a/internal/api/photos_search_geo.go b/internal/api/photos_search_geo.go index bbcdd0d5b..91200a418 100644 --- a/internal/api/photos_search_geo.go +++ b/internal/api/photos_search_geo.go @@ -25,6 +25,9 @@ import ( // @Tags Photos // @Produce json // @Success 200 {object} search.GeoResults +// @Header 200 {number} X-Count "The actual number of files returned" +// @Header 200 {number} X-Limit "The limit of the number of files to be returned" +// @Header 200 {number} X-Offset "The offset that was used" // @Failure 400,401,403,404 {object} i18n.Response // @Param count query int true "maximum number of files" minimum(1) maximum(100000) // @Param offset query int false "file offset" minimum(0) maximum(100000) diff --git a/internal/api/photos_search_test.go b/internal/api/photos_search_test.go index b152dc02b..dc472ac4f 100644 --- a/internal/api/photos_search_test.go +++ b/internal/api/photos_search_test.go @@ -37,3 +37,30 @@ func TestSearchPhotos(t *testing.T) { assert.Equal(t, http.StatusBadRequest, result.Code) }) } + +func TestSearchPhotosView(t *testing.T) { + t.Run("Success", func(t *testing.T) { + app, router, _ := NewApiTest() + SearchPhotosView(router) + r := PerformRequest(app, "GET", "/api/v1/photos/view?count=10") + body := r.Body.String() + + t.Logf("response body: %s", body) + + assert.Equal(t, http.StatusOK, r.Code) + count := gjson.Get(body, "#") + assert.LessOrEqual(t, int64(2), count.Int()) + + // Viewer-formatted results expose resolved download/preview URLs + // that the default search endpoint does not populate. + first := gjson.Get(body, "0") + assert.True(t, first.Exists(), "expected at least one result") + assert.NotEmpty(t, first.Get("DownloadUrl").String(), "DownloadUrl should be set for viewer results") + }) + t.Run("InvalidRequest", func(t *testing.T) { + app, router, _ := NewApiTest() + SearchPhotosView(router) + result := PerformRequest(app, "GET", "/api/v1/photos/view?xxx=10") + assert.Equal(t, http.StatusBadRequest, result.Code) + }) +} diff --git a/internal/api/photos_test.go b/internal/api/photos_test.go index b15c81759..ebd90f1c0 100644 --- a/internal/api/photos_test.go +++ b/internal/api/photos_test.go @@ -8,6 +8,7 @@ import ( "github.com/tidwall/gjson" "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/pkg/i18n" ) @@ -70,6 +71,27 @@ func TestGetPhoto(t *testing.T) { r := PerformRequest(app, "GET", "/api/v1/photos/xxx") assert.Equal(t, http.StatusNotFound, r.Code) }) + t.Run("GuestDeniedPrivate", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + GetPhoto(router) + sessId := AuthenticateUser(app, router, "gandalf", "Gandalf123!") + // A private picture outside the guest's shared scope is reported as not found. + r := AuthenticatedRequest(app, "GET", "/api/v1/photos/ps6sg6be2lvl0y13", sessId) + assert.Equal(t, http.StatusNotFound, r.Code) + }) + t.Run("AdminSeesPrivate", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + GetPhoto(router) + sessId := AuthenticateUser(app, router, "alice", "Alice123!") + r := AuthenticatedRequest(app, "GET", "/api/v1/photos/ps6sg6be2lvl0y13", sessId) + assert.Equal(t, http.StatusOK, r.Code) + }) } func TestUpdatePhoto(t *testing.T) { @@ -139,6 +161,44 @@ func TestLikePhoto(t *testing.T) { r := PerformRequest(app, "POST", "/api/v1/photos/xxx/like") assert.Equal(t, http.StatusNotFound, r.Code) }) + t.Run("GuestDeniedOutOfScope", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + LikePhoto(router) + // A guest holds ActionReact and so passes the route ACL, but a picture outside its shared + // scope must be reported as not found rather than returning the (unredacted) photo record. + sessId := AuthenticateUser(app, router, "gandalf", "Gandalf123!") + r := AuthenticatedRequest(app, "POST", "/api/v1/photos/ps6sg6be2lvl0y13/like", sessId) + assert.Equal(t, http.StatusNotFound, r.Code) + }) + t.Run("GuestInScopeRedacted", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + // A guest session that has redeemed a share to an album containing a non-private picture + // reaches the redaction branch: the picture is returned, but identifying metadata is stripped. + // Photo "ps6sg6be2lvl0y21" is shared via album "as6sg6bxpogaaba8" (token "1jxf3jfn2k") and is + // not touched by any mutation test, so a combined "-run" filter that archives/privatizes a + // shared picture before this subtest cannot push it out of scope and flip the result to 404. + sess := entity.NewSession(conf.SessionMaxAge(), 0) + sess.SetUser(entity.FindUserByName("guest")) + sess.RedeemToken("1jxf3jfn2k") + if err := sess.Save(); err != nil { + t.Fatal(err) + } + + LikePhoto(router) + r := AuthenticatedRequest(app, "POST", "/api/v1/photos/ps6sg6be2lvl0y21/like", sess.AuthToken()) + assert.Equal(t, http.StatusOK, r.Code) + assert.Equal(t, "ps6sg6be2lvl0y21", gjson.Get(r.Body.String(), "photo.UID").String()) + // A non-redacted field stays present (the genuine record is returned), while the identifying + // storage path is stripped — the fixture sets PhotoPath, so the empty result proves redaction. + assert.Equal(t, "Title", gjson.Get(r.Body.String(), "photo.Title").String()) + assert.Empty(t, gjson.Get(r.Body.String(), "photo.Path").String()) + }) } func TestDislikePhoto(t *testing.T) { @@ -158,6 +218,16 @@ func TestDislikePhoto(t *testing.T) { r := PerformRequest(app, "DELETE", "/api/v1/photos/xxx/like") assert.Equal(t, http.StatusNotFound, r.Code) }) + t.Run("GuestDeniedOutOfScope", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + DislikePhoto(router) + sessId := AuthenticateUser(app, router, "gandalf", "Gandalf123!") + r := AuthenticatedRequest(app, "DELETE", "/api/v1/photos/ps6sg6be2lvl0y13/like", sessId) + assert.Equal(t, http.StatusNotFound, r.Code) + }) } func TestPhotoPrimary(t *testing.T) { diff --git a/internal/api/places_search.go b/internal/api/places_search.go index c98c45837..a473954e6 100644 --- a/internal/api/places_search.go +++ b/internal/api/places_search.go @@ -24,7 +24,7 @@ import ( // @Param locale query string false "Locale for results (default: en)" // @Param count query int false "Maximum number of results (default: 10, max: 50)" // @Success 200 {object} places.SearchResults -// @Failure 400 {object} gin.H "Missing search query" +// @Failure 400 {object} i18n.Response // @Failure 401 {object} i18n.Response // @Failure 500 {object} gin.H "Search service error" // @Router /api/v1/places/search [get] @@ -52,7 +52,7 @@ func GetPlacesSearch(router *gin.RouterGroup) { count := txt.IntVal(c.Query("count"), 1, 50, 10) if query == "" { - c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "Missing search query"}) + AbortBadRequest(c) return } diff --git a/internal/api/reactions.go b/internal/api/reactions.go index 28e41928b..61cd20ec9 100644 --- a/internal/api/reactions.go +++ b/internal/api/reactions.go @@ -7,6 +7,7 @@ import ( "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/internal/entity/query" + "github.com/photoprism/photoprism/internal/entity/search" "github.com/photoprism/photoprism/internal/photoprism/get" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/react" @@ -32,6 +33,14 @@ func LikePhoto(router *gin.RouterGroup) { } id := clean.UID(c.Param("uid")) + + // Limit access to pictures within the session's shared scope, consistent with GetPhoto. + // Pictures outside the scope are reported as not found. + if visible, vErr := search.PhotoVisibleToSession(id, s); vErr != nil || !visible { + AbortEntityNotFound(c) + return + } + m, err := query.PhotoByUID(id) if err != nil { @@ -53,9 +62,13 @@ func LikePhoto(router *gin.RouterGroup) { } SaveSidecarYaml(&m) - PublishPhotoEvent(StatusUpdated, id, c) + PublishPhotoEvent(StatusUpdated, id) } + // Reduce the response to what the session is entitled to see; shared-only sessions get a + // reduced view (full-access sessions are unaffected). + m.RedactForSession(s) + c.JSON(http.StatusOK, gin.H{"photo": m}) }) } @@ -80,6 +93,14 @@ func DislikePhoto(router *gin.RouterGroup) { } id := clean.UID(c.Param("uid")) + + // Limit access to pictures within the session's shared scope, consistent with GetPhoto. + // Pictures outside the scope are reported as not found. + if visible, vErr := search.PhotoVisibleToSession(id, s); vErr != nil || !visible { + AbortEntityNotFound(c) + return + } + m, err := query.PhotoByUID(id) if err != nil { @@ -101,9 +122,13 @@ func DislikePhoto(router *gin.RouterGroup) { } SaveSidecarYaml(&m) - PublishPhotoEvent(StatusUpdated, id, c) + PublishPhotoEvent(StatusUpdated, id) } + // Reduce the response to what the session is entitled to see; shared-only sessions get a + // reduced view (full-access sessions are unaffected). + m.RedactForSession(s) + c.JSON(http.StatusOK, gin.H{"photo": m}) }) } diff --git a/internal/api/request_limits.go b/internal/api/request_limits.go new file mode 100644 index 000000000..1f7ef38ac --- /dev/null +++ b/internal/api/request_limits.go @@ -0,0 +1,67 @@ +package api + +import ( + "errors" + "mime/multipart" + "net/http" + + "github.com/gin-gonic/gin" + + "github.com/photoprism/photoprism/pkg/i18n" +) + +const ( + // MaxAuthRequestBytes bounds small authentication and credential-change payloads. + MaxAuthRequestBytes int64 = 64 * 1024 + // MaxMutationRequestBytes bounds general JSON mutation payloads. + MaxMutationRequestBytes int64 = 256 * 1024 + // MaxSelectionRequestBytes bounds selection-heavy batch mutation payloads. + MaxSelectionRequestBytes int64 = 1024 * 1024 + // MaxVisionRequestBytes bounds Vision API payloads while still allowing supported data URLs. + MaxVisionRequestBytes int64 = 32 * 1024 * 1024 + // MaxSessionRequestBytes bounds login request payloads. + MaxSessionRequestBytes int64 = MaxAuthRequestBytes + // MaxAlbumRequestBytes bounds album create and update payloads. + MaxAlbumRequestBytes int64 = MaxMutationRequestBytes + // MaxSettingsRequestBytes bounds settings and config option payloads. + MaxSettingsRequestBytes int64 = MaxMutationRequestBytes + // MaxClusterRegisterBytes bounds cluster registration and patch payloads. + MaxClusterRegisterBytes int64 = MaxMutationRequestBytes + // MaxUploadOptionsRequestBytes bounds upload-processing payloads. + MaxUploadOptionsRequestBytes int64 = MaxMutationRequestBytes + // MaxBatchPhotosEditBytes bounds batch photo edit payloads. + MaxBatchPhotosEditBytes int64 = MaxSelectionRequestBytes + // MaxMultipartOverheadBytes reserves room for multipart framing overhead. + MaxMultipartOverheadBytes int64 = 1024 * 1024 + // MaxAvatarUploadBytes bounds avatar uploads including multipart overhead. + MaxAvatarUploadBytes int64 = 20000000 + MaxMultipartOverheadBytes + // MaxMCPRequestBytes bounds Model Context Protocol (MCP) JSON-RPC payloads. + // The upstream SDK reads the full POST body into memory via io.ReadAll, so + // this cap must be enforced at the handler boundary before dispatch. + MaxMCPRequestBytes int64 = MaxMutationRequestBytes +) + +// LimitRequestBodyBytes caps the readable request body size for the current handler. +func LimitRequestBodyBytes(c *gin.Context, limit int64) { + if c == nil || c.Request == nil || c.Request.Body == nil || limit <= 0 { + return + } + + c.Request.Body = http.MaxBytesReader(c.Writer, c.Request.Body, limit) +} + +// IsRequestBodyTooLarge reports whether the parsing error was caused by a body-size limit. +func IsRequestBodyTooLarge(err error) bool { + if err == nil { + return false + } + + var maxBytesErr *http.MaxBytesError + + return errors.As(err, &maxBytesErr) || errors.Is(err, multipart.ErrMessageTooLarge) +} + +// AbortRequestTooLarge writes a localized 413 response and stops the current request. +func AbortRequestTooLarge(c *gin.Context, id i18n.Message) { + Abort(c, http.StatusRequestEntityTooLarge, id) +} diff --git a/internal/api/services.go b/internal/api/services.go index 98817e70c..0a2ed3d81 100644 --- a/internal/api/services.go +++ b/internal/api/services.go @@ -66,7 +66,7 @@ func GetService(router *gin.RouterGroup) { // @Id GetServiceFolders // @Tags Services // @Produce json -// @Success 200 {object} []object +// @Success 200 {array} object // @Failure 400,401,403,404,429 {object} i18n.Response // @Param id path string true "service id" // @Router /api/v1/services/{id}/folders [get] @@ -150,7 +150,14 @@ func AddService(router *gin.RouterGroup) { var frm form.Service // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -220,7 +227,14 @@ func UpdateService(router *gin.RouterGroup) { } // 2) Update form with values from request + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + if err = c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } diff --git a/internal/api/services_search.go b/internal/api/services_search.go index 985aa165b..bd0cd9c3b 100644 --- a/internal/api/services_search.go +++ b/internal/api/services_search.go @@ -20,6 +20,9 @@ import ( // @Tags Services // @Produce json // @Success 200 {object} entity.Services +// @Header 200 {number} X-Count "The actual number of services returned" +// @Header 200 {number} X-Limit "The limit of the number of services to be returned" +// @Header 200 {number} X-Offset "The offset that was used" // @Failure 401,403,404,429 {object} i18n.Response // @Param count query int true "maximum number of results" minimum(1) maximum(100000) // @Router /api/v1/services [get] @@ -54,7 +57,7 @@ func SearchServices(router *gin.RouterGroup) { return } - // TODO c.Header("X-Count", strconv.Itoa(count)) + AddCountHeader(c, len(result)) AddLimitHeader(c, frm.Count) AddOffsetHeader(c, frm.Offset) diff --git a/internal/api/services_search_test.go b/internal/api/services_search_test.go index a51602cda..cb1d16b43 100644 --- a/internal/api/services_search_test.go +++ b/internal/api/services_search_test.go @@ -2,6 +2,7 @@ package api import ( "net/http" + "strconv" "testing" "github.com/tidwall/gjson" @@ -20,6 +21,11 @@ func TestSearchServices(t *testing.T) { assert.LessOrEqual(t, int64(1), count.Int()) assert.Equal(t, "http://dummy-webdav/", val.String()) assert.Equal(t, http.StatusOK, r.Code) + result := r.Result() + xCount, err := strconv.Atoi(result.Header.Get("X-Count")) + assert.NoError(t, err, "strconv for X-Count failed") + assert.LessOrEqual(t, 1, xCount) + }) t.Run("InvalidRequest", func(t *testing.T) { app, router, _ := NewApiTest() diff --git a/internal/api/services_upload.go b/internal/api/services_upload.go index c07bcded5..ba7fa7da7 100644 --- a/internal/api/services_upload.go +++ b/internal/api/services_upload.go @@ -48,7 +48,14 @@ func UploadToService(router *gin.RouterGroup) { var frm form.SyncUpload // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxSelectionRequestBytes) + if err = c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } diff --git a/internal/api/session_create.go b/internal/api/session_create.go index 9414274ce..fa997fd4d 100644 --- a/internal/api/session_create.go +++ b/internal/api/session_create.go @@ -41,7 +41,15 @@ func CreateSession(router *gin.RouterGroup) { clientIp := ClientIP(c) // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxSessionRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + event.AuditWarn([]string{clientIp, "create session", "request too large", status.Error(err)}) + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + event.AuditWarn([]string{clientIp, "create session", "invalid request", status.Error(err)}) AbortBadRequest(c, err) return @@ -102,13 +110,15 @@ func CreateSession(router *gin.RouterGroup) { if err = sess.LogIn(frm, c); err != nil { switch { case sess.GetMethod().IsNot(authn.Method2FA): - c.AbortWithStatusJSON(sess.HttpStatus(), gin.H{"error": i18n.Msg(i18n.ErrInvalidCredentials)}) + Abort(c, sess.HttpStatus(), i18n.ErrInvalidCredentials) case errors.Is(err, authn.ErrPasscodeRequired): - c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": err.Error(), "code": 32, "message": i18n.Msg(i18n.ErrPasscodeRequired)}) + // Code 32 asks the client to enter a 2FA passcode (a continuation request, + // not a failure), so the text goes in "message" (code < 400) with messageId. + c.AbortWithStatusJSON(http.StatusUnauthorized, i18n.NewResponse(32, i18n.ErrPasscodeRequired)) // Return the reserved request rate limit tokens if password is correct, even if the verification code is missing. r.Success() default: - c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": err.Error(), "code": http.StatusUnauthorized, "message": i18n.Msg(i18n.ErrInvalidPasscode)}) + Abort(c, http.StatusUnauthorized, i18n.ErrInvalidPasscode) } return } @@ -123,10 +133,10 @@ func CreateSession(router *gin.RouterGroup) { switch saved, saveErr := get.Session().Save(sess); { case saveErr != nil: event.AuditErr([]string{clientIp, status.Error(saveErr)}) - c.AbortWithStatusJSON(sess.HttpStatus(), gin.H{"error": i18n.Msg(i18n.ErrInvalidCredentials)}) + Abort(c, sess.HttpStatus(), i18n.ErrInvalidCredentials) return case saved == nil: - c.AbortWithStatusJSON(sess.HttpStatus(), gin.H{"error": i18n.Msg(i18n.ErrUnexpected)}) + Abort(c, sess.HttpStatus(), i18n.ErrUnexpected) return case isNew: event.AuditInfo([]string{clientIp, "session %s", "created"}, saved.RefID) @@ -142,6 +152,13 @@ func CreateSession(router *gin.RouterGroup) { // Response includes user data, session data, and client config values. response := CreateSessionResponse(sess.AuthToken(), sess, conf.ClientSession(sess)) + // On the Portal (OIDC OP), set a narrowly-scoped session cookie so the + // /api/v1/oauth/authorize endpoint can authenticate top-level browser + // navigations, which carry no Authorization header. See SetOIDCSessionCookie. + if conf.Portal() { + SetOIDCSessionCookie(c, sess, OIDCSessionCookiePath(conf), conf.SiteHttps()) + } + // Return JSON response. c.JSON(sess.HttpStatus(), response) } diff --git a/internal/api/session_delete.go b/internal/api/session_delete.go index ff5bdd214..e78a275de 100644 --- a/internal/api/session_delete.go +++ b/internal/api/session_delete.go @@ -2,14 +2,18 @@ package api import ( "net/http" + "strings" "github.com/photoprism/photoprism/pkg/http/header" + "github.com/photoprism/photoprism/pkg/http/scheme" "github.com/photoprism/photoprism/pkg/log/status" "github.com/gin-gonic/gin" "github.com/photoprism/photoprism/internal/auth/acl" + "github.com/photoprism/photoprism/internal/auth/oidc" "github.com/photoprism/photoprism/internal/auth/session" + "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/internal/photoprism/get" @@ -43,7 +47,7 @@ func DeleteSession(router *gin.RouterGroup) { return } - // Check if the session user is allowed to manage all accounts or update his/her own account. + // Require session management or delete access. s := AuthAny(c, acl.ResourceSessions, acl.Permissions{acl.ActionManage, acl.ActionDelete}) if s.Abort(c) { @@ -55,7 +59,7 @@ func DeleteSession(router *gin.RouterGroup) { // Get client IP and auth token from request headers. clientIp := ClientIP(c) - // Only admins may delete other sessions by ref id. + // Only full session managers may delete sessions by ref ID. if rnd.IsRefID(id) { if !acl.Rules.AllowAll(acl.ResourceSessions, s.GetUserRole(), acl.Permissions{acl.AccessAll, acl.ActionManage}) { event.AuditErr([]string{clientIp, "session %s", "delete %s as %s", status.Denied}, s.RefID, acl.ResourceSessions.String(), s.GetUserRole()) @@ -82,11 +86,71 @@ func DeleteSession(router *gin.RouterGroup) { event.AuditDebug([]string{clientIp, "session %s", "deleted"}, s.RefID) } + resp := DeleteSessionResponse(s.ID) + + // On the caller's own logout (not a manager deleting by ref id), end the provider + // session too when PHOTOPRISM_OIDC_LOGOUT is enabled. + if conf := get.Config(); !rnd.IsRefID(id) { + if logoutUri := oidcLogoutURL(conf, get.OIDC(), s); logoutUri != "" { + // Delegate to the provider's end-session endpoint (the Portal OP in a cluster), + // which clears the OP session cookie itself — clearing it here would strip the + // cookie the Portal OP needs to resolve the session and chain the upstream logout. + resp["providerLogoutUri"] = logoutUri + event.AuditInfo([]string{clientIp, "session %s", "oidc provider logout initiated", status.Granted}, s.RefID) + } else if clearPath := OIDCSessionCookieClearPath(conf); clearPath != "" { + // Otherwise clear the OP cookie locally so cluster-wide Sign-Out stops silent re-SSO. + ClearOIDCSessionCookie(c, clearPath, conf.SiteHttps()) + } + } + // Return JSON response for confirmation. - c.JSON(http.StatusOK, DeleteSessionResponse(s.ID)) + c.JSON(http.StatusOK, resp) } router.DELETE("/session", deleteSessionHandler) router.DELETE("/session/:id", deleteSessionHandler) router.DELETE("/sessions/:id", deleteSessionHandler) } + +// oidcLogoutURL returns the RP-initiated logout URL for a just-deleted OIDC session, or "" +// when logout is disabled, the session was not OIDC, or the provider advertises no +// end_session_endpoint. The browser is redirected there to end the provider SSO session. +func oidcLogoutURL(conf *config.Config, provider *oidc.Client, s *entity.Session) string { + if conf == nil || provider == nil || s == nil { + return "" + } else if !conf.OIDCLogout() || s.IdToken == "" || !s.GetProvider().IsOIDC() { + return "" + } + + logoutUri, err := provider.EndSessionURL(s.IdToken, AbsoluteLoginURL(conf), "") + + if err != nil { + event.AuditWarn([]string{"oidc", "provider logout", status.Error(err)}) + return "" + } + + return logoutUri +} + +// AbsoluteLoginURL returns the node's login page as an absolute URL, suitable as an OIDC +// post_logout_redirect_uri (providers require it absolute). LoginUri() is root-relative, +// so it is joined to the site origin. +func AbsoluteLoginURL(conf *config.Config) string { + path := conf.LoginUri() + + if strings.Contains(path, "://") { + return path + } + + origin := scheme.OriginURL(conf.SiteUrl()) + + if origin == "" { + return path + } + + if !strings.HasPrefix(path, "/") { + path = "/" + path + } + + return strings.TrimRight(origin, "/") + path +} diff --git a/internal/api/session_delete_test.go b/internal/api/session_delete_test.go new file mode 100644 index 000000000..c463b7fc2 --- /dev/null +++ b/internal/api/session_delete_test.go @@ -0,0 +1,98 @@ +package api + +import ( + "net/url" + "strings" + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + "github.com/zitadel/oidc/v3/pkg/client/rp" + "golang.org/x/oauth2" + + "github.com/photoprism/photoprism/internal/auth/oidc" + "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/pkg/authn" +) + +// fakeRelyingParty implements only the rp.RelyingParty methods EndSessionURL reads. +type fakeRelyingParty struct { + rp.RelyingParty + endSession string + clientID string +} + +func (f fakeRelyingParty) GetEndSessionEndpoint() string { return f.endSession } +func (f fakeRelyingParty) OAuthConfig() *oauth2.Config { return &oauth2.Config{ClientID: f.clientID} } + +func oidcProvider(endSession string) *oidc.Client { + return &oidc.Client{RelyingParty: fakeRelyingParty{endSession: endSession, clientID: "client-abc"}} +} + +func oidcSession(provider authn.ProviderType, idToken string) *entity.Session { + s := &entity.Session{} + s.SetProvider(provider) + s.IdToken = idToken + return s +} + +func TestOidcLogoutURL(t *testing.T) { + conf := config.NewConfig(config.CliTestContext()) + provider := oidcProvider("https://provider.example/logout") + + t.Run("Success", func(t *testing.T) { + conf.Options().OIDCLogout = true + defer func() { conf.Options().OIDCLogout = false }() + + result := oidcLogoutURL(conf, provider, oidcSession(authn.ProviderOIDC, "id-token-123")) + require.NotEmpty(t, result) + + u, err := url.Parse(result) + require.NoError(t, err) + assert.Equal(t, "id-token-123", u.Query().Get("id_token_hint")) + assert.Equal(t, "client-abc", u.Query().Get("client_id")) + // post_logout_redirect_uri must be absolute (providers reject relative paths). + plr := u.Query().Get("post_logout_redirect_uri") + assert.Equal(t, AbsoluteLoginURL(conf), plr) + assert.Contains(t, plr, "://") + }) + t.Run("FlagDisabled", func(t *testing.T) { + conf.Options().OIDCLogout = false + assert.Equal(t, "", oidcLogoutURL(conf, provider, oidcSession(authn.ProviderOIDC, "id-token-123"))) + }) + t.Run("NotOIDCSession", func(t *testing.T) { + conf.Options().OIDCLogout = true + defer func() { conf.Options().OIDCLogout = false }() + assert.Equal(t, "", oidcLogoutURL(conf, provider, oidcSession(authn.ProviderLocal, "id-token-123"))) + }) + t.Run("NoIdToken", func(t *testing.T) { + conf.Options().OIDCLogout = true + defer func() { conf.Options().OIDCLogout = false }() + assert.Equal(t, "", oidcLogoutURL(conf, provider, oidcSession(authn.ProviderOIDC, ""))) + }) + t.Run("ProviderWithoutEndSession", func(t *testing.T) { + conf.Options().OIDCLogout = true + defer func() { conf.Options().OIDCLogout = false }() + assert.Equal(t, "", oidcLogoutURL(conf, oidcProvider(""), oidcSession(authn.ProviderOIDC, "id-token-123"))) + }) + t.Run("NilProvider", func(t *testing.T) { + conf.Options().OIDCLogout = true + defer func() { conf.Options().OIDCLogout = false }() + assert.Equal(t, "", oidcLogoutURL(conf, nil, oidcSession(authn.ProviderOIDC, "id-token-123"))) + }) +} + +func TestAbsoluteLoginURL(t *testing.T) { + t.Run("RelativeLoginPathResolvedToOrigin", func(t *testing.T) { + conf := config.NewConfig(config.CliTestContext()) + result := AbsoluteLoginURL(conf) + assert.Contains(t, result, "://", "must be absolute") + assert.True(t, strings.HasSuffix(result, conf.LoginUri()), "must end with the login path") + }) + t.Run("AbsoluteLoginUriPassedThrough", func(t *testing.T) { + conf := config.NewConfig(config.CliTestContext()) + conf.Options().LoginUri = "https://sso.example.com/login" + assert.Equal(t, "https://sso.example.com/login", AbsoluteLoginURL(conf)) + }) +} diff --git a/internal/api/session_get.go b/internal/api/session_get.go index 1975dc359..9aef6d00b 100644 --- a/internal/api/session_get.go +++ b/internal/api/session_get.go @@ -31,6 +31,10 @@ func GetSession(router *gin.RouterGroup) { return } + // Disable caching: the response carries the auth token and, on the Portal, + // refreshes the OP session cookie. + c.Header(header.CacheControl, header.CacheControlNoStore) + id := clean.ID(c.Param("id")) if id != "" && !rnd.IsSessionID(id) { @@ -41,10 +45,10 @@ func GetSession(router *gin.RouterGroup) { conf := get.Config() - // Check if the session user is allowed to manage all accounts or update his/her own account. + // Require session management or view access. s := AuthAny(c, acl.ResourceSessions, acl.Permissions{acl.ActionManage, acl.ActionView}) - // Check if session is valid. + // Validate the resolved session. switch { case s.Abort(c): return @@ -59,6 +63,12 @@ func GetSession(router *gin.RouterGroup) { // Get auth token from headers. authToken := AuthToken(c) + // On the Portal (OIDC OP), refresh the narrowly-scoped session cookie so the + // short-lived signed session reference stays available to /api/v1/oauth/authorize. + if conf.Portal() && authToken != "" { + SetOIDCSessionCookie(c, s, OIDCSessionCookiePath(conf), conf.SiteHttps()) + } + // Update user information. s.RefreshUser() diff --git a/internal/api/session_response.go b/internal/api/session_response.go index 1eb5e9558..55775c06a 100644 --- a/internal/api/session_response.go +++ b/internal/api/session_response.go @@ -6,6 +6,7 @@ import ( "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/photoprism/get" + "github.com/photoprism/photoprism/pkg/i18n" ) // CreateSessionResponse returns the authentication response data for POST requests @@ -14,13 +15,18 @@ func CreateSessionResponse(authToken string, sess *entity.Session, conf *config. return GetSessionResponse(authToken, sess, conf) } -// CreateSessionError returns an authentication error response. -func CreateSessionError(code int, err error) gin.H { +// CreateSessionError returns an authentication error response. "error" is the +// instance-locale fallback; "messageId" (the English source) and "messageParams" +// let the Web UI render the message in the current UI locale. +func CreateSessionError(code int, id i18n.Message, params ...any) gin.H { + resp := i18n.NewResponse(code, id, params...) return gin.H{ - "status": StatusFailed, - "code": code, - "error": err.Error(), - "config": get.Config().ClientPublic(), + "status": StatusFailed, + "code": resp.Code, + "error": resp.Error, + "messageId": resp.MessageID, + "messageParams": resp.MessageParams, + "config": get.Config().ClientPublic(), } } @@ -35,7 +41,7 @@ func GetSessionResponse(authToken string, sess *entity.Session, conf *config.Cli "provider": sess.GetProvider().String(), "scope": sess.Scope(), "user": sess.GetUser(), - "data": sess.GetData(), + "data": sess.GetData().Redacted(), "config": conf, } } else { @@ -51,7 +57,7 @@ func GetSessionResponse(authToken string, sess *entity.Session, conf *config.Cli "provider": sess.GetProvider().String(), "scope": sess.Scope(), "user": sess.GetUser(), - "data": sess.GetData(), + "data": sess.GetData().Redacted(), "config": conf, } } diff --git a/internal/api/session_test.go b/internal/api/session_test.go index 35732744a..0752e8c12 100644 --- a/internal/api/session_test.go +++ b/internal/api/session_test.go @@ -2,14 +2,17 @@ package api import ( "net/http" + "strings" "testing" "github.com/stretchr/testify/assert" "github.com/tidwall/gjson" "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/form" "github.com/photoprism/photoprism/internal/photoprism/get" + "github.com/photoprism/photoprism/pkg/http/header" "github.com/photoprism/photoprism/pkg/i18n" "github.com/photoprism/photoprism/pkg/rnd" ) @@ -61,6 +64,19 @@ func TestGetSessionResponse(t *testing.T) { assert.Equal(t, sess.GetData(), result["data"]) assert.Equal(t, conf, result["config"]) }) + t.Run("RedactsGroups", func(t *testing.T) { + sess := get.Session().Public() + sess.SetData(sess.GetData().SetGroups([]string{"media-acme-admin"})) + defer func() { sess.SetData(sess.GetData().SetGroups(nil)) }() + conf := get.Config().ClientSession(sess) + + result := GetSessionResponse(sess.AuthToken(), sess, conf) + + if data, ok := result["data"].(*entity.SessionData); assert.True(t, ok) { + assert.Nil(t, data.Groups, "session responses must not disclose the login-time group set") + } + assert.NotEmpty(t, sess.GetData().Groups, "the stored session data keeps the groups") + }) } func TestCreateSession(t *testing.T) { @@ -87,6 +103,17 @@ func TestCreateSession(t *testing.T) { r := PerformRequestWithBody(app, http.MethodPost, "/api/v1/session", `{"username": 123, "password": "xxx"}`) assert.Equal(t, http.StatusBadRequest, r.Code) }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + CreateSession(router) + + body := `{"username":"` + strings.Repeat("a", 70*1024) + `","password":"photoprism"}` + r := PerformRequestWithBody(app, http.MethodPost, "/api/v1/session", body) + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) + }) t.Run("PublicInvalidToken", func(t *testing.T) { app, router, conf := NewApiTest() conf.SetAuthMode(config.AuthModePasswd) @@ -164,6 +191,7 @@ func TestCreateSession(t *testing.T) { val := gjson.Get(r.Body.String(), "error") assert.Equal(t, i18n.Msg(i18n.ErrInvalidCredentials), val.String()) + assert.Equal(t, i18n.Source(i18n.ErrInvalidCredentials), gjson.Get(r.Body.String(), "messageId").String()) assert.Equal(t, http.StatusUnauthorized, r.Code) }) t.Run("AliceSuccess", func(t *testing.T) { @@ -204,6 +232,7 @@ func TestCreateSession(t *testing.T) { r := PerformRequestWithBody(app, http.MethodPost, "/api/v1/session", `{"username": "bob", "password": "helloworld"}`) val := gjson.Get(r.Body.String(), "error") assert.Equal(t, i18n.Msg(i18n.ErrInvalidCredentials), val.String()) + assert.Equal(t, i18n.Source(i18n.ErrInvalidCredentials), gjson.Get(r.Body.String(), "messageId").String()) assert.Equal(t, http.StatusUnauthorized, r.Code) }) t.Run("TwoFaPasscodeRequired", func(t *testing.T) { @@ -219,6 +248,11 @@ func TestCreateSession(t *testing.T) { assert.Equal(t, "", userEmail.String()) assert.Equal(t, "", userName.String()) assert.Equal(t, http.StatusUnauthorized, r.Code) + // Code 32 is a continuation request, not an error: the text is in "message", not "error". + assert.Equal(t, int64(32), gjson.Get(r.Body.String(), "code").Int()) + assert.Equal(t, i18n.Msg(i18n.ErrPasscodeRequired), gjson.Get(r.Body.String(), "message").String()) + assert.Empty(t, gjson.Get(r.Body.String(), "error").String()) + assert.Equal(t, i18n.Source(i18n.ErrPasscodeRequired), gjson.Get(r.Body.String(), "messageId").String()) }) t.Run("TwoFaInvalidPasscode", func(t *testing.T) { app, router, conf := NewApiTest() @@ -278,6 +312,7 @@ func TestGetSession(t *testing.T) { id := gjson.Get(r.Body.String(), "session_id").String() assert.Equal(t, rnd.SessionID(authToken), id) assert.Equal(t, http.StatusOK, r.Code) + assert.Equal(t, header.CacheControlNoStore, r.Header().Get(header.CacheControl), "session responses must not be cached") }) t.Run("AdminAuthenticatedRequestWithID", func(t *testing.T) { app, router, conf := NewApiTest() diff --git a/internal/api/share_preview.go b/internal/api/share_preview.go index 538d55f66..556e0e7d8 100644 --- a/internal/api/share_preview.go +++ b/internal/api/share_preview.go @@ -8,7 +8,6 @@ import ( "path/filepath" "time" - "github.com/disintegration/imaging" "github.com/gin-gonic/gin" "github.com/photoprism/photoprism/internal/entity" @@ -135,7 +134,7 @@ func SharePreview(router *gin.RouterGroup) { continue } - img, imgErr := imaging.Open(thumbnail) + img, _, imgErr := fs.DecodeImageFile(thumbnail) if imgErr != nil { log.Warn(imgErr) @@ -154,10 +153,10 @@ func SharePreview(router *gin.RouterGroup) { } // Downsize from 1600x900 to 1200x675. - preview = imaging.Resize(preview, 1200, 0, imaging.Lanczos) + preview = thumb.Resample(preview, 1200, 675, thumb.ResampleResize) // Save the resulting album preview as JPEG. - err = imaging.Save(preview, previewFilename, thumb.JpegQualitySmall().EncodeOption()) + err = thumb.Save(preview, previewFilename, thumb.JpegQualitySmall()) if err != nil { log.Error(err) diff --git a/internal/api/subjects.go b/internal/api/subjects.go index 78ad26562..b29eae06b 100644 --- a/internal/api/subjects.go +++ b/internal/api/subjects.go @@ -85,7 +85,16 @@ func UpdateSubject(router *gin.RouterGroup) { log.Errorf("subject: %s (new form)", err) AbortSaveFailed(c) return - } else if err = c.BindJSON(frm); err != nil { + } + + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + + if err = c.BindJSON(frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + log.Errorf("subject: %s (update form)", err) AbortBadRequest(c, err) return @@ -140,7 +149,7 @@ func LikeSubject(router *gin.RouterGroup) { return } - PublishSubjectEvent(StatusUpdated, uid, c) + PublishSubjectEvent(StatusUpdated, uid) c.JSON(http.StatusOK, http.Response{}) }) @@ -177,7 +186,7 @@ func DislikeSubject(router *gin.RouterGroup) { return } - PublishSubjectEvent(StatusUpdated, uid, c) + PublishSubjectEvent(StatusUpdated, uid) c.JSON(http.StatusOK, http.Response{}) }) diff --git a/internal/api/subjects_search.go b/internal/api/subjects_search.go index 09c9715b4..0fc878ea2 100644 --- a/internal/api/subjects_search.go +++ b/internal/api/subjects_search.go @@ -19,6 +19,9 @@ import ( // @Tags Subjects // @Produce json // @Success 200 {object} search.SubjectResults +// @Header 200 {number} X-Count "The actual number of subjects returned" +// @Header 200 {number} X-Limit "The limit of the number of subjects to be returned" +// @Header 200 {number} X-Offset "The offset that was used" // @Failure 401,429,403,400 {object} i18n.Response // @Param count query int true "maximum number of results" minimum(1) maximum(100000) // @Param offset query int false "search result offset" minimum(0) maximum(100000) diff --git a/internal/api/swagger.json b/internal/api/swagger.json index 7a9a38ef2..d3a6a4d59 100644 --- a/internal/api/swagger.json +++ b/internal/api/swagger.json @@ -351,6 +351,19 @@ "AdvertiseUrl": { "type": "string" }, + "AllowGroupRoles": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "AllowGroups": { + "description": "Group-based admission config (redacted for non-admin sessions):\nAllowGroups admits matching login-time groups, AllowGroupRoles\noptionally overrides the default role per group, GroupsFullView opts the\nnode into receiving the user's full group set, and GroupsSrc is the\nAllowGroups provenance (\"node\" = instance-declared via env, \"manual\" =\nadmin-pinned; empty = unmanaged).", + "items": { + "type": "string" + }, + "type": "array" + }, "AppName": { "type": "string" }, @@ -366,6 +379,15 @@ "Database": { "$ref": "#/definitions/cluster.NodeDatabase" }, + "DisplayName": { + "type": "string" + }, + "GroupsFullView": { + "type": "boolean" + }, + "GroupsSrc": { + "type": "string" + }, "Labels": { "additionalProperties": { "type": "string" @@ -376,6 +398,12 @@ "description": "NodeName", "type": "string" }, + "RedirectURIs": { + "items": { + "type": "string" + }, + "type": "array" + }, "Role": { "description": "NodeRole", "type": "string" @@ -462,6 +490,9 @@ "Node": { "$ref": "#/definitions/cluster.Node" }, + "PortalLoginUrl": { + "type": "string" + }, "Secrets": { "$ref": "#/definitions/cluster.RegisterSecrets" }, @@ -603,6 +634,9 @@ "DisableJpegXL": { "type": "boolean" }, + "DisableMCP": { + "type": "boolean" + }, "DisableOIDC": { "type": "boolean" }, @@ -627,9 +661,6 @@ "DisableVectors": { "type": "boolean" }, - "DisableVips": { - "type": "boolean" - }, "DisableWebDAV": { "type": "boolean" }, @@ -682,7 +713,7 @@ "type": "string" }, "IndexWorkers": { - "type": "integer" + "type": "string" }, "JpegQuality": { "type": "integer" @@ -699,6 +730,9 @@ "OIDCIcon": { "type": "string" }, + "OIDCLogout": { + "type": "boolean" + }, "OIDCProvider": { "type": "string" }, @@ -745,6 +779,9 @@ "SiteFavicon": { "type": "string" }, + "SiteName": { + "type": "string" + }, "SitePreview": { "type": "string" }, @@ -769,9 +806,6 @@ "ThumbColor": { "type": "string" }, - "ThumbFilter": { - "type": "string" - }, "ThumbLibrary": { "type": "string" }, @@ -877,6 +911,9 @@ "albums": { "type": "boolean" }, + "appPasswords": { + "type": "boolean" + }, "archive": { "type": "boolean" }, @@ -886,6 +923,9 @@ "calendar": { "type": "boolean" }, + "cameras": { + "type": "boolean" + }, "delete": { "type": "boolean" }, @@ -913,6 +953,9 @@ "labels": { "type": "boolean" }, + "lenses": { + "type": "boolean" + }, "library": { "type": "boolean" }, @@ -1093,6 +1136,12 @@ "language": { "type": "string" }, + "openOnHover": { + "type": "boolean" + }, + "reduceMotion": { + "type": "boolean" + }, "scrollbar": { "type": "boolean" }, @@ -2635,6 +2684,17 @@ }, "type": "object" }, + "form.Camera": { + "properties": { + "Make": { + "type": "string" + }, + "Model": { + "type": "string" + } + }, + "type": "object" + }, "form.ChangePassword": { "properties": { "new": { @@ -2777,6 +2837,17 @@ }, "type": "object" }, + "form.Lens": { + "properties": { + "Make": { + "type": "string" + }, + "Model": { + "type": "string" + } + }, + "type": "object" + }, "form.Link": { "properties": { "CanComment": { @@ -3372,6 +3443,13 @@ }, "message": { "type": "string" + }, + "messageId": { + "type": "string" + }, + "messageParams": { + "items": {}, + "type": "array" } }, "type": "object" @@ -3792,6 +3870,29 @@ }, "type": "object" }, + "query.Moment": { + "properties": { + "Country": { + "type": "string" + }, + "Label": { + "type": "string" + }, + "Month": { + "type": "integer" + }, + "PhotoCount": { + "type": "integer" + }, + "State": { + "type": "string" + }, + "Year": { + "type": "integer" + } + }, + "type": "object" + }, "search.Album": { "properties": { "Caption": { @@ -3881,6 +3982,44 @@ }, "type": "object" }, + "search.Camera": { + "properties": { + "CreatedAt": { + "type": "string" + }, + "DeletedAt": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "ID": { + "type": "integer" + }, + "Make": { + "type": "string" + }, + "Model": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Notes": { + "type": "string" + }, + "Slug": { + "type": "string" + }, + "Type": { + "type": "string" + }, + "UpdatedAt": { + "type": "string" + } + }, + "type": "object" + }, "search.Face": { "properties": { "CollisionRadius": { @@ -3972,6 +4111,12 @@ "Lng": { "type": "number" }, + "Panorama": { + "type": "boolean" + }, + "Projection": { + "type": "string" + }, "TakenAt": { "type": "string" }, @@ -4049,6 +4194,44 @@ }, "type": "object" }, + "search.Lens": { + "properties": { + "CreatedAt": { + "type": "string" + }, + "DeletedAt": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "ID": { + "type": "integer" + }, + "Make": { + "type": "string" + }, + "Model": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Notes": { + "type": "string" + }, + "Slug": { + "type": "string" + }, + "Type": { + "type": "string" + }, + "UpdatedAt": { + "type": "string" + } + }, + "type": "object" + }, "search.Photo": { "properties": { "Altitude": { @@ -4233,6 +4416,9 @@ "Private": { "type": "boolean" }, + "Projection": { + "type": "string" + }, "Quality": { "type": "integer" }, @@ -4462,6 +4648,49 @@ "ShapeBatch" ] }, + "thumb.Thumb": { + "properties": { + "h": { + "type": "integer" + }, + "src": { + "type": "string" + }, + "w": { + "type": "integer" + } + }, + "type": "object" + }, + "thumb.Viewer": { + "properties": { + "fit_1280": { + "$ref": "#/definitions/thumb.Thumb" + }, + "fit_15360": { + "$ref": "#/definitions/thumb.Thumb" + }, + "fit_1920": { + "$ref": "#/definitions/thumb.Thumb" + }, + "fit_2560": { + "$ref": "#/definitions/thumb.Thumb" + }, + "fit_4096": { + "$ref": "#/definitions/thumb.Thumb" + }, + "fit_5120": { + "$ref": "#/definitions/thumb.Thumb" + }, + "fit_720": { + "$ref": "#/definitions/thumb.Thumb" + }, + "fit_7680": { + "$ref": "#/definitions/thumb.Thumb" + } + }, + "type": "object" + }, "time.Duration": { "format": "int64", "type": "integer" @@ -4479,6 +4708,71 @@ }, "type": "object" }, + "viewer.Result": { + "properties": { + "Caption": { + "type": "string" + }, + "Codec": { + "type": "string" + }, + "DownloadUrl": { + "type": "string" + }, + "Duration": { + "$ref": "#/definitions/time.Duration" + }, + "Favorite": { + "type": "boolean" + }, + "Hash": { + "type": "string" + }, + "Height": { + "type": "integer" + }, + "Lat": { + "type": "number" + }, + "Lng": { + "type": "number" + }, + "Mime": { + "type": "string" + }, + "Panorama": { + "type": "boolean" + }, + "Playable": { + "type": "boolean" + }, + "Projection": { + "type": "string" + }, + "TakenAtLocal": { + "type": "string" + }, + "Thumbs": { + "$ref": "#/definitions/thumb.Viewer" + }, + "TimeZone": { + "type": "string" + }, + "Title": { + "type": "string" + }, + "Type": { + "type": "string" + }, + "UID": { + "type": "string" + }, + "Width": { + "type": "integer" + } + }, + "type": "object" + }, "vision.ApiFormat": { "enum": [ "url", @@ -5010,6 +5304,20 @@ "responses": { "200": { "description": "OK", + "headers": { + "X-Count": { + "description": "The actual number of albums returned", + "type": "number" + }, + "X-Limit": { + "description": "The limit of the number of albums to be returned", + "type": "number" + }, + "X-Offset": { + "description": "The offset that was used", + "type": "number" + } + }, "schema": { "items": { "$ref": "#/definitions/search.Album" @@ -5541,7 +5849,10 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/entity.Link" + "items": { + "$ref": "#/definitions/entity.Link" + }, + "type": "array" } }, "401": { @@ -6538,6 +6849,163 @@ ] } }, + "/api/v1/cameras": { + "get": { + "operationId": "SearchCameras", + "parameters": [ + { + "description": "maximum number of results", + "in": "query", + "maximum": 100000, + "minimum": 1, + "name": "count", + "required": true, + "type": "integer" + }, + { + "description": "search result offset", + "in": "query", + "maximum": 100000, + "minimum": 0, + "name": "offset", + "type": "integer" + }, + { + "description": "show where make is blank", + "in": "query", + "name": "nomake", + "type": "boolean" + }, + { + "description": "search query", + "in": "query", + "name": "q", + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "X-Count": { + "description": "The actual number of cameras returned", + "type": "number" + }, + "X-Limit": { + "description": "The limit of the number of cameras to be returned", + "type": "number" + }, + "X-Offset": { + "description": "The offset that was used", + "type": "number" + } + }, + "schema": { + "items": { + "$ref": "#/definitions/search.Camera" + }, + "type": "array" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "429": { + "description": "Too Many Requests", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + } + }, + "summary": "finds and returns cameras as JSON", + "tags": [ + "Cameras" + ] + } + }, + "/api/v1/cameras/{id}": { + "put": { + "consumes": [ + "application/json" + ], + "operationId": "UpdateCamera", + "parameters": [ + { + "description": "Camera ID", + "in": "path", + "name": "id", + "required": true, + "type": "string" + }, + { + "description": "Properties to be updated, only Make and Model supported", + "in": "body", + "name": "camera", + "required": true, + "schema": { + "$ref": "#/definitions/form.Camera" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/entity.Camera" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "404": { + "description": "Not Found", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "429": { + "description": "Too Many Requests", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + } + }, + "summary": "updates camera name", + "tags": [ + "Cameras" + ] + } + }, "/api/v1/cluster": { "get": { "operationId": "ClusterSummary", @@ -6897,7 +7365,7 @@ "type": "string" }, { - "description": "properties to update (Role, Labels, AdvertiseUrl, SiteUrl)", + "description": "properties to update (Role, DisplayName, Labels, AdvertiseUrl, SiteUrl, RedirectURIs, AllowGroups, AllowGroupRoles, GroupsFullView)", "in": "body", "name": "node", "required": true, @@ -7313,6 +7781,20 @@ "responses": { "200": { "description": "OK", + "headers": { + "X-Count": { + "description": "The actual number of errors returned", + "type": "number" + }, + "X-Limit": { + "description": "The limit of the number of errors to be returned", + "type": "number" + }, + "X-Offset": { + "description": "The offset that was used", + "type": "number" + } + }, "schema": { "$ref": "#/definitions/entity.Error" } @@ -7407,6 +7889,20 @@ "responses": { "200": { "description": "OK", + "headers": { + "X-Count": { + "description": "The actual number of faces returned", + "type": "number" + }, + "X-Limit": { + "description": "The limit of the number of faces to be returned", + "type": "number" + }, + "X-Offset": { + "description": "The offset that was used", + "type": "number" + } + }, "schema": { "items": { "$ref": "#/definitions/search.Face" @@ -7641,6 +8137,28 @@ "responses": { "200": { "description": "OK", + "headers": { + "X-Count": { + "description": "The actual number of files and folders returned. Do not use for determining if all the results have been returned.", + "type": "number" + }, + "X-Files": { + "description": "The actual number of files returned. Use this for comparing to X-Limit to determine if all the results have been returned.", + "type": "number" + }, + "X-Folders": { + "description": "The actual number of folders returned. Do not use for determining if all the results have been returned.", + "type": "number" + }, + "X-Limit": { + "description": "The limit of the number of files to be returned", + "type": "number" + }, + "X-Offset": { + "description": "The offset that was used", + "type": "number" + } + }, "schema": { "$ref": "#/definitions/api.FoldersResponse" } @@ -7840,6 +8358,20 @@ "responses": { "200": { "description": "OK", + "headers": { + "X-Count": { + "description": "The actual number of files returned", + "type": "number" + }, + "X-Limit": { + "description": "The limit of the number of files to be returned", + "type": "number" + }, + "X-Offset": { + "description": "The offset that was used", + "type": "number" + } + }, "schema": { "items": { "$ref": "#/definitions/search.GeoResult" @@ -8120,8 +8652,25 @@ "responses": { "200": { "description": "OK", + "headers": { + "X-Count": { + "description": "The actual number of labels returned", + "type": "number" + }, + "X-Limit": { + "description": "The limit of the number of labels to be returned", + "type": "number" + }, + "X-Offset": { + "description": "The offset that was used", + "type": "number" + } + }, "schema": { - "$ref": "#/definitions/search.Label" + "items": { + "$ref": "#/definitions/search.Label" + }, + "type": "array" } }, "400": { @@ -8387,6 +8936,163 @@ ] } }, + "/api/v1/lenses": { + "get": { + "operationId": "SearchLenses", + "parameters": [ + { + "description": "maximum number of results", + "in": "query", + "maximum": 100000, + "minimum": 1, + "name": "count", + "required": true, + "type": "integer" + }, + { + "description": "search result offset", + "in": "query", + "maximum": 100000, + "minimum": 0, + "name": "offset", + "type": "integer" + }, + { + "description": "show where make is blank", + "in": "query", + "name": "nomake", + "type": "boolean" + }, + { + "description": "search query", + "in": "query", + "name": "q", + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "X-Count": { + "description": "The actual number of lenses returned", + "type": "number" + }, + "X-Limit": { + "description": "The limit of the number of lenses to be returned", + "type": "number" + }, + "X-Offset": { + "description": "The offset that was used", + "type": "number" + } + }, + "schema": { + "items": { + "$ref": "#/definitions/search.Lens" + }, + "type": "array" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "429": { + "description": "Too Many Requests", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + } + }, + "summary": "finds and returns lenses as JSON", + "tags": [ + "Lenses" + ] + } + }, + "/api/v1/lenses/{id}": { + "put": { + "consumes": [ + "application/json" + ], + "operationId": "UpdateLens", + "parameters": [ + { + "description": "Lens ID", + "in": "path", + "name": "id", + "required": true, + "type": "string" + }, + { + "description": "Properties to be updated, only Make and Model supported", + "in": "body", + "name": "lens", + "required": true, + "schema": { + "$ref": "#/definitions/form.Lens" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/entity.Lens" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "404": { + "description": "Not Found", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "429": { + "description": "Too Many Requests", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + } + }, + "summary": "updates lens name", + "tags": [ + "Lenses" + ] + } + }, "/api/v1/markers": { "post": { "produces": [ @@ -8535,6 +9241,59 @@ ] } }, + "/api/v1/mcp": { + "post": { + "consumes": [ + "application/json" + ], + "operationId": "ServeMCP", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "JSON-RPC 2.0 response", + "schema": { + "type": "string" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "404": { + "description": "Not Found", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "413": { + "description": "Request Entity Too Large", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "429": { + "description": "Too Many Requests", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + } + }, + "summary": "model context protocol endpoint", + "tags": [ + "MCP" + ] + } + }, "/api/v1/metrics": { "get": { "operationId": "GetMetrics", @@ -8580,7 +9339,10 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/entity.Album" + "items": { + "$ref": "#/definitions/query.Moment" + }, + "type": "array" } }, "401": { @@ -8621,6 +9383,18 @@ "application/json" ], "responses": { + "302": { + "description": "redirect to the client redirect_uri with an authorization code", + "schema": { + "type": "string" + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, "405": { "description": "Method Not Allowed", "schema": { @@ -8628,7 +9402,69 @@ } } }, - "summary": "OAuth2 authorization endpoint (not implemented)", + "summary": "OAuth2/OIDC authorization endpoint", + "tags": [ + "Authentication" + ] + } + }, + "/api/v1/oauth/logout": { + "get": { + "operationId": "OAuthLogout", + "produces": [ + "application/json" + ], + "responses": { + "302": { + "description": "redirect to post_logout_redirect_uri", + "schema": { + "type": "string" + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "405": { + "description": "Method Not Allowed", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + } + }, + "summary": "OAuth2/OIDC end-session endpoint (RP-initiated logout)", + "tags": [ + "Authentication" + ] + }, + "post": { + "operationId": "OAuthLogout", + "produces": [ + "application/json" + ], + "responses": { + "302": { + "description": "redirect to post_logout_redirect_uri", + "schema": { + "type": "string" + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "405": { + "description": "Method Not Allowed", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + } + }, + "summary": "OAuth2/OIDC end-session endpoint (RP-initiated logout)", "tags": [ "Authentication" ] @@ -8737,6 +9573,12 @@ "$ref": "#/definitions/i18n.Response" } }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, "429": { "description": "Too Many Requests", "schema": { @@ -8757,6 +9599,18 @@ "application/json" ], "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/gin.H" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, "405": { "description": "Method Not Allowed", "schema": { @@ -8764,7 +9618,37 @@ } } }, - "summary": "OAuth2 userinfo endpoint (not implemented)", + "summary": "OAuth2/OIDC userinfo endpoint", + "tags": [ + "Authentication" + ] + }, + "post": { + "operationId": "OAuthUserinfo", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/gin.H" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "405": { + "description": "Method Not Allowed", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + } + }, + "summary": "OAuth2/OIDC userinfo endpoint", "tags": [ "Authentication" ] @@ -8864,7 +9748,7 @@ }, "/api/v1/photos": { "get": { - "description": "Fore more information see:\n- https://docs.photoprism.app/developer-guide/api/search/#get-apiv1photos", + "description": "For more information see:\n- https://docs.photoprism.app/developer-guide/api/search/#get-apiv1photos", "operationId": "SearchPhotos", "parameters": [ { @@ -8961,6 +9845,20 @@ "responses": { "200": { "description": "OK", + "headers": { + "X-Count": { + "description": "The actual number of files returned", + "type": "number" + }, + "X-Limit": { + "description": "The limit of the number of files to be returned", + "type": "number" + }, + "X-Offset": { + "description": "The offset that was used", + "type": "number" + } + }, "schema": { "items": { "$ref": "#/definitions/search.Photo" @@ -8999,6 +9897,157 @@ ] } }, + "/api/v1/photos/view": { + "get": { + "description": "Returns search results formatted for the photo viewer (lightbox) in the web UI,\nincluding resolved content URLs and preview/download tokens.\nFor more information see:\n- https://docs.photoprism.app/developer-guide/api/search/#get-apiv1photos", + "operationId": "SearchPhotosView", + "parameters": [ + { + "description": "maximum number of files", + "in": "query", + "maximum": 100000, + "minimum": 1, + "name": "count", + "required": true, + "type": "integer" + }, + { + "description": "file offset", + "in": "query", + "maximum": 100000, + "minimum": 0, + "name": "offset", + "type": "integer" + }, + { + "description": "sort order", + "enum": [ + "name", + "title", + "added", + "edited", + "newest", + "oldest", + "size", + "random", + "duration", + "relevance" + ], + "in": "query", + "name": "order", + "type": "string" + }, + { + "description": "groups consecutive files that belong to the same photo", + "in": "query", + "name": "merged", + "type": "boolean" + }, + { + "description": "excludes private pictures", + "in": "query", + "name": "public", + "type": "boolean" + }, + { + "description": "minimum quality score (1-7)", + "enum": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6, + 7 + ], + "in": "query", + "name": "quality", + "type": "integer" + }, + { + "description": "search query", + "in": "query", + "name": "q", + "type": "string" + }, + { + "description": "album uid", + "in": "query", + "name": "s", + "type": "string" + }, + { + "description": "photo path", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "is type video", + "in": "query", + "name": "video", + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "X-Count": { + "description": "The actual number of files returned", + "type": "number" + }, + "X-Limit": { + "description": "The limit of the number of files to be returned", + "type": "number" + }, + "X-Offset": { + "description": "The offset that was used", + "type": "number" + } + }, + "schema": { + "items": { + "$ref": "#/definitions/viewer.Result" + }, + "type": "array" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + }, + "404": { + "description": "Not Found", + "schema": { + "$ref": "#/definitions/i18n.Response" + } + } + }, + "summary": "finds pictures and returns a viewer-formatted JSON result for the lightbox", + "tags": [ + "Photos" + ] + } + }, "/api/v1/photos/{uid}": { "get": { "operationId": "GetPhoto", @@ -10034,9 +11083,9 @@ } }, "400": { - "description": "Missing search query", + "description": "Bad Request", "schema": { - "$ref": "#/definitions/gin.H" + "$ref": "#/definitions/i18n.Response" } }, "401": { @@ -10110,6 +11159,20 @@ "responses": { "200": { "description": "OK", + "headers": { + "X-Count": { + "description": "The actual number of services returned", + "type": "number" + }, + "X-Limit": { + "description": "The limit of the number of services to be returned", + "type": "number" + }, + "X-Offset": { + "description": "The offset that was used", + "type": "number" + } + }, "schema": { "items": { "$ref": "#/definitions/entity.Service" @@ -11073,6 +12136,20 @@ "responses": { "200": { "description": "OK", + "headers": { + "X-Count": { + "description": "The actual number of subjects returned", + "type": "number" + }, + "X-Limit": { + "description": "The limit of the number of subjects to be returned", + "type": "number" + }, + "X-Offset": { + "description": "The offset that was used", + "type": "number" + } + }, "schema": { "items": { "$ref": "#/definitions/search.Subject" @@ -11401,7 +12478,7 @@ }, "/api/v1/t/{thumb}/{token}/{size}": { "get": { - "description": "Fore more information see:\n- https://docs.photoprism.app/developer-guide/api/thumbnails/#image-endpoint-uri", + "description": "For more information see:\n- https://docs.photoprism.app/developer-guide/api/thumbnails/#image-endpoint-uri", "operationId": "GetThumb", "parameters": [ { @@ -12183,13 +13260,13 @@ }, "/api/v1/videos/{hash}/{token}/{format}": { "get": { - "description": "Fore more information see:\n- https://docs.photoprism.app/developer-guide/api/thumbnails/#video-endpoint-uri", + "description": "For more information see:\n- https://docs.photoprism.app/developer-guide/api/thumbnails/#video-endpoint-uri", "operationId": "GetVideo", "parameters": [ { "description": "SHA1 video file hash", "in": "path", - "name": "thumb", + "name": "hash", "required": true, "type": "string" }, diff --git a/internal/api/thumbnails.go b/internal/api/thumbnails.go index 29c996133..d9c154aae 100644 --- a/internal/api/thumbnails.go +++ b/internal/api/thumbnails.go @@ -19,7 +19,7 @@ import ( // GetThumb returns a thumbnail image matching the file hash, crop area, and type. // // @Summary returns a thumbnail image with the requested size -// @Description Fore more information see: +// @Description For more information see: // @Description - https://docs.photoprism.app/developer-guide/api/thumbnails/#image-endpoint-uri // @Id GetThumb // @Produce image/jpeg, image/svg+xml diff --git a/internal/api/users_avatar.go b/internal/api/users_avatar.go index 96fc5b8f4..d406ee864 100644 --- a/internal/api/users_avatar.go +++ b/internal/api/users_avatar.go @@ -13,6 +13,7 @@ import ( "github.com/photoprism/photoprism/internal/photoprism/get" "github.com/photoprism/photoprism/internal/thumb/avatar" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/fs/disk" "github.com/photoprism/photoprism/pkg/http/header" "github.com/photoprism/photoprism/pkg/i18n" "github.com/photoprism/photoprism/pkg/log/status" @@ -40,27 +41,43 @@ func UploadUserAvatar(router *gin.RouterGroup) { return } + // Require user management or own-account access. s := AuthAny(c, acl.ResourceUsers, acl.Permissions{acl.ActionManage, acl.AccessOwn}) if s.Abort(c) { return } - // Check if the session user is has user management privileges. + // Check whether the role can manage all user accounts. isAdmin := acl.Rules.AllowAll(acl.ResourceUsers, s.GetUserRole(), acl.Permissions{acl.AccessAll, acl.ActionManage}) uid := clean.UID(c.Param("uid")) - // Users may only change their own avatar. + // Non-admin users may only change their own avatar. if !isAdmin && s.GetUser().UserUID != uid { event.AuditErr([]string{ClientIP(c), "session %s", "upload avatar", "user does not match"}, s.RefID) AbortForbidden(c) return } + // Abort if there is not enough free storage to upload a new avatar. + if conf.InsufficientStorage() { + event.AuditErr([]string{ClientIP(c), "session %s", "upload avatar", status.InsufficientStorage}, s.RefID) + Abort(c, http.StatusInsufficientStorage, i18n.ErrInsufficientStorage) + return + } + // Parse upload form. + LimitRequestBodyBytes(c, MaxAvatarUploadBytes) + f, err := c.MultipartForm() if err != nil { + if IsRequestBodyTooLarge(err) { + event.AuditWarn([]string{ClientIP(c), "session %s", "upload avatar", "request too large"}, s.RefID) + AbortRequestTooLarge(c, i18n.ErrFileTooLarge) + return + } + event.AuditErr([]string{ClientIP(c), "session %s", "upload avatar", status.Error(err)}, s.RefID) Abort(c, http.StatusBadRequest, i18n.ErrUploadFailed) return @@ -125,6 +142,14 @@ func UploadUserAvatar(router *gin.RouterGroup) { // Save avatar image. if err = c.SaveUploadedFile(file, filePath); err != nil { + // Report a disk-full write failure as insufficient storage so the cause is clear. + if disk.IsNoSpace(err) { + disk.FlushFree() + event.AuditErr([]string{ClientIP(c), "session %s", "upload avatar", status.InsufficientStorage}, s.RefID) + Abort(c, http.StatusInsufficientStorage, i18n.ErrInsufficientStorage) + return + } + event.AuditErr([]string{ClientIP(c), "session %s", "upload avatar", "failed to save %s"}, s.RefID, clean.Log(filePath)) Abort(c, http.StatusBadRequest, i18n.ErrUploadFailed) return diff --git a/internal/api/users_avatar_test.go b/internal/api/users_avatar_test.go index 5b5587da2..758c76dcb 100644 --- a/internal/api/users_avatar_test.go +++ b/internal/api/users_avatar_test.go @@ -1,14 +1,17 @@ package api import ( + "bytes" "fmt" "net/http" + "net/http/httptest" "testing" "github.com/stretchr/testify/assert" "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/pkg/http/header" ) func TestUploadUserAvatar(t *testing.T) { @@ -48,4 +51,30 @@ func TestUploadUserAvatar(t *testing.T) { assert.Equal(t, http.StatusForbidden, r.Code) }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, conf := NewApiTest() + adminUid := entity.Admin.UserUID + + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + + reqUrl := fmt.Sprintf("/api/v1/users/%s/avatar", adminUid) + UploadUserAvatar(router) + authToken := AuthenticateAdmin(app, router) + + tooLarge := bytes.Repeat([]byte("A"), 22*1024*1024) + body, ctype, err := buildMultipart(map[string][]byte{"avatar.jpg": tooLarge}) + if err != nil { + t.Fatal(err) + } + + req := httptest.NewRequest(http.MethodPost, reqUrl, body) + req.Header.Set("Content-Type", ctype) + header.SetAuthorization(req, authToken) + + w := httptest.NewRecorder() + app.ServeHTTP(w, req) + + assert.Equal(t, http.StatusRequestEntityTooLarge, w.Code) + }) } diff --git a/internal/api/users_passcode.go b/internal/api/users_passcode.go index fe9da2c38..5afe8eb56 100644 --- a/internal/api/users_passcode.go +++ b/internal/api/users_passcode.go @@ -175,10 +175,10 @@ func ActivateUserPasscode(router *gin.RouterGroup) { // Log event. event.AuditInfo([]string{ClientIP(c), "session %s", authn.Users, user.UserName, authn.Passcode, status.Activated}, s.RefID) - // Invalidate any other user sessions to protect the account: - // https://cheatsheetseries.owasp.org/cheatsheets/Session_Management_Cheat_Sheet.html - event.AuditInfo([]string{ClientIP(c), "session %s", authn.Users, user.UserName, "invalidated %s"}, s.RefID, - english.Plural(user.DeleteSessions([]string{s.ID}), authn.Session, authn.Sessions)) + // Revoke other user sessions after a privilege level change, + // except for app passwords and client access tokens. + event.AuditInfo([]string{ClientIP(c), "session %s", authn.Users, user.UserName, "revoked %s"}, s.RefID, + english.Plural(user.RevokeDerivedSessions([]string{s.ID}), authn.Session, authn.Sessions)) // Clear session cache. s.ClearCache() @@ -249,16 +249,16 @@ func DeactivateUserPasscode(router *gin.RouterGroup) { func checkUserPasscodeAuth(c *gin.Context, action acl.Permission) (*entity.Session, *entity.User, *form.Passcode, error) { conf := get.Config() - // Prevent caching of API response. + // Prevent API response caching. c.Header(header.CacheControl, header.CacheControlNoStore) - // You cannot change any passwords without authentication and settings enabled. + // Passcode changes require authentication and enabled settings. if conf.Public() || conf.DisableSettings() { Abort(c, http.StatusForbidden, i18n.ErrPublic) return nil, nil, nil, authn.ErrPasscodeNotSupported } - // Check limit for failed auth requests (max. 10 per minute). + // Enforce the failed authentication rate limit. if limiter.Login.Reject(ClientIP(c)) { limiter.AbortJSON(c) return nil, nil, nil, authn.ErrRateLimitExceeded @@ -271,13 +271,13 @@ func checkUserPasscodeAuth(c *gin.Context, action acl.Permission) (*entity.Sessi return s, nil, nil, authn.ErrUnauthorized } - // Check if the current user has management privileges. + // Normalize the target user UID. uid := clean.UID(c.Param("uid")) // Get user from session. user := s.GetUser() - // Regular users can only set up a passcode for their own account. + // Users may only manage passcodes for their own account. if user.UserUID != uid || !user.CanLogIn() { AbortForbidden(c) return s, nil, nil, authn.ErrUnauthorized @@ -292,7 +292,14 @@ func checkUserPasscodeAuth(c *gin.Context, action acl.Permission) (*entity.Sessi frm := &form.Passcode{} // Validate request form values. + LimitRequestBodyBytes(c, MaxAuthRequestBytes) + if err := c.BindJSON(frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrInvalidPassword) + return s, nil, nil, authn.ErrInvalidRequest + } + Error(c, http.StatusBadRequest, err, i18n.ErrInvalidPassword) return s, nil, nil, authn.ErrInvalidRequest } else if authn.KeyTOTP.NotEqual(frm.Type) { @@ -335,7 +342,7 @@ func checkUserPasscodePassword(c *gin.Context, user *entity.User, password strin Password: password, } - // Check if user login credentials are valid. + // Check whether user login credentials are valid. authUser, provider, method, authErr := entity.Auth(f, nil, c) switch { diff --git a/internal/api/users_passcode_test.go b/internal/api/users_passcode_test.go index 31a3bf7ce..c4f153e79 100644 --- a/internal/api/users_passcode_test.go +++ b/internal/api/users_passcode_test.go @@ -3,6 +3,7 @@ package api import ( "encoding/json" "net/http" + "strings" "testing" "time" @@ -87,6 +88,18 @@ func TestCreateUserPasscode(t *testing.T) { assert.Equal(t, http.StatusForbidden, r.Code) } }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + CreateUserPasscode(router) + sessId := AuthenticateUser(app, router, "alice", "Alice123!") + + body := `{"Type":"totp","Password":"` + strings.Repeat("a", int(MaxAuthRequestBytes)) + `"}` + r := AuthenticatedRequestWithBody(app, "POST", "/api/v1/users/uqxetse3cy5eo9z2/passcode", body, sessId) + + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) + }) t.Run("AliceSuccess", func(t *testing.T) { app, router, conf := NewApiTest() conf.SetAuthMode(config.AuthModePasswd) diff --git a/internal/api/users_password.go b/internal/api/users_password.go index 3132621d2..e78e3ac40 100644 --- a/internal/api/users_password.go +++ b/internal/api/users_password.go @@ -32,7 +32,7 @@ func UpdateUserPassword(router *gin.RouterGroup) { router.PUT("/users/:uid/password", func(c *gin.Context) { conf := get.Config() - // You cannot change any passwords without authentication and settings enabled. + // Password changes require authentication and enabled settings. if conf.Public() || conf.DisableSettings() { Abort(c, http.StatusForbidden, i18n.ErrPublic) return @@ -56,14 +56,14 @@ func UpdateUserPassword(router *gin.RouterGroup) { return } - // Check if the current user has management privileges. + // Check whether the role can manage all user accounts. isAdmin := acl.Rules.AllowAll(acl.ResourceUsers, s.GetUserRole(), acl.Permissions{acl.AccessAll, acl.ActionManage}) isSuperAdmin := isAdmin && s.GetUser().IsSuperAdmin() uid := clean.UID(c.Param("uid")) var u *entity.User - // Regular users may only change their own password. + // Non-admin users may only change their own password. if !isAdmin && s.GetUser().UserUID != uid { AbortForbidden(c) return @@ -79,7 +79,14 @@ func UpdateUserPassword(router *gin.RouterGroup) { f := form.ChangePassword{} // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxAuthRequestBytes) + if err := c.BindJSON(&f); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrInvalidPassword) + return + } + Error(c, http.StatusBadRequest, err, i18n.ErrInvalidPassword) return } @@ -110,10 +117,10 @@ func UpdateUserPassword(router *gin.RouterGroup) { // Log event. event.AuditInfo([]string{ClientIP(c), "session %s", "users", u.UserName, "password", "changed"}, s.RefID) - // Invalidate any other user sessions to protect the account: - // https://cheatsheetseries.owasp.org/cheatsheets/Session_Management_Cheat_Sheet.html - event.AuditInfo([]string{ClientIP(c), "session %s", "users", u.UserName, "invalidated %s"}, s.RefID, - english.Plural(u.DeleteSessions([]string{s.ID}), "session", "sessions")) + // Revoke other user sessions after a privilege level change, + // except for app passwords and client access tokens. + event.AuditInfo([]string{ClientIP(c), "session %s", "users", u.UserName, "revoked %s"}, s.RefID, + english.Plural(u.RevokeDerivedSessions([]string{s.ID}), "session", "sessions")) AddTokenHeaders(c, s) c.JSON(http.StatusOK, i18n.NewResponse(http.StatusOK, i18n.MsgPasswordChanged)) diff --git a/internal/api/users_password_test.go b/internal/api/users_password_test.go index 5b34edd3b..6b10f2cb6 100644 --- a/internal/api/users_password_test.go +++ b/internal/api/users_password_test.go @@ -3,6 +3,7 @@ package api import ( "encoding/json" "net/http" + "strings" "testing" "github.com/stretchr/testify/assert" @@ -49,6 +50,18 @@ func TestChangePassword(t *testing.T) { "{OldPassword: old}", sessId) assert.Equal(t, http.StatusBadRequest, r.Code) }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + UpdateUserPassword(router) + sessId := AuthenticateUser(app, router, "alice", "Alice123!") + + body := `{"OldPassword":"Alice123!","NewPassword":"` + strings.Repeat("a", int(MaxAuthRequestBytes)) + `"}` + r := AuthenticatedRequestWithBody(app, "PUT", "/api/v1/users/uqxetse3cy5eo9z2/password", body, sessId) + + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) + }) t.Run("AliceProvidesWrongPassword", func(t *testing.T) { app, router, conf := NewApiTest() conf.SetAuthMode(config.AuthModePasswd) diff --git a/internal/api/users_sessions.go b/internal/api/users_sessions.go index 5b2f74676..876d52c30 100644 --- a/internal/api/users_sessions.go +++ b/internal/api/users_sessions.go @@ -31,7 +31,7 @@ import ( // @Router /api/v1/users/{uid}/sessions [get] func FindUserSessions(router *gin.RouterGroup) { router.GET("/users/:uid/sessions", func(c *gin.Context) { - // Check if the session user is has user management privileges. + // Require own-session management access. s := Auth(c, acl.ResourceSessions, acl.ActionManageOwn) if s.Abort(c) { @@ -60,7 +60,7 @@ func FindUserSessions(router *gin.RouterGroup) { return } - // Find applications that belong to the current user and sort them by name. + // Find application sessions for the current user and sort them by client name. frm.UID = s.UserUID frm.Order = sortby.ClientName frm.Provider = authn.ProviderApplication.String() diff --git a/internal/api/users_update.go b/internal/api/users_update.go index 376bdec73..59c241329 100644 --- a/internal/api/users_update.go +++ b/internal/api/users_update.go @@ -14,6 +14,7 @@ import ( "github.com/photoprism/photoprism/pkg/authn" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/i18n" + "github.com/photoprism/photoprism/pkg/log/status" ) // UpdateUser updates profile information for the specified user. @@ -37,16 +38,31 @@ func UpdateUser(router *gin.RouterGroup) { return } - // Check if the session user is allowed to manage all accounts or update his/her own account. + // Require user management or own-account update access. s := AuthAny(c, acl.ResourceUsers, acl.Permissions{acl.ActionManage, acl.AccessOwn, acl.ActionUpdate, acl.ActionUpdateOwn}) if s.Abort(c) { return } - // UserUID. + // A verified Portal cluster JWT (GrantJwtBearer) with users-manage scope is + // a trusted service principal — the Portal syncing cluster user state — with + // no end-user identity, so authorize it for user management like an admin + // instead of applying the per-user owner check below (which a user-less + // service token can never satisfy). + isClusterJWT := s.GrantType == authn.GrantJwtBearer.String() && s.ValidateScope(acl.ResourceUsers, acl.Permissions{acl.ActionManage}) + + // Check whether the role can manage all user accounts. + isAdmin := isClusterJWT || acl.Rules.AllowAll(acl.ResourceUsers, s.GetUserRole(), acl.Permissions{acl.AccessAll, acl.ActionManage}) uid := clean.UID(c.Param("uid")) + // Non-admin users may only update their own profile. + if !isAdmin && s.GetUser().UserUID != uid { + event.AuditErr([]string{ClientIP(c), "session %s", "users", clean.Log(uid), "update", status.Denied}, s.RefID) + AbortForbidden(c) + return + } + // Find user. m := entity.FindUserByUID(uid) @@ -55,7 +71,14 @@ func UpdateUser(router *gin.RouterGroup) { return } - // Init form with model values. + // System accounts (Unknown id=-1, Visitor id=-2) must not be modified. + if m.ID < 0 { + event.AuditErr([]string{ClientIP(c), "session %s", "users", clean.Log(uid), "update", status.Denied}, s.RefID) + AbortForbidden(c) + return + } + + // Initialize form with model values. f, err := m.Form() if err != nil { @@ -65,13 +88,18 @@ func UpdateUser(router *gin.RouterGroup) { } // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxMutationRequestBytes) + if err = c.BindJSON(&f); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } - // Check if the session user has user management privileges. - isAdmin := acl.Rules.AllowAll(acl.ResourceUsers, s.GetUserRole(), acl.Permissions{acl.AccessAll, acl.ActionManage}) privilegeLevelChange := isAdmin && m.PrivilegeLevelChange(f) // Check if the user account quota has been exceeded. @@ -84,8 +112,51 @@ func UpdateUser(router *gin.RouterGroup) { // Get user from session. u := s.GetUser() - // Save model with values from form. - if err = m.SaveForm(f, u); err != nil { + // Prevent users from changing their own account role, disabling their + // own super admin status, or revoking their own web login — any of + // which could lock an operator out of the admin UI (e.g. a super admin + // demoting themselves). Other own-profile fields remain editable. + if u != nil && u.UserUID == m.UserUID { + switch { + case f.UserRole != "" && clean.Role(f.UserRole) != clean.Role(m.UserRole): + event.AuditErr([]string{ClientIP(c), "session %s", "users", m.UserName, "update own role", status.Denied}, s.RefID) + AbortForbidden(c) + return + case m.SuperAdmin && !f.SuperAdmin: + event.AuditErr([]string{ClientIP(c), "session %s", "users", m.UserName, "disable own super admin status", status.Denied}, s.RefID) + AbortForbidden(c) + return + case m.CanLogin && !f.CanLogin: + event.AuditErr([]string{ClientIP(c), "session %s", "users", m.UserName, "disable own web login", status.Denied}, s.RefID) + AbortForbidden(c) + return + } + } + + // Prevent a non-super-admin from demoting a super admin, revoking their super + // admin status, or disabling their web login, so a lower-privilege admin cannot + // lock the local operator out. The cluster JWT service principal is exempt. + if m.SuperAdmin && !isClusterJWT && !u.IsSuperAdmin() { + switch { + case f.UserRole != "" && clean.Role(f.UserRole) != clean.Role(m.UserRole): + event.AuditErr([]string{ClientIP(c), "session %s", "users", m.UserName, "demote super admin role", status.Denied}, s.RefID) + AbortForbidden(c) + return + case !f.SuperAdmin: + event.AuditErr([]string{ClientIP(c), "session %s", "users", m.UserName, "disable super admin status", status.Denied}, s.RefID) + AbortForbidden(c) + return + case m.CanLogin && !f.CanLogin: + event.AuditErr([]string{ClientIP(c), "session %s", "users", m.UserName, "disable super admin web login", status.Denied}, s.RefID) + AbortForbidden(c) + return + } + } + + // Persist form values. The cluster JWT is a user-less principal that + // u.IsAdmin()/u.IsSuperAdmin() reject, so authorize it explicitly for both admin and + // super-admin-level changes (else its role, login, and 2FA edits are silently dropped). + if err = m.SaveForm(f, u, u.IsAdmin() || isClusterJWT, isClusterJWT); err != nil { event.AuditErr([]string{ClientIP(c), "session %s", "users", m.UserName, "update", err.Error()}, s.RefID) AbortSaveFailed(c) return @@ -94,14 +165,12 @@ func UpdateUser(router *gin.RouterGroup) { // Log event. event.AuditInfo([]string{ClientIP(c), "session %s", "users", m.UserName, "updated"}, s.RefID) - // Delete user sessions after a privilege level change. - // see https://cheatsheetseries.owasp.org/cheatsheets/Session_Management_Cheat_Sheet.html#renew-the-session-id-after-any-privilege-level-change + // Revoke other user sessions after a privilege level change, + // except for app passwords and client access tokens. if privilegeLevelChange { - // Prevent the current session from being deleted. - deleted := m.DeleteSessions([]string{s.ID}) - // Delete active user sessions. - event.AuditInfo([]string{ClientIP(c), "session %s", "users", m.UserName, "invalidated %s"}, s.RefID, - english.Plural(deleted, "session", "sessions")) + revoked := m.RevokeDerivedSessions([]string{s.ID}) + event.AuditInfo([]string{ClientIP(c), "session %s", "users", m.UserName, "revoked %s"}, s.RefID, + english.Plural(revoked, "session", "sessions")) } // Flush session cache. diff --git a/internal/api/users_update_test.go b/internal/api/users_update_test.go index f5558dc25..bdb6af129 100644 --- a/internal/api/users_update_test.go +++ b/internal/api/users_update_test.go @@ -4,25 +4,30 @@ import ( "encoding/json" "fmt" "net/http" + "strings" "testing" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/form" + "github.com/photoprism/photoprism/internal/photoprism/get" ) func TestUpdateUser(t *testing.T) { t.Run("InvalidRequestBody", func(t *testing.T) { + // Body validation runs after the ownership check, so target the + // session user's own UID to exercise the BindJSON failure path. app, router, conf := NewApiTest() conf.SetAuthMode(config.AuthModePasswd) defer conf.SetAuthMode(config.AuthModePublic) UpdateUser(router) sessId := AuthenticateUser(app, router, "alice", "Alice123!") - adminUid := entity.Admin.UserUID - reqUrl := fmt.Sprintf("/api/v1/users/%s", adminUid) - t.Logf("Request URL: %s", reqUrl) + aliceUid := "uqxetse3cy5eo9z2" + reqUrl := fmt.Sprintf("/api/v1/users/%s", aliceUid) r := AuthenticatedRequestWithBody(app, "PUT", reqUrl, "{Email:\"admin@example.com\",Details:{Location:\"WebStorm\"}}", sessId) assert.Equal(t, http.StatusBadRequest, r.Code) }) @@ -76,6 +81,8 @@ func TestUpdateUser(t *testing.T) { } }) t.Run("AliceChangeBob", func(t *testing.T) { + // Community Edition grants admins own-account user management only; + // full-access editions permit cross-account admin profile updates. app, router, conf := NewApiTest() conf.SetAuthMode(config.AuthModePasswd) defer conf.SetAuthMode(config.AuthModePublic) @@ -93,11 +100,56 @@ func TestUpdateUser(t *testing.T) { } else { r := AuthenticatedRequestWithBody(app, "PUT", "/api/v1/users/uqxc08w3d0ej2283", string(userForm), sessId) - assert.Equal(t, http.StatusOK, r.Code) - assert.Contains(t, r.Body.String(), "\"DisplayName\":\"Bobby\"") - assert.Contains(t, r.Body.String(), "\"UploadPath\":\"uploads-bob\"") + assert.Equal(t, http.StatusForbidden, r.Code) } }) + t.Run("GuestCannotEditOtherUser", func(t *testing.T) { + // Guest sessions may update their own profile, but not another account. + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + UpdateUser(router) + + guestUsername := "guest_update_idor_test" + if err := entity.AddUser(form.User{ + UserName: guestUsername, + UserRole: acl.RoleGuest.String(), + Password: "GuestPass123!", + CanLogin: true, + }); err != nil { + t.Fatal(err) + } + t.Cleanup(func() { + if u := entity.FindUserByName(guestUsername); u != nil { + _ = u.Delete() + } + }) + + sessId := AuthenticateUser(app, router, guestUsername, "GuestPass123!") + if sessId == "" { + t.Fatal("guest authentication failed") + } + + adminUid := entity.Admin.UserUID + body, err := json.Marshal(form.User{ + UserEmail: "attacker@example.test", + DisplayName: "PWNED", + }) + if err != nil { + t.Fatal(err) + } + + r := AuthenticatedRequestWithBody(app, "PUT", fmt.Sprintf("/api/v1/users/%s", adminUid), string(body), sessId) + assert.Equal(t, http.StatusForbidden, r.Code) + + // Confirm the admin record was not mutated. + fresh := entity.FindUserByUID(adminUid) + if fresh == nil { + t.Fatal("admin user not found after guest request") + } + assert.NotEqual(t, "attacker@example.test", fresh.UserEmail) + assert.NotEqual(t, "PWNED", fresh.DisplayName) + }) t.Run("BobChangeOwn", func(t *testing.T) { app, router, conf := NewApiTest() conf.SetAuthMode(config.AuthModePasswd) @@ -119,6 +171,8 @@ func TestUpdateUser(t *testing.T) { } }) t.Run("UserNotFound", func(t *testing.T) { + // Ownership is checked before lookup, so non-admin requests for + // unknown foreign UIDs return 403 without leaking account existence. app, router, conf := NewApiTest() conf.SetAuthMode(config.AuthModePasswd) defer conf.SetAuthMode(config.AuthModePublic) @@ -134,7 +188,170 @@ func TestUpdateUser(t *testing.T) { } else { r := AuthenticatedRequestWithBody(app, "PUT", "/api/v1/users/uqxc08w3d0ej2555", string(userForm), sessId) - assert.Equal(t, http.StatusNotFound, r.Code) + assert.Equal(t, http.StatusForbidden, r.Code) } }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + UpdateUser(router) + + sessId := AuthenticateUser(app, router, "alice", "Alice123!") + body := `{"DisplayName":"` + strings.Repeat("a", int(MaxMutationRequestBytes)) + `"}` + r := AuthenticatedRequestWithBody(app, "PUT", "/api/v1/users/uqxetse3cy5eo9z2", body, sessId) + + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) + }) +} + +func TestUpdateUser_Guards(t *testing.T) { + t.Run("SelfRoleChangeForbidden", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + UpdateUser(router) + sessId := AuthenticateUser(app, router, "alice", "Alice123!") + body, _ := json.Marshal(form.User{UserName: "alice", UserRole: "user"}) + r := AuthenticatedRequestWithBody(app, "PUT", "/api/v1/users/uqxetse3cy5eo9z2", string(body), sessId) + assert.Equal(t, http.StatusForbidden, r.Code) + }) + t.Run("SelfSuperAdminDisableForbidden", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + UpdateUser(router) + sessId := AuthenticateAdmin(app, router) + // Raw JSON so the explicit false survives marshaling (the form tags + // use omitempty, mirroring what the web UI sends). + body := `{"UserName":"admin","SuperAdmin":false}` + r := AuthenticatedRequestWithBody(app, "PUT", "/api/v1/users/"+entity.Admin.UserUID, body, sessId) + assert.Equal(t, http.StatusForbidden, r.Code) + assert.True(t, entity.FindUserByUID(entity.Admin.UserUID).SuperAdmin, "own super admin status must remain enabled") + }) + t.Run("SelfWebLoginDisableForbidden", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + UpdateUser(router) + sessId := AuthenticateAdmin(app, router) + body := `{"UserName":"admin","CanLogin":false}` + r := AuthenticatedRequestWithBody(app, "PUT", "/api/v1/users/"+entity.Admin.UserUID, body, sessId) + assert.Equal(t, http.StatusForbidden, r.Code) + assert.True(t, entity.FindUserByUID(entity.Admin.UserUID).CanLogin, "own web login must remain enabled") + }) + t.Run("SelfProfileEditStillAllowed", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + UpdateUser(router) + sessId := AuthenticateAdmin(app, router) + admin := entity.FindUserByUID(entity.Admin.UserUID) + body := `{"UserName":"admin","SuperAdmin":true,"CanLogin":true,"DisplayName":"` + admin.DisplayName + `"}` + r := AuthenticatedRequestWithBody(app, "PUT", "/api/v1/users/"+entity.Admin.UserUID, body, sessId) + assert.Equal(t, http.StatusOK, r.Code, "unchanged privilege flags must not block own-profile edits; body=%s", r.Body.String()) + }) + t.Run("SystemAccountForbidden", func(t *testing.T) { + app, router, conf := NewApiTest() + conf.SetAuthMode(config.AuthModePasswd) + defer conf.SetAuthMode(config.AuthModePublic) + UpdateUser(router) + sessId := AuthenticateUser(app, router, "alice", "Alice123!") + body, _ := json.Marshal(form.User{DisplayName: "Hacked"}) + r := AuthenticatedRequestWithBody(app, "PUT", "/api/v1/users/"+entity.UnknownUser.UserUID, string(body), sessId) + assert.Equal(t, http.StatusForbidden, r.Code) + }) + // The super-admin-protection guard only takes effect in full-access editions where + // admins manage all accounts; CE grants own-account management only, so it is + // unreachable here and covered by the edition suites with cross-account management. +} + +func TestUpdateUser_ClusterJWT(t *testing.T) { + // A Portal cluster JWT (GrantJwtBearer + users-manage scope) is a user-less + // service principal that UpdateUser authorizes like an admin so the Portal can + // sync instance user state: it bypasses the per-user owner check and applies + // the privilege-level fields (login, WebDAV, role) the form carries. + t.Run("ManagesAnotherUser", func(t *testing.T) { + fx := newPortalJWTFixture(t, "users-update-manage") + fx.nodeConf.Options().JWTScope = "cluster users" + get.SetConfig(fx.nodeConf) + + username := "cluster-sync-target" + require.NoError(t, entity.AddUser(form.User{ + UserName: username, + UserRole: acl.RoleGuest.String(), + Password: "ClusterSync123!", + CanLogin: false, + WebDAV: false, + })) + target := entity.FindUserByName(username) + require.NotNil(t, target) + require.False(t, target.CanLogin, "precondition: target login is disabled") + require.False(t, target.WebDAV, "precondition: target WebDAV is disabled") + t.Cleanup(func() { + if u := entity.FindUserByName(username); u != nil { + _ = u.Delete() + } + }) + + app, router, _ := NewApiTest() + UpdateUser(router) + + spec := fx.defaultClaimsSpec() + spec.Scope = []string{"cluster", "users"} + token := fx.issue(t, spec) + + body, err := json.Marshal(form.User{ + UserName: username, + DisplayName: "Synced By Portal", + CanLogin: true, + WebDAV: true, + }) + require.NoError(t, err) + + r := AuthenticatedRequestWithBody(app, "PUT", "/api/v1/users/"+target.UserUID, string(body), token) + assert.Equal(t, http.StatusOK, r.Code) + + updated := entity.FindUserByUID(target.UserUID) + require.NotNil(t, updated) + assert.True(t, updated.CanLogin, "cluster JWT must apply the privilege-level CanLogin change") + assert.True(t, updated.WebDAV, "cluster JWT must apply the privilege-level WebDAV change") + assert.Equal(t, "Synced By Portal", updated.DisplayName) + assert.Equal(t, acl.RoleGuest.String(), updated.UserRole, "role stays unchanged when the form omits it") + }) + t.Run("WithoutUsersScopeDenied", func(t *testing.T) { + fx := newPortalJWTFixture(t, "users-update-deny") + fx.nodeConf.Options().JWTScope = "cluster users" + get.SetConfig(fx.nodeConf) + + username := "cluster-sync-denied" + require.NoError(t, entity.AddUser(form.User{ + UserName: username, + UserRole: acl.RoleGuest.String(), + Password: "ClusterSync123!", + CanLogin: false, + })) + target := entity.FindUserByName(username) + require.NotNil(t, target) + t.Cleanup(func() { + if u := entity.FindUserByName(username); u != nil { + _ = u.Delete() + } + }) + + app, router, _ := NewApiTest() + UpdateUser(router) + + spec := fx.defaultClaimsSpec() + spec.Scope = []string{"cluster"} // no users scope → not authorized to manage users + token := fx.issue(t, spec) + + body, _ := json.Marshal(form.User{UserName: username, CanLogin: true}) + r := AuthenticatedRequestWithBody(app, "PUT", "/api/v1/users/"+target.UserUID, string(body), token) + assert.NotEqual(t, http.StatusOK, r.Code, "a JWT without the users scope must not manage users") + + unchanged := entity.FindUserByUID(target.UserUID) + require.NotNil(t, unchanged) + assert.False(t, unchanged.CanLogin, "a denied request must not enable login") + }) } diff --git a/internal/api/users_upload.go b/internal/api/users_upload.go index 7618df6bd..780233743 100644 --- a/internal/api/users_upload.go +++ b/internal/api/users_upload.go @@ -22,6 +22,7 @@ import ( "github.com/photoprism/photoprism/internal/photoprism/get" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/fs/disk" "github.com/photoprism/photoprism/pkg/i18n" "github.com/photoprism/photoprism/pkg/log/status" "github.com/photoprism/photoprism/pkg/media" @@ -68,7 +69,7 @@ func UploadUserFiles(router *gin.RouterGroup) { } // Abort if there is not enough free storage to upload new files. - if conf.FilesQuotaReached() { + if conf.InsufficientStorage() { event.AuditErr([]string{ClientIP(c), "session %s", "upload files", status.InsufficientStorage}, s.RefID) Abort(c, http.StatusInsufficientStorage, i18n.ErrInsufficientStorage) return @@ -77,9 +78,19 @@ func UploadUserFiles(router *gin.RouterGroup) { start := time.Now() token := clean.Token(c.Param("token")) + if totalSizeLimit := conf.UploadLimitBytes(); totalSizeLimit > 0 { + LimitRequestBodyBytes(c, totalSizeLimit+MaxMultipartOverheadBytes) + } + f, err := c.MultipartForm() if err != nil { + if IsRequestBodyTooLarge(err) { + log.Errorf("upload: %s", err) + AbortRequestTooLarge(c, i18n.ErrFileTooLarge) + return + } + log.Errorf("upload: %s", err) Abort(c, http.StatusBadRequest, i18n.ErrUploadFailed) return @@ -132,6 +143,15 @@ func UploadUserFiles(router *gin.RouterGroup) { // Save uploaded file in the user upload path. if err = c.SaveUploadedFile(file, destName); err != nil { log.Debugf("upload: %s in %s", clean.Error(err), clean.Log(baseName)) + + // Report a disk-full write failure as insufficient storage so the cause is clear. + if disk.IsNoSpace(err) { + disk.FlushFree() + event.AuditErr([]string{ClientIP(c), "session %s", "upload files", status.InsufficientStorage}, s.RefID) + Abort(c, http.StatusInsufficientStorage, i18n.ErrInsufficientStorage) + return + } + log.Errorf("upload: failed to save %s", clean.Log(baseName)) Abort(c, http.StatusBadRequest, i18n.ErrUploadFailed) return @@ -239,7 +259,7 @@ func UploadUserFiles(router *gin.RouterGroup) { log.Info(msg) - c.JSON(http.StatusOK, i18n.Response{Code: http.StatusOK, Msg: msg}) + c.JSON(http.StatusOK, i18n.Response{Code: http.StatusOK, Message: msg}) }) } @@ -305,7 +325,14 @@ func ProcessUserUpload(router *gin.RouterGroup) { var frm form.UploadOptions // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxUploadOptionsRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -381,7 +408,7 @@ func ProcessUserUpload(router *gin.RouterGroup) { for _, album := range opt.Albums { if a := entity.FindAlbum(entity.AlbumSearch(album, album, entity.AlbumManual)); a != nil { SaveAlbumYaml(a) - PublishAlbumEvent(StatusUpdated, a.AlbumUID, c) + PublishAlbumEvent(StatusUpdated, a.AlbumUID) } } @@ -393,6 +420,6 @@ func ProcessUserUpload(router *gin.RouterGroup) { log.Warnf("upload: %s (update covers)", coversErr) } - c.JSON(http.StatusOK, i18n.Response{Code: http.StatusOK, Msg: msg}) + c.JSON(http.StatusOK, i18n.Response{Code: http.StatusOK, Message: msg}) }) } diff --git a/internal/api/users_upload_multipart_test.go b/internal/api/users_upload_multipart_test.go index b6b03900c..6f4d985cf 100644 --- a/internal/api/users_upload_multipart_test.go +++ b/internal/api/users_upload_multipart_test.go @@ -321,6 +321,33 @@ func TestUploadUserFiles_Multipart_TotalLimitExceeded(t *testing.T) { assert.LessOrEqual(t, len(files), 1) } +func TestUploadUserFiles_Multipart_RequestTooLarge(t *testing.T) { + app, router, conf := NewApiTest() + conf.Options().UploadAllow = "jpg" + conf.Options().UploadLimit = 1 + UploadUserFiles(router) + token := AuthenticateAdmin(app, router) + + adminUid := entity.Admin.UserUID + defer removeUploadDirsForToken(t, filepath.Join(conf.UserStoragePath(adminUid), "upload"), "toolarge") + + tooLarge := bytes.Repeat([]byte("A"), 3*1024*1024) + body, ctype, err := buildMultipart(map[string][]byte{"big.jpg": tooLarge}) + if err != nil { + t.Fatal(err) + } + + req := httptest.NewRequest(http.MethodPost, "/api/v1/users/"+adminUid+"/upload/toolarge", body) + req.Header.Set("Content-Type", ctype) + header.SetAuthorization(req, token) + w := httptest.NewRecorder() + app.ServeHTTP(w, req) + + assert.Equal(t, http.StatusRequestEntityTooLarge, w.Code) + files := findUploadedFilesForToken(t, filepath.Join(conf.UserStoragePath(adminUid), "upload"), "toolarge") + assert.Empty(t, files) +} + func TestUploadUserFiles_Multipart_ZipPartialExtraction(t *testing.T) { app, router, conf := NewApiTest() conf.Options().UploadArchives = true diff --git a/internal/api/users_upload_test.go b/internal/api/users_upload_test.go index e13ed94a0..900b72a79 100644 --- a/internal/api/users_upload_test.go +++ b/internal/api/users_upload_test.go @@ -3,13 +3,16 @@ package api import ( "fmt" "net/http" + "net/http/httptest" "os" "path/filepath" + "strings" "testing" "github.com/stretchr/testify/assert" "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/pkg/http/header" ) func TestUploadUserFiles(t *testing.T) { @@ -44,6 +47,23 @@ func TestUploadUserFiles(t *testing.T) { assert.Equal(t, http.StatusInsufficientStorage, r.Code) config.Options().FilesQuota = 0 }) + t.Run("ProcessRequestTooLarge", func(t *testing.T) { + app, router, _ := NewApiTest() + adminUid := entity.Admin.UserUID + reqUrl := fmt.Sprintf("/api/v1/users/%s/upload/abc123456789", adminUid) + ProcessUserUpload(router) + token := AuthenticateAdmin(app, router) + + body := `{"albums":["` + strings.Repeat("a", 300*1024) + `"]}` + req := httptest.NewRequest(http.MethodPut, reqUrl, strings.NewReader(body)) + req.Header.Set("Content-Type", "application/json") + header.SetAuthorization(req, token) + + w := httptest.NewRecorder() + app.ServeHTTP(w, req) + + assert.Equal(t, http.StatusRequestEntityTooLarge, w.Code) + }) } func TestUploadCheckFile_AcceptsAndReducesLimit(t *testing.T) { diff --git a/internal/api/video.go b/internal/api/video.go index 187726e74..e8ec5335a 100644 --- a/internal/api/video.go +++ b/internal/api/video.go @@ -1,6 +1,7 @@ package api import ( + "errors" "net/http" "path/filepath" "strings" @@ -14,6 +15,8 @@ import ( "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" "github.com/photoprism/photoprism/pkg/http/header" + "github.com/photoprism/photoprism/pkg/i18n" + "github.com/photoprism/photoprism/pkg/log/status" "github.com/photoprism/photoprism/pkg/media/video" "github.com/photoprism/photoprism/pkg/rnd" ) @@ -21,13 +24,13 @@ import ( // GetVideo returns a video, optionally limited to a byte range for streaming. // // @Summary returns a video, optionally limited to a byte range for streaming -// @Description Fore more information see: +// @Description For more information see: // @Description - https://docs.photoprism.app/developer-guide/api/thumbnails/#video-endpoint-uri // @Id GetVideo // @Produce video/mp4 // @Tags Files, Videos // @Failure 403 {object} i18n.Response -// @Param thumb path string true "SHA1 video file hash" +// @Param hash path string true "SHA1 video file hash" // @Param token path string true "user-specific security token provided with session" // @Param format path string true "video format, e.g. mp4" // @Router /api/v1/videos/{hash}/{token}/{format} [get] @@ -167,6 +170,10 @@ func GetVideo(router *gin.RouterGroup) { if avcFile, avcErr := conv.ToAvc(mediaFile, get.Config().FFmpegEncoder(), false, false); avcFile != nil && avcErr == nil { videoFileName = avcFile.FileName() AddContentTypeHeader(c, header.ContentTypeMp4AvcMain) + } else if errors.Is(avcErr, status.ErrInsufficientStorage) { + log.Warnf("video: insufficient storage to transcode %s", clean.Log(f.FileName)) + Abort(c, http.StatusInsufficientStorage, i18n.ErrInsufficientStorage) + return } else { // Log error and default to 404.mp4 log.Errorf("video: failed to transcode %s", clean.Log(f.FileName)) diff --git a/internal/api/vision_caption.go b/internal/api/vision_caption.go index c8ed0f7fd..d72e2ae12 100644 --- a/internal/api/vision_caption.go +++ b/internal/api/vision_caption.go @@ -40,7 +40,14 @@ func PostVisionCaption(router *gin.RouterGroup) { } // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxVisionRequestBytes) + if err := c.BindJSON(&request); err != nil { + if IsRequestBodyTooLarge(err) { + c.JSON(http.StatusRequestEntityTooLarge, vision.NewApiError(request.GetId(), http.StatusRequestEntityTooLarge)) + return + } + c.JSON(http.StatusBadRequest, vision.NewApiError(request.GetId(), http.StatusBadRequest)) return } diff --git a/internal/api/vision_caption_test.go b/internal/api/vision_caption_test.go new file mode 100644 index 000000000..c2b88faf5 --- /dev/null +++ b/internal/api/vision_caption_test.go @@ -0,0 +1,21 @@ +package api + +import ( + "net/http" + "strings" + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestPostVisionCaption(t *testing.T) { + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, _ := NewApiTest() + PostVisionCaption(router) + + body := `{"images":["data:image/jpeg;base64,` + strings.Repeat("a", int(MaxVisionRequestBytes)) + `"]}` + r := PerformRequestWithBody(app, http.MethodPost, "/api/v1/vision/caption", body) + + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) + }) +} diff --git a/internal/api/vision_face.go b/internal/api/vision_face.go index 398e67ca6..992f335a4 100644 --- a/internal/api/vision_face.go +++ b/internal/api/vision_face.go @@ -42,7 +42,14 @@ func PostVisionFace(router *gin.RouterGroup) { } // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxVisionRequestBytes) + if err := c.BindJSON(&request); err != nil { + if IsRequestBodyTooLarge(err) { + c.JSON(http.StatusRequestEntityTooLarge, vision.NewApiError(request.GetId(), http.StatusRequestEntityTooLarge)) + return + } + c.JSON(http.StatusBadRequest, vision.NewApiError(request.GetId(), http.StatusBadRequest)) return } diff --git a/internal/api/vision_face_test.go b/internal/api/vision_face_test.go index f6114718a..30915ff6a 100644 --- a/internal/api/vision_face_test.go +++ b/internal/api/vision_face_test.go @@ -4,6 +4,7 @@ import ( "encoding/json" "io" "net/http" + "strings" "testing" "github.com/stretchr/testify/assert" @@ -178,4 +179,13 @@ func TestPostVisionFace(t *testing.T) { r := PerformRequest(app, http.MethodPost, "/api/v1/vision/face") assert.Equal(t, http.StatusBadRequest, r.Code) }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, _ := NewApiTest() + PostVisionFace(router) + + body := `{"images":["data:image/jpeg;base64,` + strings.Repeat("a", int(MaxVisionRequestBytes)) + `"]}` + r := PerformRequestWithBody(app, http.MethodPost, "/api/v1/vision/face", body) + + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) + }) } diff --git a/internal/api/vision_labels.go b/internal/api/vision_labels.go index 0701016b0..a7ff8e731 100644 --- a/internal/api/vision_labels.go +++ b/internal/api/vision_labels.go @@ -42,7 +42,14 @@ func PostVisionLabels(router *gin.RouterGroup) { } // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxVisionRequestBytes) + if err := c.BindJSON(&request); err != nil { + if IsRequestBodyTooLarge(err) { + c.JSON(http.StatusRequestEntityTooLarge, vision.NewApiError(request.GetId(), http.StatusRequestEntityTooLarge)) + return + } + c.JSON(http.StatusBadRequest, vision.NewApiError(request.GetId(), http.StatusBadRequest)) return } diff --git a/internal/api/vision_labels_test.go b/internal/api/vision_labels_test.go index 5d403ce59..ee2392ab7 100644 --- a/internal/api/vision_labels_test.go +++ b/internal/api/vision_labels_test.go @@ -4,6 +4,7 @@ import ( "encoding/json" "io" "net/http" + "strings" "testing" "github.com/stretchr/testify/assert" @@ -129,4 +130,13 @@ func TestPostVisionLabels(t *testing.T) { r := PerformRequest(app, http.MethodPost, "/api/v1/vision/labels") assert.Equal(t, http.StatusBadRequest, r.Code) }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, _ := NewApiTest() + PostVisionLabels(router) + + body := `{"images":["data:image/jpeg;base64,` + strings.Repeat("a", int(MaxVisionRequestBytes)) + `"]}` + r := PerformRequestWithBody(app, http.MethodPost, "/api/v1/vision/labels", body) + + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) + }) } diff --git a/internal/api/vision_nsfw.go b/internal/api/vision_nsfw.go index 563ca6f4f..57ce1cd42 100644 --- a/internal/api/vision_nsfw.go +++ b/internal/api/vision_nsfw.go @@ -41,7 +41,14 @@ func PostVisionNsfw(router *gin.RouterGroup) { } // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxVisionRequestBytes) + if err := c.BindJSON(&request); err != nil { + if IsRequestBodyTooLarge(err) { + c.JSON(http.StatusRequestEntityTooLarge, vision.NewApiError(request.GetId(), http.StatusRequestEntityTooLarge)) + return + } + c.JSON(http.StatusBadRequest, vision.NewApiError(request.GetId(), http.StatusBadRequest)) return } diff --git a/internal/api/vision_nsfw_test.go b/internal/api/vision_nsfw_test.go index fd46a8118..9aeabe787 100644 --- a/internal/api/vision_nsfw_test.go +++ b/internal/api/vision_nsfw_test.go @@ -4,6 +4,7 @@ import ( "encoding/json" "io" "net/http" + "strings" "testing" "github.com/stretchr/testify/assert" @@ -144,4 +145,13 @@ func TestPostVisionNsfw(t *testing.T) { r := PerformRequest(app, http.MethodPost, "/api/v1/vision/nsfw") assert.Equal(t, http.StatusBadRequest, r.Code) }) + t.Run("RequestTooLarge", func(t *testing.T) { + app, router, _ := NewApiTest() + PostVisionNsfw(router) + + body := `{"images":["data:image/jpeg;base64,` + strings.Repeat("a", int(MaxVisionRequestBytes)) + `"]}` + r := PerformRequestWithBody(app, http.MethodPost, "/api/v1/vision/nsfw", body) + + assert.Equal(t, http.StatusRequestEntityTooLarge, r.Code) + }) } diff --git a/internal/api/zip.go b/internal/api/zip.go index 4c6e3685e..78122329a 100644 --- a/internal/api/zip.go +++ b/internal/api/zip.go @@ -50,7 +50,14 @@ func ZipCreate(router *gin.RouterGroup) { start := time.Now() // Assign and validate request form values. + LimitRequestBodyBytes(c, MaxSelectionRequestBytes) + if err := c.BindJSON(&frm); err != nil { + if IsRequestBodyTooLarge(err) { + AbortRequestTooLarge(c, i18n.ErrBadRequest) + return + } + AbortBadRequest(c, err) return } @@ -69,8 +76,9 @@ func ZipCreate(router *gin.RouterGroup) { selection = query.DownloadSelection(settings.MediaRaw, settings.MediaSidecar, settings.Originals) } - // Find files to download. - files, err := query.SelectedFiles(frm, selection) + // Find files to download within the session's shared scope, consistent with how photo + // search filters results. + files, err := query.SelectedFilesForSession(frm, selection, s) if err != nil { Error(c, http.StatusBadRequest, err, i18n.ErrZipFailed) @@ -80,6 +88,12 @@ func ZipCreate(router *gin.RouterGroup) { return } + // Refuse to assemble a new download zip if storage is over quota or critically low. + if conf.InsufficientStorage() { + Abort(c, http.StatusInsufficientStorage, i18n.ErrInsufficientStorage) + return + } + // Configure file names. dlName := DownloadName(c) // Build filesystem paths using filepath for OS compatibility. diff --git a/internal/auth/acl/acl.go b/internal/auth/acl/acl.go index f01a8de2d..3ba8931b7 100644 --- a/internal/auth/acl/acl.go +++ b/internal/auth/acl/acl.go @@ -1,7 +1,7 @@ /* Package acl provides access control lists for authorization checks. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/auth/acl/acl_test.go b/internal/auth/acl/acl_test.go index 33d5bb5a5..a2f833eaf 100644 --- a/internal/auth/acl/acl_test.go +++ b/internal/auth/acl/acl_test.go @@ -130,6 +130,55 @@ func TestACL_DenyAll(t *testing.T) { }) } +func TestACL_ResourceMCP(t *testing.T) { + t.Run("AdminActionView", func(t *testing.T) { + assert.True(t, Rules.Allow(ResourceMCP, RoleAdmin, ActionView)) + }) + t.Run("AdminActionManage", func(t *testing.T) { + assert.True(t, Rules.Allow(ResourceMCP, RoleAdmin, ActionManage)) + }) + t.Run("AdminFullAccess", func(t *testing.T) { + assert.True(t, Rules.Allow(ResourceMCP, RoleAdmin, FullAccess)) + }) + t.Run("InstanceSearchAndView", func(t *testing.T) { + assert.True(t, Rules.Allow(ResourceMCP, RoleInstance, ActionView)) + assert.True(t, Rules.Allow(ResourceMCP, RoleInstance, ActionSearch)) + }) + t.Run("InstanceManageDenied", func(t *testing.T) { + assert.True(t, Rules.DenyAll(ResourceMCP, RoleInstance, Permissions{ActionManage, ActionUpdate, ActionDelete, FullAccess})) + }) + t.Run("ServiceSearchAndView", func(t *testing.T) { + assert.True(t, Rules.Allow(ResourceMCP, RoleService, ActionView)) + assert.True(t, Rules.Allow(ResourceMCP, RoleService, ActionSearch)) + }) + t.Run("ServiceManageDenied", func(t *testing.T) { + assert.True(t, Rules.DenyAll(ResourceMCP, RoleService, Permissions{ActionManage, ActionUpdate, ActionDelete, FullAccess})) + }) + t.Run("PortalSearchAndView", func(t *testing.T) { + assert.True(t, Rules.Allow(ResourceMCP, RolePortal, ActionView)) + assert.True(t, Rules.Allow(ResourceMCP, RolePortal, ActionSearch)) + }) + t.Run("PortalManageDenied", func(t *testing.T) { + assert.True(t, Rules.DenyAll(ResourceMCP, RolePortal, Permissions{ActionManage, ActionUpdate, ActionDelete, FullAccess})) + }) + t.Run("ClientSearchAndView", func(t *testing.T) { + assert.True(t, Rules.Allow(ResourceMCP, RoleClient, ActionView)) + assert.True(t, Rules.Allow(ResourceMCP, RoleClient, ActionSearch)) + }) + t.Run("ClientManageDenied", func(t *testing.T) { + assert.True(t, Rules.DenyAll(ResourceMCP, RoleClient, Permissions{ActionManage, ActionUpdate, ActionDelete, FullAccess})) + }) + t.Run("GuestDenied", func(t *testing.T) { + assert.True(t, Rules.DenyAll(ResourceMCP, RoleGuest, Permissions{ActionView, ActionSearch, ActionManage})) + }) + t.Run("VisitorDenied", func(t *testing.T) { + assert.True(t, Rules.DenyAll(ResourceMCP, RoleVisitor, Permissions{ActionView, ActionSearch, ActionManage})) + }) + t.Run("DefaultDenied", func(t *testing.T) { + assert.True(t, Rules.DenyAll(ResourceMCP, RoleDefault, Permissions{ActionView, ActionSearch, ActionManage})) + }) +} + func TestACL_Resources(t *testing.T) { t.Run("Rules", func(t *testing.T) { result := Rules.Resources() diff --git a/internal/auth/acl/const.go b/internal/auth/acl/const.go index e5207cec8..c60662344 100644 --- a/internal/auth/acl/const.go +++ b/internal/auth/acl/const.go @@ -8,17 +8,20 @@ const RoleAliasNone = "none" // Roles that can be granted Permissions to use a Resource. const ( - RoleDefault Role = "default" - RoleAdmin Role = "admin" - RoleUser Role = "user" - RoleViewer Role = "viewer" - RoleGuest Role = "guest" - RoleVisitor Role = "visitor" - RoleInstance Role = "instance" - RoleService Role = "service" - RolePortal Role = "portal" - RoleClient Role = "client" - RoleNone Role = "" + RoleDefault Role = "default" + RoleClusterAdmin Role = "cluster_admin" + RoleAdmin Role = "admin" + RoleManager Role = "manager" + RoleUser Role = "user" + RoleContributor Role = "contributor" + RoleViewer Role = "viewer" + RoleGuest Role = "guest" + RoleVisitor Role = "visitor" + RoleInstance Role = "instance" + RoleService Role = "service" + RolePortal Role = "portal" + RoleClient Role = "client" + RoleNone Role = "" ) // Permissions to use a Resource that can be granted to a Role. @@ -62,6 +65,8 @@ const ( ResourcePeople Resource = "people" ResourcePlaces Resource = "places" ResourceLabels Resource = "labels" + ResourceCameras Resource = "cameras" + ResourceLenses Resource = "lenses" ResourceConfig Resource = "config" ResourceSettings Resource = "settings" ResourcePasscode Resource = "passcode" @@ -77,6 +82,7 @@ const ( ResourceVision Resource = "vision" ResourceCluster Resource = "cluster" ResourceFeedback Resource = "feedback" + ResourceMCP Resource = "mcp" ResourceDefault Resource = "default" ) diff --git a/internal/auth/acl/resource_names.go b/internal/auth/acl/resource_names.go index b3ecdc8a0..cf0e0d17d 100644 --- a/internal/auth/acl/resource_names.go +++ b/internal/auth/acl/resource_names.go @@ -14,6 +14,8 @@ var ResourceNames = []Resource{ ResourcePeople, ResourcePlaces, ResourceLabels, + ResourceCameras, + ResourceLenses, ResourceConfig, ResourceSettings, ResourcePasscode, @@ -29,5 +31,6 @@ var ResourceNames = []Resource{ ResourceVision, ResourceCluster, ResourceFeedback, + ResourceMCP, ResourceDefault, } diff --git a/internal/auth/acl/roles.go b/internal/auth/acl/roles.go index 54bc86524..50899e15d 100644 --- a/internal/auth/acl/roles.go +++ b/internal/auth/acl/roles.go @@ -3,6 +3,8 @@ package acl import ( "sort" "strings" + + "github.com/photoprism/photoprism/pkg/txt" ) // RoleStrings represents user role names mapped to roles. @@ -29,29 +31,30 @@ var ClientRoles = RoleStrings{ RoleAliasNone: RoleNone, } -// Strings returns the roles as string slice. +// AdminRoles maps the roles that grant administrative privileges. The Portal-only +// cluster_admin counts as admin-tier wherever admin checks run (e.g. self-lockout +// protection), so a cluster_admin owner is never downgraded to the plain admin role. +var AdminRoles = RoleStrings{ + string(RoleAdmin): RoleAdmin, + string(RoleClusterAdmin): RoleClusterAdmin, +} + +// Strings returns the roles as string slice for display, e.g. CLI help. func (m RoleStrings) Strings() []string { result := make([]string, 0, len(m)) - includesNone := false for r := range m { - if r == "app" { + // Skip empty/none, the anonymous visitor role, and display aliases + // (app→instance, uploader→contributor). + if r == "" || r == RoleAliasNone || r == RoleVisitor.String() || r == "app" || r == "uploader" { continue } - if r == RoleAliasNone { - includesNone = true - } else if r != string(RoleNone) { - result = append(result, r) - } + result = append(result, r) } sort.Strings(result) - if includesNone { - result = append(result, RoleAliasNone) - } - return result } @@ -62,13 +65,17 @@ func (m RoleStrings) String() string { // CliUsageString returns the roles as string for use in CLI usage descriptions. func (m RoleStrings) CliUsageString() string { - s := m.Strings() + return txt.JoinOr(m.Strings()) +} - if l := len(s); l > 1 { - s[l-1] = "or " + s[l-1] +// RolesCliUsageString formats roles for CLI usage help, preserving the given order +// and placing "or" before the last entry (see txt.JoinOr). +func RolesCliUsageString(roles []Role) string { + s := make([]string, len(roles)) + for i, role := range roles { + s[i] = role.String() } - - return strings.Join(s, ", ") + return txt.JoinOr(s) } // Roles grants permissions to roles. diff --git a/internal/auth/acl/roles_cluster.go b/internal/auth/acl/roles_cluster.go new file mode 100644 index 000000000..838dc016b --- /dev/null +++ b/internal/auth/acl/roles_cluster.go @@ -0,0 +1,49 @@ +package acl + +import ( + "github.com/photoprism/photoprism/pkg/clean" +) + +// ClusterInstanceRoles lists, in descending privilege order, the roles a cluster +// group→role mapping or grant may assign as an instance login role. Shared by the +// Portal resolver, the CE node handlers, and CLI usage help; it excludes the +// Portal-only cluster_admin and the anonymous visitor role. +var ClusterInstanceRoles = []Role{ + RoleAdmin, + RoleManager, + RoleUser, + RoleContributor, + RoleViewer, + RoleGuest, +} + +// clusterInstanceRoles indexes ClusterInstanceRoles for O(1) membership checks. +var clusterInstanceRoles = func() map[Role]struct{} { + m := make(map[Role]struct{}, len(ClusterInstanceRoles)) + for _, role := range ClusterInstanceRoles { + m[role] = struct{}{} + } + return m +}() + +// IsClusterInstanceRole reports whether role may be assigned to a user on a cluster instance. +func IsClusterInstanceRole(role Role) bool { + _, ok := clusterInstanceRoles[role] + return ok +} + +// ClusterInstanceRole normalizes s and returns the matching cluster instance role, or false. +func ClusterInstanceRole(s string) (Role, bool) { + role := Role(clean.Role(s)) + if IsClusterInstanceRole(role) { + return role, true + } + return RoleNone, false +} + +// ClusterInstanceRolesCliUsageString returns ClusterInstanceRoles formatted for CLI usage help. +// It is the edition-independent source for the --oidc-group-role and --cluster-allow-group-roles +// flag help, so the listed roles always match what ClusterInstanceRole accepts. +func ClusterInstanceRolesCliUsageString() string { + return RolesCliUsageString(ClusterInstanceRoles) +} diff --git a/internal/auth/acl/roles_cluster_test.go b/internal/auth/acl/roles_cluster_test.go new file mode 100644 index 000000000..2783f7f82 --- /dev/null +++ b/internal/auth/acl/roles_cluster_test.go @@ -0,0 +1,40 @@ +package acl + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestClusterInstanceRole(t *testing.T) { + t.Run("Assignable", func(t *testing.T) { + for _, s := range []string{"admin", "manager", "user", "contributor", "viewer", "guest", " Admin ", "VIEWER"} { + role, ok := ClusterInstanceRole(s) + assert.True(t, ok, "role %q must be assignable", s) + assert.True(t, IsClusterInstanceRole(role)) + } + }) + t.Run("Rejected", func(t *testing.T) { + for _, s := range []string{"cluster_admin", "visitor", "instance", "service", "portal", "client", "none", "", "bogus"} { + role, ok := ClusterInstanceRole(s) + assert.False(t, ok, "role %q must be rejected", s) + assert.Equal(t, RoleNone, role) + } + }) +} + +func TestClusterInstanceRolesCliUsageString(t *testing.T) { + u := ClusterInstanceRolesCliUsageString() + + // Privilege order, comma-separated, with "or" before the last role. + assert.Equal(t, "admin, manager, user, contributor, viewer, or guest", u) + + // The derived membership set and the slice source of truth must agree, and + // every listed role must be accepted by ClusterInstanceRole. + for _, role := range ClusterInstanceRoles { + assert.True(t, IsClusterInstanceRole(role), "%s missing from membership set", role) + assert.Contains(t, u, role.String()) + } + assert.NotContains(t, u, "cluster_admin") + assert.NotContains(t, u, "visitor") +} diff --git a/internal/auth/acl/roles_helpers.go b/internal/auth/acl/roles_helpers.go new file mode 100644 index 000000000..72be38bbf --- /dev/null +++ b/internal/auth/acl/roles_helpers.go @@ -0,0 +1,30 @@ +package acl + +// IsAdminRole reports whether role is an administrative role (admin or cluster_admin). +func IsAdminRole(role Role) bool { + _, ok := AdminRoles[string(role)] + return ok +} + +// IsFederatedRole reports whether role may be assigned through an external identity +// provider (OIDC/LDAP). cluster_admin, visitor, and the empty role are never federatable, +// so a compromised IdP can neither escalate to operator access nor clear a role. +func IsFederatedRole(role Role) bool { + switch role { + case RoleNone, RoleClusterAdmin, RoleVisitor: + return false + default: + return true + } +} + +// FederatedRoleUpdate reports the account role an external identity provider may apply to an +// existing user, and whether to apply it. Returns ok=false when the current or mapped role is +// non-federatable or unchanged, so a directory sync can neither escalate nor clear such a role. +func FederatedRoleUpdate(current, mapped Role) (Role, bool) { + if !IsFederatedRole(current) || !IsFederatedRole(mapped) || current == mapped { + return RoleNone, false + } + + return mapped, true +} diff --git a/internal/auth/acl/roles_helpers_test.go b/internal/auth/acl/roles_helpers_test.go new file mode 100644 index 000000000..d4469d50e --- /dev/null +++ b/internal/auth/acl/roles_helpers_test.go @@ -0,0 +1,65 @@ +package acl + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestIsAdminRole(t *testing.T) { + assert.True(t, IsAdminRole(RoleAdmin)) + assert.True(t, IsAdminRole(RoleClusterAdmin)) + assert.False(t, IsAdminRole(RoleUser)) + assert.False(t, IsAdminRole(RoleViewer)) + assert.False(t, IsAdminRole(RoleGuest)) + assert.False(t, IsAdminRole(RoleVisitor)) + assert.False(t, IsAdminRole(RoleNone)) + assert.False(t, IsAdminRole(RoleManager)) +} + +func TestIsFederatedRole(t *testing.T) { + t.Run("Federatable", func(t *testing.T) { + assert.True(t, IsFederatedRole(RoleAdmin)) + assert.True(t, IsFederatedRole(RoleUser)) + assert.True(t, IsFederatedRole(RoleViewer)) + assert.True(t, IsFederatedRole(RoleGuest)) + assert.True(t, IsFederatedRole(RoleManager)) + assert.True(t, IsFederatedRole(RoleContributor)) + }) + t.Run("NotFederatable", func(t *testing.T) { + // cluster_admin is the Portal operator role and visitor is anonymous; + // neither may be granted or revoked via an external IdP/AD, and an empty + // role must never be applied by a sync. + assert.False(t, IsFederatedRole(RoleClusterAdmin)) + assert.False(t, IsFederatedRole(RoleVisitor)) + assert.False(t, IsFederatedRole(RoleNone)) + }) +} + +func TestFederatedRoleUpdate(t *testing.T) { + t.Run("AppliesChangedFederatableRole", func(t *testing.T) { + role, ok := FederatedRoleUpdate(RoleUser, RoleViewer) + assert.True(t, ok) + assert.Equal(t, RoleViewer, role) + }) + t.Run("UnchangedRoleNotApplied", func(t *testing.T) { + _, ok := FederatedRoleUpdate(RoleUser, RoleUser) + assert.False(t, ok) + }) + t.Run("NeverDowngradesClusterAdmin", func(t *testing.T) { + // An existing cluster_admin/visitor account must not be touched. + _, ok := FederatedRoleUpdate(RoleClusterAdmin, RoleAdmin) + assert.False(t, ok) + _, ok = FederatedRoleUpdate(RoleVisitor, RoleGuest) + assert.False(t, ok) + }) + t.Run("NeverEscalatesToNonFederatable", func(t *testing.T) { + // The directory must not promote to cluster_admin/visitor. + _, ok := FederatedRoleUpdate(RoleUser, RoleClusterAdmin) + assert.False(t, ok) + _, ok = FederatedRoleUpdate(RoleAdmin, RoleVisitor) + assert.False(t, ok) + _, ok = FederatedRoleUpdate(RoleUser, RoleNone) + assert.False(t, ok) + }) +} diff --git a/internal/auth/acl/roles_test.go b/internal/auth/acl/roles_test.go index 2d10409d6..adff7114f 100644 --- a/internal/auth/acl/roles_test.go +++ b/internal/auth/acl/roles_test.go @@ -18,8 +18,10 @@ func TestRoleStrings_Strings_SortedAndNoEmpty(t *testing.T) { got := m.Strings() - // Expect deterministic, sorted output and no empty entries. - assert.Equal(t, []string{"admin", "guest", "visitor"}, got) + // Expect deterministic, sorted output, no empty entries, and visitor + // excluded (reserved for anonymous/link-share access, never offered). + assert.Equal(t, []string{"admin", "guest"}, got) + assert.NotContains(t, got, "visitor") assert.True(t, sort.StringsAreSorted(got)) } @@ -43,13 +45,43 @@ func TestRoleStrings_CliUsageString(t *testing.T) { }) t.Run("Two", func(t *testing.T) { m := RoleStrings{"guest": RoleGuest, "admin": RoleAdmin} - // Note the comma before "or" matches current implementation. - assert.Equal(t, "admin, or guest", m.CliUsageString()) + // Two items read without a comma before "or" (see txt.JoinOr). + assert.Equal(t, "admin or guest", m.CliUsageString()) }) t.Run("Three", func(t *testing.T) { - m := RoleStrings{"visitor": RoleVisitor, "guest": RoleGuest, "admin": RoleAdmin} - assert.Equal(t, "admin, guest, or visitor", m.CliUsageString()) + m := RoleStrings{"user": RoleUser, "guest": RoleGuest, "admin": RoleAdmin} + assert.Equal(t, "admin, guest, or user", m.CliUsageString()) }) + t.Run("ExcludesVisitor", func(t *testing.T) { + m := RoleStrings{"visitor": RoleVisitor, "guest": RoleGuest, "admin": RoleAdmin} + assert.Equal(t, "admin or guest", m.CliUsageString()) + }) +} + +func TestRolesCliUsageString(t *testing.T) { + assert.Equal(t, "", RolesCliUsageString(nil)) + assert.Equal(t, "admin", RolesCliUsageString([]Role{RoleAdmin})) + assert.Equal(t, "admin or guest", RolesCliUsageString([]Role{RoleAdmin, RoleGuest})) + assert.Equal(t, "admin, manager, or guest", RolesCliUsageString([]Role{RoleAdmin, RoleManager, RoleGuest})) +} + +func TestRoleStrings_Strings_ExcludesAliases(t *testing.T) { + // The app→instance and uploader→contributor aliases and the visitor/empty roles + // are display-only and must not appear in role listings, even though the map + // still validates them. + m := RoleStrings{ + string(RoleAdmin): RoleAdmin, + string(RoleContributor): RoleContributor, + "uploader": RoleContributor, + "app": RoleInstance, + string(RoleVisitor): RoleVisitor, + "": RoleNone, + } + got := m.Strings() + assert.ElementsMatch(t, []string{"admin", "contributor"}, got) + assert.NotContains(t, got, "uploader") + assert.NotContains(t, got, "app") + assert.NotContains(t, got, "visitor") } func TestRoles_Allow(t *testing.T) { @@ -84,36 +116,43 @@ func TestRoles_Allow(t *testing.T) { } func TestRoleStrings_GlobalMaps_AliasNoneAndUsage(t *testing.T) { - t.Run("ClientRolesStringsIncludeAliasNoneExcludeEmpty", func(t *testing.T) { + t.Run("ClientRolesStringsExcludeAliasNoneAndEmpty", func(t *testing.T) { got := ClientRoles.Strings() - // Contains exactly the expected elements, order not enforced. - assert.ElementsMatch(t, []string{"admin", "instance", "client", "none", "portal", "service"}, got) - // Does not include empty string + // Contains exactly the expected elements, order not enforced; the "none" + // alias and the empty role are excluded from display. + assert.ElementsMatch(t, []string{"admin", "instance", "client", "portal", "service"}, got) + assert.NotContains(t, got, "none") + // Does not include empty string. for _, s := range got { assert.NotEqual(t, "", s) } }) - t.Run("UserRolesStringsIncludeAliasNoneExcludeEmpty", func(t *testing.T) { + t.Run("UserRolesStringsExcludeAliasNoneEmptyAndVisitor", func(t *testing.T) { got := UserRoles.Strings() - assert.ElementsMatch(t, []string{"admin", "guest", "none", "visitor"}, got) + assert.ElementsMatch(t, []string{"admin", "guest"}, got) + assert.NotContains(t, got, "none") + assert.NotContains(t, got, "visitor") for _, s := range got { assert.NotEqual(t, "", s) } }) - t.Run("ClientRolesCliUsageStringIncludesNoneAndOrBeforeLast", func(t *testing.T) { + t.Run("ClientRolesCliUsageStringExcludesNoneAndOrBeforeLast", func(t *testing.T) { u := ClientRoles.CliUsageString() - // Should list known roles and end with "or none" (alias present). - for _, s := range []string{"admin", "client", "instance", "portal", "service", "none"} { + // Should list known roles and end with "or service"; the "none" alias is excluded. + for _, s := range []string{"admin", "client", "instance", "portal", "service"} { assert.Contains(t, u, s) } - assert.Regexp(t, `, or none$`, u) + assert.NotContains(t, u, "none") + assert.Regexp(t, `, or service$`, u) }) - t.Run("UserRolesCliUsageStringIncludesNoneAndOrBeforeLast", func(t *testing.T) { + t.Run("UserRolesCliUsageStringExcludesNoneVisitorAndOrBeforeLast", func(t *testing.T) { u := UserRoles.CliUsageString() - for _, s := range []string{"admin", "guest", "visitor", "none"} { + for _, s := range []string{"admin", "guest"} { assert.Contains(t, u, s) } - assert.Regexp(t, `, or none$`, u) + assert.NotContains(t, u, "none") + assert.NotContains(t, u, "visitor") + assert.Regexp(t, ` or guest$`, u) }) t.Run("AliasNoneMapsToRoleNone", func(t *testing.T) { assert.Equal(t, RoleNone, ClientRoles[RoleAliasNone]) diff --git a/internal/auth/acl/rules.go b/internal/auth/acl/rules.go index c61bd1d31..21257316a 100644 --- a/internal/auth/acl/rules.go +++ b/internal/auth/acl/rules.go @@ -57,6 +57,16 @@ var Rules = ACL{ RoleAdmin: GrantFullAccess, RoleClient: GrantFullAccess, }, + ResourceCameras: Roles{ + RoleAdmin: GrantFullAccess, + RoleService: GrantFullAccess, + RoleClient: GrantFullAccess, + }, + ResourceLenses: Roles{ + RoleAdmin: GrantFullAccess, + RoleService: GrantFullAccess, + RoleClient: GrantFullAccess, + }, ResourceConfig: Roles{ RoleAdmin: GrantFullAccess, RolePortal: GrantFullAccess, @@ -138,6 +148,13 @@ var Rules = ACL{ ResourceFeedback: Roles{ RoleAdmin: GrantFullAccess, }, + ResourceMCP: Roles{ + RoleAdmin: GrantFullAccess, + RoleInstance: GrantSearchAll, + RoleService: GrantSearchAll, + RolePortal: GrantSearchAll, + RoleClient: GrantSearchAll, + }, ResourceDefault: Roles{ RoleAdmin: GrantFullAccess, RoleInstance: GrantNone, diff --git a/internal/auth/acl/scope_descriptions.go b/internal/auth/acl/scope_descriptions.go index 68bcbe800..5a0688a5d 100644 --- a/internal/auth/acl/scope_descriptions.go +++ b/internal/auth/acl/scope_descriptions.go @@ -17,6 +17,8 @@ var ScopeDescriptions = map[string]string{ ResourcePeople.String(): "Manage people records and face assignments.", ResourcePlaces.String(): "Access maps, locations, and place clusters.", ResourceLabels.String(): "Manage subject labels and keywords.", + ResourceCameras.String(): "Manage camera make and model values.", + ResourceLenses.String(): "Manage lens make and model values.", ResourceConfig.String(): "Read configuration reports and summaries.", ResourceSettings.String(): "Read and update application settings.", ResourcePasscode.String(): "Manage app passcodes and guest access codes.", diff --git a/internal/auth/acl/scope_test.go b/internal/auth/acl/scope_test.go index 14d65f5a1..1b1087065 100644 --- a/internal/auth/acl/scope_test.go +++ b/internal/auth/acl/scope_test.go @@ -71,6 +71,25 @@ func TestScopePermits(t *testing.T) { assert.False(t, ScopePermits("read settings", "sessions", Permissions{ActionDelete})) assert.False(t, ScopePermits("read settings", "sessions", Permissions{ActionDelete})) }) + t.Run("MCPScope", func(t *testing.T) { + // "mcp" is the canonical scope token for ResourceMCP and is accepted both + // standalone and combined with other scopes; unrelated scopes are denied. + assert.True(t, ScopePermits("mcp", ResourceMCP, Permissions{ActionView})) + assert.True(t, ScopePermits("mcp", ResourceMCP, Permissions{ActionSearch})) + assert.True(t, ScopePermits("MCP", ResourceMCP, Permissions{ActionView})) + assert.True(t, ScopePermits("mcp metrics", ResourceMCP, Permissions{ActionView})) + assert.True(t, ScopePermits("read mcp", ResourceMCP, Permissions{ActionView})) + assert.False(t, ScopePermits("read mcp", ResourceMCP, Permissions{ActionUpdate})) + assert.False(t, ScopePermits("metrics", ResourceMCP, Permissions{ActionView})) + // "mcp:read" is NOT an alias for "mcp read" - KeyValue.Parse treats + // it as {key=mcp, value=read}, which Attr.Find("mcp") never matches + // because the resource lookup expects a {mcp,true} entry. This + // regression assertion locks in the documented behavior in + // specs/platform/acl-scopes.md so the parser does not silently + // start accepting the colon form. + assert.False(t, ScopePermits("mcp:read", ResourceMCP, Permissions{ActionView})) + assert.False(t, ScopePermits("mcp:read", ResourceMCP, Permissions{ActionUpdate})) + }) } func TestScopeAttr(t *testing.T) { diff --git a/internal/auth/jwt/issuer.go b/internal/auth/jwt/issuer.go index 822fd721e..b6b05b5f0 100644 --- a/internal/auth/jwt/issuer.go +++ b/internal/auth/jwt/issuer.go @@ -7,6 +7,7 @@ import ( gojwt "github.com/golang-jwt/jwt/v5" + "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/pkg/rnd" ) @@ -108,3 +109,138 @@ func (i *Issuer) Issue(spec ClaimsSpec) (string, error) { } return signed, nil } + +// UserClaimsSpec describes the claims to embed in a Portal OIDC ID/access +// token. Callers populate only the OIDC profile fields permitted by the +// requested OAuth scopes; the issuer does not enforce scope-claim coupling. +type UserClaimsSpec struct { + Issuer string + Subject string + Audience string + TTL time.Duration + + NodeUUID string + AuthTime time.Time + Nonce string + Role string + + Email string + EmailVerified *bool + Name string + GivenName string + FamilyName string + PreferredUsername string + Locale string + Zoneinfo string + Picture string + + Groups []string +} + +// validate performs sanity checks on the user-claim specification before issuing a token. +func (s UserClaimsSpec) validate() error { + if strings.TrimSpace(s.Issuer) == "" { + return errors.New("jwt: issuer required") + } + if strings.TrimSpace(s.Subject) == "" { + return errors.New("jwt: subject required") + } + if strings.TrimSpace(s.Audience) == "" { + return errors.New("jwt: audience required") + } + if strings.TrimSpace(s.NodeUUID) == "" { + return errors.New("jwt: node uuid required") + } + return nil +} + +// UserClaims is the claim set emitted in Portal OIDC ID and access tokens. +// Field tags use the OIDC-standard claim names so instances can consume the +// token through their existing OIDC RP code without translation. +type UserClaims struct { + Nonce string `json:"nonce,omitempty"` + AuthTime int64 `json:"auth_time,omitempty"` + Email string `json:"email,omitempty"` + EmailVerified *bool `json:"email_verified,omitempty"` + Name string `json:"name,omitempty"` + GivenName string `json:"given_name,omitempty"` + FamilyName string `json:"family_name,omitempty"` + PreferredUsername string `json:"preferred_username,omitempty"` + Locale string `json:"locale,omitempty"` + Zoneinfo string `json:"zoneinfo,omitempty"` + Picture string `json:"picture,omitempty"` + Groups []string `json:"groups,omitempty"` + PortalRole string `json:"pp_role,omitempty"` + PortalNodeUUID string `json:"pp_node_uuid,omitempty"` + PortalIssuerKind string `json:"pp_issuer_kind,omitempty"` + gojwt.RegisteredClaims +} + +// IssueUser signs a Portal OIDC ID/access token using the manager's active +// key. The token shape mirrors what an instance OIDC RP would receive from +// any upstream IdP, with three Portal-specific claims (pp_role, pp_node_uuid, +// pp_issuer_kind) added so instances can correlate the token with the node +// they were targeted for. +func (i *Issuer) IssueUser(spec UserClaimsSpec) (string, error) { + if i == nil || i.manager == nil { + return "", errors.New("jwt: issuer not initialized") + } + if err := spec.validate(); err != nil { + return "", err + } + + ttl := spec.TTL + if ttl <= 0 { + ttl = TokenTTL + } + if ttl > MaxTokenTTL { + ttl = MaxTokenTTL + } + + key, err := i.manager.EnsureActiveKey() + if err != nil { + return "", err + } + + issuedAt := i.now().UTC() + expiresAt := issuedAt.Add(ttl) + + claims := &UserClaims{ + Nonce: spec.Nonce, + Email: spec.Email, + EmailVerified: spec.EmailVerified, + Name: spec.Name, + GivenName: spec.GivenName, + FamilyName: spec.FamilyName, + PreferredUsername: spec.PreferredUsername, + Locale: spec.Locale, + Zoneinfo: spec.Zoneinfo, + Picture: spec.Picture, + Groups: spec.Groups, + PortalRole: spec.Role, + PortalNodeUUID: spec.NodeUUID, + PortalIssuerKind: acl.RolePortal.String(), + RegisteredClaims: gojwt.RegisteredClaims{ + Issuer: spec.Issuer, + Subject: spec.Subject, + Audience: gojwt.ClaimStrings{spec.Audience}, + IssuedAt: gojwt.NewNumericDate(issuedAt), + NotBefore: gojwt.NewNumericDate(issuedAt), + ExpiresAt: gojwt.NewNumericDate(expiresAt), + ID: rnd.AuthTokenID(PrefixTokenID), + }, + } + if !spec.AuthTime.IsZero() { + claims.AuthTime = spec.AuthTime.UTC().Unix() + } + + token := gojwt.NewWithClaims(gojwt.SigningMethodEdDSA, claims) + token.Header["kid"] = key.Kid + token.Header["typ"] = "JWT" + + signed, err := token.SignedString(key.PrivateKey) + if err != nil { + return "", err + } + return signed, nil +} diff --git a/internal/auth/jwt/issuer_test.go b/internal/auth/jwt/issuer_test.go new file mode 100644 index 000000000..c37ac37e4 --- /dev/null +++ b/internal/auth/jwt/issuer_test.go @@ -0,0 +1,283 @@ +package jwt + +import ( + "crypto/ed25519" + "encoding/base64" + "encoding/json" + "strings" + "testing" + "time" + + gojwt "github.com/golang-jwt/jwt/v5" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/internal/auth/acl" +) + +// userTokenSetup spins up an in-memory key manager and issuer with a frozen +// clock so token timestamps are deterministic across assertions. +func userTokenSetup(t *testing.T) (*Issuer, *Manager) { + cfg := newTestConfig(t) + mgr, err := NewManager(cfg) + require.NoError(t, err) + mgr.now = func() time.Time { return time.Date(2026, 5, 24, 12, 0, 0, 0, time.UTC) } + _, err = mgr.EnsureActiveKey() + require.NoError(t, err) + + iss := NewIssuer(mgr) + iss.now = func() time.Time { return time.Date(2026, 5, 24, 12, 0, 0, 0, time.UTC) } + return iss, mgr +} + +// decodeUserClaims parses a Portal-issued JWT against the manager's public +// key and returns the typed UserClaims for assertions. +func decodeUserClaims(t *testing.T, mgr *Manager, token string) *UserClaims { + t.Helper() + parsed := &UserClaims{} + parser := gojwt.NewParser( + gojwt.WithValidMethods([]string{gojwt.SigningMethodEdDSA.Alg()}), + gojwt.WithoutClaimsValidation(), + ) + _, err := parser.ParseWithClaims(token, parsed, func(*gojwt.Token) (any, error) { + key, _ := mgr.ActiveKey() + return key.PublicKey, nil + }) + require.NoError(t, err) + return parsed +} + +// decodeUserPayload decodes the JWT payload as a generic map so tests can +// assert on the raw JSON shape (presence/absence of optional claims under +// omitempty rules). +func decodeUserPayload(t *testing.T, token string) map[string]any { + t.Helper() + parts := strings.Split(token, ".") + require.Len(t, parts, 3, "JWT must have three segments") + raw, err := base64.RawURLEncoding.DecodeString(parts[1]) + require.NoError(t, err) + out := map[string]any{} + require.NoError(t, json.Unmarshal(raw, &out)) + return out +} + +func validSpec() UserClaimsSpec { + return UserClaimsSpec{ + Issuer: "https://portal.example.com/", + Subject: "uxxxxxxxxxxxxxxx", + Audience: "cs5gfen1bgxz7s9i", + NodeUUID: "0192abcd-1234-7000-8000-000000000001", + Role: "admin", + } +} + +func TestIssueUser_Success(t *testing.T) { + iss, mgr := userTokenSetup(t) + + spec := validSpec() + spec.Nonce = "nonce-abc" + spec.AuthTime = time.Date(2026, 5, 24, 11, 0, 0, 0, time.UTC) + + token, err := iss.IssueUser(spec) + require.NoError(t, err) + + got := decodeUserClaims(t, mgr, token) + assert.Equal(t, spec.Issuer, got.Issuer) + assert.Equal(t, spec.Subject, got.Subject) + assert.Contains(t, got.Audience, spec.Audience) + assert.Equal(t, "nonce-abc", got.Nonce) + assert.Equal(t, spec.AuthTime.Unix(), got.AuthTime) + assert.Equal(t, "admin", got.PortalRole) + assert.Equal(t, spec.NodeUUID, got.PortalNodeUUID) + assert.Equal(t, acl.RolePortal.String(), got.PortalIssuerKind) + require.NotNil(t, got.IssuedAt) + require.NotNil(t, got.ExpiresAt) + assert.Equal(t, TokenTTL, got.ExpiresAt.Sub(got.IssuedAt.Time)) +} + +func TestIssueUser_Validation(t *testing.T) { + iss, _ := userTokenSetup(t) + + cases := []struct { + name string + mut func(*UserClaimsSpec) + err string + }{ + {"MissingIssuer", func(s *UserClaimsSpec) { s.Issuer = "" }, "jwt: issuer required"}, + {"MissingSubject", func(s *UserClaimsSpec) { s.Subject = "" }, "jwt: subject required"}, + {"MissingAudience", func(s *UserClaimsSpec) { s.Audience = "" }, "jwt: audience required"}, + {"MissingNodeUUID", func(s *UserClaimsSpec) { s.NodeUUID = "" }, "jwt: node uuid required"}, + } + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + s := validSpec() + tc.mut(&s) + _, err := iss.IssueUser(s) + assert.EqualError(t, err, tc.err) + }) + } +} + +func TestIssueUser_TTLClamp(t *testing.T) { + iss, mgr := userTokenSetup(t) + + spec := validSpec() + spec.TTL = MaxTokenTTL * 4 + + token, err := iss.IssueUser(spec) + require.NoError(t, err) + + got := decodeUserClaims(t, mgr, token) + assert.Equal(t, MaxTokenTTL, got.ExpiresAt.Sub(got.IssuedAt.Time)) +} + +func TestIssueUser_DefaultTTL(t *testing.T) { + iss, mgr := userTokenSetup(t) + + // Zero TTL falls back to the package-level TokenTTL default. + token, err := iss.IssueUser(validSpec()) + require.NoError(t, err) + + got := decodeUserClaims(t, mgr, token) + assert.Equal(t, TokenTTL, got.ExpiresAt.Sub(got.IssuedAt.Time)) +} + +func TestIssueUser_OptionalProfileClaimsOmitted(t *testing.T) { + iss, _ := userTokenSetup(t) + + // Caller has not requested any profile-scope claims. + token, err := iss.IssueUser(validSpec()) + require.NoError(t, err) + + payload := decodeUserPayload(t, token) + for _, k := range []string{ + "email", "email_verified", "name", "given_name", "family_name", + "preferred_username", "locale", "zoneinfo", "picture", "groups", "auth_time", "nonce", + } { + _, present := payload[k] + assert.Falsef(t, present, "claim %q must be omitted when caller did not set it", k) + } +} + +func TestIssueUser_EmailVerifiedExplicit(t *testing.T) { + iss, mgr := userTokenSetup(t) + + t.Run("True", func(t *testing.T) { + spec := validSpec() + spec.Email = "alice@example.com" + yes := true + spec.EmailVerified = &yes + + token, err := iss.IssueUser(spec) + require.NoError(t, err) + got := decodeUserClaims(t, mgr, token) + require.NotNil(t, got.EmailVerified) + assert.True(t, *got.EmailVerified) + }) + + t.Run("FalseEmittedExplicitly", func(t *testing.T) { + // Pointer semantics: an explicit &false MUST land in the token as + // `email_verified: false`, not be silently dropped (which is the + // trap with bool + omitempty). + spec := validSpec() + spec.Email = "alice@example.com" + no := false + spec.EmailVerified = &no + + token, err := iss.IssueUser(spec) + require.NoError(t, err) + + payload := decodeUserPayload(t, token) + verified, present := payload["email_verified"] + require.True(t, present, "email_verified must be present when caller sets &false") + assert.Equal(t, false, verified) + }) + + t.Run("NilOmitted", func(t *testing.T) { + spec := validSpec() + spec.Email = "alice@example.com" // email set but verified intentionally nil + + token, err := iss.IssueUser(spec) + require.NoError(t, err) + + payload := decodeUserPayload(t, token) + _, present := payload["email_verified"] + assert.False(t, present, "email_verified must be omitted when caller leaves it nil") + }) +} + +func TestIssueUser_GroupsEmission(t *testing.T) { + iss, mgr := userTokenSetup(t) + + spec := validSpec() + spec.Groups = []string{"media-acme-admin", "media-acme-viewer"} + + token, err := iss.IssueUser(spec) + require.NoError(t, err) + + got := decodeUserClaims(t, mgr, token) + assert.Equal(t, []string{"media-acme-admin", "media-acme-viewer"}, got.Groups) +} + +func TestIssueUser_SignatureVerifiesAgainstJWKS(t *testing.T) { + iss, mgr := userTokenSetup(t) + + spec := validSpec() + token, err := iss.IssueUser(spec) + require.NoError(t, err) + + keys := mgr.JWKS().Keys + // WithoutClaimsValidation skips the temporal nbf/exp checks because the + // issuer's frozen clock isn't aligned with wall-clock time; the point of + // this test is signature + JWKS resolution, not freshness. Issuer and + // audience are asserted explicitly on the parsed struct below. + parser := gojwt.NewParser( + gojwt.WithValidMethods([]string{gojwt.SigningMethodEdDSA.Alg()}), + gojwt.WithoutClaimsValidation(), + ) + + parsed := &UserClaims{} + _, err = parser.ParseWithClaims(token, parsed, func(tok *gojwt.Token) (any, error) { + kid, _ := tok.Header["kid"].(string) + for _, k := range keys { + if k.Kid == kid { + raw, decodeErr := base64.RawURLEncoding.DecodeString(k.X) + require.NoError(t, decodeErr) + return ed25519.PublicKey(raw), nil + } + } + t.Fatalf("no matching kid %s in JWKS", kid) + return nil, nil + }) + require.NoError(t, err) + assert.Equal(t, spec.Subject, parsed.Subject) + assert.Equal(t, spec.Issuer, parsed.Issuer) + assert.Contains(t, parsed.Audience, spec.Audience) +} + +func TestIssueUser_NilIssuer(t *testing.T) { + var iss *Issuer + _, err := iss.IssueUser(validSpec()) + assert.EqualError(t, err, "jwt: issuer not initialized") +} + +func TestIssueUser_IssuerWithoutManager(t *testing.T) { + iss := &Issuer{} + _, err := iss.IssueUser(validSpec()) + assert.EqualError(t, err, "jwt: issuer not initialized") +} + +func TestUserClaimsSpec_Validate(t *testing.T) { + // Direct coverage of the unexported validate() helper because the rule + // requires focused tests for new helpers, not just integration coverage + // through IssueUser. + t.Run("Valid", func(t *testing.T) { + assert.NoError(t, validSpec().validate()) + }) + t.Run("TrimsWhitespaceOnlyValues", func(t *testing.T) { + s := validSpec() + s.Issuer = " " + assert.EqualError(t, s.validate(), "jwt: issuer required") + }) +} diff --git a/internal/auth/jwt/jwt.go b/internal/auth/jwt/jwt.go index 997841bc5..0e34e54eb 100644 --- a/internal/auth/jwt/jwt.go +++ b/internal/auth/jwt/jwt.go @@ -3,7 +3,7 @@ Package jwt provides helpers for managing Ed25519 signing keys and issuing or verifying short-lived JWTs used for secure communication between the Portal and cluster instances and services. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -16,7 +16,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/auth/jwt/jwt_test.go b/internal/auth/jwt/jwt_test.go index 0189f2fd5..2570cbdd8 100644 --- a/internal/auth/jwt/jwt_test.go +++ b/internal/auth/jwt/jwt_test.go @@ -11,19 +11,25 @@ import ( "github.com/photoprism/photoprism/pkg/fs" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) int { // Init test logger. log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) event.AuditLog = log - // Run unit tests. - code := m.Run() - - // Remove temporary SQLite files after running the tests. + // Remove temporary SQLite files before running the tests. fs.PurgeTestDbFiles(".", false) - os.Exit(code) + // Remove temporary SQLite files after running the tests. + defer fs.PurgeTestDbFiles(".", false) + + // Run unit tests. + return m.Run() } func newTestConfig(t *testing.T) *cfg.Config { diff --git a/internal/auth/jwt/manager.go b/internal/auth/jwt/manager.go index 7cc1713b6..3a536f990 100644 --- a/internal/auth/jwt/manager.go +++ b/internal/auth/jwt/manager.go @@ -113,6 +113,8 @@ func (m *Manager) JWKS() *JWKS { } keys = append(keys, PublicJWK{ Kty: keyTypeOKP, + Use: keyUseSig, + Alg: algEdDSA, Crv: curveEd25519, Kid: k.Kid, X: base64.RawURLEncoding.EncodeToString(k.PublicKey), diff --git a/internal/auth/jwt/manager_test.go b/internal/auth/jwt/manager_test.go index f8a395ac5..19825826d 100644 --- a/internal/auth/jwt/manager_test.go +++ b/internal/auth/jwt/manager_test.go @@ -37,10 +37,15 @@ func TestManagerEnsureActiveKey(t *testing.T) { require.NoError(t, err) require.Equal(t, key.Kid, next.Kid) - // JWKS should expose the key. + // JWKS should expose the key with the signature use and EdDSA algorithm so + // relying parties can select the verifier. jwks := m.JWKS() require.Len(t, jwks.Keys, 1) require.Equal(t, key.Kid, jwks.Keys[0].Kid) + require.Equal(t, "OKP", jwks.Keys[0].Kty) + require.Equal(t, "Ed25519", jwks.Keys[0].Crv) + require.Equal(t, "sig", jwks.Keys[0].Use) + require.Equal(t, "EdDSA", jwks.Keys[0].Alg) // Reload manager from disk. m2, err := NewManager(c) diff --git a/internal/auth/jwt/types.go b/internal/auth/jwt/types.go index 38ebb24ce..b553085d8 100644 --- a/internal/auth/jwt/types.go +++ b/internal/auth/jwt/types.go @@ -9,11 +9,17 @@ import ( const ( keyTypeOKP = "OKP" curveEd25519 = "Ed25519" + algEdDSA = "EdDSA" + keyUseSig = "sig" ) // PublicJWK represents the public portion of an Ed25519 key in JWK form. +// `use` and `alg` are advertised so relying parties (e.g. the zitadel/oidc RP +// on instances) can select the EdDSA signature verifier for ID-token validation. type PublicJWK struct { Kty string `json:"kty"` + Use string `json:"use"` + Alg string `json:"alg"` Crv string `json:"crv"` Kid string `json:"kid"` X string `json:"x"` diff --git a/internal/auth/jwt/verifier.go b/internal/auth/jwt/verifier.go index dcae1da62..5de313496 100644 --- a/internal/auth/jwt/verifier.go +++ b/internal/auth/jwt/verifier.go @@ -7,6 +7,7 @@ import ( "encoding/json" "errors" "fmt" + "io" "math/rand/v2" "net/http" "os" @@ -25,6 +26,10 @@ var ( errKeyNotFound = errors.New("jwt: key not found") ) +// maxJWKSResponseBytes bounds how much of a JWKS response is read so a malicious +// or compromised IdP endpoint cannot exhaust memory; real key sets are a few KB. +const maxJWKSResponseBytes = 1 << 20 // 1 MiB + // VerifierStatus captures diagnostic information about a verifier's JWKS cache state. type VerifierStatus struct { CacheURL string `json:"cacheUrl,omitempty"` @@ -455,7 +460,7 @@ func (v *Verifier) fetchJWKS(ctx context.Context, url, etag string) (*jwksFetchR }, nil case http.StatusOK: var body JWKS - if err := json.NewDecoder(resp.Body).Decode(&body); err != nil { + if err := json.NewDecoder(io.LimitReader(resp.Body, maxJWKSResponseBytes)).Decode(&body); err != nil { return nil, err } if len(body.Keys) == 0 { diff --git a/internal/auth/jwt/verifier_test.go b/internal/auth/jwt/verifier_test.go index 4174e018e..a8beb0966 100644 --- a/internal/auth/jwt/verifier_test.go +++ b/internal/auth/jwt/verifier_test.go @@ -6,6 +6,7 @@ import ( "fmt" "net/http" "net/http/httptest" + "strings" "testing" "time" @@ -215,3 +216,40 @@ func TestBackoffDuration(t *testing.T) { } } } + +func TestVerifierRejectsOversizedJWKS(t *testing.T) { + portalCfg := newTestConfig(t) + clusterUUID := rnd.UUIDv7() + portalCfg.Options().ClusterUUID = clusterUUID + + mgr, err := NewManager(portalCfg) + require.NoError(t, err) + mgr.now = func() time.Time { return time.Date(2025, 9, 24, 10, 30, 0, 0, time.UTC) } + _, err = mgr.EnsureActiveKey() + require.NoError(t, err) + + jwksBytes, err := json.Marshal(mgr.JWKS()) + require.NoError(t, err) + require.Greater(t, len(jwksBytes), 2) + + // Build a JSON-valid but oversized JWKS by appending a large ignored field, so + // a successful decode would require reading past maxJWKSResponseBytes. With the + // cap in place the response is truncated mid-value and the decode fails. + pad := strings.Repeat("a", maxJWKSResponseBytes) + oversized := string(jwksBytes[:len(jwksBytes)-1]) + `,"pad":"` + pad + `"}` + require.Greater(t, len(oversized), maxJWKSResponseBytes) + + server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(http.StatusOK) + _, _ = w.Write([]byte(oversized)) + })) + defer server.Close() + + nodeCfg := newTestConfig(t) + nodeCfg.SetJWKSUrl(server.URL + "/.well-known/jwks.json") + nodeCfg.Options().ClusterUUID = clusterUUID + + verifier := NewVerifier(nodeCfg) + err = verifier.Prime(context.Background(), nodeCfg.JWKSUrl()) + require.Error(t, err) +} diff --git a/internal/auth/oidc/README.md b/internal/auth/oidc/README.md index b77420883..b185825aa 100644 --- a/internal/auth/oidc/README.md +++ b/internal/auth/oidc/README.md @@ -1,6 +1,6 @@ ## PhotoPrism — OIDC Integration -**Last Updated:** February 22, 2026 +**Last Updated:** June 25, 2026 ### Overview @@ -30,6 +30,8 @@ - `oidc.go` — package doc + logger. - `client.go` — RP construction (`NewClient`), PKCE detection, auth redirect, code exchange + userinfo retrieval. +- `nonce.go` — per-request `Nonce` generation and tolerant `CheckNonce` ID-token validation; tests in `nonce_test.go`. +- `logout.go` — `(*Client).EndSessionURL` builds the RP-initiated logout URL (id_token_hint, post_logout_redirect_uri, client_id, state) for a browser redirect; tests in `logout_test.go`. - `http_client.go` — shared HTTP client with TLS toggle and timeouts; helpers for tests in `http_client_test.go`. - `redirect_url.go` — builds the redirect/callback URL from site config. - `register.go` — provider registration glue; tests in `register_test.go`. @@ -51,6 +53,19 @@ - Audit every provider/redirect/token error with sanitized messages; avoid logging secrets. - Prefer explicit scopes from configuration; defaults request only the minimal set. +#### Nonce Handling + +- `AuthURLHandler` generates a unique `nonce` per authorization request, stores it in the signed and encrypted RP cookie (same scope as `state`/PKCE), and sends it on the authorization request so the provider reflects it back in the ID token. +- `CodeExchangeUserInfo` validates the ID token's `nonce` claim against the cookie value via `CheckNonce`. Validation is tolerant: a token that echoes the nonce must match, but a provider that omits the nonce on a session-resumed token (e.g. AWS Cognito) is accepted so logins do not regress. +- The library's strict nonce verifier is disabled with `rp.WithNonce(nil)` because its default expects an empty nonce and would reject every echoed value; PhotoPrism owns the check instead. +- Without an explicit nonce, Cognito auto-generates one on the first interactive login from a fresh browser, which the default verifier rejects with `nonce does not match`; sending our own nonce makes the round-trip spec-clean. + +#### RP-Initiated Logout + +- The provider's `end_session_endpoint` is captured automatically from discovery by the wrapped `zitadel/oidc` RP and read via `GetEndSessionEndpoint()`; no separate config is needed. +- `(*Client).EndSessionURL` constructs the redirect URL for the browser (it does not call the endpoint server-side, unlike `rp.EndSession`, because only the browser carries the provider's SSO cookie). It returns an empty string when the provider advertises no end-session endpoint, so callers fall back to a local-only logout. +- The behavior is gated by `PHOTOPRISM_OIDC_LOGOUT` (default off) and enforced at sign-out in `internal/api/session_delete.go`. + ### Security Group Extension for Entra ID The following features are supported by the current implementation: @@ -60,6 +75,7 @@ The following features are supported by the current implementation: - Group-to-role mapping: `--oidc-group-role` (`GROUP=ROLE`, repeatable) assigns the first matching role; falls back to `--oidc-role` (default `guest`) when no mapping matches. - Keeps app/directory roles (`roles`, `wids`) separate from security groups to avoid accidental privilege escalation. - Claim name is configurable via `--oidc-group-claim` (default `groups`). +- On Portal builds, persists the merged, normalized group set from the ID token and userinfo on the login session (`entity.SessionData.Groups`), so the Portal can evaluate group-based cluster access at authorize time without another IdP round-trip. Instance and CE sessions never store groups, and the session API responses redact the field (`SessionData.Redacted`), so group membership is not exposed to clients. #### Configuration Options diff --git a/internal/auth/oidc/client.go b/internal/auth/oidc/client.go index 59146f4a0..c140c0165 100644 --- a/internal/auth/oidc/client.go +++ b/internal/auth/oidc/client.go @@ -6,6 +6,7 @@ import ( "fmt" "net/http" "net/url" + "strings" "time" "github.com/gin-gonic/gin" @@ -26,11 +27,12 @@ import ( type Client struct { rp.RelyingParty insecure bool + prompt []string } // NewClient creates a new OpenID Connect (OIDC) Relying Party (RP) client using the provided discovery URL, -// client credentials, scopes, and site URL. -func NewClient(issuerUri *url.URL, oidcClient, oidcSecret, oidcScopes, siteUrl string, insecure bool) (result *Client, err error) { +// client credentials, scopes, authorization prompt, and site URL. +func NewClient(issuerUri *url.URL, oidcClient, oidcSecret, oidcScopes, oidcPrompt, siteUrl string, insecure bool) (result *Client, err error) { if issuerUri == nil { err = errors.New("issuer uri required") event.AuditErr([]string{"oidc", "provider", status.Error(err)}) @@ -62,8 +64,19 @@ func NewClient(issuerUri *url.URL, oidcClient, oidcSecret, oidcScopes, siteUrl s return nil, err } - // Create cookie handler. - cookieHandler := utils.NewCookieHandler(hashKey, encryptKey, utils.WithUnsecure()) + // Create cookie handler. The short-lived state (CSRF defense) and PKCE + // code_verifier cookies keep the Secure attribute on HTTPS deployments; it is + // only dropped when running insecurely (HTTP issuer / relaxed TLS), gated by the + // same flag that already permits a non-HTTPS issuer. + var cookieOpts []utils.CookieHandlerOpt + if insecure { + cookieOpts = append(cookieOpts, utils.WithUnsecure()) + } + // Scope the cookies to the OIDC endpoints under the instance base path instead + // of the library default Path=/, so they survive to the callback without relying + // on a shared-domain reverse proxy rewriting the Set-Cookie path. + cookieOpts = append(cookieOpts, utils.WithPath(CookiePath(siteUrl))) + cookieHandler := utils.NewCookieHandler(hashKey, encryptKey, cookieOpts...) // Create HTTP client. httpClient := HttpClient(insecure) @@ -73,7 +86,16 @@ func NewClient(issuerUri *url.URL, oidcClient, oidcSecret, oidcScopes, siteUrl s rp.WithHTTPClient(httpClient), rp.WithCookieHandler(cookieHandler), rp.WithVerifierOpts( - rp.WithIssuedAtOffset(5 * time.Second), + rp.WithIssuedAtOffset(5*time.Second), + // Accept EdDSA — the PhotoPrism Portal OIDC OP signs ID tokens with + // Ed25519 — alongside the default RS256 and the other common IdP + // algorithms; the verifier otherwise rejects EdDSA-signed ID tokens + // with "signature algorithm not supported". + rp.WithSupportedSigningAlgorithms("RS256", "RS384", "RS512", "ES256", "ES384", "ES512", "PS256", "PS384", "PS512", "EdDSA"), + // Disable the library's strict nonce check: its default expects an empty + // nonce and would reject every value we echo. PhotoPrism validates the + // nonce itself on the callback (see CheckNonce and README "Nonce Handling"). + rp.WithNonce(nil), ), rp.WithErrorHandler(func(w http.ResponseWriter, r *http.Request, errorType string, errorDesc string, state string) { event.AuditErr([]string{"oidc", "%s", "%s (state %s)"}, errorType, errorDesc, state) @@ -121,19 +143,66 @@ func NewClient(issuerUri *url.URL, oidcClient, oidcSecret, oidcScopes, siteUrl s event.AuditDebug([]string{"oidc", "provider", "pkce", "disabled"}) } + // Validate the configured authorization prompt and drop unsupported values, so + // a typo can never break the redirect to the identity provider. + prompt, invalidPrompt := ParsePrompt(oidcPrompt) + + if len(invalidPrompt) > 0 { + event.AuditWarn([]string{"oidc", "provider", "unsupported prompt %s", status.Skipped}, clean.Log(strings.Join(invalidPrompt, " "))) + } + // Return OIDC Client with RelyingParty provider. return &Client{ - provider, - insecure, + RelyingParty: provider, + insecure: insecure, + prompt: prompt, }, nil } // AuthURLHandler redirects a browser to the login page of the configured OIDC identity provider. func (c *Client) AuthURLHandler(ctx *gin.Context) { - handle := rp.AuthURLHandler(rnd.State, c) + // Send a per-request nonce (stored in a signed, encrypted cookie) so the + // provider reflects it back in the ID token; see README "Nonce Handling" for + // the Cognito rationale. On generation or cookie failure, fall back to a + // nonce-less redirect. + var urlParams []rp.URLParamOpt + + if nonce, nonceErr := Nonce(); nonceErr != nil { + event.AuditWarn([]string{"oidc", "nonce", status.Error(nonceErr)}) + } else if cookieErr := c.CookieHandler().SetCookie(ctx.Writer, NonceCookie, nonce); cookieErr != nil { + event.AuditWarn([]string{"oidc", "nonce cookie", status.Error(cookieErr)}) + } else { + urlParams = append(urlParams, rp.WithURLParam(nonceParam, nonce)) + } + + // Ask the provider to re-prompt (e.g. login or select_account) when configured, + // so a previously rejected user is no longer silently re-authenticated via SSO. + if len(c.prompt) > 0 { + urlParams = append(urlParams, rp.WithPromptURLParam(c.prompt...)) + } + + handle := rp.AuthURLHandler(rnd.State, c, urlParams...) handle(ctx.Writer, ctx.Request) } +// codeExchangeRecorder captures the OIDC code-exchange handler's status and +// headers while discarding its body, so a failure (e.g. a missing state cookie) +// is reported to the caller instead of being written as a raw error to the real +// response. The caller renders a branded page in its place. +type codeExchangeRecorder struct { + header http.Header + status int +} + +func (w *codeExchangeRecorder) Header() http.Header { return w.header } +func (w *codeExchangeRecorder) Write(b []byte) (int, error) { + if w.status == 0 { + w.status = http.StatusOK + } + return len(b), nil +} +func (w *codeExchangeRecorder) WriteHeader(status int) { w.status = status } + // CodeExchangeUserInfo verifies a redirect auth request and returns the user information and tokens if successful. func (c *Client) CodeExchangeUserInfo(ctx *gin.Context) (userInfo *oidc.UserInfo, tokens *oidc.Tokens[*oidc.IDTokenClaims], err error) { getInfo := func(w http.ResponseWriter, r *http.Request, t *oidc.Tokens[*oidc.IDTokenClaims], state string, rp rp.RelyingParty, i *oidc.UserInfo) { @@ -141,14 +210,22 @@ func (c *Client) CodeExchangeUserInfo(ctx *gin.Context) (userInfo *oidc.UserInfo tokens = t } + // Read and clear the per-request nonce cookie set on the authorization redirect + // so the ID token's nonce claim can be validated once the exchange succeeds. + expectedNonce, _ := c.CookieHandler().CheckCookie(ctx.Request, NonceCookie) + c.CookieHandler().DeleteCookie(ctx.Writer, NonceCookie) + // It would also be possible to directly get the user info from the oidc.IDTokenClaims // without performing a request to the userinfo endpoint of the OIDC identity provider. handle := rp.CodeExchangeHandler(rp.UserinfoCallback(getInfo), c) - handle(ctx.Writer, ctx.Request) + // Run the exchange against a recorder so a failure isn't written as a raw, + // unbranded error to the browser; the caller renders a branded page instead. + rec := &codeExchangeRecorder{header: make(http.Header)} + handle(rec, ctx.Request) - if sc := ctx.Writer.Status(); sc != 0 && sc != http.StatusOK { - if oidcErr := ctx.Writer.Header().Get("oidc_error"); oidcErr == "" { + if sc := rec.status; sc != 0 && sc != http.StatusOK { + if oidcErr := rec.header.Get("oidc_error"); oidcErr == "" { err = errors.New("failed to exchange token for user info") } else { err = errors.New(oidcErr) @@ -159,5 +236,19 @@ func (c *Client) CodeExchangeUserInfo(ctx *gin.Context) (userInfo *oidc.UserInfo return userInfo, tokens, err } + // Validate the ID token's nonce against the value sent for this request, + // tolerating a provider that omits the nonce on a session-resumed token. + if err = CheckNonce(expectedNonce, tokens); err != nil { + event.SystemError([]string{"oidc", "code exchange", "%s"}, err.Error()) + + return nil, nil, err + } + + // Propagate any cookies the handler set on success (e.g. clearing the + // single-use state cookie) to the real response. + for _, ck := range rec.header.Values("Set-Cookie") { + ctx.Writer.Header().Add("Set-Cookie", ck) + } + return userInfo, tokens, nil } diff --git a/internal/auth/oidc/client_test.go b/internal/auth/oidc/client_test.go index 4598f86fb..ab8073fe5 100644 --- a/internal/auth/oidc/client_test.go +++ b/internal/auth/oidc/client_test.go @@ -1,12 +1,19 @@ package oidc import ( + "bytes" + "net/http" + "net/http/httptest" "net/url" "testing" - "github.com/photoprism/photoprism/pkg/authn" - + "github.com/gin-gonic/gin" + "github.com/sirupsen/logrus" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/internal/event" + "github.com/photoprism/photoprism/pkg/authn" ) func TestNewClient(t *testing.T) { @@ -20,6 +27,7 @@ func TestNewClient(t *testing.T) { "csg6yqvykh0780f9", "nd09wkee0ElsMvzLGkgWS9wJAttHwF2h", authn.OidcDefaultScopes, + "", "https://app.localssl.dev/", false, ) @@ -37,6 +45,7 @@ func TestNewClient(t *testing.T) { "csg6yqvykh0780f9", "nd09wkee0ElsMvzLGkgWS9wJAttHwF2h", authn.OidcDefaultScopes, + "", "https://app.localssl.dev/", true, ) @@ -54,6 +63,7 @@ func TestNewClient(t *testing.T) { "csg6yqvykh0780f9", "nd09wkee0ElsMvzLGkgWS9wJAttHwF2h", "", + "", "https://app.localssl.dev/", true, ) @@ -67,6 +77,7 @@ func TestNewClient(t *testing.T) { "csg6yqvykh0780f9", "nd09wkee0ElsMvzLGkgWS9wJAttHwF2h", authn.OidcDefaultScopes, + "", "https://app.localssl.dev/", true, ) @@ -85,6 +96,7 @@ func TestNewClient(t *testing.T) { "nd09wkee0ElsMvzLGkgWS9wJAttHwF2h", authn.OidcDefaultScopes, "", + "", true, ) @@ -100,6 +112,7 @@ func TestNewClient(t *testing.T) { "csg6yqvykh0780f9", "nd09wkee0ElsMvzLGkgWS9wJAttHwF2h", authn.OidcDefaultScopes, + "", "https://app.localssl.dev/", true, ) @@ -108,3 +121,146 @@ func TestNewClient(t *testing.T) { assert.Nil(t, client) }) } + +func TestNewClient_LogsInvalidPrompt(t *testing.T) { + // Capture the audit log so the "unsupported prompt" warning can be asserted. + var buf bytes.Buffer + orig := event.AuditLog + testLog := logrus.New() + testLog.SetOutput(&buf) + testLog.SetLevel(logrus.TraceLevel) + event.AuditLog = testLog + t.Cleanup(func() { event.AuditLog = orig }) + + uri, err := url.Parse("http://dummy-oidc:9998") + require.NoError(t, err) + client, err := NewClient(uri, "csg6yqvykh0780f9", "nd09wkee0ElsMvzLGkgWS9wJAttHwF2h", authn.OidcDefaultScopes, "login bogus", "https://app.localssl.dev/", true) + require.NoError(t, err) + require.NotNil(t, client) + + // The unsupported token is reported; the valid one still reaches the provider. + out := buf.String() + assert.Contains(t, out, "prompt") + assert.Contains(t, out, "bogus") + assert.Equal(t, []string{"login"}, client.prompt) +} + +func TestCodeExchangeRecorder(t *testing.T) { + t.Run("CapturesStatusAndHeadersDiscardsBody", func(t *testing.T) { + rec := &codeExchangeRecorder{header: make(http.Header)} + rec.Header().Set("oidc_error", "boom") + rec.WriteHeader(http.StatusBadRequest) + n, err := rec.Write([]byte("failed to get state: http: named cookie not present")) + require.NoError(t, err) + assert.Equal(t, len("failed to get state: http: named cookie not present"), n) + assert.Equal(t, http.StatusBadRequest, rec.status) + assert.Equal(t, "boom", rec.header.Get("oidc_error")) + }) + t.Run("WriteWithoutWriteHeaderDefaultsTo200", func(t *testing.T) { + rec := &codeExchangeRecorder{header: make(http.Header)} + _, _ = rec.Write([]byte("ok")) + assert.Equal(t, http.StatusOK, rec.status) + }) +} + +func TestClient_AuthURLHandler_SendsNonce(t *testing.T) { + uri, err := url.Parse("http://dummy-oidc:9998") + require.NoError(t, err) + client, err := NewClient(uri, "csg6yqvykh0780f9", "nd09wkee0ElsMvzLGkgWS9wJAttHwF2h", authn.OidcDefaultScopes, "", "https://app.localssl.dev/", true) + require.NoError(t, err) + require.NotNil(t, client) + + gin.SetMode(gin.TestMode) + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + c.Request, _ = http.NewRequest(http.MethodGet, "/api/v1/oidc/login", nil) + + client.AuthURLHandler(c) + + // Redirects to the provider with a nonce on the authorization request. + assert.Equal(t, http.StatusFound, w.Code) + loc, locErr := url.Parse(w.Header().Get("Location")) + require.NoError(t, locErr) + sentNonce := loc.Query().Get("nonce") + assert.NotEmpty(t, sentNonce) + + // Omits the prompt parameter when no authorization prompt is configured. + assert.Empty(t, loc.Query().Get("prompt")) + + // Stores the nonce in a cookie so it survives to the callback. + var nonceCookie bool + for _, ck := range w.Result().Cookies() { + if ck.Name == NonceCookie { + nonceCookie = true + assert.NotEmpty(t, ck.Value) + } + } + assert.True(t, nonceCookie) +} + +func TestClient_AuthURLHandler_SendsPrompt(t *testing.T) { + t.Run("ValidValue", func(t *testing.T) { + uri, err := url.Parse("http://dummy-oidc:9998") + require.NoError(t, err) + client, err := NewClient(uri, "csg6yqvykh0780f9", "nd09wkee0ElsMvzLGkgWS9wJAttHwF2h", authn.OidcDefaultScopes, "select_account", "https://app.localssl.dev/", true) + require.NoError(t, err) + require.NotNil(t, client) + + gin.SetMode(gin.TestMode) + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + c.Request, _ = http.NewRequest(http.MethodGet, "/api/v1/oidc/login", nil) + + client.AuthURLHandler(c) + + // Forwards the configured prompt on the authorization request. + assert.Equal(t, http.StatusFound, w.Code) + loc, locErr := url.Parse(w.Header().Get("Location")) + require.NoError(t, locErr) + assert.Equal(t, "select_account", loc.Query().Get("prompt")) + }) + t.Run("InvalidValueIgnored", func(t *testing.T) { + uri, err := url.Parse("http://dummy-oidc:9998") + require.NoError(t, err) + client, err := NewClient(uri, "csg6yqvykh0780f9", "nd09wkee0ElsMvzLGkgWS9wJAttHwF2h", authn.OidcDefaultScopes, "bogus", "https://app.localssl.dev/", true) + require.NoError(t, err) + require.NotNil(t, client) + + gin.SetMode(gin.TestMode) + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + c.Request, _ = http.NewRequest(http.MethodGet, "/api/v1/oidc/login", nil) + + client.AuthURLHandler(c) + + // An unsupported prompt value is dropped and never breaks the redirect. + assert.Equal(t, http.StatusFound, w.Code) + loc, locErr := url.Parse(w.Header().Get("Location")) + require.NoError(t, locErr) + assert.Empty(t, loc.Query().Get("prompt")) + }) +} + +func TestClient_CodeExchangeUserInfo_NoStateCookie(t *testing.T) { + // A redirect callback without the RP state cookie (e.g. an expired/interrupted + // login) must return an error AND leave the real response untouched, so the + // caller can render a branded page instead of the raw zitadel error. + uri, err := url.Parse("http://dummy-oidc:9998") + require.NoError(t, err) + client, err := NewClient(uri, "csg6yqvykh0780f9", "nd09wkee0ElsMvzLGkgWS9wJAttHwF2h", authn.OidcDefaultScopes, "", "https://app.localssl.dev/", true) + require.NoError(t, err) + require.NotNil(t, client) + + gin.SetMode(gin.TestMode) + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + c.Request, _ = http.NewRequest(http.MethodGet, "/api/v1/oidc/redirect?code=abc&state=xyz", nil) + + userInfo, tokens, exErr := client.CodeExchangeUserInfo(c) + assert.Error(t, exErr) + assert.Nil(t, userInfo) + assert.Nil(t, tokens) + // The recorder absorbed the handler's raw error; the real writer is clean. + assert.Equal(t, http.StatusOK, w.Code) + assert.Empty(t, w.Body.String()) +} diff --git a/internal/auth/oidc/groups.go b/internal/auth/oidc/groups.go index 9ba258795..aca1cc27a 100644 --- a/internal/auth/oidc/groups.go +++ b/internal/auth/oidc/groups.go @@ -37,6 +37,31 @@ func GroupsFromClaims(claims map[string]any, claimName string) (groups []string, return uniqueGroups(groups), overage } +// MergeGroups returns a deduplicated, normalized list of group identifiers +// drawn from one or more source slices (typically the ID token and userinfo +// groups claims, plus any LDAP-derived virtual groups). Empty entries are +// dropped; remaining entries keep first-occurrence order after normalization +// through NormalizeGroupID. Returns nil when no groups remain. +func MergeGroups(sources ...[]string) []string { + total := 0 + + for _, src := range sources { + total += len(src) + } + + if total == 0 { + return nil + } + + merged := make([]string, 0, total) + + for _, src := range sources { + merged = append(merged, src...) + } + + return uniqueGroups(merged) +} + // MapGroupsToRole returns the first matching role for the provided groups using the supplied mapping. func MapGroupsToRole(groups []string, mapping map[string]acl.Role) (acl.Role, bool) { if len(groups) == 0 || len(mapping) == 0 { @@ -52,6 +77,29 @@ func MapGroupsToRole(groups []string, mapping map[string]acl.Role) (acl.Role, bo return acl.RoleNone, false } +// PortalGrantedRole returns the instance login role from the pp_role claim, and +// true only when pp_issuer_kind marks the token as Portal-issued and the role is +// federatable. The issuer-kind gate stops a non-Portal IdP from injecting a role, +// and the federatable check keeps a Portal operator from becoming a login identity. +func PortalGrantedRole(claims map[string]any) (acl.Role, bool) { + if len(claims) == 0 { + return acl.RoleNone, false + } + + if kind, _ := claims["pp_issuer_kind"].(string); kind != acl.RolePortal.String() { + return acl.RoleNone, false + } + + roleName, _ := claims["pp_role"].(string) + role := acl.ParseRole(strings.TrimSpace(roleName)) + + if !acl.IsFederatedRole(role) { + return acl.RoleNone, false + } + + return role, true +} + // HasAnyGroup returns true when at least one of the user's groups matches a required group. func HasAnyGroup(groups []string, required []string) bool { if len(required) == 0 { diff --git a/internal/auth/oidc/groups_test.go b/internal/auth/oidc/groups_test.go index 9714ee4c0..b3ebc5190 100644 --- a/internal/auth/oidc/groups_test.go +++ b/internal/auth/oidc/groups_test.go @@ -32,6 +32,21 @@ func TestGroupsFromClaimsOverage(t *testing.T) { assert.Nil(t, groups) } +func TestMergeGroups(t *testing.T) { + t.Run("Success", func(t *testing.T) { + merged := MergeGroups([]string{"ABC-123", "def-456"}, []string{"def-456", "GHI-789"}) + assert.Equal(t, []string{"abc-123", "def-456", "ghi-789"}, merged) + }) + t.Run("DropsEmptyEntries", func(t *testing.T) { + merged := MergeGroups([]string{"", "abc-123"}, []string{" "}) + assert.Equal(t, []string{"abc-123"}, merged) + }) + t.Run("NoSources", func(t *testing.T) { + assert.Nil(t, MergeGroups()) + assert.Nil(t, MergeGroups(nil, []string{})) + }) +} + func TestMapGroupsToRole(t *testing.T) { mapping := map[string]acl.Role{ "abc-123": acl.RoleAdmin, @@ -51,3 +66,71 @@ func TestHasAnyGroup(t *testing.T) { assert.False(t, HasAnyGroup([]string{"zzz"}, required)) assert.True(t, HasAnyGroup([]string{"zzz"}, nil)) } + +func TestPortalGrantedRole(t *testing.T) { + portal := func(role any) map[string]any { + return map[string]any{"pp_issuer_kind": "portal", "pp_role": role} + } + t.Run("Admin", func(t *testing.T) { + role, ok := PortalGrantedRole(portal("admin")) + assert.True(t, ok) + assert.Equal(t, acl.RoleAdmin, role) + }) + t.Run("Guest", func(t *testing.T) { + role, ok := PortalGrantedRole(portal("guest")) + assert.True(t, ok) + assert.Equal(t, acl.RoleGuest, role) + }) + t.Run("RuntimeRegisteredInstanceRole", func(t *testing.T) { + // Pro/portal builds register extra instance roles (e.g. viewer) into + // acl.UserRoles at startup; the helper must honor whatever is registered. + key := acl.RoleViewer.String() + if _, had := acl.UserRoles[key]; !had { + acl.UserRoles[key] = acl.RoleViewer + defer delete(acl.UserRoles, key) + } + role, ok := PortalGrantedRole(portal("viewer")) + assert.True(t, ok) + assert.Equal(t, acl.RoleViewer, role) + }) + t.Run("WhitespaceTrimmed", func(t *testing.T) { + role, ok := PortalGrantedRole(portal(" admin ")) + assert.True(t, ok) + assert.Equal(t, acl.RoleAdmin, role) + }) + t.Run("ClusterAdminRejected", func(t *testing.T) { + role, ok := PortalGrantedRole(portal("cluster_admin")) + assert.False(t, ok) + assert.Equal(t, acl.RoleNone, role) + }) + t.Run("VisitorRejected", func(t *testing.T) { + role, ok := PortalGrantedRole(portal("visitor")) + assert.False(t, ok) + assert.Equal(t, acl.RoleNone, role) + }) + t.Run("EmptyRole", func(t *testing.T) { + role, ok := PortalGrantedRole(portal("")) + assert.False(t, ok) + assert.Equal(t, acl.RoleNone, role) + }) + t.Run("UnknownRole", func(t *testing.T) { + role, ok := PortalGrantedRole(portal("wizard")) + assert.False(t, ok) + assert.Equal(t, acl.RoleNone, role) + }) + t.Run("NonPortalIssuerKind", func(t *testing.T) { + role, ok := PortalGrantedRole(map[string]any{"pp_issuer_kind": "upstream", "pp_role": "admin"}) + assert.False(t, ok) + assert.Equal(t, acl.RoleNone, role) + }) + t.Run("MissingIssuerKind", func(t *testing.T) { + role, ok := PortalGrantedRole(map[string]any{"pp_role": "admin"}) + assert.False(t, ok) + assert.Equal(t, acl.RoleNone, role) + }) + t.Run("EmptyClaims", func(t *testing.T) { + role, ok := PortalGrantedRole(nil) + assert.False(t, ok) + assert.Equal(t, acl.RoleNone, role) + }) +} diff --git a/internal/auth/oidc/logout.go b/internal/auth/oidc/logout.go new file mode 100644 index 000000000..f6cb23b68 --- /dev/null +++ b/internal/auth/oidc/logout.go @@ -0,0 +1,42 @@ +package oidc + +import ( + "net/url" +) + +// EndSessionURL builds the RP-initiated logout URL for the provider's end_session_endpoint, +// or "" (no error) when none is advertised so callers fall back to a local-only logout. +// The result must be followed by a browser navigation, not a server-side request (only the +// browser carries the provider SSO cookie) — hence building the URL rather than rp.EndSession. +func (c *Client) EndSessionURL(idToken, postLogoutRedirectURI, state string) (string, error) { + endpoint := c.GetEndSessionEndpoint() + + if endpoint == "" { + return "", nil + } + + u, err := url.Parse(endpoint) + + if err != nil { + return "", err + } + + q := u.Query() + q.Set("id_token_hint", idToken) + + if clientID := c.OAuthConfig().ClientID; clientID != "" { + q.Set("client_id", clientID) + } + + if postLogoutRedirectURI != "" { + q.Set("post_logout_redirect_uri", postLogoutRedirectURI) + } + + if state != "" { + q.Set("state", state) + } + + u.RawQuery = q.Encode() + + return u.String(), nil +} diff --git a/internal/auth/oidc/logout_test.go b/internal/auth/oidc/logout_test.go new file mode 100644 index 000000000..4d98e78c2 --- /dev/null +++ b/internal/auth/oidc/logout_test.go @@ -0,0 +1,74 @@ +package oidc + +import ( + "net/url" + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + "github.com/zitadel/oidc/v3/pkg/client/rp" + "golang.org/x/oauth2" +) + +// fakeRelyingParty implements only the rp.RelyingParty methods EndSessionURL reads; any +// other call panics on the nil embedded interface, which keeps the fake honest. +type fakeRelyingParty struct { + rp.RelyingParty + endSession string + clientID string +} + +func (f fakeRelyingParty) GetEndSessionEndpoint() string { return f.endSession } +func (f fakeRelyingParty) OAuthConfig() *oauth2.Config { return &oauth2.Config{ClientID: f.clientID} } + +func TestClient_EndSessionURL(t *testing.T) { + t.Run("Success", func(t *testing.T) { + c := &Client{RelyingParty: fakeRelyingParty{ + endSession: "https://provider.example/logout", + clientID: "client-abc", + }} + + result, err := c.EndSessionURL("id-token-123", "https://app.localssl.dev/library/login", "state-xyz") + require.NoError(t, err) + + u, err := url.Parse(result) + require.NoError(t, err) + assert.Equal(t, "https://provider.example/logout", u.Scheme+"://"+u.Host+u.Path) + + q := u.Query() + assert.Equal(t, "id-token-123", q.Get("id_token_hint")) + assert.Equal(t, "client-abc", q.Get("client_id")) + assert.Equal(t, "https://app.localssl.dev/library/login", q.Get("post_logout_redirect_uri")) + assert.Equal(t, "state-xyz", q.Get("state")) + }) + t.Run("NoEndSessionEndpoint", func(t *testing.T) { + c := &Client{RelyingParty: fakeRelyingParty{endSession: "", clientID: "client-abc"}} + + result, err := c.EndSessionURL("id-token-123", "https://app.localssl.dev/library/login", "") + require.NoError(t, err) + assert.Equal(t, "", result) + }) + t.Run("PreservesExistingQuery", func(t *testing.T) { + c := &Client{RelyingParty: fakeRelyingParty{ + endSession: "https://provider.example/logout?realm=master", + clientID: "client-abc", + }} + + result, err := c.EndSessionURL("id-token-123", "", "") + require.NoError(t, err) + + u, err := url.Parse(result) + require.NoError(t, err) + q := u.Query() + assert.Equal(t, "master", q.Get("realm")) + assert.Equal(t, "id-token-123", q.Get("id_token_hint")) + assert.Equal(t, "", q.Get("post_logout_redirect_uri")) + assert.Equal(t, "", q.Get("state")) + }) + t.Run("InvalidEndpoint", func(t *testing.T) { + c := &Client{RelyingParty: fakeRelyingParty{endSession: "://not a url", clientID: "client-abc"}} + + _, err := c.EndSessionURL("id-token-123", "", "") + assert.Error(t, err) + }) +} diff --git a/internal/auth/oidc/nonce.go b/internal/auth/oidc/nonce.go new file mode 100644 index 000000000..700abce56 --- /dev/null +++ b/internal/auth/oidc/nonce.go @@ -0,0 +1,58 @@ +package oidc + +import ( + "encoding/base64" + "errors" + + "github.com/zitadel/oidc/v3/pkg/oidc" + + "github.com/photoprism/photoprism/pkg/rnd" +) + +// NonceCookie is the name of the signed and encrypted cookie that transports the +// per-request OIDC nonce from the authorization redirect to the callback. +const NonceCookie = "nonce" + +// nonceParam is the OIDC authorization request parameter that carries the nonce. +const nonceParam = "nonce" + +// nonceBytes is the number of random bytes used to generate a nonce. +const nonceBytes = 32 + +// ErrNonceMismatch is returned when an ID token echoes a nonce that does not +// match the value sent on the authorization request. +var ErrNonceMismatch = errors.New("id token nonce does not match") + +// Nonce returns a new random nonce for a single OIDC authorization request, +// base64url-encoded so it is safe to use as a URL query parameter. +func Nonce() (string, error) { + b, err := rnd.RandomBytes(nonceBytes) + + if err != nil { + return "", err + } + + return base64.RawURLEncoding.EncodeToString(b), nil +} + +// CheckNonce validates the ID token's nonce claim against the value sent for the +// authorization request. It tolerates a provider that omits the nonce on a +// session-resumed token (empty claim) so logins do not regress, but rejects a +// non-empty claim that does not match the expected value. +func CheckNonce(expected string, tokens *oidc.Tokens[*oidc.IDTokenClaims]) error { + if tokens == nil || tokens.IDTokenClaims == nil { + return nil + } + + got := tokens.IDTokenClaims.GetNonce() + + if got == "" { + return nil + } + + if got != expected { + return ErrNonceMismatch + } + + return nil +} diff --git a/internal/auth/oidc/nonce_test.go b/internal/auth/oidc/nonce_test.go new file mode 100644 index 000000000..e47660bec --- /dev/null +++ b/internal/auth/oidc/nonce_test.go @@ -0,0 +1,62 @@ +package oidc + +import ( + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + "github.com/zitadel/oidc/v3/pkg/oidc" +) + +func TestNonce(t *testing.T) { + t.Run("Unique", func(t *testing.T) { + a, err := Nonce() + require.NoError(t, err) + b, err := Nonce() + require.NoError(t, err) + assert.NotEmpty(t, a) + assert.NotEmpty(t, b) + assert.NotEqual(t, a, b) + }) + t.Run("UrlSafe", func(t *testing.T) { + n, err := Nonce() + require.NoError(t, err) + // base64url uses A-Z, a-z, 0-9, '-' and '_' only (no padding). + assert.NotContains(t, n, "+") + assert.NotContains(t, n, "/") + assert.NotContains(t, n, "=") + }) +} + +func tokensWithNonce(nonce string) *oidc.Tokens[*oidc.IDTokenClaims] { + return &oidc.Tokens[*oidc.IDTokenClaims]{ + IDTokenClaims: &oidc.IDTokenClaims{ + TokenClaims: oidc.TokenClaims{Nonce: nonce}, + }, + } +} + +func TestCheckNonce(t *testing.T) { + t.Run("Match", func(t *testing.T) { + assert.NoError(t, CheckNonce("abc", tokensWithNonce("abc"))) + }) + t.Run("Absent", func(t *testing.T) { + // A provider that omits the nonce (e.g. a Cognito session-resumed token) + // must not fail verification, even though we sent one. + assert.NoError(t, CheckNonce("abc", tokensWithNonce(""))) + }) + t.Run("Mismatch", func(t *testing.T) { + assert.ErrorIs(t, CheckNonce("abc", tokensWithNonce("xyz")), ErrNonceMismatch) + }) + t.Run("UnexpectedNonce", func(t *testing.T) { + // A nonce echoed without an expected value (e.g. a lost nonce cookie) is + // unverifiable and must be rejected rather than silently accepted. + assert.ErrorIs(t, CheckNonce("", tokensWithNonce("xyz")), ErrNonceMismatch) + }) + t.Run("NilTokens", func(t *testing.T) { + assert.NoError(t, CheckNonce("abc", nil)) + }) + t.Run("NilClaims", func(t *testing.T) { + assert.NoError(t, CheckNonce("abc", &oidc.Tokens[*oidc.IDTokenClaims]{})) + }) +} diff --git a/internal/auth/oidc/oidc.go b/internal/auth/oidc/oidc.go index 1955c1866..7657b0420 100644 --- a/internal/auth/oidc/oidc.go +++ b/internal/auth/oidc/oidc.go @@ -1,7 +1,7 @@ /* Package oidc provides OpenID Connect (OIDC) single sign-on functionality. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/auth/oidc/oidc_test.go b/internal/auth/oidc/oidc_test.go index b32f07bc4..ae3d8effd 100644 --- a/internal/auth/oidc/oidc_test.go +++ b/internal/auth/oidc/oidc_test.go @@ -9,14 +9,17 @@ import ( "github.com/photoprism/photoprism/internal/event" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) int { // Init test logger. log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) event.AuditLog = log // Run unit tests. - code := m.Run() - - os.Exit(code) + return m.Run() } diff --git a/internal/auth/oidc/prompt.go b/internal/auth/oidc/prompt.go new file mode 100644 index 000000000..ba1d780be --- /dev/null +++ b/internal/auth/oidc/prompt.go @@ -0,0 +1,31 @@ +package oidc + +import ( + "strings" + + "github.com/zitadel/oidc/v3/pkg/oidc" +) + +// validPrompts lists the OpenID Connect "prompt" values PhotoPrism accepts on the +// authorization request. PromptNone ("none") is intentionally excluded: it tells the +// provider to never show UI and to error when interaction is required, which would +// break the interactive sign-in this option exists to unblock. +var validPrompts = map[string]bool{ + oidc.PromptLogin: true, + oidc.PromptConsent: true, + oidc.PromptSelectAccount: true, +} + +// ParsePrompt splits a space-separated OIDC "prompt" configuration value into its +// recognized, lowercased values and the unsupported tokens that were ignored. +func ParsePrompt(s string) (valid, invalid []string) { + for _, p := range strings.Fields(s) { + if v := strings.ToLower(p); validPrompts[v] { + valid = append(valid, v) + } else { + invalid = append(invalid, p) + } + } + + return valid, invalid +} diff --git a/internal/auth/oidc/prompt_test.go b/internal/auth/oidc/prompt_test.go new file mode 100644 index 000000000..f2cfc6c70 --- /dev/null +++ b/internal/auth/oidc/prompt_test.go @@ -0,0 +1,42 @@ +package oidc + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestParsePrompt(t *testing.T) { + t.Run("Empty", func(t *testing.T) { + valid, invalid := ParsePrompt("") + assert.Nil(t, valid) + assert.Nil(t, invalid) + }) + t.Run("SingleValue", func(t *testing.T) { + valid, invalid := ParsePrompt("login") + assert.Equal(t, []string{"login"}, valid) + assert.Nil(t, invalid) + }) + t.Run("Combo", func(t *testing.T) { + valid, invalid := ParsePrompt(" select_account consent ") + assert.Equal(t, []string{"select_account", "consent"}, valid) + assert.Nil(t, invalid) + }) + t.Run("Normalizes", func(t *testing.T) { + valid, invalid := ParsePrompt("LOGIN") + assert.Equal(t, []string{"login"}, valid) + assert.Nil(t, invalid) + }) + t.Run("DropsInvalid", func(t *testing.T) { + valid, invalid := ParsePrompt("login bogus consent") + assert.Equal(t, []string{"login", "consent"}, valid) + assert.Equal(t, []string{"bogus"}, invalid) + }) + t.Run("RejectsNone", func(t *testing.T) { + // "none" must not reach the provider: it would suppress the login UI and + // break the interactive sign-in this option exists to unblock. + valid, invalid := ParsePrompt("none") + assert.Nil(t, valid) + assert.Equal(t, []string{"none"}, invalid) + }) +} diff --git a/internal/auth/oidc/redirect_url.go b/internal/auth/oidc/redirect_url.go index ef60e0a2a..ab1b6f8eb 100644 --- a/internal/auth/oidc/redirect_url.go +++ b/internal/auth/oidc/redirect_url.go @@ -24,3 +24,17 @@ func RedirectURL(siteUrl string) (string, error) { return u.String(), nil } + +// CookiePath returns the URL path the OIDC RP state and PKCE cookies are scoped to: +// the OIDC endpoint base under the site URL's path, which covers both the +// /oidc/login leg and the /oidc/redirect callback. Scoping the cookies explicitly +// stops them from depending on a shared-domain reverse proxy rewriting the zitadel +// default Path=/ for the cookies to survive to the callback. +func CookiePath(siteUrl string) string { + u, err := url.Parse(siteUrl) + if err != nil { + return "/" + } + + return path.Dir(path.Join("/", u.Path, config.OidcRedirectUri)) +} diff --git a/internal/auth/oidc/redirect_url_test.go b/internal/auth/oidc/redirect_url_test.go index d05aa9e5f..2f41334da 100644 --- a/internal/auth/oidc/redirect_url_test.go +++ b/internal/auth/oidc/redirect_url_test.go @@ -1,6 +1,7 @@ package oidc import ( + "strings" "testing" "github.com/stretchr/testify/assert" @@ -27,3 +28,25 @@ func TestRedirectURL(t *testing.T) { assert.Empty(t, redirectURL) }) } + +// TestCookiePath verifies the RP cookie path covers both OIDC endpoints for root +// and path-prefixed site URLs, so the state and PKCE cookies survive to the callback. +func TestCookiePath(t *testing.T) { + t.Run("RootPath", func(t *testing.T) { + assert.Equal(t, "/api/v1/oidc", CookiePath("https://app.localssl.dev/")) + }) + t.Run("PortalTenantPath", func(t *testing.T) { + cookiePath := CookiePath("https://app.localssl.dev/i/pro-1/") + assert.Equal(t, "/i/pro-1/api/v1/oidc", cookiePath) + + // The cookie path must be a prefix of both the login leg and the callback so + // the browser returns the state/PKCE cookies on the redirect back. + redirectURL, err := RedirectURL("https://app.localssl.dev/i/pro-1/") + assert.NoError(t, err) + assert.Contains(t, redirectURL, cookiePath+"/redirect") + assert.True(t, strings.HasPrefix("/i/pro-1/api/v1/oidc/login", cookiePath+"/")) + }) + t.Run("NoTrailingSlash", func(t *testing.T) { + assert.Equal(t, "/i/pro-1/api/v1/oidc", CookiePath("https://app.localssl.dev/i/pro-1")) + }) +} diff --git a/internal/auth/oidc/register.go b/internal/auth/oidc/register.go index b26ca7ca5..a1457f14e 100644 --- a/internal/auth/oidc/register.go +++ b/internal/auth/oidc/register.go @@ -18,7 +18,16 @@ func ClientConfig(c *config.Config, t config.ClientType) config.Values { "icon": c.OIDCIcon(), "register": c.OIDCRegister(), "redirect": c.OIDCRedirect(), + // logout lets the UI know sign-out will redirect to the provider's end-session + // endpoint; the backend still drives the actual redirect URL. + "logout": c.OIDCLogout(), "loginUri": c.OIDCLoginUri(), + // cluster lets the frontend route a cluster-OIDC sign-out to the Portal login. + "cluster": c.ClusterOIDC(), + // portalLoginUri is the Portal's browser-facing login page (persisted from + // the register response), so sign-out lands there without re-initiating + // the instance OIDC roundtrip and pinning a return_to. + "portalLoginUri": c.PortalLoginUrl(), } return result diff --git a/internal/auth/oidc/register_test.go b/internal/auth/oidc/register_test.go index 8306a50d6..c89370f78 100644 --- a/internal/auth/oidc/register_test.go +++ b/internal/auth/oidc/register_test.go @@ -9,7 +9,19 @@ import ( ) func TestClientConfig(t *testing.T) { - c := config.NewConfig(config.CliTestContext()) - result := ClientConfig(c, config.ClientPublic) - assert.IsType(t, config.Values{}, result) + t.Run("Default", func(t *testing.T) { + c := config.NewConfig(config.CliTestContext()) + result := ClientConfig(c, config.ClientPublic) + assert.IsType(t, config.Values{}, result) + assert.Equal(t, c.ClusterOIDC(), result["cluster"]) + assert.Equal(t, false, result["cluster"]) + assert.Equal(t, c.OIDCLogout(), result["logout"]) + assert.Equal(t, false, result["logout"]) + }) + t.Run("ClusterOIDC", func(t *testing.T) { + c := config.NewConfig(config.CliTestContext()) + c.Options().ClusterOIDC = true + result := ClientConfig(c, config.ClientPublic) + assert.Equal(t, true, result["cluster"]) + }) } diff --git a/internal/auth/session/cleanup.go b/internal/auth/session/cleanup.go index f497a14fd..cae99b674 100644 --- a/internal/auth/session/cleanup.go +++ b/internal/auth/session/cleanup.go @@ -16,7 +16,7 @@ var CleanupAction = func() { if n := entity.DeleteExpiredSessions(); n > 0 { event.AuditInfo([]string{"deleted %s"}, english.Plural(n, "expired session", "expired sessions")) } else { - event.AuditDebug([]string{"found no expired sessions"}) + event.AuditTrace([]string{"found no expired sessions"}) } } @@ -34,7 +34,7 @@ func Cleanup(interval time.Duration) { ticker.Stop() return case <-ticker.C: - CleanupAction() + event.Safe(CleanupAction) } } }() diff --git a/internal/auth/session/session.go b/internal/auth/session/session.go index c42607494..92a5a0aac 100644 --- a/internal/auth/session/session.go +++ b/internal/auth/session/session.go @@ -1,7 +1,7 @@ /* Package session provides session storage and management. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/auth/session/session_test.go b/internal/auth/session/session_test.go index d11cc13e6..6cdc3af75 100644 --- a/internal/auth/session/session_test.go +++ b/internal/auth/session/session_test.go @@ -11,21 +11,25 @@ import ( "github.com/photoprism/photoprism/pkg/fs" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) int { log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) event.AuditLog = log c := config.TestConfig() + defer c.CleanupTestFolder() + defer func() { + if err := c.CloseDb(); err != nil { + log.Warnf("close db: %v", err) + } + // Remove temporary SQLite files after running the tests. + fs.PurgeTestDbFiles(".", false) + }() - code := m.Run() - - // Remove temporary SQLite files after running the tests. - if err := c.CloseDb(); err != nil { - log.Warnf("close db: %v", err) - } - - fs.PurgeTestDbFiles(".", false) - - os.Exit(code) + return m.Run() } diff --git a/internal/commands/AGENTS.md b/internal/commands/AGENTS.md new file mode 100644 index 000000000..339b15fc6 --- /dev/null +++ b/internal/commands/AGENTS.md @@ -0,0 +1,45 @@ +# Command-Line Guidelines + +**Last Updated:** June 16, 2026 + +## CLI Conventions + +- Prefer shared helpers such as `DryRunFlag(...)` and `YesFlag()` when adding command flags. +- Build CLI role help from the registered role map (never hand-maintained literals) so each edition lists exactly the roles it accepts: `commands.UserRoleUsageFor(<map>)` / `RoleStrings.CliUsageString()`, passing CE `acl.UserRoles` or an edition's own static `auth.UserRoles` (Portal's includes `cluster_admin`; editions reference their own map, not the runtime-reassigned `acl.UserRoles`, to dodge the init-order problem). For federatable or cluster-instance contexts (LDAP `--ldap-role`, OIDC group→role, cluster grants) use `acl.ClusterInstanceRolesCliUsageString()`, which lists the instance-login roles and excludes `cluster_admin`/`visitor`. +- Prefer `--json` for automation. `photoprism show commands --json [--nested]` exposes the command tree; add `--all` for hidden entries. +- Use `internal/commands/catalog` to inspect commands and flags without running the binary; when validating large JSON docs, marshal DTOs with `catalog.BuildFlat` or `catalog.BuildNode`. +- Expect `show` commands to return arrays of snake_case rows, except `photoprism show config`, which returns `{ sections: [...] }`, and `config-options` or `config-yaml`, which flatten to a top-level array. + +## CLI Tests + +- `urfave/cli` calls `os.Exit(code)` when a command returns `cli.Exit(...)`. Wrap command tests with `RunWithTestContext(cmd, args)` so `cli.OsExiter` is overridden and `go test` keeps running. +- If you only need the exit code, call `cmd.Action(ctx)` directly and assert `err.(cli.ExitCoder).ExitCode()`. +- Set `PHOTOPRISM_CLI=noninteractive` and or pass `--yes` to avoid prompts in tests and CI. +- Some commands defer `conf.Shutdown()` or emit signals that close the DB. Avoid invoking `start` or sending process signals in unit tests. +- `internal/commands/start.go` waits on `process.Signal`; avoid `process.Shutdown()` and `process.Restart()` in unit tests. + +## Download CLI Workbench + +Code anchors: +- CLI flags and examples: `internal/commands/download.go` +- Core implementation: `internal/commands/download_impl.go` +- yt-dlp helpers: `internal/photoprism/dl/*` +- Importer entry point: `internal/photoprism/get/import.go` + +Focused runs: +- `go test ./internal/commands -run 'DownloadImpl|HelpFlags' -count=1` +- `go test ./internal/photoprism/dl -run 'Options|Created|PostprocessorArgs' -count=1` + +FFmpeg-less tests: +- Set `c.Options().FFmpegBin = "/bin/false"` and `c.Settings().Index.Convert = false` when the test is not validating remux behavior. + +Stubbing yt-dlp without network: +- Use a small shell script that prints minimal JSON for `--dump-single-json` and creates a file when `--print` is requested. +- Supported harness env vars: `YTDLP_ARGS_LOG`, `YTDLP_OUTPUT_FILE`, and `YTDLP_DUMMY_CONTENT`. + +Remux and defaults: +- Pipe mode always remuxes through PhotoPrism ffmpeg and embeds title, description, and created time. +- File mode relies on yt-dlp output and passes `--postprocessor-args 'ffmpeg:-metadata creation_time=<RFC3339>'` so imports still get `Created`. +- Default remux policy is `auto`; use `always` when you need the most complete metadata. +- `photoprism dl` defaults to `--method pipe` and `--impersonate firefox`; pass `-i none` to disable impersonation. + diff --git a/internal/commands/README.md b/internal/commands/README.md index 2a290d9e7..dfec54ddc 100644 --- a/internal/commands/README.md +++ b/internal/commands/README.md @@ -20,6 +20,42 @@ The `commands` package hosts the CLI implementation for the PhotoPrism binary. C - When integrating configuration options, call the accessors on `*config.Config` (for example, `conf.ClusterUUID()`) rather than mutating option structs directly. - For HTTP interactions, depend on the safe download helpers in `pkg/http/safe` or the specialized wrappers in `internal/thumb/avatar` to inherit timeout, size, and SSRF protection defaults. +### Positional Arguments & Flag Order + +`urfave/cli` v2 delegates flag parsing to the Go stdlib `flag` package, which **stops parsing at the first non-flag token**. For any subcommand that takes a positional argument (for example `photoprism users mod USERNAME --role guest`), flags placed **after** the positional are not parsed — they are returned as additional positionals and `ctx.IsSet(...)` reports `false` for each of them. + +Without guarding for this, an action that conditionally applies values via `if ctx.IsSet("role") { ... }` will silently no-op while still logging success. + +#### Mitigation Helper + +Call `commands.RejectTrailingFlags(ctx)` near the top of every leaf action whose CLI shape is `Action <positional> [--flags...]`. The helper returns a clear `flag "--name" must appear before positional arguments` error when it detects a flag-like token in `ctx.Args().Tail()`, so the user is told to re-order rather than seeing a silent no-op. Pair it with `commands.TrailingFlagToken(ctx)` when the action needs to inspect the offending token before deciding what to do. + +Helper behavior: + +- Single-dash `-` and the `--` terminator are treated as positionals, not flags, so commands like `photoprism backup -` (write to stdout) and `photoprism foo bar -- --literal` keep working. +- Unknown flags placed before the positional are not the helper's concern — `urfave/cli` raises its own "flag provided but not defined" error in that path. +- For commands that use a flag-based identifier instead of a positional, still call the helper after the existence check so trailing flags surface as a usage error rather than a silent ignore. + +The underlying parser limitation is tracked as a known issue for a broader fix; until a global arg-reorder pass lands, all new leaf actions that accept a positional MUST call `RejectTrailingFlags` before applying flag values. + +### Exit Codes + +Wrap errors in `cli.Exit(err, <code>)` so the binary terminates with a non-zero status. A plain `return err` is logged but exits `0`, which hides failures from CI and shell scripts. Pick the code from the table below; cluster, JWT, and Portal commands set the precedent. + +| Code | Meaning | Typical Use | +|------|------------------------------------------|-----------------------------------------------------------------------------------| +| `0` | Success, or user-initiated cancel | normal completion; `ErrCanceled` from a long-running operation | +| `1` | Runtime/execution failure | DB or I/O error, backup/restore failure, indexing failure, `InitConfig` error | +| `2` | Input validation or precondition failure | missing/invalid flag, `RejectTrailingFlags`, read-only mode, malformed identifier | +| `3` | Resource not found | user, node, theme, or other named entity does not exist | +| `4` | Authentication or authorization failure | Portal returned `401` to the CLI | +| `5` | Forbidden / conflict | Portal returned `403` or `409` to the CLI | +| `6` | Rate limited | Portal returned `429` to the CLI | + +`urfave/cli`'s default `ExitErrHandler` calls `os.Exit(c.ExitCode())` only for values that implement `cli.ExitCoder`. A bare `error` flows up to `main()`, which logs it and returns normally — that is, exits `0`. Use `cli.Exit(...)` whenever a non-zero status matters; reserve plain `return err` for helpers that propagate to a caller which itself wraps the result. + +For long-running operations (indexing, importing, backup) that may be canceled by the user, return the underlying `status.ErrCanceled` (or a wrapper) without `cli.Exit` so the CLI exits `0`, and use `cli.Exit(err, 1)` for `status.ErrInsufficientStorage` and other runtime failures so scripts and CI can detect them. + ### Configuration & Flags Integration - Define new options in `internal/config/options.go` with the appropriate struct tags (`yaml`, `json`, `flag`) so they propagate to YAML, CLI, and API layers consistently. diff --git a/internal/commands/UPGRADE.md b/internal/commands/UPGRADE.md new file mode 100644 index 000000000..5b97ca676 --- /dev/null +++ b/internal/commands/UPGRADE.md @@ -0,0 +1,107 @@ +## CLI Framework Upgrade Notes + +**Last Updated:** April 25, 2026 + +This document records the analysis of upgrading the CLI framework +(`github.com/urfave/cli`) from `v2` to `v3`. The current decision is to **stay +on v2** until there is a compelling reason to migrate; this note exists so the +next person to consider it does not have to redo the discovery work. + +### Current State + +- Module pinned in `go.mod`: `github.com/urfave/cli/v2 v2.27.7` +- v2 is still receiving maintenance releases; no v3-only feature is currently + required by PhotoPrism. +- The CLI surface is contractual: every flag and command name is referenced by + Docker entrypoints, compose files, CI pipelines, the developer guide, and + user scripts. Behavioral parity is therefore a hard requirement for any + migration. + +### Scope of a v2 → v3 Migration + +The migration affects four Go modules in lockstep — the public CE repo plus +the `plus/`, `pro/`, and `portal/` private editions, since those import +`internal/commands` and `internal/config`. + +| Surface | CE | plus + pro + portal | Notes | +|-----------------------------------------------|------|---------------------|----------------------------------------------------------------| +| Files importing `urfave/cli/v2` | 62 | ~60 | Every command file plus tests. | +| `cli.Context` references | 118 | 109 | v3 removes `cli.Context` entirely; replaced by `*cli.Command`. | +| `EnvVars:` flag fields | 274 | 132 | Must become `Sources: cli.EnvVars(...)`. | +| `Subcommands:` fields | 28 | several | Renamed to `Commands:` in v3. | +| `cli.NewApp()` / `cli.App{}` | 9 | 4 entry points | v3 collapses `App` into `Command`. | +| `cli.PathFlag` uses | ~20 | 0 | Removed — use `StringFlag` with `TakesFile: true`. | +| `EnableBashCompletion` | 3 | a few | Renamed to `EnableShellCompletion`. | +| `ctx.String/Bool/Int/IsSet/Args` method calls | 219 | 109 | Same names exist on `*cli.Command`, but the receiver changes. | +| `cli.Exit`, `cli.ShowSubcommandHelp` | many | many | Still present in v3 (low impact). | + +There is **no `altsrc` usage**, which removes the most painful migration item. + +### Required Code Changes + +1. **Action handlers** — `func(ctx *cli.Context) error` becomes + `func(ctx context.Context, cmd *cli.Command) error`. Every body that calls + `ctx.String("x")` switches to `cmd.String("x")`. This affects roughly 50 + commands per edition. +2. **Flag definitions** — bulk rewrite `EnvVars: ...` to + `Sources: cli.EnvVars(...)`. The custom `CliFlags` wrapper in + `internal/config/flags.go` (~1100 lines) needs a sweep. +3. **App entry points** — `cmd/photoprism/photoprism.go` plus the three + edition `main.go` files: switch from `cli.NewApp()` to `cli.Command{}`. +4. **`Subcommands` → `Commands`** — including the catalog walker in + `internal/commands/catalog/catalog.go`, which introspects the tree. +5. **`PathFlag`** — replace ~20 occurrences in `internal/config/flags.go` and + a few command files. +6. **Test harness** — `commands_test.go::NewTestContext`, + `RunWithTestContext`, `CliTestContext` in `internal/config/test.go`, plus + `internal/entity/auth_user_test.go`, `internal/commands/mcp_test.go`, + `pkg/txt/report/json_test.go`, and the edition `cmd_test.go` files all + build `cli.App` / `cli.Context` directly. +7. **`Before` hook return signature** changes — currently unused by us. +8. **Catalog and Swagger regeneration** — the CLI catalog reflects on flag + types and would need a v3 rewrite. + +### Risks + +- **Behavioral drift, not just compile errors.** Recent v3 patches have + changed parse semantics (positional args, `--flag=""`, mutually exclusive + flags across parent chains, env-triggered flag actions). Any of these can + break user invocations silently. +- **Help / usage text changes.** v3's default help template differs; + `--help` output drift may break scraping (the `show commands` subtree and + catalog rely on this). +- **Cross-edition consistency.** All four modules must be upgraded together; + a partial migration will not compile. +- **Test surface.** ~270+ test cases use the v2 context; expect a long tail + of fixture rewrites. +- **No automated migration tool.** No `gofix` exists; the work is hand-driven + find-and-replace plus targeted rewrites. + +### Effort Estimate + +Roughly **5–10 focused engineer-days**: + +- ~2 days: mechanical sweep across CE plus three editions (handlers, flags, + App init). +- ~1–2 days: rebuilding the test harness and getting `make test-go` green + across all editions. +- ~1 day: catalog and Swagger regeneration; `show config-options` and + `show commands` parity checks. +- ~1–2 days: end-to-end smoke tests (Docker entrypoints, `photoprism start`, + `cluster register`, `users add`, all `make acceptance-*` targets) to catch + behavioral drift. +- ~1 day: docs and example updates. + +### Decision + +**Hold off on the upgrade.** Revisit when one of the following is true: + +- A specific v3 feature is required (e.g. richer flag sources, + `MutuallyExclusiveFlags`, the new shell-completion model). +- v2 stops receiving security or compatibility fixes. +- The CLI layer is being rewritten for an unrelated reason and the upgrade + can be folded into that work. + +When the time comes, perform the migration on a dedicated branch with one +clean PR per edition, and gate on the full acceptance suite — failure modes +here are predominantly subtle parse behavior, not compile errors. diff --git a/internal/commands/auth_add.go b/internal/commands/auth_add.go index da5b29246..bc023764d 100644 --- a/internal/commands/auth_add.go +++ b/internal/commands/auth_add.go @@ -48,11 +48,20 @@ func authAddAction(ctx *cli.Context) error { // Get username from command flag. userName := clean.Username(ctx.Args().First()) + // Reject flags placed after the username; the stdlib flag parser + // would silently drop them and create the token with the defaults. + if err := RejectTrailingFlags(ctx); err != nil { + return cli.Exit(err, 2) + } + // Find user account. user := entity.FindUserByName(userName) + // Reject creating an app password if the user is unknown or the feature is disabled. if user == nil && userName != "" { - return fmt.Errorf("user %s not found", clean.LogQuote(userName)) + return cli.Exit(fmt.Errorf("user %s not found", clean.LogQuote(userName)), 3) + } else if user != nil && conf.DisableAppPasswords() { + return cli.Exit(fmt.Errorf("app passwords are disabled"), 1) } // Get client name from command flag or ask for it. @@ -67,7 +76,7 @@ func authAddAction(ctx *cli.Context) error { res, err := prompt.Run() if err != nil { - return err + return cli.Exit(err, 1) } clientName = clean.Name(res) @@ -85,7 +94,7 @@ func authAddAction(ctx *cli.Context) error { res, err := prompt.Run() if err != nil { - return err + return cli.Exit(err, 1) } authScope = clean.Scope(res) @@ -95,19 +104,18 @@ func authAddAction(ctx *cli.Context) error { sess, err := entity.AddClientSession(clientName, ctx.Int64("expires"), authScope, authn.GrantCLI, user) if err != nil { - return fmt.Errorf("failed to create authentication secret: %s", err) - } else { - // Show client authentication credentials. - if sess.UserUID == "" { - fmt.Printf("\nPLEASE COPY THE FOLLOWING RANDOMLY GENERATED ACCESS TOKEN AND KEEP IT IN A SAFE PLACE, AS YOU WILL NOT BE ABLE TO SEE IT AGAIN:\n") - fmt.Printf("\n%s\n", report.Credentials("Access Token", sess.AuthToken(), "Authorization Scope", sess.Scope())) - } else { - fmt.Printf("\nPLEASE COPY THE FOLLOWING RANDOMLY GENERATED APP PASSWORD AND KEEP IT IN A SAFE PLACE, AS YOU WILL NOT BE ABLE TO SEE IT AGAIN:\n") - fmt.Printf("\n%s\n", report.Credentials("App Password", sess.AuthToken(), "Authorization Scope", sess.Scope())) - } - + return cli.Exit(fmt.Errorf("failed to create authentication secret: %s", err), 1) } - return err + // Show client authentication credentials. + if sess.UserUID == "" { + fmt.Printf("\nPLEASE COPY THE FOLLOWING RANDOMLY GENERATED ACCESS TOKEN AND KEEP IT IN A SAFE PLACE, AS YOU WILL NOT BE ABLE TO SEE IT AGAIN:\n") + fmt.Printf("\n%s\n", report.Credentials("Access Token", sess.AuthToken(), "Authorization Scope", sess.Scope())) + } else { + fmt.Printf("\nPLEASE COPY THE FOLLOWING RANDOMLY GENERATED APP PASSWORD AND KEEP IT IN A SAFE PLACE, AS YOU WILL NOT BE ABLE TO SEE IT AGAIN:\n") + fmt.Printf("\n%s\n", report.Credentials("App Password", sess.AuthToken(), "Authorization Scope", sess.Scope())) + } + + return nil }) } diff --git a/internal/commands/auth_add_test.go b/internal/commands/auth_add_test.go index 08174b334..ed16e3015 100644 --- a/internal/commands/auth_add_test.go +++ b/internal/commands/auth_add_test.go @@ -4,6 +4,8 @@ import ( "testing" "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/photoprism/get" ) func TestAuthAddCommand(t *testing.T) { @@ -57,4 +59,19 @@ func TestAuthAddCommand(t *testing.T) { assert.Error(t, err) assert.Empty(t, output) }) + t.Run("AppPasswordsDisabled", func(t *testing.T) { + conf := get.Config() + conf.Settings().Features.AppPasswords = false + defer func() { conf.Settings().Features.AppPasswords = true }() + + // Creating an app password for a user account must be rejected when disabled. + output, err := RunWithTestContext(AuthAddCommand, []string{"add", "--scope=metrics", "--expires=5000", "--name=alice", "alice"}) + assert.Error(t, err) + assert.Empty(t, output) + + // A client access token (no user) is unaffected. + output, err = RunWithTestContext(AuthAddCommand, []string{"add", "--scope=test", "--expires=5000", "--name=xyz"}) + assert.NoError(t, err) + assert.Contains(t, output, "Access Token") + }) } diff --git a/internal/commands/auth_list.go b/internal/commands/auth_list.go index 4df4c78b9..bff59409d 100644 --- a/internal/commands/auth_list.go +++ b/internal/commands/auth_list.go @@ -35,7 +35,7 @@ func authListAction(ctx *cli.Context) error { results, err := query.Sessions(ctx.Int("count"), 0, "", ctx.Args().First()) if err != nil { - return err + return cli.Exit(err, 1) } // Show log message. diff --git a/internal/commands/backup.go b/internal/commands/backup.go index 2a4bce8cd..7dd93520f 100644 --- a/internal/commands/backup.go +++ b/internal/commands/backup.go @@ -17,7 +17,9 @@ import ( const backupDescription = `A custom filename for the database backup (or - to send the backup to stdout) can optionally be passed as argument. The --database flag can be omitted in this case. When using Docker, please run the docker command with the -T flag to prevent log messages from being sent to stdout. If nothing else is specified, the database and album backup paths -will be automatically determined based on the current configuration.` +will be automatically determined based on the current configuration. + +Backups to stdout (-), bypass the insufficient storage check, so dumps can be streamed even when the local storage is full.` // BackupCommand configures the command name, flags, and action. var BackupCommand = &cli.Command{ @@ -87,7 +89,7 @@ func backupAction(ctx *cli.Context) error { defer cancel() if err != nil { - return err + return cli.Exit(err, 1) } defer conf.Shutdown() @@ -110,7 +112,7 @@ func backupAction(ctx *cli.Context) error { } if err = backup.Database(databasePath, fileName, fileName == "-", force, retain); err != nil { - return fmt.Errorf("failed to create database backup: %w", err) + return cli.Exit(fmt.Errorf("failed to create database backup: %w", err), 1) } } @@ -124,7 +126,7 @@ func backupAction(ctx *cli.Context) error { } if count, backupErr := backup.Albums(albumsPath, true); backupErr != nil { - return backupErr + return cli.Exit(backupErr, 1) } else { log.Infof("backup: saved %s", english.Plural(count, "album backup", "album backups")) } diff --git a/internal/commands/cameras.go b/internal/commands/cameras.go new file mode 100644 index 000000000..f22ac075a --- /dev/null +++ b/internal/commands/cameras.go @@ -0,0 +1,143 @@ +package commands + +import ( + "fmt" + "strconv" + "strings" + + "github.com/urfave/cli/v2" + + "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/entity/query" + "github.com/photoprism/photoprism/internal/entity/search" + "github.com/photoprism/photoprism/internal/form" + "github.com/photoprism/photoprism/pkg/txt/report" +) + +// CamerasCommand registers the "cameras" CLI command. +var CamerasCommand = &cli.Command{ + Name: "cameras", + Usage: "Camera management subcommands", + Subcommands: []*cli.Command{ + CamerasListCommand, + CamerasUpdateCommand, + }, +} + +// CamerasListCommand registers the list sub command. +var CamerasListCommand = &cli.Command{ + Name: "ls", + Usage: "Lists discovered cameras", + ArgsUsage: "[query]", + Flags: append(report.CliFlags, CountFlag, OffsetFlag, NoMakeFlag), + Action: camerasListAction, +} + +// CamerasUpdateCommand registers the update sub command. +var CamerasUpdateCommand = &cli.Command{ + Name: "update", + Usage: "Updates a specific camera Make and Model", + Flags: []cli.Flag{ + &cli.UintFlag{Name: "id", Usage: "camera id", Required: true}, + &cli.StringFlag{Name: "make", Usage: "the make of the camera", Required: true}, + &cli.StringFlag{Name: "model", Usage: "the model of the camera", Required: true}, + }, + Action: camerasUpdateAction, +} + +// camerasListAction searches the database for cameras. +func camerasListAction(ctx *cli.Context) error { + return CallWithDependencies(ctx, func(conf *config.Config) error { + + filter := strings.TrimSpace(strings.Join(ctx.Args().Slice(), " ")) + // Pagination identical to API defaults. + count := int(ctx.Uint("count")) //nolint:gosec // CLI flag bounded by validation + if count <= 0 || count > 1000 { + count = 100 + } + offset := max(ctx.Int("offset"), 0) + + frm := form.SearchCameras{ + Query: filter, + NoMake: ctx.Bool("nomake"), + Count: count, + Offset: offset, + } + + results, err := search.Cameras(frm) + + if err != nil { + return err + } + + format := report.CliFormat(ctx) + + cols := []string{"ID", "Camera Slug", "Camera Name", "Camera Make", "Camera Model", "Updated At"} + rows := make([][]string, 0, len(results)) + + for _, found := range results { + v := []string{strconv.FormatUint(uint64(found.ID), 10), found.CameraSlug, found.CameraName, found.CameraMake, found.CameraModel, found.UpdatedAt.Format("2006-01-02 15:04:05")} + rows = append(rows, v) + } + + result, err := report.RenderFormat(rows, cols, format) + + if err != nil { + return err + } + + fmt.Println(result) + + return nil + }) +} + +// camerasUpdateAction updates the make and model of a specific camera. +func camerasUpdateAction(ctx *cli.Context) error { + return CallWithDependencies(ctx, func(conf *config.Config) error { + + cameraId := ctx.Uint("id") + cameraMake := ctx.String("make") + cameraModel := ctx.String("model") + + camera := query.FindCameraByID(cameraId) + if camera == nil { + return cli.Exit("camera not found", 1) + } + if err := camera.UpdateMakeModel(cameraMake, cameraModel); err != nil { + return cli.Exit(err, 1) + } + + frm := form.SearchCameras{ + ID: strconv.FormatUint(uint64(camera.ID), 10), + Count: 10, + Offset: 0, + } + + results, err := search.Cameras(frm) + + if err != nil { + return err + } + + format := report.CliFormat(ctx) + + cols := []string{"ID", "Camera Slug", "Camera Name", "Camera Make", "Camera Model", "Updated At"} + rows := make([][]string, 0, len(results)) + + for _, found := range results { + v := []string{strconv.FormatUint(uint64(found.ID), 10), found.CameraSlug, found.CameraName, found.CameraMake, found.CameraModel, found.UpdatedAt.Format("2006-01-02 15:04:05")} + rows = append(rows, v) + } + + result, err := report.RenderFormat(rows, cols, format) + + if err != nil { + return err + } + + fmt.Println(result) + + return nil + }) +} diff --git a/internal/commands/cameras_test.go b/internal/commands/cameras_test.go new file mode 100644 index 000000000..f337e3eba --- /dev/null +++ b/internal/commands/cameras_test.go @@ -0,0 +1,86 @@ +package commands + +import ( + "strconv" + "testing" + + "github.com/stretchr/testify/assert" + "github.com/urfave/cli/v2" + + "github.com/photoprism/photoprism/internal/entity" +) + +func TestCamerasCommand(t *testing.T) { + t.Run("ListNoOptions", func(t *testing.T) { + // Run command with test context. + output, err := RunWithTestContext(CamerasCommand, []string{"cameras", "ls"}) + assert.NoError(t, err) + + // Check command output for plausibility. + for _, expect := range entity.CameraFixtures { + assert.Contains(t, output, strconv.FormatUint(uint64(expect.ID), 10)) + assert.Contains(t, output, expect.CameraSlug) + assert.Contains(t, output, expect.CameraName) + } + }) + t.Run("ListWithCount", func(t *testing.T) { + // Run command with test context. + output, err := RunWithTestContext(CamerasCommand, []string{"cameras", "ls", "--count=1", "--offset=0"}) + assert.NoError(t, err) + + // Canon EOS 7D sorts last by make/model/slug, so it must not appear in the first row. + assert.NotEmpty(t, output) + assert.NotContains(t, output, "1000002") + }) + t.Run("ListWithNoMake", func(t *testing.T) { + // Run command with test context. + output, err := RunWithTestContext(CamerasCommand, []string{"cameras", "ls", "--nomake"}) + assert.NoError(t, err) + + // Only the unknown camera has a blank make. + assert.Contains(t, output, "zz") + assert.Contains(t, output, "Unknown") + assert.NotContains(t, output, "1000002") + assert.NotContains(t, output, "Canon EOS 7D") + }) + t.Run("UpdateWithNoModel", func(t *testing.T) { + // Run command with test context. + output, err := RunWithTestContext(CamerasCommand, []string{"cameras", "update", "--id=1000002", "--make=Nikon"}) + assert.Error(t, err) + assert.Len(t, output, 0) + assert.Contains(t, err.Error(), `Required flag "model" not set`) + }) + t.Run("UpdateWithNoMake", func(t *testing.T) { + // Run command with test context. + output, err := RunWithTestContext(CamerasCommand, []string{"cameras", "update", "--id=1000002", `--model=K-1`}) + assert.Error(t, err) + assert.Len(t, output, 0) + assert.Contains(t, err.Error(), `Required flag "make" not set`) + }) + t.Run("UpdateWithEmptyMakeAndModel", func(t *testing.T) { + // Explicit empty strings satisfy the Required flag check, so the guard in UpdateMakeModel + // must reject them to prevent blanking a camera. + output, err := RunWithTestContext(CamerasCommand, []string{"cameras", "update", "--id=1000002", "--make=", "--model="}) + assert.Error(t, err) + assert.Len(t, output, 0) + assert.Contains(t, err.Error(), "make and model must not be empty") + var exitErr cli.ExitCoder + if assert.ErrorAs(t, err, &exitErr) { + assert.Equal(t, 1, exitErr.ExitCode()) + } + }) + t.Run("UpdateValid", func(t *testing.T) { + defer func() { + entity.FlushCameraCache() + assert.NoError(t, entity.Db().Save(entity.CameraFixtures.Pointer("canon-eos-7d")).Error) + }() + // Run command with test context. + output, err := RunWithTestContext(CamerasCommand, []string{"cameras", "update", "--id=1000002", "--make=Pentax", `--model=K-1`}) + assert.NoError(t, err) + + // Check command output for plausibility. + assert.Contains(t, output, "Updated At") + assert.Contains(t, output, "PENTAX K-1") + assert.Contains(t, output, "1000002") + }) +} diff --git a/internal/commands/catalog/catalog.go b/internal/commands/catalog/catalog.go index 3c4bb5aca..98ddda0e1 100644 --- a/internal/commands/catalog/catalog.go +++ b/internal/commands/catalog/catalog.go @@ -1,7 +1,7 @@ /* Package catalog provides DTOs, builders, and a templated renderer to export the PhotoPrism CLI command tree (and flags) as Markdown or JSON for documentation purposes. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/commands/cli_args.go b/internal/commands/cli_args.go new file mode 100644 index 000000000..abe0d9adf --- /dev/null +++ b/internal/commands/cli_args.go @@ -0,0 +1,37 @@ +package commands + +import ( + "fmt" + "strings" + + "github.com/urfave/cli/v2" +) + +// TrailingFlagToken returns the first arg after the leading positional that +// looks like a CLI flag (e.g. "--name" or "-r"). +// +// urfave/cli v2 delegates flag parsing to the stdlib flag package, which +// stops at the first non-flag token; flags placed after a positional are +// silently ignored. Callers use this helper to reject such invocations +// instead of acting on a context with the supplied flag values dropped. +func TrailingFlagToken(ctx *cli.Context) string { + for _, a := range ctx.Args().Tail() { + if a == "--" { + return "" + } + if strings.HasPrefix(a, "-") && len(a) > 1 { + return a + } + } + return "" +} + +// RejectTrailingFlags returns a usage error when flag-like tokens appear after +// the leading positional argument, naming the first offending token so users +// can fix the invocation rather than seeing a silent no-op. +func RejectTrailingFlags(ctx *cli.Context) error { + if tok := TrailingFlagToken(ctx); tok != "" { + return fmt.Errorf("flag %q must appear before positional arguments", tok) + } + return nil +} diff --git a/internal/commands/cli_args_test.go b/internal/commands/cli_args_test.go new file mode 100644 index 000000000..58e89ae9c --- /dev/null +++ b/internal/commands/cli_args_test.go @@ -0,0 +1,55 @@ +package commands + +import ( + "flag" + "testing" + + "github.com/stretchr/testify/assert" + "github.com/urfave/cli/v2" +) + +func TestTrailingFlagToken(t *testing.T) { + cases := []struct { + name string + args []string + want string + }{ + {"NoTail", []string{"alice"}, ""}, + {"OnlyPositionals", []string{"alice", "bob"}, ""}, + {"LongFlagAfterPositional", []string{"alice", "--name", "Alicia"}, "--name"}, + {"EqualsFlagAfterPositional", []string{"alice", "--role=guest"}, "--role=guest"}, + {"ShortFlagAfterPositional", []string{"alice", "-r", "guest"}, "-r"}, + {"BareDashIsPositional", []string{"alice", "-"}, ""}, + {"DoubleDashStopsScan", []string{"alice", "--", "--name", "literal"}, ""}, + } + + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + set := flag.NewFlagSet("test", flag.ContinueOnError) + if err := set.Parse(tc.args); err != nil { + t.Fatalf("flag parse: %v", err) + } + ctx := cli.NewContext(nil, set, nil) + assert.Equal(t, tc.want, TrailingFlagToken(ctx)) + }) + } +} + +func TestRejectTrailingFlags(t *testing.T) { + t.Run("NoTrailingFlag", func(t *testing.T) { + set := flag.NewFlagSet("test", flag.ContinueOnError) + _ = set.Parse([]string{"alice"}) + ctx := cli.NewContext(nil, set, nil) + assert.NoError(t, RejectTrailingFlags(ctx)) + }) + t.Run("TrailingFlagReturnsError", func(t *testing.T) { + set := flag.NewFlagSet("test", flag.ContinueOnError) + _ = set.Parse([]string{"alice", "--name", "Alicia"}) + ctx := cli.NewContext(nil, set, nil) + err := RejectTrailingFlags(ctx) + if assert.Error(t, err) { + assert.Contains(t, err.Error(), "--name") + assert.Contains(t, err.Error(), "must appear before positional arguments") + } + }) +} diff --git a/internal/commands/clients.go b/internal/commands/clients.go index 6d95b86d4..1577f08b9 100644 --- a/internal/commands/clients.go +++ b/internal/commands/clients.go @@ -27,7 +27,7 @@ const ( ) var ( - // ClientRoleUsage describes allowed client roles for CLI help. + // ClientRoleUsage describes the assignable client roles for CLI help. ClientRoleUsage = fmt.Sprintf("client authorization `ROLE`, e.g. %s", acl.ClientRoles.CliUsageString()) ) diff --git a/internal/commands/clients_add.go b/internal/commands/clients_add.go index 7bebb8e54..20a49646f 100644 --- a/internal/commands/clients_add.go +++ b/internal/commands/clients_add.go @@ -31,6 +31,12 @@ func clientsAddAction(ctx *cli.Context) error { return CallWithDependencies(ctx, func(conf *config.Config) error { conf.MigrateDb(false, nil) + // Reject flags placed after the username; the stdlib flag parser + // would silently drop them and register the client with the defaults. + if err := RejectTrailingFlags(ctx); err != nil { + return err + } + frm := form.AddClientFromCli(ctx) interactive := true diff --git a/internal/commands/clients_flags_test.go b/internal/commands/clients_flags_test.go index 7f6d73472..c4a39e4a4 100644 --- a/internal/commands/clients_flags_test.go +++ b/internal/commands/clients_flags_test.go @@ -7,8 +7,8 @@ import ( "github.com/urfave/cli/v2" ) -func TestClientRoleFlagUsage_IncludesNoneAlias(t *testing.T) { - t.Run("AddCommandRoleFlagIncludesNone", func(t *testing.T) { +func TestClientRoleFlagUsage_ExcludesNoneAlias(t *testing.T) { + t.Run("AddCommandRoleFlagExcludesNone", func(t *testing.T) { var roleFlag *cli.StringFlag for _, f := range ClientsAddCommand.Flags { if rf, ok := f.(*cli.StringFlag); ok && rf.Name == "role" { @@ -19,9 +19,12 @@ func TestClientRoleFlagUsage_IncludesNoneAlias(t *testing.T) { if roleFlag == nil { t.Fatal("role flag not found on ClientsAddCommand") } - assert.Contains(t, roleFlag.Usage, "none") + // Real client roles are listed; the "none" alias is excluded. + assert.Contains(t, roleFlag.Usage, "client") + assert.Contains(t, roleFlag.Usage, "service") + assert.NotContains(t, roleFlag.Usage, "none") }) - t.Run("ModCommandRoleFlagIncludesNone", func(t *testing.T) { + t.Run("ModCommandRoleFlagExcludesNone", func(t *testing.T) { var roleFlag *cli.StringFlag for _, f := range ClientsModCommand.Flags { if rf, ok := f.(*cli.StringFlag); ok && rf.Name == "role" { @@ -32,6 +35,8 @@ func TestClientRoleFlagUsage_IncludesNoneAlias(t *testing.T) { if roleFlag == nil { t.Fatal("role flag not found on ClientsModCommand") } - assert.Contains(t, roleFlag.Usage, "none") + assert.Contains(t, roleFlag.Usage, "client") + assert.Contains(t, roleFlag.Usage, "service") + assert.NotContains(t, roleFlag.Usage, "none") }) } diff --git a/internal/commands/clients_mod.go b/internal/commands/clients_mod.go index ba9150ec0..746b75f35 100644 --- a/internal/commands/clients_mod.go +++ b/internal/commands/clients_mod.go @@ -34,6 +34,12 @@ func clientsModAction(ctx *cli.Context) error { return cli.ShowSubcommandHelp(ctx) } + // Reject flags placed after the client id; the stdlib flag parser + // would silently drop them and report "client updated" with no changes. + if err := RejectTrailingFlags(ctx); err != nil { + return err + } + // Find client record. client := entity.FindClientByUID(frm.ID()) diff --git a/internal/commands/cluster_helpers.go b/internal/commands/cluster_helpers.go index 2b227df30..2ab2d97c5 100644 --- a/internal/commands/cluster_helpers.go +++ b/internal/commands/cluster_helpers.go @@ -31,7 +31,7 @@ func obtainClientCredentialsViaRegister(portalURL, joinToken, nodeName string) ( NodeRole: cluster.RoleInstance, RotateSecret: true, } - b, _ := json.Marshal(payload) + b := marshalRegisterRequest(payload) // endpoint is derived from a parsed portal URL with explicit scheme/host validation above. req, _ := http.NewRequest(http.MethodPost, endpoint.String(), bytes.NewReader(b)) //nolint:gosec req.Header.Set("Content-Type", "application/json") @@ -63,6 +63,15 @@ func obtainClientCredentialsViaRegister(portalURL, joinToken, nodeName string) ( return id, secret, nil } +// marshalRegisterRequest JSON-encodes a cluster register payload for portal requests. +func marshalRegisterRequest(payload cluster.RegisterRequest) []byte { + // Register requests may intentionally include client credentials when + // re-registering a node or rotating its secret. + b, _ := json.Marshal(payload) //nolint:gosec + + return b +} + // clusterAuditWho builds the leading audit log segments for CLI commands. func clusterAuditWho(ctx *cli.Context, conf *config.Config) []string { actor := clean.Log(conf.NodeName()) diff --git a/internal/commands/cluster_nodes_mod.go b/internal/commands/cluster_nodes_mod.go index c4f1e1e70..43d437846 100644 --- a/internal/commands/cluster_nodes_mod.go +++ b/internal/commands/cluster_nodes_mod.go @@ -9,6 +9,7 @@ import ( "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/internal/service/cluster" reg "github.com/photoprism/photoprism/internal/service/cluster/registry" @@ -18,9 +19,10 @@ import ( // flags for nodes mod var ( - nodesModRoleFlag = &cli.StringFlag{Name: "role", Aliases: []string{"t"}, Usage: "node `ROLE` (portal, instance, service)"} - nodesModInternal = &cli.StringFlag{Name: "advertise-url", Aliases: []string{"i"}, Usage: "internal service `URL`"} - nodesModLabel = &cli.StringSliceFlag{Name: "label", Aliases: []string{"l"}, Usage: "`k=v` label (repeatable)"} + nodesModRoleFlag = &cli.StringFlag{Name: "role", Aliases: []string{"t"}, Usage: "node `ROLE` (portal, instance, service)"} + nodesModInternal = &cli.StringFlag{Name: "advertise-url", Aliases: []string{"i"}, Usage: "internal service `URL`"} + nodesModLabel = &cli.StringSliceFlag{Name: "label", Aliases: []string{"l"}, Usage: "`k=v` label (repeatable)"} + nodesModDisplayName = &cli.StringFlag{Name: "display-name", Aliases: []string{"d"}, Usage: "human-friendly display `NAME` (admin override; empty clears it)"} ) // ClusterNodesModCommand updates node fields. @@ -33,6 +35,7 @@ var ClusterNodesModCommand = &cli.Command{ nodesModRoleFlag, nodesModInternal, nodesModLabel, + nodesModDisplayName, YesFlag(), }, Hidden: true, // Required for cluster-management only. @@ -88,6 +91,13 @@ func clusterNodesModAction(ctx *cli.Context) error { n.AdvertiseUrl = v changes = append(changes, fmt.Sprintf("advertise-url=%s", clean.Log(n.AdvertiseUrl))) } + // IsSet distinguishes an explicit (possibly empty) override from an absent + // flag: an empty value un-pins and falls back to the instance-reported name. + if ctx.IsSet("display-name") { + n.DisplayName = clean.TypeUnicode(strings.TrimSpace(ctx.String("display-name"))) + n.NameSrc = entity.SrcManual + changes = append(changes, fmt.Sprintf("display-name=%s", clean.Log(n.DisplayName))) + } if labels := ctx.StringSlice("label"); len(labels) > 0 { if n.Labels == nil { n.Labels = map[string]string{} diff --git a/internal/commands/cluster_nodes_mod_test.go b/internal/commands/cluster_nodes_mod_test.go index f36785bea..f735f42f1 100644 --- a/internal/commands/cluster_nodes_mod_test.go +++ b/internal/commands/cluster_nodes_mod_test.go @@ -39,6 +39,45 @@ func TestClusterNodesMod_LegacyAliasAppToInstance(t *testing.T) { } } +func TestClusterNodesMod_DisplayNameOverride(t *testing.T) { + c := get.Config() + prevEdition := c.Options().Edition + prevRole := c.Options().NodeRole + c.Options().Edition = config.Portal + c.Options().NodeRole = cluster.RolePortal + t.Cleanup(func() { + c.Options().Edition = prevEdition + c.Options().NodeRole = prevRole + }) + + r, err := reg.NewClientRegistryWithConfig(c) + assert.NoError(t, err) + + // Instance reports a display name on registration. + assert.NoError(t, r.Put(®.Node{Node: cluster.Node{Name: "pp-mod-dn", Role: cluster.RoleInstance, DisplayName: "Reported"}})) + + // Admin override pins a new value. + _, err = RunWithTestContext(ClusterNodesModCommand, []string{"mod", "--display-name=Pinned Name", "-y", "pp-mod-dn"}) + assert.NoError(t, err) + updated, err := r.FindByName("pp-mod-dn") + assert.NoError(t, err) + if !assert.NotNil(t, updated) { + return + } + assert.Equal(t, "Pinned Name", updated.DisplayName) + + // A subsequent instance registration must not overwrite the pinned override. + assert.NoError(t, r.Put(®.Node{Node: cluster.Node{ClientID: updated.ClientID, Name: updated.Name, DisplayName: "Reported Again"}})) + updated, _ = r.FindByName("pp-mod-dn") + assert.Equal(t, "Pinned Name", updated.DisplayName) + + // Clearing via an empty override un-pins and falls back to instance-reported. + _, err = RunWithTestContext(ClusterNodesModCommand, []string{"mod", "--display-name=", "-y", "pp-mod-dn"}) + assert.NoError(t, err) + updated, _ = r.FindByName("pp-mod-dn") + assert.Equal(t, "", updated.DisplayName) +} + func TestClusterNodesMod_InvalidRole(t *testing.T) { c := get.Config() prevEdition := c.Options().Edition diff --git a/internal/commands/cluster_nodes_rotate.go b/internal/commands/cluster_nodes_rotate.go index 0cdbef62e..af365f85c 100644 --- a/internal/commands/cluster_nodes_rotate.go +++ b/internal/commands/cluster_nodes_rotate.go @@ -158,7 +158,7 @@ func clusterNodesRotateAction(ctx *cli.Context) error { payload.Theme = themeVersion } - b, _ := json.Marshal(payload) + b := marshalRegisterRequest(payload) endpointUrl := stringsTrimRightSlash(portalURL) + "/api/v1/cluster/nodes/register" diff --git a/internal/commands/cluster_register.go b/internal/commands/cluster_register.go index 73f577d80..e7169b179 100644 --- a/internal/commands/cluster_register.go +++ b/internal/commands/cluster_register.go @@ -20,6 +20,7 @@ import ( "github.com/photoprism/photoprism/internal/service/cluster" "github.com/photoprism/photoprism/internal/service/cluster/theme" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/http/header" "github.com/photoprism/photoprism/pkg/log/status" "github.com/photoprism/photoprism/pkg/rnd" @@ -156,7 +157,7 @@ func clusterRegisterAction(ctx *cli.Context) error { if themeVersion, err := theme.DetectVersion(conf.ThemePath()); err == nil && themeVersion != "" { payload.Theme = themeVersion } - b, _ := json.Marshal(payload) + b := marshalRegisterRequest(payload) // In dry-run, we allow empty portalURL (will print derived/empty values). if ctx.Bool("dry-run") { @@ -469,7 +470,7 @@ func persistRegisterResponse(conf *config.Config, resp *cluster.RegisterResponse if resp.Database.Name != "" && resp.Database.User != "" { driver := strings.TrimSpace(resp.Database.Driver) if driver == "" { - driver = config.MySQL + driver = dsn.DriverMySQL } updates.SetDatabaseDriver(driver) updates.SetDatabaseName(resp.Database.Name) diff --git a/internal/commands/cluster_register_http_test.go b/internal/commands/cluster_register_http_test.go index d3f049253..af31182ff 100644 --- a/internal/commands/cluster_register_http_test.go +++ b/internal/commands/cluster_register_http_test.go @@ -117,7 +117,7 @@ func TestClusterRegister_WriteConfig_PersistsSecretFileOnly(t *testing.T) { ClientSecret: cluster.ExampleClientSecret, }, Database: cluster.RegisterDatabase{ - Driver: cfg.MySQL, + Driver: dsn.DriverMySQL, Host: "database", Port: 3306, Name: "pp_db", diff --git a/internal/commands/commands.go b/internal/commands/commands.go index 8c00e2716..f2350ac03 100644 --- a/internal/commands/commands.go +++ b/internal/commands/commands.go @@ -1,7 +1,7 @@ /* Package commands provides the CLI commands of PhotoPrism. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. @@ -61,6 +61,8 @@ var PhotoPrism = []*cli.Command{ DownloadCommand, VisionCommands, FacesCommands, + CamerasCommand, + LensesCommand, PlacesCommands, PurgeCommand, CleanUpCommand, @@ -79,6 +81,7 @@ var PhotoPrism = []*cli.Command{ ClientsCommands, ClusterCommands, AuthCommands, + MCPCommands, ShowCommands, VersionCommand, EditionCommand, diff --git a/internal/commands/commands_test.go b/internal/commands/commands_test.go index 8344a13db..c862d8ce8 100644 --- a/internal/commands/commands_test.go +++ b/internal/commands/commands_test.go @@ -21,7 +21,12 @@ import ( // "config: database not connected" during test runs, consider moving shutdown // behavior behind an interface or gating it for tests. +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) int { _ = os.Setenv("TF_CPP_MIN_LOG_LEVEL", "3") log = logrus.StandardLogger() @@ -35,8 +40,18 @@ func TestMain(m *testing.M) { if err != nil { panic(err) } + defer os.RemoveAll(tempDir) c := config.NewMinimalTestConfigWithDb("commands", tempDir) + defer c.CleanupTestFolder() + defer func() { + if err := c.CloseDb(); err != nil { + log.Warnf("close db: %v", err) + } + // Remove temporary SQLite files after running the tests. + fs.PurgeTestDbFiles(".", false) + }() + get.SetConfig(c) // Keep DB connection open for the duration of this package's tests to @@ -47,19 +62,15 @@ func TestMain(m *testing.M) { return c, c.Init() } - // Run unit tests. - code := m.Run() - - if err = c.CloseDb(); err != nil { - log.Warnf("close db: %v", err) + // Init core config (no database) using the shared test config so commands + // like "show config" and "faces config" don't fall back to a storage path + // derived from the real originals directory. + InitCoreConfig = func(ctx *cli.Context, quiet bool) (*config.Config, error) { + return c, c.InitCore() } - _ = os.RemoveAll(tempDir) - - // Remove temporary SQLite files after running the tests. - fs.PurgeTestDbFiles(".", false) - - os.Exit(code) + // Run unit tests. + return m.Run() } // SetEnvForTest sets an environment variable and restores its original value after the test. @@ -95,7 +106,7 @@ func NewTestContext(args []string) *cli.Context { app.Usage = "PhotoPrism®" app.Description = "" app.Version = "test" - app.Copyright = "(c) 2018-2025 PhotoPrism UG. All rights reserved." + app.Copyright = "(c) 2018-2026 PhotoPrism UG. All rights reserved." app.Flags = config.Flags.Cli() app.Commands = PhotoPrism app.HelpName = app.Name @@ -128,9 +139,19 @@ func RunWithTestContext(cmd *cli.Command, args []string) (output string, err err // a nil pointer panic in the "github.com/urfave/cli/v2" package. cmd.HideHelp = true - // Ensure DB connection is open for each command run (some commands call Shutdown). - if c := get.Config(); c != nil { - c.RegisterDb() // (re)register provider + // Snapshot the database connection settings before running the command. A + // command that rewrites them (e.g. cluster register persisting provisioned + // MySQL credentials) would otherwise make the post-command RegisterDb() below + // block in connectDb's 60s retry loop reaching for a server that isn't there. + c := get.Config() + var o *config.Options + var driver, dsn, name, server, user, password string + if c != nil { + o = c.Options() + driver, dsn, name = o.DatabaseDriver, o.DatabaseDSN, o.DatabaseName + server, user, password = o.DatabaseServer, o.DatabaseUser, o.DatabasePassword + // Ensure DB connection is open for each command run (some commands call Shutdown). + c.RegisterDb() } // Run command via cli.Command.Run but neutralize os.Exit so ExitCoder @@ -142,9 +163,12 @@ func RunWithTestContext(cmd *cli.Command, args []string) (output string, err err err = cmd.Run(ctx, args...) }) - // Re-open the database after the command completed so follow-up checks - // (potentially issued by the test itself) have an active connection. - if c := get.Config(); c != nil { + // Restore the original connection settings, then re-open so follow-up checks + // (potentially issued by the test itself) reconnect to the per-suite SQLite + // test DB rather than whatever server the command may have configured. + if c != nil { + o.DatabaseDriver, o.DatabaseDSN, o.DatabaseName = driver, dsn, name + o.DatabaseServer, o.DatabaseUser, o.DatabasePassword = server, user, password c.RegisterDb() } diff --git a/internal/commands/config.go b/internal/commands/config.go index 84d7bfb95..7678c95a9 100644 --- a/internal/commands/config.go +++ b/internal/commands/config.go @@ -1,10 +1,12 @@ package commands import ( + "github.com/sirupsen/logrus" "github.com/urfave/cli/v2" "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/photoprism/get" + "github.com/photoprism/photoprism/internal/service/hub" ) // InitConfig initializes the command config. @@ -13,3 +15,16 @@ var InitConfig = func(ctx *cli.Context) (*config.Config, error) { get.SetConfig(c) return c, c.Init() } + +// InitCoreConfig initializes the command core config without connecting to the +// database. When quiet is true, the log level is raised to fatal so only the +// command's own output is printed (used by the config report commands). +var InitCoreConfig = func(ctx *cli.Context, quiet bool) (*config.Config, error) { + c := config.NewConfig(ctx) + if quiet { + c.SetLogLevel(logrus.FatalLevel) + } + get.SetConfig(c) + hub.Disable() + return c, c.InitCore() +} diff --git a/internal/commands/download.go b/internal/commands/download.go index 00f31e456..18952dac5 100644 --- a/internal/commands/download.go +++ b/internal/commands/download.go @@ -261,6 +261,12 @@ func downloadAction(ctx *cli.Context) error { continue } + if matched := ffmpeg.Exclude().Match(result.Info.VCodec, result.Info.Ext, result.Info.Container); matched != "" { + log.Warnf("skipping %s because format %s is on the FFmpeg exclude list", clean.Log(u.String()), clean.Log(matched)) + failures++ + continue + } + // Best-effort creation time for file method when not remuxing locally. if ytRemux { if created := dl.CreatedFromInfo(result.Info); !created.IsZero() { @@ -340,6 +346,10 @@ func downloadAction(ctx *cli.Context) error { if dlErr != nil { log.Errorf("download failed: %v", dlErr) // even on error, any completed files returned will be imported + if len(files) == 0 { + failures++ + continue + } } // Ensure container/metadata per remux policy for file method @@ -370,13 +380,13 @@ func downloadAction(ctx *cli.Context) error { elapsed := time.Since(start) if failures > 0 { - log.Warnf("completed with %d error(s) in %s", failures, elapsed) + log.Warnf("completed with %s in %s", formatCount(failures, "error", "errors"), elapsed) } else { log.Infof("completed in %s", elapsed) } if failures > 0 { - return fmt.Errorf("some downloads failed: %d", failures) + return fmt.Errorf("%s", formatFailedCount(failures, "download", "downloads")) } return nil diff --git a/internal/commands/download_e2e_test.go b/internal/commands/download_e2e_test.go index 2bb6f9ef6..0fc386795 100644 --- a/internal/commands/download_e2e_test.go +++ b/internal/commands/download_e2e_test.go @@ -3,6 +3,7 @@ package commands import ( + "bytes" "os" "path/filepath" "runtime" @@ -36,6 +37,7 @@ func createFakeYtDlp(t *testing.T) string { if derr != nil { t.Fatalf("failed to create temp dir: %v", derr) } + t.Cleanup(func() { os.RemoveAll(dir) }) path := filepath.Join(dir, "yt-dlp") if runtime.GOOS == "windows" { // Not needed in CI/dev container. Keep simple stub. @@ -58,7 +60,7 @@ func createFakeYtDlp(t *testing.T) string { b.WriteString("for a in \"$@\"; do if [[ \"$a\" == \"--version\" ]]; then echo '2025.09.23'; exit 0; fi; done\n") b.WriteString("OUT_TPL=\"\"\n") b.WriteString("i=0; while [[ $i -lt $# ]]; do i=$((i+1)); arg=\"${!i}\"; if [[ \"$arg\" == \"--dump-single-json\" ]]; then echo '{\"id\":\"abc\",\"title\":\"Test\",\"url\":\"http://example.com\",\"_type\":\"video\"}'; exit 0; fi; if [[ \"$arg\" == \"--output\" ]]; then i=$((i+1)); OUT_TPL=\"${!i}\"; fi; done\n") - b.WriteString("if [[ $* == *'--print '* ]]; then OUT=\"$OUT_TPL\"; OUT=${OUT//%(id)s/abc}; OUT=${OUT//%(ext)s/mp4}; mkdir -p \"$(dirname \"$OUT\")\"; CONTENT=\"${YTDLP_DUMMY_CONTENT:-dummy}\"; echo \"$CONTENT\" > \"$OUT\"; echo \"$OUT\"; exit 0; fi\n") + b.WriteString("if [[ $* == *'--print '* ]]; then if [[ \"${YTDLP_FAIL_FILE_DOWNLOAD:-}\" == \"1\" ]]; then echo 'simulated yt-dlp failure' 1>&2; exit 1; fi; OUT=\"$OUT_TPL\"; OUT=${OUT//%(id)s/abc}; OUT=${OUT//%(ext)s/mp4}; mkdir -p \"$(dirname \"$OUT\")\"; CONTENT=\"${YTDLP_DUMMY_CONTENT:-dummy}\"; echo \"$CONTENT\" > \"$OUT\"; echo \"$OUT\"; exit 0; fi\n") if err := os.WriteFile(path, []byte(b.String()), 0o755); err != nil { t.Fatalf("failed to write fake yt-dlp: %v", err) } @@ -217,9 +219,63 @@ func TestDownloadImpl_FileMethod_Always_RemuxFails(t *testing.T) { if err == nil { t.Fatalf("expected failure when remux is required but ffmpeg is unavailable") } + if err.Error() != "1 download failed" { + t.Fatalf("unexpected error: %v", err) + } // Cleanup destination folder if anything was created c := get.Config() outDir := filepath.Join(c.OriginalsPath(), dest) _ = os.RemoveAll(outDir) } + +func TestDownloadImpl_FileMethod_ErrorWithoutFilesCountsFailure(t *testing.T) { + t.Setenv("YTDLP_FORCE_SHELL", "1") + t.Setenv("YTDLP_FAIL_FILE_DOWNLOAD", "1") + dl.ResetVersionWarningForTest() + + fake := createFakeYtDlp(t) + orig := dl.YtDlpBin + defer func() { dl.YtDlpBin = orig }() + + dest := "dl-e2e-file-error" + if c := get.Config(); c != nil { + c.Options().FFmpegBin = "/bin/false" + s := c.Settings() + s.Index.Convert = false + } + conf := get.Config() + if conf == nil { + t.Fatalf("missing test config") + } + + conf.RegisterDb() + dl.YtDlpBin = fake + + var logOutput bytes.Buffer + log.SetOutput(&logOutput) + t.Cleanup(func() { + log.SetOutput(os.Stderr) + }) + + var err error + err = runDownload(conf, DownloadOpts{ + Dest: dest, + Method: "file", + FileRemux: "skip", + }, []string{"https://example.com/video"}) + + if err == nil { + t.Fatalf("expected file method failure when yt-dlp returns no files") + } + if err.Error() != "1 download failed" { + t.Fatalf("unexpected error: %v", err) + } + if !strings.Contains(logOutput.String(), "completed with 1 error in") { + t.Fatalf("expected singularized summary log, got: %q", logOutput.String()) + } + + c := get.Config() + outDir := filepath.Join(c.OriginalsPath(), dest) + _ = os.RemoveAll(outDir) +} diff --git a/internal/commands/download_impl.go b/internal/commands/download_impl.go index e2cf95169..b6e4daca5 100644 --- a/internal/commands/download_impl.go +++ b/internal/commands/download_impl.go @@ -165,6 +165,12 @@ func runDownload(conf *config.Config, opts DownloadOpts, inputURLs []string) err continue } + if matched := ffmpeg.Exclude().Match(result.Info.VCodec, result.Info.Ext, result.Info.Container); matched != "" { + log.Warnf("skipping %s because format %s is on the FFmpeg exclude list", clean.Log(u.String()), clean.Log(matched)) + failures++ + continue + } + // Best-effort creation time for file method when not remuxing locally. if ytRemux { if created := dl.CreatedFromInfo(result.Info); !created.IsZero() { @@ -236,6 +242,10 @@ func runDownload(conf *config.Config, opts DownloadOpts, inputURLs []string) err }) if err != nil { log.Errorf("download failed: %v", err) + if len(files) == 0 { + failures++ + continue + } } if fileRemux != "skip" { for _, fp := range files { @@ -261,8 +271,8 @@ func runDownload(conf *config.Config, opts DownloadOpts, inputURLs []string) err elapsed := time.Since(start) if failures > 0 { - log.Warnf("completed with %d error(s) in %s", failures, elapsed) - return fmt.Errorf("some downloads failed: %d", failures) + log.Warnf("completed with %s in %s", formatCount(failures, "error", "errors"), elapsed) + return fmt.Errorf("%s", formatFailedCount(failures, "download", "downloads")) } log.Infof("completed in %s", elapsed) return nil diff --git a/internal/commands/download_impl_test.go b/internal/commands/download_impl_test.go index 727058654..3c931487f 100644 --- a/internal/commands/download_impl_test.go +++ b/internal/commands/download_impl_test.go @@ -1,9 +1,13 @@ package commands import ( + "bytes" + "os" + "strings" "testing" "github.com/photoprism/photoprism/internal/photoprism/dl" + "github.com/photoprism/photoprism/internal/photoprism/get" ) func TestMissingFormatsHint(t *testing.T) { @@ -22,6 +26,7 @@ func TestMissingFormatsHint(t *testing.T) { func TestResolveDownloadMethodEnv(t *testing.T) { t.Setenv(downloadMethodEnv, "FILE") + method, fromEnv, err := resolveDownloadMethod("") if err != nil { t.Fatalf("unexpected error: %v", err) @@ -36,6 +41,7 @@ func TestResolveDownloadMethodEnv(t *testing.T) { func TestResolveDownloadMethodInvalidEnv(t *testing.T) { t.Setenv(downloadMethodEnv, "weird") + if _, _, err := resolveDownloadMethod(""); err == nil { t.Fatalf("expected error for invalid env method") } @@ -43,6 +49,7 @@ func TestResolveDownloadMethodInvalidEnv(t *testing.T) { func TestResolveDownloadMethodFlagTakesPriority(t *testing.T) { t.Setenv(downloadMethodEnv, "file") + method, fromEnv, err := resolveDownloadMethod("pipe") if err != nil { t.Fatalf("unexpected error: %v", err) @@ -54,3 +61,35 @@ func TestResolveDownloadMethodFlagTakesPriority(t *testing.T) { t.Fatalf("did not expect env to be used when flag provided") } } + +func TestRunDownload_InvalidURLsReportPluralFailures(t *testing.T) { + conf := get.Config() + if conf == nil { + t.Fatalf("missing test config") + } + + conf.RegisterDb() + + var logOutput bytes.Buffer + log.SetOutput(&logOutput) + t.Cleanup(func() { + log.SetOutput(os.Stderr) + }) + + err := runDownload(conf, DownloadOpts{ + Dest: "dl-invalid", + }, []string{ + "not a url", + "ftp://example.com/video.mp4", + }) + + if err == nil { + t.Fatalf("expected invalid URLs to fail") + } + if err.Error() != "2 downloads failed" { + t.Fatalf("unexpected error: %v", err) + } + if !strings.Contains(logOutput.String(), "completed with 2 errors in") { + t.Fatalf("expected pluralized summary log, got: %q", logOutput.String()) + } +} diff --git a/internal/commands/faces.go b/internal/commands/faces.go index 9f9481be3..c02aa4e60 100644 --- a/internal/commands/faces.go +++ b/internal/commands/faces.go @@ -10,7 +10,6 @@ import ( "github.com/manifoldco/promptui" "github.com/urfave/cli/v2" - "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/entity/query" "github.com/photoprism/photoprism/internal/photoprism" "github.com/photoprism/photoprism/internal/photoprism/get" @@ -55,7 +54,7 @@ var FacesCommands = &cli.Command{ }, &cli.StringFlag{ Name: "engine", - Usage: "regenerate markers using detection engine `NAME` (auto, pigo, onnx)", + Usage: "regenerate markers using detection engine `NAME` (auto, onnx)", }, }, Action: facesResetAction, @@ -89,6 +88,7 @@ var FacesCommands = &cli.Command{ }, Action: facesOptimizeAction, }, + FacesConfigCommand, }, } @@ -125,13 +125,12 @@ func facesStatsAction(ctx *cli.Context) error { func facesAuditAction(ctx *cli.Context) error { start := time.Now() - conf := config.NewConfig(ctx) - get.SetConfig(conf) + conf, err := InitConfig(ctx) _, cancel := context.WithCancel(context.Background()) defer cancel() - if err := conf.Init(); err != nil { + if err != nil { return err } @@ -170,13 +169,12 @@ func facesResetAction(ctx *cli.Context) error { start := time.Now() - conf := config.NewConfig(ctx) - get.SetConfig(conf) + conf, err := InitConfig(ctx) _, cancel := context.WithCancel(context.Background()) defer cancel() - if err := conf.Init(); err != nil { + if err != nil { return err } @@ -216,13 +214,12 @@ func facesResetAllAction(ctx *cli.Context) error { start := time.Now() - conf := config.NewConfig(ctx) - get.SetConfig(conf) + conf, err := InitConfig(ctx) _, cancel := context.WithCancel(context.Background()) defer cancel() - if err := conf.Init(); err != nil { + if err != nil { return err } @@ -244,13 +241,12 @@ func facesResetAllAction(ctx *cli.Context) error { func facesIndexAction(ctx *cli.Context) error { start := time.Now() - conf := config.NewConfig(ctx) - get.SetConfig(conf) + conf, err := InitConfig(ctx) _, cancel := context.WithCancel(context.Background()) defer cancel() - if err := conf.Init(); err != nil { + if err != nil { return err } @@ -315,13 +311,12 @@ func facesIndexAction(ctx *cli.Context) error { func facesUpdateAction(ctx *cli.Context) error { start := time.Now() - conf := config.NewConfig(ctx) - get.SetConfig(conf) + conf, err := InitConfig(ctx) _, cancel := context.WithCancel(context.Background()) defer cancel() - if err := conf.Init(); err != nil { + if err != nil { return err } @@ -349,13 +344,12 @@ func facesUpdateAction(ctx *cli.Context) error { func facesOptimizeAction(ctx *cli.Context) error { start := time.Now() - conf := config.NewConfig(ctx) - get.SetConfig(conf) + conf, err := InitConfig(ctx) _, cancel := context.WithCancel(context.Background()) defer cancel() - if err := conf.Init(); err != nil { + if err != nil { return err } diff --git a/internal/commands/faces_config.go b/internal/commands/faces_config.go new file mode 100644 index 000000000..20c67add6 --- /dev/null +++ b/internal/commands/faces_config.go @@ -0,0 +1,72 @@ +package commands + +import ( + "encoding/json" + "fmt" + "strings" + + "github.com/urfave/cli/v2" + + "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/pkg/txt/report" +) + +// FacesConfigCommand displays the config options relevant for face detection +// and recognition. It mirrors `photoprism config` but restricts the report to +// the face-related rows produced by Config.FaceReport. +var FacesConfigCommand = &cli.Command{ + Name: "config", + Usage: "Displays the config options relevant for face detection and recognition", + Flags: report.CliFlags, + Action: facesConfigAction, +} + +// FacesConfigReports specifies which face-related reports to display. +var FacesConfigReports = []Report{ + {Title: "Face Detection & Recognition", NoWrap: true, Report: func(conf *config.Config) ([][]string, []string) { + return conf.FaceReport() + }}, +} + +// facesConfigAction prints face-related config option names and values. +func facesConfigAction(ctx *cli.Context) error { + conf, err := InitCoreConfig(ctx, true) + + if err != nil { + log.Debug(err) + } + + format, formatErr := report.CliFormatStrict(ctx) + if formatErr != nil { + return formatErr + } + + if format == report.JSON { + type section struct { + Title string `json:"title"` + Items []map[string]string `json:"items"` + } + sections := make([]section, 0, len(FacesConfigReports)) + for _, rep := range FacesConfigReports { + rows, cols := rep.Report(conf) + sections = append(sections, section{Title: rep.Title, Items: report.RowsToObjects(rows, cols)}) + } + b, _ := json.Marshal(map[string]any{"sections": sections}) + fmt.Println(string(b)) + return nil + } + + for _, rep := range FacesConfigReports { + rows, cols := rep.Report(conf) + opt := report.Options{Format: format, NoWrap: rep.NoWrap} + result, _ := report.Render(rows, cols, opt) + switch opt.Format { + case report.Markdown: + fmt.Printf("### %s\n\n", rep.Title) + case report.Default: + fmt.Printf("%s\n\n", strings.ToUpper(rep.Title)) + } + fmt.Println(result) + } + return nil +} diff --git a/internal/commands/faces_config_test.go b/internal/commands/faces_config_test.go new file mode 100644 index 000000000..77a6756a6 --- /dev/null +++ b/internal/commands/faces_config_test.go @@ -0,0 +1,62 @@ +package commands + +import ( + "encoding/json" + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestFacesConfigCommand(t *testing.T) { + output, err := RunWithTestContext(FacesConfigCommand, []string{}) + + if err != nil { + t.Fatal(err) + } + + // Spot-check face-related rows are reported. + assert.Contains(t, output, "face-engine") + assert.Contains(t, output, "face-size") + assert.Contains(t, output, "face-cluster-dist") + assert.Contains(t, output, "facenet-model-path") + assert.Contains(t, output, "disable-faces") + + // Non-face options must not leak into the focused report. + assert.NotContains(t, output, "originals-path") + assert.NotContains(t, output, "ffmpeg-bin") + assert.NotContains(t, output, "auth-mode") +} + +func TestFacesConfigCommandJSON(t *testing.T) { + output, err := RunWithTestContext(FacesConfigCommand, []string{"config", "--json"}) + + if err != nil { + t.Fatal(err) + } + + var payload struct { + Sections []struct { + Title string `json:"title"` + Items []map[string]string `json:"items"` + } `json:"sections"` + } + + if err := json.Unmarshal([]byte(output), &payload); err != nil { + t.Fatalf("invalid JSON output: %v\noutput: %s", err, output) + } + + if len(payload.Sections) != 1 { + t.Fatalf("expected exactly one section, got %d", len(payload.Sections)) + } + + names := make(map[string]string, len(payload.Sections[0].Items)) + for _, item := range payload.Sections[0].Items { + names[item["name"]] = item["value"] + } + + for _, want := range []string{"face-engine", "face-size", "face-cluster-dist", "facenet-model-path"} { + if _, ok := names[want]; !ok { + t.Errorf("expected JSON to contain %q, got keys: %v", want, names) + } + } +} diff --git a/internal/commands/import.go b/internal/commands/import.go index eaa479180..908f0a030 100644 --- a/internal/commands/import.go +++ b/internal/commands/import.go @@ -39,12 +39,12 @@ func importAction(ctx *cli.Context) error { defer cancel() if err != nil { - return err + return cli.Exit(err, 1) } // very if copy directory exist and is writable if conf.ReadOnly() { - return config.ErrReadOnly + return cli.Exit(config.ErrReadOnly, 2) } conf.InitDb() @@ -56,10 +56,10 @@ func importAction(ctx *cli.Context) error { if sourcePath == "" { sourcePath = conf.ImportPath() } else { - abs, err := filepath.Abs(sourcePath) + abs, pathErr := filepath.Abs(sourcePath) - if err != nil { - return err + if pathErr != nil { + return cli.Exit(pathErr, 2) } sourcePath = abs @@ -74,7 +74,7 @@ func importAction(ctx *cli.Context) error { if ctx.IsSet("dest") { destFolder, err = sanitizeDestinationArg(ctx.String("dest")) if err != nil { - return err + return cli.Exit(err, 2) } } else { destFolder = conf.ImportDest() diff --git a/internal/commands/index.go b/internal/commands/index.go index d1c0ffc38..95faa21c5 100644 --- a/internal/commands/index.go +++ b/internal/commands/index.go @@ -51,7 +51,7 @@ func indexAction(ctx *cli.Context) error { defer cancel() if err != nil { - return err + return cli.Exit(err, 1) } conf.InitDb() @@ -61,7 +61,7 @@ func indexAction(ctx *cli.Context) error { subPath, err := sanitizeSubfolderArg(ctx.Args().First()) if err != nil { - return err + return cli.Exit(err, 2) } if subPath == "" { @@ -118,8 +118,8 @@ func indexAction(ctx *cli.Context) error { // Start index and cache cleanup. cleanupStart := time.Now() - if thumbnails, _, sidecars, err := w.Start(opt); err != nil { - return err + if thumbnails, _, sidecars, cleanupErr := w.Start(opt); cleanupErr != nil { + return cli.Exit(cleanupErr, 1) } else if total := thumbnails + sidecars; total > 0 { log.Infof("cleanup: deleted %s in total [%s]", english.Plural(total, "file", "files"), time.Since(cleanupStart)) } diff --git a/internal/commands/lenses.go b/internal/commands/lenses.go new file mode 100644 index 000000000..b7b8614d4 --- /dev/null +++ b/internal/commands/lenses.go @@ -0,0 +1,149 @@ +package commands + +import ( + "fmt" + "strconv" + "strings" + + "github.com/urfave/cli/v2" + + "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/entity/query" + "github.com/photoprism/photoprism/internal/entity/search" + "github.com/photoprism/photoprism/internal/form" + "github.com/photoprism/photoprism/pkg/txt/report" +) + +// NoMakeFlag represents a CLI flag to filter the lenses returned to only those without Make populated. +var NoMakeFlag = &cli.BoolFlag{ + Name: "nomake", + Usage: "return only records without Make", +} + +// LensesCommand registers the "lenses" CL command. +var LensesCommand = &cli.Command{ + Name: "lenses", + Usage: "Lens management subcommands", + Subcommands: []*cli.Command{ + LensesListCommand, + LensesUpdateCommand, + }, +} + +// LensesListCommand registers the list sub command +var LensesListCommand = &cli.Command{ + Name: "ls", + Usage: "Lists discovered lenses", + ArgsUsage: "[query]", + Flags: append(report.CliFlags, CountFlag, OffsetFlag, NoMakeFlag), + Action: lensesListAction, +} + +// LensesUpdateCommand registers the update sub command +var LensesUpdateCommand = &cli.Command{ + Name: "update", + Usage: "Updates a specific lens Make and Model", + Flags: []cli.Flag{ + &cli.UintFlag{Name: "id", Usage: "lens id", Required: true}, + &cli.StringFlag{Name: "make", Usage: "the make of the lens", Required: true}, + &cli.StringFlag{Name: "model", Usage: "the model of the lens", Required: true}, + }, + Action: lensesUpdateAction, +} + +// lensesListAction searches the database for lenses. +func lensesListAction(ctx *cli.Context) error { + return CallWithDependencies(ctx, func(conf *config.Config) error { + + filter := strings.TrimSpace(strings.Join(ctx.Args().Slice(), " ")) + // Pagination identical to API defaults. + count := int(ctx.Uint("count")) //nolint:gosec // CLI flag bounded by validation + if count <= 0 || count > 1000 { + count = 100 + } + offset := max(ctx.Int("offset"), 0) + + frm := form.SearchLenses{ + Query: filter, + NoMake: ctx.Bool("nomake"), + Count: count, + Offset: offset, + } + + results, err := search.Lenses(frm) + + if err != nil { + return err + } + + format := report.CliFormat(ctx) + + cols := []string{"ID", "Lens Slug", "Lens Name", "Lens Make", "Lens Model", "Updated At"} + rows := make([][]string, 0, len(results)) + + for _, found := range results { + v := []string{strconv.FormatUint(uint64(found.ID), 10), found.LensSlug, found.LensName, found.LensMake, found.LensModel, found.UpdatedAt.Format("2006-01-02 15:04:05")} + rows = append(rows, v) + } + + result, err := report.RenderFormat(rows, cols, format) + + if err != nil { + return err + } + + fmt.Println(result) + + return nil + }) +} + +// lensesUpdateAction searches the database for lenses. +func lensesUpdateAction(ctx *cli.Context) error { + return CallWithDependencies(ctx, func(conf *config.Config) error { + + lensId := ctx.Uint("id") + lensMake := ctx.String("make") + lensModel := ctx.String("model") + + lens := query.FindLensByID(lensId) + if lens == nil { + return cli.Exit("lens not found", 1) + } + if err := lens.UpdateMakeModel(lensMake, lensModel); err != nil { + return cli.Exit(err, 1) + } + + frm := form.SearchLenses{ + ID: strconv.FormatUint(uint64(lens.ID), 10), + Count: 10, + Offset: 0, + } + + results, err := search.Lenses(frm) + + if err != nil { + return err + } + + format := report.CliFormat(ctx) + + cols := []string{"ID", "Lens Slug", "Lens Name", "Lens Make", "Lens Model", "Updated At"} + rows := make([][]string, 0, len(results)) + + for _, found := range results { + v := []string{strconv.FormatUint(uint64(found.ID), 10), found.LensSlug, found.LensName, found.LensMake, found.LensModel, found.UpdatedAt.Format("2006-01-02 15:04:05")} + rows = append(rows, v) + } + + result, err := report.RenderFormat(rows, cols, format) + + if err != nil { + return err + } + + fmt.Println(result) + + return nil + }) +} diff --git a/internal/commands/lenses_test.go b/internal/commands/lenses_test.go new file mode 100644 index 000000000..cbe921576 --- /dev/null +++ b/internal/commands/lenses_test.go @@ -0,0 +1,110 @@ +package commands + +import ( + "strconv" + "testing" + + "github.com/stretchr/testify/assert" + "github.com/urfave/cli/v2" + + "github.com/photoprism/photoprism/internal/entity" +) + +func TestLensesCommand(t *testing.T) { + t.Run("ListNoOptions", func(t *testing.T) { + // Run command with test context. + output, err := RunWithTestContext(LensesCommand, []string{"lenses", "ls"}) + assert.NoError(t, err) + + // Check command output for plausibility. + for _, expect := range entity.LensFixtures { + assert.Contains(t, output, strconv.FormatUint(uint64(expect.ID), 10)) + assert.Contains(t, output, expect.LensSlug) + assert.Contains(t, output, expect.LensName) + assert.Contains(t, output, expect.LensMake) + assert.Contains(t, output, expect.LensModel) + } + }) + t.Run("ListWithCountAndOffset", func(t *testing.T) { + // Run command with test context. + output, err := RunWithTestContext(LensesCommand, []string{"lenses", "ls", "--count=1", "--offset=2"}) + assert.NoError(t, err) + + // Check command output for plausibility. + expect := entity.LensFixtures.Get("lens-f-380") + assert.Contains(t, output, strconv.FormatUint(uint64(expect.ID), 10)) + assert.Contains(t, output, expect.LensSlug) + assert.Contains(t, output, expect.LensName) + assert.Contains(t, output, expect.LensMake) + assert.Contains(t, output, expect.LensModel) + + assert.NotContains(t, output, "zz") + assert.NotContains(t, output, "1000001") + assert.NotContains(t, output, "1000002") + }) + t.Run("ListWithNoMake", func(t *testing.T) { + // Run command with test context. + output, err := RunWithTestContext(LensesCommand, []string{"lenses", "ls", "--nomake"}) + assert.NoError(t, err) + + // Check command output for plausibility. + expect := entity.LensFixtures.Get("4-37") + assert.Contains(t, output, strconv.FormatUint(uint64(expect.ID), 10)) + assert.Contains(t, output, expect.LensSlug) + assert.Contains(t, output, expect.LensName) + assert.Contains(t, output, expect.LensModel) + assert.Contains(t, output, "zz") + assert.Contains(t, output, "Unknown") + + assert.NotContains(t, output, "1000000") + assert.NotContains(t, output, "1000001") + }) + t.Run("UpdateWithNoModel", func(t *testing.T) { + + // Run command with test context. + output, err := RunWithTestContext(LensesCommand, []string{"lenses", "update", "--id=1000002", "--make=Nikon"}) + assert.Error(t, err) + + // Check command output for plausibility. + // Can't capture the output when an error happens :-( + // assert.Contains(t, output, "Updates a specific lens Make and Model") + // assert.Contains(t, output, "photoprism lenses update [command options]") + assert.Len(t, output, 0) + assert.Contains(t, err.Error(), `Required flag "model" not set`) + }) + t.Run("UpdateWithNoMake", func(t *testing.T) { + // Run command with test context. + output, err := RunWithTestContext(LensesCommand, []string{"lenses", "update", "--id=1000002", `--model="Sigma 18-125mm F3.8-5.6 DC HSM"`}) + assert.Error(t, err) + + // Check command output for plausibility. + // Can't capture the output when an error happens :-( + // assert.Contains(t, output, "Updates a specific lens Make and Model") + // assert.Contains(t, output, "photoprism lenses update [command options]") + assert.Len(t, output, 0) + assert.Contains(t, err.Error(), `Required flag "make" not set`) + }) + t.Run("UpdateWithEmptyMakeAndModel", func(t *testing.T) { + // Explicit empty strings satisfy the Required flag check, so the guard in UpdateMakeModel + // must reject them to prevent blanking a lens. + output, err := RunWithTestContext(LensesCommand, []string{"lenses", "update", "--id=1000002", "--make=", "--model="}) + assert.Error(t, err) + assert.Len(t, output, 0) + assert.Contains(t, err.Error(), "make and model must not be empty") + var exitErr cli.ExitCoder + if assert.ErrorAs(t, err, &exitErr) { + assert.Equal(t, 1, exitErr.ExitCode()) + } + }) + t.Run("UpdateValid", func(t *testing.T) { + defer assert.NoError(t, entity.Db().Save(entity.LensFixtures.Pointer("4-37")).Error) + // Run command with test context. + output, err := RunWithTestContext(LensesCommand, []string{"lenses", "update", "--id=1000002", "--make=Tamron", `--model="Tamron SP AF 24-135mm F3.5-5.6 AD AL (190D)"`}) + assert.NoError(t, err) + + // Check command output for plausibility. + assert.Contains(t, output, "Updated At") + assert.Contains(t, output, "Tamron SP AF 24-135mm F3.5-5.6 AD AL (190D)") + assert.Contains(t, output, "1000002") + }) +} diff --git a/internal/commands/mcp.go b/internal/commands/mcp.go new file mode 100644 index 000000000..cceafbc81 --- /dev/null +++ b/internal/commands/mcp.go @@ -0,0 +1,95 @@ +package commands + +import ( + "context" + "errors" + "log/slog" + "os" + + sdkmcp "github.com/modelcontextprotocol/go-sdk/mcp" + "github.com/urfave/cli/v2" + + "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/mcp" +) + +// MCPCommands configures the Model Context Protocol (MCP) command group. +var MCPCommands = &cli.Command{ + Name: "mcp", + Usage: "Shows the Model Context Protocol (MCP) server subcommands", + Subcommands: []*cli.Command{ + MCPServeCommand, + }, +} + +// MCPServeCommand starts the MCP server over the stdio transport. +var MCPServeCommand = &cli.Command{ + Name: "serve", + Usage: "Starts the internal MCP server via stdio for development and testing", + Action: mcpServeAction, +} + +// mcpServeAction starts the MCP server over the stdio transport, +// writing a startup line to stderr so the JSON-RPC stream on stdout +// stays clean for the MCP client. The action loads the active config +// and refuses to start when DisableMCP is set, mirroring how the +// HTTP transport at /api/v1/mcp is gated; pass --disable-mcp=false on +// the command line to override the operator setting for ad-hoc +// development runs. +func mcpServeAction(ctx *cli.Context) error { + conf, err := InitConfig(ctx) + + if err != nil { + return err + } + + if err = mcpDisabledExit(conf); err != nil { + return err + } + + logger := slog.New(slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{Level: slog.LevelInfo})) + logger.Info("starting mcp server", + "transport", "stdio", + "tools", len(mcp.ToolNames), + "resources", len(mcp.ResourceURIs), + ) + + return runMCPServer(context.Background(), ctx, &sdkmcp.StdioTransport{}) +} + +// mcpDisabledExit returns a cli.ExitCoder error when MCP is disabled +// by config, pointing the caller at --disable-mcp=false for ad-hoc +// development runs. It returns nil when MCP is enabled. +func mcpDisabledExit(conf *config.Config) error { + if conf == nil || !conf.DisableMCP() { + return nil + } + + return cli.Exit(errors.New("mcp serve disabled by config; pass --disable-mcp=false to override"), 1) +} + +// runMCPServer builds an MCP server from the CLI app metadata (Version, +// Edition) and runs it over the given transport until ctx is canceled or +// the transport closes. The transport is a parameter so tests can +// substitute an in-memory transport for the stdio one mcpServeAction uses +// in production. +func runMCPServer(ctx context.Context, appCtx *cli.Context, transport sdkmcp.Transport) error { + implementation := &sdkmcp.Implementation{ + Name: "photoprism-mcp", + Version: mcpAppMetadata(appCtx, "Version", "development"), + } + edition := mcpAppMetadata(appCtx, "Edition", "unknown") + + return mcp.NewServer(implementation, edition).Run(ctx, transport) +} + +// mcpAppMetadata returns the named string entry from the CLI app metadata, +// falling back to the supplied default if the key is missing, the value is +// not a string, or the value is an empty string. +func mcpAppMetadata(ctx *cli.Context, key, fallback string) string { + if value, ok := ctx.App.Metadata[key].(string); ok && value != "" { + return value + } + + return fallback +} diff --git a/internal/commands/mcp_test.go b/internal/commands/mcp_test.go new file mode 100644 index 000000000..10d527cfa --- /dev/null +++ b/internal/commands/mcp_test.go @@ -0,0 +1,172 @@ +package commands + +import ( + "context" + "errors" + "strings" + "testing" + "time" + + sdkmcp "github.com/modelcontextprotocol/go-sdk/mcp" + "github.com/stretchr/testify/require" + "github.com/urfave/cli/v2" + + "github.com/photoprism/photoprism/internal/photoprism/get" +) + +// TestMCPCommandRegistered ensures the MCP command is present in the CLI catalog. +func TestMCPCommandRegistered(t *testing.T) { + found := false + + for _, cmd := range PhotoPrism { + if cmd.Name == "mcp" { + found = true + break + } + } + + if !found { + t.Fatal("expected mcp command to be registered") + } +} + +// TestShowCommandsIncludesMCP ensures the command catalog exposes the MCP command. +func TestShowCommandsIncludesMCP(t *testing.T) { + out, err := RunWithTestContext(ShowCommandsCommand, []string{"commands"}) + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + + if !strings.Contains(out, "## photoprism mcp") { + t.Fatalf("expected MCP heading in output\n%s", out[:min(400, len(out))]) + } +} + +// TestRunMCPServerOverInMemoryTransport exercises the full Action-side wiring +// (implementation metadata, server construction, Run lifecycle) against an +// in-memory MCP client. It is the stdio-path counterpart to the in-process +// tests in internal/mcp/server_test.go and catches regressions in the CLI +// glue that the SDK's unit tests cannot reach. +func TestRunMCPServerOverInMemoryTransport(t *testing.T) { + ctx, cancel := context.WithCancel(context.Background()) + defer cancel() + + serverTransport, clientTransport := sdkmcp.NewInMemoryTransports() + + appCtx := NewTestContext(nil) + appCtx.App.Metadata["Version"] = "42.1.0" + appCtx.App.Metadata["Edition"] = "pro" + + serverDone := make(chan error, 1) + go func() { serverDone <- runMCPServer(ctx, appCtx, serverTransport) }() + + client := sdkmcp.NewClient(&sdkmcp.Implementation{Name: "photoprism-mcp-test", Version: "1.0"}, nil) + + session, err := client.Connect(ctx, clientTransport, nil) + require.NoError(t, err) + + info := session.InitializeResult() + require.NotNil(t, info, "client should receive an InitializeResult from the server") + require.Equal(t, "photoprism-mcp", info.ServerInfo.Name) + require.Equal(t, "42.1.0", info.ServerInfo.Version, "Version must be sourced from App.Metadata") + + tools, err := session.ListTools(ctx, nil) + require.NoError(t, err) + require.Len(t, tools.Tools, 2, "server should advertise the two read-only tools over stdio-equivalent transport") + + require.NoError(t, session.Close()) + cancel() + + select { + case err := <-serverDone: + if err != nil && !errors.Is(err, context.Canceled) { + t.Errorf("runMCPServer returned unexpected error: %v", err) + } + case <-time.After(5 * time.Second): + t.Fatal("runMCPServer did not shut down within 5 seconds") + } +} + +// TestMCPDisabledExit covers the gate helper that mcpServeAction calls +// before starting the stdio transport: DisableMCP=true must return a +// cli.ExitCoder error whose message points at --disable-mcp=false as +// the documented override; DisableMCP=false must return nil so the +// server can start; nil config must be tolerated. +func TestMCPDisabledExit(t *testing.T) { + conf := get.Config() + require.NotNil(t, conf, "test harness must provide a shared config") + + original := conf.Options().DisableMCP + t.Cleanup(func() { conf.Options().DisableMCP = original }) + + t.Run("DisableMCPTrue_Refuses", func(t *testing.T) { + conf.Options().DisableMCP = true + + err := mcpDisabledExit(conf) + require.Error(t, err) + + coder, ok := err.(cli.ExitCoder) + require.True(t, ok, "expected cli.ExitCoder, got %T", err) + require.Equal(t, 1, coder.ExitCode()) + require.Contains(t, err.Error(), "--disable-mcp=false") + }) + t.Run("DisableMCPFalse_Allows", func(t *testing.T) { + conf.Options().DisableMCP = false + + require.NoError(t, mcpDisabledExit(conf)) + }) + t.Run("NilConfig_Allows", func(t *testing.T) { + require.NoError(t, mcpDisabledExit(nil)) + }) +} + +// TestMCPServeRefusesWhenDisabled drives the full mcp serve action through +// RunWithTestContext to confirm the gate trips end-to-end before the stdio +// transport is started. The DisableMCP=false branch is not exercised here +// because mcpServeAction would block on stdin once it reaches the transport; +// the gate-level coverage in TestMCPDisabledExit is sufficient to assert the +// pre-transport branch. +func TestMCPServeRefusesWhenDisabled(t *testing.T) { + conf := get.Config() + require.NotNil(t, conf, "test harness must provide a shared config") + + original := conf.Options().DisableMCP + t.Cleanup(func() { conf.Options().DisableMCP = original }) + + conf.Options().DisableMCP = true + + _, err := RunWithTestContext(MCPServeCommand, []string{"serve"}) + require.Error(t, err) + + coder, ok := err.(cli.ExitCoder) + require.True(t, ok, "expected cli.ExitCoder, got %T", err) + require.Equal(t, 1, coder.ExitCode()) + require.Contains(t, err.Error(), "--disable-mcp=false") +} + +// TestMCPAppMetadata covers the happy path and every fallback branch of +// mcpAppMetadata: missing key, non-string value, empty-string value, and +// nil metadata map. +func TestMCPAppMetadata(t *testing.T) { + cases := []struct { + name string + metadata map[string]any + key string + fallback string + want string + }{ + {"ValidString", map[string]any{"Version": "1.2.3"}, "Version", "development", "1.2.3"}, + {"MissingKey", map[string]any{"Edition": "ce"}, "Version", "development", "development"}, + {"NonStringValue", map[string]any{"Version": 42}, "Version", "development", "development"}, + {"EmptyString", map[string]any{"Version": ""}, "Version", "development", "development"}, + {"NilMetadata", nil, "Version", "development", "development"}, + } + + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + app := &cli.App{Metadata: tc.metadata} + ctx := cli.NewContext(app, nil, nil) + require.Equal(t, tc.want, mcpAppMetadata(ctx, tc.key, tc.fallback)) + }) + } +} diff --git a/internal/commands/messages.go b/internal/commands/messages.go new file mode 100644 index 000000000..d8ec82881 --- /dev/null +++ b/internal/commands/messages.go @@ -0,0 +1,17 @@ +package commands + +import ( + "fmt" + + "github.com/dustin/go-humanize/english" +) + +// formatCount returns a human-readable count phrase with the correct noun form. +func formatCount(count int, singular, plural string) string { + return english.Plural(count, singular, plural) +} + +// formatFailedCount returns a human-readable failure phrase with the correct noun form. +func formatFailedCount(count int, singular, plural string) string { + return fmt.Sprintf("%s failed", formatCount(count, singular, plural)) +} diff --git a/internal/commands/messages_test.go b/internal/commands/messages_test.go new file mode 100644 index 000000000..746714af6 --- /dev/null +++ b/internal/commands/messages_test.go @@ -0,0 +1,46 @@ +package commands + +import "testing" + +func TestFormatCount(t *testing.T) { + tests := []struct { + name string + count int + singular string + plural string + want string + }{ + {name: "Zero", count: 0, singular: "error", plural: "errors", want: "0 errors"}, + {name: "One", count: 1, singular: "download", plural: "downloads", want: "1 download"}, + {name: "Many", count: 2, singular: "file", plural: "files", want: "2 files"}, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := formatCount(tt.count, tt.singular, tt.plural); got != tt.want { + t.Fatalf("formatCount() = %q, want %q", got, tt.want) + } + }) + } +} + +func TestFormatFailedCount(t *testing.T) { + tests := []struct { + name string + count int + singular string + plural string + want string + }{ + {name: "One", count: 1, singular: "download", plural: "downloads", want: "1 download failed"}, + {name: "Many", count: 2, singular: "file", plural: "files", want: "2 files failed"}, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := formatFailedCount(tt.count, tt.singular, tt.plural); got != tt.want { + t.Fatalf("formatFailedCount() = %q, want %q", got, tt.want) + } + }) + } +} diff --git a/internal/commands/migrations.go b/internal/commands/migrations.go index 1a1bb3697..4bf2a01b4 100644 --- a/internal/commands/migrations.go +++ b/internal/commands/migrations.go @@ -11,7 +11,6 @@ import ( "github.com/sirupsen/logrus" "github.com/urfave/cli/v2" - "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/entity/migrate" "github.com/photoprism/photoprism/pkg/txt/report" ) @@ -148,12 +147,12 @@ func migrationsRunAction(ctx *cli.Context) error { start := time.Now() - conf := config.NewConfig(ctx) + conf, err := InitConfig(ctx) _, cancel := context.WithCancel(context.Background()) defer cancel() - if err := conf.Init(); err != nil { + if err != nil { return err } diff --git a/internal/commands/restore.go b/internal/commands/restore.go index 220fd7516..b7c2a5ef3 100644 --- a/internal/commands/restore.go +++ b/internal/commands/restore.go @@ -76,7 +76,7 @@ func restoreAction(ctx *cli.Context) error { defer cancel() if err != nil { - return err + return cli.Exit(err, 1) } defer conf.Shutdown() @@ -85,7 +85,7 @@ func restoreAction(ctx *cli.Context) error { if !restoreDatabase { // Do nothing. } else if err = backup.RestoreDatabase(databasePath, databaseFile, databaseFile == "-", force); err != nil { - return err + return cli.Exit(err, 1) } log.Infoln("restore: migrating index database schema") @@ -106,7 +106,7 @@ func restoreAction(ctx *cli.Context) error { log.Infof("restore: restoring album backups from %s", clean.Log(albumsPath)) if count, restoreErr := backup.RestoreAlbums(albumsPath, true); restoreErr != nil { - return restoreErr + return cli.Exit(restoreErr, 1) } else { log.Infof("restore: restored %s from YAML files", english.Plural(count, "album", "albums")) } diff --git a/internal/commands/show_config.go b/internal/commands/show_config.go index 73025fdd4..816390296 100644 --- a/internal/commands/show_config.go +++ b/internal/commands/show_config.go @@ -5,12 +5,9 @@ import ( "fmt" "strings" - "github.com/sirupsen/logrus" "github.com/urfave/cli/v2" "github.com/photoprism/photoprism/internal/config" - "github.com/photoprism/photoprism/internal/photoprism/get" - "github.com/photoprism/photoprism/internal/service/hub" "github.com/photoprism/photoprism/pkg/txt/report" ) @@ -34,12 +31,9 @@ var ConfigReports = []Report{ // showConfigAction displays global config option names and values. func showConfigAction(ctx *cli.Context) error { - conf := config.NewConfig(ctx) - conf.SetLogLevel(logrus.FatalLevel) - get.SetConfig(conf) - hub.Disable() + conf, err := InitCoreConfig(ctx, true) - if err := conf.InitCore(); err != nil { + if err != nil { log.Debug(err) } diff --git a/internal/commands/show_json_test.go b/internal/commands/show_json_test.go index 8947ade01..af5286b7a 100644 --- a/internal/commands/show_json_test.go +++ b/internal/commands/show_json_test.go @@ -97,6 +97,11 @@ func TestShowMetadata_JSON(t *testing.T) { } func TestShowConfig_JSON(t *testing.T) { + // "show config" calls InitCore, which creates storage dirs and an index database under + // ".photoprism" in the working directory when no storage path is set; run from a temp + // dir so the test does not leave files in the repository. + t.Chdir(t.TempDir()) + out, err := RunWithTestContext(ShowConfigCommand, []string{"config", "--json"}) if err != nil { diff --git a/internal/commands/show_test.go b/internal/commands/show_test.go index 099ffb250..c8095f9b0 100644 --- a/internal/commands/show_test.go +++ b/internal/commands/show_test.go @@ -7,6 +7,11 @@ import ( ) func TestShowConfigCommand(t *testing.T) { + // "show config" calls InitCore, which creates storage dirs and an index database at the + // configured path; without a storage path it defaults to ".photoprism" under the working + // directory. Run from a temp dir so the test does not leave files in the repository. + t.Chdir(t.TempDir()) + // Run command with test context. output, err := RunWithTestContext(ShowConfigCommand, []string{}) diff --git a/internal/commands/stop.go b/internal/commands/stop.go index 4d3c09ff1..1086abc42 100644 --- a/internal/commands/stop.go +++ b/internal/commands/stop.go @@ -8,9 +8,6 @@ import ( "github.com/sevlyar/go-daemon" "github.com/urfave/cli/v2" - "github.com/photoprism/photoprism/internal/config" - "github.com/photoprism/photoprism/internal/photoprism/get" - "github.com/photoprism/photoprism/internal/service/hub" "github.com/photoprism/photoprism/pkg/clean" ) @@ -24,11 +21,9 @@ var StopCommand = &cli.Command{ // stopAction stops the daemon if it is running. func stopAction(ctx *cli.Context) error { - conf := config.NewConfig(ctx) - get.SetConfig(conf) - hub.Disable() + conf, err := InitCoreConfig(ctx, false) - if err := conf.InitCore(); err != nil { + if err != nil { log.Debug(err) } diff --git a/internal/commands/testdata/.gitignore b/internal/commands/testdata/.gitignore new file mode 100644 index 000000000..c96a04f00 --- /dev/null +++ b/internal/commands/testdata/.gitignore @@ -0,0 +1,2 @@ +* +!.gitignore \ No newline at end of file diff --git a/internal/commands/users.go b/internal/commands/users.go index c2ebeb0db..e98ecfd82 100644 --- a/internal/commands/users.go +++ b/internal/commands/users.go @@ -11,20 +11,28 @@ import ( // Usage hints for the user management subcommands. const ( - UserNameUsage = "full `NAME` for display in the interface" - UserEmailUsage = "unique `EMAIL` address of the user" - UserPasswordUsage = "`PASSWORD` for local authentication (8-72 characters)" - UserAuthUsage = "authentication `PROVIDER` (default, local, oidc or none)" - UserAuthIDUsage = "authentication `ID`, e.g. Subject ID or Distinguished Name (DN)" - UserAdminUsage = "makes user super admin with full access" - UserNoLoginUsage = "disables login on the web interface" - UserWebDAVUsage = "allows to sync files via WebDAV" - UserDisable2FA = "deactivates two-factor authentication" + UserNameUsage = "full `NAME` for display in the interface" + UserEmailUsage = "unique `EMAIL` address of the user" + UserPasswordUsage = "`PASSWORD` for local authentication (8-72 characters)" + UserAuthUsage = "authentication `PROVIDER` (default, local, oidc, or none)" + UserAuthIDUsage = "authentication `ID`, e.g. Subject ID or Distinguished Name (DN)" + UserAuthIssuerUsage = "authentication `ISSUER` URL, e.g. the Portal base URL for OIDC accounts" + UserAdminUsage = "makes user super admin with full access" + UserNoLoginUsage = "disables login on the web interface" + UserWebDAVUsage = "allows to sync files via WebDAV" + UserDisable2FA = "deactivates two-factor authentication" ) +// UserRoleUsageFor builds the --role flag help from the assignable user roles in m, so +// each edition's CLI lists exactly the roles its own registered map accepts (Portal, for +// example, includes cluster_admin). Edition commands pass their static auth.UserRoles map. +func UserRoleUsageFor(m acl.RoleStrings) string { + return fmt.Sprintf("user account `ROLE`, e.g. %s", m.CliUsageString()) +} + var ( - // UserRoleUsage describes allowed user roles for CLI help. - UserRoleUsage = fmt.Sprintf("user account `ROLE`, e.g. %s", acl.UserRoles.CliUsageString()) + // UserRoleUsage describes the assignable user roles for CLI help. + UserRoleUsage = UserRoleUsageFor(acl.UserRoles) ) // UsersCommands configures the user management subcommands. @@ -77,6 +85,11 @@ var UserFlags = []cli.Flag{ Usage: UserAuthIDUsage, Value: "", }, + &cli.StringFlag{ + Name: "auth-issuer", + Usage: UserAuthIssuerUsage, + Value: "", + }, SuperAdminFlag(UserAdminUsage), &cli.BoolFlag{ Name: "no-login", diff --git a/internal/commands/users_add.go b/internal/commands/users_add.go index c73621cb9..2ce005602 100644 --- a/internal/commands/users_add.go +++ b/internal/commands/users_add.go @@ -28,6 +28,12 @@ func usersAddAction(ctx *cli.Context) error { return CallWithDependencies(ctx, func(conf *config.Config) error { conf.MigrateDb(false, nil) + // Reject flags placed after the username; the stdlib flag parser + // would silently drop them and create the account with the defaults. + if err := RejectTrailingFlags(ctx); err != nil { + return err + } + frm := form.NewUserFromCli(ctx) interactive := true diff --git a/internal/commands/users_flags_test.go b/internal/commands/users_flags_test.go index 77e7ec7d8..9097658ea 100644 --- a/internal/commands/users_flags_test.go +++ b/internal/commands/users_flags_test.go @@ -5,10 +5,31 @@ import ( "github.com/stretchr/testify/assert" "github.com/urfave/cli/v2" + + "github.com/photoprism/photoprism/internal/auth/acl" ) -func TestUserRoleFlagUsage_IncludesNoneAlias(t *testing.T) { - t.Run("AddCommandUserRoleFlagIncludesNone", func(t *testing.T) { +func TestUserRoleUsageFor(t *testing.T) { + // Lists exactly the assignable roles in the given map — including cluster_admin + // when the map registers it (the Portal case) — and drops the visitor and + // uploader-alias entries via RoleStrings.Strings. + m := acl.RoleStrings{ + string(acl.RoleAdmin): acl.RoleAdmin, + string(acl.RoleClusterAdmin): acl.RoleClusterAdmin, + "uploader": acl.RoleContributor, + string(acl.RoleVisitor): acl.RoleVisitor, + string(acl.RoleGuest): acl.RoleGuest, + } + u := UserRoleUsageFor(m) + assert.Contains(t, u, "user account `ROLE`") + assert.Contains(t, u, "cluster_admin") + assert.Contains(t, u, "guest") + assert.NotContains(t, u, "uploader") + assert.NotContains(t, u, "visitor") +} + +func TestUserRoleFlagUsage_ExcludesNoneAndVisitor(t *testing.T) { + t.Run("AddCommandUserRoleFlagExcludesNoneAndVisitor", func(t *testing.T) { var roleFlag *cli.StringFlag for _, f := range UsersAddCommand.Flags { if rf, ok := f.(*cli.StringFlag); ok && rf.Name == "role" { @@ -19,9 +40,13 @@ func TestUserRoleFlagUsage_IncludesNoneAlias(t *testing.T) { if roleFlag == nil { t.Fatal("role flag not found on UsersAddCommand") } - assert.Contains(t, roleFlag.Usage, "none") + // Offered roles are listed; the "none" alias and "visitor" are excluded. + assert.Contains(t, roleFlag.Usage, "admin") + assert.Contains(t, roleFlag.Usage, "guest") + assert.NotContains(t, roleFlag.Usage, "none") + assert.NotContains(t, roleFlag.Usage, "visitor") }) - t.Run("ModCommandUserRoleFlagIncludesNone", func(t *testing.T) { + t.Run("ModCommandUserRoleFlagExcludesNoneAndVisitor", func(t *testing.T) { var roleFlag *cli.StringFlag for _, f := range UsersModCommand.Flags { if rf, ok := f.(*cli.StringFlag); ok && rf.Name == "role" { @@ -32,6 +57,9 @@ func TestUserRoleFlagUsage_IncludesNoneAlias(t *testing.T) { if roleFlag == nil { t.Fatal("role flag not found on UsersModCommand") } - assert.Contains(t, roleFlag.Usage, "none") + assert.Contains(t, roleFlag.Usage, "admin") + assert.Contains(t, roleFlag.Usage, "guest") + assert.NotContains(t, roleFlag.Usage, "none") + assert.NotContains(t, roleFlag.Usage, "visitor") }) } diff --git a/internal/commands/users_mod.go b/internal/commands/users_mod.go index 9176bebd5..fcf786bba 100644 --- a/internal/commands/users_mod.go +++ b/internal/commands/users_mod.go @@ -36,6 +36,12 @@ func usersModAction(ctx *cli.Context) error { return cli.ShowSubcommandHelp(ctx) } + // Reject flags placed after the username; the stdlib flag parser + // would silently drop them and report "user updated" with no changes. + if err := RejectTrailingFlags(ctx); err != nil { + return err + } + // Find user record. var m *entity.User diff --git a/internal/commands/users_mod_test.go b/internal/commands/users_mod_test.go index 7415f9511..39f562e42 100644 --- a/internal/commands/users_mod_test.go +++ b/internal/commands/users_mod_test.go @@ -4,6 +4,9 @@ import ( "testing" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/internal/entity" ) func TestUsersModCommand(t *testing.T) { @@ -25,4 +28,37 @@ func TestUsersModCommand(t *testing.T) { assert.Error(t, err) assert.Empty(t, output) }) + t.Run("AdoptOidcIdentityWithIssuer", func(t *testing.T) { + // Create a fresh local account, then adopt it into an OIDC identity with a + // pinned issuer — the documented reconcile path for a pre-existing account. + _, err := RunWithTestContext(UsersAddCommand, []string{"add", "--name=Adopt Me", "--email=adopt@example.com", "--password=test1234", "--role=admin", "adoptme"}) + require.NoError(t, err) + + _, err = RunWithTestContext(UsersModCommand, []string{"mod", "--auth=oidc", "--auth-id=us9k2lqd8m3n7abc", "--auth-issuer=https://portal.example.com/", "adoptme"}) + require.NoError(t, err) + + m := entity.FindUserByName("adoptme") + require.NotNil(t, m) + assert.Equal(t, "oidc", m.AuthProvider) + assert.Equal(t, "us9k2lqd8m3n7abc", m.AuthID) + assert.Equal(t, "https://portal.example.com/", m.AuthIssuer) + }) + t.Run("RejectFlagsAfterPositional", func(t *testing.T) { + // Run with the broken arg order QA reported (positional first, then flags). + // The stdlib flag parser stops at "alice", so --name / --role would + // silently no-op without RejectTrailingFlags. + output, err := RunWithTestContext(UsersModCommand, []string{"mod", "alice", "--name", "Alicia", "--role", "guest"}) + + require.Error(t, err) + assert.Contains(t, err.Error(), "must appear before positional arguments") + assert.Empty(t, output) + + // Confirm the alice fixture is untouched when it still exists. Earlier + // tests in the suite may have deleted it, so skip the comparison in + // that case rather than coupling this test to suite ordering. + if alice := entity.FindUserByName("alice"); alice != nil { + assert.Equal(t, "Alice", alice.DisplayName) + assert.Equal(t, "admin", alice.UserRole) + } + }) } diff --git a/internal/commands/video_remux.go b/internal/commands/video_remux.go index e4873c670..6a5307e0e 100644 --- a/internal/commands/video_remux.go +++ b/internal/commands/video_remux.go @@ -49,12 +49,12 @@ func videoRemuxAction(ctx *cli.Context) error { return err } - plans, preflight, err := videoBuildRemuxPlans(conf, results, ctx.Bool(videoForceFlag.Name)) + plans, preflight, skipped, err := videoBuildRemuxPlans(conf, results, ctx.Bool(videoForceFlag.Name)) if err != nil { return err } - if len(plans) == 0 { + if len(plans) == 0 && skipped == 0 { log.Infof("remux: found no matching videos") return nil } @@ -76,7 +76,7 @@ func videoRemuxAction(ctx *cli.Context) error { } } - var processed, skipped, failed int + var processed, failed int convert := get.Convert() for _, plan := range plans { @@ -95,10 +95,15 @@ func videoRemuxAction(ctx *cli.Context) error { processed++ } - log.Infof("remux: processed %d, skipped %d, failed %d", processed, skipped, failed) + log.Infof( + "remux: processed %s, skipped %s, %s", + formatCount(processed, "file", "files"), + formatCount(skipped, "file", "files"), + formatFailedCount(failed, "file", "files"), + ) if failed > 0 { - return fmt.Errorf("remux: %d files failed", failed) + return fmt.Errorf("remux: %s", formatFailedCount(failed, "file", "files")) } return nil @@ -115,47 +120,59 @@ type videoRemuxPlan struct { } // videoBuildRemuxPlans prepares remux operations and preflight size checks from search results. -func videoBuildRemuxPlans(conf *config.Config, results []search.Photo, force bool) ([]videoRemuxPlan, []videoOutputPlan, error) { +func videoBuildRemuxPlans(conf *config.Config, results []search.Photo, force bool) ([]videoRemuxPlan, []videoOutputPlan, int, error) { plans := make([]videoRemuxPlan, 0, len(results)) preflight := make([]videoOutputPlan, 0, len(results)) + skipped := 0 for _, found := range results { videoFile, ok := videoPrimaryFile(found) if !ok { log.Warnf("remux: missing video file for %s", clean.Log(found.PhotoUID)) + skipped++ continue } if videoFile.FileSidecar { log.Warnf("remux: skipping sidecar file %s", clean.Log(videoFile.FileName)) + skipped++ continue } if videoFile.MediaType == entity.MediaLive { log.Warnf("remux: skipping live photo video %s", clean.Log(videoFile.FileName)) + skipped++ continue } srcPath := photoprism.FileName(videoFile.FileRoot, videoFile.FileName) if !fs.FileExistsNotEmpty(srcPath) { log.Warnf("remux: missing file %s", clean.Log(srcPath)) + skipped++ continue } if !videoCodecIsAvc(videoFile.FileCodec) && !force { if !videoFallbackCodecAvc(srcPath) { log.Warnf("remux: skipping non-AVC video %s", clean.Log(videoFile.FileName)) + skipped++ continue } } + if matched := ffmpeg.Exclude().Match(videoFile.FileCodec, fs.FileType(srcPath).String()); matched != "" { + log.Warnf("remux: skipping %s because format %s is on the FFmpeg exclude list", clean.Log(videoFile.FileName), clean.Log(matched)) + skipped++ + continue + } + destPath := fs.StripKnownExt(srcPath) + fs.ExtMp4 useSidecar := false indexPath := destPath if conf.ReadOnly() || !fs.PathWritable(filepath.Dir(srcPath)) || !fs.Writable(srcPath) { if !conf.SidecarWritable() || !fs.PathWritable(conf.SidecarPath()) { - return nil, nil, config.ErrReadOnly + return nil, nil, skipped, config.ErrReadOnly } sidecarBase := videoSidecarPath(srcPath, conf.OriginalsPath(), conf.SidecarPath()) @@ -166,6 +183,7 @@ func videoBuildRemuxPlans(conf *config.Config, results []search.Photo, force boo if destPath != srcPath && fs.FileExistsNotEmpty(destPath) && !force { log.Warnf("remux: output already exists %s", clean.Log(destPath)) + skipped++ continue } @@ -183,7 +201,7 @@ func videoBuildRemuxPlans(conf *config.Config, results []search.Photo, force boo }) } - return plans, preflight, nil + return plans, preflight, skipped, nil } // videoRemuxFile runs ffmpeg remuxing and refreshes previews/thumbnails before reindexing. @@ -197,6 +215,10 @@ func videoRemuxFile(conf *config.Config, convert *photoprism.Convert, plan video opt := encode.NewRemuxOptions(conf.FFmpegBin(), fs.VideoMp4, true) opt.Force = true + if ffmpeg.Exclude().Contains(fs.FileType(plan.SrcPath).String()) { + return fmt.Errorf("format %s is excluded from FFmpeg processing", clean.Log(fs.FileType(plan.SrcPath).String())) + } + if err = ffmpeg.RemuxFile(plan.SrcPath, tempPath, opt); err != nil { return err } diff --git a/internal/commands/video_remux_test.go b/internal/commands/video_remux_test.go new file mode 100644 index 000000000..c01c49288 --- /dev/null +++ b/internal/commands/video_remux_test.go @@ -0,0 +1,52 @@ +package commands + +import ( + "os" + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/internal/entity/search" + "github.com/photoprism/photoprism/internal/ffmpeg" + "github.com/photoprism/photoprism/internal/photoprism/get" + "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/media/video" +) + +func TestVideoBuildRemuxPlans(t *testing.T) { + t.Run("CountsExcludedFilesAsSkipped", func(t *testing.T) { + conf := get.Config() + require.NotNil(t, conf) + + saved := ffmpeg.Exclude() + ffmpeg.SetExclude(video.NewFormats("avi")) + t.Cleanup(func() { ffmpeg.SetExclude(saved) }) + + relPath := "testdata/remux-excluded.avi" + absPath := fs.Abs(relPath) + require.NoError(t, os.WriteFile(absPath, []byte("test"), fs.ModeFile)) + t.Cleanup(func() { + _ = os.Remove(absPath) + }) + + results := []search.Photo{{ + PhotoUID: "ptest-remux-excluded", + Files: []entity.File{{ + FileRoot: entity.RootOriginals, + FileName: relPath, + FileVideo: true, + FileCodec: video.CodecAvc1, + FileType: fs.VideoAVI.String(), + FileSize: 4, + }}, + }} + + plans, preflight, skipped, err := videoBuildRemuxPlans(conf, results, false) + require.NoError(t, err) + assert.Empty(t, plans) + assert.Empty(t, preflight) + assert.Equal(t, 1, skipped) + }) +} diff --git a/internal/commands/video_transcode.go b/internal/commands/video_transcode.go index 328b2828a..1ea2bf742 100644 --- a/internal/commands/video_transcode.go +++ b/internal/commands/video_transcode.go @@ -10,6 +10,7 @@ import ( "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/entity/search" + "github.com/photoprism/photoprism/internal/ffmpeg" "github.com/photoprism/photoprism/internal/photoprism" "github.com/photoprism/photoprism/internal/photoprism/get" "github.com/photoprism/photoprism/pkg/clean" @@ -103,10 +104,15 @@ func videoTranscodeAction(ctx *cli.Context) error { processed++ } - log.Infof("transcode: processed %d, skipped %d, failed %d", processed, skipped, failed) + log.Infof( + "transcode: processed %s, skipped %s, %s", + formatCount(processed, "file", "files"), + formatCount(skipped, "file", "files"), + formatFailedCount(failed, "file", "files"), + ) if failed > 0 { - return fmt.Errorf("transcode: %d files failed", failed) + return fmt.Errorf("transcode: %s", formatFailedCount(failed, "file", "files")) } return nil @@ -149,6 +155,11 @@ func videoBuildTranscodePlans(conf *config.Config, results []search.Photo, force continue } + if matched := ffmpeg.Exclude().Match(videoFile.FileCodec, fs.FileType(srcPath).String()); matched != "" { + log.Warnf("transcode: skipping %s because format %s is on the FFmpeg exclude list", clean.Log(videoFile.FileName), clean.Log(matched)) + continue + } + if !conf.SidecarWritable() || !fs.PathWritable(conf.SidecarPath()) { return nil, nil, config.ErrReadOnly } diff --git a/internal/commands/video_trim.go b/internal/commands/video_trim.go index 191668eda..dc07f54d9 100644 --- a/internal/commands/video_trim.go +++ b/internal/commands/video_trim.go @@ -104,10 +104,15 @@ func videoTrimAction(ctx *cli.Context) error { processed++ } - log.Infof("trim: processed %d, skipped %d, failed %d", processed, skipped, failed) + log.Infof( + "trim: processed %s, skipped %s, %s", + formatCount(processed, "file", "files"), + formatCount(skipped, "file", "files"), + formatFailedCount(failed, "file", "files"), + ) if failed > 0 { - return fmt.Errorf("trim: %d files failed", failed) + return fmt.Errorf("trim: %s", formatFailedCount(failed, "file", "files")) } return nil diff --git a/internal/config/AGENTS.md b/internal/config/AGENTS.md new file mode 100644 index 000000000..6211f7d5b --- /dev/null +++ b/internal/config/AGENTS.md @@ -0,0 +1,22 @@ +# Config Guidelines + +**Last Updated:** April 9, 2026 + +## Option Precedence & Wiring + +- Respect config precedence: `options.yml` overrides CLI and environment values, which override defaults. +- When adding a new option, update `internal/config/options.go` for YAML and flag tags, register the flag in `internal/config/flags.go`, expose a getter, surface it in `*config.Report()`, and persist generated values by setting `c.options.OptionsYaml` before writing `options.yml`. +- Exercise new flags with `CliTestContext` from `internal/config/test.go`. + +## Config Persistence + +- For `options.yml` writes, use config-owned helpers instead of ad-hoc YAML handling: `Config.SaveOptionsPatch(...)` for generic merges and `Config.SaveClusterOptionsUpdate(...)` for cluster-managed updates. +- Use `pkg/fs.ConfigFilePath` when you need a config filename so existing `.yml` files stay valid while new installs may adopt `.yaml`. +- In Go code, use public `*config.Config` accessors such as `Config.JWKSUrl()`, `Config.SetJWKSUrl()`, and `Config.ClusterUUID()` instead of mutating `Config.Options()` directly; reserve raw option mutation for test fixtures. + +## CLI Override Rules & DB Helpers + +- Favor explicit CLI flags: check `c.cliCtx.IsSet("<flag>")` before overriding user-supplied values. +- Follow the `ClusterUUID` pattern for generated values: `options.yml`, then CLI or environment overrides, then a generated value persisted back to disk. +- Reuse `conf.Db()` and `conf.Database*()` helpers, avoid GORM `WithContext`, quote MySQL identifiers, and reject unsupported drivers early. + diff --git a/internal/config/README.md b/internal/config/README.md index df381fa83..f18f71321 100644 --- a/internal/config/README.md +++ b/internal/config/README.md @@ -1,19 +1,22 @@ ## PhotoPrism — Config Package -**Last Updated:** March 4, 2026 +**Last Updated:** March 8, 2026 ### Overview PhotoPrism’s [runtime configuration](https://docs.photoprism.app/developer-guide/configuration/) is managed by this package. Fields are defined in [`options.go`](options.go) and then initialized with values from command-line flags, [environment variables](https://docs.photoprism.app/getting-started/config-options/), and [optional YAML files](https://docs.photoprism.app/getting-started/config-files/) (`storage/config/*.yml`). -Client config values are derived from the runtime configuration and exposed to the frontend via `GET /api/v1/config`. This includes a `storageNamespace` value (SHA-256 hash of `SiteUrl`) used by the browser to scope local storage keys on shared domains. +Client config values are derived from the runtime configuration and exposed to the frontend via `GET /api/v1/config`. This includes a `storageNamespace` value (SHA-256 hash of `SiteUrl`) used by the browser to scope namespaced browser-storage keys on shared domains. ### Storage Namespace & Legacy Session Compatibility - `storageNamespace` is deterministic per `SiteUrl` (`SHA-256(SiteUrl)`) and is used by the frontend storage wrappers to isolate data on shared domains. -- Frontend reads from namespaced keys first and then falls back to legacy global keys; when a legacy value is found, it is migrated to the active namespace on read. -- Legacy mobile/webview integrations should prefer writing both global `session.token` and `session.id` when pre-populating authentication data. +- The preferred frontend/browser contract uses namespaced keys in the format `pp:<storageNamespace>:<key>`, with `pp:root:` as the fallback prefix when no namespace is available. +- Frontend reads namespaced keys first and then falls back to selected legacy global keys; when a legacy value is found, it is migrated to the active namespace on read. +- New mobile or web-view integrations should write the namespaced `session` preference flag plus both namespaced `session.token` and `session.id` keys when pre-populating authentication data. - Writing only a token is not enough to restore an authenticated user session in current frontend logic, because session restore requires both token and session id. +- A namespaced `localStorage["pp:<storageNamespace>:session"]` value of `"true"` selects namespaced `sessionStorage` for the active session. Any other value uses namespaced `localStorage`. +- The OIDC callback bridge still honors the legacy unnamespaced `localStorage["session"] === "true"` preference during migration, but new integrations should not depend on that fallback. - Older compatibility keys (`authToken` / `sessionId`) are only auto-migrated when both are present. ### Sources & Precedence diff --git a/internal/config/cli_context_test.go b/internal/config/cli_context_test.go index 968034cca..f811b7175 100644 --- a/internal/config/cli_context_test.go +++ b/internal/config/cli_context_test.go @@ -13,6 +13,10 @@ type durationTarget struct { Interval time.Duration `flag:"interval"` } +type indexWorkersTarget struct { + IndexWorkers string `flag:"index-workers"` +} + func TestApplyCliContext_Duration(t *testing.T) { tests := []struct { name string @@ -42,3 +46,35 @@ func TestApplyCliContext_Duration(t *testing.T) { }) } } + +// TestApplyCliContext_IndexWorkersString verifies that the index-workers +// option, recently changed from int to string with "auto" as the default, +// propagates correctly through the reflection-based CLI binder. Both the +// "auto" sentinel and a numeric override must land verbatim in the +// Options.IndexWorkers field for IndexWorkers() to interpret later. +func TestApplyCliContext_IndexWorkersString(t *testing.T) { + tests := []struct { + name string + input string + }{ + {name: "Auto", input: IndexWorkersAuto}, + {name: "Numeric", input: "4"}, + {name: "Empty", input: ""}, + } + + for _, tc := range tests { + t.Run(tc.name, func(t *testing.T) { + flags := flag.NewFlagSet("test", flag.ContinueOnError) + flags.String("index-workers", "", "doc") + app := cli.NewApp() + ctx := cli.NewContext(app, flags, nil) + _ = ctx.Set("index-workers", tc.input) + + target := &indexWorkersTarget{} + err := ApplyCliContext(target, ctx) + + assert.NoError(t, err) + assert.Equal(t, tc.input, target.IndexWorkers) + }) + } +} diff --git a/internal/config/cli_flag.go b/internal/config/cli_flag.go index 49b6f77e5..0498fd104 100644 --- a/internal/config/cli_flag.go +++ b/internal/config/cli_flag.go @@ -2,6 +2,7 @@ package config import ( "reflect" + "strconv" "strings" "github.com/urfave/cli/v2" @@ -13,7 +14,8 @@ import ( type CliFlag struct { Flag cli.DocGenerationFlag Tags []string - DocDefault string + Secret bool // Secret marks the flag as carrying sensitive data. + DocDefault string // DocDefault contains the default value for use in docs. } // Skip checks if the parameter should be skipped based on a list of tags. @@ -32,13 +34,23 @@ func (f CliFlag) Fields() reflect.Value { return fields } -// Default returns the default value. +// Default returns the documented default value of the flag, never the +// runtime value urfave/cli writes back into f.Value once an environment +// variable or CLI argument has been applied. Secret flags collapse to +// DocDefault (or "") regardless of any source-code default so generated +// docs and config reports stay stable across deployments. func (f CliFlag) Default() string { - if f.DocDefault != "" { + if f.Secret || f.DocDefault != "" { return f.DocDefault } - return f.Flag.GetValue() + text := f.Flag.GetDefaultText() + + if unquoted, err := strconv.Unquote(text); err == nil { + return unquoted + } + + return text } // Hidden checks if the flag is hidden. diff --git a/internal/config/cli_flag_test.go b/internal/config/cli_flag_test.go index 876db8a20..1c4679df3 100644 --- a/internal/config/cli_flag_test.go +++ b/internal/config/cli_flag_test.go @@ -4,6 +4,7 @@ import ( "testing" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" "github.com/urfave/cli/v2" ) @@ -141,6 +142,85 @@ func TestCliFlag_Default(t *testing.T) { assert.Equal(t, "", nodefault.Default()) } +// TestCliFlag_DefaultStringDefault verifies that the literal source-code +// default of a StringFlag is returned with quotes stripped, not the %q +// representation urfave/cli uses for documentation output. +func TestCliFlag_DefaultStringDefault(t *testing.T) { + t.Run("Empty", func(t *testing.T) { + f := CliFlag{ + Flag: &cli.StringFlag{ + Name: "flag-empty-default", + EnvVars: []string{"PHOTOPRISM_TEST_EMPTY"}, + }, + } + + assert.Equal(t, "", f.Default()) + }) + t.Run("Literal", func(t *testing.T) { + f := CliFlag{ + Flag: &cli.StringFlag{ + Name: "flag-literal-default", + EnvVars: []string{"PHOTOPRISM_TEST_LITERAL"}, + Value: "hello", + }, + } + + assert.Equal(t, "hello", f.Default()) + }) +} + +// TestCliFlag_DefaultIgnoresEnvOverride verifies that an env-supplied +// runtime value never replaces the documented default. +func TestCliFlag_DefaultIgnoresEnvOverride(t *testing.T) { + t.Setenv("PHOTOPRISM_TEST_OVERRIDE", "secret-runtime-value") + + flag := &cli.StringFlag{ + Name: "flag-env-override", + EnvVars: []string{"PHOTOPRISM_TEST_OVERRIDE"}, + Value: "documented-default", + } + + app := cli.NewApp() + app.Flags = []cli.Flag{flag} + app.Action = func(*cli.Context) error { return nil } + require.NoError(t, app.Run([]string{"app"})) + + wrapped := CliFlag{Flag: flag} + + assert.Equal(t, "secret-runtime-value", flag.GetValue(), "sanity: urfave/cli should expose the env value via GetValue") + assert.Equal(t, "documented-default", wrapped.Default(), "Default() must keep returning the documented default after env override") +} + +// TestCliFlag_DefaultSecret verifies that flags carrying secret data +// never echo the runtime value (or the source-code default) through +// Default(). Operators can attach a placeholder via DocDefault when one +// is desirable; otherwise Default() returns the empty string. +func TestCliFlag_DefaultSecret(t *testing.T) { + t.Setenv("PHOTOPRISM_TEST_SECRET", "hunter2-runtime-secret") + + flag := &cli.StringFlag{ + Name: "flag-secret", + EnvVars: []string{"PHOTOPRISM_TEST_SECRET"}, + Value: "compiled-default", + } + + app := cli.NewApp() + app.Flags = []cli.Flag{flag} + app.Action = func(*cli.Context) error { return nil } + require.NoError(t, app.Run([]string{"app"})) + + t.Run("EmptyPlaceholder", func(t *testing.T) { + f := CliFlag{Flag: flag, Secret: true} + + assert.Equal(t, "", f.Default()) + }) + t.Run("DocDefaultPlaceholder", func(t *testing.T) { + f := CliFlag{Flag: flag, Secret: true, DocDefault: "[redacted]"} + + assert.Equal(t, "[redacted]", f.Default()) + }) +} + func TestCliFlag_EnvVar(t *testing.T) { hasDefault := CliFlag{ Flag: &cli.StringFlag{ diff --git a/internal/config/cli_flags_test.go b/internal/config/cli_flags_test.go index d7dabe6c4..b090ea015 100644 --- a/internal/config/cli_flags_test.go +++ b/internal/config/cli_flags_test.go @@ -285,6 +285,22 @@ func TestCliFlags_SetHidden(t *testing.T) { t.Logf("auth-mode hidden flag after: %#v", cliFlags[1].Hidden()) } +func TestCliFlags_StorageFreeDisabledByDefault(t *testing.T) { + var storageFreeFlag *cli.Float64Flag + + for i := range Flags { + if Flags[i].Name() == "storage-free" { + storageFreeFlag, _ = Flags[i].Flag.(*cli.Float64Flag) + break + } + } + + if assert.NotNil(t, storageFreeFlag) { + assert.Equal(t, DefaultStorageFree, storageFreeFlag.Value) + assert.Less(t, storageFreeFlag.Value, 0.0, "storage-free must default to a disabled (negative) value") + } +} + func TestCliFlags_ThemeURLHiddenByDefault(t *testing.T) { var themeURLFlag *CliFlag diff --git a/internal/config/client_config.go b/internal/config/client_config.go index 84958d4d7..d15b608c9 100644 --- a/internal/config/client_config.go +++ b/internal/config/client_config.go @@ -46,6 +46,7 @@ type ClientConfig struct { SiteUrl string `json:"siteUrl"` SiteDomain string `json:"siteDomain"` SiteAuthor string `json:"siteAuthor"` + SiteName string `json:"siteName"` SiteTitle string `json:"siteTitle"` SiteCaption string `json:"siteCaption"` SiteDescription string `json:"siteDescription"` @@ -84,7 +85,6 @@ type ClientConfig struct { Cameras entity.Cameras `json:"cameras"` Lenses entity.Lenses `json:"lenses"` Countries entity.Countries `json:"countries"` - People entity.People `json:"people"` Thumbs ThumbSizes `json:"thumbs"` Tier int `json:"tier"` Membership string `json:"membership"` @@ -129,6 +129,7 @@ type Years []int type ClientDisable struct { Restart bool `json:"restart"` WebDAV bool `json:"webdav"` + MCP bool `json:"mcp"` Settings bool `json:"settings"` Places bool `json:"places"` Backups bool `json:"backups"` @@ -262,6 +263,7 @@ func (c *Config) ClientPublic() *ClientConfig { Disable: ClientDisable{ Restart: true, WebDAV: true, + MCP: c.DisableMCP(), Settings: c.DisableSettings(), Places: c.DisablePlaces(), Backups: true, @@ -297,6 +299,7 @@ func (c *Config) ClientPublic() *ClientConfig { SiteUrl: c.SiteUrl(), SiteDomain: c.SiteDomain(), SiteAuthor: c.SiteAuthor(), + SiteName: c.SiteName(), SiteTitle: c.SiteTitle(), SiteCaption: c.SiteCaption(), SiteDescription: c.SiteDescription(), @@ -333,7 +336,6 @@ func (c *Config) ClientPublic() *ClientConfig { Cameras: entity.Cameras{}, Lenses: entity.Lenses{}, Countries: entity.Countries{}, - People: entity.People{}, Tier: c.Hub().Tier(), Membership: c.Hub().Membership(), Customer: "", @@ -360,6 +362,7 @@ func (c *Config) ClientShare() *ClientConfig { Disable: ClientDisable{ Restart: true, WebDAV: c.DisableWebDAV(), + MCP: c.DisableMCP(), Settings: c.DisableSettings(), Places: c.DisablePlaces(), Backups: true, @@ -395,6 +398,7 @@ func (c *Config) ClientShare() *ClientConfig { SiteUrl: c.SiteUrl(), SiteDomain: c.SiteDomain(), SiteAuthor: c.SiteAuthor(), + SiteName: c.SiteName(), SiteTitle: c.SiteTitle(), SiteCaption: c.SiteCaption(), SiteDescription: c.SiteDescription(), @@ -433,7 +437,6 @@ func (c *Config) ClientShare() *ClientConfig { Cameras: entity.Cameras{}, Lenses: entity.Lenses{}, Countries: entity.Countries{}, - People: entity.People{}, Colors: colors.All.List(), Thumbs: Thumbs, Tier: c.Hub().Tier(), @@ -467,6 +470,7 @@ func (c *Config) ClientUser(withSettings bool) *ClientConfig { Backups: c.DisableBackups(), Restart: c.DisableRestart(), WebDAV: c.DisableWebDAV(), + MCP: c.DisableMCP(), Places: c.DisablePlaces(), TensorFlow: c.DisableTensorFlow(), Faces: c.DisableFaces(), @@ -501,6 +505,7 @@ func (c *Config) ClientUser(withSettings bool) *ClientConfig { SiteUrl: c.SiteUrl(), SiteDomain: c.SiteDomain(), SiteAuthor: c.SiteAuthor(), + SiteName: c.SiteName(), SiteTitle: c.SiteTitle(), SiteCaption: c.SiteCaption(), SiteDescription: c.SiteDescription(), @@ -540,7 +545,6 @@ func (c *Config) ClientUser(withSettings bool) *ClientConfig { Cameras: entity.Cameras{}, Lenses: entity.Lenses{}, Countries: entity.Countries{}, - People: entity.People{}, Colors: colors.All.List(), Thumbs: Thumbs, Tier: c.Hub().Tier(), @@ -694,7 +698,6 @@ func (c *Config) ClientUser(withSettings bool) *ClientConfig { // People are subjects with type person. cfg.Count.People, _ = query.PeopleCount() - cfg.People, _ = query.People() c.Db(). Where("id IN (SELECT photos.camera_id FROM photos WHERE photos.photo_quality > -1 OR photos.deleted_at IS NULL)"). diff --git a/internal/config/client_config_test.go b/internal/config/client_config_test.go index edd5c736e..6427bfc0d 100644 --- a/internal/config/client_config_test.go +++ b/internal/config/client_config_test.go @@ -31,6 +31,13 @@ func TestConfig_ClientConfig(t *testing.T) { assert.Equal(t, AuthModePasswd, result2.AuthMode) assert.Equal(t, false, result2.Public) }) + t.Run("SiteName", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.SiteName = "Acme Media" + cfg := c.ClientPublic() + assert.IsType(t, &ClientConfig{}, cfg) + assert.Equal(t, "Acme Media", cfg.SiteName) + }) t.Run("Values", func(t *testing.T) { c := TestConfig() @@ -73,6 +80,27 @@ func TestConfig_ClientConfig(t *testing.T) { }) } +func TestConfig_ClientConfigDisableMCP(t *testing.T) { + // ClientPublic, ClientShare, and ClientUser must all propagate the MCP + // disable flag so the frontend can hide any MCP-related controls when + // the endpoint is turned off via --disable-mcp / PHOTOPRISM_DISABLE_MCP. + c := NewMinimalTestConfigWithDb("client-mcp", t.TempDir()) + c.SetAuthMode(AuthModePasswd) + + original := c.Options().DisableMCP + t.Cleanup(func() { c.Options().DisableMCP = original }) + + c.Options().DisableMCP = false + assert.False(t, c.ClientPublic().Disable.MCP) + assert.False(t, c.ClientShare().Disable.MCP) + assert.False(t, c.ClientUser(true).Disable.MCP) + + c.Options().DisableMCP = true + assert.True(t, c.ClientPublic().Disable.MCP) + assert.True(t, c.ClientShare().Disable.MCP) + assert.True(t, c.ClientUser(true).Disable.MCP) +} + func TestConfig_ClientShareConfig(t *testing.T) { config := TestConfig() result := config.ClientShare() @@ -131,35 +159,38 @@ func TestConfig_ClientRoleConfig(t *testing.T) { assert.Equal(t, adminFeatures, f) expected := customize.FeatureSettings{ - Account: true, - Albums: true, - Archive: true, - Delete: true, - Download: true, - Edit: true, - BatchEdit: true, - Estimates: true, - Favorites: true, - Files: true, - Folders: true, - Import: true, - Labels: true, - Library: true, - Logs: true, - Calendar: true, - Moments: true, - People: true, - Places: true, - Private: true, - Ratings: true, - Reactions: true, - Review: true, - Search: true, - Settings: true, - Share: true, - Services: true, - Upload: true, - Videos: true, + Albums: true, + Archive: true, + Delete: true, + Download: true, + Edit: true, + BatchEdit: true, + Estimates: true, + Favorites: true, + Files: true, + Folders: true, + Import: true, + Labels: true, + Cameras: true, + Lenses: true, + Library: true, + Logs: true, + Calendar: true, + Moments: true, + People: true, + Places: true, + Private: true, + Ratings: true, + Reactions: true, + Review: true, + Search: true, + Account: true, + AppPasswords: true, + Settings: true, + Share: true, + Services: true, + Upload: true, + Videos: true, } assert.Equal(t, expected, f) @@ -171,35 +202,38 @@ func TestConfig_ClientRoleConfig(t *testing.T) { assert.NotEqual(t, adminFeatures, f) expected := customize.FeatureSettings{ - Account: true, - Albums: true, - Archive: false, - Delete: false, - Download: true, - Edit: false, - BatchEdit: false, - Estimates: true, - Favorites: false, - Files: false, - Folders: true, - Import: false, - Labels: false, - Library: false, - Logs: false, - Calendar: true, - Moments: true, - People: false, - Places: true, - Private: false, - Ratings: false, - Reactions: true, - Review: true, - Search: true, - Settings: true, - Share: false, - Services: false, - Upload: false, - Videos: true, + Albums: true, + Archive: false, + Delete: false, + Download: true, + Edit: false, + BatchEdit: false, + Estimates: true, + Favorites: false, + Files: false, + Folders: true, + Import: false, + Labels: false, + Cameras: false, + Lenses: false, + Library: false, + Logs: false, + Calendar: true, + Moments: true, + People: false, + Places: true, + Private: false, + Ratings: false, + Reactions: true, + Review: true, + Search: true, + Account: true, + AppPasswords: true, + Settings: true, + Share: false, + Services: false, + Upload: false, + Videos: true, } assert.Equal(t, expected, f) @@ -211,35 +245,38 @@ func TestConfig_ClientRoleConfig(t *testing.T) { assert.NotEqual(t, adminFeatures, f) expected := customize.FeatureSettings{ - Account: false, - Albums: true, - Archive: false, - Delete: false, - Download: true, - Edit: false, - BatchEdit: false, - Estimates: true, - Favorites: false, - Files: false, - Folders: true, - Import: false, - Labels: false, - Library: false, - Logs: false, - Calendar: true, - Moments: true, - People: false, - Places: true, - Private: false, - Ratings: false, - Reactions: false, - Review: true, - Search: false, - Settings: false, - Share: false, - Services: false, - Upload: false, - Videos: false, + Albums: true, + Archive: false, + Delete: false, + Download: true, + Edit: false, + BatchEdit: false, + Estimates: true, + Favorites: false, + Files: false, + Folders: true, + Import: false, + Labels: false, + Cameras: false, + Lenses: false, + Library: false, + Logs: false, + Calendar: true, + Moments: true, + People: false, + Places: true, + Private: false, + Ratings: false, + Reactions: false, + Review: true, + Search: false, + Account: false, + AppPasswords: false, + Settings: false, + Share: false, + Services: false, + Upload: false, + Videos: false, } assert.Equal(t, expected, f) @@ -255,6 +292,8 @@ func TestConfig_ClientRoleConfig(t *testing.T) { assert.False(t, f.Calendar) assert.False(t, f.Moments) assert.False(t, f.Labels) + assert.False(t, f.Cameras) + assert.False(t, f.Lenses) assert.False(t, f.People) assert.False(t, f.Settings) assert.False(t, f.Edit) @@ -299,6 +338,8 @@ func TestConfig_ClientSessionConfig(t *testing.T) { assert.True(t, f.Calendar) assert.True(t, f.Moments) assert.True(t, f.Labels) + assert.True(t, f.Cameras) + assert.True(t, f.Lenses) assert.True(t, f.People) assert.True(t, f.Settings) assert.True(t, f.Edit) @@ -331,6 +372,8 @@ func TestConfig_ClientSessionConfig(t *testing.T) { assert.True(t, f.Calendar) assert.True(t, f.Moments) assert.True(t, f.Labels) + assert.True(t, f.Cameras) + assert.True(t, f.Lenses) assert.True(t, f.People) assert.True(t, f.Settings) assert.True(t, f.Edit) @@ -362,6 +405,8 @@ func TestConfig_ClientSessionConfig(t *testing.T) { assert.True(t, f.Albums) assert.False(t, f.Moments) assert.False(t, f.Labels) + assert.False(t, f.Cameras) + assert.False(t, f.Lenses) assert.False(t, f.People) assert.False(t, f.Settings) assert.True(t, f.Edit) @@ -395,6 +440,8 @@ func TestConfig_ClientSessionConfig(t *testing.T) { assert.True(t, f.Moments) assert.True(t, f.Folders) assert.False(t, f.Labels) + assert.False(t, f.Cameras) + assert.False(t, f.Lenses) assert.False(t, f.People) assert.False(t, f.Settings) assert.False(t, f.Edit) @@ -428,6 +475,8 @@ func TestConfig_ClientSessionConfig(t *testing.T) { assert.True(t, f.Moments) assert.True(t, f.Folders) assert.False(t, f.Labels) + assert.False(t, f.Cameras) + assert.False(t, f.Lenses) assert.False(t, f.People) assert.False(t, f.Settings) assert.False(t, f.Edit) @@ -460,6 +509,8 @@ func TestConfig_ClientSessionConfig(t *testing.T) { assert.False(t, f.Albums) assert.False(t, f.Moments) assert.False(t, f.Labels) + assert.False(t, f.Cameras) + assert.False(t, f.Lenses) assert.False(t, f.People) assert.False(t, f.Settings) assert.False(t, f.Edit) @@ -490,6 +541,8 @@ func TestConfig_ClientSessionConfig(t *testing.T) { assert.True(t, f.Calendar) assert.True(t, f.Moments) assert.True(t, f.Labels) + assert.True(t, f.Cameras) + assert.True(t, f.Lenses) assert.True(t, f.People) assert.True(t, f.Settings) assert.True(t, f.Edit) @@ -522,6 +575,8 @@ func TestConfig_ClientSessionConfig(t *testing.T) { assert.False(t, f.Moments) assert.False(t, f.Folders) assert.False(t, f.Labels) + assert.False(t, f.Cameras) + assert.False(t, f.Lenses) assert.False(t, f.People) assert.False(t, f.Settings) assert.False(t, f.Edit) @@ -553,6 +608,8 @@ func TestConfig_ClientSessionConfig(t *testing.T) { assert.False(t, f.Calendar) assert.False(t, f.Moments) assert.False(t, f.Labels) + assert.False(t, f.Cameras) + assert.False(t, f.Lenses) assert.False(t, f.People) assert.True(t, f.Settings) assert.False(t, f.Edit) @@ -581,6 +638,7 @@ func TestConfig_ClientSessionConfig(t *testing.T) { f := cfg.Settings.Features assert.Equal(t, adminFeatures, f) }) + c.CleanupTestFolder() } func TestConfig_Flags(t *testing.T) { diff --git a/internal/config/config.go b/internal/config/config.go index 0d567a4d3..500d0ed6c 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -1,7 +1,7 @@ /* Package config provides global options, command-line flags, and user settings. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. @@ -33,7 +33,6 @@ import ( "os" "path/filepath" "reflect" - "runtime" "strings" "sync" "sync/atomic" @@ -57,6 +56,7 @@ import ( "github.com/photoprism/photoprism/internal/config/customize" "github.com/photoprism/photoprism/internal/config/ttl" "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/internal/ffmpeg" "github.com/photoprism/photoprism/internal/mutex" "github.com/photoprism/photoprism/internal/photoprism/dl" "github.com/photoprism/photoprism/internal/service/hub" @@ -65,6 +65,7 @@ import ( "github.com/photoprism/photoprism/pkg/checksum" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/fs/disk" "github.com/photoprism/photoprism/pkg/i18n" "github.com/photoprism/photoprism/pkg/rnd" "github.com/photoprism/photoprism/pkg/txt" @@ -268,6 +269,10 @@ func (c *Config) Init() error { // Initialize thumbnail package. thumb.Init(memory.FreeMemory(), c.IndexWorkers(), c.ThumbLibrary()) + // Set minimum free storage space in percent. + disk.StorageLowPct = c.StorageFree() + DisableStorageCheck.Store(disk.StorageLowPct <= 0) + // Load optional vision package configuration. if visionYaml := c.VisionYaml(); !fs.FileExistsNotEmpty(visionYaml) { // Do nothing. @@ -376,10 +381,13 @@ func (c *Config) Propagate() { thumb.SizeOnDemand = c.ThumbSizeUncached() thumb.JpegQualityDefault = c.JpegQuality() thumb.CachePublic = c.HttpCachePublic() - thumb.ExamplesPath = c.ExamplesPath() + thumb.SamplesPath = c.SamplesPath() thumb.IccProfilesPath = c.IccProfilesPath() initThumbs() + // Configure FFmpeg package. + ffmpeg.SetExclude(c.FFmpegExclude()) + // Configure video download package. dl.YtDlpBin = c.YtDlpBin() dl.FFmpegBin = c.FFmpegBin() @@ -437,7 +445,6 @@ func (c *Config) Propagate() { face.MatchDist = c.FaceMatchDist() face.SkipChildren = c.FaceSkipChildren() face.IgnoreBackground = !c.FaceAllowBackground() - face.DetectionAngles = c.FaceAngles() if err := face.ConfigureEngine(face.EngineSettings{ Name: c.FaceEngine(), ONNX: face.ONNXOptions{ @@ -841,129 +848,6 @@ func (c *Config) Shutdown() { } } -// IndexWorkers returns the number of indexing workers. -func (c *Config) IndexWorkers() int { - // Use one worker on systems with less than the recommended amount of memory. - if TotalMem < RecommendedMem { - return 1 - } - - // NumCPU returns the number of logical CPU cores. - cores := min( - // Limit to physical cores to avoid high load on HT capable CPUs. - runtime.NumCPU(), cpuid.CPU.PhysicalCores) - - // Limit number of workers when using SQLite3 to avoid database locking issues. - if c.DatabaseDriver() == SQLite3 && (cores >= 8 && c.options.IndexWorkers <= 0 || c.options.IndexWorkers > 4) { - return 4 - } - - // Return explicit value if set and not too large. - if c.options.IndexWorkers > runtime.NumCPU() { - return runtime.NumCPU() - } else if c.options.IndexWorkers > 0 { - return c.options.IndexWorkers - } - - // Use half the available cores by default. - if cores > 1 { - return cores / 2 - } - - return 1 -} - -// IndexSchedule returns the indexing schedule in cron format, e.g. "0 */3 * * *" to start indexing every 3 hours. -func (c *Config) IndexSchedule() string { - return Schedule(c.options.IndexSchedule) -} - -// WakeupInterval returns the duration between background worker runs -// required for face recognition and index maintenance (1-86400s). -func (c *Config) WakeupInterval() time.Duration { - if c.options.WakeupInterval <= 0 { - if c.Unsafe() { - // Worker can be disabled only in unsafe mode. - return time.Duration(0) - } else { - // Default to 15 minutes if no interval is set. - return DefaultWakeupInterval - } - } - - // Do not run more than once per minute. - if c.options.WakeupInterval < MinWakeupInterval/time.Second { - return MinWakeupInterval - } else if c.options.WakeupInterval < MinWakeupInterval { - c.options.WakeupInterval *= time.Second - } - - // Do not run less than once per day. - if c.options.WakeupInterval > MaxWakeupInterval { - return MaxWakeupInterval - } - - return c.options.WakeupInterval -} - -// AutoIndex returns the auto index delay duration. -func (c *Config) AutoIndex() time.Duration { - if c.options.AutoIndex < 0 { - return -1 * time.Second - } else if c.options.AutoIndex == 0 || c.options.AutoIndex > 604800 { - return DefaultAutoIndexDelay * time.Second - } - - return time.Duration(c.options.AutoIndex) * time.Second -} - -// AutoImport returns the auto import delay duration. -func (c *Config) AutoImport() time.Duration { - if c.options.AutoImport < 0 || c.ReadOnly() { - return -1 * time.Second - } else if c.options.AutoImport == 0 || c.options.AutoImport > 604800 { - return DefaultAutoImportDelay * time.Second - } - - return time.Duration(c.options.AutoImport) * time.Second -} - -// OriginalsLimit returns the maximum size of originals in MB. -func (c *Config) OriginalsLimit() int { - if c.options.OriginalsLimit <= 0 || c.options.OriginalsLimit > 100000 { - return -1 - } - - return c.options.OriginalsLimit -} - -// OriginalsLimitBytes returns the maximum size of originals in bytes. -func (c *Config) OriginalsLimitBytes() int64 { - if result := c.OriginalsLimit(); result <= 0 { - return -1 - } else { - return int64(result) * 1024 * 1024 - } -} - -// ResolutionLimit returns the maximum resolution of originals in megapixels (width x height). -func (c *Config) ResolutionLimit() int { - result := c.options.ResolutionLimit - - // Disabling or increasing the limit is at your own risk. - // Only sponsors receive support in case of problems. - switch { - case result == 0: - return DefaultResolutionLimit - case result < 0: - return -1 - case result > 900: - result = 900 - } - - return result -} - // RenewApiKeys renews the api credentials for maps and places. func (c *Config) RenewApiKeys() { if c.hub == nil { diff --git a/internal/config/config_app.go b/internal/config/config_app.go index 009859c5e..a6e1a01e2 100644 --- a/internal/config/config_app.go +++ b/internal/config/config_app.go @@ -14,10 +14,15 @@ import ( // DefaultAppColor specifies the default app background and splash screen color. var DefaultAppColor = "#19191a" -// AppName returns the app name when installed on a device. +// AppName returns the app name shown when installed as a PWA, preferring an explicit +// AppName, then the distinctive SiteName (SITE_NAME), then the SiteTitle. func (c *Config) AppName() string { name := strings.TrimSpace(c.options.AppName) + if name == "" { + name = c.SiteName() + } + if name == "" { name = c.SiteTitle() } @@ -93,6 +98,7 @@ func (c *Config) AppConfig() pwa.Config { BaseUri: c.BaseUri("/"), FrontendUri: c.FrontendUri(""), StaticUri: c.StaticUri(), + StaticPath: c.StaticPath(), SiteUrl: c.SiteUrl(), CdnUrl: c.CdnUrl("/"), ThemeUri: ThemeUri, diff --git a/internal/config/config_app_test.go b/internal/config/config_app_test.go index 359370d73..79ed8e6f3 100644 --- a/internal/config/config_app_test.go +++ b/internal/config/config_app_test.go @@ -11,8 +11,32 @@ import ( func TestConfig_AppName(t *testing.T) { c := NewConfig(CliTestContext()) - assert.Equal(t, "PhotoPrism", c.AppName()) + t.Run("ExplicitAppNameWins", func(t *testing.T) { + c.options.AppName = "My App" + c.options.SiteName = "Acme Media" + c.options.SiteTitle = "Our Trip" + assert.Equal(t, "My App", c.AppName()) + }) + t.Run("PrefersSiteNameOverSiteTitle", func(t *testing.T) { + c.options.AppName = "" + c.options.SiteName = "Acme Media" + c.options.SiteTitle = "Our Trip" + assert.Equal(t, "Acme Media", c.AppName()) + }) + t.Run("FallsBackToSiteTitle", func(t *testing.T) { + c.options.AppName = "" + c.options.SiteName = "" + c.options.SiteTitle = "Our Trip" + assert.Equal(t, "Our Trip", c.AppName()) + }) + t.Run("StripsQuotesAndClips", func(t *testing.T) { + c.options.AppName = `A'B"C` + assert.Equal(t, "ABC", c.AppName()) + }) + c.options.AppName = "" + c.options.SiteName = "" + c.options.SiteTitle = "" } func TestConfig_AppMode(t *testing.T) { @@ -35,6 +59,14 @@ func TestConfig_AppIcon(t *testing.T) { assert.Equal(t, "mint", c.AppIcon()) c.options.AppIcon = "bold" assert.Equal(t, "bold", c.AppIcon()) + c.options.AppIcon = "bloom" + assert.Equal(t, "bloom", c.AppIcon()) + c.options.AppIcon = "flower" + assert.Equal(t, "flower", c.AppIcon()) + c.options.AppIcon = "ring" + assert.Equal(t, "ring", c.AppIcon()) + c.options.AppIcon = "shutter" + assert.Equal(t, "shutter", c.AppIcon()) c.options.AppIcon = "logo" assert.Equal(t, "logo", c.AppIcon()) } @@ -94,9 +126,12 @@ func TestConfig_AppManifest(t *testing.T) { assert.Equal(t, appConf.Description, result.Description) assert.Equal(t, appConf.BaseUri, result.Scope) assert.Equal(t, pwa.StartUrl(appConf.BaseUri, appConf.FrontendUri), result.StartUrl) - assert.Len(t, result.Icons, len(pwa.IconSizes)) + assert.Len(t, result.Icons, len(pwa.IconSizes)+len(pwa.MaskableIconSizes)) assert.Len(t, result.Categories, len(pwa.Categories)) assert.Len(t, result.Permissions, len(pwa.Permissions)) + assert.NotEmpty(t, result.Lang) + assert.NotEmpty(t, result.Dir) + assert.Len(t, result.Screenshots, 2) cached := c.AppManifest() assert.NotEmpty(t, cached) @@ -105,7 +140,7 @@ func TestConfig_AppManifest(t *testing.T) { assert.Equal(t, appConf.Description, cached.Description) assert.Equal(t, appConf.BaseUri, cached.Scope) assert.Equal(t, pwa.StartUrl(appConf.BaseUri, appConf.FrontendUri), cached.StartUrl) - assert.Len(t, cached.Icons, len(pwa.IconSizes)) + assert.Len(t, cached.Icons, len(pwa.IconSizes)+len(pwa.MaskableIconSizes)) assert.Len(t, cached.Categories, len(pwa.Categories)) assert.Len(t, cached.Permissions, len(pwa.Permissions)) }) diff --git a/internal/config/config_auth_test.go b/internal/config/config_auth_test.go index 3198fea03..508b51725 100644 --- a/internal/config/config_auth_test.go +++ b/internal/config/config_auth_test.go @@ -118,8 +118,8 @@ func TestConfig_RegisterUri(t *testing.T) { func TestConfig_LoginUri(t *testing.T) { c := NewConfig(CliTestContext()) assert.Equal(t, "/library/login", c.LoginUri()) - c.options.FrontendUri = "/portal/admin/" - assert.Equal(t, "/portal/admin/login", c.LoginUri()) + c.options.FrontendUri = "/portal/" + assert.Equal(t, "/portal/login", c.LoginUri()) } func TestConfig_LoginInfo(t *testing.T) { diff --git a/internal/config/config_cdn.go b/internal/config/config_cdn.go index 2d322916a..487620421 100644 --- a/internal/config/config_cdn.go +++ b/internal/config/config_cdn.go @@ -5,24 +5,31 @@ import ( "strings" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/http/scheme" ) +// CdnBaseUrl returns the configured CDN URL normalized as a base URL, or "" if unset. +// Strips the scheme's default port so semantically equal Site and CDN URLs compare equal. +func (c *Config) CdnBaseUrl() string { + return scheme.NormalizeBaseURL(c.options.CdnUrl) +} + // CdnUrl returns the optional content delivery network URI without trailing slash. func (c *Config) CdnUrl(res string) string { - if c.options.CdnUrl == "" || c.options.CdnUrl == c.options.SiteUrl { + cdnUrl := c.CdnBaseUrl() + + if cdnUrl == "" || cdnUrl == c.SiteUrl() { return res } - return strings.TrimRight(c.options.CdnUrl, "/") + res + return strings.TrimRight(cdnUrl, "/") + res } // UseCdn checks if a Content Deliver Network (CDN) is used to serve static content. func (c *Config) UseCdn() bool { - if c.options.CdnUrl == "" || c.options.CdnUrl == c.options.SiteUrl { - return false - } + cdnUrl := c.CdnBaseUrl() - return true + return cdnUrl != "" && cdnUrl != c.SiteUrl() } // NoCdn checks if there is no Content Deliver Network (CDN) configured to serve static content. @@ -32,9 +39,11 @@ func (c *Config) NoCdn() bool { // CdnDomain returns the content delivery network domain name if specified. func (c *Config) CdnDomain() string { - if c.options.CdnUrl == "" || c.options.CdnUrl == c.options.SiteUrl { + cdnUrl := c.CdnBaseUrl() + + if cdnUrl == "" || cdnUrl == c.SiteUrl() { return "" - } else if u, err := url.Parse(c.options.CdnUrl); err != nil { + } else if u, err := url.Parse(cdnUrl); err != nil { return "" } else { return u.Hostname() @@ -43,7 +52,9 @@ func (c *Config) CdnDomain() string { // CdnVideo checks if videos should be streamed using the configured CDN. func (c *Config) CdnVideo() bool { - if c.options.CdnUrl == "" || c.options.CdnUrl == c.options.SiteUrl { + cdnUrl := c.CdnBaseUrl() + + if cdnUrl == "" || cdnUrl == c.SiteUrl() { return false } diff --git a/internal/config/config_cdn_test.go b/internal/config/config_cdn_test.go index 961970afe..1a573a680 100644 --- a/internal/config/config_cdn_test.go +++ b/internal/config/config_cdn_test.go @@ -32,6 +32,39 @@ func TestConfig_CdnUrl(t *testing.T) { assert.True(t, c.UseCdn()) } +func TestConfig_CdnUrl_DefaultPortEqualsSite(t *testing.T) { + c := NewConfig(CliTestContext()) + + c.options.SiteUrl = "https://host/" + c.options.CdnUrl = "https://host:443/" + assert.False(t, c.UseCdn()) + assert.True(t, c.NoCdn()) + assert.Equal(t, "/api/v1", c.CdnUrl(ApiUri)) + assert.Equal(t, "", c.CdnDomain()) + assert.False(t, c.CdnVideo()) + + c.options.SiteUrl = "https://host:443/" + c.options.CdnUrl = "https://host/" + assert.False(t, c.UseCdn()) + assert.True(t, c.NoCdn()) + + c.options.SiteUrl = "http://host/" + c.options.CdnUrl = "http://host:80/" + assert.False(t, c.UseCdn()) +} + +func TestConfig_CdnBaseUrl(t *testing.T) { + c := NewConfig(CliTestContext()) + + assert.Equal(t, "", c.CdnBaseUrl()) + c.options.CdnUrl = " " + assert.Equal(t, "", c.CdnBaseUrl()) + c.options.CdnUrl = "https://cdn.example.com:443/" + assert.Equal(t, "https://cdn.example.com/", c.CdnBaseUrl()) + c.options.CdnUrl = "http://foo:2342/foo/" + assert.Equal(t, "http://foo:2342/foo/", c.CdnBaseUrl()) +} + func TestConfig_CdnDomain(t *testing.T) { c := NewConfig(CliTestContext()) diff --git a/internal/config/config_cluster.go b/internal/config/config_cluster.go index 455f4e6a7..d9c064024 100644 --- a/internal/config/config_cluster.go +++ b/internal/config/config_cluster.go @@ -6,8 +6,12 @@ import ( urlpkg "net/url" "os" "path/filepath" + "sort" "strings" + "time" + "unicode" + "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/internal/service/cluster" "github.com/photoprism/photoprism/internal/service/cluster/theme" "github.com/photoprism/photoprism/pkg/clean" @@ -26,7 +30,10 @@ var DefaultPortalUrl = "https://portal.${PHOTOPRISM_CLUSTER_DOMAIN}" var DefaultNodeRole = cluster.RoleInstance // DefaultJWTAllowedScopes lists default OAuth scopes for cluster-issued JWTs. -var DefaultJWTAllowedScopes = "config cluster vision metrics" +// Includes "users" so the Portal-side user-management proxy +// (POST/PUT/DELETE /api/v1/cluster/nodes/{uuid}/users[/{uid}]) and the +// lifecycle sync push are accepted by the instance JWT scope allowlist. +var DefaultJWTAllowedScopes = "config cluster vision metrics mcp users" // SaveClusterOptionsUpdate persists a cluster options update to options.yml, // reloads in-memory options, and returns true when values changed. @@ -44,6 +51,7 @@ func (c *Config) SaveClusterOptionsUpdate(update cluster.OptionsUpdate) (bool, e setOptionString(patch, "ClusterCIDR", update.ClusterCIDR) setOptionString(patch, "NodeClientID", update.NodeClientID) setOptionString(patch, "JWKSUrl", update.JWKSUrl) + setOptionString(patch, "PortalLoginUrl", update.PortalLoginUrl) setOptionString(patch, "NodeUUID", update.NodeUUID) setOptionString(patch, "DatabaseDriver", update.DatabaseDriver) setOptionString(patch, "DatabaseDSN", update.DatabaseDSN) @@ -112,6 +120,174 @@ func (c *Config) Portal() bool { return c.NodeRole() == cluster.RolePortal } +// ClusterAllowGroups returns the normalized group identifiers admitted to this +// instance for Portal cluster admission, including the keys of +// ClusterAllowGroupRoles so a role mapping alone admits its groups. +func (c *Config) ClusterAllowGroups() []string { + seen := make(map[string]struct{}) + result := make([]string, 0, len(c.options.ClusterAllowGroups)) + + add := func(id string) { + if n := normalizeGroupID(id); n != "" { + if _, dup := seen[n]; !dup { + seen[n] = struct{}{} + result = append(result, n) + } + } + } + + for _, entry := range c.options.ClusterAllowGroups { + for _, id := range splitGroupList(entry) { + add(id) + } + } + + // Role-map keys join the admitted set in sorted order for stable output. + roles := c.ClusterAllowGroupRoles() + keys := make([]string, 0, len(roles)) + + for group := range roles { + keys = append(keys, group) + } + + sort.Strings(keys) + + for _, group := range keys { + add(group) + } + + if len(result) == 0 { + return nil + } + + return result +} + +// ClusterAllowGroupRoles maps normalized group identifiers to the instance role +// granted on Portal cluster admission, from comma- or whitespace-separated +// GROUP=ROLE pairs. acl.ClusterInstanceRole validation does not depend on the +// edition role table, so it resolves correctly during early bootstrap too. +func (c *Config) ClusterAllowGroupRoles() map[string]string { + if len(c.options.ClusterAllowGroupRoles) == 0 { + return nil + } + + result := make(map[string]string, len(c.options.ClusterAllowGroupRoles)) + + for _, entry := range c.options.ClusterAllowGroupRoles { + for _, pair := range splitGroupList(entry) { + group, roleName, ok := parseGroupRolePair(pair) + + if !ok { + continue + } + + role, valid := acl.ClusterInstanceRole(roleName) + + if !valid { + continue + } + + result[group] = role.String() + } + } + + if len(result) == 0 { + return nil + } + + return result +} + +// ClusterGroupsFullView reports whether the Portal should send the user's full +// group set to this instance instead of only the contributing groups. +func (c *Config) ClusterGroupsFullView() bool { + return c.options.ClusterGroupsFullView +} + +// splitGroupList splits a raw option entry into group identifiers, accepting +// comma- and whitespace-separated lists. +func splitGroupList(s string) []string { + return strings.FieldsFunc(s, func(r rune) bool { + return r == ',' || unicode.IsSpace(r) + }) +} + +// parseGroupRolePair splits a single GROUP=ROLE (or GROUP:ROLE) pair, returning +// the normalized group id and the raw role string. ok is false for a malformed +// pair (missing separator, empty group, or empty role). +func parseGroupRolePair(pair string) (group, role string, ok bool) { + sep := strings.IndexAny(pair, "=:") + if sep < 1 || sep >= len(pair)-1 { + return "", "", false + } + group = normalizeGroupID(pair[:sep]) + role = strings.TrimSpace(pair[sep+1:]) + return group, role, group != "" && role != "" +} + +// PortalOIDCIssuer returns the issuer URL advertised by the Portal's OIDC OP +// (discovery doc, ID tokens, userinfo). Falls back to SiteUrl when the +// `PHOTOPRISM_PORTAL_OIDC_ISSUER` override is unset. +func (c *Config) PortalOIDCIssuer() string { + if iss := strings.TrimSpace(c.options.PortalOIDCIssuer); iss != "" { + return iss + } + return c.SiteUrl() +} + +// portalOIDCTTLBounds are the configurable lower / upper bounds for the +// Portal OIDC OP token and code TTLs. Going below the floor would push +// past the recommended single-request window for an interactive login; +// going above the ceiling weakens the security posture of the OP. +const ( + portalOIDCTTLMin = 60 + portalOIDCTTLMax = 900 + portalOIDCCodeTTLMin = 30 + portalOIDCCodeTTLMax = 300 +) + +// PortalOIDCTTL returns the configured access-token / ID-token lifetime for +// the Portal OIDC OP, clamped to a safe range. Defaults to 300 seconds and +// caps at 900. +func (c *Config) PortalOIDCTTL() time.Duration { + return clampDurationSeconds(c.options.PortalOIDCTTL, portalOIDCTTLMin, portalOIDCTTLMax, 300) +} + +// PortalOIDCCodeTTL returns the authorization-code lifetime for the Portal +// OIDC OP. Defaults to 60 seconds and caps at 300. +func (c *Config) PortalOIDCCodeTTL() time.Duration { + return clampDurationSeconds(c.options.PortalOIDCCodeTTL, portalOIDCCodeTTLMin, portalOIDCCodeTTLMax, 60) +} + +// PortalOIDCDefaultPolicyChooser reports whether the Portal OIDC OP should +// route multi-instance logins through the chooser (default), as opposed to +// `direct` which always honors the requested client_id without prompting. +func (c *Config) PortalOIDCDefaultPolicyChooser() bool { + switch strings.ToLower(strings.TrimSpace(c.options.PortalOIDCDefaultPolicy)) { + case "direct": + return false + default: + return true + } +} + +// clampDurationSeconds returns the configured value clamped to [min, max]. +// A zero or negative configured value falls back to `def`. +func clampDurationSeconds(value, minSec, maxSec, defSec int) time.Duration { + v := value + if v <= 0 { + v = defSec + } + if v < minSec { + v = minSec + } + if v > maxSec { + v = maxSec + } + return time.Duration(v) * time.Second +} + // PortalUrl returns the URL of the cluster management portal server, if configured. func (c *Config) PortalUrl() string { if c.options.PortalUrl == "" { @@ -483,43 +659,77 @@ func (c *Config) JWKSUrl() string { return strings.TrimSpace(c.options.JWKSUrl) } -// SetJWKSUrl updates the configured JWKS endpoint for portal-issued JWTs. +// validClusterURL returns the trimmed URL and true when it is an absolute +// HTTPS URL, or an HTTP URL on a loopback host; an empty input is valid and +// returns the empty string. +func validClusterURL(url string) (string, bool) { + trimmed := strings.TrimSpace(url) + if trimmed == "" { + return "", true + } + + parsed, err := urlpkg.Parse(trimmed) + if err != nil || parsed == nil || parsed.Scheme == "" || parsed.Host == "" { + return trimmed, false + } + + switch strings.ToLower(parsed.Scheme) { + case "https": + return trimmed, true + case "http": + return trimmed, dns.IsLoopbackHost(parsed.Hostname()) + default: + return trimmed, false + } +} + +// SetJWKSUrl updates the configured JWKS endpoint for portal-issued JWTs +// (HTTPS, or HTTP for loopback hosts only). func (c *Config) SetJWKSUrl(url string) { if c == nil || c.options == nil { return } - trimmed := strings.TrimSpace(url) - if trimmed == "" { - c.options.JWKSUrl = "" - return - } - - parsed, err := urlpkg.Parse(trimmed) - if err != nil || parsed == nil || parsed.Scheme == "" || parsed.Host == "" { - log.Warnf("config: ignoring JWKS URL %q (%v)", trimmed, err) - return - } - - scheme := strings.ToLower(parsed.Scheme) - host := parsed.Hostname() - - switch scheme { - case "https": - // Always allowed. - case "http": - if !dns.IsLoopbackHost(host) { - log.Warnf("config: rejecting JWKS URL %q (http only allowed for localhost/loopback)", trimmed) - return - } - default: - log.Warnf("config: rejecting JWKS URL %q (unsupported scheme)", trimmed) + trimmed, ok := validClusterURL(url) + if !ok { + log.Warnf("config: rejecting JWKS URL %s (must be https, or http on loopback)", clean.Log(trimmed)) return } c.options.JWKSUrl = trimmed } +// PortalLoginUrl returns the browser-facing Portal login page URL. Nodes +// persist it from the Portal's register response, which derives it from the +// Portal's SiteUrl and login route; the frontend uses it to land cluster +// sign-outs on the Portal login instead of re-initiating the instance OIDC +// roundtrip with a pinned return_to. Stored values are re-validated on read, +// so an invalid or stale URL (e.g. from a hand-edited options.yml or env) +// never becomes a browser redirect target. +func (c *Config) PortalLoginUrl() string { + if v, ok := validClusterURL(c.options.PortalLoginUrl); ok { + return v + } + + return "" +} + +// SetPortalLoginUrl updates the browser-facing Portal login page URL +// (HTTPS, or HTTP for loopback hosts only). +func (c *Config) SetPortalLoginUrl(url string) { + if c == nil || c.options == nil { + return + } + + trimmed, ok := validClusterURL(url) + if !ok { + log.Warnf("config: rejecting portal login URL %s (must be https, or http on loopback)", clean.Log(trimmed)) + return + } + + c.options.PortalLoginUrl = trimmed +} + // JWKSCacheTTL returns the JWKS cache lifetime in seconds (default 300, max 3600). func (c *Config) JWKSCacheTTL() int { if c.options.JWKSCacheTTL <= 0 { diff --git a/internal/config/config_cluster_test.go b/internal/config/config_cluster_test.go index d9780a30a..38093a031 100644 --- a/internal/config/config_cluster_test.go +++ b/internal/config/config_cluster_test.go @@ -20,6 +20,201 @@ import ( const shortTestJoinToken = "short-token" +func TestConfig_ClusterAllowGroups(t *testing.T) { + t.Run("Default", func(t *testing.T) { + c := NewConfig(CliTestContext()) + assert.Nil(t, c.ClusterAllowGroups()) + }) + t.Run("NormalizesAndSplits", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.ClusterAllowGroups = []string{"Media-Acme-Admin, Media-Acme-Viewer", "media-acme-admin"} + assert.Equal(t, []string{"media-acme-admin", "media-acme-viewer"}, c.ClusterAllowGroups()) + }) + t.Run("IncludesRoleMapKeys", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.ClusterAllowGroupRoles = []string{"Media-Acme-Admin=admin"} + assert.Equal(t, []string{"media-acme-admin"}, c.ClusterAllowGroups(), + "a role mapping alone must admit its groups") + }) +} + +func TestConfig_ClusterAllowGroupRoles(t *testing.T) { + t.Run("Default", func(t *testing.T) { + c := NewConfig(CliTestContext()) + assert.Nil(t, c.ClusterAllowGroupRoles()) + }) + t.Run("AcceptsAllInstanceRoles", func(t *testing.T) { + // Roles must validate independently of the registered edition role + // table, since this is read during early bootstrap before activation. + c := NewConfig(CliTestContext()) + c.options.ClusterAllowGroupRoles = []string{ + "g-admin=admin", "g-manager=manager", "g-user=user", + "g-contributor=contributor", "g-viewer:viewer", "g-guest=guest", + } + assert.Equal(t, map[string]string{ + "g-admin": "admin", "g-manager": "manager", "g-user": "user", + "g-contributor": "contributor", "g-viewer": "viewer", "g-guest": "guest", + }, c.ClusterAllowGroupRoles()) + }) + t.Run("ToleratesWhitespaceSeparatedPairs", func(t *testing.T) { + // A StringSlice env splits on commas, so a space-separated value arrives + // as a single element; it must still resolve to all its pairs. + c := NewConfig(CliTestContext()) + c.options.ClusterAllowGroupRoles = []string{"g-admin=admin g-viewer=viewer"} + assert.Equal(t, map[string]string{"g-admin": "admin", "g-viewer": "viewer"}, c.ClusterAllowGroupRoles()) + }) + t.Run("DropsInvalidEntries", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.ClusterAllowGroupRoles = []string{"a=cluster_admin", "b=visitor", "c=bogus", "=admin", "noseparator", ""} + assert.Nil(t, c.ClusterAllowGroupRoles(), "non-instance roles and malformed pairs must be dropped") + }) +} + +func TestConfig_ClusterGroupsFullView(t *testing.T) { + c := NewConfig(CliTestContext()) + assert.False(t, c.ClusterGroupsFullView()) + c.options.ClusterGroupsFullView = true + assert.True(t, c.ClusterGroupsFullView()) +} + +func TestSplitGroupList(t *testing.T) { + assert.Equal(t, []string{"a", "b", "c"}, splitGroupList("a,b c")) + assert.Empty(t, splitGroupList(" , ")) +} + +func TestReportGroupRoles(t *testing.T) { + assert.Equal(t, "", reportGroupRoles(nil)) + assert.Equal(t, "a=admin, b=guest", reportGroupRoles(map[string]string{"b": "guest", "a": "admin"})) +} + +func TestConfig_PortalLoginUrl(t *testing.T) { + t.Run("Default", func(t *testing.T) { + c := NewConfig(CliTestContext()) + assert.Equal(t, "", c.PortalLoginUrl()) + }) + t.Run("SetterValidates", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.SetPortalLoginUrl(" https://portal.example.com/portal/login ") + assert.Equal(t, "https://portal.example.com/portal/login", c.PortalLoginUrl()) + c.SetPortalLoginUrl("http://127.0.0.1:2342/portal/login") + assert.Equal(t, "http://127.0.0.1:2342/portal/login", c.PortalLoginUrl(), "http loopback must be allowed") + c.SetPortalLoginUrl("http://portal.example.com/portal/login") + assert.Equal(t, "http://127.0.0.1:2342/portal/login", c.PortalLoginUrl(), "http non-loopback must be rejected") + c.SetPortalLoginUrl("ftp://portal.example.com/login") + assert.Equal(t, "http://127.0.0.1:2342/portal/login", c.PortalLoginUrl(), "unsupported schemes must be rejected") + c.SetPortalLoginUrl("") + assert.Equal(t, "", c.PortalLoginUrl(), "an empty value must clear the URL") + }) + t.Run("GetterRejectsStoredInvalidValues", func(t *testing.T) { + // Values can bypass the setter (env, flag, hand-edited options.yml, or a + // stale persisted entry) — the getter must never hand them to the browser. + c := NewConfig(CliTestContext()) + for _, v := range []string{"javascript:alert(1)", "http://portal.example.com/login", "://nope", "ftp://x/login"} { + c.options.PortalLoginUrl = v + assert.Equal(t, "", c.PortalLoginUrl(), "stored value %q must be rejected on read", v) + } + c.options.PortalLoginUrl = "https://portal.example.com/portal/login" + assert.Equal(t, "https://portal.example.com/portal/login", c.PortalLoginUrl()) + }) +} + +func TestValidClusterURL(t *testing.T) { + t.Run("Valid", func(t *testing.T) { + for _, v := range []string{"", "https://portal.example.com/login", "http://127.0.0.1:2342/login", "http://localhost/login"} { + _, ok := validClusterURL(v) + assert.True(t, ok, "%q must be valid", v) + } + }) + t.Run("Invalid", func(t *testing.T) { + for _, v := range []string{"http://portal.example.com/login", "javascript:alert(1)", "://nope", "/relative/login"} { + _, ok := validClusterURL(v) + assert.False(t, ok, "%q must be invalid", v) + } + }) + t.Run("Trims", func(t *testing.T) { + v, ok := validClusterURL(" https://a.example.com/ ") + assert.True(t, ok) + assert.Equal(t, "https://a.example.com/", v) + }) +} + +func TestConfig_PortalOIDCIssuer(t *testing.T) { + t.Run("DefaultsToSiteUrl", func(t *testing.T) { + c := NewConfig(CliTestContext()) + assert.Equal(t, c.SiteUrl(), c.PortalOIDCIssuer()) + }) + t.Run("FollowsSiteUrlOverride", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.SiteUrl = "https://portal.example.com/" + assert.Equal(t, "https://portal.example.com/", c.PortalOIDCIssuer()) + }) + t.Run("ExplicitOverrideWins", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.SiteUrl = "https://site.example.com/" + c.options.PortalOIDCIssuer = "https://portal-issuer.example.com/" + assert.Equal(t, "https://portal-issuer.example.com/", c.PortalOIDCIssuer()) + }) +} + +func TestConfig_PortalOIDCTTL(t *testing.T) { + t.Run("DefaultsToFiveMinutes", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.PortalOIDCTTL = 0 + assert.Equal(t, 300*time.Second, c.PortalOIDCTTL()) + }) + t.Run("ClampsToMin", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.PortalOIDCTTL = 10 + assert.Equal(t, 60*time.Second, c.PortalOIDCTTL()) + }) + t.Run("ClampsToMax", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.PortalOIDCTTL = 99999 + assert.Equal(t, 900*time.Second, c.PortalOIDCTTL()) + }) + t.Run("HonorsExplicit", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.PortalOIDCTTL = 600 + assert.Equal(t, 600*time.Second, c.PortalOIDCTTL()) + }) +} + +func TestConfig_PortalOIDCCodeTTL(t *testing.T) { + t.Run("DefaultsToSixtySeconds", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.PortalOIDCCodeTTL = 0 + assert.Equal(t, 60*time.Second, c.PortalOIDCCodeTTL()) + }) + t.Run("ClampsToMin", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.PortalOIDCCodeTTL = 5 + assert.Equal(t, 30*time.Second, c.PortalOIDCCodeTTL()) + }) + t.Run("ClampsToMax", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.PortalOIDCCodeTTL = 1000 + assert.Equal(t, 300*time.Second, c.PortalOIDCCodeTTL()) + }) +} + +func TestConfig_PortalOIDCDefaultPolicyChooser(t *testing.T) { + t.Run("DefaultIsChooser", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.PortalOIDCDefaultPolicy = "" + assert.True(t, c.PortalOIDCDefaultPolicyChooser()) + }) + t.Run("Direct", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.PortalOIDCDefaultPolicy = "direct" + assert.False(t, c.PortalOIDCDefaultPolicyChooser()) + }) + t.Run("UnknownValueDefaultsToChooser", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.PortalOIDCDefaultPolicy = "garbage" + assert.True(t, c.PortalOIDCDefaultPolicyChooser()) + }) +} + func TestConfig_PortalUrl(t *testing.T) { t.Run("Unset", func(t *testing.T) { c := NewConfig(CliTestContext()) @@ -225,7 +420,7 @@ func TestConfig_Cluster(t *testing.T) { c.options.JWTScope = "cluster vision" assert.Equal(t, list.ParseAttr("cluster vision"), c.JWTAllowedScopes()) c.options.JWTScope = "" - assert.Equal(t, list.ParseAttr("config cluster vision metrics"), c.JWTAllowedScopes()) + assert.Equal(t, list.ParseAttr("config cluster vision metrics mcp users"), c.JWTAllowedScopes()) }) t.Run("Paths", func(t *testing.T) { c := NewConfig(CliTestContext()) diff --git a/internal/config/config_const.go b/internal/config/config_const.go index 3838dd329..ba8a35a14 100644 --- a/internal/config/config_const.go +++ b/internal/config/config_const.go @@ -27,6 +27,12 @@ const CustomStaticUri = "/c/static" // ThemeUri defines the optional theme URI path for serving theme assets. const ThemeUri = "/_theme" +// IndexWorkersAuto is the sentinel value of the index-workers option that +// asks IndexWorkers() to derive the worker count from the available CPU +// cores and database driver. Operators can keep "auto" or set a positive +// numeric string to pin the worker count explicitly. +const IndexWorkersAuto = "auto" + // DefaultIndexSchedule defines the default indexing schedule in cron format. const DefaultIndexSchedule = "" // e.g. "0 */3 * * *" for every 3 hours diff --git a/internal/config/config_db.go b/internal/config/config_db.go index 3f8698d15..feffa3a6d 100644 --- a/internal/config/config_db.go +++ b/internal/config/config_db.go @@ -8,6 +8,7 @@ import ( "runtime" "strconv" "strings" + "sync" "time" "github.com/jinzhu/gorm" @@ -25,49 +26,55 @@ import ( "github.com/photoprism/photoprism/pkg/txt" ) -// SQL Databases. -// TODO: PostgreSQL support requires upgrading GORM, so generic column data types can be used. -const ( - Auto = "auto" - MySQL = dsn.DriverMySQL - MariaDB = dsn.DriverMariaDB - Postgres = dsn.DriverPostgres - SQLite3 = dsn.DriverSQLite3 -) +var postgresSupportWarnOnce sync.Once + +// Auto requests automatic detection of an implementation-defined default +// (e.g. the database driver). The canonical SQL driver identifiers live in +// pkg/dsn (dsn.DriverMySQL, dsn.DriverSQLite3, …). +const Auto = "auto" // DatabaseDriver returns the database driver name. func (c *Config) DatabaseDriver() string { c.normalizeDatabaseDSN() - switch strings.ToLower(c.options.DatabaseDriver) { - case MySQL, MariaDB: - c.options.DatabaseDriver = MySQL - case SQLite3, "sqlite", "test", "file", "": - c.options.DatabaseDriver = SQLite3 - case "tidb": + switch dsn.ParseDriver(c.options.DatabaseDriver) { + case dsn.DriverMySQL, dsn.DriverMariaDB: + c.options.DatabaseDriver = dsn.DriverMySQL + case dsn.DriverPostgres: + // See issue #47 and <https://github.com/photoprism/photoprism/pull/4831>. + postgresSupportWarnOnce.Do(func() { + log.Warnf("config: support for PostgreSQL is not yet available in this version") + }) + c.options.DatabaseDriver = dsn.DriverPostgres + case dsn.DriverSQLite3, dsn.DriverNone, dsn.DriverAuto: + c.options.DatabaseDriver = dsn.DriverSQLite3 + case dsn.DriverTiDB: log.Warnf("config: database driver 'tidb' is deprecated, using sqlite") - c.options.DatabaseDriver = SQLite3 + c.options.DatabaseDriver = dsn.DriverSQLite3 c.options.DatabaseDSN = "" default: log.Warnf("config: unsupported database driver %s, using sqlite", c.options.DatabaseDriver) - c.options.DatabaseDriver = SQLite3 + c.options.DatabaseDriver = dsn.DriverSQLite3 c.options.DatabaseDSN = "" } return c.options.DatabaseDriver } -// DatabaseDriverName returns the formatted database driver name. +// DatabaseDriverName returns the formatted database driver name. Input is +// always canonical after DatabaseDriver(); the default arm is defensive. func (c *Config) DatabaseDriverName() string { switch c.DatabaseDriver() { - case MySQL, MariaDB: + case dsn.DriverMySQL: return "MariaDB" - case SQLite3, "sqlite", "test", "file", "": + case dsn.DriverPostgres: + return "PostgreSQL" + case dsn.DriverSQLite3: return "SQLite" - case "tidb": - return "TiDB" + case dsn.DriverAuto: + return "Auto" default: - return "unsupported database" + return "Unsupported" } } @@ -92,7 +99,7 @@ func (c *Config) DatabaseSsl() bool { } switch c.DatabaseDriver() { - case MySQL: + case dsn.DriverMySQL: // see https://mariadb.org/mission-impossible-zero-configuration-ssl/ return c.IsDatabaseVersion("v11.4") default: @@ -115,7 +122,7 @@ func (c *Config) DatabaseDSN() string { // Generate matching database DSN based on the configured database driver. if c.NoDatabaseDSN() { switch c.DatabaseDriver() { - case MySQL: + case dsn.DriverMySQL: databaseServer := c.DatabaseServer() // Connect via Unix Domain Socket? @@ -135,18 +142,24 @@ func (c *Config) DatabaseDSN() string { dsn.Params[dsn.DriverMySQL], c.DatabaseTimeout(), ) - case Postgres: + case dsn.DriverPostgres: + databaseServer := c.DatabaseServer() + d := dsn.DSN{ + Driver: dsn.DriverPostgres, + Server: databaseServer, + } + return fmt.Sprintf( "user=%s password=%s dbname=%s host=%s port=%d connect_timeout=%d %s", c.DatabaseUser(), c.DatabasePassword(), c.DatabaseName(), - c.DatabaseHost(), - c.DatabasePort(), + d.Host(), + d.Port(), c.DatabaseTimeout(), dsn.Params[dsn.DriverPostgres], ) - case SQLite3: + case dsn.DriverSQLite3: return filepath.Join(c.StoragePath(), fmt.Sprintf("index.db?%s", dsn.Params[dsn.DriverSQLite3])) default: log.Errorf("config: empty database dsn") @@ -155,7 +168,7 @@ func (c *Config) DatabaseDSN() string { } // If missing, add the required parameters to the configured MySQL/MariaDB DSN. - if c.DatabaseDriver() == MySQL && !strings.Contains(c.options.DatabaseDSN, "?") { + if c.DatabaseDriver() == dsn.DriverMySQL && !strings.Contains(c.options.DatabaseDSN, "?") { c.options.DatabaseDSN = fmt.Sprintf( "%s?%s&timeout=%ds", c.options.DatabaseDSN, @@ -181,7 +194,7 @@ func (c *Config) HasDatabaseDSN() bool { // ReportDatabaseDSN checks if the database data source name (DSN) should be reported // instead of database name, server, user, and password. func (c *Config) ReportDatabaseDSN() bool { - if c.DatabaseDriver() == SQLite3 { + if c.DatabaseDriver() == dsn.DriverSQLite3 { return true } @@ -192,7 +205,7 @@ func (c *Config) ReportDatabaseDSN() bool { func (c *Config) ParseDatabaseDSN() { if c.NoDatabaseDSN() { return - } else if c.options.DatabaseServer != "" && c.DatabaseDriver() == SQLite3 { + } else if c.options.DatabaseServer != "" && c.DatabaseDriver() == dsn.DriverSQLite3 { return } @@ -214,7 +227,7 @@ func (c *Config) DatabaseFile() string { func (c *Config) DatabaseServer() string { c.ParseDatabaseDSN() - if c.DatabaseDriver() == SQLite3 { + if c.DatabaseDriver() == dsn.DriverSQLite3 { return "" } else if c.options.DatabaseServer == "" { return localhost @@ -227,7 +240,7 @@ func (c *Config) DatabaseServer() string { func (c *Config) DatabaseHost() string { c.ParseDatabaseDSN() - if c.DatabaseDriver() == SQLite3 { + if c.DatabaseDriver() == dsn.DriverSQLite3 { return "" } @@ -239,7 +252,7 @@ func (c *Config) DatabaseHost() string { func (c *Config) DatabasePort() int { c.ParseDatabaseDSN() - if c.DatabaseDriver() == SQLite3 { + if c.DatabaseDriver() == dsn.DriverSQLite3 { return 0 } @@ -249,7 +262,7 @@ func (c *Config) DatabasePort() int { // DatabasePortString the database server port as string. func (c *Config) DatabasePortString() string { - if c.DatabaseDriver() == SQLite3 { + if c.DatabaseDriver() == dsn.DriverSQLite3 { return "" } @@ -260,7 +273,7 @@ func (c *Config) DatabasePortString() string { func (c *Config) DatabaseName() string { c.ParseDatabaseDSN() - if c.DatabaseDriver() == SQLite3 { + if c.DatabaseDriver() == dsn.DriverSQLite3 { return c.DatabaseDSN() } else if c.options.DatabaseName == "" { return "photoprism" @@ -271,7 +284,7 @@ func (c *Config) DatabaseName() string { // DatabaseUser returns the database user name. func (c *Config) DatabaseUser() string { - if c.DatabaseDriver() == SQLite3 { + if c.DatabaseDriver() == dsn.DriverSQLite3 { return "" } @@ -286,7 +299,7 @@ func (c *Config) DatabaseUser() string { // DatabasePassword returns the database user password. func (c *Config) DatabasePassword() string { - if c.DatabaseDriver() == SQLite3 { + if c.DatabaseDriver() == dsn.DriverSQLite3 { return "" } @@ -358,7 +371,7 @@ func (c *Config) DatabaseProvisionPrefix() string { // ShouldAutoRotateDatabase decides whether callers should request DB rotation automatically. // It is used by both the CLI and node bootstrap to avoid unnecessary provisioning calls. func (c *Config) ShouldAutoRotateDatabase() bool { - if c.Portal() || c.DatabaseDriver() != MySQL { + if c.Portal() || c.DatabaseDriver() != dsn.DriverMySQL { return false } @@ -423,8 +436,14 @@ func (c *Config) Db() *gorm.DB { return c.db } -// CloseDb closes the db connection (if any). +// CloseDb closes the db connection (if any). Before tearing down the +// connection it drains async work registered with entity.AsyncJobAdd so +// goroutines launched by UpdateCountsAsync, UpdateCoversAsync, and +// similar helpers do not race the provider being nilled and panic on a +// nil dialect lookup. func (c *Config) CloseDb() error { + entity.WaitForAsyncJobs() + if c.db != nil { if err := c.db.Close(); err == nil { c.db = nil @@ -440,11 +459,11 @@ func (c *Config) CloseDb() error { // SetDbOptions sets the database collation to unicode if supported. func (c *Config) SetDbOptions() { switch c.DatabaseDriver() { - case MySQL, MariaDB: + case dsn.DriverMySQL, dsn.DriverMariaDB: c.Db().Set("gorm:table_options", "ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci") - case Postgres: + case dsn.DriverPostgres: // Ignore for now. - case SQLite3: + case dsn.DriverSQLite3: // Not required as Unicode is default. } } @@ -453,7 +472,9 @@ func (c *Config) SetDbOptions() { // sets the database options and connection provider. func (c *Config) RegisterDb() { if err := c.connectDb(); err != nil { - log.Errorf("config: %s (register db)") + // Report via the system log, not the database-persisted logger, so a + // connection failure cannot trigger a follow-up error writing to the DB. + event.SystemError([]string{"config", "database", "register", "%s"}, err) return } @@ -515,7 +536,7 @@ func (c *Config) checkDb(db *gorm.DB) error { } switch c.DatabaseDriver() { - case MySQL: + case dsn.DriverMySQL: type Res struct { Value string `gorm:"column:Value;"` } @@ -540,11 +561,11 @@ func (c *Config) checkDb(db *gorm.DB) error { case c.dbVersion == "": log.Warnf("config: unknown database server version") case !c.IsDatabaseVersion("v10.0.0"): - return fmt.Errorf("config: MySQL %s is not supported, see https://docs.photoprism.app/getting-started/#databases", c.dbVersion) + return fmt.Errorf("MySQL %s is not supported, see https://docs.photoprism.app/getting-started/#databases", c.dbVersion) case !c.IsDatabaseVersion("v10.5.12"): - return fmt.Errorf("config: MariaDB %s is not supported, see https://docs.photoprism.app/getting-started/#databases", c.dbVersion) + return fmt.Errorf("MariaDB %s is not supported, see https://docs.photoprism.app/getting-started/#databases", c.dbVersion) } - case SQLite3: + case dsn.DriverSQLite3: type Res struct { Value string `gorm:"column:Value;"` } @@ -585,11 +606,11 @@ func (c *Config) connectDb() error { dbDsn := c.DatabaseDSN() if dbDriver == "" { - return errors.New("config: database driver not specified") + return errors.New("driver not specified") } if dbDsn == "" { - return errors.New("config: database DSN not specified") + return errors.New("DSN not specified") } // Open database connection. @@ -624,7 +645,9 @@ func (c *Config) connectDb() error { // Check database server version. if err = c.checkDb(db); err != nil { if c.Unsafe() { - log.Error(err) + // Report via the system log so a database problem is not written to + // the database-persisted error log. + event.SystemError([]string{"config", "database", "check", "%s"}, err) } else { return err } diff --git a/internal/config/config_db_test.go b/internal/config/config_db_test.go index 2182e55db..e870fe418 100644 --- a/internal/config/config_db_test.go +++ b/internal/config/config_db_test.go @@ -6,6 +6,8 @@ import ( "github.com/stretchr/testify/assert" + "github.com/photoprism/photoprism/pkg/dsn" + "github.com/photoprism/photoprism/internal/service/cluster" ) @@ -26,26 +28,72 @@ func TestConfig_DatabaseDriver(t *testing.T) { c := NewConfig(CliTestContext()) resetDatabaseOptions(c) - assert.Equal(t, SQLite3, c.DatabaseDriver()) + assert.Equal(t, dsn.DriverSQLite3, c.DatabaseDriver()) }) t.Run("NormalizesDeprecatedDSN", func(t *testing.T) { c := NewConfig(CliTestContext()) resetDatabaseOptions(c) - c.options.DatabaseDriver = MySQL + c.options.DatabaseDriver = dsn.DriverMySQL c.options.Deprecated.DatabaseDsn = "user:pass@tcp(localhost:3306)/photoprism" - assert.Equal(t, MySQL, c.DatabaseDriver()) + assert.Equal(t, dsn.DriverMySQL, c.DatabaseDriver()) assert.Equal(t, "user:pass@tcp(localhost:3306)/photoprism", c.options.DatabaseDSN) assert.Empty(t, c.options.Deprecated.DatabaseDsn) }) } func TestConfig_DatabaseDriverName(t *testing.T) { - c := NewConfig(CliTestContext()) - resetDatabaseOptions(c) - driver := c.DatabaseDriverName() - assert.Equal(t, "SQLite", driver) + t.Run("DefaultsToSQLite", func(t *testing.T) { + c := NewConfig(CliTestContext()) + resetDatabaseOptions(c) + assert.Equal(t, "SQLite", c.DatabaseDriverName()) + }) + t.Run("Whitespace", func(t *testing.T) { + c := NewConfig(CliTestContext()) + resetDatabaseOptions(c) + c.options.DatabaseDriver = " " + assert.Equal(t, "SQLite", c.DatabaseDriverName()) + }) + t.Run("Auto", func(t *testing.T) { + c := NewConfig(CliTestContext()) + resetDatabaseOptions(c) + c.options.DatabaseDriver = " AUTO " + assert.Equal(t, "SQLite", c.DatabaseDriverName()) + }) + t.Run("MySQLReportsAsMariaDB", func(t *testing.T) { + c := NewConfig(CliTestContext()) + resetDatabaseOptions(c) + c.options.DatabaseDriver = dsn.DriverMySQL + assert.Equal(t, "MariaDB", c.DatabaseDriverName()) + }) + t.Run("MariaDBAliasReportsAsMariaDB", func(t *testing.T) { + // "mariadb" collapses onto DriverMySQL in ParseDriver; format stays "MariaDB". + c := NewConfig(CliTestContext()) + resetDatabaseOptions(c) + c.options.DatabaseDriver = dsn.DriverMariaDB + assert.Equal(t, "MariaDB", c.DatabaseDriverName()) + }) + t.Run("PostgresReportsAsPostgreSQL", func(t *testing.T) { + c := NewConfig(CliTestContext()) + resetDatabaseOptions(c) + c.options.DatabaseDriver = dsn.DriverPostgres + assert.Equal(t, "PostgreSQL", c.DatabaseDriverName()) + }) + t.Run("DeprecatedTiDBReportsAsSQLite", func(t *testing.T) { + // DatabaseDriver() warns and rewrites "tidb" to SQLite3 before this runs. + c := NewConfig(CliTestContext()) + resetDatabaseOptions(c) + c.options.DatabaseDriver = "tidb" + assert.Equal(t, "SQLite", c.DatabaseDriverName()) + }) + t.Run("UnknownDriverReportsAsSQLite", func(t *testing.T) { + // DatabaseDriver() coerces unknown drivers to SQLite3 before this runs. + c := NewConfig(CliTestContext()) + resetDatabaseOptions(c) + c.options.DatabaseDriver = "oracle" + assert.Equal(t, "SQLite", c.DatabaseDriverName()) + }) } func TestConfig_DatabaseVersion(t *testing.T) { @@ -65,7 +113,7 @@ func TestConfig_normalizeDatabaseDSN(t *testing.T) { c := NewConfig(CliTestContext()) c.options.Deprecated.DatabaseDsn = "foo:b@r@tcp(honeypot:1234)/baz?charset=utf8mb4,utf8&parseTime=true" - c.options.DatabaseDriver = MySQL + c.options.DatabaseDriver = dsn.DriverMySQL assert.Equal(t, "honeypot:1234", c.DatabaseServer()) assert.Equal(t, "honeypot", c.DatabaseHost()) @@ -79,7 +127,7 @@ func TestConfig_ParseDatabaseDSN(t *testing.T) { c := NewConfig(CliTestContext()) c.options.DatabaseDSN = "foo:b@r@tcp(honeypot:1234)/baz?charset=utf8mb4,utf8&parseTime=true" - c.options.DatabaseDriver = SQLite3 + c.options.DatabaseDriver = dsn.DriverSQLite3 assert.Equal(t, "", c.DatabaseServer()) assert.Equal(t, "", c.DatabaseHost()) @@ -88,7 +136,7 @@ func TestConfig_ParseDatabaseDSN(t *testing.T) { assert.Equal(t, "", c.DatabaseUser()) assert.Equal(t, "", c.DatabasePassword()) - c.options.DatabaseDriver = MySQL + c.options.DatabaseDriver = dsn.DriverMySQL assert.Equal(t, "honeypot:1234", c.DatabaseServer()) assert.Equal(t, "honeypot", c.DatabaseHost()) @@ -97,7 +145,7 @@ func TestConfig_ParseDatabaseDSN(t *testing.T) { assert.Equal(t, "foo", c.DatabaseUser()) assert.Equal(t, "b@r", c.DatabasePassword()) - c.options.DatabaseDriver = SQLite3 + c.options.DatabaseDriver = dsn.DriverSQLite3 assert.Equal(t, "", c.DatabaseServer()) assert.Equal(t, "", c.DatabaseHost()) @@ -110,7 +158,7 @@ func TestConfig_ParseDatabaseDSN(t *testing.T) { target := NewConfig(CliTestContext()) resetDatabaseOptions(target) - target.options.DatabaseDriver = MySQL + target.options.DatabaseDriver = dsn.DriverMySQL target.options.DatabaseServer = "db.internal:3306" target.options.DatabaseName = "photoprism" target.options.DatabaseUser = "app" @@ -129,7 +177,7 @@ func TestConfig_ParseDatabaseDSN(t *testing.T) { cfg := NewConfig(CliTestContext()) resetDatabaseOptions(cfg) - cfg.options.DatabaseDriver = SQLite3 + cfg.options.DatabaseDriver = dsn.DriverSQLite3 cfg.options.DatabaseDSN = "file:/data/app.db?_busy_timeout=5000" cfg.options.DatabaseServer = "/tmp/mysql.sock" cfg.options.DatabaseName = "existing-name" @@ -154,15 +202,45 @@ func TestConfig_DatabaseServer(t *testing.T) { } func TestConfig_DatabaseHost(t *testing.T) { - c := NewConfig(CliTestContext()) - resetDatabaseOptions(c) - assert.Equal(t, "", c.DatabaseHost()) + t.Run("SQLite", func(t *testing.T) { + c := NewConfig(CliTestContext()) + resetDatabaseOptions(c) + assert.Equal(t, "", c.DatabaseHost()) + }) + t.Run("PostgresDefaultsToLocalhost", func(t *testing.T) { + c := NewConfig(CliTestContext()) + resetDatabaseOptions(c) + c.options.DatabaseDriver = dsn.DriverPostgres + assert.Equal(t, "localhost", c.DatabaseHost()) + }) + t.Run("PostgresUsesConfiguredHost", func(t *testing.T) { + c := NewConfig(CliTestContext()) + resetDatabaseOptions(c) + c.options.DatabaseDriver = dsn.DriverPostgres + c.options.DatabaseServer = "postgres.internal:5433" + assert.Equal(t, "postgres.internal", c.DatabaseHost()) + }) } func TestConfig_DatabasePort(t *testing.T) { - c := NewConfig(CliTestContext()) - resetDatabaseOptions(c) - assert.Equal(t, 0, c.DatabasePort()) + t.Run("SQLite", func(t *testing.T) { + c := NewConfig(CliTestContext()) + resetDatabaseOptions(c) + assert.Equal(t, 0, c.DatabasePort()) + }) + t.Run("PostgresDefaultsTo5432", func(t *testing.T) { + c := NewConfig(CliTestContext()) + resetDatabaseOptions(c) + c.options.DatabaseDriver = dsn.DriverPostgres + assert.Equal(t, 5432, c.DatabasePort()) + }) + t.Run("PostgresUsesConfiguredPort", func(t *testing.T) { + c := NewConfig(CliTestContext()) + resetDatabaseOptions(c) + c.options.DatabaseDriver = dsn.DriverPostgres + c.options.DatabaseServer = "postgres.internal:5433" + assert.Equal(t, 5433, c.DatabasePort()) + }) } func TestConfig_DatabasePortString(t *testing.T) { @@ -191,9 +269,9 @@ func TestConfig_DatabasePassword(t *testing.T) { // Test setting the password via secret file. _ = os.Setenv(FlagFileVar("DATABASE_PASSWORD"), "testdata/secret_database") assert.Equal(t, "", c.DatabasePassword()) - c.Options().DatabaseDriver = MySQL + c.Options().DatabaseDriver = dsn.DriverMySQL assert.Equal(t, "StoryOfAmélie", c.DatabasePassword()) - c.Options().DatabaseDriver = SQLite3 + c.Options().DatabaseDriver = dsn.DriverSQLite3 _ = os.Setenv(FlagFileVar("DATABASE_PASSWORD"), "") assert.Equal(t, "", c.DatabasePassword()) @@ -223,17 +301,17 @@ func TestShouldAutoRotateDatabase(t *testing.T) { conf := NewMinimalTestConfig(t.TempDir()) conf.Options().Edition = Portal conf.Options().NodeRole = cluster.RolePortal - conf.Options().DatabaseDriver = MySQL + conf.Options().DatabaseDriver = dsn.DriverMySQL assert.False(t, conf.ShouldAutoRotateDatabase()) }) t.Run("NonMySQLDriverFalse", func(t *testing.T) { conf := NewMinimalTestConfig(t.TempDir()) - conf.Options().DatabaseDriver = SQLite3 + conf.Options().DatabaseDriver = dsn.DriverSQLite3 assert.False(t, conf.ShouldAutoRotateDatabase()) }) t.Run("MySQLMissingFieldsTrue", func(t *testing.T) { conf := NewMinimalTestConfig(t.TempDir()) - conf.Options().DatabaseDriver = MySQL + conf.Options().DatabaseDriver = dsn.DriverMySQL conf.Options().DatabaseName = "photoprism" conf.Options().DatabaseUser = "" conf.Options().DatabasePassword = "" @@ -245,14 +323,14 @@ func TestConfig_DatabaseDSN(t *testing.T) { c := NewConfig(CliTestContext()) resetDatabaseOptions(c) driver := c.DatabaseDriver() - assert.Equal(t, SQLite3, driver) + assert.Equal(t, dsn.DriverSQLite3, driver) c.options.DatabaseDSN = "" c.options.DatabaseDriver = "MariaDB" assert.Equal(t, "photoprism:@tcp(localhost)/photoprism?charset=utf8mb4,utf8&collation=utf8mb4_unicode_ci&parseTime=true&timeout=15s", c.DatabaseDSN()) c.options.DatabaseDriver = "tidb" assert.Equal(t, ProjectRoot+"/storage/testdata/index.db?_busy_timeout=5000", c.DatabaseDSN()) c.options.DatabaseDriver = "Postgres" - assert.Equal(t, ProjectRoot+"/storage/testdata/index.db?_busy_timeout=5000", c.DatabaseDSN()) + assert.Equal(t, "user=photoprism password= dbname=photoprism host=localhost port=5432 connect_timeout=15 sslmode=disable TimeZone=UTC", c.DatabaseDSN()) c.options.DatabaseDriver = "SQLite" assert.Equal(t, ProjectRoot+"/storage/testdata/index.db?_busy_timeout=5000", c.DatabaseDSN()) c.options.DatabaseDriver = "" @@ -262,7 +340,7 @@ func TestConfig_DatabaseDSN(t *testing.T) { conf := NewConfig(CliTestContext()) resetDatabaseOptions(conf) - conf.options.DatabaseDriver = MySQL + conf.options.DatabaseDriver = dsn.DriverMySQL conf.options.DatabaseServer = "proxy.internal:6032" conf.options.DatabaseName = "instancedb" conf.options.DatabaseUser = "instance" @@ -278,7 +356,7 @@ func TestConfig_DatabaseDSN(t *testing.T) { conf := NewConfig(CliTestContext()) resetDatabaseOptions(conf) - conf.options.DatabaseDriver = MySQL + conf.options.DatabaseDriver = dsn.DriverMySQL conf.options.DatabaseServer = "/var/run/mysql.sock" conf.options.DatabaseName = "instancedb" conf.options.DatabaseUser = "instance" @@ -290,6 +368,43 @@ func TestConfig_DatabaseDSN(t *testing.T) { t.Fatalf("DatabaseDSN() = %q, want %q", got, want) } }) + t.Run("PostgresDefaults", func(t *testing.T) { + conf := NewConfig(CliTestContext()) + resetDatabaseOptions(conf) + + conf.options.DatabaseDriver = dsn.DriverPostgres + conf.options.DatabaseName = "instancedb" + conf.options.DatabaseUser = "instance" + conf.options.DatabasePassword = "secret" + conf.options.DatabaseTimeout = 12 + + want := "user=instance password=secret dbname=instancedb host=localhost port=5432 connect_timeout=12 sslmode=disable TimeZone=UTC" + if got := conf.DatabaseDSN(); got != want { + t.Fatalf("DatabaseDSN() = %q, want %q", got, want) + } + + assert.Equal(t, "localhost", conf.DatabaseHost()) + assert.Equal(t, 5432, conf.DatabasePort()) + }) + t.Run("PostgresCustomServer", func(t *testing.T) { + conf := NewConfig(CliTestContext()) + resetDatabaseOptions(conf) + + conf.options.DatabaseDriver = dsn.DriverPostgres + conf.options.DatabaseServer = "postgres.internal:5433" + conf.options.DatabaseName = "instancedb" + conf.options.DatabaseUser = "instance" + conf.options.DatabasePassword = "secret" + conf.options.DatabaseTimeout = 9 + + want := "user=instance password=secret dbname=instancedb host=postgres.internal port=5433 connect_timeout=9 sslmode=disable TimeZone=UTC" + if got := conf.DatabaseDSN(); got != want { + t.Fatalf("DatabaseDSN() = %q, want %q", got, want) + } + + assert.Equal(t, "postgres.internal", conf.DatabaseHost()) + assert.Equal(t, 5433, conf.DatabasePort()) + }) } func TestConfig_DatabaseDSNFlags(t *testing.T) { @@ -304,7 +419,7 @@ func TestConfig_DatabaseDSNFlags(t *testing.T) { conf := NewConfig(CliTestContext()) resetDatabaseOptions(conf) - conf.options.DatabaseDriver = MySQL + conf.options.DatabaseDriver = dsn.DriverMySQL conf.options.Deprecated.DatabaseDsn = "user:pass@tcp(db.internal:3306)/photoprism" assert.False(t, conf.NoDatabaseDSN()) @@ -318,10 +433,10 @@ func TestConfig_ReportDatabaseDSN(t *testing.T) { conf := NewConfig(CliTestContext()) resetDatabaseOptions(conf) - assert.Equal(t, SQLite3, conf.DatabaseDriver()) + assert.Equal(t, dsn.DriverSQLite3, conf.DatabaseDriver()) assert.True(t, conf.ReportDatabaseDSN()) - conf.options.DatabaseDriver = MySQL + conf.options.DatabaseDriver = dsn.DriverMySQL conf.options.DatabaseDSN = "" assert.False(t, conf.ReportDatabaseDSN()) @@ -334,7 +449,7 @@ func TestConfig_DatabaseFile(t *testing.T) { // Ensure SQLite defaults resetDatabaseOptions(c) driver := c.DatabaseDriver() - assert.Equal(t, SQLite3, driver) + assert.Equal(t, dsn.DriverSQLite3, driver) c.options.DatabaseDSN = "" assert.Equal(t, ProjectRoot+"/storage/testdata/index.db", c.DatabaseFile()) assert.Equal(t, ProjectRoot+"/storage/testdata/index.db?_busy_timeout=5000", c.DatabaseDSN()) diff --git a/internal/config/config_faces.go b/internal/config/config_faces.go index 993ee4544..f32d76e03 100644 --- a/internal/config/config_faces.go +++ b/internal/config/config_faces.go @@ -1,7 +1,6 @@ package config import ( - "math" "os" "path/filepath" "runtime" @@ -16,7 +15,7 @@ import ( func (c *Config) FaceEngine() string { if c == nil { return face.EngineNone - } else if c.options.FaceEngine == face.EnginePigo || c.options.FaceEngine == face.EngineONNX { + } else if c.options.FaceEngine == face.EngineONNX || c.options.FaceEngine == face.EngineNone { return c.options.FaceEngine } @@ -28,14 +27,10 @@ func (c *Config) FaceEngine() string { modelPath := c.FaceEngineModelPath() if desired == face.EngineAuto { - if modelPath != "" { - if _, err := os.Stat(modelPath); err == nil { - desired = face.EngineONNX - } else { - desired = face.EnginePigo - } + if _, err := os.Stat(modelPath); err == nil { + desired = face.EngineONNX } else { - desired = face.EnginePigo + desired = face.EngineNone } c.options.FaceEngine = desired @@ -112,15 +107,6 @@ func (c *Config) FaceEngineShouldRun(when vision.RunType) bool { return false } -// FaceEngineRetry controls whether detection retries at a higher resolution should be performed. -func (c *Config) FaceEngineRetry() bool { - if c == nil { - return false - } - - return c.FaceEngine() == face.EnginePigo && c.IndexWorkers() > 2 -} - // FaceEngineThreads returns the configured thread count for ONNX inference. func (c *Config) FaceEngineThreads() int { if c == nil { @@ -274,36 +260,3 @@ func (c *Config) FaceAllowBackground() bool { return c.options.FaceAllowBackground } - -// FaceAngles returns the set of detection angles in radians. -func (c *Config) FaceAngles() []float64 { - if len(c.options.FaceAngles) == 0 { - return append([]float64(nil), face.DefaultAngles...) - } - - angles := make([]float64, 0, len(c.options.FaceAngles)) - seen := make(map[float64]struct{}, len(c.options.FaceAngles)) - - for _, angle := range c.options.FaceAngles { - if math.IsNaN(angle) || math.IsInf(angle, 0) { - continue - } - - if angle < -math.Pi || angle > math.Pi { - continue - } - - if _, ok := seen[angle]; ok { - continue - } - - seen[angle] = struct{}{} - angles = append(angles, angle) - } - - if len(angles) == 0 { - return append([]float64(nil), face.DefaultAngles...) - } - - return angles -} diff --git a/internal/config/config_faces_test.go b/internal/config/config_faces_test.go index 2e80b5e92..9417faed6 100644 --- a/internal/config/config_faces_test.go +++ b/internal/config/config_faces_test.go @@ -1,7 +1,6 @@ package config import ( - "math" "os" "path/filepath" "runtime" @@ -18,7 +17,7 @@ func TestConfig_FaceEngine(t *testing.T) { t.Run("Defaults", func(t *testing.T) { c := NewConfig(CliTestContext()) engine := c.FaceEngine() - assert.Contains(t, []string{face.EnginePigo, face.EngineONNX}, engine) + assert.Contains(t, []string{face.EngineNone, face.EngineONNX}, engine) }) t.Run("NilConfig", func(t *testing.T) { assert.Equal(t, face.EngineNone, (*Config)(nil).FaceEngine()) @@ -46,10 +45,15 @@ func TestConfig_FaceEngine(t *testing.T) { }) t.Run("ExplicitEngine", func(t *testing.T) { c := NewConfig(CliTestContext()) - c.options.FaceEngine = face.EnginePigo - assert.Equal(t, face.EnginePigo, c.FaceEngine()) c.options.FaceEngine = face.EngineONNX assert.Equal(t, face.EngineONNX, c.FaceEngine()) + c.options.FaceEngine = face.EngineNone + assert.Equal(t, face.EngineNone, c.FaceEngine()) + }) + t.Run("LegacyPigoAlias", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.FaceEngine = "pigo" + assert.Equal(t, face.EngineONNX, c.FaceEngine()) }) } @@ -298,14 +302,3 @@ func TestConfig_FaceAllowBackground(t *testing.T) { c.options.FaceAllowBackground = true assert.True(t, c.FaceAllowBackground()) } - -func TestConfig_FaceAngles(t *testing.T) { - c := NewConfig(CliTestContext()) - assert.Equal(t, face.DefaultAngles, c.FaceAngles()) - - c.options.FaceAngles = []float64{-0.5, 0, 0.5} - assert.Equal(t, []float64{-0.5, 0, 0.5}, c.FaceAngles()) - - c.options.FaceAngles = []float64{math.Pi + 0.1, math.NaN(), 4} - assert.Equal(t, face.DefaultAngles, c.FaceAngles()) -} diff --git a/internal/config/config_features.go b/internal/config/config_features.go index 0ec0f8d8e..a5494236e 100644 --- a/internal/config/config_features.go +++ b/internal/config/config_features.go @@ -36,6 +36,18 @@ func (c *Config) DisableWebDAV() bool { return c.options.DisableWebDAV } +// DisableAppPasswords checks if app passwords should be disabled, so they cannot be +// created and existing ones are no longer accepted as a credential. Backed by the +// AppPasswords feature flag (Settings UI / PHOTOPRISM_DISABLE_FEATURES). +func (c *Config) DisableAppPasswords() bool { + return !c.Settings().Features.AppPasswords +} + +// DisableMCP checks if the Model Context Protocol (MCP) API endpoint should be disabled. +func (c *Config) DisableMCP() bool { + return c.options.DisableMCP +} + // DisablePlaces checks if geocoding and maps should be disabled. func (c *Config) DisablePlaces() bool { return c.options.DisablePlaces || len(places.LocationServiceUrls) == 0 @@ -135,13 +147,9 @@ func (c *Config) DisableHeifConvert() bool { return c.options.DisableHeifConvert } -// DisableVips checks if the use of libvips is disabled. +// DisableVips checks if libvips is unavailable in the current runtime. func (c *Config) DisableVips() bool { - if bits.UintSize < 64 { - return true - } - - return c.options.DisableVips + return bits.UintSize < 64 } // DisableSips checks if conversion of RAW images with SIPS is disabled. diff --git a/internal/config/config_features_test.go b/internal/config/config_features_test.go index 28e84ecb9..618a2337a 100644 --- a/internal/config/config_features_test.go +++ b/internal/config/config_features_test.go @@ -1,6 +1,7 @@ package config import ( + "math/bits" "testing" "github.com/stretchr/testify/assert" @@ -63,6 +64,32 @@ func TestConfig_DisableWebDAV(t *testing.T) { assert.True(t, c.DisableWebDAV()) } +func TestConfig_DisableMCP(t *testing.T) { + c := NewConfig(CliTestContext()) + + // Option defaults to false so the MCP endpoint is registered. + assert.False(t, c.DisableMCP()) + + c.options.DisableMCP = true + assert.True(t, c.DisableMCP()) + + c.options.DisableMCP = false + assert.False(t, c.DisableMCP()) +} + +func TestConfig_DisableAppPasswords(t *testing.T) { + c := NewConfig(CliTestContext()) + + // Backed by the AppPasswords feature flag, which defaults to enabled. + assert.False(t, c.DisableAppPasswords()) + + c.Settings().Features.AppPasswords = false + assert.True(t, c.DisableAppPasswords()) + + c.Settings().Features.AppPasswords = true + assert.False(t, c.DisableAppPasswords()) +} + func TestConfig_DisableExifTool(t *testing.T) { c := NewConfig(CliTestContext()) assert.False(t, c.DisableExifTool()) @@ -151,11 +178,7 @@ func TestConfig_DisableImageMagick(t *testing.T) { func TestConfig_DisableVips(t *testing.T) { c := NewConfig(CliTestContext()) - assert.Equal(t, false, c.DisableVips()) - c.options.DisableVips = true - assert.True(t, c.DisableVips()) - c.options.DisableVips = false - assert.Equal(t, false, c.DisableVips()) + assert.Equal(t, bits.UintSize < 64, c.DisableVips()) } func TestConfig_DisableSips(t *testing.T) { diff --git a/internal/config/config_ffmpeg.go b/internal/config/config_ffmpeg.go index 70d342a6b..8ca5cb7bd 100644 --- a/internal/config/config_ffmpeg.go +++ b/internal/config/config_ffmpeg.go @@ -7,6 +7,7 @@ import ( "github.com/photoprism/photoprism/internal/ffmpeg/encode" "github.com/photoprism/photoprism/internal/thumb" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/media/video" "github.com/photoprism/photoprism/pkg/txt" ) @@ -45,7 +46,7 @@ func (c *Config) FFmpegEncoder() encode.Encoder { return encode.FindEncoder(c.options.FFmpegEncoder) } -// FFmpegSize returns the maximum ffmpeg video encoding size in pixels (720-7680). +// FFmpegSize returns the maximum ffmpeg video encoding size in pixels (720-15360). func (c *Config) FFmpegSize() int { return thumb.VideoSize(c.options.FFmpegSize).Width } @@ -135,6 +136,13 @@ func (c *Config) FFmpegMapAudio() string { return c.options.FFmpegMapAudio } +// FFmpegExclude returns a comma-separated list of container and codec names +// that must not be processed by FFmpeg, e.g. for transcoding, remuxing, or +// still-frame extraction. Matching is case-insensitive. +func (c *Config) FFmpegExclude() video.Formats { + return video.NewFormats(c.options.FFmpegExclude) +} + // FFmpegOptions returns the FFmpeg options to use for video transcoding. func (c *Config) FFmpegOptions(encoder encode.Encoder, bitrate string) (encode.Options, error) { // Get options to transcode other formats with FFmpeg. diff --git a/internal/config/config_ffmpeg_test.go b/internal/config/config_ffmpeg_test.go index 80b195018..43e182fe9 100644 --- a/internal/config/config_ffmpeg_test.go +++ b/internal/config/config_ffmpeg_test.go @@ -18,6 +18,8 @@ func TestConfig_FFmpegEncoder(t *testing.T) { assert.Equal(t, encode.SoftwareAvc, c.FFmpegEncoder()) c.options.FFmpegEncoder = "intel" assert.Equal(t, encode.IntelAvc, c.FFmpegEncoder()) + c.options.FFmpegEncoder = "vulkan" + assert.Equal(t, encode.VulkanAvc, c.FFmpegEncoder()) c.options.FFmpegEncoder = "xxx" assert.Equal(t, encode.SoftwareAvc, c.FFmpegEncoder()) c.options.FFmpegEncoder = "" @@ -57,7 +59,7 @@ func TestConfig_FFmpegSize(t *testing.T) { assert.Equal(t, 4096, c.FFmpegSize()) c.options.FFmpegSize = -1 - assert.Equal(t, 7680, c.FFmpegSize()) + assert.Equal(t, 15360, c.FFmpegSize()) c.options.FFmpegSize = 10 assert.Equal(t, 720, c.FFmpegSize()) @@ -73,6 +75,9 @@ func TestConfig_FFmpegSize(t *testing.T) { c.options.FFmpegSize = 8640 assert.Equal(t, thumb.Sizes[thumb.Fit7680].Width, c.FFmpegSize()) + + c.options.FFmpegSize = 15360 + assert.Equal(t, thumb.Sizes[thumb.Fit15360].Width, c.FFmpegSize()) } func TestConfig_FFmpegQuality(t *testing.T) { @@ -142,6 +147,24 @@ func TestConfig_FFmpegMapAudio(t *testing.T) { assert.Equal(t, encode.DefaultMapAudio, c.FFmpegMapAudio()) } +func TestConfig_FFmpegExclude(t *testing.T) { + c := NewConfig(CliTestContext()) + assert.Equal(t, "magy", c.FFmpegExclude().String()) + + // String() returns formats sorted alphabetically; codec names are canonicalized. + c.options.FFmpegExclude = "magicyuv, hap" + assert.Equal(t, "hap, magy", c.FFmpegExclude().String()) + + excluded := c.FFmpegExclude() + assert.True(t, excluded.Contains("magicyuv")) + assert.True(t, excluded.Contains("hap")) + assert.False(t, excluded.Contains("avc1")) + + c.options.FFmpegExclude = "" + assert.Equal(t, "", c.FFmpegExclude().String()) + assert.False(t, c.FFmpegExclude().Contains("magicyuv")) +} + func TestConfig_FFmpegOptions(t *testing.T) { c := NewConfig(CliTestContext()) bitrate := "25M" diff --git a/internal/config/config_index.go b/internal/config/config_index.go new file mode 100644 index 000000000..e34da49ff --- /dev/null +++ b/internal/config/config_index.go @@ -0,0 +1,192 @@ +package config + +import ( + "runtime" + "strconv" + "strings" + "sync" + "time" + + "github.com/dustin/go-humanize/english" + + "github.com/photoprism/photoprism/pkg/dsn" +) + +// indexWorkersLogOnce gates the per-process startup log emitted by IndexWorkers, +// so the chosen worker count and reason appear once instead of on every call. +var indexWorkersLogOnce sync.Once + +// IndexWorkers returns the number of indexing workers and logs the +// chosen value once per process so support sessions can see why it was +// picked (configured override, low-memory cap, SQLite cap, or auto). +func (c *Config) IndexWorkers() int { + num, reason := c.indexWorkers() + indexWorkersLogOnce.Do(func() { + log.Debugf("config: %s (%s, %s, driver %s)", + english.Plural(num, "indexing worker", "indexing workers"), + reason, + english.Plural(runtime.NumCPU(), "cpu", "cpus"), + c.DatabaseDriver()) + }) + return num +} + +// IndexWorkersReason returns a short tag describing how the current +// IndexWorkers() value was derived. It mirrors the internal computation +// without re-logging and is intended for the config report and tests. +func (c *Config) IndexWorkersReason() string { + _, reason := c.indexWorkers() + return reason +} + +// indexWorkers derives the indexing worker count from the configured option, +// runtime.NumCPU(), and the database driver. Returns the count and a reason +// tag (low-memory, sqlite-cap, configured, configured-clamped, auto, single-cpu) +// so callers can surface the rationale without re-deriving it. Uses +// runtime.NumCPU() (cgroup- and affinity-aware) rather than CPUID-based +// physical-core probes, which are unreliable under virtualization. +func (c *Config) indexWorkers() (n int, reason string) { + // Cap to one worker on systems below the recommended memory threshold. + if TotalMem < RecommendedMem { + return 1, "low-memory" + } + + cpus := runtime.NumCPU() + configured := parseIndexWorkers(c.options.IndexWorkers) + + // SQLite serializes writes, so we cap workers to avoid lock contention. + if c.DatabaseDriver() == dsn.DriverSQLite3 { + switch { + case configured > 4: + return 4, "sqlite-cap" + case configured > 0: + return configured, "configured" + case cpus >= 8: + return 4, "sqlite-cap" + } + // Small SQLite installs fall through to the auto path below. + } + + // Honor an explicit operator override, clamped to the visible CPUs. + if configured > cpus { + return cpus, "configured-clamped" + } + if configured > 0 { + return configured, "configured" + } + + // Half the visible CPUs leaves headroom for OS, DB, HTTP, and other workers. + if half := cpus / 2; half >= 1 { + return half, "auto" + } + + return 1, "single-cpu" +} + +// parseIndexWorkers normalizes the index-workers option to an int; empty, +// "auto", and unparseable values return 0 to fall through to auto-derivation. +func parseIndexWorkers(value string) int { + value = strings.TrimSpace(value) + + if value == "" || strings.EqualFold(value, IndexWorkersAuto) { + return 0 + } + + n, err := strconv.Atoi(value) + if err != nil { + return 0 + } + + return n +} + +// IndexSchedule returns the indexing schedule in cron format, e.g. "0 */3 * * *" to start indexing every 3 hours. +func (c *Config) IndexSchedule() string { + return Schedule(c.options.IndexSchedule) +} + +// WakeupInterval returns the duration between background worker runs +// required for face recognition and index maintenance (1-86400s). +func (c *Config) WakeupInterval() time.Duration { + if c.options.WakeupInterval <= 0 { + if c.Unsafe() { + // Worker can be disabled only in unsafe mode. + return time.Duration(0) + } else { + // Default to 15 minutes if no interval is set. + return DefaultWakeupInterval + } + } + + // Do not run more than once per minute. + if c.options.WakeupInterval < MinWakeupInterval/time.Second { + return MinWakeupInterval + } else if c.options.WakeupInterval < MinWakeupInterval { + c.options.WakeupInterval *= time.Second + } + + // Do not run less than once per day. + if c.options.WakeupInterval > MaxWakeupInterval { + return MaxWakeupInterval + } + + return c.options.WakeupInterval +} + +// AutoIndex returns the auto index delay duration. +func (c *Config) AutoIndex() time.Duration { + if c.options.AutoIndex < 0 { + return -1 * time.Second + } else if c.options.AutoIndex == 0 || c.options.AutoIndex > 604800 { + return DefaultAutoIndexDelay * time.Second + } + + return time.Duration(c.options.AutoIndex) * time.Second +} + +// AutoImport returns the auto import delay duration. +func (c *Config) AutoImport() time.Duration { + if c.options.AutoImport < 0 || c.ReadOnly() { + return -1 * time.Second + } else if c.options.AutoImport == 0 || c.options.AutoImport > 604800 { + return DefaultAutoImportDelay * time.Second + } + + return time.Duration(c.options.AutoImport) * time.Second +} + +// OriginalsLimit returns the maximum size of originals in MB. +func (c *Config) OriginalsLimit() int { + if c.options.OriginalsLimit <= 0 || c.options.OriginalsLimit > 100000 { + return -1 + } + + return c.options.OriginalsLimit +} + +// OriginalsLimitBytes returns the maximum size of originals in bytes. +func (c *Config) OriginalsLimitBytes() int64 { + if result := c.OriginalsLimit(); result <= 0 { + return -1 + } else { + return int64(result) * 1024 * 1024 + } +} + +// ResolutionLimit returns the maximum resolution of originals in megapixels (width x height). +func (c *Config) ResolutionLimit() int { + result := c.options.ResolutionLimit + + // Disabling or increasing the limit is at your own risk. + // Only sponsors receive support in case of problems. + switch { + case result == 0: + return DefaultResolutionLimit + case result < 0: + return -1 + case result > 900: + result = 900 + } + + return result +} diff --git a/internal/config/config_index_test.go b/internal/config/config_index_test.go new file mode 100644 index 000000000..b6e06cbc3 --- /dev/null +++ b/internal/config/config_index_test.go @@ -0,0 +1,247 @@ +package config + +import ( + "runtime" + "testing" + "time" + + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/pkg/dsn" +) + +func TestConfig_IndexWorkers(t *testing.T) { + c := NewConfig(CliTestContext()) + + assert.GreaterOrEqual(t, c.IndexWorkers(), 1) +} + +// TestConfig_IndexWorkersOverride exercises every branch of the +// configured-value parsing — the auto sentinel, an empty string, a +// numeric override, a junk string, and a value above runtime.NumCPU() — +// and asserts the getter still respects the SQLite cap and returns at +// least one worker. +func TestConfig_IndexWorkersOverride(t *testing.T) { + c := NewConfig(CliTestContext()) + original := c.options.IndexWorkers + t.Cleanup(func() { c.options.IndexWorkers = original }) + + cases := []struct { + name string + value string + minCount int + }{ + {"Auto", IndexWorkersAuto, 1}, + {"AutoMixedCase", "Auto", 1}, + {"Empty", "", 1}, + {"Numeric", "1", 1}, + {"Garbage", "not-a-number", 1}, + {"OverCPU", "9999", 1}, + } + + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + c.options.IndexWorkers = tc.value + got := c.IndexWorkers() + assert.GreaterOrEqual(t, got, tc.minCount) + assert.LessOrEqual(t, got, runtime.NumCPU()) + }) + } +} + +// TestConfig_IndexWorkersReason walks every branch of the auto-detection +// helper and pins the (count, reason) pair the report and startup log +// rely on. The DatabaseDriver and IndexWorkers options are mutated in +// place against a CliTestContext config and restored on cleanup; the +// global TotalMem is swapped via t.Cleanup to keep the suite isolated. +func TestConfig_IndexWorkersReason(t *testing.T) { + c := NewConfig(CliTestContext()) + + originalDriver := c.options.DatabaseDriver + originalWorkers := c.options.IndexWorkers + originalMem := TotalMem + t.Cleanup(func() { + c.options.DatabaseDriver = originalDriver + c.options.IndexWorkers = originalWorkers + TotalMem = originalMem + }) + + cpus := runtime.NumCPU() + + t.Run("LowMemory", func(t *testing.T) { + TotalMem = RecommendedMem - 1 + t.Cleanup(func() { TotalMem = originalMem }) + + c.options.DatabaseDriver = dsn.DriverMySQL + c.options.IndexWorkers = "16" + + got, reason := c.indexWorkers() + assert.Equal(t, 1, got) + assert.Equal(t, "low-memory", reason) + }) + t.Run("SqliteAutoLargeHost", func(t *testing.T) { + if cpus < 8 { + t.Skipf("requires at least 8 CPUs (have %d)", cpus) + } + TotalMem = originalMem + c.options.DatabaseDriver = dsn.DriverSQLite3 + c.options.IndexWorkers = IndexWorkersAuto + + got, reason := c.indexWorkers() + assert.Equal(t, 4, got) + assert.Equal(t, "sqlite-cap", reason) + }) + t.Run("SqliteOverrideAboveCap", func(t *testing.T) { + TotalMem = originalMem + c.options.DatabaseDriver = dsn.DriverSQLite3 + c.options.IndexWorkers = "12" + + got, reason := c.indexWorkers() + assert.Equal(t, 4, got) + assert.Equal(t, "sqlite-cap", reason) + }) + t.Run("SqliteOverrideAtOrBelowCap", func(t *testing.T) { + TotalMem = originalMem + c.options.DatabaseDriver = dsn.DriverSQLite3 + c.options.IndexWorkers = "3" + + got, reason := c.indexWorkers() + assert.Equal(t, 3, got) + assert.Equal(t, "configured", reason) + }) + t.Run("MysqlAuto", func(t *testing.T) { + TotalMem = originalMem + c.options.DatabaseDriver = dsn.DriverMySQL + c.options.IndexWorkers = IndexWorkersAuto + + got, reason := c.indexWorkers() + switch { + case cpus >= 2: + assert.Equal(t, cpus/2, got) + assert.Equal(t, "auto", reason) + default: + assert.Equal(t, 1, got) + assert.Equal(t, "single-cpu", reason) + } + }) + t.Run("MysqlConfiguredWithinBudget", func(t *testing.T) { + TotalMem = originalMem + c.options.DatabaseDriver = dsn.DriverMySQL + c.options.IndexWorkers = "2" + + got, reason := c.indexWorkers() + assert.Equal(t, 2, got) + assert.Equal(t, "configured", reason) + }) + t.Run("MysqlConfiguredAboveCpus", func(t *testing.T) { + TotalMem = originalMem + c.options.DatabaseDriver = dsn.DriverMySQL + c.options.IndexWorkers = "9999" + + got, reason := c.indexWorkers() + assert.Equal(t, cpus, got) + assert.Equal(t, "configured-clamped", reason) + }) + t.Run("ReportGetterMatchesHelper", func(t *testing.T) { + TotalMem = originalMem + c.options.DatabaseDriver = dsn.DriverMySQL + c.options.IndexWorkers = IndexWorkersAuto + + want, wantReason := c.indexWorkers() + assert.Equal(t, want, c.IndexWorkers()) + assert.Equal(t, wantReason, c.IndexWorkersReason()) + }) +} + +func TestParseIndexWorkers(t *testing.T) { + cases := map[string]int{ + "": 0, + " ": 0, + IndexWorkersAuto: 0, + "Auto": 0, + "AUTO": 0, + "0": 0, + "-1": -1, + "4": 4, + " 8 ": 8, + "junk": 0, + } + + for input, want := range cases { + t.Run(input, func(t *testing.T) { + assert.Equal(t, want, parseIndexWorkers(input)) + }) + } +} + +func TestConfig_IndexSchedule(t *testing.T) { + c := NewConfig(CliTestContext()) + assert.Equal(t, DefaultIndexSchedule, c.IndexSchedule()) +} + +func TestConfig_WakeupInterval(t *testing.T) { + c := NewConfig(CliTestContext()) + i := c.WakeupInterval() + + assert.Equal(t, "1h34m9s", c.WakeupInterval().String()) + + c.options.WakeupInterval = 45 + + assert.Equal(t, "45s", c.WakeupInterval().String()) + + c.options.WakeupInterval = 0 + + assert.Equal(t, "15m0s", c.WakeupInterval().String()) + + c.options.WakeupInterval = 150 + + assert.Equal(t, "2m30s", c.WakeupInterval().String()) + + c.options.WakeupInterval = i + + assert.Equal(t, "1h34m9s", c.WakeupInterval().String()) +} + +func TestConfig_AutoIndex(t *testing.T) { + c := NewConfig(CliTestContext()) + assert.Equal(t, -1*time.Second, c.AutoIndex()) +} + +func TestConfig_AutoImport(t *testing.T) { + c := NewConfig(CliTestContext()) + assert.Equal(t, 2*time.Hour, c.AutoImport()) +} + +func TestConfig_OriginalsLimit(t *testing.T) { + c := NewConfig(CliTestContext()) + + assert.Equal(t, -1, c.OriginalsLimit()) + c.options.OriginalsLimit = 800 + assert.Equal(t, 800, c.OriginalsLimit()) +} + +func TestConfig_OriginalsLimitBytes(t *testing.T) { + c := NewConfig(CliTestContext()) + + assert.Equal(t, int64(-1), c.OriginalsLimitBytes()) + c.options.OriginalsLimit = 800 + assert.Equal(t, int64(838860800), c.OriginalsLimitBytes()) +} + +func TestConfig_ResolutionLimit(t *testing.T) { + c := NewConfig(CliTestContext()) + + assert.Equal(t, DefaultResolutionLimit, c.ResolutionLimit()) + c.options.ResolutionLimit = 800 + assert.Equal(t, 800, c.ResolutionLimit()) + c.options.ResolutionLimit = 950 + assert.Equal(t, 900, c.ResolutionLimit()) + c.options.ResolutionLimit = 0 + assert.Equal(t, DefaultResolutionLimit, c.ResolutionLimit()) + c.options.ResolutionLimit = -1 + assert.Equal(t, -1, c.ResolutionLimit()) + c.options.Sponsor = false + assert.Equal(t, -1, c.ResolutionLimit()) + c.options.Sponsor = true + assert.Equal(t, -1, c.ResolutionLimit()) +} diff --git a/internal/config/config_media.go b/internal/config/config_media.go index 01534350e..f3491426f 100644 --- a/internal/config/config_media.go +++ b/internal/config/config_media.go @@ -1,6 +1,7 @@ package config import ( + "github.com/photoprism/photoprism/internal/thumb" "github.com/photoprism/photoprism/pkg/media" ) @@ -34,7 +35,8 @@ func (c *Config) ImageMagickEnabled() bool { return !c.DisableImageMagick() } -// JpegXLDecoderBin returns the JPEG XL decoder executable file name. +// JpegXLDecoderBin returns the external JPEG XL decoder executable file name, +// which is used as a fallback when libvips lacks native JPEG XL support. func (c *Config) JpegXLDecoderBin() string { return FindBin("", "djxl") } @@ -44,17 +46,32 @@ func (c *Config) JpegXLEnabled() bool { return !c.DisableJpegXL() } -// DisableJpegXL checks if JPEG XL file format support is disabled. +// DisableJpegXL checks if JPEG XL file format support is disabled. It stays enabled +// as long as the external "djxl" decoder is available or libvips can decode JPEG XL +// natively, so the format only turns off when neither option exists. func (c *Config) DisableJpegXL() bool { - if c.options.DisableJpegXL { - return true - } else if c.JpegXLDecoderBin() == "" { + if jpegXLDisabled(c.options.DisableJpegXL, c.JpegXLDecoderBin() != "", thumb.JpegXLSupported) { c.options.DisableJpegXL = true } return c.options.DisableJpegXL } +// jpegXLDisabled reports whether JPEG XL support is unavailable, given the explicit +// disable option and external decoder availability. nativeSupported is a thunk so the +// libvips capability probe runs only when no external decoder is present, keeping +// config introspection on standard installs (which ship "djxl") free of a libvips start. +func jpegXLDisabled(explicit, decoderAvailable bool, nativeSupported func() bool) bool { + switch { + case explicit: + return true + case decoderAvailable: + return false + default: + return !nativeSupported() + } +} + // HeifConvertBin returns the name of the "heif-dec" executable ("heif-convert" in earlier libheif versions). // see https://github.com/photoprism/photoprism/issues/4439 func (c *Config) HeifConvertBin() string { diff --git a/internal/config/config_media_test.go b/internal/config/config_media_test.go index cd2b9a2b5..3a5140bf4 100644 --- a/internal/config/config_media_test.go +++ b/internal/config/config_media_test.go @@ -114,6 +114,30 @@ func TestConfig_DisableJpegXL(t *testing.T) { c.options.DisableJpegXL = false } +func TestJpegXLDisabled(t *testing.T) { + yes := func() bool { return true } + no := func() bool { return false } + t.Run("ExplicitlyDisabled", func(t *testing.T) { + assert.True(t, jpegXLDisabled(true, true, yes)) + }) + t.Run("DecoderAvailable", func(t *testing.T) { + assert.False(t, jpegXLDisabled(false, true, no)) + }) + t.Run("NativeOnly", func(t *testing.T) { + assert.False(t, jpegXLDisabled(false, false, yes)) + }) + t.Run("NeitherAvailable", func(t *testing.T) { + assert.True(t, jpegXLDisabled(false, false, no)) + }) + t.Run("DecoderShortCircuitsProbe", func(t *testing.T) { + // The libvips probe must not run when an external decoder is available, so + // config introspection on standard installs does not start libvips. + probed := false + assert.False(t, jpegXLDisabled(false, true, func() bool { probed = true; return false })) + assert.False(t, probed) + }) +} + func TestConfig_Import(t *testing.T) { c := NewConfig(CliTestContext()) diff --git a/internal/config/config_oidc.go b/internal/config/config_oidc.go index 67ea72a2c..b1b7eac07 100644 --- a/internal/config/config_oidc.go +++ b/internal/config/config_oidc.go @@ -27,6 +27,13 @@ const ( OidcRedirectUri = ApiUri + "/oidc/redirect" ) +// ClusterOIDC reports whether a cluster instance should use the Portal as its OIDC +// login provider, deriving the OIDC RP credentials from the node client +// (PHOTOPRISM_CLUSTER_OIDC). Explicit PHOTOPRISM_OIDC_CLIENT / _SECRET win. +func (c *Config) ClusterOIDC() bool { + return c.options.ClusterOIDC +} + // OIDCEnabled checks if sign-on via OpenID Connect (OIDC) is fully configured and enabled. func (c *Config) OIDCEnabled() bool { switch { @@ -79,6 +86,46 @@ func (c *Config) OIDCSecret() string { } } +// SetOIDCUri sets the OIDC provider URI in memory, e.g. when a cluster instance +// defaults it to the Portal issuer during bootstrap. +func (c *Config) SetOIDCUri(value string) { + if c == nil || c.options == nil { + return + } + c.options.OIDCUri = strings.TrimSpace(value) +} + +// SetOIDCClient sets the OIDC RP Client ID in memory, e.g. when a cluster +// instance derives it from the node client credentials during bootstrap. +func (c *Config) SetOIDCClient(value string) { + if c == nil || c.options == nil { + return + } + c.options.OIDCClient = strings.TrimSpace(value) +} + +// SetOIDCSecret sets the OIDC RP Client Secret in memory, e.g. when a cluster +// instance derives it from the node client credentials during bootstrap. +func (c *Config) SetOIDCSecret(value string) { + if c == nil || c.options == nil { + return + } + c.options.OIDCSecret = value +} + +// OIDCIssuerOnSiteDomain reports whether the configured OIDC issuer is served from +// this node's own site host (a shared-domain Portal OP). The OP session cookie is +// host-only to that domain, so this gates whether an instance can clear it on +// logout. It compares the site host, not PortalUrl (which may be a loopback). +func (c *Config) OIDCIssuerOnSiteDomain() bool { + issuer := c.OIDCUri() + if issuer == nil || issuer.Hostname() == "" { + return false + } + + return strings.EqualFold(issuer.Hostname(), c.SiteDomain()) +} + // OIDCScopes returns the user information scopes for single sign-on via OIDC. func (c *Config) OIDCScopes() string { if c.options.OIDCScopes == "" { @@ -88,6 +135,13 @@ func (c *Config) OIDCScopes() string { return c.options.OIDCScopes } +// OIDCPrompt returns the OpenID Connect "prompt" parameter sent on the authorization +// request (e.g. login or select_account); empty preserves the provider's default +// single sign-on behavior. Unsupported values are dropped when the client is built. +func (c *Config) OIDCPrompt() string { + return strings.TrimSpace(c.options.OIDCPrompt) +} + // OIDCProvider returns the OIDC provider name. func (c *Config) OIDCProvider() string { if c.options.OIDCProvider == "" { @@ -120,6 +174,12 @@ func (c *Config) OIDCRegister() bool { return c.options.OIDCRegister } +// OIDCLogout checks if signing out should also end the provider session via OpenID +// Connect RP-initiated logout (redirect to the discovered end_session_endpoint). +func (c *Config) OIDCLogout() bool { + return c.options.OIDCLogout +} + // OIDCUsername returns the preferred username claim for new users signing up via OIDC. func (c *Config) OIDCUsername() string { switch c.options.OIDCUsername { @@ -165,26 +225,26 @@ func (c *Config) OIDCGroupRoles() map[string]acl.Role { result := make(map[string]acl.Role, len(c.options.OIDCGroupRole)) for _, entry := range c.options.OIDCGroupRole { - entry = strings.TrimSpace(entry) + // splitGroupList tolerates comma- and whitespace-separated pairs, so a + // single env value with several pairs resolves the same either way. + for _, pair := range splitGroupList(entry) { + group, roleName, ok := parseGroupRolePair(pair) - if entry == "" { - continue + if !ok { + continue + } + + role := acl.ParseRole(roleName) + + // Skip a mapping to a non-federatable role: the Portal operator role + // cluster_admin and the anonymous visitor role must not be assignable + // through the IdP group mechanism, even if the directory is compromised. + if !acl.IsFederatedRole(role) { + continue + } + + result[group] = role } - - sep := strings.IndexAny(entry, "=:") - - if sep < 1 || sep >= len(entry)-1 { - continue - } - - group := normalizeGroupID(entry[:sep]) - role := acl.ParseRole(entry[sep+1:]) - - if group == "" || role == acl.RoleNone { - continue - } - - result[group] = role } return result @@ -201,9 +261,10 @@ func (c *Config) OIDCRole() acl.Role { return acl.RoleGuest } - role := acl.UserRoles[clean.Role(c.options.OIDCRole)] - - if role != acl.RoleNone { + // Ignore a configured default role that cannot be federated (cluster_admin / + // visitor): new OIDC accounts must never be provisioned as a Portal operator + // or an anonymous visitor. + if role := acl.UserRoles[clean.Role(c.options.OIDCRole)]; acl.IsFederatedRole(role) { return role } @@ -239,10 +300,12 @@ func (c *Config) OIDCReport() (rows [][]string, cols []string) { {"oidc-client", c.OIDCClient()}, {"oidc-secret", strings.Repeat("*", utf8.RuneCountInString(c.OIDCSecret()))}, {"oidc-scopes", c.OIDCScopes()}, + {"oidc-prompt", c.OIDCPrompt()}, {"oidc-provider", c.OIDCProvider()}, {"oidc-icon", c.OIDCIcon()}, {"oidc-redirect", fmt.Sprintf("%t", c.OIDCRedirect())}, {"oidc-register", fmt.Sprintf("%t", c.OIDCRegister())}, + {"oidc-logout", fmt.Sprintf("%t", c.OIDCLogout())}, {"oidc-username", c.OIDCUsername()}, } diff --git a/internal/config/config_oidc_test.go b/internal/config/config_oidc_test.go index 3f274b61c..fe4da541a 100644 --- a/internal/config/config_oidc_test.go +++ b/internal/config/config_oidc_test.go @@ -68,6 +68,64 @@ func TestConfig_OIDCClient(t *testing.T) { assert.Equal(t, "", c.OIDCClient()) } +func TestConfig_SetOIDCClient(t *testing.T) { + c := NewConfig(CliTestContext()) + c.SetOIDCClient(" cs5cpu17n6gj2qo5 ") + assert.Equal(t, "cs5cpu17n6gj2qo5", c.OIDCClient()) + c.SetOIDCClient("") + assert.Equal(t, "", c.OIDCClient()) +} + +func TestConfig_SetOIDCSecret(t *testing.T) { + c := NewConfig(CliTestContext()) + c.SetOIDCSecret("topsecret123456") + assert.Equal(t, "topsecret123456", c.OIDCSecret()) + c.SetOIDCSecret("") + assert.Equal(t, "", c.OIDCSecret()) +} + +func TestConfig_SetOIDCUri(t *testing.T) { + c := NewConfig(CliTestContext()) + c.SetOIDCUri(" https://app.localssl.dev/ ") + assert.Equal(t, "https://app.localssl.dev/", c.OIDCUri().String()) + c.SetOIDCUri("") + assert.Equal(t, "", c.OIDCUri().String()) +} + +func TestConfig_ClusterOIDC(t *testing.T) { + c := NewConfig(CliTestContext()) + assert.False(t, c.ClusterOIDC()) + c.options.ClusterOIDC = true + assert.True(t, c.ClusterOIDC()) +} + +func TestConfig_OIDCIssuerOnSiteDomain(t *testing.T) { + t.Run("SharedDomainMatch", func(t *testing.T) { + // Instance under /i/pro-1 with the Portal OP at the shared-domain root. + c := NewConfig(CliTestContext()) + c.options.SiteUrl = "https://app.localssl.dev/i/pro-1/" + c.options.OIDCUri = "https://app.localssl.dev/" + assert.True(t, c.OIDCIssuerOnSiteDomain()) + }) + t.Run("SubdomainIsolatedIssuerDiffers", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.SiteUrl = "https://node1.example.com/" + c.options.OIDCUri = "https://portal.example.com/" + assert.False(t, c.OIDCIssuerOnSiteDomain()) + }) + t.Run("ExternalIdP", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.SiteUrl = "https://app.localssl.dev/i/pro-1/" + c.options.OIDCUri = "https://keycloak.example.com/realms/main" + assert.False(t, c.OIDCIssuerOnSiteDomain()) + }) + t.Run("NoIssuer", func(t *testing.T) { + c := NewConfig(CliTestContext()) + c.options.SiteUrl = "https://app.localssl.dev/i/pro-1/" + assert.False(t, c.OIDCIssuerOnSiteDomain()) + }) +} + func TestConfig_OIDCSecret(t *testing.T) { c := NewConfig(CliTestContext()) @@ -110,6 +168,16 @@ func TestConfig_OIDCRedirect(t *testing.T) { assert.False(t, c.OIDCRedirect()) } +func TestConfig_OIDCPrompt(t *testing.T) { + c := NewConfig(CliTestContext()) + + assert.Equal(t, "", c.OIDCPrompt()) + + c.options.OIDCPrompt = " select_account " + + assert.Equal(t, "select_account", c.OIDCPrompt()) +} + func TestConfig_OIDCUsername(t *testing.T) { c := NewConfig(CliTestContext()) @@ -160,10 +228,22 @@ func TestConfig_OIDCGroupRoles(t *testing.T) { "def-456:guest", "invalid", "=none", + "ghi-789=visitor", } roles := c.OIDCGroupRoles() + assert.Equal(t, acl.RoleAdmin, roles["abc-123"]) + assert.Equal(t, acl.RoleGuest, roles["def-456"]) + // A mapping to a non-federatable role (visitor, like cluster_admin) is + // dropped so a compromised IdP cannot assign it via group membership. + assert.NotContains(t, roles, "ghi-789") + assert.Len(t, roles, 2) + + // A single env value with whitespace-separated pairs (StringSlice env only + // splits on commas) must still resolve every pair. + c.options.OIDCGroupRole = []string{"abc-123=admin def-456=guest"} + roles = c.OIDCGroupRoles() assert.Equal(t, acl.RoleAdmin, roles["abc-123"]) assert.Equal(t, acl.RoleGuest, roles["def-456"]) assert.Len(t, roles, 2) @@ -193,6 +273,16 @@ func TestConfig_OIDCRegister(t *testing.T) { assert.False(t, c.OIDCRegister()) } +func TestConfig_OIDCLogout(t *testing.T) { + c := NewConfig(CliTestContext()) + + assert.False(t, c.OIDCLogout()) + + c.options.OIDCLogout = true + + assert.True(t, c.OIDCLogout()) +} + func TestConfig_OIDCRole(t *testing.T) { c := NewConfig(CliTestContext()) @@ -205,6 +295,12 @@ func TestConfig_OIDCRole(t *testing.T) { c.options.OIDCRole = "admin" assert.Equal(t, acl.RoleAdmin, c.OIDCRole()) + + // A non-federatable default role (visitor, like cluster_admin) is ignored so + // new OIDC accounts are never provisioned as an operator or anonymous role. + c.options.OIDCRole = "visitor" + + assert.Equal(t, acl.RoleNone, c.OIDCRole()) } func TestConfig_OIDCWebDAV(t *testing.T) { diff --git a/internal/config/config_server.go b/internal/config/config_server.go index e13cafe1f..9171ac06f 100644 --- a/internal/config/config_server.go +++ b/internal/config/config_server.go @@ -99,11 +99,63 @@ func (c *Config) HttpMode() string { return c.options.HttpMode } -// HttpCompression returns the http compression method (gzip, or none). +// HttpCompression returns the raw, lowercased and trimmed value of the +// HttpCompression option as configured by the operator. The string may be +// a single token ("gzip", "zstd", "none", "") or a comma-separated +// preference list (e.g. "zstd,gzip"); use HttpCompressionPreferences for +// the parsed and validated form. func (c *Config) HttpCompression() string { return strings.ToLower(strings.TrimSpace(c.options.HttpCompression)) } +// HttpCompressionPreferences returns the operator's ordered, deduplicated +// list of supported response content-encodings ("gzip", "zstd"). Empty, +// "none", and "identity" tokens disable compression and yield a nil +// result. Unknown tokens are dropped silently here and surfaced via +// HttpCompressionUnknown so the caller can log them once at startup. +func (c *Config) HttpCompressionPreferences() []string { + parts := strings.Split(c.HttpCompression(), ",") + prefs := make([]string, 0, len(parts)) + seen := make(map[string]struct{}, len(parts)) + for _, p := range parts { + t := strings.TrimSpace(p) + switch t { + case "", "none", "identity": + continue + case "gzip", "zstd": + if _, dup := seen[t]; dup { + continue + } + seen[t] = struct{}{} + prefs = append(prefs, t) + } + } + return prefs +} + +// HttpCompressionUnknown returns the unique, ordered list of compression +// tokens from the HttpCompression option that are neither supported +// encodings nor recognized off-switches. Operators learn about typos this +// way without breaking startup. +func (c *Config) HttpCompressionUnknown() []string { + parts := strings.Split(c.HttpCompression(), ",") + unknown := make([]string, 0, len(parts)) + seen := make(map[string]struct{}, len(parts)) + for _, p := range parts { + t := strings.TrimSpace(p) + switch t { + case "", "none", "identity", "gzip", "zstd": + continue + } + if _, dup := seen[t]; dup { + continue + } + seen[t] = struct{}{} + unknown = append(unknown, t) + } + return unknown +} + // HttpHeaderTimeout returns the timeout for reading HTTP request headers. func (c *Config) HttpHeaderTimeout() time.Duration { if c.options.HttpHeaderTimeout <= 0 { diff --git a/internal/config/config_server_test.go b/internal/config/config_server_test.go index 92772875b..b9f9e7773 100644 --- a/internal/config/config_server_test.go +++ b/internal/config/config_server_test.go @@ -117,6 +117,67 @@ func TestConfig_HttpCompression(t *testing.T) { c := NewConfig(CliTestContext()) assert.Equal(t, "", c.HttpCompression()) + + c.Options().HttpCompression = " Zstd, GZIP " + assert.Equal(t, "zstd, gzip", c.HttpCompression()) +} + +func TestConfig_HttpCompressionPreferences(t *testing.T) { + c := NewConfig(CliTestContext()) + + t.Run("Empty", func(t *testing.T) { + c.Options().HttpCompression = "" + assert.Empty(t, c.HttpCompressionPreferences()) + }) + t.Run("None", func(t *testing.T) { + c.Options().HttpCompression = "none" + assert.Empty(t, c.HttpCompressionPreferences()) + }) + t.Run("LegacyGzip", func(t *testing.T) { + c.Options().HttpCompression = "gzip" + assert.Equal(t, []string{"gzip"}, c.HttpCompressionPreferences()) + }) + t.Run("ZstdThenGzip", func(t *testing.T) { + c.Options().HttpCompression = "zstd,gzip" + assert.Equal(t, []string{"zstd", "gzip"}, c.HttpCompressionPreferences()) + }) + t.Run("PreservesOrderAndDeduplicates", func(t *testing.T) { + c.Options().HttpCompression = "gzip, zstd, gzip" + assert.Equal(t, []string{"gzip", "zstd"}, c.HttpCompressionPreferences()) + }) + t.Run("DropsUnknownTokens", func(t *testing.T) { + c.Options().HttpCompression = "br, zstd, gzip" + assert.Equal(t, []string{"zstd", "gzip"}, c.HttpCompressionPreferences()) + }) + t.Run("WhitespaceAndCaseInsensitive", func(t *testing.T) { + c.Options().HttpCompression = " ZSTD , GZip " + assert.Equal(t, []string{"zstd", "gzip"}, c.HttpCompressionPreferences()) + }) + t.Run("IdentityIsOff", func(t *testing.T) { + c.Options().HttpCompression = "identity" + assert.Empty(t, c.HttpCompressionPreferences()) + }) +} + +func TestConfig_HttpCompressionUnknown(t *testing.T) { + c := NewConfig(CliTestContext()) + + t.Run("None", func(t *testing.T) { + c.Options().HttpCompression = "zstd, gzip" + assert.Empty(t, c.HttpCompressionUnknown()) + }) + t.Run("ReportsUnknown", func(t *testing.T) { + c.Options().HttpCompression = "br, zstd, deflate, gzip" + assert.Equal(t, []string{"br", "deflate"}, c.HttpCompressionUnknown()) + }) + t.Run("DeduplicatesUnknown", func(t *testing.T) { + c.Options().HttpCompression = "br, br, deflate" + assert.Equal(t, []string{"br", "deflate"}, c.HttpCompressionUnknown()) + }) + t.Run("EmptyDoesNotReportUnknown", func(t *testing.T) { + c.Options().HttpCompression = "" + assert.Empty(t, c.HttpCompressionUnknown()) + }) } func TestConfig_HttpHeaderTimeout(t *testing.T) { diff --git a/internal/config/config_site.go b/internal/config/config_site.go index bbbc12e06..e9a398961 100644 --- a/internal/config/config_site.go +++ b/internal/config/config_site.go @@ -12,6 +12,7 @@ import ( "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/http/scheme" ) //go:embed robots.txt @@ -92,7 +93,7 @@ func (c *Config) ContentUri() string { // DownloadUrl returns the download URL based on the SiteUrl and the DownloadUri. func (c *Config) DownloadUrl() string { - return strings.TrimRight(c.options.SiteUrl, "/") + DownloadUri + return strings.TrimRight(c.SiteUrl(), "/") + DownloadUri } // VideoUri returns the video streaming URI. @@ -114,13 +115,14 @@ func (c *Config) StaticAssetUri(res string) string { return c.StaticUri() + "/" + res } -// SiteUrl returns the public server URL (default is "http://localhost:2342/"). +// SiteUrl returns the normalized public base URL (default "http://localhost:2342/"). +// Strips default ports, query strings, and fragments so absolute URLs stay stable. func (c *Config) SiteUrl() string { - if c.options.SiteUrl == "" { - return "http://localhost:2342/" + if siteUrl := scheme.NormalizeBaseURL(c.options.SiteUrl); siteUrl != "" { + return siteUrl } - return strings.TrimRight(c.options.SiteUrl, "/") + "/" + return "http://localhost:2342/" } // SiteHttps checks if the site URL uses HTTPS. @@ -159,13 +161,37 @@ func (c *Config) SiteAuthor() string { return c.options.SiteAuthor } -// SiteTitle returns the main site title (default is application name). -func (c *Config) SiteTitle() string { - if c.options.SiteTitle == "" { - return c.Name() +// SiteName returns a short, distinctive label for this instance, used by the +// navigation instance switcher and the Portal instance selector. It returns the +// first configured value among SiteName, AppName, and SiteTitle, or "" when none +// is set. Unlike SiteTitle and AppName it does not fall back to the product Name, +// so callers can fall back to the instance's base-path segment for unbranded peers. +func (c *Config) SiteName() string { + for _, name := range []string{c.options.SiteName, c.options.AppName, c.options.SiteTitle} { + if s := clean.TypeUnicode(name); s != "" { + return s + } } - return c.options.SiteTitle + return "" +} + +// SiteTitle returns the main site title (default is application name). +func (c *Config) SiteTitle() string { + if c.options.SiteTitle != "" { + return c.options.SiteTitle + } + + // With no SiteTitle and no AppName configured, fall back to the distinctive + // SiteName (SITE_NAME) before the product Name so an instance branded only via + // SITE_NAME shows that name as its title. + if c.options.AppName == "" { + if name := clean.TypeUnicode(c.options.SiteName); name != "" { + return name + } + } + + return c.Name() } // SiteCaption returns a short site caption. @@ -200,7 +226,7 @@ func (c *Config) SitePreview() string { return c.options.SitePreview } else if fileName := filepath.Join(c.ThemePath(), c.options.SitePreview); fs.FileExistsNotEmpty(fileName) { - return strings.TrimRight(c.options.SiteUrl, "/") + path.Join(ThemeUri, c.options.SitePreview) + return strings.TrimRight(c.SiteUrl(), "/") + path.Join(ThemeUri, c.options.SitePreview) } return c.SiteUrl() + strings.TrimPrefix(c.options.SitePreview, "/") diff --git a/internal/config/config_site_test.go b/internal/config/config_site_test.go index c308c0ee3..7da579efb 100644 --- a/internal/config/config_site_test.go +++ b/internal/config/config_site_test.go @@ -3,6 +3,7 @@ package config import ( "crypto/sha256" "fmt" + "os" "path/filepath" "testing" @@ -67,10 +68,10 @@ func TestConfig_FrontendUri(t *testing.T) { assert.Equal(t, "/foo/library/", c.FrontendUri("/")) assert.Equal(t, "/foo/library/browse", c.FrontendUri("/browse")) - c.options.FrontendUri = "/portal/admin/" - assert.Equal(t, "/foo/portal/admin", c.FrontendUri("")) - assert.Equal(t, "/foo/portal/admin/", c.FrontendUri("/")) - assert.Equal(t, "/foo/portal/admin/browse", c.FrontendUri("/browse")) + c.options.FrontendUri = "/portal/" + assert.Equal(t, "/foo/portal", c.FrontendUri("")) + assert.Equal(t, "/foo/portal/", c.FrontendUri("/")) + assert.Equal(t, "/foo/portal/browse", c.FrontendUri("/browse")) c.options.FrontendUri = " " assert.Equal(t, "/foo/library", c.FrontendUri("")) @@ -80,7 +81,7 @@ func TestNormalizeFrontendPath(t *testing.T) { assert.Equal(t, "", normalizeFrontendPath("")) assert.Equal(t, "", normalizeFrontendPath(" ")) assert.Equal(t, "/library", normalizeFrontendPath("/library")) - assert.Equal(t, "/portal/admin", normalizeFrontendPath("portal/admin/")) + assert.Equal(t, "/portal", normalizeFrontendPath("portal/")) assert.Equal(t, "", normalizeFrontendPath("../admin")) } @@ -110,11 +111,44 @@ func TestConfig_VideoUri(t *testing.T) { func TestConfig_SiteUrl(t *testing.T) { c := NewConfig(CliTestContext()) - assert.Equal(t, "http://localhost:2342/", c.SiteUrl()) - c.options.SiteUrl = "http://superhost:2342/" - assert.Equal(t, "http://superhost:2342/", c.SiteUrl()) - c.options.SiteUrl = "http://superhost" - assert.Equal(t, "http://superhost/", c.SiteUrl()) + cases := []struct { + name string + in string + want string + }{ + // Baseline behavior. + {"Default", "", "http://localhost:2342/"}, + {"NoTrailingSlash", "http://superhost", "http://superhost/"}, + {"NonDefaultPort", "http://superhost:2342/", "http://superhost:2342/"}, + + // Default-port stripping. + {"HttpsDefaultPort", "https://app.localssl.dev:443/", "https://app.localssl.dev/"}, + {"HttpDefaultPort", "http://example.com:80/sub", "http://example.com/sub/"}, + {"NonDefaultPortPreserved", "https://example.com:8443/", "https://example.com:8443/"}, + {"MismatchedScheme", "http://example.com:443/", "http://example.com:443/"}, + + // Uncommon but well-formed inputs. + {"IPv6DefaultPort", "https://[::1]:443/", "https://[::1]/"}, + {"IPv6NonDefaultPort", "https://[2001:db8::1]:8443/path", "https://[2001:db8::1]:8443/path/"}, + {"PathPreserved", "https://example.com:443/i/pro-1/", "https://example.com/i/pro-1/"}, + {"QueryStripped", "https://example.com:443/i/pro-1/?lang=de&page=2", "https://example.com/i/pro-1/"}, + {"ForceQueryStripped", "https://example.com/?", "https://example.com/"}, + {"FragmentStripped", "https://example.com/library/#photo123", "https://example.com/library/"}, + {"SurroundingWhitespace", " https://app.example.com:443/ ", "https://app.example.com/"}, + {"ExtraTrailingSlashes", "https://example.com:443////", "https://example.com/"}, + {"Whitespace", " ", "http://localhost:2342/"}, + + // Unix-socket schemes: port stripping must stay a no-op. + {"UnixScheme", "unix:///var/run/photoprism.sock", "unix:///var/run/photoprism.sock/"}, + {"HttpUnixScheme", "http+unix:///var/run/photoprism.sock", "http+unix:///var/run/photoprism.sock/"}, + } + + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + c.options.SiteUrl = tc.in + assert.Equal(t, tc.want, c.SiteUrl()) + }) + } } func TestConfig_SiteHttps(t *testing.T) { @@ -163,6 +197,32 @@ func TestConfig_SitePreview(t *testing.T) { assert.Equal(t, "http://localhost:2342/foo/preview123.jpg", c.SitePreview()) } +func TestConfig_SitePreview_StripsDefaultPort(t *testing.T) { + c := NewConfig(CliTestContext()) + + tmp := t.TempDir() + c.SetThemePath(tmp) + previewFile := filepath.Join(c.ThemePath(), "preview.jpg") + if err := os.WriteFile(previewFile, []byte("test"), fs.ModeFile); err != nil { + t.Fatal(err) + } + + c.options.SiteUrl = "https://host:443/" + c.options.SitePreview = "preview.jpg" + assert.Equal(t, "https://host/_theme/preview.jpg", c.SitePreview()) +} + +func TestConfig_DownloadUrl_StripsDefaultPort(t *testing.T) { + c := NewConfig(CliTestContext()) + + c.options.SiteUrl = "https://host:443/" + assert.Equal(t, "https://host"+DownloadUri, c.DownloadUrl()) + c.options.SiteUrl = "http://host:80/" + assert.Equal(t, "http://host"+DownloadUri, c.DownloadUrl()) + c.options.SiteUrl = "https://host:8443/" + assert.Equal(t, "https://host:8443"+DownloadUri, c.DownloadUrl()) +} + func TestConfig_SiteAuthor(t *testing.T) { c := NewConfig(CliTestContext()) @@ -181,6 +241,34 @@ func TestConfig_SiteTitle(t *testing.T) { assert.Equal(t, "Cats", c.SiteTitle()) c.options.SiteTitle = "PhotoPrism" assert.Equal(t, "PhotoPrism", c.SiteTitle()) + // With no SiteTitle and no AppName, the distinctive SiteName is used as the title. + c.options.SiteTitle = "" + c.options.SiteName = "Acme Media" + assert.Equal(t, "Acme Media", c.SiteTitle()) + // A configured AppName suppresses the SiteName-as-title fallback. + c.options.AppName = "My App" + assert.Equal(t, "PhotoPrism", c.SiteTitle()) + c.options.AppName = "" + c.options.SiteName = "" +} + +func TestConfig_SiteName(t *testing.T) { + c := NewConfig(CliTestContext()) + + // Falls back through AppName and SiteTitle when SiteName is unset. + assert.Equal(t, "", c.SiteName()) + c.options.SiteTitle = "Cats" + assert.Equal(t, "Cats", c.SiteName()) + c.options.AppName = "Kitten" + assert.Equal(t, "Kitten", c.SiteName()) + // SiteName takes precedence when explicitly configured. + c.options.SiteName = "Acme Media" + assert.Equal(t, "Acme Media", c.SiteName()) + // Empty when nothing distinctive is configured (no product Name fallback). + c.options.SiteName = "" + c.options.AppName = "" + c.options.SiteTitle = "" + assert.Equal(t, "", c.SiteName()) } func TestConfig_SiteCaption(t *testing.T) { diff --git a/internal/config/config_storage.go b/internal/config/config_storage.go index de303d5b0..06f67e7ae 100644 --- a/internal/config/config_storage.go +++ b/internal/config/config_storage.go @@ -14,9 +14,15 @@ import ( "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/fs/disk" "github.com/photoprism/photoprism/pkg/rnd" ) +// DefaultStorageFree is the default value of the "storage-free" option. It is negative so the +// runtime free-space probe is disabled by default, as the probe can misreport on some network +// mounts, fuse layers, and container overlays; operators opt in with a 1-99 percentage. +const DefaultStorageFree = -1.0 + // binPaths stores known executable paths. var ( binPaths = make(map[string]string, 8) @@ -236,6 +242,58 @@ func (c *Config) CreateDirectories() error { return nil } +// StoragePath returns the path for generated files like cache and index. +func (c *Config) StoragePath() string { + if c.options.StoragePath == "" { + // Default directories. + originalsDir := fs.Abs(filepath.Join(c.OriginalsPath(), fs.PPHiddenPathname, fs.StorageDir)) + storageDir := fs.Abs(fs.StorageDir) + + // Find existing directories. + if fs.PathWritable(originalsDir) && !c.ReadOnly() { + return originalsDir + } else if fs.PathWritable(storageDir) && c.ReadOnly() { + return storageDir + } + + // Fallback to backup storage path. + if fs.PathWritable(c.options.BackupPath) { + return fs.Abs(filepath.Join(c.options.BackupPath, fs.StorageDir)) + } + + // Use .photoprism in home directory? + if usr, _ := user.Current(); usr.HomeDir != "" { + p := fs.Abs(filepath.Join(usr.HomeDir, fs.PPHiddenPathname, fs.StorageDir)) + + if fs.PathWritable(p) || c.ReadOnly() { + return p + } + } + + // Fallback directory in case nothing else works. + if c.ReadOnly() { + return fs.Abs(filepath.Join(fs.PPHiddenPathname, fs.StorageDir)) + } + + // Store cache and index in "originals/.photoprism/storage". + return originalsDir + } + + return fs.Abs(c.options.StoragePath) +} + +// StorageFree returns the percentage of total storage space below which it is considered critically low. +// A negative value disables the check (the default); 0 or values >= 100 fall back to the disk package default. +func (c *Config) StorageFree() float64 { + if c.options.StorageFree < 0 { + return -1 + } else if c.options.StorageFree == 0 || c.options.StorageFree >= 100 { + return disk.StorageLowPct + } + + return c.options.StorageFree +} + // ConfigPath returns the config path. func (c *Config) ConfigPath() string { if c.options.ConfigPath == "" { @@ -595,46 +653,6 @@ func (c *Config) ThumbCachePath() string { return filepath.Join(c.CachePath(), fs.ThumbnailsDir) } -// StoragePath returns the path for generated files like cache and index. -func (c *Config) StoragePath() string { - if c.options.StoragePath == "" { - // Default directories. - originalsDir := fs.Abs(filepath.Join(c.OriginalsPath(), fs.PPHiddenPathname, fs.StorageDir)) - storageDir := fs.Abs(fs.StorageDir) - - // Find existing directories. - if fs.PathWritable(originalsDir) && !c.ReadOnly() { - return originalsDir - } else if fs.PathWritable(storageDir) && c.ReadOnly() { - return storageDir - } - - // Fallback to backup storage path. - if fs.PathWritable(c.options.BackupPath) { - return fs.Abs(filepath.Join(c.options.BackupPath, fs.StorageDir)) - } - - // Use .photoprism in home directory? - if usr, _ := user.Current(); usr.HomeDir != "" { - p := fs.Abs(filepath.Join(usr.HomeDir, fs.PPHiddenPathname, fs.StorageDir)) - - if fs.PathWritable(p) || c.ReadOnly() { - return p - } - } - - // Fallback directory in case nothing else works. - if c.ReadOnly() { - return fs.Abs(filepath.Join(fs.PPHiddenPathname, fs.StorageDir)) - } - - // Store cache and index in "originals/.photoprism/storage". - return originalsDir - } - - return fs.Abs(c.options.StoragePath) -} - // AssetsPath returns the path to static assets for models and templates. func (c *Config) AssetsPath() string { if c.options.AssetsPath == "" { @@ -707,9 +725,9 @@ func (c *Config) LocalesPath() string { return filepath.Join(c.AssetsPath(), fs.LocalesDir) } -// ExamplesPath returns the example files path. -func (c *Config) ExamplesPath() string { - return filepath.Join(c.AssetsPath(), fs.ExamplesDir) +// SamplesPath returns the bundled sample files path. +func (c *Config) SamplesPath() string { + return filepath.Join(c.AssetsPath(), fs.SamplesDir) } // TestdataPath returns the test files path. diff --git a/internal/config/config_storage_test.go b/internal/config/config_storage_test.go index 25e732630..82708a36c 100644 --- a/internal/config/config_storage_test.go +++ b/internal/config/config_storage_test.go @@ -12,6 +12,7 @@ import ( "github.com/stretchr/testify/require" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/fs/disk" "github.com/photoprism/photoprism/pkg/rnd" ) @@ -138,46 +139,32 @@ func TestConfig_YtDlpBin(t *testing.T) { func TestConfig_TempPath(t *testing.T) { c := NewConfig(CliTestContext()) - d0 := c.tempPath() + // Reset the cached TempPath() so the result does not depend on execution order. + tempPath = "" + t.Cleanup(func() { tempPath = "" }) - t.Logf("c.options.TempPath: '%s'", c.options.TempPath) - t.Logf("c.tempPath(): '%s'", d0) - - assert.Equal(t, ProjectRoot+"/storage/testdata/temp", c.tempPath()) + // With TempPath configured (default test config), it is returned unchanged. + want := ProjectRoot + "/storage/testdata/temp" + assert.Equal(t, want, c.tempPath()) + // TempPath() caches the first resolved value and keeps returning it even after + // the configured option is cleared. + assert.Equal(t, want, c.TempPath()) c.options.TempPath = "" + assert.Equal(t, want, c.TempPath(), "cached TempPath() should not change") + + // Without a configured option, tempPath() falls back to a "photoprism_" subdirectory + // of the OS temp dir, which is not necessarily "/tmp" (e.g. when TMPDIR is set). + wantPrefix := filepath.Join(os.TempDir(), "photoprism_") d1 := c.tempPath() - if d1 == "" { t.Fatal("temp path is empty") } + assert.True(t, strings.HasPrefix(d1, wantPrefix), "want prefix %q, got %q", wantPrefix, d1) - if !strings.HasPrefix(d1, "/tmp/photoprism_") { - t.Fatalf("unexpected temp path: %s", d1) - } - - d2 := c.tempPath() - - if d2 == "" { - t.Fatal("temp path is empty") - } - - if !strings.HasPrefix(d2, "/tmp/photoprism_") { - t.Fatalf("unexpected temp path: %s", d2) - } - - if d1 != d2 { - t.Fatalf("temp paths should match: '%s' <=> '%s'", d1, d2) - } else { - t.Logf("temp paths match: '%s' == '%s'", d1, d2) - } - - if d4 := c.TempPath(); d4 != d0 { - t.Fatalf("temp paths should match: '%s' <=> '%s'", d4, d0) - } else { - t.Logf("temp paths match: '%s' == '%s'", d4, d0) - } + // The fallback must be stable across repeated calls. + assert.Equal(t, d1, c.tempPath(), "fallback temp paths should match") } func TestConfig_CmdCachePath(t *testing.T) { @@ -606,3 +593,42 @@ func TestDefaultsYamlResolution(t *testing.T) { require.Equal(t, "", defaultsYaml(ctx)) }) } + +func TestConfig_StorageFree(t *testing.T) { + c := NewConfig(CliTestContext()) + + // Pin the shared default so the "use default" cases are deterministic, and + // restore both the option and the package-level threshold afterwards. + origOpt := c.options.StorageFree + origPct := disk.StorageLowPct + disk.StorageLowPct = 1.0 + t.Cleanup(func() { + c.options.StorageFree = origOpt + disk.StorageLowPct = origPct + }) + + t.Run("Disabled", func(t *testing.T) { + c.options.StorageFree = -1 + assert.Equal(t, float64(-1), c.StorageFree()) + }) + t.Run("NegativeDisables", func(t *testing.T) { + c.options.StorageFree = -12.5 + assert.Equal(t, float64(-1), c.StorageFree()) + }) + t.Run("ZeroUsesDefault", func(t *testing.T) { + c.options.StorageFree = 0 + assert.Equal(t, 1.0, c.StorageFree()) + }) + t.Run("HundredOrMoreUsesDefault", func(t *testing.T) { + c.options.StorageFree = 100 + assert.Equal(t, 1.0, c.StorageFree()) + c.options.StorageFree = 250 + assert.Equal(t, 1.0, c.StorageFree()) + }) + t.Run("CustomThreshold", func(t *testing.T) { + c.options.StorageFree = 5 + assert.Equal(t, 5.0, c.StorageFree()) + c.options.StorageFree = 99 + assert.Equal(t, 99.0, c.StorageFree()) + }) +} diff --git a/internal/config/config_test.go b/internal/config/config_test.go index dece1fd83..702fa83a3 100644 --- a/internal/config/config_test.go +++ b/internal/config/config_test.go @@ -5,7 +5,6 @@ import ( "path/filepath" "strings" "testing" - "time" "github.com/sirupsen/logrus" "github.com/stretchr/testify/assert" @@ -22,23 +21,27 @@ func init() { hub.ApplyTestConfig() } +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) int { _ = os.Setenv("PHOTOPRISM_TEST", "true") log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) c := TestConfig() + defer c.CleanupTestFolder() + defer func() { + if err := c.CloseDb(); err != nil { + log.Warnf("close db: %v", err) + } + // Remove temporary SQLite files after running the tests. + fs.PurgeTestDbFiles(".", false) + }() - code := m.Run() - - // Remove temporary SQLite files after running the tests. - if err := c.CloseDb(); err != nil { - log.Warnf("close db: %v", err) - } - - fs.PurgeTestDbFiles(".", false) - - os.Exit(code) + return m.Run() } func TestNewConfig(t *testing.T) { @@ -232,11 +235,11 @@ func TestConfig_AdminUser(t *testing.T) { assert.Equal(t, "admin", c.AdminUser()) } -func TestConfig_ExamplesPath(t *testing.T) { +func TestConfig_SamplesPath(t *testing.T) { c := NewConfig(CliTestContext()) - path := c.ExamplesPath() - assert.Equal(t, ProjectRoot+"/assets/examples", path) + path := c.SamplesPath() + assert.Equal(t, ProjectRoot+"/assets/samples", path) } func TestConfig_TemplatesPath(t *testing.T) { @@ -316,86 +319,8 @@ func TestConfig_ThemePath(t *testing.T) { assert.Equal(t, ProjectRoot+"/storage/testdata/config/theme", c.ThemePath()) } -func TestConfig_IndexWorkers(t *testing.T) { - c := NewConfig(CliTestContext()) - - assert.GreaterOrEqual(t, c.IndexWorkers(), 1) -} - -func TestConfig_IndexSchedule(t *testing.T) { - c := NewConfig(CliTestContext()) - assert.Equal(t, DefaultIndexSchedule, c.IndexSchedule()) -} - -func TestConfig_WakeupInterval(t *testing.T) { - c := NewConfig(CliTestContext()) - i := c.WakeupInterval() - - assert.Equal(t, "1h34m9s", c.WakeupInterval().String()) - - c.options.WakeupInterval = 45 - - assert.Equal(t, "45s", c.WakeupInterval().String()) - - c.options.WakeupInterval = 0 - - assert.Equal(t, "15m0s", c.WakeupInterval().String()) - - c.options.WakeupInterval = 150 - - assert.Equal(t, "2m30s", c.WakeupInterval().String()) - - c.options.WakeupInterval = i - - assert.Equal(t, "1h34m9s", c.WakeupInterval().String()) -} - -func TestConfig_AutoIndex(t *testing.T) { - c := NewConfig(CliTestContext()) - assert.Equal(t, -1*time.Second, c.AutoIndex()) -} - -func TestConfig_AutoImport(t *testing.T) { - c := NewConfig(CliTestContext()) - assert.Equal(t, 2*time.Hour, c.AutoImport()) -} - -func TestConfig_OriginalsLimit(t *testing.T) { - c := NewConfig(CliTestContext()) - - assert.Equal(t, -1, c.OriginalsLimit()) - c.options.OriginalsLimit = 800 - assert.Equal(t, 800, c.OriginalsLimit()) -} - -func TestConfig_OriginalsLimitBytes(t *testing.T) { - c := NewConfig(CliTestContext()) - - assert.Equal(t, int64(-1), c.OriginalsLimitBytes()) - c.options.OriginalsLimit = 800 - assert.Equal(t, int64(838860800), c.OriginalsLimitBytes()) -} - -func TestConfig_ResolutionLimit(t *testing.T) { - c := NewConfig(CliTestContext()) - - assert.Equal(t, DefaultResolutionLimit, c.ResolutionLimit()) - c.options.ResolutionLimit = 800 - assert.Equal(t, 800, c.ResolutionLimit()) - c.options.ResolutionLimit = 950 - assert.Equal(t, 900, c.ResolutionLimit()) - c.options.ResolutionLimit = 0 - assert.Equal(t, DefaultResolutionLimit, c.ResolutionLimit()) - c.options.ResolutionLimit = -1 - assert.Equal(t, -1, c.ResolutionLimit()) - c.options.Sponsor = false - assert.Equal(t, -1, c.ResolutionLimit()) - c.options.Sponsor = true - assert.Equal(t, -1, c.ResolutionLimit()) -} - func TestConfig_Serial(t *testing.T) { - c := NewConfig(CliTestContext()) + c := TestConfig() // Use complete test context, as NewConfig may not have the required file. result := c.Serial() diff --git a/internal/config/config_thumb.go b/internal/config/config_thumb.go index 52ca4956b..b23454405 100644 --- a/internal/config/config_thumb.go +++ b/internal/config/config_thumb.go @@ -40,26 +40,20 @@ func (c *Config) JpegQuality() thumb.Quality { // ThumbLibrary returns the name of the image processing library to be used for generating thumbnails. func (c *Config) ThumbLibrary() string { - if c.DisableVips() { - return thumb.LibImaging - } - switch c.options.ThumbLibrary { case thumb.LibVips, thumb.LibAuto: return thumb.LibVips - case thumb.LibImaging: - return thumb.LibImaging default: c.options.ThumbLibrary = clean.TypeLowerUnderscore(c.options.ThumbLibrary) switch c.options.ThumbLibrary { - case "imagine", "": - c.options.ThumbLibrary = thumb.LibImaging - return thumb.LibImaging + case "", thumb.LibAuto, "imaging", "imagine": + c.options.ThumbLibrary = thumb.LibVips + return thumb.LibVips case "vips", "libvips": c.options.ThumbLibrary = thumb.LibVips default: - c.options.ThumbLibrary = thumb.LibAuto + c.options.ThumbLibrary = thumb.LibVips } return thumb.LibVips @@ -71,9 +65,9 @@ func (c *Config) ThumbColor() thumb.ColorSpace { return thumb.ParseColor(c.options.ThumbColor, c.ThumbLibrary()) } -// ThumbFilter returns the thumbnail resample filter (best to worst: blackman, lanczos, cubic or linear). +// ThumbFilter returns the default thumbnail resample filter. func (c *Config) ThumbFilter() thumb.ResampleFilter { - return thumb.ParseFilter(c.options.ThumbFilter, c.ThumbLibrary()) + return thumb.ParseFilter("", c.ThumbLibrary()) } // ThumbUncached checks if on-demand thumbnail rendering is enabled (high memory and cpu usage). @@ -81,27 +75,27 @@ func (c *Config) ThumbUncached() bool { return c.options.ThumbUncached } -// ThumbSizePrecached returns the pre-cached thumbnail size limit in pixels (720-7680). +// ThumbSizePrecached returns the pre-cached thumbnail size limit in pixels (720-15360). func (c *Config) ThumbSizePrecached() int { size := c.options.ThumbSize if size < 720 { size = 720 // Mobile, TV - } else if size > 7680 { - size = 7680 // 8K Ultra HD + } else if size > 15360 { + size = 15360 // 16K, e.g. for 360° media } return size } -// ThumbSizeUncached returns the on-demand rendering size limit in pixels (720-7680). +// ThumbSizeUncached returns the on-demand rendering size limit in pixels (720-15360). func (c *Config) ThumbSizeUncached() int { limit := c.options.ThumbSizeUncached if limit < 720 { limit = 720 // Mobile, TV - } else if limit > 7680 { - limit = 7680 // 8K Ultra HD + } else if limit > 15360 { + limit = 15360 // 16K, e.g. for 360° media } if c.ThumbSizePrecached() > limit { diff --git a/internal/config/config_thumb_test.go b/internal/config/config_thumb_test.go index 0db6bf2f7..1e9cbbab5 100644 --- a/internal/config/config_thumb_test.go +++ b/internal/config/config_thumb_test.go @@ -41,17 +41,7 @@ func TestConfig_JpegQuality(t *testing.T) { func TestConfig_ThumbFilter(t *testing.T) { c := NewConfig(CliTestContext()) - assert.Equal(t, thumb.ResampleLanczos, c.ThumbFilter()) - c.options.ThumbFilter = "blackman" - assert.Equal(t, thumb.ResampleBlackman, c.ThumbFilter()) - c.options.ThumbFilter = "lanczos" - assert.Equal(t, thumb.ResampleLanczos, c.ThumbFilter()) - c.options.ThumbFilter = "linear" - assert.Equal(t, thumb.ResampleLinear, c.ThumbFilter()) - c.options.ThumbFilter = Auto - assert.Equal(t, thumb.ResampleLanczos, c.ThumbFilter()) - c.options.ThumbFilter = "" - assert.Equal(t, thumb.ResampleLanczos, c.ThumbFilter()) + assert.Equal(t, thumb.ResampleAuto, c.ThumbFilter()) } func TestConfig_ThumbSizeUncached(t *testing.T) { @@ -65,7 +55,9 @@ func TestConfig_ThumbSize(t *testing.T) { assert.Equal(t, 720, c.ThumbSizePrecached()) c.options.ThumbSize = 7681 - assert.Equal(t, 7680, c.ThumbSizePrecached()) + assert.Equal(t, 7681, c.ThumbSizePrecached()) + c.options.ThumbSize = 15361 + assert.Equal(t, 15360, c.ThumbSizePrecached()) } func TestConfig_ThumbSizeUncached2(t *testing.T) { @@ -73,12 +65,45 @@ func TestConfig_ThumbSizeUncached2(t *testing.T) { assert.Equal(t, 720, c.ThumbSizeUncached()) c.options.ThumbSizeUncached = 7681 - assert.Equal(t, 7680, c.ThumbSizeUncached()) + assert.Equal(t, 7681, c.ThumbSizeUncached()) + c.options.ThumbSizeUncached = 15361 + assert.Equal(t, 15360, c.ThumbSizeUncached()) c.options.ThumbSizeUncached = 800 c.options.ThumbSize = 900 assert.Equal(t, int(900), c.ThumbSizeUncached()) } +func TestInitThumbs_AdvertisesLargeSizes(t *testing.T) { + origCached := thumb.SizeCached + origOnDemand := thumb.SizeOnDemand + defer func() { + thumb.SizeCached = origCached + thumb.SizeOnDemand = origOnDemand + initThumbs() + }() + + names := func() []string { + out := make([]string, 0, len(Thumbs)) + for _, s := range Thumbs { + out = append(out, s.Size) + } + return out + } + + // A high on-demand limit exposes the 8K and 16K sizes to client apps. + thumb.SizeCached = 1920 + thumb.SizeOnDemand = 15360 + initThumbs() + assert.Contains(t, names(), "fit_15360") + assert.Contains(t, names(), "fit_7680") + + // A low limit keeps the large on-demand sizes out of the advertised list. + thumb.SizeOnDemand = 2560 + initThumbs() + assert.NotContains(t, names(), "fit_15360") + assert.NotContains(t, names(), "fit_7680") +} + func TestConfig_PngSize(t *testing.T) { c := NewConfig(CliTestContext()) @@ -91,14 +116,12 @@ func TestConfig_PngSize(t *testing.T) { func TestConfig_ThumbLibrary(t *testing.T) { c := NewConfig(CliTestContext()) - assert.False(t, c.DisableVips()) c.options.ThumbLibrary = Auto assert.Equal(t, "vips", c.ThumbLibrary()) - c.options.DisableVips = true - assert.Equal(t, "imaging", c.ThumbLibrary()) - c.options.DisableVips = false c.options.ThumbLibrary = "libvips" assert.Equal(t, "vips", c.ThumbLibrary()) + c.options.ThumbLibrary = "imaging" + assert.Equal(t, "vips", c.ThumbLibrary()) c.options.ThumbLibrary = "xxx" assert.Equal(t, "vips", c.ThumbLibrary()) } diff --git a/internal/config/config_usage.go b/internal/config/config_usage.go index 7feb8588f..1bc7678c8 100644 --- a/internal/config/config_usage.go +++ b/internal/config/config_usage.go @@ -2,16 +2,27 @@ package config import ( "math" + "sync/atomic" "time" gc "github.com/patrickmn/go-cache" "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/internal/entity/query" + "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/fs/disk" "github.com/photoprism/photoprism/pkg/fs/duf" ) +// DisableStorageCheck turns off the free storage probe by StorageLow. Init sets it from the +// configured threshold (StorageFree <= 0), and StorageLow latches it true after a probe error +// so a storage path whose free space cannot be read is not probed repeatedly. Exported so +// tests with synthetic storage paths can reset it; atomic because StorageLow is called +// concurrently by indexing workers, API handlers, and client config builds. +var DisableStorageCheck atomic.Bool + +// usageCache is the disk usage information cache. var usageCache = gc.New(5*time.Minute, 5*time.Minute) // FlushUsageCache resets the usage information cache. @@ -24,7 +35,10 @@ func FlushUsageCache() { // derive their values from the ratio helpers to align with Prometheus // conventions and avoid rounding artifacts. type Usage struct { - // File storage usage and quota (total). + // Indicates if free storage is below threshold. + StorageLow bool `json:"storageLow"` + + // Originals volume usage and quota information. FilesUsed uint64 `json:"filesUsed"` FilesUsedPct int `json:"filesUsedPct"` FilesFree uint64 `json:"filesFree"` @@ -68,10 +82,12 @@ func (info *Usage) UsersUsedRatio() float64 { } // Usage returns the used, free and total storage size in bytes and caches the result. -func (c *Config) Usage() Usage { - // Return nil if feature is not enabled. +func (c *Config) Usage() (info Usage) { + // When detailed usage info is disabled, still report the low-storage flag + // but skip the quota and database accounting below. if !c.UsageInfo() { - return Usage{} + _, info.StorageLow, _ = c.StorageLow() + return info } originalsPath := c.OriginalsPath() @@ -80,7 +96,7 @@ func (c *Config) Usage() Usage { return cached.(Usage) } - info := Usage{} + _, info.StorageLow, _ = c.StorageLow() if err := c.Db().Unscoped(). Table("files"). @@ -180,6 +196,32 @@ func (c *Config) UsersQuotaReached(role acl.Role) bool { return c.UsersQuotaExceeded(99, role) } +// StorageLow reports whether the storage folder is critically low on free disk space for safe indexing writes. +func (c *Config) StorageLow() (free uint64, low bool, err error) { + if DisableStorageCheck.Load() { + return 0, false, nil + } + + free, low, err = disk.StorageLow(c.StoragePath()) + + if err != nil { + DisableStorageCheck.Store(true) + log.Debugf("storage: failed to detect free disk space (%s)", clean.Error(err)) + } + + return free, low, err +} + +// InsufficientStorage reports whether new file writes should be rejected due to quota or low free disk space. +func (c *Config) InsufficientStorage() bool { + if c.FilesQuotaReached() { + return true + } + + _, low, _ := c.StorageLow() + return low +} + // UsersQuotaExceeded checks whether the number of user accounts specified in percent has been exceeded. func (c *Config) UsersQuotaExceeded(usedPct int, role acl.Role) bool { if c.options.UsersQuota <= 0 { diff --git a/internal/config/config_usage_test.go b/internal/config/config_usage_test.go index 9fb9e1304..8907f6cf5 100644 --- a/internal/config/config_usage_test.go +++ b/internal/config/config_usage_test.go @@ -7,6 +7,7 @@ import ( "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/fs/disk" "github.com/photoprism/photoprism/pkg/fs/duf" ) @@ -118,6 +119,110 @@ func TestConfig_FilesQuotaReached(t *testing.T) { c.options.FilesQuota = uint64(0) } +func TestConfig_StorageLow(t *testing.T) { + c := TestConfig() + + free, low, err := c.StorageLow() + assert.NoError(t, err) + assert.False(t, low, "test storage filesystem must not be reported as low") + assert.NotZero(t, free) +} + +func TestConfig_StorageLow_SkipCheck(t *testing.T) { + c := TestConfig() + + // Seed a low entry so the check would normally return low=true. + disk.SetFree(c.StoragePath(), 1*disk.MB, 1000*disk.MB) + t.Cleanup(disk.FlushFree) + + // Toggling DisableStorageCheck mirrors what PHOTOPRISM_STORAGE_FREE="-1" does at startup. + prev := DisableStorageCheck.Load() + DisableStorageCheck.Store(true) + t.Cleanup(func() { DisableStorageCheck.Store(prev) }) + + free, low, err := c.StorageLow() + assert.NoError(t, err) + assert.False(t, low, "skip flag must bypass the disk probe") + assert.Zero(t, free) +} + +func TestConfig_InsufficientStorage(t *testing.T) { + c := TestConfig() + + // Drive the disk side from the cache so the verdict is independent of the host filesystem. + disk.SetFree(c.StoragePath(), 999*disk.MB, 1000*disk.MB) + t.Cleanup(disk.FlushFree) + + t.Run("Neither", func(t *testing.T) { + c.options.FilesQuota = 0 + FlushUsageCache() + disk.SetFree(c.StoragePath(), 950*disk.MB, 1000*disk.MB) + + assert.False(t, c.InsufficientStorage()) + }) + t.Run("QuotaOnly", func(t *testing.T) { + c.options.FilesQuota = 1 + FlushUsageCache() + disk.SetFree(c.StoragePath(), 999*disk.MB, 1000*disk.MB) + + assert.True(t, c.InsufficientStorage()) + }) + t.Run("StorageLowOnly", func(t *testing.T) { + c.options.FilesQuota = 0 + FlushUsageCache() + disk.SetFree(c.StoragePath(), 1*disk.MB, 1000*disk.MB) + + assert.True(t, c.InsufficientStorage()) + }) + t.Run("Both", func(t *testing.T) { + c.options.FilesQuota = 1 + FlushUsageCache() + disk.SetFree(c.StoragePath(), 1*disk.MB, 1000*disk.MB) + + assert.True(t, c.InsufficientStorage()) + }) + + c.options.FilesQuota = 0 +} + +func TestConfig_Usage_StorageLow(t *testing.T) { + c := TestConfig() + + // Make the verdict independent of host state and prior tests: enable the probe, + // pin the threshold, and drive free space from the cache. + prevDisable := DisableStorageCheck.Load() + prevPct := disk.StorageLowPct + DisableStorageCheck.Store(false) + disk.StorageLowPct = 1.0 + disk.FlushFree() + t.Cleanup(func() { + DisableStorageCheck.Store(prevDisable) + disk.StorageLowPct = prevPct + disk.FlushFree() + FlushUsageCache() + c.options.UsageInfo = false + }) + + t.Run("ReportedWhenUsageInfoDisabled", func(t *testing.T) { + c.options.UsageInfo = false + c.options.FilesQuota = 0 + c.options.UsersQuota = 0 + FlushUsageCache() + disk.SetFree(c.StoragePath(), 1*disk.MB, 1000*disk.MB) + + u := c.Usage() + assert.True(t, u.StorageLow, "storageLow must be reported even when usage info is disabled") + assert.Zero(t, u.FilesUsed, "detailed usage must stay unset when usage info is disabled") + }) + t.Run("HealthyWhenUsageInfoEnabled", func(t *testing.T) { + c.options.UsageInfo = true + FlushUsageCache() + disk.SetFree(c.StoragePath(), 950*disk.MB, 1000*disk.MB) + + assert.False(t, c.Usage().StorageLow) + }) +} + func TestConfig_UsersQuotaReached(t *testing.T) { c := TestConfig() diff --git a/internal/config/customize/README.md b/internal/config/customize/README.md index a13060f66..0ec648adb 100644 --- a/internal/config/customize/README.md +++ b/internal/config/customize/README.md @@ -1,6 +1,6 @@ ## PhotoPrism — Customize Package -**Last Updated:** November 21, 2025 +**Last Updated:** June 9, 2026 ### Overview @@ -17,6 +17,12 @@ The `customize` package defines user-facing configuration defaults for PhotoPris - The value may be comma- or space-separated (case-insensitive); hyphens/underscores are ignored. - Tokens are inflected so singular/plural variants match (for example, `albums`, `album`, or `Album` all disable the Albums flag). +### Per-Role & Per-Scope Gating + +- `Settings.ApplyACL(rules, role)` and `Settings.ApplyScope(scope)` return a per-session copy of the feature flags, switching off features the session may not use. A flag is enabled only when both the global default and the relevant permission/scope allow it. +- The `Account` and `AppPasswords` flags require permission (and scope) to update the password (`ResourcePassword`/`ActionUpdate`), so a share-token visitor without an account does not see the account or app-password affordances. +- This per-session gating shapes only the client config the Web UI reads; server-side enforcement of disabled app passwords uses the global `AppPasswords` flag via `Config.DisableAppPasswords()`. + ### Settings Lifecycle - `NewDefaultSettings()` seeds UI, search, maps, imports, indexing, templates, downloads, and features from the defaults in this package. diff --git a/internal/config/customize/acl.go b/internal/config/customize/acl.go index a1c5b399e..193883a45 100644 --- a/internal/config/customize/acl.go +++ b/internal/config/customize/acl.go @@ -13,6 +13,8 @@ func (s *Settings) ApplyACL(list acl.ACL, role acl.Role) *Settings { m.Features.Favorites = s.Features.Favorites && list.AllowAny(acl.ResourceFavorites, role, acl.Permissions{acl.ActionSearch}) m.Features.Folders = s.Features.Folders && list.AllowAny(acl.ResourceFolders, role, acl.Permissions{acl.ActionSearch}) m.Features.Labels = s.Features.Labels && list.AllowAny(acl.ResourceLabels, role, acl.Permissions{acl.ActionSearch}) + m.Features.Cameras = s.Features.Cameras && list.AllowAny(acl.ResourceCameras, role, acl.Permissions{acl.ActionSearch}) + m.Features.Lenses = s.Features.Lenses && list.AllowAny(acl.ResourceLenses, role, acl.Permissions{acl.ActionSearch}) m.Features.Calendar = s.Features.Calendar && list.AllowAny(acl.ResourceCalendar, role, acl.Permissions{acl.ActionSearch}) m.Features.Moments = s.Features.Moments && list.AllowAny(acl.ResourceMoments, role, acl.Permissions{acl.ActionSearch}) m.Features.People = s.Features.People && list.AllowAny(acl.ResourcePeople, role, acl.Permissions{acl.ActionSearch}) @@ -43,6 +45,7 @@ func (s *Settings) ApplyACL(list acl.ACL, role acl.Role) *Settings { // Settings. m.Features.Account = s.Features.Account && list.Allow(acl.ResourcePassword, role, acl.ActionUpdate) + m.Features.AppPasswords = s.Features.AppPasswords && list.Allow(acl.ResourcePassword, role, acl.ActionUpdate) m.Features.Settings = s.Features.Settings && list.AllowAny(acl.ResourceSettings, role, acl.Permissions{acl.ActionUpdate}) m.Features.Services = s.Features.Services && list.Allow(acl.ResourceServices, role, acl.ActionUpload) diff --git a/internal/config/customize/acl_test.go b/internal/config/customize/acl_test.go index ec89251ee..05214ab72 100644 --- a/internal/config/customize/acl_test.go +++ b/internal/config/customize/acl_test.go @@ -15,35 +15,38 @@ func TestSettings_ApplyACL(t *testing.T) { s := NewDefaultSettings() expected := FeatureSettings{ - Account: true, - Albums: true, - Archive: true, - Delete: true, - Download: true, - Edit: true, - BatchEdit: true, - Estimates: true, - Favorites: true, - Files: true, - Folders: true, - Import: true, - Labels: true, - Library: true, - Logs: true, - Calendar: true, - Moments: true, - People: true, - Places: true, - Private: true, - Ratings: true, - Reactions: true, - Review: true, - Search: true, - Settings: true, - Share: true, - Services: true, - Upload: true, - Videos: true, + Albums: true, + Archive: true, + Delete: true, + Download: true, + Edit: true, + BatchEdit: true, + Estimates: true, + Favorites: true, + Files: true, + Folders: true, + Import: true, + Labels: true, + Cameras: true, + Lenses: true, + Library: true, + Logs: true, + Calendar: true, + Moments: true, + People: true, + Places: true, + Private: true, + Ratings: true, + Reactions: true, + Review: true, + Search: true, + Account: true, + AppPasswords: true, + Settings: true, + Share: true, + Services: true, + Upload: true, + Videos: true, } assert.Equal(t, original, s.Features) @@ -56,35 +59,38 @@ func TestSettings_ApplyACL(t *testing.T) { s := NewDefaultSettings() expected := FeatureSettings{ - Account: false, - Albums: true, - Archive: false, - Delete: false, - Download: true, - Edit: false, - BatchEdit: false, - Estimates: true, - Favorites: false, - Files: false, - Folders: true, - Import: false, - Labels: false, - Library: false, - Logs: false, - Calendar: true, - Moments: true, - People: false, - Places: true, - Private: false, - Ratings: false, - Reactions: false, - Review: true, - Search: false, - Settings: false, - Share: false, - Services: false, - Upload: false, - Videos: false, + Albums: true, + Archive: false, + Delete: false, + Download: true, + Edit: false, + BatchEdit: false, + Estimates: true, + Favorites: false, + Files: false, + Folders: true, + Import: false, + Labels: false, + Cameras: false, + Lenses: false, + Library: false, + Logs: false, + Calendar: true, + Moments: true, + People: false, + Places: true, + Private: false, + Ratings: false, + Reactions: false, + Review: true, + Search: false, + Account: false, + AppPasswords: false, + Settings: false, + Share: false, + Services: false, + Upload: false, + Videos: false, } assert.Equal(t, original, s.Features) @@ -98,5 +104,9 @@ func TestSettings_ApplyACL(t *testing.T) { r := s.ApplyACL(acl.Rules, acl.RoleClient) assert.True(t, r.Features.BatchEdit) + // AppPasswords mirrors Account: both require permission to update the + // password, which the client role does not have. + assert.Equal(t, r.Features.Account, r.Features.AppPasswords) + assert.False(t, r.Features.AppPasswords) }) } diff --git a/internal/config/customize/customize.go b/internal/config/customize/customize.go index 0ab72e55f..a178455d1 100644 --- a/internal/config/customize/customize.go +++ b/internal/config/customize/customize.go @@ -1,7 +1,7 @@ /* Package customize provides user settings to customize the app. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/config/customize/feature.go b/internal/config/customize/feature.go index d67b002a7..e3b547e10 100644 --- a/internal/config/customize/feature.go +++ b/internal/config/customize/feature.go @@ -2,33 +2,36 @@ package customize // FeatureSettings represents feature flags, mainly for the Web UI. type FeatureSettings struct { - Account bool `json:"account" yaml:"Account"` - Albums bool `json:"albums" yaml:"Albums"` - Archive bool `json:"archive" yaml:"Archive"` - Delete bool `json:"delete" yaml:"Delete"` - Download bool `json:"download" yaml:"Download"` - Edit bool `json:"edit" yaml:"Edit"` - BatchEdit bool `json:"batchEdit" yaml:"BatchEdit"` - Estimates bool `json:"estimates" yaml:"Estimates"` - Favorites bool `json:"favorites" yaml:"Favorites"` - Files bool `json:"files" yaml:"Files"` - Folders bool `json:"folders" yaml:"Folders"` - Import bool `json:"import" yaml:"Import"` - Labels bool `json:"labels" yaml:"Labels"` - Library bool `json:"library" yaml:"Library"` - Logs bool `json:"logs" yaml:"Logs"` - Calendar bool `json:"calendar" yaml:"Calendar"` - Moments bool `json:"moments" yaml:"Moments"` - People bool `json:"people" yaml:"People"` - Places bool `json:"places" yaml:"Places"` - Private bool `json:"private" yaml:"Private"` - Ratings bool `json:"ratings" yaml:"Ratings"` - Reactions bool `json:"reactions" yaml:"Reactions"` - Review bool `json:"review" yaml:"Review"` - Search bool `json:"search" yaml:"Search"` - Services bool `json:"services" yaml:"Services"` - Settings bool `json:"settings" yaml:"Settings"` - Share bool `json:"share" yaml:"Share"` - Upload bool `json:"upload" yaml:"Upload"` - Videos bool `json:"videos" yaml:"Videos"` + Albums bool `json:"albums" yaml:"Albums"` + Archive bool `json:"archive" yaml:"Archive"` + Delete bool `json:"delete" yaml:"Delete"` + Download bool `json:"download" yaml:"Download"` + Edit bool `json:"edit" yaml:"Edit"` + BatchEdit bool `json:"batchEdit" yaml:"BatchEdit"` + Estimates bool `json:"estimates" yaml:"Estimates"` + Favorites bool `json:"favorites" yaml:"Favorites"` + Files bool `json:"files" yaml:"Files"` + Folders bool `json:"folders" yaml:"Folders"` + Import bool `json:"import" yaml:"Import"` + Labels bool `json:"labels" yaml:"Labels"` + Cameras bool `json:"cameras" yaml:"Cameras"` + Lenses bool `json:"lenses" yaml:"Lenses"` + Library bool `json:"library" yaml:"Library"` + Logs bool `json:"logs" yaml:"Logs"` + Calendar bool `json:"calendar" yaml:"Calendar"` + Moments bool `json:"moments" yaml:"Moments"` + People bool `json:"people" yaml:"People"` + Places bool `json:"places" yaml:"Places"` + Private bool `json:"private" yaml:"Private"` + Ratings bool `json:"ratings" yaml:"Ratings"` + Reactions bool `json:"reactions" yaml:"Reactions"` + Review bool `json:"review" yaml:"Review"` + Search bool `json:"search" yaml:"Search"` + Services bool `json:"services" yaml:"Services"` + Account bool `json:"account" yaml:"Account"` + AppPasswords bool `json:"appPasswords" yaml:"AppPasswords"` + Settings bool `json:"settings" yaml:"Settings"` + Share bool `json:"share" yaml:"Share"` + Upload bool `json:"upload" yaml:"Upload"` + Videos bool `json:"videos" yaml:"Videos"` } diff --git a/internal/config/customize/features_default_test.go b/internal/config/customize/features_default_test.go index a5eea81dd..65f2d7636 100644 --- a/internal/config/customize/features_default_test.go +++ b/internal/config/customize/features_default_test.go @@ -21,7 +21,7 @@ func TestInitDefaultFeatures_DisableList(t *testing.T) { DefaultFeatures = initDefaultFeatures() }) - _ = os.Setenv("PHOTOPRISM_DISABLE_FEATURES", "Upload, videos share batch-edit labels") + _ = os.Setenv("PHOTOPRISM_DISABLE_FEATURES", "Upload, videos share batch-edit labels cameras lenses") DefaultFeatures = initDefaultFeatures() assert.False(t, DefaultFeatures.Upload) @@ -29,6 +29,8 @@ func TestInitDefaultFeatures_DisableList(t *testing.T) { assert.False(t, DefaultFeatures.Share) assert.False(t, DefaultFeatures.BatchEdit) assert.False(t, DefaultFeatures.Labels) + assert.False(t, DefaultFeatures.Cameras) + assert.False(t, DefaultFeatures.Lenses) // unaffected feature stays enabled assert.True(t, DefaultFeatures.Favorites) @@ -37,6 +39,35 @@ func TestInitDefaultFeatures_DisableList(t *testing.T) { assert.NotEqual(t, origDefaults, FeatureSettings{}) } +func TestInitDefaultFeatures_AppPasswords(t *testing.T) { + origEnv, envSet := os.LookupEnv("PHOTOPRISM_DISABLE_FEATURES") + origDefaults := DefaultFeatures + + t.Cleanup(func() { + if envSet { + _ = os.Setenv("PHOTOPRISM_DISABLE_FEATURES", origEnv) + } else { + _ = os.Unsetenv("PHOTOPRISM_DISABLE_FEATURES") + } + + DefaultFeatures = origDefaults + }) + + t.Run("EnabledByDefault", func(t *testing.T) { + _ = os.Unsetenv("PHOTOPRISM_DISABLE_FEATURES") + assert.True(t, initDefaultFeatures().AppPasswords) + }) + t.Run("DisabledViaEnv", func(t *testing.T) { + // Operators can turn app passwords off at startup via PHOTOPRISM_DISABLE_FEATURES; + // the name is normalized, so "app-passwords", "appPasswords", and "AppPasswords" + // all disable it. + _ = os.Setenv("PHOTOPRISM_DISABLE_FEATURES", "app-passwords") + features := initDefaultFeatures() + assert.False(t, features.AppPasswords) + assert.True(t, features.Albums) + }) +} + func TestNewSettingsCopiesDefaultFeatures(t *testing.T) { origEnv, envSet := os.LookupEnv("PHOTOPRISM_DISABLE_FEATURES") origDefaults := DefaultFeatures diff --git a/internal/config/customize/import.go b/internal/config/customize/import.go index e335e0cde..ca7f3849a 100644 --- a/internal/config/customize/import.go +++ b/internal/config/customize/import.go @@ -32,11 +32,10 @@ func (s *ImportSettings) GetPath() string { } // GetDest returns the default file import destination, or a custom pattern if set and valid. +// It does not modify the receiver, so parallel import workers can call it concurrently; +// invalid stored patterns are normalized once in Settings.Propagate, not on read. func (s *ImportSettings) GetDest() string { - if dest := strings.Trim(clean.Path(s.Dest), "/."); dest == "" || dest != s.Dest { - s.Dest = "" - } else if ImportDestRegexp.MatchString(dest) { - s.Dest = dest + if dest := strings.Trim(clean.Path(s.Dest), "/."); dest != "" && dest == s.Dest && ImportDestRegexp.MatchString(dest) { return dest } diff --git a/internal/config/customize/import_test.go b/internal/config/customize/import_test.go index d669a2a6f..68786baf4 100644 --- a/internal/config/customize/import_test.go +++ b/internal/config/customize/import_test.go @@ -1,6 +1,7 @@ package customize import ( + "sync" "testing" "time" @@ -60,7 +61,9 @@ func TestImportSettings(t *testing.T) { assert.Equal(t, customPath, s.GetPath()) assert.Equal(t, true, s.Move) assert.Equal(t, DefaultImportDest, s.GetDest()) - assert.Equal(t, "", s.Dest) + // GetDest must not mutate the receiver so it stays safe for concurrent import workers; + // invalid stored patterns are normalized once in Settings.Propagate instead. + assert.Equal(t, customDest, s.Dest) assert.Equal(t, DefaultImportDest, s.GetDest()) pathName, fileName := s.GetDestName() @@ -70,6 +73,33 @@ func TestImportSettings(t *testing.T) { }) } +// TestImportSettings_GetDestConcurrent ensures GetDest and GetDestName are safe for +// concurrent use by parallel import workers; it fails under -race if GetDest writes +// to the shared receiver again. +func TestImportSettings_GetDestConcurrent(t *testing.T) { + s := &ImportSettings{Dest: "/1/2/20060102_150405_82F63B78.jpg"} + + const workers = 16 + + var wg sync.WaitGroup + + wg.Add(workers) + + for range workers { + go func() { + defer wg.Done() + for range 100 { + _ = s.GetDest() + _, _ = s.GetDestName() + } + }() + } + + wg.Wait() + + assert.Equal(t, DefaultImportDest, s.GetDest()) +} + func TestImportDestRegexp(t *testing.T) { // Must match "^\\D*\\d{2,14}[\\-/_].*\\d{2,14}.*(\\.ext|\\.EXT)$" t.Run("Valid", func(t *testing.T) { diff --git a/internal/config/customize/scope.go b/internal/config/customize/scope.go index e732de070..eefd826f7 100644 --- a/internal/config/customize/scope.go +++ b/internal/config/customize/scope.go @@ -20,6 +20,8 @@ func (s *Settings) ApplyScope(scope string) *Settings { m.Features.Favorites = s.Features.Favorites && scopes.Contains(acl.ResourceFavorites.String()) m.Features.Folders = s.Features.Folders && scopes.Contains(acl.ResourceFolders.String()) m.Features.Labels = s.Features.Labels && scopes.Contains(acl.ResourceLabels.String()) + m.Features.Cameras = s.Features.Cameras && scopes.Contains(acl.ResourceCameras.String()) + m.Features.Lenses = s.Features.Lenses && scopes.Contains(acl.ResourceLenses.String()) m.Features.Calendar = s.Features.Calendar && scopes.Contains(acl.ResourceCalendar.String()) m.Features.Moments = s.Features.Moments && scopes.Contains(acl.ResourceMoments.String()) m.Features.People = s.Features.People && scopes.Contains(acl.ResourcePeople.String()) @@ -49,6 +51,7 @@ func (s *Settings) ApplyScope(scope string) *Settings { // Settings. m.Features.Account = s.Features.Account && scopes.Contains(acl.ResourcePassword.String()) + m.Features.AppPasswords = s.Features.AppPasswords && scopes.Contains(acl.ResourcePassword.String()) m.Features.Settings = s.Features.Settings && scopes.Contains(acl.ResourceSettings.String()) m.Features.Services = s.Features.Services && scopes.Contains(acl.ResourceServices.String()) diff --git a/internal/config/customize/scope_test.go b/internal/config/customize/scope_test.go index 7868b1a62..e31fe9192 100644 --- a/internal/config/customize/scope_test.go +++ b/internal/config/customize/scope_test.go @@ -19,35 +19,38 @@ func TestSettings_ApplyScope(t *testing.T) { s := NewDefaultSettings() expected := FeatureSettings{ - Account: true, - Albums: true, - Archive: true, - Delete: true, - Download: true, - Edit: true, - BatchEdit: true, - Estimates: true, - Favorites: true, - Files: true, - Folders: true, - Import: true, - Labels: true, - Library: true, - Logs: true, - Calendar: true, - Moments: true, - People: true, - Places: true, - Private: true, - Ratings: true, - Reactions: true, - Review: true, - Search: true, - Settings: true, - Share: true, - Services: true, - Upload: true, - Videos: true, + Albums: true, + Archive: true, + Delete: true, + Download: true, + Edit: true, + BatchEdit: true, + Estimates: true, + Favorites: true, + Files: true, + Folders: true, + Import: true, + Labels: true, + Cameras: true, + Lenses: true, + Library: true, + Logs: true, + Calendar: true, + Moments: true, + People: true, + Places: true, + Private: true, + Ratings: true, + Reactions: true, + Review: true, + Search: true, + Account: true, + AppPasswords: true, + Settings: true, + Share: true, + Services: true, + Upload: true, + Videos: true, } assert.Equal(t, original, s.Features) @@ -60,35 +63,38 @@ func TestSettings_ApplyScope(t *testing.T) { s := NewDefaultSettings() expected := FeatureSettings{ - Account: false, - Albums: true, - Archive: true, - Delete: true, - Download: true, - Edit: true, - BatchEdit: true, - Estimates: true, - Favorites: false, - Files: false, - Folders: false, - Import: false, - Labels: false, - Library: false, - Logs: false, - Calendar: true, - Moments: true, - People: true, - Places: true, - Private: true, - Ratings: true, - Reactions: true, - Review: true, - Search: true, - Settings: false, - Share: false, - Services: false, - Upload: true, - Videos: true, + Albums: true, + Archive: true, + Delete: true, + Download: true, + Edit: true, + BatchEdit: true, + Estimates: true, + Favorites: false, + Files: false, + Folders: false, + Import: false, + Labels: false, + Cameras: false, + Lenses: false, + Library: false, + Logs: false, + Calendar: true, + Moments: true, + People: true, + Places: true, + Private: true, + Ratings: true, + Reactions: true, + Review: true, + Search: true, + Account: false, + AppPasswords: false, + Settings: false, + Share: false, + Services: false, + Upload: true, + Videos: true, } assert.Equal(t, original, s.Features) @@ -101,35 +107,38 @@ func TestSettings_ApplyScope(t *testing.T) { s := NewDefaultSettings() expected := FeatureSettings{ - Account: true, - Albums: true, - Archive: false, - Delete: false, - Download: true, - Edit: false, - BatchEdit: false, - Estimates: true, - Favorites: false, - Files: false, - Folders: true, - Import: false, - Labels: false, - Library: false, - Logs: false, - Calendar: true, - Moments: true, - People: false, - Places: true, - Private: false, - Ratings: false, - Reactions: true, - Review: true, - Search: true, - Settings: true, - Share: false, - Services: false, - Upload: false, - Videos: true, + Albums: true, + Archive: false, + Delete: false, + Download: true, + Edit: false, + BatchEdit: false, + Estimates: true, + Favorites: false, + Files: false, + Folders: true, + Import: false, + Labels: false, + Cameras: false, + Lenses: false, + Library: false, + Logs: false, + Calendar: true, + Moments: true, + People: false, + Places: true, + Private: false, + Ratings: false, + Reactions: true, + Review: true, + Search: true, + Account: true, + AppPasswords: true, + Settings: true, + Share: false, + Services: false, + Upload: false, + Videos: true, } assert.Equal(t, original, s.Features) @@ -141,35 +150,38 @@ func TestSettings_ApplyScope(t *testing.T) { s := NewDefaultSettings() expected := FeatureSettings{ - Account: false, - Albums: true, - Archive: false, - Delete: false, - Download: true, - Edit: false, - BatchEdit: false, - Estimates: true, - Favorites: false, - Files: false, - Folders: true, - Import: false, - Labels: false, - Library: false, - Logs: false, - Calendar: true, - Moments: true, - People: false, - Places: true, - Private: false, - Ratings: false, - Reactions: false, - Review: true, - Search: false, - Settings: false, - Share: false, - Services: false, - Upload: false, - Videos: false, + Albums: true, + Archive: false, + Delete: false, + Download: true, + Edit: false, + BatchEdit: false, + Estimates: true, + Favorites: false, + Files: false, + Folders: true, + Import: false, + Labels: false, + Cameras: false, + Lenses: false, + Library: false, + Logs: false, + Calendar: true, + Moments: true, + People: false, + Places: true, + Private: false, + Ratings: false, + Reactions: false, + Review: true, + Search: false, + Account: false, + AppPasswords: false, + Settings: false, + Share: false, + Services: false, + Upload: false, + Videos: false, } assert.Equal(t, original, s.Features) @@ -181,35 +193,38 @@ func TestSettings_ApplyScope(t *testing.T) { s := NewDefaultSettings() expected := FeatureSettings{ - Account: false, - Albums: false, - Archive: false, - Delete: false, - Download: false, - Edit: false, - BatchEdit: false, - Estimates: true, - Favorites: false, - Files: false, - Folders: false, - Import: false, - Labels: false, - Library: false, - Logs: false, - Calendar: false, - Moments: false, - People: false, - Places: false, - Private: false, - Ratings: false, - Reactions: false, - Review: true, - Search: false, - Settings: false, - Share: false, - Services: false, - Upload: false, - Videos: false, + Albums: false, + Archive: false, + Delete: false, + Download: false, + Edit: false, + BatchEdit: false, + Estimates: true, + Favorites: false, + Files: false, + Folders: false, + Import: false, + Labels: false, + Cameras: false, + Lenses: false, + Library: false, + Logs: false, + Calendar: false, + Moments: false, + People: false, + Places: false, + Private: false, + Ratings: false, + Reactions: false, + Review: true, + Search: false, + Account: false, + AppPasswords: false, + Settings: false, + Share: false, + Services: false, + Upload: false, + Videos: false, } assert.Equal(t, original, s.Features) diff --git a/internal/config/customize/settings.go b/internal/config/customize/settings.go index 32133a11e..e6ddbac59 100644 --- a/internal/config/customize/settings.go +++ b/internal/config/customize/settings.go @@ -53,12 +53,14 @@ func NewSettings(theme, language, timeZone string) *Settings { return &Settings{ UI: UISettings{ - Scrollbar: true, - Zoom: false, - Theme: theme, - Language: language, - TimeZone: timeZone, - StartPage: DefaultStartPage, + Scrollbar: true, + Zoom: false, + OpenOnHover: true, + ReduceMotion: false, + Theme: theme, + Language: language, + TimeZone: timeZone, + StartPage: DefaultStartPage, }, Search: SearchSettings{ BatchSize: -1, @@ -115,6 +117,12 @@ func (s *Settings) Propagate() { s.Maps.Style = DefaultMapsStyle } + // Reset the import destination pattern unless it is already a normalized, valid value, + // so GetDest can stay side-effect free for concurrent import workers. + if s.Import.Dest != "" && s.Import.GetDest() != s.Import.Dest { + s.Import.Dest = "" + } + i18n.SetLocale(s.UI.Language) } diff --git a/internal/config/customize/settings_test.go b/internal/config/customize/settings_test.go index e055debf9..52750766d 100644 --- a/internal/config/customize/settings_test.go +++ b/internal/config/customize/settings_test.go @@ -15,6 +15,10 @@ func TestNewSettings(t *testing.T) { assert.Equal(t, DefaultLanguage, s.UI.Language) assert.Equal(t, DefaultTimeZone, s.UI.TimeZone) assert.Equal(t, DefaultStartPage, s.UI.StartPage) + assert.Equal(t, true, s.UI.Scrollbar) + assert.Equal(t, false, s.UI.Zoom) + assert.Equal(t, true, s.UI.OpenOnHover) + assert.Equal(t, false, s.UI.ReduceMotion) assert.Equal(t, DefaultMapsStyle, s.Maps.Style) }) t.Run("Custom", func(t *testing.T) { @@ -38,6 +42,18 @@ func TestNewSettings(t *testing.T) { assert.Equal(t, DefaultStartPage, s.UI.StartPage) assert.Equal(t, DefaultMapsStyle, s.Maps.Style) }) + t.Run("ImportDest", func(t *testing.T) { + s := NewDefaultSettings() + // A normalized, valid pattern is preserved. + s.Import.Dest = "2006/01/20060102_150405_82F63B78.jpg" + s.Propagate() + assert.Equal(t, "2006/01/20060102_150405_82F63B78.jpg", s.Import.Dest) + // An invalid or denormalized pattern is reset so GetDest falls back to the default. + s.Import.Dest = "/1/2/20060102_150405_82F63B78.jpg" + s.Propagate() + assert.Equal(t, "", s.Import.Dest) + assert.Equal(t, DefaultImportDest, s.Import.GetDest()) + }) } func TestSettings_Load(t *testing.T) { @@ -83,6 +99,9 @@ func TestSettings_Save(t *testing.T) { s := NewDefaultSettings() s.UI.Theme = "onyx" s.UI.Language = "de" + // Set the UI booleans to non-default values so the round-trip proves their yaml tags map. + s.UI.Scrollbar = false + s.UI.ReduceMotion = true assert.Equal(t, "onyx", s.UI.Theme) assert.Equal(t, "de", s.UI.Language) @@ -91,6 +110,13 @@ func TestSettings_Save(t *testing.T) { t.Fatal(err) } + reloaded := NewDefaultSettings() + if err := reloaded.Load("testdata/settings_tmp.yml"); err != nil { + t.Fatal(err) + } + assert.Equal(t, false, reloaded.UI.Scrollbar) + assert.Equal(t, true, reloaded.UI.ReduceMotion) + if err := os.Remove("testdata/settings_tmp.yml"); err != nil { t.Fatal(err) } diff --git a/internal/config/customize/testdata/settings.yml b/internal/config/customize/testdata/settings.yml index 4b84ef046..840b2d73b 100755 --- a/internal/config/customize/testdata/settings.yml +++ b/internal/config/customize/testdata/settings.yml @@ -1,6 +1,8 @@ UI: Scrollbar: true Zoom: false + OpenOnHover: true + ReduceMotion: false Theme: onyx Language: de TimeZone: Local @@ -14,7 +16,6 @@ Maps: Animate: 0 Style: default Features: - Account: true Albums: true Archive: true Delete: true @@ -27,6 +28,8 @@ Features: Folders: true Import: true Labels: true + Cameras: true + Lenses: true Library: true Logs: true Calendar: true @@ -39,6 +42,8 @@ Features: Review: true Search: true Services: true + Account: true + AppPasswords: true Settings: true Share: true Upload: true diff --git a/internal/config/customize/ui.go b/internal/config/customize/ui.go index 26cfcadf0..38d8c3461 100644 --- a/internal/config/customize/ui.go +++ b/internal/config/customize/ui.go @@ -2,10 +2,12 @@ package customize // UISettings represents user interface settings. type UISettings struct { - Scrollbar bool `json:"scrollbar" yaml:"Scrollbar"` - Zoom bool `json:"zoom" yaml:"Zoom"` - Theme string `json:"theme" yaml:"Theme"` - Language string `json:"language" yaml:"Language"` - TimeZone string `json:"timeZone" yaml:"TimeZone"` - StartPage string `json:"startPage" yaml:"StartPage"` + Scrollbar bool `json:"scrollbar" yaml:"Scrollbar"` + Zoom bool `json:"zoom" yaml:"Zoom"` + OpenOnHover bool `json:"openOnHover" yaml:"OpenOnHover"` + ReduceMotion bool `json:"reduceMotion" yaml:"ReduceMotion"` + Theme string `json:"theme" yaml:"Theme"` + Language string `json:"language" yaml:"Language"` + TimeZone string `json:"timeZone" yaml:"TimeZone"` + StartPage string `json:"startPage" yaml:"StartPage"` } diff --git a/internal/config/feat/feat.go b/internal/config/feat/feat.go index 9e1c17676..0d394f410 100644 --- a/internal/config/feat/feat.go +++ b/internal/config/feat/feat.go @@ -2,7 +2,7 @@ Package feat centralizes feature flag definitions that gate PhotoPrism configuration experiments and in-progress integrations. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -15,7 +15,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/config/flags.go b/internal/config/flags.go index 7eb3e1f19..c1e167c84 100644 --- a/internal/config/flags.go +++ b/internal/config/flags.go @@ -3,13 +3,13 @@ package config import ( "fmt" - "github.com/klauspost/cpuid/v2" "github.com/urfave/cli/v2" "github.com/photoprism/photoprism/internal/ai/face" "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/internal/config/ttl" "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/internal/ffmpeg" "github.com/photoprism/photoprism/internal/ffmpeg/encode" "github.com/photoprism/photoprism/internal/service/cluster" "github.com/photoprism/photoprism/internal/service/hub/places" @@ -39,7 +39,7 @@ var Flags = CliFlags{ Usage: "secret `KEY` for signing authentication tokens", EnvVars: EnvVars("AUTH_SECRET"), Hidden: true, - }}, { + }, Secret: true}, { Flag: &cli.BoolFlag{ Name: "public", Aliases: []string{"p"}, @@ -59,7 +59,7 @@ var Flags = CliFlags{ Aliases: []string{"pw"}, Usage: fmt.Sprintf("initial `PASSWORD` of the superadmin account (%d-%d characters)", entity.PasswordLength, txt.ClipPassword), EnvVars: EnvVars("ADMIN_PASSWORD"), - }}, { + }, Secret: true}, { Flag: &cli.IntFlag{ Name: "password-length", Usage: "minimum password `LENGTH` in characters", @@ -83,13 +83,19 @@ var Flags = CliFlags{ Usage: "client `SECRET` for single sign-on via OpenID Connect", Value: "", EnvVars: EnvVars("OIDC_SECRET"), - }}, { + }, Secret: true}, { Flag: &cli.StringFlag{ Name: "oidc-scopes", Usage: "client authorization `SCOPES` for single sign-on via OpenID Connect", Value: authn.OidcDefaultScopes, EnvVars: EnvVars("OIDC_SCOPES"), }}, { + Flag: &cli.StringFlag{ + Name: "oidc-prompt", + Usage: "authorization `PROMPT` for single sign-on via OpenID Connect (login, select_account, consent)", + Value: "", + EnvVars: EnvVars("OIDC_PROMPT"), + }}, { Flag: &cli.StringFlag{ Name: "oidc-provider", Usage: "custom identity provider `NAME`, e.g. Google", @@ -112,6 +118,11 @@ var Flags = CliFlags{ Usage: "allows new users to create an account when they sign in with OpenID Connect", EnvVars: EnvVars("OIDC_REGISTER"), }}, { + Flag: &cli.BoolFlag{ + Name: "oidc-logout", + Usage: "ends the provider session on sign-out via OpenID Connect RP-initiated logout", + EnvVars: EnvVars("OIDC_LOGOUT"), + }}, { Flag: &cli.StringFlag{ Name: "oidc-username", Usage: "preferred username `CLAIM` for new OpenID Connect users (preferred_username, name, nickname, email)", @@ -133,7 +144,7 @@ var Flags = CliFlags{ }}, { Flag: &cli.StringSliceFlag{ Name: "oidc-group-role", - Usage: "map `GROUP=ROLE`; repeat to add more (roles: " + acl.UserRoles.CliUsageString() + ")", + Usage: "map `GROUP=ROLE`; repeat to add more (roles: " + acl.ClusterInstanceRolesCliUsageString() + ")", EnvVars: EnvVars("OIDC_GROUP_ROLE"), Hidden: true, }}, { @@ -216,6 +227,19 @@ var Flags = CliFlags{ Usage: "hosting partner id", EnvVars: EnvVars("PARTNER_ID"), }}, { + Flag: &cli.PathFlag{ + Name: "storage-path", + Aliases: []string{"s"}, + Usage: "writable storage `PATH` for sidecar, cache, and database files", + EnvVars: EnvVars("STORAGE_PATH"), + TakesFile: true, + }}, { + Flag: &cli.Float64Flag{ + Name: "storage-free", + Usage: "minimum `PERCENT` (1-99) of free storage required for indexing, importing, and uploads, -1 disables the check", + Value: DefaultStorageFree, + EnvVars: EnvVars("STORAGE_FREE"), + }}, { Flag: &cli.PathFlag{ Name: "config-path", Aliases: []string{"config", "c"}, @@ -262,13 +286,6 @@ var Flags = CliFlags{ Value: fs.UsersDir, EnvVars: EnvVars("USERS_PATH"), }}, { - Flag: &cli.PathFlag{ - Name: "storage-path", - Aliases: []string{"s"}, - Usage: "writable storage `PATH` for sidecar, cache, and database files", - EnvVars: EnvVars("STORAGE_PATH"), - TakesFile: true, - }}, { Flag: &cli.PathFlag{ Name: "import-path", Aliases: []string{"im"}, @@ -290,7 +307,7 @@ var Flags = CliFlags{ Flag: &cli.BoolFlag{ Name: "upload-nsfw", Aliases: []string{"n"}, - Usage: "allows uploads that might be offensive (detecting unsafe content requires TensorFlow)", + Usage: "allows uploads that might be offensive (when disabled, files flagged by the NSFW model are rejected before indexing)", EnvVars: EnvVars("UPLOAD_NSFW"), }}, { Flag: &cli.StringFlag{ @@ -393,13 +410,13 @@ var Flags = CliFlags{ Usage: "enables the use of YAML files for backing up album metadata", EnvVars: EnvVars("BACKUP_ALBUMS"), }, DocDefault: "true"}, { - Flag: &cli.IntFlag{ + Flag: &cli.StringFlag{ Name: "index-workers", Aliases: []string{"workers"}, - Usage: "maximum `NUMBER` of indexing workers, default depends on the number of physical cores", - Value: cpuid.CPU.PhysicalCores / 2, + Usage: "maximum `NUMBER` of indexing workers, or 'auto' to derive from the available CPU cores", + Value: IndexWorkersAuto, EnvVars: EnvVars("INDEX_WORKERS", "WORKERS"), - }, DocDefault: " "}, { + }}, { Flag: &cli.StringFlag{ Name: "index-schedule", Usage: "indexing `SCHEDULE` in cron format (e.g. \"@every 3h\" for every 3 hours; \"\" to disable)", @@ -462,6 +479,11 @@ var Flags = CliFlags{ Usage: "prevents other apps from accessing PhotoPrism as a shared network drive", EnvVars: EnvVars("DISABLE_WEBDAV"), }}, { + Flag: &cli.BoolFlag{ + Name: "disable-mcp", + Usage: "disables the Model Context Protocol (MCP) API endpoint for AI agent integrations", + EnvVars: EnvVars("DISABLE_MCP"), + }}, { Flag: &cli.BoolFlag{ Name: "disable-places", Usage: "disables interactive world maps and reverse geocoding", @@ -492,11 +514,6 @@ var Flags = CliFlags{ Usage: "disables metadata extraction with ExifTool (required for full Video, Live Photo, and XMP support)", EnvVars: EnvVars("DISABLE_EXIFTOOL"), }}, { - Flag: &cli.BoolFlag{ - Name: "disable-vips", - Usage: "disables image processing and conversion with libvips", - EnvVars: EnvVars("DISABLE_VIPS"), - }}, { Flag: &cli.BoolFlag{ Name: "disable-sips", Usage: "disables file conversion using the sips command under macOS", @@ -587,7 +604,7 @@ var Flags = CliFlags{ }}, { Flag: &cli.StringFlag{ Name: "app-icon", - Usage: "home screen app `ICON` (logo, app, crisp, mint, bold, square)", + Usage: "home screen app `ICON` (logo, app, crisp, mint, bold, square, bloom, flower, ring, shutter)", EnvVars: EnvVars("APP_ICON"), }}, { Flag: &cli.StringFlag{ @@ -636,29 +653,35 @@ var Flags = CliFlags{ }}, { Flag: &cli.StringFlag{ Name: "site-author", - Usage: "site `OWNER`, copyright, or artist", + Usage: "site `OWNER` shown in the author meta tag", EnvVars: EnvVars("SITE_AUTHOR"), }}, { + Flag: &cli.StringFlag{ + Name: "site-name", + Usage: "short `NAME` for identifying this instance within a cluster *optional*", + Value: "", + EnvVars: EnvVars("SITE_NAME"), + }}, { Flag: &cli.StringFlag{ Name: "site-title", - Usage: "site `TITLE`", + Usage: "main `TITLE` shown in the web interface and meta tags", Value: "", EnvVars: EnvVars("SITE_TITLE"), }}, { Flag: &cli.StringFlag{ Name: "site-caption", - Usage: "site `CAPTION`", + Usage: "short `CAPTION` or tagline shown alongside the title", Value: "AI-Powered Photos App", EnvVars: EnvVars("SITE_CAPTION"), }}, { Flag: &cli.StringFlag{ Name: "site-description", - Usage: "site `DESCRIPTION` *optional*", + Usage: "longer `DESCRIPTION` shown in SEO and social meta tags *optional*", EnvVars: EnvVars("SITE_DESCRIPTION"), }}, { Flag: &cli.StringFlag{ Name: "site-favicon", - Usage: "site favicon `FILENAME` *optional*", + Usage: "custom favicon `FILENAME` for web browsers *optional*", EnvVars: EnvVars("SITE_FAVICON"), TakesFile: true, }}, { @@ -712,17 +735,46 @@ var Flags = CliFlags{ EnvVars: EnvVars("CLUSTER_UUID"), Hidden: true, }}, { + Flag: &cli.BoolFlag{ + Name: "cluster-oidc", + Usage: "use the cluster Portal as this instance's OIDC login provider", + EnvVars: EnvVars("CLUSTER_OIDC"), + }}, { + Flag: &cli.StringSliceFlag{ + Name: "cluster-allow-groups", + Usage: "admit group `ID` to this instance via the Portal (repeatable)", + EnvVars: EnvVars("CLUSTER_ALLOW_GROUPS"), + Hidden: true, + }}, { + Flag: &cli.StringSliceFlag{ + Name: "cluster-allow-group-roles", + Usage: "map `GROUP=ROLE` for Portal admission (roles: " + acl.ClusterInstanceRolesCliUsageString() + ")", + EnvVars: EnvVars("CLUSTER_ALLOW_GROUP_ROLES"), + Hidden: true, + }}, { + Flag: &cli.BoolFlag{ + Name: "cluster-groups-full-view", + Usage: "send the user's full group set to this instance", + EnvVars: EnvVars("CLUSTER_GROUPS_FULL_VIEW"), + Hidden: true, + }}, { Flag: &cli.StringFlag{ Name: "portal-url", Usage: "base `URL` of the cluster management portal", Value: DefaultPortalUrl, EnvVars: EnvVars("PORTAL_URL"), }}, { + Flag: &cli.StringFlag{ + Name: "portal-login-url", + Usage: "browser-facing `URL` of the Portal login page", + EnvVars: EnvVars("PORTAL_LOGIN_URL"), + Hidden: true, + }}, { Flag: &cli.StringFlag{ Name: "join-token", Usage: "secret `TOKEN` required to join a cluster; min 24 chars", EnvVars: EnvVars("JOIN_TOKEN"), - }}, { + }, Secret: true}, { Flag: &cli.StringFlag{ Name: "node-name", Usage: "node `NAME` (unique in cluster domain; [a-z0-9-]{1,32})", @@ -750,7 +802,7 @@ var Flags = CliFlags{ Usage: "node OAuth client `SECRET` (auto-assigned via join token)", EnvVars: EnvVars("NODE_CLIENT_SECRET"), Hidden: true, - }}, { + }, Secret: true}, { Flag: &cli.StringFlag{ Name: "jwks-url", Usage: "JWKS endpoint `URL` provided by the cluster portal for JWT verification", @@ -774,6 +826,29 @@ var Flags = CliFlags{ Value: 60, EnvVars: EnvVars("JWT_LEEWAY"), }}, { + Flag: &cli.StringFlag{ + Name: "portal-oidc-issuer", + Usage: "Portal OIDC OP issuer `URL` advertised in discovery and ID tokens (defaults to site-url)", + EnvVars: EnvVars("PORTAL_OIDC_ISSUER"), + }}, { + Flag: &cli.IntFlag{ + Name: "portal-oidc-ttl", + Usage: "Portal OIDC OP access/ID-token lifetime in `SECONDS` (default 300, max 900)", + Value: 300, + EnvVars: EnvVars("PORTAL_OIDC_TTL"), + }}, { + Flag: &cli.IntFlag{ + Name: "portal-oidc-code-ttl", + Usage: "Portal OIDC OP authorization-code lifetime in `SECONDS` (default 60, max 300)", + Value: 60, + EnvVars: EnvVars("PORTAL_OIDC_CODE_TTL"), + }}, { + Flag: &cli.StringFlag{ + Name: "portal-oidc-default-policy", + Usage: "Portal OIDC OP routing policy when a user has access to multiple instances (`chooser` or `direct`)", + Value: "chooser", + EnvVars: EnvVars("PORTAL_OIDC_DEFAULT_POLICY"), + }}, { Flag: &cli.StringFlag{ Name: "advertise-url", Usage: "advertised `URL` for intra-cluster calls (scheme://host[:port])", @@ -860,7 +935,7 @@ var Flags = CliFlags{ Flag: &cli.StringFlag{ Name: "http-compression", Aliases: []string{"z"}, - Usage: "Web server compression `METHOD` (gzip, none)", + Usage: "Web server compression `METHODS` as a comma-separated preference list (e.g. \"zstd,gzip\"; supported: gzip, zstd, none)", EnvVars: EnvVars("HTTP_COMPRESSION"), }}, { Flag: &cli.StringFlag{ @@ -950,7 +1025,8 @@ var Flags = CliFlags{ Aliases: []string{"db-pass"}, Usage: "database user `PASSWORD`", EnvVars: EnvVars("DATABASE_PASSWORD"), - }}, { + }, + Secret: true}, { Flag: &cli.IntFlag{ Name: "database-timeout", Usage: "timeout in `SECONDS` for establishing a database connection (1-60)", @@ -1008,7 +1084,7 @@ var Flags = CliFlags{ }}, { Flag: &cli.IntFlag{ Name: "ffmpeg-size", - Usage: "encoding resolution limit in `PIXELS` (720-7680)", + Usage: "encoding resolution limit in `PIXELS` (720-15360)", Value: thumb.Sizes[thumb.Fit4096].Width, EnvVars: EnvVars("FFMPEG_SIZE"), }}, { @@ -1047,6 +1123,12 @@ var Flags = CliFlags{ Value: encode.DefaultMapAudio, EnvVars: EnvVars("FFMPEG_MAP_AUDIO"), }, DocDefault: fmt.Sprintf("`%s`", encode.DefaultMapAudio)}, { + Flag: &cli.StringFlag{ + Name: "ffmpeg-exclude", + Usage: "container and codec `FORMATS` not to be processed by FFmpeg, separated by commas", + Value: ffmpeg.DefaultExclude, + EnvVars: EnvVars("FFMPEG_EXCLUDE", "FFMPEG_BLACKLIST"), + }}, { Flag: &cli.StringFlag{ Name: "exiftool-bin", Usage: "ExifTool `COMMAND` for extracting metadata", @@ -1132,16 +1214,16 @@ var Flags = CliFlags{ Name: "download-token", Usage: "`DEFAULT` download URL token for originals (leave blank for a random value)", EnvVars: EnvVars("DOWNLOAD_TOKEN"), - }}, { + }, Secret: true}, { Flag: &cli.StringFlag{ Name: "preview-token", Usage: "`DEFAULT` thumbnail and video streaming URL token (leave blank for a random value)", EnvVars: EnvVars("PREVIEW_TOKEN"), - }}, { + }, Secret: true}, { Flag: &cli.StringFlag{ Name: "thumb-library", Aliases: []string{"thumbs"}, - Usage: "image processing `LIBRARY` to be used for generating thumbnails (auto, imaging, vips)", + Usage: "image processing `LIBRARY` to be used for generating thumbnails (auto, vips)", Value: Auto, EnvVars: EnvVars("THUMB_LIBRARY"), }}, { @@ -1151,22 +1233,15 @@ var Flags = CliFlags{ Value: thumb.ColorAuto, EnvVars: EnvVars("THUMB_COLOR"), }}, { - Flag: &cli.StringFlag{ - Name: "thumb-filter", - Aliases: []string{"filter"}, - Usage: "downscaling filter `NAME` (imaging best to worst: blackman, lanczos, cubic, linear, nearest)", - Value: thumb.ResampleAuto.String(), - EnvVars: EnvVars("THUMB_FILTER"), - }}, { Flag: &cli.IntFlag{ Name: "thumb-size", - Usage: "maximum size of pre-generated thumbnails in `PIXELS` (720-7680)", + Usage: "maximum size of pre-generated thumbnails in `PIXELS` (720-15360)", Value: thumb.SizeCached, EnvVars: EnvVars("THUMB_SIZE"), }}, { Flag: &cli.IntFlag{ Name: "thumb-size-uncached", - Usage: "maximum size of thumbnails generated on demand in `PIXELS` (720-7680)", + Usage: "maximum size of thumbnails generated on demand in `PIXELS` (720-15360)", Value: thumb.SizeOnDemand, EnvVars: EnvVars("THUMB_SIZE_UNCACHED"), }}, { @@ -1186,13 +1261,13 @@ var Flags = CliFlags{ Flag: &cli.IntFlag{ Name: "jpeg-size", Usage: "maximum size of generated JPEG images in `PIXELS` (720-30000)", - Value: 7680, + Value: 15360, EnvVars: EnvVars("JPEG_SIZE"), }}, { Flag: &cli.IntFlag{ Name: "png-size", Usage: "maximum size of generated PNG images in `PIXELS` (720-30000)", - Value: 7680, + Value: 15360, EnvVars: EnvVars("PNG_SIZE"), }}, { Flag: &cli.StringFlag{ @@ -1218,7 +1293,7 @@ var Flags = CliFlags{ Usage: "vision service access `TOKEN` *optional*", Value: "", EnvVars: EnvVars("VISION_KEY"), - }}, { + }, Secret: true}, { Flag: &cli.StringFlag{ Name: "vision-schedule", Usage: "vision worker `SCHEDULE` for background processing (e.g. \"0 12 * * *\" for daily at noon) or at a random time (daily, weekly)", @@ -1232,12 +1307,12 @@ var Flags = CliFlags{ }}, { Flag: &cli.BoolFlag{ Name: "detect-nsfw", - Usage: "flags newly added pictures as private if they might be offensive (requires TensorFlow)", + Usage: "flags newly added pictures as private if they might be offensive (uses the configured NSFW model; built-in TensorFlow by default)", EnvVars: EnvVars("DETECT_NSFW"), }}, { Flag: &cli.StringFlag{ Name: "face-engine", - Usage: "face detection engine `NAME` (auto, pigo, onnx)", + Usage: "face detection engine `NAME` (auto, onnx)", Value: face.EngineAuto, EnvVars: EnvVars("FACE_ENGINE"), }}, { @@ -1258,12 +1333,6 @@ var Flags = CliFlags{ Value: face.ScoreThreshold, EnvVars: EnvVars("FACE_SCORE"), }}, { - Flag: &cli.Float64SliceFlag{ - Name: "face-angle", - Usage: "face detection `ANGLE` in radians (repeatable)", - Value: cli.NewFloat64Slice(face.DefaultAngles...), - EnvVars: EnvVars("FACE_ANGLE"), - }}, { Flag: &cli.IntFlag{ Name: "face-overlap", Usage: "face area overlap threshold in `PERCENT` (1-100)", diff --git a/internal/config/flags_grouprole_test.go b/internal/config/flags_grouprole_test.go new file mode 100644 index 000000000..925e54adc --- /dev/null +++ b/internal/config/flags_grouprole_test.go @@ -0,0 +1,37 @@ +package config + +import ( + "testing" + + "github.com/stretchr/testify/assert" + "github.com/urfave/cli/v2" + + "github.com/photoprism/photoprism/internal/auth/acl" +) + +// TestGroupRoleFlagsUsage pins the hidden --oidc-group-role and +// --cluster-allow-group-roles flags to the shared acl.ClusterInstanceRoles list, +// so the role help cannot drift. These flags are Hidden and therefore never +// render via "--help" or "show commands", so this is the only coverage of their +// usage text. +func TestGroupRoleFlagsUsage(t *testing.T) { + roles := acl.ClusterInstanceRolesCliUsageString() + assert.Equal(t, "admin, manager, user, contributor, viewer, or guest", roles) + + found := map[string]bool{"oidc-group-role": false, "cluster-allow-group-roles": false} + for _, f := range Flags { + ssf, ok := f.Flag.(*cli.StringSliceFlag) + if !ok { + continue + } + if _, tracked := found[ssf.Name]; !tracked { + continue + } + found[ssf.Name] = true + assert.True(t, ssf.Hidden, "%s must stay hidden", ssf.Name) + assert.Contains(t, ssf.Usage, roles, "%s usage must list the cluster instance roles", ssf.Name) + } + for name, ok := range found { + assert.Truef(t, ok, "flag --%s not found in config.Flags", name) + } +} diff --git a/internal/config/messages.go b/internal/config/messages.go index cb6d08b9a..44c0348e0 100644 --- a/internal/config/messages.go +++ b/internal/config/messages.go @@ -2,7 +2,7 @@ package config var ( // SignUpURL points to the membership sign-up page. - SignUpURL = "https://www.photoprism.app/membership" + SignUpURL = "https://www.photoprism.app/membership/" // MsgSponsor is the default sponsorship message shown to users. MsgSponsor = "Become a member today, support our mission and enjoy our member benefits! 💎" // MsgSignUp is the default sign-up helper text. diff --git a/internal/config/options.go b/internal/config/options.go index 11c61ae8f..42dd72e51 100644 --- a/internal/config/options.go +++ b/internal/config/options.go @@ -40,10 +40,12 @@ type Options struct { OIDCClient string `yaml:"OIDCClient" json:"-" flag:"oidc-client"` OIDCSecret string `yaml:"OIDCSecret" json:"-" flag:"oidc-secret"` OIDCScopes string `yaml:"OIDCScopes" json:"-" flag:"oidc-scopes"` + OIDCPrompt string `yaml:"OIDCPrompt" json:"-" flag:"oidc-prompt"` OIDCProvider string `yaml:"OIDCProvider" json:"OIDCProvider" flag:"oidc-provider"` OIDCIcon string `yaml:"OIDCIcon" json:"OIDCIcon" flag:"oidc-icon"` OIDCRedirect bool `yaml:"OIDCRedirect" json:"OIDCRedirect" flag:"oidc-redirect"` OIDCRegister bool `yaml:"OIDCRegister" json:"OIDCRegister" flag:"oidc-register"` + OIDCLogout bool `yaml:"OIDCLogout" json:"OIDCLogout" flag:"oidc-logout"` OIDCUsername string `yaml:"OIDCUsername" json:"-" flag:"oidc-username"` OIDCGroupClaim string `yaml:"OIDCGroupClaim" json:"-" flag:"oidc-group-claim" tags:"portal,pro"` OIDCGroup []string `yaml:"OIDCGroup" json:"-" flag:"oidc-group" tags:"portal,pro"` @@ -63,6 +65,8 @@ type Options struct { Unsafe bool `yaml:"-" json:"-" flag:"unsafe"` Demo bool `yaml:"-" json:"-" flag:"demo"` Sponsor bool `yaml:"-" json:"-" flag:"sponsor"` + StoragePath string `yaml:"StoragePath" json:"-" flag:"storage-path"` + StorageFree float64 `yaml:"StorageFree" json:"-" flag:"storage-free"` ConfigPath string `yaml:"ConfigPath" json:"-" flag:"config-path"` OptionsYaml string `json:"-" yaml:"-" flag:"-"` DefaultsYaml string `json:"-" yaml:"-" flag:"defaults-yaml"` @@ -70,7 +74,6 @@ type Options struct { OriginalsLimit int `yaml:"OriginalsLimit" json:"OriginalsLimit" flag:"originals-limit"` ResolutionLimit int `yaml:"ResolutionLimit" json:"ResolutionLimit" flag:"resolution-limit"` UsersPath string `yaml:"UsersPath" json:"-" flag:"users-path"` - StoragePath string `yaml:"StoragePath" json:"-" flag:"storage-path"` ImportPath string `yaml:"ImportPath" json:"-" flag:"import-path"` ImportDest string `yaml:"ImportDest" json:"-" flag:"import-dest"` ImportAllow string `yaml:"ImportAllow" json:"ImportAllow" flag:"import-allow"` @@ -94,7 +97,7 @@ type Options struct { BackupRetain int `yaml:"BackupRetain" json:"BackupRetain" flag:"backup-retain"` BackupDatabase bool `yaml:"BackupDatabase" json:"BackupDatabase" flag:"backup-database" default:"true"` BackupAlbums bool `yaml:"BackupAlbums" json:"BackupAlbums" flag:"backup-albums" default:"true"` - IndexWorkers int `yaml:"IndexWorkers" json:"IndexWorkers" flag:"index-workers"` + IndexWorkers string `yaml:"IndexWorkers" json:"IndexWorkers" flag:"index-workers"` IndexSchedule string `yaml:"IndexSchedule" json:"IndexSchedule" flag:"index-schedule"` WakeupInterval time.Duration `yaml:"WakeupInterval" json:"WakeupInterval" flag:"wakeup-interval"` AutoIndex int `yaml:"AutoIndex" json:"AutoIndex" flag:"auto-index"` @@ -106,13 +109,13 @@ type Options struct { DisableBackups bool `yaml:"DisableBackups" json:"DisableBackups" flag:"disable-backups"` DisableRestart bool `yaml:"DisableRestart" json:"-" flag:"disable-restart"` DisableWebDAV bool `yaml:"DisableWebDAV" json:"DisableWebDAV" flag:"disable-webdav"` + DisableMCP bool `yaml:"DisableMCP" json:"DisableMCP" flag:"disable-mcp"` DisablePlaces bool `yaml:"DisablePlaces" json:"DisablePlaces" flag:"disable-places"` DisableTensorFlow bool `yaml:"DisableTensorFlow" json:"DisableTensorFlow" flag:"disable-tensorflow"` DisableFaces bool `yaml:"DisableFaces" json:"DisableFaces" flag:"disable-faces"` DisableClassification bool `yaml:"DisableClassification" json:"DisableClassification" flag:"disable-classification"` DisableFFmpeg bool `yaml:"DisableFFmpeg" json:"DisableFFmpeg" flag:"disable-ffmpeg"` DisableExifTool bool `yaml:"DisableExifTool" json:"DisableExifTool" flag:"disable-exiftool"` - DisableVips bool `yaml:"DisableVips" json:"DisableVips" flag:"disable-vips"` DisableSips bool `yaml:"DisableSips" json:"DisableSips" flag:"disable-sips"` DisableDarktable bool `yaml:"DisableDarktable" json:"DisableDarktable" flag:"disable-darktable"` DisableRawTherapee bool `yaml:"DisableRawTherapee" json:"DisableRawTherapee" flag:"disable-rawtherapee"` @@ -138,6 +141,7 @@ type Options struct { SiteUrl string `yaml:"SiteUrl" json:"SiteUrl" flag:"site-url"` FrontendUri string `yaml:"FrontendUri" json:"-" flag:"frontend-uri" tags:"portal,pro"` SiteAuthor string `yaml:"SiteAuthor" json:"SiteAuthor" flag:"site-author"` + SiteName string `yaml:"SiteName" json:"SiteName" flag:"site-name"` SiteTitle string `yaml:"SiteTitle" json:"SiteTitle" flag:"site-title"` SiteCaption string `yaml:"SiteCaption" json:"SiteCaption" flag:"site-caption"` SiteDescription string `yaml:"SiteDescription" json:"SiteDescription" flag:"site-description"` @@ -151,7 +155,12 @@ type Options struct { ClusterDomain string `yaml:"ClusterDomain" json:"-" flag:"cluster-domain"` ClusterCIDR string `yaml:"ClusterCIDR" json:"-" flag:"cluster-cidr"` ClusterUUID string `yaml:"ClusterUUID" json:"-" flag:"cluster-uuid"` + ClusterOIDC bool `yaml:"ClusterOIDC" json:"-" flag:"cluster-oidc"` + ClusterAllowGroups []string `yaml:"ClusterAllowGroups" json:"-" flag:"cluster-allow-groups"` + ClusterAllowGroupRoles []string `yaml:"ClusterAllowGroupRoles" json:"-" flag:"cluster-allow-group-roles"` + ClusterGroupsFullView bool `yaml:"ClusterGroupsFullView" json:"-" flag:"cluster-groups-full-view"` PortalUrl string `yaml:"PortalUrl" json:"-" flag:"portal-url"` + PortalLoginUrl string `yaml:"PortalLoginUrl" json:"-" flag:"portal-login-url"` PortalProxy bool `yaml:"PortalProxy" json:"-" flag:"portal-proxy"` PortalProxyUri string `yaml:"PortalProxyUri" json:"-" flag:"portal-proxy-uri"` JoinToken string `yaml:"JoinToken" json:"-" flag:"join-token"` @@ -164,6 +173,10 @@ type Options struct { JWKSCacheTTL int `yaml:"JWKSCacheTTL" json:"-" flag:"jwks-cache-ttl"` JWTScope string `yaml:"JWTScope" json:"-" flag:"jwt-scope"` JWTLeeway int `yaml:"JWTLeeway" json:"-" flag:"jwt-leeway"` + PortalOIDCIssuer string `yaml:"PortalOIDCIssuer" json:"-" flag:"portal-oidc-issuer"` + PortalOIDCTTL int `yaml:"PortalOIDCTTL" json:"-" flag:"portal-oidc-ttl"` + PortalOIDCCodeTTL int `yaml:"PortalOIDCCodeTTL" json:"-" flag:"portal-oidc-code-ttl"` + PortalOIDCDefaultPolicy string `yaml:"PortalOIDCDefaultPolicy" json:"-" flag:"portal-oidc-default-policy"` AdvertiseUrl string `yaml:"AdvertiseUrl" json:"-" flag:"advertise-url"` HttpsProxy string `yaml:"HttpsProxy" json:"HttpsProxy" flag:"https-proxy"` HttpsProxyInsecure bool `yaml:"HttpsProxyInsecure" json:"HttpsProxyInsecure" flag:"https-proxy-insecure"` @@ -211,6 +224,7 @@ type Options struct { FFmpegDevice string `yaml:"FFmpegDevice" json:"-" flag:"ffmpeg-device"` FFmpegMapVideo string `yaml:"FFmpegMapVideo" json:"FFmpegMapVideo" flag:"ffmpeg-map-video"` FFmpegMapAudio string `yaml:"FFmpegMapAudio" json:"FFmpegMapAudio" flag:"ffmpeg-map-audio"` + FFmpegExclude string `yaml:"FFmpegExclude" json:"-" flag:"ffmpeg-exclude"` ExifToolBin string `yaml:"ExifToolBin" json:"-" flag:"exiftool-bin"` SipsBin string `yaml:"SipsBin" json:"-" flag:"sips-bin"` SipsExclude string `yaml:"SipsExclude" json:"-" flag:"sips-exclude"` @@ -229,7 +243,6 @@ type Options struct { PreviewToken string `yaml:"PreviewToken" json:"-" flag:"preview-token"` ThumbLibrary string `yaml:"ThumbLibrary" json:"ThumbLibrary" flag:"thumb-library"` ThumbColor string `yaml:"ThumbColor" json:"ThumbColor" flag:"thumb-color"` - ThumbFilter string `yaml:"ThumbFilter" json:"ThumbFilter" flag:"thumb-filter"` ThumbSize int `yaml:"ThumbSize" json:"ThumbSize" flag:"thumb-size"` ThumbSizeUncached int `yaml:"ThumbSizeUncached" json:"ThumbSizeUncached" flag:"thumb-size-uncached"` ThumbUncached bool `yaml:"ThumbUncached" json:"ThumbUncached" flag:"thumb-uncached"` @@ -244,11 +257,9 @@ type Options struct { VisionFilter string `yaml:"VisionFilter" json:"VisionFilter" flag:"vision-filter"` DetectNSFW bool `yaml:"DetectNSFW" json:"DetectNSFW" flag:"detect-nsfw"` FaceEngine string `yaml:"FaceEngine" json:"-" flag:"face-engine"` - FaceEngineRetry bool `yaml:"-" json:"-" flag:"-"` FaceEngineThreads int `yaml:"FaceEngineThreads" json:"-" flag:"face-engine-threads"` FaceSize int `yaml:"-" json:"-" flag:"face-size"` FaceScore float64 `yaml:"-" json:"-" flag:"face-score"` - FaceAngles []float64 `yaml:"-" json:"-" flag:"face-angle"` FaceOverlap int `yaml:"-" json:"-" flag:"face-overlap"` FaceClusterSize int `yaml:"-" json:"-" flag:"face-cluster-size"` FaceClusterScore int `yaml:"-" json:"-" flag:"face-cluster-score"` diff --git a/internal/config/options_test.go b/internal/config/options_test.go index add9f72b3..a804a5014 100644 --- a/internal/config/options_test.go +++ b/internal/config/options_test.go @@ -54,7 +54,7 @@ func TestOptions_LoadDoesNotOverrideEdition(t *testing.T) { assert.Equal(t, "PhotoPrism", c.Name) assert.Equal(t, "PhotoPrism®", c.About) assert.Equal(t, "test", c.Version) - assert.Equal(t, "(c) 2018-2025 PhotoPrism UG. All rights reserved.", c.Copyright) + assert.Equal(t, "(c) 2018-2026 PhotoPrism UG. All rights reserved.", c.Copyright) dir := t.TempDir() fileName := filepath.Join(dir, "options.yml") @@ -74,7 +74,7 @@ func TestOptions_LoadDoesNotOverrideEdition(t *testing.T) { assert.Equal(t, "PhotoPrism", c.Name) assert.Equal(t, "PhotoPrism®", c.About) assert.Equal(t, "test", c.Version) - assert.Equal(t, "(c) 2018-2025 PhotoPrism UG. All rights reserved.", c.Copyright) + assert.Equal(t, "(c) 2018-2026 PhotoPrism UG. All rights reserved.", c.Copyright) assert.Equal(t, 4242, c.HttpPort) } @@ -102,6 +102,35 @@ func TestOptions_MarshalDoesNotIncludeBuildMetadata(t *testing.T) { assert.Equal(t, 4242, values["HttpPort"]) } +// TestOptions_IndexWorkersYamlRoundTrip pins yaml.v2's loose-typing +// behavior for the IndexWorkers field after its type changed from int to +// string. The test asserts that legacy options.yml files using the +// bare-int form (`IndexWorkers: 4`) still load — yaml.v2 coerces scalar +// nodes into the string field — alongside the new "auto" sentinel and +// the explicit quoted-string form. +func TestOptions_IndexWorkersYamlRoundTrip(t *testing.T) { + cases := map[string]struct { + yaml string + want string + }{ + "BareInt": {"IndexWorkers: 4\n", "4"}, + "QuotedInt": {"IndexWorkers: \"4\"\n", "4"}, + "Auto": {"IndexWorkers: auto\n", "auto"}, + "QuotedAuto": {"IndexWorkers: \"auto\"\n", "auto"}, + "Negative": {"IndexWorkers: -1\n", "-1"}, + "Empty": {"IndexWorkers: \"\"\n", ""}, + "Unspecified": {"AdminUser: admin\n", ""}, + } + + for name, tc := range cases { + t.Run(name, func(t *testing.T) { + var o Options + assert.NoError(t, yaml.Unmarshal([]byte(tc.yaml), &o)) + assert.Equal(t, tc.want, o.IndexWorkers) + }) + } +} + func TestOptions_ExpandFilenames(t *testing.T) { p := Options{TempPath: "tmp", ImportPath: "import"} assert.Equal(t, "tmp", p.TempPath) diff --git a/internal/config/pwa/config.go b/internal/config/pwa/config.go index a46f2893f..1f6dadb29 100644 --- a/internal/config/pwa/config.go +++ b/internal/config/pwa/config.go @@ -11,6 +11,7 @@ type Config struct { BaseUri string `json:"baseUri"` FrontendUri string `json:"frontendUri"` StaticUri string `json:"staticUri"` + StaticPath string `json:"staticPath"` SiteUrl string `json:"siteUrl"` CdnUrl string `json:"cdnUrl"` ThemeUri string `json:"themeUri"` diff --git a/internal/config/pwa/icon.go b/internal/config/pwa/icon.go index f550154e5..30c0c981c 100644 --- a/internal/config/pwa/icon.go +++ b/internal/config/pwa/icon.go @@ -15,14 +15,18 @@ type Icons []Icon // Icon represents an app icon. type Icon struct { - Src string `json:"src"` - Sizes string `json:"sizes,omitempty"` - Type string `json:"type,omitempty"` + Src string `json:"src"` + Sizes string `json:"sizes,omitempty"` + Type string `json:"type,omitempty"` + Purpose string `json:"purpose,omitempty"` } // IconSizes represents standard app icon sizes. var IconSizes = []int{16, 32, 76, 114, 128, 144, 152, 160, 167, 180, 192, 196, 256, 400, 512} +// MaskableIconSizes represents the safe-zone-padded icon sizes emitted with purpose "maskable". +var MaskableIconSizes = []int{192, 512} + // NewIcons creates new app icons in the default sizes based on the parameters provided. func NewIcons(c Config) Icons { staticUri := c.StaticUri @@ -73,15 +77,46 @@ func NewIcons(c Config) Icons { }} } - icons := make(Icons, len(IconSizes)) + icons := make(Icons, 0, len(IconSizes)+len(MaskableIconSizes)) - for i, d := range IconSizes { - icons[i] = Icon{ + for _, d := range IconSizes { + icons = append(icons, Icon{ Src: fmt.Sprintf("%s/icons/%s/%d.png", staticUri, appIcon, d), Sizes: fmt.Sprintf("%dx%d", d, d), Type: "image/png", + }) + } + + // Adaptive launcher icons generated from a safe-zone-padded source so Android + // fills the home-screen mask shape instead of letterboxing the default icon. + // Emitted only for sizes whose file exists on disk so the manifest never + // advertises a maskable variant that resolves to a 404, e.g. for custom icon + // sets without pre-rendered maskable images. + for _, d := range MaskableIconSizes { + if !maskableIconExists(c.StaticPath, appIcon, d) { + continue } + + icons = append(icons, Icon{ + Src: fmt.Sprintf("%s/icons/%s/maskable/%d.png", staticUri, appIcon, d), + Sizes: fmt.Sprintf("%dx%d", d, d), + Type: "image/png", + Purpose: "maskable", + }) } return icons } + +// maskableIconExists reports whether a non-empty maskable icon file of the given +// size exists on disk for the specified icon set. It returns false when staticPath +// is unset, since the manifest must not reference variants that cannot be verified. +func maskableIconExists(staticPath, appIcon string, size int) bool { + if staticPath == "" { + return false + } + + fileName := filepath.Join(staticPath, fs.IconsDir, appIcon, "maskable", fmt.Sprintf("%d.png", size)) + + return fs.FileExistsNotEmpty(fileName) +} diff --git a/internal/config/pwa/icon_test.go b/internal/config/pwa/icon_test.go index 522d0fb02..c866a0a1a 100644 --- a/internal/config/pwa/icon_test.go +++ b/internal/config/pwa/icon_test.go @@ -10,27 +10,91 @@ import ( func TestNewIcons(t *testing.T) { t.Run("Standard", func(t *testing.T) { - c := Config{StaticUri: "https://demo-cdn.photoprism.app/static", Icon: "test"} + c := Config{StaticUri: "https://demo-cdn.photoprism.app/static", StaticPath: fs.Abs("./testdata"), Icon: "test"} result := NewIcons(c) assert.NotEmpty(t, result) + assert.Len(t, result, len(IconSizes)+len(MaskableIconSizes)) assert.Equal(t, "https://demo-cdn.photoprism.app/static/icons/test/16.png", result[0].Src) assert.Equal(t, "image/png", result[0].Type) assert.Equal(t, "16x16", result[0].Sizes) + assert.Equal(t, "", result[0].Purpose) + }) + t.Run("Maskable", func(t *testing.T) { + c := Config{StaticUri: "https://demo-cdn.photoprism.app/static", StaticPath: fs.Abs("./testdata"), Icon: "test"} + result := NewIcons(c) + maskable := maskableIcons(result) + assert.Len(t, maskable, len(MaskableIconSizes)) + assert.Equal(t, "https://demo-cdn.photoprism.app/static/icons/test/maskable/192.png", maskable[0].Src) + assert.Equal(t, "192x192", maskable[0].Sizes) + assert.Equal(t, "image/png", maskable[0].Type) + assert.Equal(t, "https://demo-cdn.photoprism.app/static/icons/test/maskable/512.png", maskable[1].Src) + assert.Equal(t, "512x512", maskable[1].Sizes) + }) + t.Run("MaskablePartial", func(t *testing.T) { + c := Config{StaticUri: "https://demo-cdn.photoprism.app/static", StaticPath: fs.Abs("./testdata"), Icon: "partial"} + result := NewIcons(c) + maskable := maskableIcons(result) + assert.Len(t, maskable, 1) + assert.Equal(t, "https://demo-cdn.photoprism.app/static/icons/partial/maskable/192.png", maskable[0].Src) + assert.Len(t, result, len(IconSizes)+1) + }) + t.Run("MaskableMissing", func(t *testing.T) { + c := Config{StaticUri: "https://demo-cdn.photoprism.app/static", StaticPath: fs.Abs("./testdata"), Icon: "nomask"} + result := NewIcons(c) + assert.Empty(t, maskableIcons(result)) + assert.Len(t, result, len(IconSizes)) + }) + t.Run("StaticPathUnset", func(t *testing.T) { + c := Config{StaticUri: "https://demo-cdn.photoprism.app/static", Icon: "test"} + result := NewIcons(c) + assert.Empty(t, maskableIcons(result)) + assert.Len(t, result, len(IconSizes)) }) t.Run("Custom", func(t *testing.T) { c := Config{StaticUri: "https://demo-cdn.photoprism.app/static", Icon: "/test.png"} result := NewIcons(c) assert.NotEmpty(t, result) + assert.Len(t, result, 1) assert.Equal(t, "/test.png", result[0].Src) assert.Equal(t, "image/png", result[0].Type) assert.Equal(t, "", result[0].Sizes) + assert.Equal(t, "", result[0].Purpose) }) t.Run("Theme", func(t *testing.T) { c := Config{StaticUri: "https://demo-cdn.photoprism.app/static", Icon: "/_theme/example.png", ThemePath: fs.Abs("./testdata"), ThemeUri: "/_theme"} result := NewIcons(c) assert.NotEmpty(t, result) + assert.Len(t, result, 1) assert.Equal(t, "/_theme/example.png", result[0].Src) assert.Equal(t, "image/png", result[0].Type) assert.Equal(t, "100x67", result[0].Sizes) + assert.Equal(t, "", result[0].Purpose) }) } + +func TestMaskableIconExists(t *testing.T) { + staticPath := fs.Abs("./testdata") + t.Run("Exists", func(t *testing.T) { + assert.True(t, maskableIconExists(staticPath, "test", 192)) + assert.True(t, maskableIconExists(staticPath, "test", 512)) + }) + t.Run("Missing", func(t *testing.T) { + assert.False(t, maskableIconExists(staticPath, "test", 256)) + assert.False(t, maskableIconExists(staticPath, "partial", 512)) + assert.False(t, maskableIconExists(staticPath, "nomask", 192)) + }) + t.Run("StaticPathUnset", func(t *testing.T) { + assert.False(t, maskableIconExists("", "test", 192)) + }) +} + +// maskableIcons returns the subset of icons emitted with purpose "maskable". +func maskableIcons(icons Icons) Icons { + maskable := make(Icons, 0, len(MaskableIconSizes)) + for _, icon := range icons { + if icon.Purpose == "maskable" { + maskable = append(maskable, icon) + } + } + return maskable +} diff --git a/internal/config/pwa/manifest.go b/internal/config/pwa/manifest.go index 8075aca12..5ee0c5510 100644 --- a/internal/config/pwa/manifest.go +++ b/internal/config/pwa/manifest.go @@ -14,6 +14,8 @@ type Manifest struct { Name string `json:"name"` ShortName string `json:"short_name,omitempty"` Description string `json:"description,omitempty"` + Lang string `json:"lang,omitempty"` + Dir string `json:"dir,omitempty"` Categories list.List `json:"categories"` Developer Url `json:"developer"` DisplayOverride []string `json:"display_override"` @@ -30,6 +32,7 @@ type Manifest struct { OptionalPermissions list.List `json:"optional_permissions"` HostPermissions []string `json:"host_permissions"` Icons Icons `json:"icons"` + Screenshots Screenshots `json:"screenshots,omitempty"` } // NewManifest creates a new progressive web app manifest based on the config provided. @@ -40,6 +43,8 @@ func NewManifest(c Config) (m *Manifest) { Name: c.Name, ShortName: txt.Clip(c.Name, 32), Description: c.Description, + Lang: clean.WebLocale(c.DefaultLocale, "en"), + Dir: clean.TextDir(c.DefaultLocale, "en"), Categories: Categories, Developer: PhotoPrism, DisplayOverride: DisplayOverride, @@ -60,5 +65,6 @@ func NewManifest(c Config) (m *Manifest) { OptionalPermissions: OptionalPermissions, HostPermissions: HostPermissions(c.SiteUrl, c.CdnUrl), Icons: NewIcons(c), + Screenshots: NewScreenshots(c), } } diff --git a/internal/config/pwa/manifest_test.go b/internal/config/pwa/manifest_test.go index a79da134e..bab8f7950 100644 --- a/internal/config/pwa/manifest_test.go +++ b/internal/config/pwa/manifest_test.go @@ -4,18 +4,22 @@ import ( "testing" "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/pkg/fs" ) func TestNewManifest(t *testing.T) { c := Config{ - Icon: "logo", - Color: "#aaaaaa", - Name: "TestPrism+", - Description: "App's Description", - Mode: "fullscreen", - BaseUri: "/", - FrontendUri: "/library", - StaticUri: "/static", + Icon: "test", + Color: "#aaaaaa", + Name: "TestPrism+", + Description: "App's Description", + DefaultLocale: "pt_BR", + Mode: "fullscreen", + BaseUri: "/", + FrontendUri: "/library", + StaticUri: "/static", + StaticPath: fs.Abs("./testdata"), } t.Run("Standard", func(t *testing.T) { @@ -24,13 +28,25 @@ func TestNewManifest(t *testing.T) { assert.Equal(t, c.Name, result.Name) assert.Equal(t, c.Name, result.ShortName) assert.Equal(t, c.Description, result.Description) + assert.Equal(t, "pt-BR", result.Lang) + assert.Equal(t, "ltr", result.Dir) assert.Equal(t, c.BaseUri, result.Scope) assert.Equal(t, StartUrl(c.BaseUri, c.FrontendUri), result.StartUrl) assert.Equal(t, "library/browse", result.Shortcuts[0].Url) - assert.Len(t, result.Icons, len(IconSizes)) + assert.Len(t, result.Icons, len(IconSizes)+len(MaskableIconSizes)) + assert.Len(t, result.Screenshots, 2) + assert.Equal(t, "wide", result.Screenshots[0].FormFactor) + assert.Equal(t, "narrow", result.Screenshots[1].FormFactor) assert.Len(t, result.Categories, len(Categories)) assert.Len(t, result.Permissions, len(Permissions)) }) + t.Run("DefaultLang", func(t *testing.T) { + d := c + d.DefaultLocale = "" + result := NewManifest(d) + assert.Equal(t, "en", result.Lang) + assert.Equal(t, "ltr", result.Dir) + }) t.Run("StartUrlForPathScope", func(t *testing.T) { c.BaseUri = "/instance/pro-1/" c.FrontendUri = "/instance/pro-1/library" diff --git a/internal/config/pwa/pwa.go b/internal/config/pwa/pwa.go index 7913abc29..62f5a5ae3 100644 --- a/internal/config/pwa/pwa.go +++ b/internal/config/pwa/pwa.go @@ -1,7 +1,7 @@ /* Package pwa provides data structures and tools for working with progressive web applications. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/config/pwa/screenshot.go b/internal/config/pwa/screenshot.go new file mode 100644 index 000000000..d97ad2417 --- /dev/null +++ b/internal/config/pwa/screenshot.go @@ -0,0 +1,35 @@ +package pwa + +import "fmt" + +// Screenshots represents a list of app store style install-prompt screenshots. +type Screenshots []Screenshot + +// Screenshot represents a single install-prompt screenshot. +type Screenshot struct { + Src string `json:"src"` + Sizes string `json:"sizes,omitempty"` + Type string `json:"type,omitempty"` + FormFactor string `json:"form_factor,omitempty"` +} + +// NewScreenshots creates the install-prompt screenshots based on the config provided. +// Browsers show a richer, app-store-style install dialog when wide and narrow form factors are present. +func NewScreenshots(c Config) Screenshots { + staticUri := c.StaticUri + + return Screenshots{ + { + Src: fmt.Sprintf("%s/img/screenshots/wide.jpg", staticUri), + Sizes: "1280x900", + Type: "image/jpeg", + FormFactor: "wide", + }, + { + Src: fmt.Sprintf("%s/img/screenshots/narrow.jpg", staticUri), + Sizes: "375x667", + Type: "image/jpeg", + FormFactor: "narrow", + }, + } +} diff --git a/internal/config/pwa/screenshot_test.go b/internal/config/pwa/screenshot_test.go new file mode 100644 index 000000000..8742e444c --- /dev/null +++ b/internal/config/pwa/screenshot_test.go @@ -0,0 +1,22 @@ +package pwa + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestNewScreenshots(t *testing.T) { + t.Run("Standard", func(t *testing.T) { + c := Config{StaticUri: "https://demo-cdn.photoprism.app/static"} + result := NewScreenshots(c) + assert.Len(t, result, 2) + assert.Equal(t, "https://demo-cdn.photoprism.app/static/img/screenshots/wide.jpg", result[0].Src) + assert.Equal(t, "1280x900", result[0].Sizes) + assert.Equal(t, "image/jpeg", result[0].Type) + assert.Equal(t, "wide", result[0].FormFactor) + assert.Equal(t, "https://demo-cdn.photoprism.app/static/img/screenshots/narrow.jpg", result[1].Src) + assert.Equal(t, "375x667", result[1].Sizes) + assert.Equal(t, "narrow", result[1].FormFactor) + }) +} diff --git a/internal/config/pwa/testdata/icons/partial/maskable/192.png b/internal/config/pwa/testdata/icons/partial/maskable/192.png new file mode 100644 index 000000000..d377ae492 Binary files /dev/null and b/internal/config/pwa/testdata/icons/partial/maskable/192.png differ diff --git a/internal/config/pwa/testdata/icons/test/maskable/192.png b/internal/config/pwa/testdata/icons/test/maskable/192.png new file mode 100644 index 000000000..d377ae492 Binary files /dev/null and b/internal/config/pwa/testdata/icons/test/maskable/192.png differ diff --git a/internal/config/pwa/testdata/icons/test/maskable/512.png b/internal/config/pwa/testdata/icons/test/maskable/512.png new file mode 100644 index 000000000..9c625a4af Binary files /dev/null and b/internal/config/pwa/testdata/icons/test/maskable/512.png differ diff --git a/internal/config/pwa/url_test.go b/internal/config/pwa/url_test.go index 072aceefd..a8fd3c62b 100644 --- a/internal/config/pwa/url_test.go +++ b/internal/config/pwa/url_test.go @@ -16,11 +16,11 @@ func TestShortcutUrl(t *testing.T) { func TestStartUrl(t *testing.T) { t.Run("RootScope", func(t *testing.T) { assert.Equal(t, "./library", StartUrl("/", "/library")) - assert.Equal(t, "./portal/admin", StartUrl("/", "/portal/admin")) + assert.Equal(t, "./portal", StartUrl("/", "/portal")) }) t.Run("PathScope", func(t *testing.T) { assert.Equal(t, "./library", StartUrl("/instance/pro-1/", "/instance/pro-1/library")) - assert.Equal(t, "./portal/admin", StartUrl("/foo/", "/foo/portal/admin")) + assert.Equal(t, "./portal", StartUrl("/foo/", "/foo/portal")) }) t.Run("OutOfScopeFallback", func(t *testing.T) { assert.Equal(t, "/library", StartUrl("/instance/pro-1/", "/library")) diff --git a/internal/config/report.go b/internal/config/report.go index 1965ca530..afc96db69 100644 --- a/internal/config/report.go +++ b/internal/config/report.go @@ -2,11 +2,11 @@ package config import ( "fmt" + "sort" "strings" "time" "unicode/utf8" - "github.com/photoprism/photoprism/internal/ai/face" "github.com/photoprism/photoprism/internal/ai/vision" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/dsn" @@ -39,6 +39,10 @@ func (c *Config) Report() (rows [][]string, cols []string) { {"debug", fmt.Sprintf("%t", c.Debug())}, {"trace", fmt.Sprintf("%t", c.Trace())}, + // Storage. + {"storage-path", c.StoragePath()}, + {"storage-free", fmt.Sprintf("%.0f", c.StorageFree())}, + // Config. {"config-path", c.ConfigPath()}, {"certificates-path", c.CertificatesPath()}, @@ -58,12 +62,11 @@ func (c *Config) Report() (rows [][]string, cols []string) { {"originals-path", c.OriginalsPath()}, {"originals-limit", fmt.Sprintf("%d", c.OriginalsLimit())}, {"resolution-limit", fmt.Sprintf("%d", c.ResolutionLimit())}, - {"users-path", c.UsersPath()}, - {"users-originals-path", c.UsersOriginalsPath()}, - // Storage. - {"storage-path", c.StoragePath()}, + // Other Paths. + {"users-path", c.UsersPath()}, {"users-storage-path", c.UsersStoragePath()}, + {"users-originals-path", c.UsersOriginalsPath()}, {"import-path", c.ImportPath()}, {"import-dest", c.ImportDest()}, {"import-allow", c.ImportAllow().String()}, @@ -102,7 +105,7 @@ func (c *Config) Report() (rows [][]string, cols []string) { {"backup-albums-path", c.BackupAlbumsPath()}, // Indexing. - {"index-workers", fmt.Sprintf("%d", c.IndexWorkers())}, + {"index-workers", fmt.Sprintf("%d (%s)", c.IndexWorkers(), c.IndexWorkersReason())}, {"index-schedule", c.IndexSchedule()}, {"wakeup-interval", c.WakeupInterval().String()}, {"auto-index", fmt.Sprintf("%d", c.AutoIndex()/time.Second)}, @@ -117,13 +120,13 @@ func (c *Config) Report() (rows [][]string, cols []string) { {"disable-backups", fmt.Sprintf("%t", c.DisableBackups())}, {"disable-restart", fmt.Sprintf("%t", c.DisableRestart())}, {"disable-webdav", fmt.Sprintf("%t", c.DisableWebDAV())}, + {"disable-mcp", fmt.Sprintf("%t", c.DisableMCP())}, {"disable-places", fmt.Sprintf("%t", c.DisablePlaces())}, {"disable-tensorflow", fmt.Sprintf("%t", c.DisableTensorFlow())}, {"disable-faces", fmt.Sprintf("%t", c.DisableFaces())}, {"disable-classification", fmt.Sprintf("%t", c.DisableClassification())}, {"disable-ffmpeg", fmt.Sprintf("%t", c.DisableFFmpeg())}, {"disable-exiftool", fmt.Sprintf("%t", c.DisableExifTool())}, - {"disable-vips", fmt.Sprintf("%t", c.DisableVips())}, {"disable-sips", fmt.Sprintf("%t", c.DisableSips())}, {"disable-darktable", fmt.Sprintf("%t", c.DisableDarktable())}, {"disable-rawtherapee", fmt.Sprintf("%t", c.DisableRawTherapee())}, @@ -165,6 +168,7 @@ func (c *Config) Report() (rows [][]string, cols []string) { {"site-https", fmt.Sprintf("%t", c.SiteHttps())}, {"site-domain", c.SiteDomain()}, {"site-author", c.SiteAuthor()}, + {"site-name", c.SiteName()}, {"site-title", c.SiteTitle()}, {"site-caption", c.SiteCaption()}, {"site-description", c.SiteDescription()}, @@ -190,7 +194,12 @@ func (c *Config) Report() (rows [][]string, cols []string) { {"cluster-domain", c.ClusterDomain()}, {"cluster-cidr", c.ClusterCIDR()}, {"cluster-uuid", c.ClusterUUID()}, + {"cluster-oidc", fmt.Sprintf("%t", c.ClusterOIDC())}, + {"cluster-allow-groups", strings.Join(c.ClusterAllowGroups(), ", ")}, + {"cluster-allow-group-roles", reportGroupRoles(c.ClusterAllowGroupRoles())}, + {"cluster-groups-full-view", fmt.Sprintf("%t", c.ClusterGroupsFullView())}, {"portal-url", clean.UriRedacted(c.PortalUrl())}, + {"portal-login-url", clean.UriRedacted(c.PortalLoginUrl())}, }...) if c.Portal() { @@ -287,6 +296,7 @@ func (c *Config) Report() (rows [][]string, cols []string) { {"ffmpeg-device", c.FFmpegDevice()}, {"ffmpeg-map-video", c.FFmpegMapVideo()}, {"ffmpeg-map-audio", c.FFmpegMapAudio()}, + {"ffmpeg-exclude", c.FFmpegExclude().String()}, {"exiftool-bin", c.ExifToolBin()}, {"sips-bin", c.SipsBin()}, {"sips-exclude", c.SipsExclude()}, @@ -308,7 +318,6 @@ func (c *Config) Report() (rows [][]string, cols []string) { {"preview-token", c.PreviewToken()}, {"thumb-library", c.ThumbLibrary()}, {"thumb-color", c.ThumbColor()}, - {"thumb-filter", c.ThumbFilter().String()}, {"thumb-size", fmt.Sprintf("%d", c.ThumbSizePrecached())}, {"thumb-size-uncached", fmt.Sprintf("%d", c.ThumbSizeUncached())}, {"thumb-uncached", fmt.Sprintf("%t", c.ThumbUncached())}, @@ -331,27 +340,11 @@ func (c *Config) Report() (rows [][]string, cols []string) { {"face-engine-run", vision.ReportRunType(c.FaceEngineRunType())}, }...) - switch faceEngine { - case face.EngineONNX: - rows = append(rows, [][]string{ - {"face-engine-threads", fmt.Sprintf("%d", c.FaceEngineThreads())}, - {"face-size", fmt.Sprintf("%d", c.FaceSize())}, - {"face-score", fmt.Sprintf("%f", c.FaceScore())}, - }...) - case face.EnginePigo: - rows = append(rows, [][]string{ - {"face-size", fmt.Sprintf("%d", c.FaceSize())}, - {"face-score", fmt.Sprintf("%f", c.FaceScore())}, - {"face-angle", fmt.Sprintf("%v", c.FaceAngles())}, - }...) - default: - rows = append(rows, [][]string{ - {"face-engine-threads", fmt.Sprintf("%d", c.FaceEngineThreads())}, - {"face-size", fmt.Sprintf("%d", c.FaceSize())}, - {"face-score", fmt.Sprintf("%f", c.FaceScore())}, - {"face-angle", fmt.Sprintf("%v", c.FaceAngles())}, - }...) - } + rows = append(rows, [][]string{ + {"face-engine-threads", fmt.Sprintf("%d", c.FaceEngineThreads())}, + {"face-size", fmt.Sprintf("%d", c.FaceSize())}, + {"face-score", fmt.Sprintf("%f", c.FaceScore())}, + }...) rows = append(rows, [][]string{ {"face-overlap", fmt.Sprintf("%d", c.FaceOverlap())}, @@ -381,3 +374,52 @@ func (c *Config) Report() (rows [][]string, cols []string) { return rows, cols } + +// FaceReport returns the face-detection and face-recognition config values as +// a table for reporting. It mirrors the values used by Report() so output stays +// consistent between `photoprism config` and `photoprism faces config`. +func (c *Config) FaceReport() (rows [][]string, cols []string) { + cols = []string{"Name", "Value"} + + rows = [][]string{ + {"disable-faces", fmt.Sprintf("%t", c.DisableFaces())}, + {"vision-yaml", c.VisionYaml()}, + {"face-engine", c.FaceEngine()}, + {"face-engine-run", vision.ReportRunType(c.FaceEngineRunType())}, + {"face-engine-threads", fmt.Sprintf("%d", c.FaceEngineThreads())}, + {"facenet-model-path", c.FacenetModelPath()}, + {"face-size", fmt.Sprintf("%d", c.FaceSize())}, + {"face-score", fmt.Sprintf("%f", c.FaceScore())}, + {"face-overlap", fmt.Sprintf("%d", c.FaceOverlap())}, + {"face-cluster-size", fmt.Sprintf("%d", c.FaceClusterSize())}, + {"face-cluster-score", fmt.Sprintf("%d", c.FaceClusterScore())}, + {"face-cluster-core", fmt.Sprintf("%d", c.FaceClusterCore())}, + {"face-cluster-dist", fmt.Sprintf("%f", c.FaceClusterDist())}, + {"face-cluster-radius", fmt.Sprintf("%f", c.FaceClusterRadius())}, + {"face-collision-dist", fmt.Sprintf("%f", c.FaceCollisionDist())}, + {"face-epsilon-dist", fmt.Sprintf("%f", c.FaceEpsilonDist())}, + {"face-match-dist", fmt.Sprintf("%f", c.FaceMatchDist())}, + {"face-skip-children", fmt.Sprintf("%t", c.FaceSkipChildren())}, + {"face-allow-background", fmt.Sprintf("%t", c.FaceAllowBackground())}, + } + + return rows, cols +} + +// reportGroupRoles renders a group → role mapping as sorted "group=role" pairs +// for the config report. +func reportGroupRoles(roles map[string]string) string { + if len(roles) == 0 { + return "" + } + + pairs := make([]string, 0, len(roles)) + + for group, role := range roles { + pairs = append(pairs, group+"="+role) + } + + sort.Strings(pairs) + + return strings.Join(pairs, ", ") +} diff --git a/internal/config/report_sections.go b/internal/config/report_sections.go index 60824c1c1..4472deea1 100644 --- a/internal/config/report_sections.go +++ b/internal/config/report_sections.go @@ -17,7 +17,7 @@ We recommend that only advanced users change these parameters:` var OptionsReportSections = []ReportSection{ {Start: "PHOTOPRISM_AUTH_MODE", Title: "Authentication"}, {Start: "PHOTOPRISM_LOG_LEVEL", Title: "Logging"}, - {Start: "PHOTOPRISM_CONFIG_PATH", Title: "Storage"}, + {Start: "PHOTOPRISM_STORAGE_PATH", Title: "Storage"}, {Start: "PHOTOPRISM_SIDECAR_PATH", Title: "Sidecar Files"}, {Start: "PHOTOPRISM_USAGE_INFO", Title: "Usage"}, {Start: "PHOTOPRISM_BACKUP_PATH", Title: "Backup"}, @@ -44,7 +44,7 @@ var OptionsReportSections = []ReportSection{ var YamlReportSections = []ReportSection{ {Start: "AuthMode", Title: "Authentication"}, {Start: "LogLevel", Title: "Logging"}, - {Start: "ConfigPath", Title: "Storage"}, + {Start: "StoragePath", Title: "Storage"}, {Start: "SidecarPath", Title: "Sidecar Files"}, {Start: "UsageInfo", Title: "Usage"}, {Start: "BackupPath", Title: "Backup"}, diff --git a/internal/config/report_test.go b/internal/config/report_test.go index 406c390d6..33e9c43f4 100644 --- a/internal/config/report_test.go +++ b/internal/config/report_test.go @@ -6,6 +6,8 @@ import ( "github.com/stretchr/testify/assert" + "github.com/photoprism/photoprism/pkg/dsn" + "github.com/photoprism/photoprism/internal/service/cluster" ) @@ -104,7 +106,7 @@ func TestConfig_ReportDatabaseSection(t *testing.T) { rows, _ := conf.Report() values := collect(rows) - assert.Equal(t, SQLite3, values["database-driver"]) + assert.Equal(t, dsn.DriverSQLite3, values["database-driver"]) assert.Equal(t, conf.DatabaseDSN(), values["database-dsn"]) _, hasName := values["database-name"] assert.False(t, hasName) @@ -113,7 +115,7 @@ func TestConfig_ReportDatabaseSection(t *testing.T) { conf := NewConfig(CliTestContext()) resetDatabaseOptions(conf) - conf.options.DatabaseDriver = MySQL + conf.options.DatabaseDriver = dsn.DriverMySQL conf.options.DatabaseServer = "db.internal:3306" conf.options.DatabaseName = "photoprism" conf.options.DatabaseUser = "app" @@ -122,7 +124,7 @@ func TestConfig_ReportDatabaseSection(t *testing.T) { rows, _ := conf.Report() values := collect(rows) - assert.Equal(t, MySQL, values["database-driver"]) + assert.Equal(t, dsn.DriverMySQL, values["database-driver"]) assert.Equal(t, "photoprism", values["database-name"]) assert.Equal(t, "db.internal:3306", values["database-server"]) assert.Equal(t, "db.internal", values["database-host"]) @@ -136,13 +138,13 @@ func TestConfig_ReportDatabaseSection(t *testing.T) { conf := NewConfig(CliTestContext()) resetDatabaseOptions(conf) - conf.options.DatabaseDriver = MySQL + conf.options.DatabaseDriver = dsn.DriverMySQL conf.options.DatabaseDSN = "user:pass@tcp(db.internal:3306)/photoprism" rows, _ := conf.Report() values := collect(rows) - assert.Equal(t, MySQL, values["database-driver"]) + assert.Equal(t, dsn.DriverMySQL, values["database-driver"]) assert.Equal(t, "user:***@tcp(db.internal:3306)/photoprism?charset=utf8mb4,utf8&collation=utf8mb4_unicode_ci&parseTime=true&timeout=15s", values["database-dsn"]) _, hasName := values["database-name"] assert.False(t, hasName) @@ -271,6 +273,57 @@ func TestConfig_ReportThemeURLVisibility(t *testing.T) { }) } +func TestConfig_FaceReport(t *testing.T) { + m := NewConfig(CliTestContext()) + rows, cols := m.FaceReport() + + assert.Equal(t, []string{"Name", "Value"}, cols) + assert.GreaterOrEqual(t, len(rows), 1) + + values := make(map[string]string, len(rows)) + for _, row := range rows { + if len(row) < 2 { + continue + } + values[row[0]] = row[1] + } + + // Spot-check that the core face-related options are present. + expected := []string{ + "disable-faces", + "vision-yaml", + "face-engine", + "face-engine-run", + "face-engine-threads", + "facenet-model-path", + "face-size", + "face-score", + "face-overlap", + "face-cluster-size", + "face-cluster-score", + "face-cluster-core", + "face-cluster-dist", + "face-cluster-radius", + "face-collision-dist", + "face-epsilon-dist", + "face-match-dist", + "face-skip-children", + "face-allow-background", + } + + for _, name := range expected { + _, ok := values[name] + assert.True(t, ok, "FaceReport missing %q", name) + } + + // Non-face options must not leak into the focused report. + unexpected := []string{"originals-path", "auth-mode", "ffmpeg-bin", "site-url"} + for _, name := range unexpected { + _, ok := values[name] + assert.False(t, ok, "FaceReport unexpectedly includes %q", name) + } +} + func TestConfig_ReportURIRedaction(t *testing.T) { collect := func(rows [][]string) map[string]string { result := make(map[string]string, len(rows)) diff --git a/internal/config/test.go b/internal/config/test.go index dd8d864f3..b1af88330 100644 --- a/internal/config/test.go +++ b/internal/config/test.go @@ -7,6 +7,7 @@ import ( "path/filepath" "regexp" "strconv" + "strings" "sync" "testing" "time" @@ -18,6 +19,7 @@ import ( _ "github.com/jinzhu/gorm/dialects/sqlite" "github.com/photoprism/photoprism/internal/config/customize" + "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/internal/service/hub" "github.com/photoprism/photoprism/internal/thumb" "github.com/photoprism/photoprism/pkg/authn" @@ -25,6 +27,7 @@ import ( "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/log/status" "github.com/photoprism/photoprism/pkg/rnd" "github.com/photoprism/photoprism/pkg/txt/report" ) @@ -119,7 +122,8 @@ func NewTestOptionsForPath(dbName, dataPath string) *Options { // Obtain test database credentials. // - // Example PHOTOPRISM_TEST_DSN for MariaDB / MySQL: + // Example PHOTOPRISM_TEST_DSN for MariaDB / MySQL (the port matches the dev + // MariaDB service, which defaults to 4001 unless MARIADB_PORT overrides it): // - "photoprism:photoprism@tcp(mariadb:4001)/photoprism?parseTime=true" dbName = PkgNameRegexp.ReplaceAllString(dbName, "") testDriver := os.Getenv("PHOTOPRISM_TEST_DRIVER") @@ -152,7 +156,7 @@ func NewTestOptionsForPath(dbName, dataPath string) *Options { opts := &Options{ Name: "PhotoPrism", Version: "0.0.0", - Copyright: "(c) 2018-2025 PhotoPrism UG. All rights reserved.", + Copyright: "(c) 2018-2026 PhotoPrism UG. All rights reserved.", Public: true, Sponsor: true, AuthMode: "", @@ -205,7 +209,7 @@ func NewTestOptionsError() *Options { OriginalsPath: dataPath + "/originals", ImportPath: dataPath + "/import", TempPath: dataPath + "/temp", - DatabaseDriver: SQLite3, + DatabaseDriver: dsn.DriverSQLite3, DatabaseDSN: ".test-error.db", } @@ -225,6 +229,13 @@ func TestConfig() *Config { return testConfig } +// OnceTestConfig attempts to set testConfig if it hasn't already been done. +func OnceTestConfig(c *Config) { + // If this is the 1st call to NewTestConfig, then cache it. + // This is required for /internal/photoprism tests. + testConfigOnce.Do(func() { testConfig = c }) +} + // NewMinimalTestConfig creates a lightweight test Config (no DB, minimal filesystem). // // Not suitable for tests requiring a database or pre-created storage directories. @@ -244,7 +255,7 @@ func NewMinimalTestConfigWithDb(dbName, dataPath string) *Config { cachedDb := false // Try to restore test db from cache. - if len(testDbCache) > 0 && c.DatabaseDriver() == SQLite3 && !fs.FileExists(c.DatabaseDSN()) { + if len(testDbCache) > 0 && c.DatabaseDriver() == dsn.DriverSQLite3 && !fs.FileExists(c.DatabaseDSN()) { if err := os.WriteFile(c.DatabaseDSN(), testDbCache, fs.ModeFile); err != nil { log.Warnf("config: %s (restore test database)", err) } else { @@ -264,7 +275,7 @@ func NewMinimalTestConfigWithDb(dbName, dataPath string) *Config { c.InitTestDb() - if testDbCache == nil && c.DatabaseDriver() == SQLite3 && fs.FileExistsNotEmpty(c.DatabaseDSN()) { + if testDbCache == nil && c.DatabaseDriver() == dsn.DriverSQLite3 && fs.FileExistsNotEmpty(c.DatabaseDSN()) { testDbMutex.Lock() defer testDbMutex.Unlock() @@ -312,38 +323,54 @@ func NewIsolatedTestConfig(dbName, dataPath string, createDirs bool) *Config { } // NewTestConfig initializes test data so required directories exist before tests run. -// See AGENTS.md (Test Data & Fixtures) and specs/dev/backend-testing.md for guidance. +// See AGENTS.md (Test Data & Fixtures) for guidance. +// This now creates an isolated set of folders to ensure that cross package testing does not clash. +// You should use os.RemoveAll(c.StoragePath()) to remove the isolated folder created (assuming c := NewTestConfig("test")). func NewTestConfig(dbName string) *Config { defer log.Debug(capture.Time(time.Now(), "config: new test config created")) testConfigMutex.Lock() defer testConfigMutex.Unlock() + storagePath := os.Getenv("PHOTOPRISM_STORAGE_PATH") + if storagePath == "" { + storagePath = fs.Abs("../../storage") + } + + var tp string + var err error + + if tp, err = os.MkdirTemp(storagePath, "test-photoprism-*"); err != nil { + log.Panicf("config: %s", clean.Error(err)) + } + + tp = filepath.Join(tp, fs.TestdataDir) + c := &Config{ cliCtx: CliTestContext(), - options: NewTestOptions(dbName), + options: NewTestOptionsForPath(dbName, tp), token: rnd.Base36(8), cache: gc.New(time.Second, time.Minute), } s := customize.NewSettings(c.DefaultTheme(), c.DefaultLocale(), c.DefaultTimezone().String()) - if err := fs.MkdirAll(c.ConfigPath()); err != nil { - log.Panicf("config: %s", err.Error()) + if err = fs.MkdirAll(c.ConfigPath()); err != nil { + log.Panicf("config: %s", clean.Error(err)) } // Save settings next to the test config path, reusing any existing // `.yaml`/`.yml` variant so the tests mirror production behavior. - if err := s.Save(fs.ConfigFilePath(c.ConfigPath(), "settings", fs.ExtYml)); err != nil { - log.Panicf("config: %s", err.Error()) + if err = s.Save(fs.ConfigFilePath(c.ConfigPath(), "settings", fs.ExtYml)); err != nil { + log.Panicf("config: %s", clean.Error(err)) } - if err := c.Init(); err != nil { - log.Panicf("config: %s", err.Error()) + if err = c.Init(); err != nil { + log.Panicf("config: %s", clean.Error(err)) } - if err := c.InitializeTestData(); err != nil { - log.Errorf("config: %s", err.Error()) + if err = c.InitializeTestData(); err != nil { + log.Errorf("config: %s", clean.Error(err)) } c.RegisterDb() @@ -373,7 +400,7 @@ func NewTestContext(args []string) *cli.Context { app := cli.NewApp() app.Usage = "PhotoPrism®" app.Version = "test" - app.Copyright = "(c) 2018-2025 PhotoPrism UG. All rights reserved." + app.Copyright = "(c) 2018-2026 PhotoPrism UG. All rights reserved." app.EnableBashCompletion = true app.Flags = Flags.Cli() app.Metadata = Values{ @@ -418,6 +445,7 @@ func CliTestContext() *cli.Context { globalSet.String("darktable-cli", config.DarktableBin, "doc") globalSet.String("darktable-exclude", config.DarktableExclude, "doc") globalSet.String("sips-exclude", config.SipsExclude, "doc") + globalSet.String("ffmpeg-exclude", config.FFmpegExclude, "doc") globalSet.String("wakeup-interval", "1h34m9s", "doc") globalSet.Bool("vision-api", config.VisionApi, "doc") globalSet.Bool("detect-nsfw", config.DetectNSFW, "doc") @@ -454,6 +482,7 @@ func CliTestContext() *cli.Context { LogErr(c.Set("darktable-cli", config.DarktableBin)) LogErr(c.Set("darktable-exclude", "raf, cr3")) LogErr(c.Set("sips-exclude", "avif, avifs, thm")) + LogErr(c.Set("ffmpeg-exclude", "magicyuv")) LogErr(c.Set("wakeup-interval", "1h34m9s")) LogErr(c.Set("vision-api", "true")) LogErr(c.Set("detect-nsfw", "true")) @@ -608,3 +637,29 @@ func (c *Config) AssertTestData(t *testing.T) { reportErr("SidecarPath") } } + +// CleanupTestFolder removes the isolated storage directory created by NewTestConfig. +// +// It only deletes paths matching the isolated layout "test-photoprism-*/testdata" so a +// misconfigured StoragePath can never remove a real storage directory. A failed removal +// is logged as a warning rather than aborting, so a teardown hiccup does not turn a +// passing test run into a hard exit. +func (c *Config) CleanupTestFolder() { + if c.options == nil { + event.SystemWarn([]string{"config", "test", "c.options is nil in CleanupTestFolder"}) + return + } + + td := c.StoragePath() + parent := filepath.Dir(td) + + if filepath.Base(td) == fs.TestdataDir && strings.HasPrefix(filepath.Base(parent), "test-photoprism") { + if err := os.RemoveAll(parent); err != nil { + event.SystemWarn([]string{"config", "test", "cleanup %s", "%s"}, parent, clean.Error(err)) + return + } + event.SystemDebug([]string{"config", "test", "cleanup %s", status.Succeeded}, parent) + } else { + event.SystemWarn([]string{"config", "test", "cleanup %s", "failed"}, td) + } +} diff --git a/internal/config/test_test.go b/internal/config/test_test.go index 867f9f2fb..e9ffb1790 100644 --- a/internal/config/test_test.go +++ b/internal/config/test_test.go @@ -1,12 +1,15 @@ package config import ( + "bytes" "testing" "github.com/jinzhu/gorm" + "github.com/sirupsen/logrus" "github.com/stretchr/testify/assert" "github.com/urfave/cli/v2" + "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/pkg/fs" ) @@ -57,3 +60,47 @@ func TestNewTestErrorConfig(t *testing.T) { assert.IsType(t, &gorm.DB{}, db) } + +// captureSystemLog swaps event.SystemLog for a buffer-backed logger, runs fn, and +// returns what fn wrote to the system log. CleanupTestFolder logs via event.System* +// (not the DB-hooked default logger), so tests must read the system log to see it. +func captureSystemLog(t *testing.T, fn func()) string { + t.Helper() + var buf bytes.Buffer + logger := logrus.New() + logger.SetOutput(&buf) + logger.SetLevel(logrus.DebugLevel) + orig := event.SystemLog + event.SystemLog = logger + t.Cleanup(func() { event.SystemLog = orig }) + fn() + return buf.String() +} + +func TestCleanupTestFolder(t *testing.T) { + t.Run("OptionsNil", func(t *testing.T) { + var c Config + out := captureSystemLog(t, c.CleanupTestFolder) + assert.Contains(t, out, "c.options is nil in CleanupTestFolder") + }) + t.Run("NotExpectedPath", func(t *testing.T) { + c := Config{options: &Options{StoragePath: "/tmp/photoprism/testdata"}} + out := captureSystemLog(t, c.CleanupTestFolder) + assert.Contains(t, out, "cleanup /tmp/photoprism/testdata") + assert.Contains(t, out, "failed") + }) + t.Run("Success", func(t *testing.T) { + c := Config{options: &Options{StoragePath: "/tmp/photoprism/test-photoprism-1394931550/testdata"}} + out := captureSystemLog(t, c.CleanupTestFolder) + assert.Contains(t, out, "cleanup /tmp/photoprism/test-photoprism-1394931550") + assert.Contains(t, out, "succeeded") + }) + t.Run("MarkerNotPrefix", func(t *testing.T) { + // The isolated-folder marker must be the prefix of the parent directory, not merely + // a substring, so a path like ".../my-test-photoprism-x/testdata" is refused. + c := Config{options: &Options{StoragePath: "/tmp/photoprism/my-test-photoprism-x/testdata"}} + out := captureSystemLog(t, c.CleanupTestFolder) + assert.Contains(t, out, "cleanup /tmp/photoprism/my-test-photoprism-x/testdata") + assert.Contains(t, out, "failed") + }) +} diff --git a/internal/config/ttl/ttl.go b/internal/config/ttl/ttl.go index ecd8d0652..7f6372598 100644 --- a/internal/config/ttl/ttl.go +++ b/internal/config/ttl/ttl.go @@ -1,7 +1,7 @@ /* Package ttl provides cache expiration defaults and helper functions. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/entity/README.md b/internal/entity/README.md new file mode 100644 index 000000000..ee54776a7 --- /dev/null +++ b/internal/entity/README.md @@ -0,0 +1,70 @@ +## PhotoPrism — Database Entities + +**Last Updated:** June 1, 2026 + +### Overview + +`internal/entity` holds the GORM models (Photo, File, Album, Label, Face, User, Client, Session, Service, Marker, …), their query and create/update helpers, the test fixtures (`*_fixtures.go`), and the migration helpers under `migrate/`. Models map to the database via GORM v1 (`github.com/jinzhu/gorm`) and are shared by the API, workers, and CLI. + +### Timestamps + +Created and updated timestamps are stored as SQL `DATETIME` **without fractional seconds** (`DATETIME_PRECISION = 0`). To keep in-memory and persisted values in sync, the package sets GORM's timestamp source to second precision in `db.go`: + +```go +gorm.NowFunc = Now // entity.Now() == UTC().Truncate(time.Second) +``` + +Time helpers in `entity_time.go`: + +- `UTC()` — current time in UTC, full sub-second precision. Use for elapsed-time measurements, not for values that get persisted. +- `Now()` — UTC truncated to whole seconds. This is what GORM writes to `created_at` / `updated_at`. +- `TimeStamp()` — pointer to `Now()`, for nullable `*time.Time` columns. +- `Time(s)` — parses an RFC 3339 string to a second-precision UTC time, or `nil`. + +Implications: + +- **Do not rely on sub-second ordering of persisted timestamps.** Two rows created and updated within the same wall-clock second compare **equal**, so `created_at` / `updated_at` cannot disambiguate them. There is no monotonic auto-increment ID on UID-keyed models (e.g. `Client`), so there is no reliable intra-second tiebreaker — give rows distinct times when ordering must be deterministic. +- Because both SQLite and MariaDB now receive second-precision values, timestamp behavior is **identical across drivers**. A timestamp assertion that passes on SQLite will pass on MariaDB. + +When a test needs to prove a write advanced a timestamp, prefer one of: + +- Seed the starting value clearly in the past (e.g. `Now().Add(-time.Hour)`) and assert the new value is greater. This stays meaningful and distinguishes a real bump from a no-op. +- Compare with `Time.Sub()` and assert the difference falls in a sane range, rather than a strict `Before`/`After`. A same-second save legitimately yields a zero delta: + + ```go + elapsed := after.Sub(before) + assert.GreaterOrEqual(t, elapsed, time.Duration(0)) + assert.Less(t, elapsed, time.Minute) + ``` + +### Testing + +Tests default to SQLite. To exercise the models against MariaDB (which is stricter and is the production database for some subsystems such as the cluster registry): + +```bash +mysql < scripts/sql/reset-acceptance.sql +PHOTOPRISM_TEST_DRIVER="mysql" \ +PHOTOPRISM_TEST_DSN="root:photoprism@tcp(mariadb:4001)/acceptance?charset=utf8mb4,utf8&collation=utf8mb4_unicode_ci&parseTime=true" \ +go test ./internal/entity/... -count=1 -tags="slow,develop" +``` + +MariaDB strict mode rejects inserts that SQLite quietly accepts, so a test that only ran on SQLite can fail here: + +- **Primary keys must be set.** An empty PK (`""` UID, zero ID) triggers `Error 1364: Field '<col>' doesn't have a default value`. Use a valid ID/UID, not a placeholder like `"1234"`. +- **Values must fit the column.** Oversized strings give `Error 1406: Data too long`; out-of-range integers give `Error 1264: Out of range value` (e.g. `photo_id` is `INT UNSIGNED`, max 4294967295). +- UID format (see `pkg/rnd/uid.go`): a one-byte prefix + 6 base36 time chars + 9 base36 random, 16 chars total (`p…` photo, `a…` album, `c…` client, `u…` user, `l…` label). Reuse existing fixtures for foreign-key safety; use a throwaway but in-range value only where a real reference would overwrite seeded data (e.g. a synthetic `photo_id` so a Details row does not attach to a real photo). +- Fixtures live in `*_fixtures.go`, but some join rows are created **indirectly** from a parent fixture's embedded slice (e.g. a `photos_labels` row from a `Photo` fixture's `Labels`). Verify a combination is free against the **seeded database**, not just the fixtures file. +- `List`-style global queries (`WHERE … <> ''` with no per-test scope) are not isolated on the shared `acceptance` database: rows from other tests in the same run leak in, so a `len(list) == N` assertion that holds on a per-test SQLite file can fail on MariaDB. + +### Collation & Emoji + +MariaDB's `utf8mb4_unicode_ci` assigns most emoji the **same collation weight**, so an SQL `=`, `<>`, or `LIKE` on a `utf8mb4` column treats distinct emoji as equal (e.g. `test/🪞` matches `test/🎃`). SQLite compares text byte-exact, so this only reproduces on MariaDB. + +- `utf8mb4` columns that collapse: `albums.album_title`, display/name text (`*_name`, `*_title`). +- `VARBINARY` columns that stay byte-exact: `albums.album_slug`, `albums.album_filter`, `albums.album_path`, `photos.photo_path`, and every `*_uid`. A `utf8mb4` column compared against a `VARBINARY` column is byte-exact (the binary operand wins). + +The durable fix for an identity/path column is to make it `VARBINARY` — `album_path` is `VARBINARY(1024)` so it matches `photos.photo_path` and `album_path = ?` lookups are byte-exact at the database. Where a `utf8mb4` column must stay, keep the SQL but re-verify the match byte-exact in Go before accepting it (see `FindFolderAlbum` / `findFolderAlbumByPath`, whose Go re-check is retained as defense-in-depth even now that `album_path` is `VARBINARY`). For self-join SQL where a Go re-check is awkward, `HEX(col) = HEX(col)` compares byte-exact on both MariaDB and SQLite. Legacy folder slugs drop emoji entirely (`slug.Make("ins/🪞") == "ins"`) and long paths truncate to `ClipSlug` runes, so distinct folders can still collide on `album_slug`; folder albums are therefore deduplicated by `album_filter` (the byte-exact serialized path), not by slug (see `query.RemoveDuplicateMoments`). + +### VARBINARY Index Prefix Limit + +InnoDB caps an index key prefix at **767 bytes** on the `COMPACT`/`REDUNDANT` row formats, and only allows up to 3072 bytes on `DYNAMIC`/`COMPRESSED`. On a `VARBINARY` column the prefix is counted in **bytes** (on `utf8mb4` it is counted in characters, i.e. up to 4 bytes each), so converting a long text column to `VARBINARY` can push an existing prefix index over the limit on older or non-`DYNAMIC` installs. Keep prefix indexes on long `VARBINARY` path/filter columns at **≤ 767 bytes**; the project convention is **512** (`albums.album_filter(512)`, `albums.album_path(512)`). A prefix index only narrows candidate rows — the full-column comparison stays exact — so a shorter prefix costs nothing for correctness. diff --git a/internal/entity/album.go b/internal/entity/album.go index de1dde1b5..94973cf3b 100644 --- a/internal/entity/album.go +++ b/internal/entity/album.go @@ -52,7 +52,7 @@ type Album struct { AlbumUID string `gorm:"type:VARBINARY(42);unique_index;" json:"UID" yaml:"UID"` ParentUID string `gorm:"type:VARBINARY(42);default:'';" json:"ParentUID,omitempty" yaml:"ParentUID,omitempty"` AlbumSlug string `gorm:"type:VARBINARY(160);index;" json:"Slug" yaml:"Slug"` - AlbumPath string `gorm:"type:VARCHAR(1024);index;" json:"Path,omitempty" yaml:"Path,omitempty"` + AlbumPath string `gorm:"type:VARBINARY(1024);index;" json:"Path,omitempty" yaml:"Path,omitempty"` AlbumType string `gorm:"type:VARBINARY(8);default:'album';" json:"Type" yaml:"Type,omitempty"` AlbumTitle string `gorm:"type:VARCHAR(160);index;" json:"Title" yaml:"Title"` AlbumLocation string `gorm:"type:VARCHAR(160);" json:"Location" yaml:"Location,omitempty"` @@ -238,7 +238,7 @@ func NewUserAlbum(albumTitle, albumType, sortOrder, userUid string) *Album { // NewFolderAlbum creates a new album representing a filesystem folder. func NewFolderAlbum(albumTitle, albumPath, albumFilter string) *Album { - albumSlug := txt.Slug(albumPath) + albumSlug := txt.SlugUnique(albumPath) if albumTitle == "" || albumSlug == "" || albumPath == "" || albumFilter == "" { return nil @@ -250,7 +250,7 @@ func NewFolderAlbum(albumTitle, albumPath, albumFilter string) *Album { AlbumOrder: DefaultOrderFolder, AlbumType: AlbumFolder, AlbumSlug: txt.Clip(albumSlug, txt.ClipSlug), - AlbumPath: txt.Clip(albumPath, txt.ClipPath), + AlbumPath: ClipPath(albumPath), AlbumFilter: albumFilter, CreatedAt: now, UpdatedAt: now, @@ -401,24 +401,21 @@ func FindAlbumByAttr(slugs, filters []string, albumType string) *Album { // FindFolderAlbum looks up a folder album by its canonical path or slug. func FindFolderAlbum(albumPath string) *Album { albumPath = clean.SlashPath(albumPath) - albumSlug := txt.Slug(albumPath) + albumSlugs := folderAlbumSlugCandidates(albumPath) - if albumSlug == "" { + if len(albumSlugs) == 0 { return nil } - m := Album{} - - // Prefer exact path matches so emoji child folders do not collide with parent + // Prefer an exact path match so emoji child folders do not collide with parent // slugs (e.g. "ins/🍷" and "ins" both normalize to "ins"). - stmt := UnscopedDb().Where("album_type = ? AND album_path = ?", AlbumFolder, albumPath) - - if stmt.First(&m).Error == nil { - return &m + if m := findFolderAlbumByPath(albumPath); m != nil { + return m } // Fallback for legacy rows created before album_path was persisted. - stmt = UnscopedDb().Where("album_type = ? AND album_slug = ?", AlbumFolder, albumSlug). + m := Album{} + stmt := UnscopedDb().Where("album_type = ? AND album_slug IN (?)", AlbumFolder, albumSlugs). Where("(album_path IS NULL OR album_path = '')") if stmt.First(&m).Error == nil { @@ -428,6 +425,32 @@ func FindFolderAlbum(albumPath string) *Album { return nil } +// findFolderAlbumByPath returns the folder album whose path matches byte-exact. +// MariaDB's utf8mb4_unicode_ci collation gives most emoji the same weight, so the +// "album_path = ?" query can also return a sibling folder that differs only by +// emoji; each candidate row is therefore re-checked in Go before it is accepted. +func findFolderAlbumByPath(albumPath string) *Album { + if albumPath == "" { + return nil + } + + var matches Albums + + if err := UnscopedDb(). + Where("album_type = ? AND album_path = ?", AlbumFolder, albumPath). + Find(&matches).Error; err != nil { + return nil + } + + for i := range matches { + if matches[i].AlbumPath == albumPath { + return &matches[i] + } + } + + return nil +} + // AlbumSearch creates a new Album to be used as parameter for FindAlbum. func AlbumSearch(albumUid, albumTitle, albumType string) Album { // Set default type. @@ -816,8 +839,8 @@ func (m *Album) UpdateFolder(albumPath, albumFilter, albumTitle string) error { return fmt.Errorf("album does not exist") } - albumPath = clean.SlashPath(albumPath) - albumSlug := txt.Slug(albumPath) + albumPath = ClipPath(clean.SlashPath(albumPath)) + albumSlug := txt.SlugUnique(albumPath) repairTitle := shouldRepairFolderAlbumTitle(m.AlbumTitle, albumTitle, albumPath, m.AlbumFilter) if albumSlug == "" || albumPath == "" || albumFilter == "" || !m.HasID() { @@ -840,19 +863,51 @@ func (m *Album) UpdateFolder(albumPath, albumFilter, albumTitle string) error { if err := m.Updates(values); err != nil { return err - } else if err = UnscopedDb().Exec("UPDATE albums SET album_path = NULL WHERE album_type = ? AND album_path = ? AND id <> ?", AlbumFolder, albumPath, m.ID).Error; err != nil { + } else if err = clearDuplicateFolderAlbumPaths(albumPath, m.ID); err != nil { return err } return nil } +// clearDuplicateFolderAlbumPaths nulls album_path on other folder albums that share +// the exact same path so a single album owns it. The candidate query is collation- +// fuzzy on MariaDB (see findFolderAlbumByPath), so each row is re-checked byte-exact +// before its path is cleared to avoid wiping an emoji sibling's path. +func clearDuplicateFolderAlbumPaths(albumPath string, keepID uint) error { + if albumPath == "" { + return nil + } + + var matches Albums + + if err := UnscopedDb(). + Where("album_type = ? AND album_path = ? AND id <> ?", AlbumFolder, albumPath, keepID). + Find(&matches).Error; err != nil { + return err + } + + duplicateIDs := make([]uint, 0, len(matches)) + + for i := range matches { + if matches[i].AlbumPath == albumPath { + duplicateIDs = append(duplicateIDs, matches[i].ID) + } + } + + if len(duplicateIDs) == 0 { + return nil + } + + return UnscopedDb().Exec("UPDATE albums SET album_path = NULL WHERE id IN (?)", duplicateIDs).Error +} + // Save updates the record in the database or inserts a new record if it does not already exist. func (m *Album) Save() error { if err := Db().Save(m).Error; err != nil { return err } else { - event.PublishUserEntities("albums", event.EntityUpdated, []*Album{m}, m.CreatedBy) + event.PublishUserEntities("albums", event.EntityUpdated, []string{m.AlbumUID}, m.CreatedBy) return nil } } @@ -864,7 +919,7 @@ func (m *Album) Create() error { } m.PublishCountChange(1) - event.PublishUserEntities("albums", event.EntityCreated, []*Album{m}, m.CreatedBy) + event.PublishUserEntities("albums", event.EntityCreated, []string{m.AlbumUID}, m.CreatedBy) return nil } @@ -957,7 +1012,7 @@ func (m *Album) Restore() error { m.DeletedAt = nil m.PublishCountChange(1) - event.PublishUserEntities("albums", event.EntityCreated, []*Album{m}, m.CreatedBy) + event.PublishUserEntities("albums", event.EntityCreated, []string{m.AlbumUID}, m.CreatedBy) return nil } diff --git a/internal/entity/album_test.go b/internal/entity/album_test.go index 73c972285..1bdcaaa43 100644 --- a/internal/entity/album_test.go +++ b/internal/entity/album_test.go @@ -8,6 +8,8 @@ import ( "github.com/stretchr/testify/assert" + "github.com/photoprism/photoprism/internal/event" + "github.com/photoprism/photoprism/internal/entity/sortby" "github.com/photoprism/photoprism/internal/form" "github.com/photoprism/photoprism/pkg/txt" @@ -493,7 +495,7 @@ func TestFindFolderAlbum(t *testing.T) { legacy := &Album{ AlbumType: AlbumFolder, - AlbumSlug: txt.Slug(parentPath), + AlbumSlug: legacyFolderAlbumSlug(parentPath), AlbumPath: "", AlbumFilter: `path:"` + parentPath + `" public:true`, CreatedAt: Now(), @@ -516,6 +518,243 @@ func TestFindFolderAlbum(t *testing.T) { assert.Equal(t, legacy.ID, album.ID) }) + t.Run("LegacyFallbackForLongAsciiPath", func(t *testing.T) { + unique := txt.Slug(time.Now().UTC().Format(time.RFC3339Nano)) + folderPath := "pictures/Ferie 2008 Mellomeuropa/Galleri-konvertert/bilder/" + unique + "/01 Praha, Dresden, Wroclaw" + + legacy := &Album{ + AlbumType: AlbumFolder, + AlbumSlug: legacyFolderAlbumSlug(folderPath), + AlbumPath: "", + AlbumFilter: `path:"` + folderPath + `" public:true`, + CreatedAt: Now(), + UpdatedAt: Now(), + } + legacy.SetTitle("Legacy Folder") + + if err := legacy.Create(); err != nil { + t.Fatal(err) + } + + t.Cleanup(func() { + _ = legacy.DeletePermanently() + }) + + album := FindFolderAlbum(folderPath) + if album == nil { + t.Fatal("expected legacy album") + } + + assert.Equal(t, legacy.ID, album.ID) + assert.NotEqual(t, txt.SlugUnique(folderPath), legacy.AlbumSlug) + }) + t.Run("LongAsciiSiblingsDoNotCollide", func(t *testing.T) { + unique := txt.Slug(time.Now().UTC().Format(time.RFC3339Nano)) + base := "pictures/Ferie 2008 Mellomeuropa/Galleri-konvertert/bilder/" + unique + "/" + pathA := base + "01 Praha, Dresden, Wroclaw" + pathB := base + "02 Wroclaw, Auschwitz" + filterA := `path:"` + pathA + `" public:true` + filterB := `path:"` + pathB + `" public:true` + + albumA := NewFolderAlbum("01 Praha, Dresden, Wroclaw", pathA, filterA) + if albumA == nil { + t.Fatal("expected albumA") + } + + if err := albumA.Create(); err != nil { + t.Fatal(err) + } + + t.Cleanup(func() { + _ = albumA.DeletePermanently() + }) + + albumB := NewFolderAlbum("02 Wroclaw, Auschwitz", pathB, filterB) + if albumB == nil { + t.Fatal("expected albumB") + } + + if err := albumB.Create(); err != nil { + t.Fatal(err) + } + + t.Cleanup(func() { + _ = albumB.DeletePermanently() + }) + + assert.NotEqual(t, albumA.AlbumSlug, albumB.AlbumSlug) + + foundA := FindFolderAlbum(pathA) + foundB := FindFolderAlbum(pathB) + + if foundA == nil || foundB == nil { + t.Fatalf("expected both folder albums to resolve, got A=%v B=%v", foundA, foundB) + } + + assert.Equal(t, albumA.ID, foundA.ID) + assert.Equal(t, albumB.ID, foundB.ID) + }) +} + +// TestFindFolderAlbumByPath exercises the byte-exact folder album path lookup. +func TestFindFolderAlbumByPath(t *testing.T) { + unique := func() string { return txt.Slug(time.Now().UTC().Format(time.RFC3339Nano)) } + t.Run("EmptyPath", func(t *testing.T) { + assert.Nil(t, findFolderAlbumByPath("")) + }) + t.Run("NotFound", func(t *testing.T) { + assert.Nil(t, findFolderAlbumByPath("missing-"+unique()+"/🪞")) + }) + t.Run("Success", func(t *testing.T) { + albumPath := "byte-exact-" + unique() + "/🪞" + album := NewFolderAlbum("🪞", albumPath, `path:"`+albumPath+`" public:true`) + + if album == nil { + t.Fatal("expected album") + } + + if err := album.Create(); err != nil { + t.Fatal(err) + } + + t.Cleanup(func() { _ = album.DeletePermanently() }) + + found := findFolderAlbumByPath(albumPath) + + if found == nil { + t.Fatal("expected folder album to resolve") + } + + assert.Equal(t, album.ID, found.ID) + assert.Equal(t, albumPath, found.AlbumPath) + }) + t.Run("EmojiSiblingsDoNotCollide", func(t *testing.T) { + // On MariaDB (utf8mb4_unicode_ci) two emoji sibling paths collate equal, + // so the byte-exact re-check must keep them apart; SQLite passes trivially. + base := "emoji-sibling-" + unique() + "/" + pathMirror := base + "🪞" + pathPumpkin := base + "🎃" + + mirror := NewFolderAlbum("🪞", pathMirror, `path:"`+pathMirror+`" public:true`) + pumpkin := NewFolderAlbum("🎃", pathPumpkin, `path:"`+pathPumpkin+`" public:true`) + + if mirror == nil || pumpkin == nil { + t.Fatal("expected both albums") + } + + if err := mirror.Create(); err != nil { + t.Fatal(err) + } + + if err := pumpkin.Create(); err != nil { + t.Fatal(err) + } + + t.Cleanup(func() { + _ = mirror.DeletePermanently() + _ = pumpkin.DeletePermanently() + }) + + foundMirror := findFolderAlbumByPath(pathMirror) + foundPumpkin := findFolderAlbumByPath(pathPumpkin) + + if foundMirror == nil || foundPumpkin == nil { + t.Fatalf("expected both folder albums to resolve, got mirror=%v pumpkin=%v", foundMirror, foundPumpkin) + } + + assert.Equal(t, mirror.ID, foundMirror.ID) + assert.Equal(t, pumpkin.ID, foundPumpkin.ID) + assert.Equal(t, pathMirror, foundMirror.AlbumPath) + assert.Equal(t, pathPumpkin, foundPumpkin.AlbumPath) + }) +} + +// TestClearDuplicateFolderAlbumPaths exercises byte-exact folder album path dedup. +func TestClearDuplicateFolderAlbumPaths(t *testing.T) { + unique := func() string { return txt.Slug(time.Now().UTC().Format(time.RFC3339Nano)) } + t.Run("EmptyPath", func(t *testing.T) { + assert.NoError(t, clearDuplicateFolderAlbumPaths("", 0)) + }) + t.Run("ClearsByteExactDuplicate", func(t *testing.T) { + albumPath := "dup-" + unique() + "/🪞" + filter := `path:"` + albumPath + `" public:true` + + keep := NewFolderAlbum("🪞 keep", albumPath, filter) + + if keep == nil { + t.Fatal("expected album") + } + + if err := keep.Create(); err != nil { + t.Fatal(err) + } + + dupe := &Album{AlbumType: AlbumFolder, AlbumSlug: keep.AlbumSlug + "x", AlbumPath: albumPath, AlbumFilter: filter, CreatedAt: Now(), UpdatedAt: Now()} + dupe.SetTitle("🪞 dupe") + + if err := dupe.Create(); err != nil { + t.Fatal(err) + } + + t.Cleanup(func() { + _ = keep.DeletePermanently() + _ = dupe.DeletePermanently() + }) + + if err := clearDuplicateFolderAlbumPaths(albumPath, keep.ID); err != nil { + t.Fatal(err) + } + + if kept := FindAlbum(Album{AlbumUID: keep.AlbumUID}); kept != nil { + assert.Equal(t, albumPath, kept.AlbumPath) + } + + cleared := FindAlbum(Album{AlbumUID: dupe.AlbumUID}) + + if cleared == nil { + t.Fatal("expected duplicate album to still exist") + } + + assert.Empty(t, cleared.AlbumPath) + }) + t.Run("PreservesEmojiSibling", func(t *testing.T) { + base := "dup-sibling-" + unique() + "/" + pathMirror := base + "🪞" + pathPumpkin := base + "🎃" + + mirror := NewFolderAlbum("🪞", pathMirror, `path:"`+pathMirror+`" public:true`) + pumpkin := NewFolderAlbum("🎃", pathPumpkin, `path:"`+pathPumpkin+`" public:true`) + + if mirror == nil || pumpkin == nil { + t.Fatal("expected both albums") + } + + if err := mirror.Create(); err != nil { + t.Fatal(err) + } + + if err := pumpkin.Create(); err != nil { + t.Fatal(err) + } + + t.Cleanup(func() { + _ = mirror.DeletePermanently() + _ = pumpkin.DeletePermanently() + }) + + // Clearing duplicates of the pumpkin path must not wipe the mirror sibling. + if err := clearDuplicateFolderAlbumPaths(pathPumpkin, pumpkin.ID); err != nil { + t.Fatal(err) + } + + preserved := findFolderAlbumByPath(pathMirror) + + if preserved == nil { + t.Fatal("expected mirror folder album to be preserved") + } + + assert.Equal(t, pathMirror, preserved.AlbumPath) + }) } // TestFindAlbum exercises the related album behavior. @@ -1136,6 +1375,25 @@ func TestAlbum_Save(t *testing.T) { assert.True(t, afterDate.After(initialDate)) }) + t.Run("PublishesUidOnlyUpdatedEvent", func(t *testing.T) { + album := AlbumFixtures.Get("christmas2030") + + sub := event.Subscribe("albums.updated", "user.*.albums.updated") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + if err := album.Save(); err != nil { + t.Fatal(err) + } + + select { + case msg := <-sub.Receiver: + uids, ok := msg.Fields["entities"].([]string) + assert.True(t, ok, "entities payload should be []string, got %T", msg.Fields["entities"]) + assert.Equal(t, []string{album.AlbumUID}, uids) + case <-time.After(2 * time.Second): + t.Fatal("expected one albums.updated event") + } + }) } // TestAlbum_Create exercises the related album behavior. diff --git a/internal/entity/album_yaml.go b/internal/entity/album_yaml.go index c762fcc4c..e7fd033c2 100644 --- a/internal/entity/album_yaml.go +++ b/internal/entity/album_yaml.go @@ -136,5 +136,13 @@ func (m *Album) LoadFromYaml(fileName string) error { return err } - return yaml.Unmarshal(data, m) + if err = yaml.Unmarshal(data, m); err != nil { + return err + } + + // Clip the restored path to the album_path column's byte budget so a backup + // with a long multi-byte path cannot overflow the column on save. + m.AlbumPath = ClipPath(m.AlbumPath) + + return nil } diff --git a/internal/entity/auth_client.go b/internal/entity/auth_client.go index ab13e8f2e..7118b000c 100644 --- a/internal/entity/auth_client.go +++ b/internal/entity/auth_client.go @@ -39,6 +39,8 @@ type Client struct { AppName string `gorm:"size:64;" json:"AppName" yaml:"AppName,omitempty"` AppVersion string `gorm:"size:64;" json:"AppVersion" yaml:"AppVersion,omitempty"` ClientName string `gorm:"size:200;" json:"ClientName" yaml:"ClientName,omitempty"` + DisplayName string `gorm:"size:200;" json:"DisplayName" yaml:"DisplayName,omitempty"` + NameSrc string `gorm:"type:VARBINARY(8);default:'';" json:"NameSrc,omitempty" yaml:"NameSrc,omitempty"` ClientRole string `gorm:"size:64;default:'';" json:"ClientRole" yaml:"ClientRole,omitempty"` ClientType string `gorm:"type:VARBINARY(16)" json:"ClientType" yaml:"ClientType,omitempty"` ClientURL string `gorm:"type:VARBINARY(255);default:'';column:client_url;" json:"ClientURL" yaml:"ClientURL,omitempty"` @@ -193,6 +195,31 @@ func (m *Client) SetName(s string) *Client { return m } +// SetDisplayName sets the human-friendly DisplayName when src has at least the +// priority of the current NameSrc, mirroring User.SetDisplayName. An empty name +// from a manual (admin) source clears the override so the next instance +// registration can repopulate it; an empty name from any other source is ignored. +func (m *Client) SetDisplayName(name, src string) *Client { + name = clean.TypeUnicode(name) + + if SrcPriority[src] < SrcPriority[m.NameSrc] { + return m + } + + if name == "" { + if src == SrcManual { + m.DisplayName = "" + m.NameSrc = SrcAuto + } + return m + } + + m.DisplayName = name + m.NameSrc = src + + return m +} + // SetRole sets the client role specified as string. func (m *Client) SetRole(role string) *Client { r := clean.Role(role) diff --git a/internal/entity/auth_client_data.go b/internal/entity/auth_client_data.go index 96d5fef54..3869a7562 100644 --- a/internal/entity/auth_client_data.go +++ b/internal/entity/auth_client_data.go @@ -22,8 +22,21 @@ type ClientData struct { ClusterUUID string `json:"clusterUUID,omitempty"` ServiceKind string `json:"serviceKind,omitempty"` ServiceFeatures []string `json:"serviceFeatures,omitempty"` + AllowGroups []string `json:"allowGroups,omitempty"` + AllowGroupRoles map[string]string `json:"allowGroupRoles,omitempty"` + GroupsFullView bool `json:"groupsFullView,omitempty"` + GroupsSrc string `json:"groupsSrc,omitempty"` + RedirectURIs []string `json:"redirectUris,omitempty"` } +// Recognized ClientData.GroupsSrc provenance values. An admin-pinned config +// (manual) is never replaced by an instance-declared one (node); an empty +// value marks unmanaged group config. +const ( + ClientGroupsSrcNode = "node" + ClientGroupsSrcManual = "manual" +) + // NewClientData creates a new client data struct and returns a pointer to it. func NewClientData() *ClientData { return &ClientData{} diff --git a/internal/entity/auth_client_test.go b/internal/entity/auth_client_test.go index e668b5c57..f5c297694 100644 --- a/internal/entity/auth_client_test.go +++ b/internal/entity/auth_client_test.go @@ -35,6 +35,42 @@ func TestClient_GetData(t *testing.T) { assert.Equal(t, "portal", second.Theme) } +func TestClient_GetData_OIDCFields(t *testing.T) { + t.Run("RoundTripThroughDataJSON", func(t *testing.T) { + src := NewClient() + src.SetData(&ClientData{ + AllowGroups: []string{"media-acme-admin", "media-acme-viewer"}, + AllowGroupRoles: map[string]string{"media-acme-admin": "admin", "media-acme-viewer": "viewer"}, + RedirectURIs: []string{"https://photos.example.com/api/v1/oidc/redirect"}, + }) + + // Read back from a fresh Client populated only via the marshaled JSON, + // so the test exercises the json.Unmarshal path, not the m.data cache. + dst := &Client{DataJSON: src.DataJSON} + got := dst.GetData() + + assert.Equal(t, []string{"media-acme-admin", "media-acme-viewer"}, got.AllowGroups) + assert.Equal(t, "admin", got.AllowGroupRoles["media-acme-admin"]) + assert.Equal(t, "viewer", got.AllowGroupRoles["media-acme-viewer"]) + assert.Equal(t, []string{"https://photos.example.com/api/v1/oidc/redirect"}, got.RedirectURIs) + }) + + t.Run("OmitEmpty", func(t *testing.T) { + c := NewClient() + c.SetData(&ClientData{Theme: "portal"}) + + // Older rows without the OIDC fields must round-trip cleanly and report zero values. + assert.NotContains(t, string(c.DataJSON), "allowGroups") + assert.NotContains(t, string(c.DataJSON), "allowGroupRoles") + assert.NotContains(t, string(c.DataJSON), "redirectUris") + + got := (&Client{DataJSON: c.DataJSON}).GetData() + assert.Nil(t, got.AllowGroups) + assert.Nil(t, got.AllowGroupRoles) + assert.Nil(t, got.RedirectURIs) + }) +} + func TestFindClient(t *testing.T) { t.Run("Alice", func(t *testing.T) { expected := ClientFixtures.Get("alice") @@ -113,6 +149,43 @@ func TestClient_SetRole(t *testing.T) { assert.True(t, c.HasRole("admin")) } +func TestClient_SetDisplayName(t *testing.T) { + t.Run("InstanceReportSets", func(t *testing.T) { + c := Client{} + c.SetDisplayName("Reported", SrcAuto) + assert.Equal(t, "Reported", c.DisplayName) + assert.Equal(t, SrcAuto, c.NameSrc) + }) + t.Run("InstanceUpdatesOwnValue", func(t *testing.T) { + c := Client{DisplayName: "Old", NameSrc: SrcAuto} + c.SetDisplayName("New", SrcAuto) + assert.Equal(t, "New", c.DisplayName) + }) + t.Run("ManualPinsOverAuto", func(t *testing.T) { + c := Client{DisplayName: "Reported", NameSrc: SrcAuto} + c.SetDisplayName("Pinned", SrcManual) + assert.Equal(t, "Pinned", c.DisplayName) + assert.Equal(t, SrcManual, c.NameSrc) + }) + t.Run("AutoCannotOverrideManual", func(t *testing.T) { + c := Client{DisplayName: "Pinned", NameSrc: SrcManual} + c.SetDisplayName("Reported", SrcAuto) + assert.Equal(t, "Pinned", c.DisplayName) + assert.Equal(t, SrcManual, c.NameSrc) + }) + t.Run("ManualClearUnpins", func(t *testing.T) { + c := Client{DisplayName: "Pinned", NameSrc: SrcManual} + c.SetDisplayName("", SrcManual) + assert.Equal(t, "", c.DisplayName) + assert.Equal(t, SrcAuto, c.NameSrc) + }) + t.Run("AutoEmptyIgnored", func(t *testing.T) { + c := Client{DisplayName: "Reported", NameSrc: SrcAuto} + c.SetDisplayName("", SrcAuto) + assert.Equal(t, "Reported", c.DisplayName) + }) +} + func TestClient_User(t *testing.T) { t.Run("Alice", func(t *testing.T) { alice := ClientFixtures.Get("alice") diff --git a/internal/entity/auth_session.go b/internal/entity/auth_session.go index 5e4b155e2..2af537d69 100644 --- a/internal/entity/auth_session.go +++ b/internal/entity/auth_session.go @@ -62,11 +62,11 @@ type Session struct { RefreshToken string `gorm:"type:VARBINARY(2048);column:refresh_token;default:'';" json:"-" yaml:"-"` IdToken string `gorm:"type:VARBINARY(2048);column:id_token;default:'';" json:"IdToken,omitempty" yaml:"IdToken,omitempty"` UserAgent string `gorm:"size:512;" json:"UserAgent" yaml:"UserAgent,omitempty"` - DataJSON json.RawMessage `gorm:"type:VARBINARY(4096);" json:"-" yaml:"Data,omitempty"` + DataJSON json.RawMessage `gorm:"type:VARBINARY(16384);" json:"-" yaml:"Data,omitempty"` data *SessionData `gorm:"-" yaml:"-"` RefID string `gorm:"type:VARBINARY(16);default:'';" json:"ID" yaml:"-"` LoginIP string `gorm:"size:64;column:login_ip" json:"LoginIP" yaml:"-"` - LoginAt time.Time `json:"LoginAt" yaml:"-"` + LoginAt *time.Time `json:"LoginAt" yaml:"-"` CreatedAt time.Time `json:"CreatedAt" yaml:"CreatedAt"` UpdatedAt time.Time `json:"UpdatedAt" yaml:"UpdatedAt"` Status int `gorm:"-" json:"Status" yaml:"-"` @@ -390,6 +390,14 @@ func (m *Session) IsClient() bool { return authn.Provider(m.AuthProvider).IsClient() } +// IsApplication checks whether this session has been authenticated using an app password. +// The application provider is set only for user-bound app passwords, regardless of the grant +// type that minted them (password for local users, session for OIDC-only users, cli for the +// "auth add" command), so the provider alone identifies an app password. +func (m *Session) IsApplication() bool { + return authn.Provider(m.AuthProvider).IsApplication() +} + // clientRole resolves the client role for this session. When resolve is true it // may perform a one-time lookup via FindClientByUID; callers that already // depend on GetClientRole must pass resolve=false to avoid the recursive loop @@ -1045,7 +1053,7 @@ func (m *Session) SetClientIP(ip string) { if m.LoginIP == "" { m.LoginIP = ip - m.LoginAt = Now() + m.LoginAt = TimeStamp() } return diff --git a/internal/entity/auth_session_client_test.go b/internal/entity/auth_session_client_test.go index 5190755a3..504bd5156 100644 --- a/internal/entity/auth_session_client_test.go +++ b/internal/entity/auth_session_client_test.go @@ -95,4 +95,47 @@ func TestAddClientSession(t *testing.T) { t.Logf("sess: %#v", sess) }) + t.Run("NoClientIPPersistsNullLoginAt", func(t *testing.T) { + // Sessions created without a client IP (e.g. via "photoprism auth add") + // must persist login_at as SQL NULL, not a zero "0000-00-00" datetime + // that strict MySQL/MariaDB sql_modes reject with Error 1292. + // A value-typed LoginAt leaves Go's zero time.Time, which go-sql-driver/mysql serializes as the literal 0000-00-00. + sess, err := AddClientSession("", unix.Day, "metrics", authn.GrantCLI, nil) + + assert.NoError(t, err) + + if sess == nil { + t.Fatal("session must not be nil") + } + + assert.Nil(t, sess.LoginAt) + + var nullCount int + if err = UnscopedDb().Table("auth_sessions"). + Where("id = ? AND login_at IS NULL", sess.ID). + Count(&nullCount).Error; err != nil { + t.Fatal(err) + } + + assert.Equal(t, 1, nullCount, "login_at must be NULL when no client IP was set") + }) + t.Run("ClientIPSetsLoginAt", func(t *testing.T) { + sess := NewClientSession("", unix.Day, "metrics", authn.GrantClientCredentials, nil) + sess.SetClientIP("203.0.113.7") + + assert.NoError(t, sess.Create()) + + if sess.LoginAt == nil { + t.Fatal("login_at must be set when a client IP is present") + } + + var nullCount int + if err := UnscopedDb().Table("auth_sessions"). + Where("id = ? AND login_at IS NULL", sess.ID). + Count(&nullCount).Error; err != nil { + t.Fatal(err) + } + + assert.Equal(t, 0, nullCount, "login_at must not be NULL when a client IP was set") + }) } diff --git a/internal/entity/auth_session_data.go b/internal/entity/auth_session_data.go index f1ce521ed..68b0f6ed5 100644 --- a/internal/entity/auth_session_data.go +++ b/internal/entity/auth_session_data.go @@ -20,10 +20,18 @@ func (u UIDs) Join(s string) string { // SessionData represents User Session data. type SessionData struct { - Tokens []string `json:"tokens"` // Share Tokens. - Shares UIDs `json:"shares"` // Share UIDs. + Tokens []string `json:"tokens"` // Share Tokens. + Shares UIDs `json:"shares"` // Share UIDs. + Groups []string `json:"groups,omitempty"` // Normalized login-time group identifiers (OIDC/LDAP). } +// SessionGroupsByteLimit caps the serialized size of SessionData.Groups so the +// session data always fits its 16384-byte database column with room to spare +// for share tokens redeemed later in the session's lifetime. The budget holds +// roughly 300 GUID-sized identifiers — beyond Entra's 200-group overage +// threshold, where the IdP stops emitting groups in tokens altogether. +const SessionGroupsByteLimit = 12288 + // NewSessionData creates a new session data struct and returns a pointer to it. func NewSessionData() *SessionData { return &SessionData{} @@ -71,6 +79,44 @@ func (data *SessionData) RedeemToken(token string) (n int) { return n } +// SetGroups stores the user's normalized login-time group identifiers, +// dropping trailing entries once their serialized size would exceed +// SessionGroupsByteLimit so the session data cannot outgrow its column. +func (data *SessionData) SetGroups(groups []string) *SessionData { + size := 0 + + for i, g := range groups { + // Each entry serializes as a quoted string plus a separator. + if size += len(g) + 3; size > SessionGroupsByteLimit { + log.Warnf("auth: session group set truncated to %d of %d entries", i, len(groups)) + groups = groups[:i] + break + } + } + + if len(groups) == 0 { + data.Groups = nil + } else { + data.Groups = groups + } + + return data +} + +// Redacted returns a copy of the session data without server-side fields (the +// login-time group set), so API session responses never disclose the user's +// upstream group memberships to clients. +func (data *SessionData) Redacted() *SessionData { + if data == nil { + return nil + } + + redacted := *data + redacted.Groups = nil + + return &redacted +} + // NoShares checks if the session has no shares yet. func (data SessionData) NoShares() bool { return len(data.Shares) == 0 diff --git a/internal/entity/auth_session_data_test.go b/internal/entity/auth_session_data_test.go index feb74844c..eba546d8a 100644 --- a/internal/entity/auth_session_data_test.go +++ b/internal/entity/auth_session_data_test.go @@ -1,6 +1,8 @@ package entity import ( + "encoding/json" + "strings" "testing" "github.com/stretchr/testify/assert" @@ -33,6 +35,63 @@ func TestSessionData_RedeemToken(t *testing.T) { assert.True(t, data.HasShare("as6sg6bxpogaaba8")) } +func TestSessionData_SetGroups(t *testing.T) { + t.Run("Success", func(t *testing.T) { + data := NewSessionData() + data.SetGroups([]string{"media-acme-admin", "media-acme-viewer"}) + assert.Equal(t, []string{"media-acme-admin", "media-acme-viewer"}, data.Groups) + }) + t.Run("Empty", func(t *testing.T) { + data := NewSessionData() + data.SetGroups([]string{"media-acme-admin"}) + data.SetGroups(nil) + assert.Nil(t, data.Groups) + }) + t.Run("HoldsEntraOverageBound", func(t *testing.T) { + // Entra emits at most 200 groups in a token before signaling overage; + // a set of that size must be stored without truncation. + groups := make([]string, 0, 200) + for i := 0; i < 200; i++ { + groups = append(groups, "12345678-1234-1234-1234-12345678901"+string(rune('a'+i%26))) + } + data := NewSessionData() + data.SetGroups(groups) + assert.Len(t, data.Groups, 200) + }) + t.Run("TruncatesOversizedSet", func(t *testing.T) { + groups := make([]string, 0, 500) + for i := 0; i < 500; i++ { + groups = append(groups, strings.Repeat("a", 30)+string(rune('a'+i%26))) + } + data := NewSessionData() + data.SetGroups(groups) + assert.NotEmpty(t, data.Groups) + assert.Less(t, len(data.Groups), len(groups)) + j, err := json.Marshal(data) + assert.NoError(t, err) + assert.LessOrEqual(t, len(j), 16384, "serialized session data must fit the database column") + }) +} + +func TestSessionData_Redacted(t *testing.T) { + t.Run("StripsGroups", func(t *testing.T) { + data := &SessionData{ + Tokens: []string{"1jxf3jfn2k"}, + Shares: UIDs{"as6sg6bxpogaaba8"}, + Groups: []string{"media-acme-admin"}, + } + redacted := data.Redacted() + assert.Nil(t, redacted.Groups) + assert.Equal(t, data.Tokens, redacted.Tokens) + assert.Equal(t, data.Shares, redacted.Shares) + assert.Equal(t, []string{"media-acme-admin"}, data.Groups, "the original must stay intact") + }) + t.Run("Nil", func(t *testing.T) { + var data *SessionData + assert.Nil(t, data.Redacted()) + }) +} + func TestSessionData_SharedUIDs(t *testing.T) { data := SessionData{Shares: []string{"abc123", "def444"}, Tokens: []string{"5jxf3jfn2k"}} diff --git a/internal/entity/auth_session_fixtures.go b/internal/entity/auth_session_fixtures.go index fc4cc64ee..fbf434277 100644 --- a/internal/entity/auth_session_fixtures.go +++ b/internal/entity/auth_session_fixtures.go @@ -86,6 +86,22 @@ var SessionFixtures = SessionMap{ UserUID: UserFixtures.Pointer("alice").UserUID, UserName: UserFixtures.Pointer("alice").UserName, }, + "alice_app_password": { + authToken: "5f1c8a3e9d2b4c6a8e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b", + ID: rnd.SessionID("5f1c8a3e9d2b4c6a8e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b"), + RefID: "sessapppwa01", + SessTimeout: -1, + SessExpires: unix.Now() + unix.Day, + AuthScope: clean.Scope("webdav"), + AuthProvider: authn.ProviderApplication.String(), + AuthMethod: authn.MethodDefault.String(), + GrantType: authn.GrantSession.String(), + ClientName: "alice_app_password", + LastActive: -1, + user: UserFixtures.Pointer("alice"), + UserUID: UserFixtures.Pointer("alice").UserUID, + UserName: UserFixtures.Pointer("alice").UserName, + }, "alice_token_scope": { authToken: "778f0f7d80579a072836c65b786145d6e0127505194cc51e", ID: rnd.SessionID("778f0f7d80579a072836c65b786145d6e0127505194cc51e"), @@ -113,7 +129,7 @@ var SessionFixtures = SessionMap{ user: UserFixtures.Pointer("bob"), UserUID: UserFixtures.Pointer("bob").UserUID, UserName: UserFixtures.Pointer("bob").UserName, - LoginAt: Now().Add(-24), + LoginAt: TimePointer(Now().Add(-24)), CreatedAt: Now().Add(-24), UpdatedAt: Now().Add(-24), }, @@ -168,7 +184,7 @@ var SessionFixtures = SessionMap{ user: UserFixtures.Pointer("friend"), UserUID: UserFixtures.Pointer("friend").UserUID, UserName: UserFixtures.Pointer("friend").UserName, - LoginAt: Now().Add(-12), + LoginAt: TimePointer(Now().Add(-12)), CreatedAt: Now().Add(-20), UpdatedAt: Now().Add(-12), }, diff --git a/internal/entity/auth_session_test.go b/internal/entity/auth_session_test.go index af87afbe0..d620dc746 100644 --- a/internal/entity/auth_session_test.go +++ b/internal/entity/auth_session_test.go @@ -934,6 +934,34 @@ func TestSession_IsSuperAdmin(t *testing.T) { } +func TestSession_IsApplication(t *testing.T) { + user := FindUserByName("alice") + assert.NotNil(t, user) + + // Every user-bound client session is an app password, regardless of the grant + // type used to mint it (password for local users, session for OIDC-only users, + // cli for the "auth add" command). A client session without a user is a plain + // access token, not an app password. + cases := []struct { + name string + grant authn.GrantType + user *User + want bool + }{ + {"PasswordGrant", authn.GrantPassword, user, true}, + {"SessionGrant", authn.GrantSession, user, true}, + {"CliGrant", authn.GrantCLI, user, true}, + {"ClientCredentialsNoUser", authn.GrantClientCredentials, nil, false}, + } + + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + s := NewClientSession("test-app-"+tc.name, 3600, "*", tc.grant, tc.user) + assert.Equal(t, tc.want, s.IsApplication()) + }) + } +} + func TestSession_NotRegistered(t *testing.T) { alice := FindSessionByRefID("sessxkkcabcd") alice.RefreshUser() diff --git a/internal/entity/auth_user.go b/internal/entity/auth_user.go index 033068822..fc3b91fde 100644 --- a/internal/entity/auth_user.go +++ b/internal/entity/auth_user.go @@ -200,6 +200,28 @@ func FindUserByName(userName string) *User { return FindUser(User{UserName: userName}) } +// UserEmailAvailable reports whether email is unused or only held by the account +// with exceptUID. The email field is informational — not verified, and not unique +// as an identity — so external (OIDC/LDAP) provisioning skips a colliding email +// instead of letting Validate reject the account and block the login. +func UserEmailAvailable(email, exceptUID string) bool { + if email = clean.Email(email); email == "" { + return false + } + + found := FindUser(User{UserEmail: email}) + + return found == nil || found.UserUID == exceptUID +} + +// EmailVerified reports whether the account's email address has been verified, +// i.e. VerifiedAt is set to a non-zero time. PhotoPrism does not verify emails, +// so this is false for operator-managed accounts and true only when an upstream +// IdP asserted it. +func (m *User) EmailVerified() bool { + return clean.TimeSet(m.VerifiedAt) +} + // FindLocalUser returns the matching local user or nil if it was not found. func FindLocalUser(userName string) *User { name := clean.Username(userName) @@ -250,6 +272,15 @@ func (m *User) InvalidUID() bool { return !m.HasUID() } +// IsSystemOrInvalid checks whether the user is a system user or has an invalid ID. +func (m *User) IsSystemOrInvalid() bool { + if m == nil { + return true + } + + return m.ID <= 0 || m.InvalidUID() +} + // SameUID checks if the given uid matches the own uid. func (m *User) SameUID(uid string) bool { if m == nil { @@ -261,14 +292,17 @@ func (m *User) SameUID(uid string) bool { return m.UserUID == uid } -// InitAccount sets the name and password of the initial admin account. +// InitAccount sets the name and password of the initial super admin account. func (m *User) InitAccount(initName, initPasswd, scope string) (updated bool) { // User must exist and the password must not be empty. initPasswd = strings.TrimSpace(initPasswd) - if rnd.InvalidUID(m.UserUID, UserUID) || initPasswd == "" { + if m.InvalidUID() || initPasswd == "" { + return false + } else if m.IsDeleted() || m.HasProvider(authn.ProviderNone) { + event.SystemDebug([]string{"config", "init", "admin account", status.Disabled}) return false } else if !m.CanLogIn() { - log.Warnf("users: %s account is not allowed to log in", m.String()) + event.SystemWarn([]string{"config", "init", "admin account", status.Disabled}) } // Abort if user has a password. @@ -330,7 +364,7 @@ func (m *User) Save() (err error) { // Delete marks the entity as deleted. func (m *User) Delete() (err error) { - if m.ID <= 1 { + if m.IsSystemOrInvalid() { return fmt.Errorf("cannot delete system user") } else if m.UserUID == "" { return fmt.Errorf("uid is required to delete user") @@ -349,7 +383,9 @@ func (m *User) Delete() (err error) { // IsDeleted checks if the user account has been deleted. func (m *User) IsDeleted() bool { - if m.DeletedAt == nil { + if m == nil { + return true + } else if m.DeletedAt == nil { return false } @@ -433,6 +469,15 @@ func (m *User) UpdateLoginTime() *time.Time { return nil } + // Align a super admin's stored role with the running edition on login so a + // leftover out-of-edition role (e.g. a Portal cluster_admin on a Plus + // instance) does not surface in the admin UI. No-op for regular accounts. + if m.NormalizeAdminRole() { + if err := Db().Model(m).UpdateColumn("UserRole", m.UserRole).Error; err == nil { + event.AuditInfo([]string{"users", "%s", "role normalized to %s", status.Succeeded}, clean.Log(m.UserName), m.UserRole) + } + } + timeStamp := TimeStamp() if err := Db().Model(m).UpdateColumn("LoginAt", timeStamp).Error; err != nil { @@ -444,13 +489,13 @@ func (m *User) UpdateLoginTime() *time.Time { return timeStamp } -// CanLogIn checks if the user is allowed to log in and use the web UI. +// CanLogIn checks if the user is allowed to log in and use the Web UI/API. func (m *User) CanLogIn() bool { if m == nil { return false - } else if m.IsDeleted() || m.HasProvider(authn.ProviderNone) { + } else if m.IsSystemOrInvalid() || m.IsDeleted() || m.HasProvider(authn.ProviderNone) { return false - } else if !m.CanLogin && !m.SuperAdmin || m.ID <= 0 || m.UserName == "" { + } else if !m.CanLogin && !m.SuperAdmin || m.UserName == "" { return false } else if m.IsDisabled() || m.IsUnknown() || !m.IsRegistered() { return false @@ -459,12 +504,17 @@ func (m *User) CanLogIn() bool { } } +// DenyLogIn checks if the user should be denied access to the web UI/API +func (m *User) DenyLogIn() bool { + return !m.CanLogIn() +} + // CanUseWebDAV checks whether the user is allowed to use WebDAV to synchronize files. func (m *User) CanUseWebDAV() bool { if m == nil { // Abort check if user is nil for any reason. return false - } else if !m.WebDAV || m.ID <= 0 || m.IsDisabled() || m.IsUnknown() || !m.IsRegistered() || m.HasProvider(authn.ProviderNone) { + } else if !m.WebDAV || m.IsSystemOrInvalid() || m.IsDisabled() || m.IsUnknown() || !m.IsRegistered() || m.HasProvider(authn.ProviderNone) { // Deny WebDAV access if WebDAV is disabled, the user does not have a // regular, registered account, or the account has been deactivated. return false @@ -777,6 +827,12 @@ func (m *User) AclRole() acl.Role { switch { case m.SuperAdmin: + // SuperAdmins map to the strongest operator role available. On Portal + // builds that is cluster_admin (registered in acl.UserRoles); CE/Pro + // leave it unregistered, so super admins resolve to RoleAdmin there. + if r, ok := acl.UserRoles[acl.RoleClusterAdmin.String()]; ok { + return r + } return acl.RoleAdmin case role == "": return acl.RoleNone @@ -787,6 +843,38 @@ func (m *User) AclRole() acl.Role { } } +// NormalizeAdminRole aligns a super admin's stored role with the running +// edition. A SuperAdmin's effective role is fixed by the edition — cluster_admin +// when the edition registers it (the Portal), otherwise admin — which is exactly +// what AclRole resolves at runtime. Persisting that target means a stored role +// which differs from it (most often a leftover Portal cluster_admin on a Plus/Pro +// instance, but also any non-admin-tier role) is rewritten so the stored and +// effective roles agree and the value no longer surfaces as a disabled, +// out-of-edition role in the admin UI. The target is derived from the edition's +// registered roles, not from entity.Admin, because CreateDefaultUsers overwrites +// Admin with the stored seed-admin row at bootstrap. It only ever touches super +// admins, so it cannot grant or revoke privileges for a regular account. Returns +// true if the role was changed; the caller persists the result. +func (m *User) NormalizeAdminRole() bool { + if m == nil || !m.SuperAdmin { + return false + } + + // The edition's super-admin role (mirrors AclRole's SuperAdmin branch). + target := acl.RoleAdmin.String() + if _, ok := acl.UserRoles[acl.RoleClusterAdmin.String()]; ok { + target = acl.RoleClusterAdmin.String() + } + + if clean.Role(m.UserRole) == target { + return false + } + + m.SetRole(target) + + return true +} + // Settings returns the user settings and initializes them if necessary. func (m *User) Settings() *UserSettings { if m.UserSettings != nil { @@ -878,13 +966,23 @@ func (m *User) Equal(u *User) bool { return m.UserUID == u.UserUID } -// IsAdmin checks if the user is an admin with username. +// IsAdmin checks if the user is an admin with username. The Portal-only +// cluster_admin operator role counts as an admin so account-management logic +// (e.g. SaveForm role changes) treats it like a regular admin. func (m *User) IsAdmin() bool { if m == nil { return false } - return m.IsSuperAdmin() || m.IsRegistered() && m.AclRole() == acl.RoleAdmin + if !m.IsSuperAdmin() && !m.IsRegistered() { + return false + } + + if m.IsSuperAdmin() { + return true + } + + return acl.IsAdminRole(m.AclRole()) } // IsSuperAdmin checks if the user is a super admin. @@ -919,26 +1017,39 @@ func (m *User) IsUnknown() bool { return m.InvalidUID() || m.ID == UnknownUser.ID || m.UserUID == UnknownUser.UserUID || m.HasRole(acl.RoleNone) } -// DeleteSessions deletes all active user sessions except those passed as argument. -func (m *User) DeleteSessions(omit []string) (deleted int) { +// RevokeDerivedSessions deletes user login sessions, including those created using app passwords. +func (m *User) RevokeDerivedSessions(omit []string) (deleted int) { + return m.RevokeSessions(omit, authn.RevokeDerivedSessions) +} + +// RevokeSessions deletes all user sessions depending on the scope, except for the ones specified to omit. +func (m *User) RevokeSessions(omit []string, scope authn.SessionScope) (deleted int) { if m.UserUID == "" { return 0 } - // Compose update statement. - stmt := Db() + // Limit deletion to the user's own sessions, excluding the ids passed as argument. + stmt := Db().Where("user_uid = ?", m.UserUID) - // Find all user sessions except the session ids passed as argument. - if len(omit) == 0 { - stmt = stmt.Where("user_uid = ?", m.UserUID) - } else { - stmt = stmt.Where("user_uid = ? AND id NOT IN (?)", m.UserUID, omit) + if len(omit) > 0 { + stmt = stmt.Where("id NOT IN (?)", omit) } - // Exclude client access tokens. - stmt = stmt.Where("auth_provider NOT IN (?)", authn.ClientProviders) + // Restrict the session types removed based on the revocation scope. + switch scope { + case authn.RevokeLoginSessions: + // Keep app passwords, client access tokens, and sessions derived from app passwords. + stmt = stmt.Where("auth_provider NOT IN (?)", authn.ClientProviders) + case authn.RevokeDerivedSessions: + // Keep app passwords and client access tokens, but delete regular + // login sessions and those derived from app passwords. + stmt = stmt.Where("auth_provider NOT IN (?) OR auth_method = ?", + authn.ClientProviders, authn.MethodSession.String()) + case authn.RevokeAllSessions: + // Remove all sessions, including app passwords, client access tokens, and derived sessions. + } - // Fetch sessions from database. + // Fetch matching sessions from the database. sess := Sessions{} if err := stmt.Find(&sess).Error; err != nil { @@ -1282,12 +1393,12 @@ func (m *User) RedeemToken(token string) (n int) { share.Comment = link.Comment if err := share.Save(); err != nil { - event.AuditErr([]string{"user %s", "token %s", "failed to redeem shares", status.Error(err)}, m.RefID, clean.Log(token)) + event.AuditErr([]string{"user %s", "share token redeem failed", status.Error(err)}, m.RefID) } else { link.Redeem() } } else if err := found.UpdateLink(link); err != nil { - event.AuditErr([]string{"user %s", "token %s", "failed to update shares", status.Error(err)}, m.RefID, clean.Log(token)) + event.AuditErr([]string{"user %s", "share token update failed", status.Error(err)}, m.RefID) } } @@ -1325,10 +1436,16 @@ func (m *User) PrivilegeLevelChange(frm form.User) bool { } // SaveForm updates the entity using form data and stores it in the database. -func (m *User) SaveForm(frm form.User, u *User) error { - if m.UserName == "" || m.ID <= 0 { +// Privilege-level fields (role, login, WebDAV, paths) are applied only when byAdmin; +// the most sensitive ones (super-admin status, auth provider/method such as 2FA, +// external identity) also require bySuperAdmin. The caller passes both explicitly so a +// user-less cluster service principal can act despite failing u.IsAdmin()/IsSuperAdmin(). +func (m *User) SaveForm(frm form.User, u *User, byAdmin, bySuperAdmin bool) error { + if m.UserName == "" || m.IsSystemOrInvalid() { return fmt.Errorf("system users cannot be modified") - } else if (m.ID == 1 || frm.SuperAdmin) && acl.RoleAdmin.NotEqual(frm.Role()) { + } else if frm.SuperAdmin && !acl.IsAdminRole(acl.Role(frm.Role())) { + // Super admins must keep an admin-level role. cluster_admin is the + // Portal operator role and counts as admin-level (it is unused on CE/Pro). return fmt.Errorf("super admin must not have a non-admin role") } else if frm.BasePath != "" && clean.UserPath(frm.BasePath) == "" { return fmt.Errorf("invalid base folder") @@ -1363,18 +1480,21 @@ func (m *User) SaveForm(frm form.User, u *User) error { m.VerifyToken = GenerateToken() } - // Change user privileges only if allowed. - if u == nil { - // Do nothing. - } else if u.IsAdmin() { + // Apply privilege-level changes only when the caller is authorized as an + // admin. A trusted cluster service principal has no end-user identity, so + // the handler passes byAdmin explicitly instead of relying on u.IsAdmin(), + // which a user-less token can never satisfy. + if u != nil && byAdmin { // Restore account. if frm.DeletedAt == nil { m.DeletedAt = nil } - // Prevent admins from locking themselves out. + // Prevent admins from locking themselves out: keep their current role + // and keep login enabled on a self-save. Forcing RoleAdmin here would + // silently demote a Portal cluster_admin; an explicit self role change + // is already rejected by the update handler. if u.Equal(m) { - m.SetRole(acl.RoleAdmin.String()) m.CanLogin = true } else { m.SetRole(frm.Role()) @@ -1384,8 +1504,9 @@ func (m *User) SaveForm(frm form.User, u *User) error { m.WebDAV = frm.WebDAV m.UserAttr = frm.Attr() - // Only allow super admins to change the authentication method and make other users super admins. - if u.IsSuperAdmin() { + // Only super-admin-level authority may change the auth method or grant super admin: + // an actual super admin, or bySuperAdmin (the trusted cluster service principal). + if u.IsSuperAdmin() || bySuperAdmin { if !u.Equal(m) { m.SuperAdmin = frm.SuperAdmin } @@ -1402,17 +1523,9 @@ func (m *User) SaveForm(frm form.User, u *User) error { m.SetUploadPath(frm.UploadPath) } - // Ensure super admins never have a non-admin role. - if m.SuperAdmin { - m.SetRole(acl.RoleAdmin.String()) - } - - // Make sure that the initial admin user cannot lock itself out. - if m.ID == Admin.ID && (m.AclRole() != acl.RoleAdmin || !m.SuperAdmin || !m.CanLogin) { - m.SetRole(acl.RoleAdmin.String()) - m.SuperAdmin = true - m.CanLogin = true - } + // Ensure super admins keep an admin-tier role that the running edition + // actually registers; see NormalizeAdminRole. + m.NormalizeAdminRole() return m.Save() } @@ -1472,7 +1585,7 @@ func (m *User) HasAvatar() bool { // SetAvatar updates the user avatar image. func (m *User) SetAvatar(thumb, thumbSrc string) error { - if m.UserName == "" || m.ID <= 0 { + if m.UserName == "" || m.IsSystemOrInvalid() { return fmt.Errorf("system user avatars cannot be changed") } diff --git a/internal/entity/auth_user_cli.go b/internal/entity/auth_user_cli.go index a438667fc..a7f6e6790 100644 --- a/internal/entity/auth_user_cli.go +++ b/internal/entity/auth_user_cli.go @@ -48,6 +48,14 @@ func (m *User) SetValuesFromCli(ctx *cli.Context) error { privilegeLevelChange = true } + // Authentication Issuer URL, e.g. the Portal base URL when adopting an + // account into a cluster OIDC identity. Pinning it scopes the link to that + // issuer instead of matching any provider that asserts the same subject. + if ctx.IsSet("auth-issuer") { + m.AuthIssuer = frm.AuthIssuer + privilegeLevelChange = true + } + // Super-admin status. if ctx.IsSet("superadmin") { m.SuperAdmin = frm.SuperAdmin @@ -101,8 +109,9 @@ func (m *User) SetValuesFromCli(ctx *cli.Context) error { // Invalid. return err } else if privilegeLevelChange { - // Delete sessions after privilege level change. - m.DeleteSessions(nil) + // Revoke all user sessions after a privilege level change, + // except for app passwords and client access tokens. + m.RevokeDerivedSessions(nil) } return nil diff --git a/internal/entity/auth_user_settings.go b/internal/entity/auth_user_settings.go index bd65f6062..50edc0e12 100644 --- a/internal/entity/auth_user_settings.go +++ b/internal/entity/auth_user_settings.go @@ -53,7 +53,7 @@ func CreateUserSettings(user *User) error { return fmt.Errorf("empty user uid") } - user.UserSettings = &UserSettings{} + user.UserSettings = NewUserSettings(user.GetUID()) if err := Db().Where("user_uid = ?", user.GetUID()).First(user.UserSettings).Error; err == nil { return nil diff --git a/internal/entity/auth_user_settings_test.go b/internal/entity/auth_user_settings_test.go index 168c007b4..9faa745af 100644 --- a/internal/entity/auth_user_settings_test.go +++ b/internal/entity/auth_user_settings_test.go @@ -15,7 +15,7 @@ func TestCreateUserSettings(t *testing.T) { assert.Nil(t, m.UserSettings) }) t.Run("Success", func(t *testing.T) { - m := &User{UserUID: "1234"} + m := &User{UserUID: "usg73p55zwgr1gbq"} err := CreateUserSettings(m) if err != nil { diff --git a/internal/entity/auth_user_share_test.go b/internal/entity/auth_user_share_test.go index d22152092..00c536190 100644 --- a/internal/entity/auth_user_share_test.go +++ b/internal/entity/auth_user_share_test.go @@ -103,7 +103,7 @@ func TestFindUserShares(t *testing.T) { } func TestUserShare_Create(t *testing.T) { - m := UserShare{} + m := UserShare{UserUID: "uqxc08w3d0ej2283", ShareUID: "as6sg6bxpogaaba7"} err := m.Create() if err != nil { diff --git a/internal/entity/auth_user_test.go b/internal/entity/auth_user_test.go index 33b0bd4ee..b687c69e9 100644 --- a/internal/entity/auth_user_test.go +++ b/internal/entity/auth_user_test.go @@ -511,6 +511,39 @@ func TestFirstOrCreateUser(t *testing.T) { }) } +func TestUserEmailAvailable(t *testing.T) { + alice := FindUserByName("alice") + require.NotNil(t, alice) + require.NotEmpty(t, alice.UserEmail) + t.Run("UnusedEmail", func(t *testing.T) { + assert.True(t, UserEmailAvailable("brand-new-unused-email@example.com", "")) + }) + t.Run("TakenByOtherAccount", func(t *testing.T) { + assert.False(t, UserEmailAvailable(alice.UserEmail, "")) + assert.False(t, UserEmailAvailable(alice.UserEmail, "u00000000000other")) + }) + t.Run("FreeForSameAccount", func(t *testing.T) { + assert.True(t, UserEmailAvailable(alice.UserEmail, alice.UserUID)) + }) + t.Run("EmptyEmail", func(t *testing.T) { + assert.False(t, UserEmailAvailable("", "")) + assert.False(t, UserEmailAvailable(" ", "")) + }) +} + +func TestUser_EmailVerified(t *testing.T) { + t.Run("NilVerifiedAt", func(t *testing.T) { + assert.False(t, (&User{}).EmailVerified()) + }) + t.Run("ZeroVerifiedAt", func(t *testing.T) { + zero := time.Time{} + assert.False(t, (&User{VerifiedAt: &zero}).EmailVerified()) + }) + t.Run("SetVerifiedAt", func(t *testing.T) { + assert.True(t, (&User{VerifiedAt: TimeStamp()}).EmailVerified()) + }) +} + func TestFindUser(t *testing.T) { t.Run("ID", func(t *testing.T) { m := FindUser(User{ID: 1}) @@ -835,9 +868,9 @@ func TestUser_SetPassword(t *testing.T) { func TestUser_InitAccount(t *testing.T) { t.Run("Ok", func(t *testing.T) { - p := User{UserUID: "u000000000000009", UserName: "Hanna", DisplayName: "", CanLogin: true} + p := User{ID: 9, UserUID: "u000000000000009", UserName: "Hanna", DisplayName: "", UserRole: acl.RoleAdmin.String(), AuthProvider: authn.ProviderLocal.String(), CanLogin: true} assert.Nil(t, FindPassword("u000000000000009")) - assert.True(t, p.InitAccount("admin", "insecure", "")) + assert.True(t, p.InitAccount("Hanna", "insecure", "")) m := FindPassword("u000000000000009") if m == nil { @@ -1205,6 +1238,64 @@ func TestUser_UpdateLoginTime(t *testing.T) { u.DeletedAt = &deleted assert.Nil(t, u.UpdateLoginTime()) }) + t.Run("NormalizesOutOfEditionSuperAdminRole", func(t *testing.T) { + u := NewUser() + u.UserName = "normalize-login" + u.DisplayName = "Normalize Login" + u.SuperAdmin = true + u.UserRole = acl.RoleAdmin.String() + u.CanLogin = true + + if err := u.Save(); err != nil { + t.Fatal(err) + } + + // Simulate a leftover out-of-edition role written outside this edition's + // validation (e.g. a Portal cluster_admin row on a Plus instance). + if err := Db().Model(u).UpdateColumn("UserRole", acl.RoleClusterAdmin.String()).Error; err != nil { + t.Fatal(err) + } + u.UserRole = acl.RoleClusterAdmin.String() + + // Logging in normalizes the stored role back to the edition's admin role. + // CE/Plus/Pro register only admin (not cluster_admin), so the target is admin. + u.UpdateLoginTime() + assert.Equal(t, acl.RoleAdmin.String(), u.UserRole) + + m := FindUser(User{UserUID: u.UserUID}) + if m == nil { + t.Fatal("result must not be nil") + } + assert.Equal(t, acl.RoleAdmin.String(), m.UserRole) + }) +} + +func TestUser_NormalizeAdminRole(t *testing.T) { + // CE registers admin but not cluster_admin, so the edition target is admin. + t.Run("ForeignSuperAdminRoleReset", func(t *testing.T) { + m := &User{UserName: "norm-foreign", SuperAdmin: true, UserRole: acl.RoleClusterAdmin.String()} + assert.True(t, m.NormalizeAdminRole()) + assert.Equal(t, acl.RoleAdmin.String(), m.UserRole) + }) + t.Run("RegisteredAdminRoleKept", func(t *testing.T) { + m := &User{UserName: "norm-admin", SuperAdmin: true, UserRole: acl.RoleAdmin.String()} + assert.False(t, m.NormalizeAdminRole()) + assert.Equal(t, acl.RoleAdmin.String(), m.UserRole) + }) + t.Run("NonAdminTierSuperAdminRoleReset", func(t *testing.T) { + m := &User{UserName: "norm-guest", SuperAdmin: true, UserRole: acl.RoleGuest.String()} + assert.True(t, m.NormalizeAdminRole()) + assert.Equal(t, acl.RoleAdmin.String(), m.UserRole) + }) + t.Run("RegularAccountUntouched", func(t *testing.T) { + m := &User{UserName: "norm-regular", SuperAdmin: false, UserRole: acl.RoleClusterAdmin.String()} + assert.False(t, m.NormalizeAdminRole()) + assert.Equal(t, acl.RoleClusterAdmin.String(), m.UserRole) + }) + t.Run("NilUser", func(t *testing.T) { + var m *User + assert.False(t, m.NormalizeAdminRole()) + }) } func TestUser_CanLogIn(t *testing.T) { @@ -1244,6 +1335,14 @@ func TestUser_CanUseWebDAV(t *testing.T) { assert.False(t, UserFixtures.Pointer("deleted").CanUseWebDAV()) assert.False(t, UserFixtures.Pointer("friend").CanUseWebDAV()) + + // Disabling web login must not affect WebDAV access: the API gate denies app + // passwords when CanLogin is off, while WebDAV stays governed by CanUseWebDAV. + // bob is a non-super-admin with WebDAV enabled (super admins always keep login). + webdavUser := UserFixtures.Get("bob") + webdavUser.CanLogin = false + assert.False(t, webdavUser.CanLogIn()) + assert.True(t, webdavUser.CanUseWebDAV()) } func TestUser_CanUpload(t *testing.T) { @@ -1407,7 +1506,7 @@ func TestUser_SaveForm(t *testing.T) { frm, err := UnknownUser.Form() assert.NoError(t, err) - err = UnknownUser.SaveForm(frm, UserFixtures.Pointer("guest")) + err = UnknownUser.SaveForm(frm, UserFixtures.Pointer("guest"), false, false) assert.Error(t, err) }) t.Run("Admin", func(t *testing.T) { @@ -1425,7 +1524,7 @@ func TestUser_SaveForm(t *testing.T) { frm.UserEmail = "admin@example.com" frm.UserDetails.UserLocation = "GoLand" - err = Admin.SaveForm(frm, UserFixtures.Pointer("guest")) + err = Admin.SaveForm(frm, UserFixtures.Pointer("guest"), false, false) assert.NoError(t, err) assert.Equal(t, "admin@example.com", Admin.UserEmail) @@ -1450,7 +1549,7 @@ func TestUser_SaveForm(t *testing.T) { frm.UserEmail = "admin@example.com" frm.UserDetails.UserLocation = "GoLand" - err = Admin.SaveForm(frm, UserFixtures.Pointer("alice")) + err = Admin.SaveForm(frm, UserFixtures.Pointer("alice"), true, false) assert.NoError(t, err) assert.Equal(t, "admin@example.com", Admin.UserEmail) @@ -1474,7 +1573,7 @@ func TestUser_SaveForm(t *testing.T) { } frm.DisplayName = "New Name" - err = Admin.SaveForm(frm, UserFixtures.Pointer("alice")) + err = Admin.SaveForm(frm, UserFixtures.Pointer("alice"), true, false) assert.NoError(t, err) assert.Equal(t, "New Name", Admin.DisplayName) @@ -1482,7 +1581,10 @@ func TestUser_SaveForm(t *testing.T) { m = FindUserByUID(Admin.UserUID) assert.Equal(t, "New Name", m.DisplayName) }) - t.Run("PreventDisableLoginForInitialAdmin", func(t *testing.T) { + t.Run("AnotherSuperAdminCanDisableInitialAdminLogin", func(t *testing.T) { + // The seed admin is no longer special-cased: another super admin may + // disable its login (e.g. a cluster-managed instance that keeps no local + // super admin). The acting admin still cannot lock itself out. m := FindUser(Admin) if m == nil { @@ -1496,13 +1598,59 @@ func TestUser_SaveForm(t *testing.T) { } frm.CanLogin = false - err = Admin.SaveForm(frm, UserFixtures.Pointer("alice")) + err = Admin.SaveForm(frm, UserFixtures.Pointer("alice"), true, false) assert.NoError(t, err) - assert.Equal(t, true, Admin.CanLogin) + assert.False(t, Admin.CanLogin) m = FindUserByUID(Admin.UserUID) - assert.Equal(t, true, m.CanLogin) + assert.False(t, m.CanLogin) + + // Restore the seed admin so later subtests see a login-capable account. + Admin.CanLogin = true + if err = Admin.Save(); err != nil { + t.Fatal(err) + } + }) + t.Run("AnotherSuperAdminCanDemoteInitialAdmin", func(t *testing.T) { + // With the hard ID-1 lock removed, a second super admin can fully demote + // the seed admin (clear super admin, drop to a non-admin role, disable + // login). The form must request SuperAdmin=false so the role normalization + // does not re-promote it. + m := FindUser(Admin) + + if m == nil { + t.Fatal("result must not be nil") + } + + frm, err := m.Form() + + if err != nil { + t.Fatal(err) + } + + frm.UserRole = acl.RoleGuest.String() + frm.SuperAdmin = false + frm.CanLogin = false + err = Admin.SaveForm(frm, UserFixtures.Pointer("alice"), true, false) + + assert.NoError(t, err) + assert.False(t, Admin.SuperAdmin) + assert.Equal(t, acl.RoleGuest.String(), Admin.UserRole) + assert.False(t, Admin.CanLogin) + + m = FindUserByUID(Admin.UserUID) + assert.False(t, m.SuperAdmin) + assert.Equal(t, acl.RoleGuest.String(), m.UserRole) + assert.False(t, m.CanLogin) + + // Restore the seed admin so later subtests see a usable super admin. + Admin.SuperAdmin = true + Admin.CanLogin = true + Admin.SetRole(acl.RoleAdmin.String()) + if err = Admin.Save(); err != nil { + t.Fatal(err) + } }) t.Run("PreventInitialAdminFromDisablingOwnLogin", func(t *testing.T) { m := FindUser(Admin) @@ -1518,7 +1666,7 @@ func TestUser_SaveForm(t *testing.T) { } frm.CanLogin = false - err = Admin.SaveForm(frm, &Admin) + err = Admin.SaveForm(frm, &Admin, true, false) assert.NoError(t, err) assert.Equal(t, true, Admin.CanLogin) @@ -1540,7 +1688,7 @@ func TestUser_SaveForm(t *testing.T) { } frm.AuthProvider = authn.ProviderNone.String() - err = Admin.SaveForm(frm, &Admin) + err = Admin.SaveForm(frm, &Admin, true, false) assert.NoError(t, err) assert.Equal(t, "local", Admin.AuthProvider) @@ -1564,7 +1712,7 @@ func TestUser_SaveForm(t *testing.T) { } frm.AuthProvider = authn.ProviderNone.String() - err = alice.SaveForm(frm, &alice) + err = alice.SaveForm(frm, &alice, true, false) assert.NoError(t, err) assert.Equal(t, "local", alice.AuthProvider) @@ -1598,7 +1746,7 @@ func TestUser_SaveForm(t *testing.T) { frm.SuperAdmin = false frm.CanLogin = false - err = user.SaveForm(frm, &user) + err = user.SaveForm(frm, &user, true, false) assert.NoError(t, err) assert.Equal(t, "admin", m.UserRole) @@ -1619,7 +1767,7 @@ func TestUser_SaveForm(t *testing.T) { } frm.UserRole = "user" - err = Admin.SaveForm(frm, UserFixtures.Pointer("guest")) + err = Admin.SaveForm(frm, UserFixtures.Pointer("guest"), false, false) assert.Error(t, err) assert.Equal(t, "super admin must not have a non-admin role", err.Error()) @@ -1641,7 +1789,7 @@ func TestUser_SaveForm(t *testing.T) { } frm.BasePath = "//*?" - err = Admin.SaveForm(frm, &Admin) + err = Admin.SaveForm(frm, &Admin, true, false) assert.Error(t, err) assert.Equal(t, "invalid base folder", err.Error()) @@ -1663,7 +1811,7 @@ func TestUser_SaveForm(t *testing.T) { } frm.UploadPath = "//*?" - err = Admin.SaveForm(frm, &Admin) + err = Admin.SaveForm(frm, &Admin, true, false) assert.Error(t, err) assert.Equal(t, "invalid upload folder", err.Error()) @@ -1671,6 +1819,95 @@ func TestUser_SaveForm(t *testing.T) { m = FindUserByUID(Admin.UserUID) assert.Equal(t, "", m.UploadPath) }) + t.Run("ClusterServicePrincipalDisablesLogin", func(t *testing.T) { + // A trusted cluster service principal (e.g. the Portal syncing user + // state) has no end-user identity, so SaveForm receives an unknown + // actor. With byAdmin set it must still persist privilege fields such as + // CanLogin; otherwise the Portal login toggle is silently ignored. + u := &User{UserName: "cluster-login-off", UserRole: acl.RoleUser.String(), CanLogin: true} + if err := u.Create(); err != nil { + t.Fatal(err) + } + + frm, err := u.Form() + if err != nil { + t.Fatal(err) + } + + frm.CanLogin = false + err = u.SaveForm(frm, &User{}, true, false) + + assert.NoError(t, err) + assert.False(t, u.CanLogin) + + m := FindUserByUID(u.UserUID) + assert.False(t, m.CanLogin) + }) + t.Run("UnprivilegedActorKeepsLogin", func(t *testing.T) { + // Without admin authorization the privilege block is skipped, so + // CanLogin stays unchanged even when the form requests false. + u := &User{UserName: "cluster-login-keep", UserRole: acl.RoleUser.String(), CanLogin: true} + if err := u.Create(); err != nil { + t.Fatal(err) + } + + frm, err := u.Form() + if err != nil { + t.Fatal(err) + } + + frm.CanLogin = false + err = u.SaveForm(frm, &User{}, false, false) + + assert.NoError(t, err) + assert.True(t, u.CanLogin) + + m := FindUserByUID(u.UserUID) + assert.True(t, m.CanLogin) + }) + t.Run("ClusterServicePrincipalDisables2FA", func(t *testing.T) { + // Disabling 2FA is super-admin-level; the cluster principal isn't a super admin, so + // without bySuperAdmin the auth method change would be dropped. + u := &User{UserName: "cluster-2fa-off", UserRole: acl.RoleUser.String(), CanLogin: true, AuthMethod: authn.Method2FA.String()} + if err := u.Create(); err != nil { + t.Fatal(err) + } + + frm, err := u.Form() + if err != nil { + t.Fatal(err) + } + + frm.AuthMethod = authn.MethodDefault.String() + err = u.SaveForm(frm, &User{}, true, true) + + assert.NoError(t, err) + assert.False(t, u.Method().Is(authn.Method2FA)) + + m := FindUserByUID(u.UserUID) + assert.False(t, m.Method().Is(authn.Method2FA)) + }) + t.Run("UnprivilegedAdminKeeps2FA", func(t *testing.T) { + // A regular admin (byAdmin, not super-admin-level) must not disable another user's 2FA. + u := &User{UserName: "admin-2fa-keep", UserRole: acl.RoleUser.String(), CanLogin: true, AuthMethod: authn.Method2FA.String()} + if err := u.Create(); err != nil { + t.Fatal(err) + } + + frm, err := u.Form() + if err != nil { + t.Fatal(err) + } + + frm.AuthMethod = authn.MethodDefault.String() + err = u.SaveForm(frm, &User{}, true, false) + + assert.NoError(t, err) + assert.True(t, u.Method().Is(authn.Method2FA)) + + m := FindUserByUID(u.UserUID) + assert.True(t, m.Method().Is(authn.Method2FA)) + }) } func TestUser_SetDisplayName(t *testing.T) { @@ -2204,7 +2441,7 @@ func TestUser_Equal(t *testing.T) { assert.False(t, Admin.Equal(&Visitor)) } -func TestUser_DeleteSessions(t *testing.T) { +func TestUser_RevokeDerivedSessions(t *testing.T) { t.Run("EmptyUid", func(t *testing.T) { u := User{ ID: 1234567, @@ -2213,13 +2450,115 @@ func TestUser_DeleteSessions(t *testing.T) { UserRole: "user", } - assert.Equal(t, 0, u.DeleteSessions([]string{})) + assert.Equal(t, 0, u.RevokeDerivedSessions([]string{})) }) t.Run("Alice", func(t *testing.T) { m := FindLocalUser("alice") - assert.Equal(t, 0, m.DeleteSessions([]string{rnd.SessionID("69be27ac5ca305b394046a83f6fda18167ca3d3f2dbe7ac0")})) - assert.Equal(t, 1, m.DeleteSessions([]string{})) + assert.Equal(t, 0, m.RevokeDerivedSessions([]string{rnd.SessionID("69be27ac5ca305b394046a83f6fda18167ca3d3f2dbe7ac0")})) + assert.Equal(t, 1, m.RevokeDerivedSessions([]string{})) + }) +} + +// revokeTestSession creates a persisted session of the given type for a synthetic user. +func revokeTestSession(t *testing.T, uid string, provider authn.ProviderType, method authn.MethodType, authID string) *Session { + s := NewSession(86400, 0) + s.UserUID = uid + s.UserName = "revoke-test" + s.SetProvider(provider) + s.SetMethod(method) + if authID != "" { + s.SetAuthID(authID, uid) + } + require.NoError(t, s.Create()) + return s +} + +// countUserSessions returns the number of sessions stored for the given user uid. +func countUserSessions(t *testing.T, uid string) int { + var sess Sessions + require.NoError(t, Db().Where("user_uid = ?", uid).Find(&sess).Error) + return len(sess) +} + +// newRevokeTestUser creates a synthetic user with one regular login, a parent app +// password, a derived child app session, and a client access token. +func newRevokeTestUser(t *testing.T) *User { + uid := rnd.GenerateUID(UserUID) + revokeTestSession(t, uid, authn.ProviderLocal, authn.MethodDefault, "") + parent := revokeTestSession(t, uid, authn.ProviderApplication, authn.MethodDefault, "") + revokeTestSession(t, uid, authn.ProviderApplication, authn.MethodSession, parent.ID) + revokeTestSession(t, uid, authn.ProviderClient, authn.MethodOAuth2, "") + return &User{ID: 100, UserUID: uid, UserName: "revoke-test", UserRole: "admin", AuthProvider: authn.ProviderLocal.String(), RefID: "usrevoke0001"} +} + +func TestUser_RevokeSessions(t *testing.T) { + t.Run("EmptyUid", func(t *testing.T) { + u := &User{ID: 1234567, UserUID: "", UserName: "test", UserRole: "user"} + assert.Equal(t, 0, u.RevokeSessions(nil, authn.RevokeAllSessions)) + }) + t.Run("LoginSessions", func(t *testing.T) { + u := newRevokeTestUser(t) + assert.Equal(t, 4, countUserSessions(t, u.UserUID)) + assert.Equal(t, 1, u.RevokeSessions(nil, authn.RevokeLoginSessions)) + assert.Equal(t, 3, countUserSessions(t, u.UserUID)) + }) + t.Run("DerivedSessions", func(t *testing.T) { + u := newRevokeTestUser(t) + assert.Equal(t, 2, u.RevokeSessions(nil, authn.RevokeDerivedSessions)) + assert.Equal(t, 2, countUserSessions(t, u.UserUID)) + }) + t.Run("AllSessions", func(t *testing.T) { + u := newRevokeTestUser(t) + assert.Equal(t, 4, u.RevokeSessions(nil, authn.RevokeAllSessions)) + assert.Equal(t, 0, countUserSessions(t, u.UserUID)) + }) + t.Run("OmitKeepsSession", func(t *testing.T) { + u := newRevokeTestUser(t) + var login Sessions + require.NoError(t, Db().Where("user_uid = ? AND auth_provider = ?", u.UserUID, authn.ProviderLocal.String()).Find(&login).Error) + require.Len(t, login, 1) + assert.Equal(t, 0, u.RevokeSessions([]string{login[0].ID}, authn.RevokeLoginSessions)) + assert.Equal(t, 4, countUserSessions(t, u.UserUID)) + }) + t.Run("CrossUserIsolation", func(t *testing.T) { + // The `auth_method = 'session'` clause must stay scoped to the target user, so + // revoking one user's derived sessions must never touch another user's sessions. + uidA := rnd.GenerateUID(UserUID) + uidB := rnd.GenerateUID(UserUID) + parentA := revokeTestSession(t, uidA, authn.ProviderApplication, authn.MethodDefault, "") + revokeTestSession(t, uidA, authn.ProviderApplication, authn.MethodSession, parentA.ID) + parentB := revokeTestSession(t, uidB, authn.ProviderApplication, authn.MethodDefault, "") + derivedB := revokeTestSession(t, uidB, authn.ProviderApplication, authn.MethodSession, parentB.ID) + + uA := &User{ID: 101, UserUID: uidA, UserName: "iso-a", RefID: "usiso0000a01"} + assert.Equal(t, 1, uA.RevokeDerivedSessions(nil)) + assert.Equal(t, 1, countUserSessions(t, uidA)) // parent A kept + assert.Equal(t, 2, countUserSessions(t, uidB)) // user B untouched + + sB, err := FindSession(derivedB.ID) + require.NoError(t, err) + require.NotNil(t, sB) + }) +} + +func TestUser_DenyLogIn(t *testing.T) { + t.Run("Active", func(t *testing.T) { + assert.False(t, UserFixtures.Pointer("alice").DenyLogIn()) + }) + t.Run("ProviderNone", func(t *testing.T) { + u := UserFixtures.Get("bob") + u.SetProvider(authn.ProviderNone) + assert.True(t, u.DenyLogIn()) + }) + t.Run("WebLoginDisabled", func(t *testing.T) { + u := UserFixtures.Get("bob") + u.CanLogin = false + assert.True(t, u.DenyLogIn()) + }) + t.Run("Nil", func(t *testing.T) { + var u *User + assert.True(t, u.DenyLogIn()) }) } diff --git a/internal/entity/camera.go b/internal/entity/camera.go index d4155fbf3..f4be1cb4e 100644 --- a/internal/entity/camera.go +++ b/internal/entity/camera.go @@ -1,11 +1,15 @@ package entity import ( + "fmt" "strings" "sync" "time" + "github.com/ulule/deepcopier" + "github.com/photoprism/photoprism/internal/event" + "github.com/photoprism/photoprism/internal/form" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/txt" ) @@ -35,6 +39,7 @@ func (Camera) TableName() string { return "cameras" } +// UnknownCamera is the placeholder used when no camera make or model is known. var UnknownCamera = Camera{ CameraSlug: UnknownID, CameraName: "Unknown", @@ -125,7 +130,8 @@ func FirstOrCreateCamera(m *Camera) *Camera { return &result } else if err := m.Create(); err == nil { if !m.Unknown() { - event.EntitiesCreated("cameras", []*Camera{m}) + // Content channels carry only stable identities, never entity fields; publish the slug. + event.EntitiesCreated("cameras", []string{m.CameraSlug}) event.Publish("count.cameras", event.Data{ "count": 1, @@ -182,3 +188,54 @@ func (m *Camera) Mobile() bool { func (m *Camera) Unknown() bool { return m.CameraSlug == "" || m.CameraSlug == UnknownCamera.CameraSlug } + +// UpdateMakeModel updates the make and model of an existing camera, e.g. to fix entries that +// ExifTool decodes with a missing or garbled make. +// The camera slug is intentionally left unchanged so existing photo references and the unique slug +// index are preserved across renames. +func (m *Camera) UpdateMakeModel(makeName, modelName string) error { + if m.ID == 0 { + return fmt.Errorf("empty id") + } + + makeName = strings.TrimSpace(makeName) + modelName = strings.TrimSpace(modelName) + + if makeName == "" || modelName == "" { + return fmt.Errorf("make and model must not be empty") + } + + cam := NewCamera(makeName, modelName) + // Override the changeable fields. + m.CameraMake = cam.CameraMake + m.CameraModel = cam.CameraModel + m.CameraName = cam.CameraName + m.CameraType = cam.CameraType + + cameraMutex.Lock() + defer cameraMutex.Unlock() + if err := Db().Save(m).Error; err != nil { + return err + } else { + if !m.Unknown() { + event.EntitiesUpdated("cameras", []string{m.CameraSlug}) + } + cameraCache.SetDefault(m.CameraSlug, m) + } + return nil +} + +// SaveForm validates the form, copies its data into the camera, and persists it. +func (m *Camera) SaveForm(f *form.Camera) error { + if f == nil { + return fmt.Errorf("form is nil") + } else if err := f.Validate(); err != nil { + return err + } + + if err := deepcopier.Copy(m).From(f); err != nil { + return err + } + + return m.UpdateMakeModel(f.CameraMake, f.CameraModel) +} diff --git a/internal/entity/camera_cache.go b/internal/entity/camera_cache.go index 014da7c95..f31f2c5b4 100644 --- a/internal/entity/camera_cache.go +++ b/internal/entity/camera_cache.go @@ -8,6 +8,7 @@ import ( var cameraCache = gc.New(time.Hour, 15*time.Minute) +// FlushCameraCache removes all cached cameras. func FlushCameraCache() { cameraCache.Flush() } diff --git a/internal/entity/camera_makes.go b/internal/entity/camera_makes.go index eed3161cf..cc15f88d4 100644 --- a/internal/entity/camera_makes.go +++ b/internal/entity/camera_makes.go @@ -1,5 +1,6 @@ package entity +// Camera make name constants used for normalization and device-type detection. const ( MakeNone = "" MakeAcer = "Acer" diff --git a/internal/entity/camera_models.go b/internal/entity/camera_models.go index 13c8113b0..7ea7751fb 100644 --- a/internal/entity/camera_models.go +++ b/internal/entity/camera_models.go @@ -1,5 +1,6 @@ package entity +// Camera model name constants used for normalization and device-type detection. const ( ModelNone = "" ModelUnknown = "Unknown" diff --git a/internal/entity/camera_test.go b/internal/entity/camera_test.go index cd81e6578..a930e1be7 100644 --- a/internal/entity/camera_test.go +++ b/internal/entity/camera_test.go @@ -2,8 +2,12 @@ package entity import ( "testing" + "time" "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/event" + "github.com/photoprism/photoprism/internal/form" ) func TestFirstOrCreateCamera(t *testing.T) { @@ -253,3 +257,142 @@ func TestCamera_Mobile(t *testing.T) { assert.True(t, camera.Mobile()) }) } + +func TestCamera_UpdateMakeModel(t *testing.T) { + t.Run("ExistingCamera", func(t *testing.T) { + fixture := "canon-eos-7d" + camera := NewCamera(CameraFixtures.Get(fixture).CameraMake, CameraFixtures.Get(fixture).CameraModel) + + result := FirstOrCreateCamera(camera) + + defer assert.NoError(t, UnscopedDb().Save(CameraFixtures.Pointer(fixture)).Error) + makeName := "Pentax" + modelName := "K-1" + err := result.UpdateMakeModel(makeName, modelName) + assert.NoError(t, err) + assert.Equal(t, CameraFixtures.Get(fixture).ID, result.ID) + assert.Equal(t, CameraMakes[makeName], result.CameraMake) + assert.Equal(t, modelName, result.CameraModel) + assert.Equal(t, CameraFixtures.Get(fixture).CameraSlug, result.CameraSlug) // Slug is preserved across renames. + assert.Equal(t, CameraMakes[makeName]+" "+modelName, result.CameraName) + }) + t.Run("NewCamera", func(t *testing.T) { + setup := NewCamera("", "9 99") + camera := FirstOrCreateCamera(setup) + defer assert.NoError(t, UnscopedDb().Delete(&Camera{}, "id = ?", camera.ID).Error) + makeName := "Pentax" + modelName := "K-1" + err := camera.UpdateMakeModel(makeName, modelName) + assert.NoError(t, err) + assert.Equal(t, CameraMakes[makeName], camera.CameraMake) + assert.Equal(t, modelName, camera.CameraModel) + assert.Equal(t, "9-99", camera.CameraSlug) // Slug is preserved across renames. + assert.Equal(t, CameraMakes[makeName]+" "+modelName, camera.CameraName) + }) + t.Run("NotExistingCamera", func(t *testing.T) { + camera := NewCamera("", "9 98") + err := camera.UpdateMakeModel("Pentax", "K-3") + assert.Error(t, err) + }) + t.Run("EmptyMake", func(t *testing.T) { + camera := &Camera{ID: CameraFixtures.Get("canon-eos-7d").ID, CameraMake: "Canon", CameraModel: "EOS 7D", CameraName: "Canon EOS 7D", CameraSlug: "canon-eos-7d"} + err := camera.UpdateMakeModel(" ", "EOS 7D") + assert.Error(t, err) + // The guard returns before any mutation, so existing values must be untouched. + assert.Equal(t, "Canon", camera.CameraMake) + assert.Equal(t, "EOS 7D", camera.CameraModel) + }) + t.Run("EmptyModel", func(t *testing.T) { + camera := &Camera{ID: CameraFixtures.Get("canon-eos-7d").ID, CameraMake: "Canon", CameraModel: "EOS 7D", CameraName: "Canon EOS 7D", CameraSlug: "canon-eos-7d"} + err := camera.UpdateMakeModel("Canon", "") + assert.Error(t, err) + assert.Equal(t, "Canon", camera.CameraMake) + assert.Equal(t, "EOS 7D", camera.CameraModel) + }) +} + +// TestCamera_EntityEvents pins the camera content-channel payloads to the UID-only +// invariant: cameras.created/updated carry a []string of stable slugs, never entity +// fields, and an update does not republish the camera count. +func TestCamera_EntityEvents(t *testing.T) { + t.Run("CreatedPublishesSlugOnly", func(t *testing.T) { + m := NewCamera("Acme", "Test Camera 6789") + + // Force the create branch to fire regardless of prior runs, -count>1, or cache state. + removeTestCamera := func() { + cameraCache.Delete(m.CameraSlug) + assert.NoError(t, UnscopedDb().Delete(&Camera{}, "camera_slug = ?", m.CameraSlug).Error) + } + removeTestCamera() + t.Cleanup(removeTestCamera) + + sub := event.Subscribe("cameras.created") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + camera := FirstOrCreateCamera(m) + + if camera == nil { + t.Fatal("result must not be nil") + } + + select { + case msg := <-sub.Receiver: + assert.Equal(t, "cameras.created", msg.Name) + slugs, ok := msg.Fields["entities"].([]string) + assert.True(t, ok, "entities payload should be []string, got %T", msg.Fields["entities"]) + assert.Equal(t, []string{camera.CameraSlug}, slugs) + case <-time.After(2 * time.Second): + t.Fatal("expected one cameras.created event") + } + }) + t.Run("UpdatedPublishesSlugOnlyWithoutCount", func(t *testing.T) { + fixture := "canon-eos-7d" + camera := FirstOrCreateCamera(NewCamera(CameraFixtures.Get(fixture).CameraMake, CameraFixtures.Get(fixture).CameraModel)) + t.Cleanup(func() { assert.NoError(t, UnscopedDb().Save(CameraFixtures.Pointer(fixture)).Error) }) + + updated := event.Subscribe("cameras.updated") + t.Cleanup(func() { event.Unsubscribe(updated) }) + count := event.Subscribe("count.cameras") + t.Cleanup(func() { event.Unsubscribe(count) }) + + assert.NoError(t, camera.UpdateMakeModel("Pentax", "K-1")) + // The slug must be preserved across a Make/Model rename so the published identity is stable. + assert.Equal(t, CameraFixtures.Get(fixture).CameraSlug, camera.CameraSlug) + + select { + case msg := <-updated.Receiver: + assert.Equal(t, "cameras.updated", msg.Name) + slugs, ok := msg.Fields["entities"].([]string) + assert.True(t, ok, "entities payload should be []string, got %T", msg.Fields["entities"]) + assert.Equal(t, []string{camera.CameraSlug}, slugs) + case <-time.After(2 * time.Second): + t.Fatal("expected one cameras.updated event") + } + // An update does not change the camera count, so no count event is published. + select { + case msg := <-count.Receiver: + t.Fatalf("unexpected %s event on camera update", msg.Name) + case <-time.After(200 * time.Millisecond): + } + }) +} + +func TestCamera_SaveForm(t *testing.T) { + t.Run("Success", func(t *testing.T) { + fixture := "canon-eos-7d" + camera := FirstOrCreateCamera(NewCamera(CameraFixtures.Get(fixture).CameraMake, CameraFixtures.Get(fixture).CameraModel)) + defer assert.NoError(t, UnscopedDb().Save(CameraFixtures.Pointer(fixture)).Error) + err := camera.SaveForm(&form.Camera{CameraMake: "Pentax", CameraModel: "K-1"}) + assert.NoError(t, err) + assert.Equal(t, CameraMakes["Pentax"], camera.CameraMake) + assert.Equal(t, "K-1", camera.CameraModel) + }) + t.Run("NilForm", func(t *testing.T) { + camera := &Camera{ID: CameraFixtures.Get("canon-eos-7d").ID} + assert.Error(t, camera.SaveForm(nil)) + }) + t.Run("EmptyMake", func(t *testing.T) { + camera := &Camera{ID: CameraFixtures.Get("canon-eos-7d").ID} + assert.Error(t, camera.SaveForm(&form.Camera{CameraMake: "", CameraModel: "K-1"})) + }) +} diff --git a/internal/entity/cell.go b/internal/entity/cell.go index 284478e6a..8ff2300d3 100644 --- a/internal/entity/cell.go +++ b/internal/entity/cell.go @@ -26,6 +26,29 @@ type Cell struct { UpdatedAt time.Time `json:"UpdatedAt" yaml:"-"` } +// ensurePlace loads or synthesizes the related place so callers can safely +// access place-derived fields even when the association was not preloaded. +func (m *Cell) ensurePlace() *Place { + if m.Place != nil { + return m.Place + } + + if m.PlaceID == "" || m.PlaceID == UnknownPlace.ID { + m.Place = &UnknownPlace + return m.Place + } + + if place := FindPlace(m.PlaceID); place != nil { + m.Place = place + return m.Place + } + + log.Warnf("cell: place %s for %s is missing", m.PlaceID, m.ID) + m.Place = &UnknownPlace + + return m.Place +} + // TableName returns the entity table name. func (Cell) TableName() string { return "cells" @@ -139,6 +162,7 @@ func (m *Cell) Find(api string) error { db := Db() if err := db.Preload("Place").First(m, "id = ?", m.ID).Error; err == nil { + m.ensurePlace() log.Tracef("cell: found %s", m.ID) return nil } @@ -249,10 +273,7 @@ func FirstOrCreateCell(m *Cell) *Cell { // Keywords returns search keywords for a location. func (m *Cell) Keywords() (result []string) { - if m.Place == nil { - log.Errorf("cell: place for %s is missing - you may have found a bug", m.ID) - return result - } + place := m.ensurePlace() result = append(result, txt.Keywords(txt.ReplaceSpaces(m.District(), "-"))...) result = append(result, txt.Keywords(txt.ReplaceSpaces(m.City(), "-"))...) @@ -261,7 +282,7 @@ func (m *Cell) Keywords() (result []string) { result = append(result, txt.Keywords(m.Name())...) result = append(result, txt.Keywords(m.Street())...) result = append(result, txt.Keywords(m.Category())...) - result = append(result, txt.Words(m.Place.PlaceKeywords)...) + result = append(result, txt.Words(place.PlaceKeywords)...) result = txt.UniqueWords(result) @@ -315,17 +336,17 @@ func (m *Cell) NoCategory() bool { // Label returns the location place label func (m *Cell) Label() string { - return m.Place.Label() + return m.ensurePlace().Label() } // District returns the district name if any. func (m *Cell) District() string { - return m.Place.District() + return m.ensurePlace().District() } // City returns the location city name if any. func (m *Cell) City() string { - return m.Place.City() + return m.ensurePlace().City() } // LongCity checks if the city name is more than 16 char @@ -345,20 +366,20 @@ func (m *Cell) CityContains(text string) bool { // State returns the location place state func (m *Cell) State() string { - return m.Place.State() + return m.ensurePlace().State() } // NoState checks if the location place has no state func (m *Cell) NoState() bool { - return m.Place.State() == "" + return m.State() == "" } // CountryCode returns the location place country code func (m *Cell) CountryCode() string { - return m.Place.CountryCode() + return m.ensurePlace().CountryCode() } // CountryName returns the location place country name func (m *Cell) CountryName() string { - return m.Place.CountryName() + return m.ensurePlace().CountryName() } diff --git a/internal/entity/cell_test.go b/internal/entity/cell_test.go index b6c8ab763..7d92f231b 100644 --- a/internal/entity/cell_test.go +++ b/internal/entity/cell_test.go @@ -57,6 +57,25 @@ func TestCell_Find(t *testing.T) { r := m.Find("") assert.Nil(t, r) }) + t.Run("RepairsMissingPlaceAssociation", func(t *testing.T) { + fixture := CellFixtures["mexico"] + fixture.Place = nil + + assert.NotPanics(t, func() { + assert.Equal(t, "Teotihuacán", fixture.City()) + }) + assert.Equal(t, "State of Mexico", fixture.State()) + assert.Equal(t, "Mexico", fixture.CountryName()) + }) + t.Run("MissingPlaceFallsBackToUnknown", func(t *testing.T) { + m := &Cell{ID: "s2:testmissingplace", PlaceID: "zz:missing"} + + assert.NotPanics(t, func() { + assert.Equal(t, "Unknown", m.City()) + }) + assert.Equal(t, "Unknown", m.State()) + assert.Equal(t, "Unknown", m.CountryName()) + }) t.Run("ApiEmpty", func(t *testing.T) { l := NewCell(2, 1) err := l.Find("") diff --git a/internal/entity/clip.go b/internal/entity/clip.go new file mode 100644 index 000000000..36f58d424 --- /dev/null +++ b/internal/entity/clip.go @@ -0,0 +1,54 @@ +package entity + +import ( + "strings" + + "github.com/photoprism/photoprism/pkg/txt/clip" +) + +const ( + // TypeBytes is the byte budget for sanitized type and identifier strings. + TypeBytes = 64 + + // PathBytes is the byte budget shared by the album_path, photo_path, and + // folders.path columns (all VARBINARY(1024)). Path values are clipped to it + // on write so the byte-exact comparisons between these columns hold. + PathBytes = 1024 +) + +// ToASCII removes all non-ASCII runes from the string. +func ToASCII(s string) string { + result := make([]rune, 0, len(s)) + + for _, r := range s { + if r <= 127 { + result = append(result, r) + } + } + + return string(result) +} + +// Clip trims leading/trailing whitespace and limits the string to maxLen bytes +// without splitting a multi-byte UTF-8 rune. +func Clip(s string, maxLen int) string { + return clip.Bytes(s, maxLen) +} + +// ClipPath limits a filesystem path to the PathBytes byte budget on a UTF-8 +// rune boundary, so a multi-byte path cannot overflow the album_path, +// photo_path, or folders.path columns or break the byte-exact comparisons +// between them. +func ClipPath(p string) string { + return clip.Bytes(p, PathBytes) +} + +// ClipType normalizes identifier-like strings by stripping non-ASCII runes and clipping to 32 characters. +func ClipType(s string) string { + return Clip(ToASCII(s), TypeBytes) +} + +// ClipTypeLower lowercases the string before applying ClipType. +func ClipTypeLower(s string) string { + return ClipType(strings.ToLower(s)) +} diff --git a/internal/entity/string_test.go b/internal/entity/clip_test.go similarity index 55% rename from internal/entity/string_test.go rename to internal/entity/clip_test.go index da212fb25..13dc6c27f 100644 --- a/internal/entity/string_test.go +++ b/internal/entity/clip_test.go @@ -3,6 +3,7 @@ package entity import ( "strings" "testing" + "unicode/utf8" "github.com/stretchr/testify/assert" ) @@ -29,7 +30,7 @@ func TestClip(t *testing.T) { assert.Equal(t, 16, len(result)) }) t.Run("ToASCII", func(t *testing.T) { - result := Clip(ToASCII(strings.ToLower(" 幸福 Hanzi are logograms developed for the writing of Chinese! Expressions in an index may not ...!")), ClipStringType) + result := Clip(ToASCII(strings.ToLower(" 幸福 Hanzi are logograms developed for the writing of Chinese! Expressions in an index may not ...!")), TypeBytes) assert.Equal(t, "hanzi are logograms developed for the writing of chinese! expres", result) assert.Equal(t, 64, len(result)) }) @@ -40,14 +41,33 @@ func TestClip(t *testing.T) { }) } -func TestSanitizeStringType(t *testing.T) { - result := SanitizeStringType(" 幸福 Hanzi are logograms developed for the writing of Chinese! Expressions in an index may not ...!") - assert.Equal(t, "Hanzi are logograms developed for the writing of Chinese! Expres", result) // codespell:ignore - assert.Equal(t, ClipStringType, len(result)) +// TestClipPath verifies that paths are limited to the PathBytes byte budget +// without splitting a multi-byte rune. +func TestClipPath(t *testing.T) { + t.Run("ShortPath", func(t *testing.T) { + assert.Equal(t, "2024/Vacation", ClipPath("2024/Vacation")) + }) + t.Run("Empty", func(t *testing.T) { + assert.Equal(t, "", ClipPath("")) + }) + t.Run("MultiByteOverflow", func(t *testing.T) { + // 400 four-byte emoji = 1600 bytes, over the 1024-byte budget. + path := strings.Repeat("😀", 400) + result := ClipPath(path) + assert.LessOrEqual(t, len(result), PathBytes) + assert.True(t, utf8.ValidString(result)) + assert.Equal(t, 256, utf8.RuneCountInString(result)) + }) } -func TestSanitizeStringTypeLower(t *testing.T) { - result := SanitizeStringTypeLower(" 幸福 Hanzi are logograms developed for the writing of Chinese! Expressions in an index may not ...!") - assert.Equal(t, "hanzi are logograms developed for the writing of chinese! expres", result) // codespell:ignore - assert.Equal(t, ClipStringType, len(result)) +func TestClipType(t *testing.T) { + result := ClipType(" 幸福 Hanzi are logograms developed for the writing of Chinese! Expressions in an index may not ...!") + assert.Equal(t, "Hanzi are logograms developed for the writing of Chinese! Expres", result) // codespell:ignore + assert.Equal(t, TypeBytes, len(result)) +} + +func TestClipTypeLower(t *testing.T) { + result := ClipTypeLower(" 幸福 Hanzi are logograms developed for the writing of Chinese! Expressions in an index may not ...!") + assert.Equal(t, "hanzi are logograms developed for the writing of chinese! expres", result) // codespell:ignore + assert.Equal(t, TypeBytes, len(result)) } diff --git a/internal/entity/country.go b/internal/entity/country.go index 8fa3eee57..da8810c74 100644 --- a/internal/entity/country.go +++ b/internal/entity/country.go @@ -89,7 +89,8 @@ func FirstOrCreateCountry(m *Country) *Country { return &result } else if createErr := m.Create(); createErr == nil { if !m.Unknown() { - event.EntitiesCreated("countries", []*Country{m}) + // Content channels carry only stable identities, never entity fields; publish the country code. + event.EntitiesCreated("countries", []string{m.ID}) event.Publish("count.countries", event.Data{ "count": 1, diff --git a/internal/entity/country_test.go b/internal/entity/country_test.go index 7eb25db9c..7bd0831dd 100644 --- a/internal/entity/country_test.go +++ b/internal/entity/country_test.go @@ -2,8 +2,11 @@ package entity import ( "testing" + "time" "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/event" ) func TestNewCountry(t *testing.T) { @@ -43,6 +46,43 @@ func TestFirstOrCreateCountry(t *testing.T) { }) } +// TestCountry_EntityEvents pins the countries content-channel payload to the UID-only +// invariant: countries.created carries a []string of stable country codes, never entity fields. +func TestCountry_EntityEvents(t *testing.T) { + t.Run("CreatedPublishesCodeOnly", func(t *testing.T) { + const code = "qq" // User-assigned ISO 3166 range; not a real fixture country. + + // Force the create branch to fire regardless of prior runs, -count>1, or cache state. + removeTestCountry := func() { + countryCache.Delete(code) + assert.NoError(t, UnscopedDb().Delete(&Country{}, "id = ?", code).Error) + } + removeTestCountry() + t.Cleanup(removeTestCountry) + + sub := event.Subscribe("countries.created") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + country := FirstOrCreateCountry(NewCountry(code, "Event Test Country")) + + if country == nil { + t.Fatal("country must not be nil") + } + + assert.Equal(t, code, country.ID) + + select { + case msg := <-sub.Receiver: + assert.Equal(t, "countries.created", msg.Name) + ids, ok := msg.Fields["entities"].([]string) + assert.True(t, ok, "entities payload should be []string, got %T", msg.Fields["entities"]) + assert.Equal(t, []string{code}, ids) + case <-time.After(2 * time.Second): + t.Fatal("expected one countries.created event") + } + }) +} + func TestCountry_Name(t *testing.T) { country := NewCountry("xy", "Neverland") assert.Equal(t, "Neverland", country.Name()) diff --git a/internal/entity/db.go b/internal/entity/db.go index 52d543574..62d23e5e3 100644 --- a/internal/entity/db.go +++ b/internal/entity/db.go @@ -1,16 +1,15 @@ package entity import ( - "time" - "github.com/jinzhu/gorm" ) -// Set UTC as the default for created and updated timestamps. +// Set UTC, truncated to whole seconds, as the default for created and updated +// timestamps. The schema stores these as DATETIME without fractional seconds, so +// generating second-precision values keeps in-memory and persisted times in sync +// and makes timestamp comparisons behave the same on SQLite and MariaDB. func init() { - gorm.NowFunc = func() time.Time { - return UTC() - } + gorm.NowFunc = Now } // Db returns the default *gorm.DB connection. diff --git a/internal/entity/db_conn.go b/internal/entity/db_conn.go index 14d83a92b..4f3bc77ab 100644 --- a/internal/entity/db_conn.go +++ b/internal/entity/db_conn.go @@ -8,16 +8,6 @@ import ( "github.com/jinzhu/gorm" _ "github.com/jinzhu/gorm/dialects/mysql" _ "github.com/jinzhu/gorm/dialects/sqlite" - - "github.com/photoprism/photoprism/pkg/dsn" -) - -// Supported test databases. -const ( - MySQL = dsn.DriverMySQL - SQLite3 = dsn.DriverSQLite3 - SQLiteTestDB = ".test.db" - SQLiteMemoryDSN = ":memory:?cache=shared" ) // dbConn is the global gorm.DB connection provider. diff --git a/internal/entity/details_test.go b/internal/entity/details_test.go index 707f5bc0f..fc60984ef 100644 --- a/internal/entity/details_test.go +++ b/internal/entity/details_test.go @@ -151,7 +151,7 @@ func TestDetails_Create(t *testing.T) { assert.Error(t, details.Create()) }) t.Run("Success", func(t *testing.T) { - details := Details{PhotoID: 1236799955432} + details := Details{PhotoID: 900000001} err := details.Create() @@ -161,10 +161,9 @@ func TestDetails_Create(t *testing.T) { }) } -// TODO fails on mariadb func TestDetails_Save(t *testing.T) { t.Run("Success", func(t *testing.T) { - details := Details{PhotoID: 123678955432, UpdatedAt: time.Date(2020, 2, 1, 0, 0, 0, 0, time.UTC)} + details := Details{PhotoID: 900000002, UpdatedAt: time.Date(2020, 2, 1, 0, 0, 0, 0, time.UTC)} initialDate := details.UpdatedAt err := details.Save() diff --git a/internal/entity/entity.go b/internal/entity/entity.go index 1ad36a80e..caecf38c8 100644 --- a/internal/entity/entity.go +++ b/internal/entity/entity.go @@ -1,7 +1,7 @@ /* Package entity provides entity models based on the GORM library. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. @@ -49,3 +49,12 @@ func FlushCaches() { FlushPhotoLabelCache() FlushSessionCache() } + +// TypeString returns an entity type string for logging, defaulting to "unknown". +func TypeString(entityType string) string { + if entityType == "" { + return "unknown" + } + + return entityType +} diff --git a/internal/entity/entity_const.go b/internal/entity/entity_const.go index 5cef1cfbf..f1a603263 100644 --- a/internal/entity/entity_const.go +++ b/internal/entity/entity_const.go @@ -33,7 +33,7 @@ const ( const ( RootUnknown = "" RootOriginals = "/" - RootExamples = "examples" + RootSamples = "samples" RootSidecar = "sidecar" RootImport = "import" RootPath = "/" diff --git a/internal/entity/entity_counts.go b/internal/entity/entity_counts.go index ad885f83d..0f949f3e2 100644 --- a/internal/entity/entity_counts.go +++ b/internal/entity/entity_counts.go @@ -3,6 +3,7 @@ package entity import ( "fmt" "strings" + "sync" "sync/atomic" "time" @@ -11,12 +12,42 @@ import ( "github.com/photoprism/photoprism/internal/mutex" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/time/unix" ) // countsBusy indicates whether count refresh jobs are currently running. var countsBusy = atomic.Bool{} +// asyncWG tracks in-flight goroutines spawned by entity package async +// helpers (UpdateCountsAsync and the cover-update goroutine in +// internal/entity/query). Callers that intend to tear down the database +// connection — most importantly config.CloseDb during test shutdown — +// should invoke WaitForAsyncJobs first to avoid a nil-DB race in the +// running goroutines. +var asyncWG sync.WaitGroup + +// AsyncJobAdd registers a new in-flight async job spawned by the entity +// package or its sub-packages. It must be paired with AsyncJobDone in a +// deferred call so the WaitForAsyncJobs helper can drain reliably. +func AsyncJobAdd() { + asyncWG.Add(1) +} + +// AsyncJobDone marks an in-flight async job as finished. Always pair it +// with a preceding AsyncJobAdd via defer so panics in the goroutine still +// release the WaitGroup. +func AsyncJobDone() { + asyncWG.Done() +} + +// WaitForAsyncJobs blocks until every async job started via the package's +// async helpers has finished. Callers that need to safely tear down the +// database connection should invoke this before nilling the provider. +func WaitForAsyncJobs() { + asyncWG.Wait() +} + type LabelPhotoCount struct { LabelID int PhotoCount int @@ -103,7 +134,7 @@ func UpdateSubjectCounts(public bool) (err error) { condition := gorm.Expr("subj_type = ?", SubjPerson) switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: res = Db().Exec(`UPDATE ? LEFT JOIN ( SELECT m.subj_uid, COUNT(DISTINCT f.id) AS subj_files, COUNT(DISTINCT f.photo_id) AS subj_photos FROM files f @@ -114,7 +145,7 @@ func UpdateSubjectCounts(public bool) (err error) { SET subjects.file_count = CASE WHEN b.subj_files IS NULL THEN 0 ELSE b.subj_files END, subjects.photo_count = CASE WHEN b.subj_photos IS NULL THEN 0 ELSE b.subj_photos END WHERE ?`, gorm.Expr(subjTable), photosJoin, condition) - case SQLite3: + case dsn.DriverSQLite3: // Update files count. res = Db().Table(subjTable). UpdateColumn("file_count", gorm.Expr("(SELECT COUNT(DISTINCT f.id)"+ @@ -187,7 +218,7 @@ func UpdateLabelCounts() (err error) { start := time.Now() var res *gorm.DB - if IsDialect(MySQL) { + if IsDialect(dsn.DriverMySQL) { res = Db().Exec(`UPDATE labels LEFT JOIN ( SELECT p2.label_id, COUNT(DISTINCT photo_id) AS label_photos FROM ( SELECT pl.label_id as label_id, p.id AS photo_id FROM photos p @@ -201,7 +232,7 @@ func UpdateLabelCounts() (err error) { ) p2 GROUP BY p2.label_id ) b ON b.label_id = labels.id SET photo_count = CASE WHEN b.label_photos IS NULL THEN 0 ELSE b.label_photos END`) - } else if IsDialect(SQLite3) { + } else if IsDialect(dsn.DriverSQLite3) { res = Db(). Table("labels"). UpdateColumn("photo_count", @@ -236,17 +267,32 @@ func UpdateLabelCounts() (err error) { return nil } -// UpdateCountsAsync runs UpdateCounts in a go routine -// and logs the returned error, if any, as a warning. +// UpdateCountsAsync runs UpdateCounts in a goroutine and logs the +// returned error, if any, as a warning. The launched goroutine is +// registered with the package WaitGroup (via AsyncJobAdd / AsyncJobDone) +// so config.CloseDb can drain in-flight work via WaitForAsyncJobs before +// tearing down the database connection. A deferred recover guards against +// any future shutdown race producing a process-killing panic instead of +// a clean log line. func UpdateCountsAsync() { + AsyncJobAdd() go func() { + defer AsyncJobDone() + defer func() { + if r := recover(); r != nil { + log.Errorf("index: recovered from panic in UpdateCountsAsync (%v)", r) + } + }() if err := UpdateCounts(); err != nil { log.Warnf("index: %s (update counts)", clean.Error(err)) } }() } -// UpdateCounts updates precalculated photo and file counts. +// UpdateCounts updates precalculated photo and file counts. It returns +// nil without doing any work when the entity database provider has been +// torn down (e.g. during test shutdown), so a stray async invocation +// after CloseDb does not panic on a nil dialect lookup. func UpdateCounts() (err error) { if !countsBusy.CompareAndSwap(false, true) { log.Debugf("index: skipped updating counts because it is already in progress") @@ -255,6 +301,11 @@ func UpdateCounts() (err error) { defer countsBusy.Store(false) + if Db() == nil { + log.Debugf("index: skipped updating counts because database is not connected") + return nil + } + log.Debug("index: updating counts") if err = UpdatePlacesCounts(); err != nil { diff --git a/internal/entity/entity_counts_test.go b/internal/entity/entity_counts_test.go index 5bcee8546..f79e9e7c9 100644 --- a/internal/entity/entity_counts_test.go +++ b/internal/entity/entity_counts_test.go @@ -1,6 +1,7 @@ package entity import ( + "sync" "testing" "time" @@ -62,3 +63,69 @@ func TestUpdateLabelCountsIfNeeded(t *testing.T) { t.Fatalf("timestamp not refreshed") } } + +func TestUpdateCounts_NilDbReturnsCleanly(t *testing.T) { + // Simulate the post-CloseDb shutdown state where the entity DB + // provider has been nilled. UpdateCounts must return nil instead of + // panicking on a nil dialect lookup, otherwise an in-flight async + // goroutine spawned by UpdateCountsAsync would crash the process. + prev := dbConn + defer SetDbProvider(prev) + SetDbProvider(nil) + + if err := UpdateCounts(); err != nil { + t.Fatalf("UpdateCounts on nil DB should return nil, got %v", err) + } +} + +func TestWaitForAsyncJobs_DrainsRegisteredWork(t *testing.T) { + // Models the contract that config.CloseDb relies on: WaitForAsyncJobs + // must block until every AsyncJobAdd has a matching AsyncJobDone, so + // async count/cover update goroutines finish before the DB connection + // is torn down. + const workers = 8 + + started := make(chan struct{}, workers) + release := make(chan struct{}) + var done sync.WaitGroup + + done.Add(workers) + for range workers { + AsyncJobAdd() + go func() { + defer AsyncJobDone() + defer done.Done() + started <- struct{}{} + <-release + }() + } + + // Make sure every goroutine is parked before we start the wait so the + // test exercises a real drain rather than a fast path on an empty WG. + for range workers { + <-started + } + + waitDone := make(chan struct{}) + go func() { + WaitForAsyncJobs() + close(waitDone) + }() + + select { + case <-waitDone: + t.Fatalf("WaitForAsyncJobs returned before any worker called AsyncJobDone") + case <-time.After(20 * time.Millisecond): + // Expected — workers are still parked. + } + + close(release) + done.Wait() + + select { + case <-waitDone: + // Expected. + case <-time.After(2 * time.Second): + t.Fatalf("WaitForAsyncJobs did not return after all workers finished") + } +} diff --git a/internal/entity/entity_init.go b/internal/entity/entity_init.go index 488c80465..a02980c1a 100644 --- a/internal/entity/entity_init.go +++ b/internal/entity/entity_init.go @@ -6,6 +6,7 @@ import ( "github.com/photoprism/photoprism/internal/entity/migrate" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/fs" ) @@ -55,13 +56,13 @@ func InitTestDb(driver, dbDsn string) *DbConn { // Set default test database driver. if driver == "test" || driver == "sqlite" || driver == "" || dbDsn == "" { - driver = SQLite3 + driver = dsn.DriverSQLite3 } // Set default database DSN. - if driver == SQLite3 { - if dbDsn == "" || dbDsn == SQLiteTestDB { - dbDsn = SQLiteTestDB + if driver == dsn.DriverSQLite3 { + if dbDsn == "" || dbDsn == dsn.SQLiteTestDB { + dbDsn = dsn.SQLiteTestDB if !fs.FileExists(dbDsn) { log.Debugf("sqlite: test database %s does not already exist", clean.Log(dbDsn)) } else if err := os.Remove(dbDsn); err != nil { diff --git a/internal/entity/entity_test.go b/internal/entity/entity_test.go index 29097d764..de336f3de 100644 --- a/internal/entity/entity_test.go +++ b/internal/entity/entity_test.go @@ -11,26 +11,27 @@ import ( "github.com/photoprism/photoprism/pkg/fs" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) int { log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) event.AuditLog = log // Remove temporary SQLite files before running the tests. fs.PurgeTestDbFiles(".", false) + // Remove temporary SQLite files after running the tests. + defer fs.PurgeTestDbFiles(".", false) db := InitTestDb( os.Getenv("PHOTOPRISM_TEST_DRIVER"), os.Getenv("PHOTOPRISM_TEST_DSN")) + defer db.Close() - code := m.Run() - - // Remove temporary SQLite files after running the tests. - db.Close() - - fs.PurgeTestDbFiles(".", false) - - os.Exit(code) + return m.Run() } func TestTypeString(t *testing.T) { diff --git a/internal/entity/entity_time.go b/internal/entity/entity_time.go index 77df064d5..984b9c224 100644 --- a/internal/entity/entity_time.go +++ b/internal/entity/entity_time.go @@ -23,6 +23,15 @@ func TimeStamp() *time.Time { return &t } +// TimePointer returns a reference to the specified time, or nil if it is the zero value. +func TimePointer(t time.Time) *time.Time { + if t.IsZero() { + return nil + } + + return &t +} + // Time returns a reference to the specified time in UTC, truncated to seconds, or nil if it is invalid. func Time(s string) *time.Time { if t, err := time.Parse(time.RFC3339, s); err == nil { diff --git a/internal/entity/entity_time_test.go b/internal/entity/entity_time_test.go index ed5880233..915923009 100644 --- a/internal/entity/entity_time_test.go +++ b/internal/entity/entity_time_test.go @@ -26,7 +26,11 @@ func TestUTC(t *testing.T) { t.Logf("NOW: %s, %s", utc.String(), utcGorm.String()) - assert.True(t, utcGorm.After(utc)) + // gorm.NowFunc truncates to whole seconds, so it can trail the sub-second + // UTC() reading by up to a second; assert they stay within a sane window. + delta := utcGorm.Sub(utc) + assert.Greater(t, delta, -time.Second) + assert.Less(t, delta, time.Second) if zone, offset := utcGorm.Zone(); zone != tz.UTC { t.Error("gorm time should be UTC") @@ -133,6 +137,20 @@ func TestTimeStamp(t *testing.T) { } } +func TestTimePointer(t *testing.T) { + t.Run("NonZero", func(t *testing.T) { + now := Now() + result := TimePointer(now) + if result == nil { + t.Fatal("result must not be nil") + } + assert.Equal(t, now, *result) + }) + t.Run("Zero", func(t *testing.T) { + assert.Nil(t, TimePointer(time.Time{})) + }) +} + func TestTime(t *testing.T) { result := Time("2022-01-02T13:04:05+01:00") diff --git a/internal/entity/entity_update_test.go b/internal/entity/entity_update_test.go index 0f075a77a..72a7de967 100644 --- a/internal/entity/entity_update_test.go +++ b/internal/entity/entity_update_test.go @@ -50,7 +50,7 @@ func TestUpdate(t *testing.T) { }) t.Run("NotUpdated", func(t *testing.T) { uid := rnd.GenerateUID(PhotoUID) - m := &Photo{ID: missingPhotoID(), PhotoUID: uid, UpdatedAt: time.Now(), CreatedAt: Now(), PhotoTitle: "Foo"} + m := &Photo{ID: missingPhotoID(), PhotoUID: uid, UpdatedAt: Now().Add(-time.Hour), CreatedAt: Now(), PhotoTitle: "Foo"} updatedAt := m.UpdatedAt err := Update(m, "ID", "PhotoUID") diff --git a/internal/entity/error.go b/internal/entity/error.go index 2427e8753..9cb163c9f 100644 --- a/internal/entity/error.go +++ b/internal/entity/error.go @@ -7,8 +7,15 @@ import ( "github.com/sirupsen/logrus" "github.com/photoprism/photoprism/internal/event" + "github.com/photoprism/photoprism/pkg/txt/clip" ) +// ErrorMessageBytes is the storage limit of the error_message column in bytes, +// matching its VARBINARY(2048) definition. Messages may contain multi-byte text +// (e.g. file paths or recovered-panic stack traces), so writes are clipped by +// bytes on a rune boundary to avoid write errors and invalid UTF-8. +const ErrorMessageBytes = 2048 + // logEvents is true when events are being recorded in the "errors" database table. var logEvents = atomic.Bool{} @@ -64,7 +71,7 @@ func (Error) LogEvents(minLevel logrus.Level) { errLog := Error{ErrorLevel: level.String()} if val, ok := msg.Fields["message"]; ok { - errLog.ErrorMessage = val.(string) + errLog.ErrorMessage = clip.Bytes(val.(string), ErrorMessageBytes) } if val, ok := msg.Fields["time"]; ok { diff --git a/internal/entity/face.go b/internal/entity/face.go index 1f600d78b..c5f906332 100644 --- a/internal/entity/face.go +++ b/internal/entity/face.go @@ -11,6 +11,7 @@ import ( "time" "github.com/photoprism/photoprism/internal/ai/face" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/rnd" ) @@ -269,7 +270,14 @@ func (m *Face) MatchMarkers(faceIds []string) error { return err } - for _, marker := range markers { + start := time.Now() + resultLen := len(markers) + + for i, marker := range markers { + if time.Since(start) > time.Duration(time.Minute*15) { + log.Infof("faces: matching %d of %d markers", i, resultLen) + start = time.Now() + } if ok, dist := m.Match(marker.Embeddings()); !ok { // Ignore. } else if _, err = marker.SetFace(m, dist); err != nil { @@ -341,7 +349,7 @@ func (m *Face) RefreshPhotos() error { var err error switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: update := fmt.Sprintf(`UPDATE photos p JOIN files f ON f.photo_id = p.id JOIN %s m ON m.file_uid = f.file_uid SET p.checked_at = NULL WHERE m.face_id = ?`, Marker{}.TableName()) err = UnscopedDb().Exec(update, m.ID).Error diff --git a/internal/entity/file.go b/internal/entity/file.go index 1d3c05c02..100856d46 100644 --- a/internal/entity/file.go +++ b/internal/entity/file.go @@ -17,6 +17,7 @@ import ( "github.com/photoprism/photoprism/internal/ai/face" "github.com/photoprism/photoprism/internal/config/customize" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/fs" "github.com/photoprism/photoprism/pkg/media" "github.com/photoprism/photoprism/pkg/media/colors" @@ -129,7 +130,7 @@ func (m File) RegenerateIndex() { } switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: Log("files", "regenerate photo_taken_at", Db().Exec("UPDATE files JOIN ? p ON p.id = files.photo_id SET files.photo_taken_at = p.taken_at_local WHERE ?", gorm.Expr(photosTable), updateWhere).Error) @@ -141,7 +142,7 @@ func (m File) RegenerateIndex() { Log("files", "regenerate time_index", Db().Exec("UPDATE files SET time_index = CASE WHEN media_id IS NOT NULL AND photo_taken_at IS NOT NULL THEN CONCAT(100000000000000 - CAST(photo_taken_at AS UNSIGNED), '-', media_id) ELSE NULL END WHERE ?", updateWhere).Error) - case SQLite3: + case dsn.DriverSQLite3: Log("files", "regenerate photo_taken_at", Db().Exec("UPDATE files SET photo_taken_at = (SELECT p.taken_at_local FROM ? p WHERE p.id = photo_id) WHERE ?", gorm.Expr(photosTable), updateWhere).Error) @@ -547,7 +548,7 @@ func (m *File) Rename(fileName, rootName, filePath, fileBase string) error { // Update photo path and name if possible. if p := m.RelatedPhoto(); p != nil { return p.Updates(Values{ - "PhotoPath": filePath, + "PhotoPath": ClipPath(filePath), "PhotoName": fileBase, }) } @@ -674,7 +675,7 @@ func (m *File) IsAnimated() bool { // ColorProfile returns the ICC color profile name if any. func (m *File) ColorProfile() string { - return SanitizeStringType(m.FileColorProfile) + return ClipType(m.FileColorProfile) } // HasColorProfile tests if the file has a matching color profile. @@ -684,8 +685,8 @@ func (m *File) HasColorProfile(profile colors.Profile) bool { // SetColorProfile sets the ICC color profile name such as "Display P3". func (m *File) SetColorProfile(name string) { - if name = SanitizeStringType(name); name != "" { - m.FileColorProfile = SanitizeStringType(name) + if name = ClipType(name); name != "" { + m.FileColorProfile = ClipType(name) } } @@ -696,7 +697,7 @@ func (m *File) ResetColorProfile() { // SetSoftware sets the software name. func (m *File) SetSoftware(name string) { - if name = SanitizeStringType(name); name != "" { + if name = ClipType(name); name != "" { m.FileSoftware = name } } diff --git a/internal/entity/folder.go b/internal/entity/folder.go index 63e3e09ca..16c168885 100644 --- a/internal/entity/folder.go +++ b/internal/entity/folder.go @@ -70,6 +70,10 @@ func NewFolder(root, dir string, modTime time.Time) Folder { dir = "" } + // Clip to the shared path byte budget so folders.path stays byte-exact with + // album_path and photo_path. + dir = ClipPath(dir) + year := 0 month := 0 @@ -141,9 +145,9 @@ func (m *Folder) SetValuesFromPath() { } } -// Slug returns a slug based on the folder title. +// Slug returns a collision-resistant slug derived from the folder path. func (m *Folder) Slug() string { - return txt.Slug(m.Path) + return txt.SlugUnique(m.Path) } // RootPath returns the full folder path including root. @@ -201,22 +205,28 @@ func ReconcileOriginalsFolderAlbums(rootPath string) (reconciled int, err error) } // originalsFolderAlbumReconcileScope returns the effective reconciliation scope for a path. -// If a slug collision with a sibling folder album is detected, the scope is expanded to -// include the parent folder path so related rows can be repaired together. +// If a slug collision is detected, the scope is expanded to the highest colliding +// ancestor folder path so related rows can be repaired together. func originalsFolderAlbumReconcileScope(rootPath string) string { rootPath = clean.UserPath(rootPath) - if rootPath == "" || !hasOriginalsFolderPath(rootPath) || !hasOriginalsFolderAlbumSlugCollision(rootPath) { + if rootPath == "" || !hasOriginalsFolderPath(rootPath) { return rootPath } - parentPath := path.Dir(rootPath) + scopePath := rootPath - if parentPath == "/" || parentPath == "." { - return rootPath + for hasOriginalsFolderAlbumSlugCollision(scopePath) { + parentPath := clean.UserPath(path.Dir(scopePath)) + + if parentPath == "" || parentPath == "." || parentPath == "/" || parentPath == scopePath { + break + } + + scopePath = parentPath } - return parentPath + return scopePath } // hasOriginalsFolderPath reports whether an active originals folder row exists for rootPath. @@ -233,23 +243,32 @@ func hasOriginalsFolderPath(rootPath string) bool { // hasOriginalsFolderAlbumSlugCollision reports whether rootPath collides with another // active folder album that shares the same slug but stores a different non-empty path. +// The "different path" check runs in Go because MariaDB's utf8mb4_unicode_ci collation +// collapses most emoji, so an SQL "album_path <> ?" would wrongly exclude an emoji +// sibling (e.g. "ins/🪞" treated as equal to "ins/🍷") and miss the collision. func hasOriginalsFolderAlbumSlugCollision(rootPath string) bool { - albumSlug := txt.Slug(rootPath) + albumSlugs := folderAlbumSlugCandidates(rootPath) - if albumSlug == "" { + if len(albumSlugs) == 0 { return false } - var collisions int + var albums Albums - if err := Db().Model(&Album{}). - Where("album_type = ? AND album_slug = ? AND album_path <> '' AND album_path <> ?", AlbumFolder, albumSlug, rootPath). - Count(&collisions).Error; err != nil { + if err := Db(). + Where("album_type = ? AND album_slug IN (?) AND album_path <> ''", AlbumFolder, albumSlugs). + Find(&albums).Error; err != nil { log.Debugf("folder: %s (check album slug collision for %s)", err, clean.LogQuote(rootPath)) return false } - return collisions > 0 + for i := range albums { + if albums[i].AlbumPath != rootPath { + return true + } + } + + return false } // syncOriginalsAlbum ensures an originals folder has a matching folder album. diff --git a/internal/entity/folder_album_slug.go b/internal/entity/folder_album_slug.go new file mode 100644 index 000000000..fedf563d3 --- /dev/null +++ b/internal/entity/folder_album_slug.go @@ -0,0 +1,65 @@ +package entity + +import ( + "strings" + + "github.com/gosimple/slug" + + "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/txt" +) + +// folderAlbumSlugCandidates returns the current and legacy slug candidates for a folder path. +// The first entry is the canonical slug used by new rows; later entries cover legacy formats +// so FindFolderAlbum can resolve rows written before the collision-safe slug landed. +func folderAlbumSlugCandidates(albumPath string) []string { + albumPath = clean.SlashPath(albumPath) + + if albumPath == "" { + return nil + } + + candidates := make([]string, 0, 3) + + for _, value := range []string{txt.SlugUnique(albumPath), txt.Slug(albumPath), legacyFolderAlbumSlug(albumPath)} { + if value == "" { + continue + } + + duplicate := false + + for _, existing := range candidates { + if existing == value { + duplicate = true + break + } + } + + if !duplicate { + candidates = append(candidates, value) + } + } + + return candidates +} + +// legacyFolderAlbumSlug reproduces the folder album slug logic used before the 2026 collision fixes. +func legacyFolderAlbumSlug(albumPath string) string { + albumPath = strings.TrimSpace(clean.SlashPath(albumPath)) + + if albumPath == "" || albumPath == "-" { + return albumPath + } + + if albumPath[0] == txt.SlugEncoded && txt.ContainsAlnumLower(albumPath[1:]) { + return txt.Clip(albumPath, txt.ClipSlug) + } + + result := slug.Make(albumPath) + + if result == "" { + result = string(txt.SlugEncoded) + txt.SlugEncoding.EncodeToString([]byte(albumPath)) + } + + return txt.Clip(result, txt.ClipSlug) +} diff --git a/internal/entity/folder_album_slug_test.go b/internal/entity/folder_album_slug_test.go new file mode 100644 index 000000000..25c7403ce --- /dev/null +++ b/internal/entity/folder_album_slug_test.go @@ -0,0 +1,44 @@ +package entity + +import ( + "strings" + "testing" + + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/pkg/txt" +) + +func TestFolderAlbumSlugCandidates(t *testing.T) { + t.Run("Empty", func(t *testing.T) { + assert.Nil(t, folderAlbumSlugCandidates("")) + }) + t.Run("ShortAsciiPath", func(t *testing.T) { + candidates := folderAlbumSlugCandidates("pictures/2024") + assert.Equal(t, []string{"pictures-2024"}, candidates) + }) + t.Run("LongAsciiPathExposesHashAndLegacy", func(t *testing.T) { + path := "pictures/Ferie 2008 Mellomeuropa/Galleri-konvertert/bilder/ferie 2008 mellomeuropa/galleri/01 Praha, Dresden, Wroclaw" + candidates := folderAlbumSlugCandidates(path) + + if len(candidates) < 2 { + t.Fatalf("expected at least 2 candidates, got %v", candidates) + } + + assert.Equal(t, txt.SlugUnique(path), candidates[0]) + assert.Contains(t, candidates, legacyFolderAlbumSlug(path)) + assert.NotEqual(t, candidates[0], legacyFolderAlbumSlug(path)) + }) + t.Run("LongAsciiSiblingsDoNotCollide", func(t *testing.T) { + base := "pictures/Ferie 2008 Mellomeuropa/Galleri-konvertert/bilder/ferie 2008 mellomeuropa/galleri/" + a := folderAlbumSlugCandidates(base + "01 Praha, Dresden, Wroclaw") + b := folderAlbumSlugCandidates(base + "02 Wroclaw, Auschwitz") + + assert.NotEqual(t, a[0], b[0]) + }) + t.Run("LegacyAndCurrentMatchForShortPath", func(t *testing.T) { + path := "pictures/" + strings.Repeat("x", 4) + candidates := folderAlbumSlugCandidates(path) + assert.Len(t, candidates, 1) + }) +} diff --git a/internal/entity/folder_test.go b/internal/entity/folder_test.go index 6fbc95391..382d814dc 100644 --- a/internal/entity/folder_test.go +++ b/internal/entity/folder_test.go @@ -549,11 +549,15 @@ func TestFolder_Create(t *testing.T) { // - title/filter point to pathWine _ = UnscopedDb().Where("album_type = ? AND album_path IN (?)", AlbumFolder, []string{pathMirror, pathWine}).Delete(Album{}).Error - stale := NewFolderAlbum(folderWine.Title(), pathMirror, `path:"`+pathWine+`" public:true`) - - if stale == nil { - t.Fatal("expected stale folder album") + stale := &Album{ + AlbumType: AlbumFolder, + AlbumSlug: legacyFolderAlbumSlug(pathMirror), + AlbumPath: pathMirror, + AlbumFilter: `path:"` + pathWine + `" public:true`, + CreatedAt: Now(), + UpdatedAt: Now(), } + stale.SetTitle(folderWine.Title()) if err := stale.Create(); err != nil { t.Fatal(err) @@ -608,11 +612,15 @@ func TestFolder_Create(t *testing.T) { // exists and points to the wrong folder metadata. _ = UnscopedDb().Where("album_type = ? AND album_path IN (?)", AlbumFolder, []string{pathMirror, pathWine}).Delete(Album{}).Error - stale := NewFolderAlbum(folderWine.Title(), pathMirror, `path:"`+pathWine+`" public:true`) - - if stale == nil { - t.Fatal("expected stale folder album") + stale := &Album{ + AlbumType: AlbumFolder, + AlbumSlug: legacyFolderAlbumSlug(pathMirror), + AlbumPath: pathMirror, + AlbumFilter: `path:"` + pathWine + `" public:true`, + CreatedAt: Now(), + UpdatedAt: Now(), } + stale.SetTitle(folderWine.Title()) if err := stale.Create(); err != nil { t.Fatal(err) @@ -644,4 +652,72 @@ func TestFolder_Create(t *testing.T) { assert.Equal(t, pathMirror, mirrorAlbum.AlbumPath) assert.Equal(t, pathWine, wineAlbum.AlbumPath) }) + t.Run("SingleDeepFolderRescanRepairsAncestorCollisionScope", func(t *testing.T) { + parentPath := "ins-deep-" + txt.Slug(time.Now().UTC().Format(time.RFC3339Nano)) + pathMirror := parentPath + "/🍷" + pathEmoji := parentPath + "/🪞" + pathPumpkin := pathEmoji + "/🎃" + pathLink := pathPumpkin + "/🔗" + pathFish := pathLink + "/🐠" + + folderMirror := NewFolder(RootOriginals, pathMirror, time.Now().UTC()) + folderEmoji := NewFolder(RootOriginals, pathEmoji, time.Now().UTC()) + folderPumpkin := NewFolder(RootOriginals, pathPumpkin, time.Now().UTC()) + folderLink := NewFolder(RootOriginals, pathLink, time.Now().UTC()) + folderFish := NewFolder(RootOriginals, pathFish, time.Now().UTC()) + + for _, folder := range []*Folder{&folderMirror, &folderEmoji, &folderPumpkin, &folderLink, &folderFish} { + if err := folder.Create(); err != nil { + t.Fatal(err) + } + } + + t.Cleanup(func() { + _ = UnscopedDb().Where("root = ? AND path IN (?)", RootOriginals, []string{pathMirror, pathEmoji, pathPumpkin, pathLink, pathFish}).Delete(Folder{}).Error + _ = UnscopedDb().Where("album_type = ? AND album_path IN (?)", AlbumFolder, []string{pathMirror, pathEmoji, pathPumpkin, pathLink, pathFish}).Delete(Album{}).Error + }) + + // Start from a stale collision state where a deep emoji-only folder has + // overwritten a sibling album outside its immediate parent subtree. + _ = UnscopedDb().Where("album_type = ? AND album_path IN (?)", AlbumFolder, []string{pathMirror, pathFish}).Delete(Album{}).Error + + stale := &Album{ + AlbumType: AlbumFolder, + AlbumSlug: legacyFolderAlbumSlug(pathMirror), + AlbumPath: pathMirror, + AlbumFilter: `path:"` + pathFish + `" public:true`, + CreatedAt: Now(), + UpdatedAt: Now(), + } + stale.SetTitle(folderFish.Title()) + + if err := stale.Create(); err != nil { + t.Fatal(err) + } + + reconciled, err := ReconcileOriginalsFolderAlbums(pathFish) + + if err != nil { + t.Fatal(err) + } + + assert.Equal(t, 5, reconciled) + + mirrorAlbum := FindFolderAlbum(pathMirror) + + if mirrorAlbum == nil { + t.Fatal("expected mirror folder album") + } + + fishAlbum := FindFolderAlbum(pathFish) + + if fishAlbum == nil { + t.Fatal("expected fish folder album") + } + + assert.Equal(t, folderMirror.Title(), mirrorAlbum.AlbumTitle) + assert.Equal(t, folderFish.Title(), fishAlbum.AlbumTitle) + assert.Equal(t, pathMirror, mirrorAlbum.AlbumPath) + assert.Equal(t, pathFish, fishAlbum.AlbumPath) + }) } diff --git a/internal/entity/label.go b/internal/entity/label.go index 657f51063..dd842128d 100644 --- a/internal/entity/label.go +++ b/internal/entity/label.go @@ -91,7 +91,7 @@ func NewLabel(name string, priority int) *Label { labelName = "Unknown" } - labelName = txt.Title(labelName) + labelName = normalizeLabelName(labelName) labelSlug := txt.Slug(labelName) result := &Label{ @@ -110,6 +110,10 @@ func (m *Label) Save() error { labelMutex.Lock() defer labelMutex.Unlock() + if err := ensureUniqueLabelSlugs(m); err != nil { + return err + } + return Db().Save(m).Error } @@ -129,6 +133,10 @@ func (m *Label) SaveForm(f *form.Label) error { } if m.SetName(f.LabelName) { + if err := ensureUniqueLabelSlugs(m); err != nil { + return err + } + return Db().Save(m).Error } else { return ErrInvalidName @@ -140,6 +148,10 @@ func (m *Label) Create() error { labelMutex.Lock() defer labelMutex.Unlock() + if err := ensureUniqueLabelSlugs(m); err != nil { + return err + } + return UnscopedDb().Create(m).Error } @@ -230,15 +242,18 @@ func FirstOrCreateLabel(m *Label) *Label { return nil } - result := &Label{} - - if err := UnscopedDb(). - Where("(custom_slug <> '' AND custom_slug = ? OR label_slug <> '' AND label_slug = ?)", m.CustomSlug, m.LabelSlug). - First(result).Error; err == nil { + if result := findLabelByExactName(m.LabelName); result != nil { return result - } else if createErr := m.Create(); createErr == nil { + } + + if err := ensureUniqueLabelSlugs(m); err != nil { + log.Errorf("label: %s (prepare %s)", err, clean.Log(m.LabelName)) + return nil + } + + if createErr := m.Create(); createErr == nil { if m.LabelPriority >= 0 { - event.EntitiesCreated("labels", []*Label{m}) + event.EntitiesCreated("labels", []string{m.LabelUID}) event.Publish("count.labels", event.Data{ "count": 1, @@ -246,9 +261,9 @@ func FirstOrCreateLabel(m *Label) *Label { } return m - } else if err = UnscopedDb(). - Where("(custom_slug <> '' AND custom_slug = ? OR label_slug <> '' AND label_slug = ?)", m.CustomSlug, m.LabelSlug). - First(result).Error; err == nil { + } else if result := findLabelByExactName(m.LabelName); result != nil { + return result + } else if result := findLabelBySlugValue(m.CustomSlug, 0); result != nil && sameLabelName(result.LabelName, m.LabelName) { return result } else { log.Errorf("label: %s (find or create %s)", createErr, m.LabelSlug) @@ -259,7 +274,7 @@ func FirstOrCreateLabel(m *Label) *Label { // SetName changes the label name. func (m *Label) SetName(name string) bool { - labelName := txt.Clip(clean.NameCapitalized(name), txt.ClipName) + labelName := normalizeLabelName(name) if labelName == "" { return false @@ -283,7 +298,7 @@ func (m *Label) SetName(name string) bool { // InvalidName checks if the label name is invalid. func (m *Label) InvalidName() bool { - labelName := txt.Clip(clean.NameCapitalized(m.LabelName), txt.ClipName) + labelName := normalizeLabelName(m.LabelName) if labelName == "" { return true diff --git a/internal/entity/label_cache.go b/internal/entity/label_cache.go index c3f9e4b8e..865be0de4 100644 --- a/internal/entity/label_cache.go +++ b/internal/entity/label_cache.go @@ -29,6 +29,24 @@ var ( photoLabelCacheMutex = sync.Mutex{} ) +// labelCacheNameKey returns the cache key for an exact label name lookup. +func labelCacheNameKey(name string) string { + if name == "" { + return "" + } + + return "name:" + name +} + +// labelCacheSlugKey returns the cache key for a label slug lookup. +func labelCacheSlugKey(slug string) string { + if slug == "" { + return "" + } + + return "slug:" + slug +} + // photoLabelCacheKey returns a string key for the photoLabelCache. func photoLabelCacheKey(photoId, labelId uint) string { return fmt.Sprintf("%d-%d", photoId, labelId) @@ -100,24 +118,29 @@ func FindLabel(name string, cached bool) (*Label, error) { return &Label{}, errors.New("missing label name") } - // Use the label slug as natural key cache. - cacheKey := txt.Slug(name) + labelName := normalizeLabelName(name) + slugKey := txt.Slug(name) + nameCacheKey := labelCacheNameKey(labelName) + slugCacheKey := labelCacheSlugKey(slugKey) - if cacheKey == "" { - return &Label{}, fmt.Errorf("invalid label slug %s", clean.LogQuote(cacheKey)) + if labelName == "" && slugKey == "" { + return &Label{}, fmt.Errorf("invalid label slug %s", clean.LogQuote(slugKey)) } // Return cached label, if found. if cached { - if cacheData, ok := labelCache.Get(cacheKey); ok { - log.Tracef("label: cache hit for %s", cacheKey) + for _, cacheKey := range []string{nameCacheKey, slugCacheKey} { + if cacheKey == "" { + continue + } + + if cacheData, ok := labelCache.Get(cacheKey); ok { + log.Tracef("label: cache hit for %s", cacheKey) + + if result := cacheData.(*Label); result.HasID() { + return result, nil + } - // Get cached data. - if result := cacheData.(*Label); result.HasID() { - // Return cached entity. - return result, nil - } else { - // Return cached "not found" error. return &Label{}, fmt.Errorf("label not found") } } @@ -126,14 +149,44 @@ func FindLabel(name string, cached bool) (*Label, error) { // Fetch and cache label. result := &Label{} - if find := Db().First(result, "(label_slug <> '' AND label_slug = ? OR custom_slug <> '' AND custom_slug = ?)", cacheKey, cacheKey); find.RecordNotFound() { - labelCache.Set(cacheKey, result, labelCacheErrorExpiration) + if labelName != "" { + if find := Db().First(result, "label_name = ?", labelName); find.Error == nil { + if nameCacheKey != "" { + labelCache.SetDefault(nameCacheKey, result) + } + if slugCacheKey != "" { + labelCache.SetDefault(slugCacheKey, result) + } + return result, nil + } + } + + if find := Db().First(result, "(label_slug <> '' AND label_slug = ? OR custom_slug <> '' AND custom_slug = ?)", slugKey, slugKey); find.RecordNotFound() { + if nameCacheKey != "" { + labelCache.Set(nameCacheKey, result, labelCacheErrorExpiration) + } + if slugCacheKey != "" { + labelCache.Set(slugCacheKey, result, labelCacheErrorExpiration) + } return result, fmt.Errorf("label not found") } else if find.Error != nil { - labelCache.Set(cacheKey, result, labelCacheErrorExpiration) + if nameCacheKey != "" { + labelCache.Set(nameCacheKey, result, labelCacheErrorExpiration) + } + if slugCacheKey != "" { + labelCache.Set(slugCacheKey, result, labelCacheErrorExpiration) + } return result, find.Error } else { - labelCache.SetDefault(result.LabelSlug, result) + if nameCacheKey != "" { + labelCache.SetDefault(nameCacheKey, result) + } + if result.LabelSlug != "" { + labelCache.SetDefault(labelCacheSlugKey(result.LabelSlug), result) + } + if result.CustomSlug != "" { + labelCache.SetDefault(labelCacheSlugKey(result.CustomSlug), result) + } } return result, nil diff --git a/internal/entity/label_cache_test.go b/internal/entity/label_cache_test.go index f58528fb5..6c5ca2597 100644 --- a/internal/entity/label_cache_test.go +++ b/internal/entity/label_cache_test.go @@ -37,6 +37,25 @@ func TestFindLabel(t *testing.T) { assert.Error(t, err) assert.NotNil(t, result) }) + t.Run("FindsExactNameBeforeHomophoneSlug", func(t *testing.T) { + first := FirstOrCreateLabel(NewLabel("问", 0)) + second := FirstOrCreateLabel(NewLabel("吻", 0)) + + if first == nil || second == nil { + t.Fatal("expected labels") + } + + t.Cleanup(func() { + _ = Db().Unscoped().Delete(second).Error + _ = Db().Unscoped().Delete(first).Error + FlushLabelCache() + }) + + result, err := FindLabel("吻", true) + assert.NoError(t, err) + assert.Equal(t, second.ID, result.ID) + assert.Equal(t, "吻", result.LabelName) + }) } func TestFindPhotoLabel(t *testing.T) { diff --git a/internal/entity/label_search.go b/internal/entity/label_search.go new file mode 100644 index 000000000..1fa575a6f --- /dev/null +++ b/internal/entity/label_search.go @@ -0,0 +1,376 @@ +package entity + +import ( + "fmt" + "strings" + + "github.com/jinzhu/inflection" + + "github.com/photoprism/photoprism/pkg/txt" +) + +// activeLabelByExactName finds an active label by exact name, falling back to a +// same-name slug match when only the slug lookup is stable across collations. +// A slug-only hit is also accepted when the candidate was renamed away from +// the queried name (see acceptLabelSlugMatch). +func activeLabelByExactName(name string) *Label { + name = normalizeLabelName(name) + + if name == "" { + return nil + } + + result := &Label{} + + if err := Db().Where("label_name = ?", name).First(result).Error; err == nil { + return result + } + + if candidate := activeLabelBySlugValue(txt.Slug(name)); acceptLabelSlugMatch(candidate, name) { + return candidate + } + + return nil +} + +// activeLabelBySlugValue finds an active label by label or custom slug. +func activeLabelBySlugValue(slugValue string) *Label { + if slugValue == "" { + return nil + } + + result := &Label{} + + if err := Db().Where("(custom_slug <> '' AND custom_slug = ? OR label_slug <> '' AND label_slug = ?)", slugValue, slugValue).First(result).Error; err != nil { + return nil + } + + return result +} + +// labelSlugTerms returns candidate slugs for a single search term. +func labelSlugTerms(term string) (result []string) { + term = strings.TrimSpace(term) + + if term == "" { + return result + } + + add := func(value string) { + if value == "" { + return + } + + for _, existing := range result { + if existing == value { + return + } + } + + result = append(result, value) + } + + add(txt.Slug(term)) + + if txt.ContainsASCIILetters(term) { + singular := inflection.Singular(term) + + if singular != term { + add(txt.Slug(singular)) + } + } + + return result +} + +// LabelSlugs returns unique candidate slugs for one or more search terms. +func LabelSlugs(search, sep string) (result []string) { + if search == "" { + return result + } else if sep == "" { + sep = " " + } + + add := func(value string) { + if value == "" { + return + } + + for _, existing := range result { + if existing == value { + return + } + } + + result = append(result, value) + } + + for raw := range strings.SplitSeq(search, sep) { + for _, slugValue := range labelSlugTerms(raw) { + add(slugValue) + } + } + + return result +} + +// FindLabels resolves active labels from raw names or slugs separated by sep. +func FindLabels(search, sep string) (Labels, error) { + if search == "" { + return nil, fmt.Errorf("missing label search") + } else if sep == "" { + sep = " " + } + + search = strings.TrimSpace(search) + + if (sep == " " || !strings.Contains(search, sep)) && search != "" { + if exact := activeLabelByExactName(search); exact != nil { + return Labels{*exact}, nil + } + } + + if !strings.Contains(search, sep) { + if exact := activeLabelBySlugValue(txt.Slug(search)); exact != nil { + return Labels{*exact}, nil + } + } + + var result Labels + seen := make(map[uint]struct{}, 8) + + add := func(label *Label) { + if label == nil || label.Deleted() { + return + } + + if _, ok := seen[label.ID]; ok { + return + } + + seen[label.ID] = struct{}{} + result = append(result, *label) + } + + for _, slugValue := range LabelSlugs(search, sep) { + add(activeLabelBySlugValue(slugValue)) + } + + for raw := range strings.SplitSeq(search, sep) { + raw = strings.TrimSpace(raw) + + if raw == "" || raw == search { + continue + } + + if sep == " " { + add(activeLabelByExactName(raw)) + } + + for _, slugValue := range labelSlugTerms(raw) { + add(activeLabelBySlugValue(slugValue)) + } + } + + if len(result) == 0 { + return nil, fmt.Errorf("label not found") + } + + return result, nil +} + +// FindLabelIDs resolves label IDs and optionally includes their category labels. +func FindLabelIDs(search, sep string, includeCategories bool) ([]uint, error) { + labels, err := FindLabels(search, sep) + if err != nil { + return nil, err + } + + result := make([]uint, 0, len(labels)) + seen := make(map[uint]struct{}, len(labels)) + + add := func(id uint) { + if id == 0 { + return + } + + if _, ok := seen[id]; ok { + return + } + + seen[id] = struct{}{} + result = append(result, id) + } + + for _, label := range labels { + add(label.ID) + } + + if !includeCategories || len(result) == 0 { + return result, nil + } + + var categories []Category + + if err := Db().Where("category_id IN (?)", result).Find(&categories).Error; err != nil { + return nil, err + } + + for _, category := range categories { + add(category.LabelID) + } + + return result, nil +} + +// ErrLabelNotFound reports that a positive label-filter AND group matched no +// known labels. Callers use this to short-circuit to an empty result set while +// still distinguishing the case from "only negative groups given". +var ErrLabelNotFound = fmt.Errorf("label not found") + +// unescapeLabelTerm decodes '\\', '\!', '\|', '\&' escape sequences in a single +// label search term to their literal characters. Escape sequences in front of +// other runes are preserved so existing escape-free terms are untouched. +func unescapeLabelTerm(s string) string { + if !strings.ContainsRune(s, txt.EscapeRune) { + return s + } + + var b strings.Builder + b.Grow(len(s)) + + escaped := false + + for _, r := range s { + if escaped { + switch r { + case '!', txt.OrRune, txt.AndRune, txt.EscapeRune: + b.WriteRune(r) + default: + b.WriteRune(txt.EscapeRune) + b.WriteRune(r) + } + + escaped = false + + continue + } + + if r == txt.EscapeRune { + escaped = true + + continue + } + + b.WriteRune(r) + } + + if escaped { + b.WriteRune(txt.EscapeRune) + } + + return b.String() +} + +// resolveLabelGroup unions the category-expanded label IDs for every '|' +// alternative in a single AND group, respecting escape sequences. +func resolveLabelGroup(group string) (ids []uint) { + alts := txt.TrimmedSplitWithEscape(group, txt.OrRune, txt.EscapeRune) + + if len(alts) == 0 { + return nil + } + + seen := make(map[uint]struct{}, len(alts)) + + add := func(id uint) { + if id == 0 { + return + } + + if _, ok := seen[id]; ok { + return + } + + seen[id] = struct{}{} + ids = append(ids, id) + } + + for _, alt := range alts { + alt = strings.TrimSpace(unescapeLabelTerm(alt)) + + if alt == "" { + continue + } + + altIDs, lookupErr := FindLabelIDs(alt, txt.Or, true) + if lookupErr != nil { + continue + } + + for _, id := range altIDs { + add(id) + } + } + + return ids +} + +// ParseLabelFilter splits a label filter into positive and negative groups of +// category-expanded label IDs. Each element of include is the OR-expanded ID +// set for one positive AND group (all positive groups must match); each element +// of exclude is the OR-expanded ID set for one negative AND group (none must +// match). A leading '!' on an AND group marks it as an exclusion; an escaped +// '\\!' is treated as a literal label-name character. sawPositive reports +// whether at least one positive group was parsed, so callers can distinguish +// "only negative groups" from "unknown positive label => empty result". An +// ErrLabelNotFound return means a positive group resolved to zero labels and +// the caller should short-circuit to an empty result set. +func ParseLabelFilter(s string) (include, exclude [][]uint, sawPositive bool, err error) { + s = strings.TrimSpace(s) + + if s == "" { + return nil, nil, false, nil + } + + groups := txt.TrimmedSplitWithEscape(s, txt.AndRune, txt.EscapeRune) + + for _, group := range groups { + group = strings.TrimSpace(group) + + if group == "" { + continue + } + + negate := strings.HasPrefix(group, "!") + + if negate { + group = strings.TrimSpace(group[1:]) + } + + if group == "" { + continue + } + + ids := resolveLabelGroup(group) + + if len(ids) == 0 { + if negate { + continue + } + + sawPositive = true + + return nil, nil, true, ErrLabelNotFound + } + + if negate { + exclude = append(exclude, ids) + } else { + sawPositive = true + include = append(include, ids) + } + } + + return include, exclude, sawPositive, nil +} diff --git a/internal/entity/label_search_test.go b/internal/entity/label_search_test.go new file mode 100644 index 000000000..f835e44c8 --- /dev/null +++ b/internal/entity/label_search_test.go @@ -0,0 +1,284 @@ +package entity + +import ( + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func TestActiveLabelByExactName(t *testing.T) { + t.Run("Empty", func(t *testing.T) { + assert.Nil(t, activeLabelByExactName("")) + }) + t.Run("ResolvesRenamedLabelByPreviousName", func(t *testing.T) { + original := FirstOrCreateLabel(NewLabel("RenameAxnA", 0)) + require.NotNil(t, original) + + t.Cleanup(func() { + _ = Db().Unscoped().Delete(original).Error + FlushLabelCache() + }) + + require.True(t, original.SetName("RenameAxnB")) + require.NoError(t, Db().Save(original).Error) + FlushLabelCache() + + got := activeLabelByExactName("RenameAxnA") + require.NotNil(t, got) + assert.Equal(t, original.ID, got.ID) + assert.Equal(t, "RenameAxnB", got.LabelName) + }) + t.Run("DoesNotMergeHomophones", func(t *testing.T) { + first := FirstOrCreateLabel(NewLabel("问", 0)) + require.NotNil(t, first) + + t.Cleanup(func() { + _ = Db().Unscoped().Delete(first).Error + FlushLabelCache() + }) + + // "吻" slugifies to the same value as "问" but does not yet exist; + // activeLabelByExactName must not return the existing "问" row for it. + got := activeLabelByExactName("吻") + assert.Nil(t, got) + }) +} + +func TestLabelSlugs(t *testing.T) { + t.Run("PipeSeparated", func(t *testing.T) { + assert.Equal(t, []string{"cake", "flower"}, LabelSlugs("cake|flower", "|")) + }) + t.Run("IncludesSingularASCIIForms", func(t *testing.T) { + assert.Equal(t, []string{"cats", "cat", "dogs", "dog"}, LabelSlugs("cats dogs", " ")) + }) + t.Run("DeduplicatesRepeatedSlugs", func(t *testing.T) { + assert.Equal(t, []string{"cake"}, LabelSlugs("cake cake", " ")) + }) +} + +func TestFindLabels(t *testing.T) { + t.Run("FindsExistingNameIgnoringCase", func(t *testing.T) { + labels, err := FindLabels("cow", " ") + require.NoError(t, err) + require.Len(t, labels, 1) + assert.Equal(t, LabelFixtures.Get("cow").ID, labels[0].ID) + }) + t.Run("FindsExactHomophoneName", func(t *testing.T) { + first := FirstOrCreateLabel(NewLabel("问", 0)) + second := FirstOrCreateLabel(NewLabel("吻", 0)) + + require.NotNil(t, first) + require.NotNil(t, second) + + t.Cleanup(func() { + _ = Db().Unscoped().Delete(second).Error + _ = Db().Unscoped().Delete(first).Error + FlushLabelCache() + }) + + labels, err := FindLabels("吻", " ") + require.NoError(t, err) + require.Len(t, labels, 1) + assert.Equal(t, second.ID, labels[0].ID) + assert.Equal(t, "吻", labels[0].LabelName) + }) + t.Run("ResolvesRenamedLabelByPreviousNameEndToEnd", func(t *testing.T) { + // Integration check: searching by an old name yields the renamed + // row. FindLabels has multiple slug fallbacks of its own; the + // activeLabelByExactName branch is pinned directly by + // TestActiveLabelByExactName/ResolvesRenamedLabelByPreviousName. + original := FirstOrCreateLabel(NewLabel("RenameDog", 0)) + require.NotNil(t, original) + + t.Cleanup(func() { + _ = Db().Unscoped().Delete(original).Error + FlushLabelCache() + }) + + require.True(t, original.SetName("RenameHund")) + require.NoError(t, Db().Save(original).Error) + FlushLabelCache() + + labels, err := FindLabels("RenameDog", " ") + require.NoError(t, err) + require.Len(t, labels, 1) + assert.Equal(t, original.ID, labels[0].ID) + assert.Equal(t, "RenameHund", labels[0].LabelName) + }) + t.Run("PreservesPipeSeparatorSemantics", func(t *testing.T) { + labels, err := FindLabels("potato|couch", "|") + assert.Error(t, err) + assert.Empty(t, labels) + }) + t.Run("MatchesTrailingPipeSlug", func(t *testing.T) { + labels, err := FindLabels("mall|", "|") + require.NoError(t, err) + require.Len(t, labels, 1) + assert.Equal(t, LabelFixtures.Get("mall|").ID, labels[0].ID) + }) +} + +func TestFindLabelIDs(t *testing.T) { + t.Run("WithoutCategories", func(t *testing.T) { + labelIDs, err := FindLabelIDs("landscape", " ", false) + require.NoError(t, err) + assert.Equal(t, []uint{LabelFixtures.Get("landscape").ID}, labelIDs) + }) + t.Run("IncludesCategories", func(t *testing.T) { + labelIDs, err := FindLabelIDs("landscape", " ", true) + require.NoError(t, err) + assert.Contains(t, labelIDs, LabelFixtures.Get("landscape").ID) + assert.Contains(t, labelIDs, LabelFixtures.Get("flower").ID) + assert.Len(t, labelIDs, 2) + }) +} + +func TestUnescapeLabelTerm(t *testing.T) { + t.Run("Empty", func(t *testing.T) { + assert.Equal(t, "", unescapeLabelTerm("")) + }) + t.Run("WithoutEscape", func(t *testing.T) { + assert.Equal(t, "cake", unescapeLabelTerm("cake")) + }) + t.Run("EscapedOperators", func(t *testing.T) { + assert.Equal(t, "!weird", unescapeLabelTerm(`\!weird`)) + assert.Equal(t, "cat&dog", unescapeLabelTerm(`cat\&dog`)) + assert.Equal(t, "a|b", unescapeLabelTerm(`a\|b`)) + assert.Equal(t, `a\b`, unescapeLabelTerm(`a\\b`)) + }) + t.Run("UnknownEscapePreserved", func(t *testing.T) { + assert.Equal(t, `a\bc`, unescapeLabelTerm(`a\bc`)) + }) + t.Run("TrailingEscapePreserved", func(t *testing.T) { + assert.Equal(t, `a\`, unescapeLabelTerm(`a\`)) + }) +} + +func TestResolveLabelGroup(t *testing.T) { + t.Run("SingleExact", func(t *testing.T) { + ids := resolveLabelGroup("cake") + assert.Equal(t, []uint{LabelFixtures.Get("cake").ID}, ids) + }) + t.Run("OrAlternatives", func(t *testing.T) { + ids := resolveLabelGroup("cake|cow") + assert.Contains(t, ids, LabelFixtures.Get("cake").ID) + assert.Contains(t, ids, LabelFixtures.Get("cow").ID) + }) + t.Run("CategoryExpansion", func(t *testing.T) { + ids := resolveLabelGroup("landscape") + assert.Contains(t, ids, LabelFixtures.Get("landscape").ID) + assert.Contains(t, ids, LabelFixtures.Get("flower").ID) + }) + t.Run("UnknownReturnsEmpty", func(t *testing.T) { + assert.Empty(t, resolveLabelGroup("totally-unknown-label-name")) + }) + t.Run("EscapedAmpersandName", func(t *testing.T) { + ids := resolveLabelGroup(`construction\&failure`) + assert.Equal(t, []uint{LabelFixtures.Get("construction&failure").ID}, ids) + }) +} + +func TestParseLabelFilter(t *testing.T) { + cakeID := LabelFixtures.Get("cake").ID + cowID := LabelFixtures.Get("cow").ID + flowerID := LabelFixtures.Get("flower").ID + landscapeID := LabelFixtures.Get("landscape").ID + + t.Run("Empty", func(t *testing.T) { + include, exclude, sawPositive, err := ParseLabelFilter("") + require.NoError(t, err) + assert.False(t, sawPositive) + assert.Empty(t, include) + assert.Empty(t, exclude) + }) + t.Run("SinglePositive", func(t *testing.T) { + include, exclude, sawPositive, err := ParseLabelFilter("cake") + require.NoError(t, err) + assert.True(t, sawPositive) + require.Len(t, include, 1) + assert.Equal(t, []uint{cakeID}, include[0]) + assert.Empty(t, exclude) + }) + t.Run("SingleNegative", func(t *testing.T) { + include, exclude, sawPositive, err := ParseLabelFilter("!cake") + require.NoError(t, err) + assert.False(t, sawPositive) + assert.Empty(t, include) + require.Len(t, exclude, 1) + assert.Equal(t, []uint{cakeID}, exclude[0]) + }) + t.Run("IncludeAndExclude", func(t *testing.T) { + include, exclude, sawPositive, err := ParseLabelFilter("cake&!flower") + require.NoError(t, err) + assert.True(t, sawPositive) + require.Len(t, include, 1) + assert.Equal(t, []uint{cakeID}, include[0]) + require.Len(t, exclude, 1) + assert.Equal(t, []uint{flowerID}, exclude[0]) + }) + t.Run("MultipleIncludes", func(t *testing.T) { + include, exclude, sawPositive, err := ParseLabelFilter("cake&cow") + require.NoError(t, err) + assert.True(t, sawPositive) + require.Len(t, include, 2) + assert.Equal(t, []uint{cakeID}, include[0]) + assert.Equal(t, []uint{cowID}, include[1]) + assert.Empty(t, exclude) + }) + t.Run("OrWithinPositiveGroup", func(t *testing.T) { + include, _, sawPositive, err := ParseLabelFilter("cake|cow") + require.NoError(t, err) + assert.True(t, sawPositive) + require.Len(t, include, 1) + assert.ElementsMatch(t, []uint{cakeID, cowID}, include[0]) + }) + t.Run("UnknownPositiveShortCircuits", func(t *testing.T) { + _, _, sawPositive, err := ParseLabelFilter("cake&totally-unknown-label") + assert.ErrorIs(t, err, ErrLabelNotFound) + assert.True(t, sawPositive) + }) + t.Run("UnknownNegativeIsNoOp", func(t *testing.T) { + include, exclude, sawPositive, err := ParseLabelFilter("cake&!totally-unknown-label") + require.NoError(t, err) + assert.True(t, sawPositive) + require.Len(t, include, 1) + assert.Empty(t, exclude) + }) + t.Run("NegativeCategoryExpansion", func(t *testing.T) { + _, exclude, _, err := ParseLabelFilter("!landscape") + require.NoError(t, err) + require.Len(t, exclude, 1) + assert.Contains(t, exclude[0], landscapeID) + assert.Contains(t, exclude[0], flowerID) + }) + t.Run("EscapedLeadingBang", func(t *testing.T) { + // A leading \! is a literal label name. No label named "!weird" + // exists in fixtures, so the lookup short-circuits. + _, _, sawPositive, err := ParseLabelFilter(`\!weird`) + assert.ErrorIs(t, err, ErrLabelNotFound) + assert.True(t, sawPositive) + }) + t.Run("NegatedEscapedBang", func(t *testing.T) { + // "!\!weird" = NOT a label literally named "!weird"; unknown negative is a no-op. + include, exclude, sawPositive, err := ParseLabelFilter(`!\!weird`) + require.NoError(t, err) + assert.False(t, sawPositive) + assert.Empty(t, include) + assert.Empty(t, exclude) + }) + t.Run("EscapedAmpersandName", func(t *testing.T) { + include, _, sawPositive, err := ParseLabelFilter(`construction\&failure`) + require.NoError(t, err) + assert.True(t, sawPositive) + require.Len(t, include, 1) + assert.Equal(t, []uint{LabelFixtures.Get("construction&failure").ID}, include[0]) + }) + t.Run("LoneBangDropped", func(t *testing.T) { + include, exclude, sawPositive, err := ParseLabelFilter("!") + require.NoError(t, err) + assert.False(t, sawPositive) + assert.Empty(t, include) + assert.Empty(t, exclude) + }) +} diff --git a/internal/entity/label_slug.go b/internal/entity/label_slug.go new file mode 100644 index 000000000..25dbc83c6 --- /dev/null +++ b/internal/entity/label_slug.go @@ -0,0 +1,182 @@ +package entity + +import ( + "crypto/sha256" + "fmt" + "strings" + + "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/txt" +) + +// normalizeLabelName returns the canonical label name used for comparisons and lookups. +func normalizeLabelName(name string) string { + return txt.Clip(clean.NameCapitalized(name), txt.ClipName) +} + +// sameLabelName reports whether two label names normalize to the same value +// when compared case-insensitively. +func sameLabelName(a, b string) bool { + a = normalizeLabelName(a) + b = normalizeLabelName(b) + + if a == "" || b == "" { + return false + } + + return strings.EqualFold(a, b) +} + +// findLabelByExactName looks up a label by its canonical name, including soft-deleted rows. +func findLabelByExactName(name string) *Label { + name = normalizeLabelName(name) + + if name == "" { + return nil + } + + result := &Label{} + + if err := UnscopedDb().Where("label_name = ?", name).First(result).Error; err != nil { + if candidate := findLabelBySlugValue(txt.Slug(name), 0); candidate != nil && acceptLabelSlugMatch(candidate, name) { + return candidate + } + + return nil + } + + return result +} + +// acceptLabelSlugMatch reports whether a slug-based hit resolves to the queried +// name: canonical names match (homophone-safe), or the candidate was renamed +// away (immutable LabelSlug holds the old slug, CustomSlug holds the new one). +// LabelSlug == CustomSlug is excluded so first-created homophones don't match. +func acceptLabelSlugMatch(candidate *Label, name string) bool { + if candidate == nil { + return false + } + + if sameLabelName(candidate.LabelName, name) { + return true + } + + queriedSlug := txt.Slug(name) + + if queriedSlug == "" { + return false + } + + return candidate.LabelSlug == queriedSlug && candidate.CustomSlug != queriedSlug +} + +// findLabelBySlugValue looks up a label by label or custom slug, including soft-deleted rows. +func findLabelBySlugValue(slugValue string, excludeID uint) *Label { + if slugValue == "" { + return nil + } + + result := &Label{} + stmt := UnscopedDb().Where("(custom_slug <> '' AND custom_slug = ? OR label_slug <> '' AND label_slug = ?)", slugValue, slugValue) + + if excludeID > 0 { + stmt = stmt.Where("id <> ?", excludeID) + } + + if err := stmt.First(result).Error; err != nil { + return nil + } + + return result +} + +// uniqueLabelSlug returns a deterministic collision-safe slug for a label name. +func uniqueLabelSlug(baseSlug, labelName string, attempt int) string { + hashInput := labelName + + if attempt > 0 { + hashInput = fmt.Sprintf("%s#%d", labelName, attempt) + } + + hash := sha256.Sum256([]byte(hashInput)) + suffix := fmt.Sprintf("%x", hash[:4]) + prefixLen := txt.ClipSlug - len(suffix) - 1 + + if prefixLen <= 0 { + return txt.Clip(baseSlug, txt.ClipSlug) + } + + prefix := txt.Clip(baseSlug, prefixLen) + + for len(prefix) > 0 && prefix[len(prefix)-1] == '-' { + prefix = prefix[:len(prefix)-1] + } + + if prefix == "" { + return txt.Clip(baseSlug, txt.ClipSlug) + } + + return prefix + "-" + suffix +} + +// ensureUniqueLabelSlugs updates label and custom slugs so distinct names do not reuse an existing slug. +func ensureUniqueLabelSlugs(m *Label) error { + if m == nil { + return ErrInvalidName + } + + labelName := normalizeLabelName(m.LabelName) + + if labelName == "" { + return ErrInvalidName + } + + baseSlug := m.CustomSlug + + if baseSlug == "" { + baseSlug = m.LabelSlug + } + + if baseSlug == "" { + baseSlug = txt.Slug(labelName) + } + + if baseSlug == "" { + return ErrInvalidName + } + + m.LabelName = labelName + + if m.CustomSlug == "" { + m.CustomSlug = baseSlug + } + + if m.LabelSlug == "" { + m.LabelSlug = m.CustomSlug + } + + conflict := findLabelBySlugValue(m.CustomSlug, m.ID) + + if conflict == nil || sameLabelName(conflict.LabelName, labelName) { + return nil + } + + uniqueSlug := "" + + for attempt := 0; ; attempt++ { + uniqueSlug = uniqueLabelSlug(baseSlug, labelName, attempt) + taken := findLabelBySlugValue(uniqueSlug, m.ID) + + if taken == nil || sameLabelName(taken.LabelName, labelName) { + break + } + } + + if !m.HasID() || m.LabelSlug == baseSlug || m.LabelSlug == m.CustomSlug { + m.LabelSlug = uniqueSlug + } + + m.CustomSlug = uniqueSlug + + return nil +} diff --git a/internal/entity/label_slug_test.go b/internal/entity/label_slug_test.go new file mode 100644 index 000000000..3acaf60b8 --- /dev/null +++ b/internal/entity/label_slug_test.go @@ -0,0 +1,35 @@ +package entity + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestAcceptLabelSlugMatch(t *testing.T) { + t.Run("Nil", func(t *testing.T) { + assert.False(t, acceptLabelSlugMatch(nil, "Cat")) + }) + t.Run("EmptyQuery", func(t *testing.T) { + candidate := &Label{LabelName: "Cat", LabelSlug: "cat", CustomSlug: "cat"} + assert.False(t, acceptLabelSlugMatch(candidate, "")) + }) + t.Run("SameName", func(t *testing.T) { + candidate := &Label{LabelName: "Cat", LabelSlug: "cat", CustomSlug: "cat"} + assert.True(t, acceptLabelSlugMatch(candidate, "cat")) + }) + t.Run("RenamedAwayFromQueriedName", func(t *testing.T) { + candidate := &Label{LabelName: "Katze", LabelSlug: "cat", CustomSlug: "katze"} + assert.True(t, acceptLabelSlugMatch(candidate, "Cat")) + }) + t.Run("HomophoneNotRenamed", func(t *testing.T) { + // First-created homophone has LabelSlug == CustomSlug; a query for + // a different name that slugifies the same must not be accepted. + candidate := &Label{LabelName: "问", LabelSlug: "wen", CustomSlug: "wen"} + assert.False(t, acceptLabelSlugMatch(candidate, "吻")) + }) + t.Run("DifferentNameAndDifferentSlug", func(t *testing.T) { + candidate := &Label{LabelName: "Other", LabelSlug: "other", CustomSlug: "other"} + assert.False(t, acceptLabelSlugMatch(candidate, "Cat")) + }) +} diff --git a/internal/entity/label_test.go b/internal/entity/label_test.go index 2e7c2b9f9..3bb181f3e 100644 --- a/internal/entity/label_test.go +++ b/internal/entity/label_test.go @@ -6,8 +6,11 @@ import ( "time" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + "github.com/photoprism/photoprism/internal/event" + "github.com/photoprism/photoprism/internal/ai/classify" "github.com/photoprism/photoprism/internal/form" "github.com/photoprism/photoprism/pkg/rnd" @@ -172,20 +175,102 @@ func TestLabel_GetSlug(t *testing.T) { } func TestFirstOrCreateLabel(t *testing.T) { - label := LabelFixtures.Get("flower") - result := FirstOrCreateLabel(&label) + t.Run("Existing", func(t *testing.T) { + label := LabelFixtures.Get("flower") + result := FirstOrCreateLabel(&label) - if result == nil { - t.Fatal("result must not be nil") - } + if result == nil { + t.Fatal("result must not be nil") + } - if result.LabelName != label.LabelName { - t.Errorf("LabelName should be the same: %s %s", result.LabelName, label.LabelName) - } + if result.LabelName != label.LabelName { + t.Errorf("LabelName should be the same: %s %s", result.LabelName, label.LabelName) + } - if result.LabelSlug != label.LabelSlug { - t.Errorf("LabelName should be the same: %s %s", result.LabelSlug, label.LabelSlug) - } + if result.LabelSlug != label.LabelSlug { + t.Errorf("LabelName should be the same: %s %s", result.LabelSlug, label.LabelSlug) + } + }) + t.Run("MatchesExistingNameIgnoringCase", func(t *testing.T) { + result := FirstOrCreateLabel(NewLabel("cow", 0)) + + if result == nil { + t.Fatal("result must not be nil") + } + + assert.Equal(t, LabelFixtures.Get("cow").ID, result.ID) + assert.Equal(t, "cow", result.LabelSlug) + }) + t.Run("CreatesDistinctHomophoneLabels", func(t *testing.T) { + first := FirstOrCreateLabel(NewLabel("问", 0)) + second := FirstOrCreateLabel(NewLabel("吻", 0)) + + if first == nil || second == nil { + t.Fatal("expected labels") + } + + t.Cleanup(func() { + _ = Db().Unscoped().Delete(second).Error + _ = Db().Unscoped().Delete(first).Error + }) + + assert.Equal(t, "问", first.LabelName) + assert.Equal(t, "吻", second.LabelName) + assert.NotEqual(t, first.ID, second.ID) + assert.Equal(t, "wen", first.LabelSlug) + assert.Contains(t, second.LabelSlug, "wen-") + assert.NotEqual(t, first.LabelSlug, second.LabelSlug) + assert.Equal(t, first.LabelSlug, first.CustomSlug) + assert.Equal(t, second.LabelSlug, second.CustomSlug) + }) + t.Run("PublishesUidOnlyCreatedEvent", func(t *testing.T) { + sub := event.Subscribe("labels.created") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + result := FirstOrCreateLabel(NewLabel("UidOnlyEventLabel", 0)) + require.NotNil(t, result) + + t.Cleanup(func() { + _ = Db().Unscoped().Delete(result).Error + FlushLabelCache() + }) + + select { + case msg := <-sub.Receiver: + uids, ok := msg.Fields["entities"].([]string) + assert.True(t, ok, "entities payload should be []string, got %T", msg.Fields["entities"]) + assert.Equal(t, []string{result.LabelUID}, uids) + case <-time.After(2 * time.Second): + t.Fatal("expected one labels.created event") + } + }) + t.Run("ReusesRenamedLabelByPreviousName", func(t *testing.T) { + original := FirstOrCreateLabel(NewLabel("RenameCat", 0)) + require.NotNil(t, original) + + t.Cleanup(func() { + _ = Db().Unscoped().Delete(original).Error + FlushLabelCache() + }) + + require.True(t, original.SetName("RenameKatze")) + require.NoError(t, Db().Save(original).Error) + FlushLabelCache() + + assert.Equal(t, "renamecat", original.LabelSlug) + assert.Equal(t, "renamekatze", original.CustomSlug) + + again := FirstOrCreateLabel(NewLabel("RenameCat", 0)) + require.NotNil(t, again) + assert.Equal(t, original.ID, again.ID) + assert.Equal(t, "RenameKatze", again.LabelName) + + var rows []Label + require.NoError(t, UnscopedDb(). + Where("label_slug LIKE ? OR custom_slug LIKE ?", "renamecat%", "renamecat%"). + Find(&rows).Error) + assert.Len(t, rows, 1, "rename + re-add must not create a duplicate") + }) } func TestLabel_UpdateClassify(t *testing.T) { @@ -271,6 +356,28 @@ func TestLabel_Update(t *testing.T) { }) } +func TestLabel_SaveForm_CollidingSlug(t *testing.T) { + base := FirstOrCreateLabel(NewLabel("问", 0)) + other := createTestLabel(t, "save-form-collision") + + if base == nil { + t.Fatal("expected base label") + } + + t.Cleanup(func() { + _ = Db().Unscoped().Delete(base).Error + }) + + originalSlug := other.LabelSlug + frm := &form.Label{LabelName: "吻"} + require.NoError(t, other.SaveForm(frm)) + + assert.Equal(t, "吻", other.LabelName) + assert.Equal(t, originalSlug, other.LabelSlug) + assert.NotEqual(t, "wen", other.CustomSlug) + assert.Contains(t, other.CustomSlug, "wen-") +} + func TestLabel_Updates(t *testing.T) { t.Run("Success", func(t *testing.T) { label := createTestLabel(t, "updates") diff --git a/internal/entity/legacy/legacy.go b/internal/entity/legacy/legacy.go index 6262f09c6..8ab71c7d3 100644 --- a/internal/entity/legacy/legacy.go +++ b/internal/entity/legacy/legacy.go @@ -1,7 +1,7 @@ /* Package legacy provides legacy entity models to be used in migrations. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/entity/lens.go b/internal/entity/lens.go index 0fae6ca5b..14344f04b 100644 --- a/internal/entity/lens.go +++ b/internal/entity/lens.go @@ -1,11 +1,15 @@ package entity import ( + "fmt" "strings" "sync" "time" + "github.com/ulule/deepcopier" + "github.com/photoprism/photoprism/internal/event" + "github.com/photoprism/photoprism/internal/form" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/txt" ) @@ -35,6 +39,7 @@ func (Lens) TableName() string { return "lenses" } +// UnknownLens is the placeholder used when no lens make or model is known. var UnknownLens = Lens{ LensSlug: UnknownID, LensName: "Unknown", @@ -120,7 +125,8 @@ func FirstOrCreateLens(m *Lens) *Lens { return &result } else if err := m.Create(); err == nil { if !m.Unknown() { - event.EntitiesCreated("lenses", []*Lens{m}) + // Content channels carry only stable identities, never entity fields; publish the slug. + event.EntitiesCreated("lenses", []string{m.LensSlug}) event.Publish("count.lenses", event.Data{ "count": 1, @@ -153,3 +159,53 @@ func (m *Lens) String() string { func (m *Lens) Unknown() bool { return m.LensSlug == "" || m.LensSlug == UnknownLens.LensSlug } + +// UpdateMakeModel updates the make and model of an existing lens, e.g. to fix Pentax models that +// ExifTool decodes as a numeric "4 38". +// The lens slug is intentionally left unchanged so existing photo references and the unique slug +// index are preserved across renames. +func (m *Lens) UpdateMakeModel(makeName, modelName string) error { + if m.ID == 0 { + return fmt.Errorf("empty id") + } + + makeName = strings.TrimSpace(makeName) + modelName = strings.TrimSpace(modelName) + + if makeName == "" || modelName == "" { + return fmt.Errorf("make and model must not be empty") + } + + l := NewLens(makeName, modelName) + // Override the changeable fields. + m.LensMake = l.LensMake + m.LensModel = l.LensModel + m.LensName = l.LensName + + lensMutex.Lock() + defer lensMutex.Unlock() + if err := Db().Save(m).Error; err != nil { + return err + } else { + if !m.Unknown() { + event.EntitiesUpdated("lenses", []string{m.LensSlug}) + } + lensCache.SetDefault(m.LensSlug, m) + } + return nil +} + +// SaveForm validates the form, copies its data into the lens, and persists it. +func (m *Lens) SaveForm(f *form.Lens) error { + if f == nil { + return fmt.Errorf("form is nil") + } else if err := f.Validate(); err != nil { + return err + } + + if err := deepcopier.Copy(m).From(f); err != nil { + return err + } + + return m.UpdateMakeModel(f.LensMake, f.LensModel) +} diff --git a/internal/entity/lens_cache.go b/internal/entity/lens_cache.go index b24cde872..28ac9b2c8 100644 --- a/internal/entity/lens_cache.go +++ b/internal/entity/lens_cache.go @@ -8,6 +8,7 @@ import ( var lensCache = gc.New(time.Hour, 15*time.Minute) +// FlushLensCache removes all cached lenses. func FlushLensCache() { lensCache.Flush() } diff --git a/internal/entity/lens_fixtures.go b/internal/entity/lens_fixtures.go index 64201b468..d43af84bf 100644 --- a/internal/entity/lens_fixtures.go +++ b/internal/entity/lens_fixtures.go @@ -22,6 +22,7 @@ func (m LensMap) Pointer(name string) *Lens { return NewLens("", name) } +// LensFixtures holds the set of test fixtures for Lenses var LensFixtures = LensMap{ "lens-f-380": { ID: 1000000, @@ -38,10 +39,10 @@ var LensFixtures = LensMap{ }, "4.15mm-f/2.2": { ID: 1000001, - LensSlug: "4.15mm-f/2.2", - LensName: "Apple iPhone SE back camera 4.15mm f/2.2", + LensSlug: "apple-iphone-se-4-15mm-f-2-2", + LensName: "Apple iPhone SE 4.15mm f/2.2", LensMake: "Apple", - LensModel: "iPhone SE back camera 4.15mm f/2.2", + LensModel: "iPhone SE 4.15mm f/2.2", LensType: "", LensDescription: "", LensNotes: "Notes", @@ -49,7 +50,19 @@ var LensFixtures = LensMap{ UpdatedAt: time.Date(2019, 1, 1, 0, 0, 0, 0, time.UTC), DeletedAt: nil, }, -} + "4-37": { + ID: 1000002, + LensSlug: "4-37", + LensName: "4 37", + LensMake: "", + LensModel: "4 37", + LensType: "", + LensDescription: "", + LensNotes: "", + CreatedAt: time.Date(2026, 06, 12, 10, 0, 0, 0, time.UTC), + UpdatedAt: time.Date(2026, 06, 12, 10, 0, 0, 0, time.UTC), + DeletedAt: nil, + }} // CreateLensFixtures inserts known entities into the database for testing. func CreateLensFixtures() { diff --git a/internal/entity/lens_test.go b/internal/entity/lens_test.go index 3db863ef5..cfc5054fd 100644 --- a/internal/entity/lens_test.go +++ b/internal/entity/lens_test.go @@ -2,8 +2,12 @@ package entity import ( "testing" + "time" "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/event" + "github.com/photoprism/photoprism/internal/form" ) func TestNewLens(t *testing.T) { @@ -67,12 +71,34 @@ func TestLens_String(t *testing.T) { func TestFirstOrCreateLens(t *testing.T) { t.Run("ExistingLens", func(t *testing.T) { - lens := NewLens("Apple", "iPhone SE") + fixture := "4.15mm-f/2.2" + lens := NewLens(LensFixtures.Get(fixture).LensMake, "iPhone SE back camera 4.15mm f/2.2") // Use value that comes back from exiftool result := FirstOrCreateLens(lens) - if result == nil { - t.Fatal("result must not be nil") + assert.NotNil(t, result) + if result != nil { + assert.Equal(t, LensFixtures.Get(fixture).ID, result.ID) + assert.Equal(t, LensFixtures.Get(fixture).LensMake, result.LensMake) + assert.Equal(t, LensFixtures.Get(fixture).LensModel, result.LensModel) + assert.Equal(t, LensFixtures.Get(fixture).LensSlug, result.LensSlug) + assert.Equal(t, LensFixtures.Get(fixture).LensName, result.LensName) + } + }) + t.Run("ExistingLensWithOnlyModel", func(t *testing.T) { + // This tests the Pentax lens situation + fixture := "4-37" + lens := NewLens(LensFixtures.Get(fixture).LensMake, LensFixtures.Get(fixture).LensModel) + + result := FirstOrCreateLens(lens) + + assert.NotNil(t, result) + if result != nil { + assert.Equal(t, LensFixtures.Get(fixture).ID, result.ID) + assert.Equal(t, LensFixtures.Get(fixture).LensMake, result.LensMake) + assert.Equal(t, LensFixtures.Get(fixture).LensModel, result.LensModel) + assert.Equal(t, LensFixtures.Get(fixture).LensSlug, result.LensSlug) + assert.Equal(t, LensFixtures.Get(fixture).LensName, result.LensName) } }) t.Run("NotExistingLens", func(t *testing.T) { @@ -86,3 +112,144 @@ func TestFirstOrCreateLens(t *testing.T) { assert.GreaterOrEqual(t, result.ID, uint(1)) }) } + +func TestLensUpdateMakeModel(t *testing.T) { + t.Run("ExistingLens", func(t *testing.T) { + fixture := "4-37" + lens := NewLens(LensFixtures.Get(fixture).LensMake, LensFixtures.Get(fixture).LensModel) + + result := FirstOrCreateLens(lens) + + defer assert.NoError(t, UnscopedDb().Save(LensFixtures.Pointer(fixture)).Error) + make := "Tamron" + model := "Tamron SP AF 24-135mm F3.5-5.6 AD AL (190D)" + err := result.UpdateMakeModel(make, model) + assert.NoError(t, err) + assert.Equal(t, LensFixtures.Get(fixture).ID, result.ID) + assert.Equal(t, make, result.LensMake) + assert.Equal(t, "SP AF 24-135mm F3.5-5.6 AD AL (190D)", result.LensModel) // NewLens strips Tamron from model to prevent double up in name + assert.Equal(t, LensFixtures.Get(fixture).LensSlug, result.LensSlug) + assert.Equal(t, model, result.LensName) // NewLens prevents Tamron Tamron ... as name + }) + t.Run("NewLens", func(t *testing.T) { + setup := NewLens("", "4 38") + lens := FirstOrCreateLens(setup) + defer assert.NoError(t, UnscopedDb().Delete(&Lens{}, "id = ?", lens.ID).Error) + make := "Pentax" + model := "smc PENTAX-FA 28-105mm F3.2-4.5 AL[IF]" + err := lens.UpdateMakeModel(make, model) + assert.NoError(t, err) + assert.Equal(t, CameraMakes[make], lens.LensMake) + assert.Equal(t, model, lens.LensModel) + assert.Equal(t, "4-38", lens.LensSlug) + assert.Equal(t, "PENTAX smc PENTAX-FA 28-105mm F3.2-4.5 AL[IF]", lens.LensName) + }) + t.Run("NotExistingLens", func(t *testing.T) { + lens := NewLens("", "4 39") + err := lens.UpdateMakeModel("Pentax", "smc PENTAX-FA 31mm F1.8 AL Limited") + assert.Error(t, err) + }) + t.Run("EmptyMake", func(t *testing.T) { + lens := &Lens{ID: LensFixtures.Get("lens-f-380").ID, LensMake: "Apple", LensModel: "F380", LensName: "Apple F380", LensSlug: "lens-f-380"} + err := lens.UpdateMakeModel(" ", "F380") + assert.Error(t, err) + // The guard returns before any mutation, so existing values must be untouched. + assert.Equal(t, "Apple", lens.LensMake) + assert.Equal(t, "F380", lens.LensModel) + }) + t.Run("EmptyModel", func(t *testing.T) { + lens := &Lens{ID: LensFixtures.Get("lens-f-380").ID, LensMake: "Apple", LensModel: "F380", LensName: "Apple F380", LensSlug: "lens-f-380"} + err := lens.UpdateMakeModel("Apple", "") + assert.Error(t, err) + assert.Equal(t, "Apple", lens.LensMake) + assert.Equal(t, "F380", lens.LensModel) + }) +} + +// TestLens_EntityEvents pins the lens content-channel payloads to the UID-only +// invariant: lenses.created/updated carry a []string of stable slugs, never entity +// fields, and an update does not republish the lens count. +func TestLens_EntityEvents(t *testing.T) { + t.Run("CreatedPublishesSlugOnly", func(t *testing.T) { + m := NewLens("Acme", "Test Lens 6789") + + // Force the create branch to fire regardless of prior runs, -count>1, or cache state. + removeTestLens := func() { + lensCache.Delete(m.LensSlug) + assert.NoError(t, UnscopedDb().Delete(&Lens{}, "lens_slug = ?", m.LensSlug).Error) + } + removeTestLens() + t.Cleanup(removeTestLens) + + sub := event.Subscribe("lenses.created") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + lens := FirstOrCreateLens(m) + + if lens == nil { + t.Fatal("result must not be nil") + } + + select { + case msg := <-sub.Receiver: + assert.Equal(t, "lenses.created", msg.Name) + slugs, ok := msg.Fields["entities"].([]string) + assert.True(t, ok, "entities payload should be []string, got %T", msg.Fields["entities"]) + assert.Equal(t, []string{lens.LensSlug}, slugs) + case <-time.After(2 * time.Second): + t.Fatal("expected one lenses.created event") + } + }) + t.Run("UpdatedPublishesSlugOnlyWithoutCount", func(t *testing.T) { + fixture := "lens-f-380" + lens := Lens{} + assert.NoError(t, UnscopedDb().First(&lens, "id = ?", LensFixtures.Get(fixture).ID).Error) + t.Cleanup(func() { assert.NoError(t, UnscopedDb().Save(LensFixtures.Pointer(fixture)).Error) }) + + updated := event.Subscribe("lenses.updated") + t.Cleanup(func() { event.Unsubscribe(updated) }) + count := event.Subscribe("count.lenses") + t.Cleanup(func() { event.Unsubscribe(count) }) + + assert.NoError(t, lens.UpdateMakeModel("Sigma", "85mm F1.4")) + // The slug must be preserved across a Make/Model rename so the published identity is stable. + assert.Equal(t, LensFixtures.Get(fixture).LensSlug, lens.LensSlug) + + select { + case msg := <-updated.Receiver: + assert.Equal(t, "lenses.updated", msg.Name) + slugs, ok := msg.Fields["entities"].([]string) + assert.True(t, ok, "entities payload should be []string, got %T", msg.Fields["entities"]) + assert.Equal(t, []string{lens.LensSlug}, slugs) + case <-time.After(2 * time.Second): + t.Fatal("expected one lenses.updated event") + } + // An update does not change the lens count, so no count event is published. + select { + case msg := <-count.Receiver: + t.Fatalf("unexpected %s event on lens update", msg.Name) + case <-time.After(200 * time.Millisecond): + } + }) +} + +func TestLens_SaveForm(t *testing.T) { + t.Run("Success", func(t *testing.T) { + lens := Lens{} + assert.NoError(t, UnscopedDb().First(&lens, "id = ?", LensFixtures.Get("lens-f-380").ID).Error) + defer assert.NoError(t, UnscopedDb().Save(LensFixtures.Pointer("lens-f-380")).Error) + err := lens.SaveForm(&form.Lens{LensMake: "Sigma", LensModel: "85mm F1.4"}) + assert.NoError(t, err) + assert.Equal(t, CameraMakes["Sigma"], lens.LensMake) // NewLens normalizes the make. + assert.Equal(t, "85mm F1.4", lens.LensModel) + assert.Equal(t, "lens-f-380", lens.LensSlug) // Slug is preserved across renames. + }) + t.Run("NilForm", func(t *testing.T) { + lens := &Lens{ID: LensFixtures.Get("lens-f-380").ID} + assert.Error(t, lens.SaveForm(nil)) + }) + t.Run("EmptyMake", func(t *testing.T) { + lens := &Lens{ID: LensFixtures.Get("lens-f-380").ID} + assert.Error(t, lens.SaveForm(&form.Lens{LensMake: "", LensModel: "85mm F1.4"})) + }) +} diff --git a/internal/entity/link.go b/internal/entity/link.go index 37d09c927..c3d66d738 100644 --- a/internal/entity/link.go +++ b/internal/entity/link.go @@ -233,7 +233,7 @@ func FindLinks(token, shared string) (found Links) { } if err := q.Order("modified_at DESC").Find(&found).Error; err != nil { - event.AuditErr([]string{"token %s", status.Error(err)}, clean.Log(token)) + event.AuditErr([]string{"share token lookup failed", status.Error(err)}) } return found diff --git a/internal/entity/link_fixtures.go b/internal/entity/link_fixtures.go index aca5cc933..80d1e680e 100644 --- a/internal/entity/link_fixtures.go +++ b/internal/entity/link_fixtures.go @@ -2,10 +2,11 @@ package entity import "time" -var date = time.Date(2050, 3, 6, 2, 6, 51, 0, time.UTC) - +// LinkMap represents a map of share link fixtures keyed by token. type LinkMap map[string]Link +// LinkFixtures provides share link fixtures for use in tests. +// //nolint:gosec // G101: Deterministic fixture tokens for tests only. var LinkFixtures = LinkMap{ "1jxf3jfn2k": { @@ -68,6 +69,30 @@ var LinkFixtures = LinkMap{ CreatedAt: time.Date(2020, 3, 6, 2, 6, 51, 0, time.UTC), ModifiedAt: time.Date(2020, 3, 6, 2, 6, 51, 0, time.UTC), }, + "8jxf3jfn2k": { + LinkUID: "ss62xpryd1ob3gtf", + ShareUID: "as6sg6bipogaaba1", // "april-1990" folder album (smart, path filter). + ShareSlug: "april-1990", + LinkToken: "8jxf3jfn2k", + LinkExpires: 0, + LinkViews: 0, + MaxViews: 0, + HasPassword: false, + CreatedAt: time.Date(2020, 3, 6, 2, 6, 51, 0, time.UTC), + ModifiedAt: time.Date(2020, 3, 6, 2, 6, 51, 0, time.UTC), + }, + "9jxf3jfn2k": { + LinkUID: "ss62xpryd1ob4gtf", + ShareUID: "as6sg6bipogaab11", // "california-usa" state album (smart, place filter). + ShareSlug: "california-usa", + LinkToken: "9jxf3jfn2k", + LinkExpires: 0, + LinkViews: 0, + MaxViews: 0, + HasPassword: false, + CreatedAt: time.Date(2020, 3, 6, 2, 6, 51, 0, time.UTC), + ModifiedAt: time.Date(2020, 3, 6, 2, 6, 51, 0, time.UTC), + }, } // CreateLinkFixtures inserts known entities into the database for testing. diff --git a/internal/entity/marker.go b/internal/entity/marker.go index 8153e6705..18996ac85 100644 --- a/internal/entity/marker.go +++ b/internal/entity/marker.go @@ -14,6 +14,7 @@ import ( "github.com/photoprism/photoprism/internal/form" "github.com/photoprism/photoprism/internal/thumb/crop" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/rnd" ) @@ -579,7 +580,7 @@ func (m *Marker) RefreshPhotos() error { var err error switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: err = UnscopedDb().Exec(`UPDATE photos p JOIN files f ON f.photo_id = p.id JOIN ? m ON m.file_uid = f.file_uid SET p.checked_at = NULL WHERE m.marker_uid = ?`, diff --git a/internal/entity/marker_test.go b/internal/entity/marker_test.go index 3a24e85da..c67a42561 100644 --- a/internal/entity/marker_test.go +++ b/internal/entity/marker_test.go @@ -3,9 +3,12 @@ package entity import ( "fmt" "testing" + "time" "github.com/stretchr/testify/assert" + "github.com/photoprism/photoprism/pkg/dsn" + "github.com/photoprism/photoprism/internal/form" "github.com/photoprism/photoprism/internal/thumb/crop" ) @@ -273,7 +276,11 @@ func TestMarker_Save(t *testing.T) { afterDate := m.UpdatedAt assert.Equal(t, SrcMeta, m.MarkerSrc) - assert.True(t, afterDate.After(initialDate)) + // Timestamps are stored with second precision, so a save within the same + // second leaves UpdatedAt unchanged; assert it stays within a sane window. + elapsed := afterDate.Sub(initialDate) + assert.GreaterOrEqual(t, elapsed, time.Duration(0)) + assert.Less(t, elapsed, time.Minute) if m.MarkerUID == "" || m.FileUID == "" { t.Errorf("UIDs should not be empty") @@ -406,7 +413,7 @@ func TestMarker_ClearFace(t *testing.T) { t.Run("ReturnsUpdateError", func(t *testing.T) { originalProvider := dbConn tempConn := &DbConn{ - Driver: SQLite3, + Driver: dsn.DriverSQLite3, Dsn: fmt.Sprintf("%s/%s", t.TempDir(), "clear-face-error.db"), } @@ -442,7 +449,7 @@ func TestMarker_SyncSubject(t *testing.T) { t.Run("UpdateKnownFaceError", func(t *testing.T) { originalProvider := dbConn tempConn := &DbConn{ - Driver: SQLite3, + Driver: dsn.DriverSQLite3, Dsn: fmt.Sprintf("%s/%s", t.TempDir(), "sync-subject-error.db"), } diff --git a/internal/entity/migrate/AGENTS.md b/internal/entity/migrate/AGENTS.md new file mode 100644 index 000000000..497c1c54e --- /dev/null +++ b/internal/entity/migrate/AGENTS.md @@ -0,0 +1,33 @@ +# Migration Package Guidelines + +**Last Updated:** June 1, 2026 + +This file applies to `internal/entity/migrate/`. Read [`README.md`](README.md) here for the runtime flow, retry behavior, and CLI troubleshooting commands. + +## Editing Migrations + +- Add or change SQL in [`mysql/`](mysql/) and [`sqlite3/`](sqlite3/); do not hand-edit the generated [`dialect_mysql.go`](dialect_mysql.go) or [`dialect_sqlite3.go`](dialect_sqlite3.go) files. +- Reuse the same timestamp-based migration ID across dialects for the same logical change. +- Use `.pre.sql` only when the SQL must run before GORM `AutoMigrate(...)`, typically for renames or shape changes that the ORM must see afterward. +- Keep migrations idempotent when possible with `IF EXISTS`, `IF NOT EXISTS`, or safe update conditions. Failed migrations are recorded once and then skipped on normal startup, so noisy or brittle SQL creates persistent operator friction until someone retries it manually. +- When (re-)creating a prefix index on a `VARBINARY` column, keep the prefix at **≤ 767 bytes** (the convention is `512`). InnoDB caps key prefixes at 767 bytes on `COMPACT`/`REDUNDANT` row formats, and `VARBINARY` prefixes are counted in bytes, so a longer prefix fails on older or non-`DYNAMIC` installs. See [`README.md`](README.md) → "Index Prefix Limits". +- If a migration requires custom Go logic instead of plain SQL, keep the reason narrow and obvious. Package-local helpers should still preserve the same retry semantics described in [`README.md`](README.md). + +## Generation & Verification + +- After changing migration SQL, run `go generate ./internal/entity/migrate`. +- After Go edits in this package, run `go fmt ./internal/entity/migrate`. +- Verify the package with `go test ./internal/entity/migrate -count=1`. +- When a change affects operator workflows, also verify the CLI help and status paths with `./photoprism migrations --help`, `./photoprism migrations ls --help`, and `./photoprism migrations run --help`. + +## Test Fixtures + +- Keep [`testdata/migrate_sqlite3`](testdata/migrate_sqlite3) and [`testdata/migrate_mysql.sql`](testdata/migrate_mysql.sql) aligned with the pre-migration schema shape expected by the regression tests. +- `TestDialectSQLite3` runs against a copied SQLite fixture. `TestDialectMysql` expects a MariaDB service reachable as `mariadb:${MARIADB_PORT:-4001}` with the `migrate` database and user from [`testdata/migrate_mysql.sql`](testdata/migrate_mysql.sql). + +## Runtime Model + +- The `versions` table gates the once-per-release schema initialization path. +- The `migrations` table stores per-migration `started_at`, `finished_at`, and `error` state. +- Normal startup does not rerun rows that already failed. Retrying failed rows requires `photoprism migrations run --failed` or explicitly naming migration IDs. +- Unfinished rows without an error are treated as stale and repeatable only after 60 minutes. More recent unfinished rows are assumed to still be running. diff --git a/internal/entity/migrate/README.md b/internal/entity/migrate/README.md new file mode 100644 index 000000000..e80ba3c98 --- /dev/null +++ b/internal/entity/migrate/README.md @@ -0,0 +1,110 @@ +# Database Migrations + +**Last Updated:** June 1, 2026 + +This package contains the dialect-specific SQL migrations that complement GORM's schema auto-migration during database initialization. The SQL source files live in [`mysql/`](mysql/) and [`sqlite3/`](sqlite3/), and [`generate.go`](generate.go) embeds them into the generated [`dialect_mysql.go`](dialect_mysql.go) and [`dialect_sqlite3.go`](dialect_sqlite3.go) files. + +Files ending in `.pre.sql` run in the `pre` stage before ORM auto-migration. All other migration files run in the `main` stage afterward. + +## Index Prefix Limits (VARBINARY Columns) + +InnoDB caps an index key **prefix** at **767 bytes** on the `COMPACT`/`REDUNDANT` row formats, and only allows up to 3072 bytes on `DYNAMIC`/`COMPRESSED`. On a `VARBINARY` column the prefix is measured in **bytes** (on a `utf8mb4` column it is measured in characters, i.e. up to 4 bytes each), so a `CREATE INDEX … (col(N))` with `N > 767` fails with *"Specified key was too long; max key length is 767 bytes"* on older or non-`DYNAMIC` installs. + +When a migration converts a long text column to `VARBINARY` and re-creates its prefix index, keep the prefix at **≤ 767 bytes** — the project convention is **512** (see `mysql/20220329-040000.sql` for `album_filter(512)` and `mysql/20260601-000001.sql` for `album_path(512)`). A prefix index only narrows candidate rows; the full-column comparison is still exact, so a shorter prefix has no correctness cost. SQLite has no equivalent limit and is not migrated for `VARBINARY` type changes (its `TEXT` comparisons are already byte-exact). + +## When Migrations Run + +PhotoPrism initializes the database through [`Config.InitDb()`](../../config/config_db.go) and [`Config.MigrateDb()`](../../config/config_db.go). This happens during `photoprism start` and in other commands that need a ready schema. + +The migration flow is: + +1. Open the configured database connection and register it as the active provider. +2. Load or create a row in the `versions` table for the current PhotoPrism `Version` and `Edition`. +3. Run `pre` SQL migrations from this package. +4. If the current release still `NeedsMigration()`, run the one-time schema work in [`entity.InitDb()`](../entity_init.go) and [`Tables.Migrate()`](../entity_tables.go): + - drop deprecated tables when enabled + - run GORM `AutoMigrate(...)` for all registered entities + - apply one-off compatibility fixes that are also tracked through `versions` +5. Run `main` SQL migrations from this package. +6. Mark the current release as migrated by setting `versions.migrated_at`. + +The important distinction is that the `versions` table gates the expensive release-level schema initialization, while the `migrations` table tracks each named SQL migration in this package. + +## Why Migrations Are Not Repeated + +PhotoPrism uses two persistence layers to avoid rerunning the same startup work and to keep broken migrations from producing the same error on every launch. + +### `versions`: Once Per Release + +The `versions` table stores one row per PhotoPrism `Version` and `Edition`. After a successful release-level initialization, `MigrateDb()` sets `migrated_at`. On later startups of the same release, `NeedsMigration()` returns `false`, so the full ORM auto-migration path is skipped. This reduces startup time and avoids repeating the same broad schema work over and over again. + +### `migrations`: Once Per Migration ID + +Each SQL migration in this package has a stable timestamp-based `ID`, for example `20240709-000001`. Before running a migration, PhotoPrism looks for an existing row in the `migrations` table. + +- If `finished_at` is set, the migration already succeeded and is skipped. +- If `error` is set, the migration previously failed and is skipped during normal startup. +- If the migration was started but not finished and has been "running" for less than 60 minutes, it is treated as still in progress and is skipped. +- If the migration was started but not finished and has been "running" for 60 minutes or more, it is treated as stale and may be repeated automatically. + +This is the reason broken migrations do not spam the logs on every startup: the failure is recorded once in `migrations.error`, and future runs see that row and skip it unless you explicitly ask to retry it. + +## Troubleshooting & Testing + +Use the CLI commands below when you need to inspect migration state, retry failed work, or test specific migration IDs. These commands use the normal PhotoPrism configuration, so point them at a disposable or copied database first when you are testing reruns. + +### Inspecting Status + +```bash +photoprism migrations +photoprism migrations ls +photoprism migrations status +photoprism migrations show +``` + +`photoprism migrations` shows the available subcommands. `photoprism migrations ls` displays the current status of known migrations without executing them. + +For automation or diffing, `ls` also supports machine-readable output: + +```bash +photoprism migrations ls --json +photoprism migrations ls --md +photoprism migrations ls --csv +photoprism migrations ls --tsv +``` + +The status output maps to the runtime logic in [`migration.go`](migration.go): + +| Status | Meaning | +|----------------|------------------------------------------------------------------------| +| `OK` | The migration finished successfully. | +| `-` | The migration has not been started yet. | +| `Repeat` | The migration looks stale and is eligible to run again automatically. | +| `Running?` | The migration started recently and is assumed to still be in progress. | +| `<error text>` | The last attempt failed and will be skipped on normal startup. | + +### Running Migrations + +```bash +photoprism migrations run +photoprism migrations run --trace +photoprism migrations run --failed +photoprism migrations run --failed --trace +photoprism migrate +``` + +`photoprism migrations run` executes pending schema migrations. `--trace` enables trace logging for debugging. `--failed` retries migrations that have an `error` recorded in the `migrations` table. `photoprism migrate` is a top-level alias for `photoprism migrations run`. + +### Running Specific Migration IDs + +You can limit status checks or runs to one or more specific migration IDs: + +```bash +photoprism migrations ls 20240709-000001 +photoprism migrations run 20240709-000001 +photoprism migrations run --failed "20240709-000001 20250315-000001" +``` + +When you pass a specific ID, PhotoPrism selects only that migration. When you pass multiple IDs, quote them as a single whitespace-separated argument so the CLI can split them correctly. + +Named migrations are allowed to run again even if they already succeeded or previously failed. That makes targeted troubleshooting possible, but it also means you should prefer a test database before forcing reruns. diff --git a/internal/entity/migrate/dbms_authid_migration.go b/internal/entity/migrate/dbms_authid_migration.go index d4e7b975c..a8747af00 100644 --- a/internal/entity/migrate/dbms_authid_migration.go +++ b/internal/entity/migrate/dbms_authid_migration.go @@ -5,6 +5,8 @@ import ( "strings" "github.com/jinzhu/gorm" + + "github.com/photoprism/photoprism/pkg/dsn" ) // ConvertDBMSAuthIDDataTypes applies the data type conversion for auth_id columns for SQLite @@ -12,7 +14,7 @@ import ( // This can't be done in a script as the order of columns is not known, and is determined by the age of the database func ConvertDBMSAuthIDDataTypes(db *gorm.DB) (err error) { switch db.Dialect().GetName() { - case SQLite3: + case dsn.DriverSQLite3: // These create statements will get out of date, but that is ok, as the main migrate path will add any missing columns/indexes in later. authSessionsCreate := `CREATE TABLE "auth_sessions" ("id" VARBINARY(2048),"user_uid" VARBINARY(42) DEFAULT '',"user_name" varchar(200),"client_uid" VARBINARY(42) DEFAULT '',"client_name" varchar(200) DEFAULT '',"client_ip" varchar(64),"auth_provider" VARBINARY(128) DEFAULT '',"auth_method" VARBINARY(128) DEFAULT '',"auth_issuer" VARBINARY(255) DEFAULT '',"auth_id" TEXT NOT NULL COLLATE BINARY DEFAULT '',"auth_scope" varchar(1024) DEFAULT '',"grant_type" VARBINARY(64) DEFAULT '',"last_active" bigint,"sess_expires" bigint,"sess_timeout" bigint,"preview_token" VARBINARY(64) DEFAULT '',"download_token" VARBINARY(64) DEFAULT '',"access_token" VARBINARY(4096) DEFAULT '',"refresh_token" VARBINARY(2048) DEFAULT '',"id_token" VARBINARY(2048) DEFAULT '',"user_agent" varchar(512),"data_json" VARBINARY(4096),"ref_id" VARBINARY(16) DEFAULT '',"login_ip" varchar(64),"login_at" datetime,"created_at" datetime,"updated_at" datetime , PRIMARY KEY ("id"))` authUsersCreate := `CREATE TABLE "auth_users" ("id" integer primary key autoincrement,"user_uuid" VARBINARY(64),"user_uid" VARBINARY(42),"auth_provider" VARBINARY(128) DEFAULT '',"auth_method" VARBINARY(128) DEFAULT '',"auth_issuer" VARBINARY(255) DEFAULT '',"auth_id" TEXT NOT NULL COLLATE BINARY DEFAULT '',"user_name" varchar(200),"display_name" varchar(200),"user_email" varchar(255),"backup_email" varchar(255),"user_role" varchar(64) DEFAULT '',"user_scope" varchar(1024) DEFAULT '*',"user_attr" varchar(1024) DEFAULT '',"super_admin" bool,"can_login" bool,"login_at" datetime,"expires_at" datetime,"webdav" bool,"base_path" VARBINARY(1024),"upload_path" VARBINARY(1024),"can_invite" bool,"invite_token" VARBINARY(64),"invited_by" varchar(64),"verify_token" VARBINARY(64),"verified_at" datetime,"consent_at" datetime,"born_at" datetime,"reset_token" VARBINARY(64),"preview_token" VARBINARY(64),"download_token" VARBINARY(64),"thumb" VARBINARY(128) DEFAULT '',"thumb_src" VARBINARY(8) DEFAULT '',"ref_id" VARBINARY(16),"created_at" datetime,"updated_at" datetime,"deleted_at" datetime )` diff --git a/internal/entity/migrate/dialect_mysql.go b/internal/entity/migrate/dialect_mysql.go index de5d9f207..ae9cf2e0a 100644 --- a/internal/entity/migrate/dialect_mysql.go +++ b/internal/entity/migrate/dialect_mysql.go @@ -231,4 +231,22 @@ var DialectMySQL = Migrations{ Stage: "main", Statements: []string{"UPDATE photos SET indexed_at = checked_at WHERE indexed_at IS NULL;"}, }, + { + ID: "20260601-000001", + Dialect: "mysql", + Stage: "main", + Statements: []string{"DROP INDEX IF EXISTS idx_albums_album_path ON albums;", "ALTER TABLE albums MODIFY album_path VARBINARY(1024);", "CREATE OR REPLACE INDEX idx_albums_album_path ON albums (album_path(512));"}, + }, + { + ID: "20260602-000001", + Dialect: "mysql", + Stage: "main", + Statements: []string{"ALTER TABLE photos MODIFY uuid VARBINARY(255);"}, + }, + { + ID: "20260612-000001", + Dialect: "mysql", + Stage: "main", + Statements: []string{"ALTER TABLE auth_sessions MODIFY data_json VARBINARY(16384);"}, + }, } diff --git a/internal/entity/migrate/dialect_mysql_test.go b/internal/entity/migrate/dialect_mysql_test.go index 665b3781d..c1fd01c12 100644 --- a/internal/entity/migrate/dialect_mysql_test.go +++ b/internal/entity/migrate/dialect_mysql_test.go @@ -1,6 +1,8 @@ package migrate import ( + "fmt" + "os" "os/exec" "path/filepath" "testing" @@ -28,9 +30,14 @@ func TestDialectMysql(t *testing.T) { log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) + port := os.Getenv("MARIADB_PORT") + if port == "" { + port = "4001" + } + db, err := gorm.Open( "mysql", - "migrate:migrate@tcp(mariadb:4001)/migrate?charset=utf8mb4,utf8&collation=utf8mb4_unicode_ci&parseTime=true", + fmt.Sprintf("migrate:migrate@tcp(mariadb:%s)/migrate?charset=utf8mb4,utf8&collation=utf8mb4_unicode_ci&parseTime=true", port), ) if err != nil || db == nil { diff --git a/internal/entity/migrate/dialects.go b/internal/entity/migrate/dialects.go index 9ee0d400e..72cfdb654 100644 --- a/internal/entity/migrate/dialects.go +++ b/internal/entity/migrate/dialects.go @@ -1,19 +1,17 @@ package migrate -import "sync" +import ( + "sync" -// Supported database dialects. -const ( - MySQL = "mysql" - SQLite3 = "sqlite3" + "github.com/photoprism/photoprism/pkg/dsn" ) var Dialects = map[string]Migrations{ - MySQL: DialectMySQL, - SQLite3: DialectSQLite3, + dsn.DriverMySQL: DialectMySQL, + dsn.DriverSQLite3: DialectSQLite3, } var once = map[string]*sync.Once{ - MySQL: {}, - SQLite3: {}, + dsn.DriverMySQL: {}, + dsn.DriverSQLite3: {}, } diff --git a/internal/entity/migrate/migrate.go b/internal/entity/migrate/migrate.go index 6dfe6f7ee..06c7c644d 100644 --- a/internal/entity/migrate/migrate.go +++ b/internal/entity/migrate/migrate.go @@ -1,7 +1,7 @@ /* Package migrate provides database schema migrations. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/entity/migrate/mysql/20260601-000001.sql b/internal/entity/migrate/mysql/20260601-000001.sql new file mode 100644 index 000000000..9f5e7eda5 --- /dev/null +++ b/internal/entity/migrate/mysql/20260601-000001.sql @@ -0,0 +1,3 @@ +DROP INDEX IF EXISTS idx_albums_album_path ON albums; +ALTER TABLE albums MODIFY album_path VARBINARY(1024); +CREATE OR REPLACE INDEX idx_albums_album_path ON albums (album_path(512)); diff --git a/internal/entity/migrate/mysql/20260602-000001.sql b/internal/entity/migrate/mysql/20260602-000001.sql new file mode 100644 index 000000000..89688eba5 --- /dev/null +++ b/internal/entity/migrate/mysql/20260602-000001.sql @@ -0,0 +1 @@ +ALTER TABLE photos MODIFY uuid VARBINARY(255); diff --git a/internal/entity/migrate/mysql/20260612-000001.sql b/internal/entity/migrate/mysql/20260612-000001.sql new file mode 100644 index 000000000..8e4e9b157 --- /dev/null +++ b/internal/entity/migrate/mysql/20260612-000001.sql @@ -0,0 +1 @@ +ALTER TABLE auth_sessions MODIFY data_json VARBINARY(16384); diff --git a/internal/entity/mysql8_test.go b/internal/entity/mysql8_test.go index 3ce57e920..e005df3df 100644 --- a/internal/entity/mysql8_test.go +++ b/internal/entity/mysql8_test.go @@ -5,6 +5,8 @@ import ( "testing" "time" + "github.com/photoprism/photoprism/pkg/dsn" + "github.com/photoprism/photoprism/internal/entity/migrate" "github.com/jinzhu/gorm" @@ -17,7 +19,7 @@ func TestMySQL8(t *testing.T) { t.Skip("skipping MySQL 8 test: PHOTOPRISM_TEST_DSN_MYSQL8 is not set") } - dbDriver := MySQL + dbDriver := dsn.DriverMySQL db, err := gorm.Open(dbDriver, dbDsn) if err != nil || db == nil { diff --git a/internal/entity/passcode.go b/internal/entity/passcode.go index 07672df93..ca238a484 100644 --- a/internal/entity/passcode.go +++ b/internal/entity/passcode.go @@ -2,6 +2,7 @@ package entity import ( "bytes" + "crypto/subtle" "errors" "fmt" "image" @@ -254,8 +255,9 @@ func (m *Passcode) Valid(code string) (valid bool, recovery bool, err error) { return false, false, authn.ErrInvalidPasscodeKey } - // Check if recovery code has been used. - if m.RecoveryCode == code { + // Check if recovery code has been used, comparing in constant time so the + // stored secret does not leak through response timing. + if m.RecoveryCode != "" && subtle.ConstantTimeCompare([]byte(m.RecoveryCode), []byte(code)) == 1 { return true, true, nil } diff --git a/internal/entity/passcode_test.go b/internal/entity/passcode_test.go index 69b5b8c71..fb2ffbc0f 100644 --- a/internal/entity/passcode_test.go +++ b/internal/entity/passcode_test.go @@ -381,6 +381,21 @@ func TestPasscode_Verify(t *testing.T) { assert.True(t, recoveryCode) assert.Nil(t, m.VerifiedAt) }) + t.Run("EmptyRecoveryCodeNeverMatches", func(t *testing.T) { + m := &Passcode{ + UID: "uqxc08w3d0ej2283", + KeyURL: "otpauth://totp/Example:alice", + RecoveryCode: "", + } + // An unset recovery code must not match any submitted code (constant-time + // compare returns 0 on a length mismatch, but the guard makes intent explicit). + valid, recoveryCode, err := m.Valid("123456") + if err != nil { + t.Fatal(err) + } + assert.False(t, valid) + assert.False(t, recoveryCode) + }) t.Run("ErrPasscodeRequired", func(t *testing.T) { m := &Passcode{ UID: "uqxc08w3d0ej2283", diff --git a/internal/entity/password_test.go b/internal/entity/password_test.go index cf726a364..844ee4329 100644 --- a/internal/entity/password_test.go +++ b/internal/entity/password_test.go @@ -103,7 +103,7 @@ func TestPassword_Invalid(t *testing.T) { func TestPassword_Create(t *testing.T) { t.Run("Success", func(t *testing.T) { - p := Password{} + p := Password{UID: "uriku0138hqql4bz"} err := p.Create() diff --git a/internal/entity/photo.go b/internal/entity/photo.go index 014594db2..3f0c0f0dd 100644 --- a/internal/entity/photo.go +++ b/internal/entity/photo.go @@ -14,6 +14,7 @@ import ( "github.com/ulule/deepcopier" "github.com/photoprism/photoprism/internal/ai/classify" + "github.com/photoprism/photoprism/internal/auth/acl" "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/internal/form" "github.com/photoprism/photoprism/pkg/clean" @@ -23,6 +24,7 @@ import ( "github.com/photoprism/photoprism/pkg/rnd" "github.com/photoprism/photoprism/pkg/time/tz" "github.com/photoprism/photoprism/pkg/txt" + "github.com/photoprism/photoprism/pkg/txt/clip" ) const ( @@ -44,7 +46,7 @@ func MapKey(takenAt time.Time, cellId string) string { // Photo represents a photo, all its properties, and link to all its images and sidecar files. type Photo struct { ID uint `gorm:"primary_key" yaml:"-"` - UUID string `gorm:"type:VARBINARY(64);index;" json:"DocumentID,omitempty" yaml:"DocumentID,omitempty"` + UUID string `gorm:"type:VARBINARY(255);index;" json:"DocumentID,omitempty" yaml:"DocumentID,omitempty"` TakenAt time.Time `gorm:"type:DATETIME;index:idx_photos_taken_uid;" json:"TakenAt" yaml:"TakenAt"` TakenAtLocal time.Time `gorm:"type:DATETIME;" json:"TakenAtLocal" yaml:"TakenAtLocal"` TakenSrc string `gorm:"type:VARBINARY(8);" json:"TakenSrc" yaml:"TakenSrc,omitempty"` @@ -806,6 +808,65 @@ func (m *Photo) PreloadMany() *Photo { return m } +// RedactForSession trims fields a shared-only session should not see when it accesses a picture +// through sharing: the album list is limited to the albums shared with the session, and people, +// labels, owner/storage metadata, and identifying metadata (camera serial, the XMP DocumentID, and +// per-file InstanceID) are removed. Sessions with full library or admin access (and nil sessions) +// are returned unchanged. +func (m *Photo) RedactForSession(sess *Session) *Photo { + if m == nil || sess == nil { + return m + } + + // Only sessions limited to shared content are redacted. + if !sess.GetUser().HasSharedAccessOnly(acl.ResourcePhotos) && !sess.NotRegistered() { + return m + } + + // Limit album membership to the albums shared with the session. + if len(m.Albums) > 0 { + shared := sess.SharedUIDs() + + if len(shared) == 0 { + m.Albums = nil + } else { + allowed := make(map[string]struct{}, len(shared)) + for _, uid := range shared { + allowed[uid] = struct{}{} + } + + kept := m.Albums[:0] + for _, a := range m.Albums { + if _, ok := allowed[a.AlbumUID]; ok { + kept = append(kept, a) + } + } + + m.Albums = kept + } + } + + // Remove labels and people, plus the per-file XMP InstanceID (marker identity is omitted + // defensively in case markers are loaded). + m.Labels = nil + for i := range m.Files { + m.Files[i].OmitMarkers = true + m.Files[i].InstanceID = "" + } + + // Remove owner, storage, and identifying metadata. CameraSerial is a device fingerprint that + // can link a photographer's pictures, and the XMP DocumentID is a content-provenance identifier; + // neither is needed by a shared-only viewer (navigation uses PhotoUID/FileUID). + m.CreatedBy = "" + m.PhotoPath = "" + m.OriginalName = "" + m.UUID = "" + m.CameraSerial = "" + m.Details = nil + + return m +} + // NormalizeValues updates the model values with the values from deprecated fields, if any. func (m *Photo) NormalizeValues() (normalized bool) { if m.PhotoCaption == "" && m.PhotoDescription != "" { @@ -1345,7 +1406,8 @@ func (m *Photo) MapKey() string { // SetCameraSerial updates the camera serial number. func (m *Photo) SetCameraSerial(s string) { - if s = txt.Clip(s, txt.ClipDefault); m.NoCameraSerial() && s != "" { + // camera_serial is VARBINARY(160), so clip by bytes on a rune boundary. + if s = clip.Bytes(s, txt.ClipDefault); m.NoCameraSerial() && s != "" { m.CameraSerial = s } } diff --git a/internal/entity/photo_album_test.go b/internal/entity/photo_album_test.go index db0404ed8..ad834bb9c 100644 --- a/internal/entity/photo_album_test.go +++ b/internal/entity/photo_album_test.go @@ -38,9 +38,8 @@ func TestFirstOrCreatePhotoAlbum(t *testing.T) { t.Errorf("PhotoUID should be the same: %s %s", result.PhotoUID, model.PhotoUID) } }) - //TODO fails on mariadb t.Run("NotYetExistingAlbum", func(t *testing.T) { - model := &PhotoAlbum{} + model := &PhotoAlbum{PhotoUID: "ps6sg6be2lvl0y14", AlbumUID: "as6sg6bipotaab29"} result := FirstOrCreatePhotoAlbum(model) if result == nil { @@ -57,10 +56,9 @@ func TestFirstOrCreatePhotoAlbum(t *testing.T) { }) } -// TODO fails on mariadb func TestPhotoAlbum_Save(t *testing.T) { t.Run("Success", func(t *testing.T) { - p := PhotoAlbum{} + p := PhotoAlbum{PhotoUID: "ps6sg6be2lvl0y14", AlbumUID: "as6sg6bipogaab11"} err := p.Create() diff --git a/internal/entity/photo_estimate.go b/internal/entity/photo_estimate.go index 76c361976..61f9a1134 100644 --- a/internal/entity/photo_estimate.go +++ b/internal/entity/photo_estimate.go @@ -6,6 +6,7 @@ import ( "github.com/jinzhu/gorm" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/fs" "github.com/photoprism/photoprism/pkg/geo" "github.com/photoprism/photoprism/pkg/txt" @@ -99,14 +100,14 @@ func (m *Photo) EstimateLocation(force bool) { var mostRecent Photos switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: err = UnscopedDb(). Where("photo_lat <> 0 AND photo_lng <> 0"). Where("place_src <> '' AND place_src <> ? AND place_id IS NOT NULL AND place_id <> '' AND place_id <> 'zz'", SrcEstimate). Where("taken_src <> '' AND taken_at BETWEEN CAST(? AS DATETIME) AND CAST(? AS DATETIME)", rangeMin, rangeMax). Order(gorm.Expr("ABS(TIMESTAMPDIFF(SECOND, taken_at, ?))", m.TakenAt)).Limit(2). Preload("Place").Find(&mostRecent).Error - case SQLite3: + case dsn.DriverSQLite3: err = UnscopedDb(). Where("photo_lat <> 0 AND photo_lng <> 0"). Where("place_src <> '' AND place_src <> ? AND place_id IS NOT NULL AND place_id <> '' AND place_id <> 'zz'", SrcEstimate). diff --git a/internal/entity/photo_label.go b/internal/entity/photo_label.go index 9c7bec4d3..c2de1be83 100644 --- a/internal/entity/photo_label.go +++ b/internal/entity/photo_label.go @@ -144,9 +144,14 @@ func FirstOrCreatePhotoLabel(m *PhotoLabel) *PhotoLabel { // Try to find and return an existing label. Otherwise, create a new one and return it. if result, err := FindPhotoLabel(m.PhotoID, m.LabelID, true); err == nil { return result - } else if createErr := m.Create(); createErr == nil { + } + + // Drop stale negative cache entries before retrying through the database. + FlushCachedPhotoLabel(m) + + if createErr := m.Create(); createErr == nil { return m - } else if result, err = FindPhotoLabel(m.PhotoID, m.LabelID, false); err == nil { + } else if result, err := FindPhotoLabel(m.PhotoID, m.LabelID, false); err == nil { return result } else { log.Errorf("photo-label: %s (find or create)", createErr) diff --git a/internal/entity/photo_label_test.go b/internal/entity/photo_label_test.go index 52b77887a..5808c0eb7 100644 --- a/internal/entity/photo_label_test.go +++ b/internal/entity/photo_label_test.go @@ -49,6 +49,22 @@ func TestFirstOrCreatePhotoLabel(t *testing.T) { assert.Nil(t, FirstOrCreatePhotoLabel(NewPhotoLabel(0, 1, 38, "image"))) assert.Nil(t, FirstOrCreatePhotoLabel(NewPhotoLabel(1, 0, 38, "image"))) }) + t.Run("ClearsStaleNotFoundCache", func(t *testing.T) { + FlushPhotoLabelCache() + relation := createTestPhotoLabel(t) + + photoLabelCache.Set(relation.CacheKey(), PhotoLabel{}, labelCacheErrorExpiration) + + result := FirstOrCreatePhotoLabel(NewPhotoLabel(relation.PhotoID, relation.LabelID, relation.Uncertainty, relation.LabelSrc)) + require.NotNil(t, result) + assert.Equal(t, relation.PhotoID, result.PhotoID) + assert.Equal(t, relation.LabelID, result.LabelID) + + cached, err := FindPhotoLabel(relation.PhotoID, relation.LabelID, true) + require.NoError(t, err) + assert.Equal(t, relation.PhotoID, cached.PhotoID) + assert.Equal(t, relation.LabelID, cached.LabelID) + }) } func TestPhotoLabel_ClassifyLabel(t *testing.T) { @@ -74,12 +90,11 @@ func TestPhotoLabel_Save(t *testing.T) { t.Fatal(err) } }) - //TODO fails on mariadb t.Run("PhotoNotNilAndLabelNotNil", func(t *testing.T) { label := &Label{LabelName: "LabelSaveUnique", LabelSlug: "unique-slug"} photo := &Photo{} - photoLabel := PhotoLabel{Photo: photo, Label: label} + photoLabel := PhotoLabel{PhotoID: 900000003, LabelID: 900000004, Photo: photo, Label: label} err := photoLabel.Save() if err != nil { t.Fatal(err) diff --git a/internal/entity/photo_location.go b/internal/entity/photo_location.go index b33a6b343..08adfdda7 100644 --- a/internal/entity/photo_location.go +++ b/internal/entity/photo_location.go @@ -366,7 +366,7 @@ func (m *Photo) UpdateLocation() (keywords []string, labels classify.Labels) { // Empty or unknown S2 cell id... should not happen, unless coordinates are invalid. log.Warnf("photo: unknown cell id for lat %f, lng %f (uid %s)", m.PhotoLat, m.PhotoLng, m.PhotoUID) } else if err := loc.Find(GeoApi); err != nil { - log.Errorf("photo: %s (find location)", err) + log.Warnf("photo: %s (find location)", err) } else if loc.Place == nil { log.Warnf("photo: failed fetching geo data (uid %s, cell %s)", m.PhotoUID, loc.ID) } else if loc.ID != UnknownLocation.ID { diff --git a/internal/entity/photo_merge.go b/internal/entity/photo_merge.go index a0d7b6a53..4ecac2e39 100644 --- a/internal/entity/photo_merge.go +++ b/internal/entity/photo_merge.go @@ -5,6 +5,7 @@ import ( "github.com/jinzhu/gorm" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/media" "github.com/photoprism/photoprism/pkg/rnd" ) @@ -109,11 +110,11 @@ func (m *Photo) Merge(mergeMeta, mergeUuid bool) (original Photo, merged Photos, logResult(UnscopedDb().Exec("UPDATE photos SET photo_quality = -1, deleted_at = ? WHERE id = ?", Now(), merge.ID)) switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: logResult(UnscopedDb().Exec("UPDATE IGNORE photos_keywords SET photo_id = ? WHERE photo_id = ?", original.ID, merge.ID)) logResult(UnscopedDb().Exec("UPDATE IGNORE photos_labels SET photo_id = ? WHERE photo_id = ?", original.ID, merge.ID)) logResult(UnscopedDb().Exec("UPDATE IGNORE photos_albums SET photo_uid = ? WHERE photo_uid = ?", original.PhotoUID, merge.PhotoUID)) - case SQLite3: + case dsn.DriverSQLite3: logResult(UnscopedDb().Exec("UPDATE OR IGNORE photos_keywords SET photo_id = ? WHERE photo_id = ?", original.ID, merge.ID)) logResult(UnscopedDb().Exec("UPDATE OR IGNORE photos_labels SET photo_id = ? WHERE photo_id = ?", original.ID, merge.ID)) logResult(UnscopedDb().Exec("UPDATE OR IGNORE photos_albums SET photo_uid = ? WHERE photo_uid = ?", original.PhotoUID, merge.PhotoUID)) diff --git a/internal/entity/photo_quality.go b/internal/entity/photo_quality.go index 9aaa718ac..36a780f62 100644 --- a/internal/entity/photo_quality.go +++ b/internal/entity/photo_quality.go @@ -44,7 +44,7 @@ func (m *Photo) QualityScore() (score int) { score++ } - if score < 3 && (m.PhotoType != MediaImage || m.EditedAt != nil) { + if score < 3 && (m.PhotoType != MediaImage || m.PhotoIso > 0 || m.PhotoExposure != "" || m.EditedAt != nil) { score = 3 } diff --git a/internal/entity/photo_quality_test.go b/internal/entity/photo_quality_test.go index e6de48031..3c582805e 100644 --- a/internal/entity/photo_quality_test.go +++ b/internal/entity/photo_quality_test.go @@ -2,6 +2,7 @@ package entity import ( "testing" + "time" "github.com/stretchr/testify/assert" ) @@ -43,6 +44,35 @@ func TestPhoto_UpdateQuality(t *testing.T) { }) } +func TestPhoto_QualityScorePhotographicMetadataFloor(t *testing.T) { + t.Run("ImageWithISO", func(t *testing.T) { + p := &Photo{ + PhotoType: MediaImage, + PhotoIso: 200, + TakenAt: time.Date(2015, 1, 1, 0, 0, 0, 0, time.UTC), + } + + assert.Equal(t, 3, p.QualityScore()) + }) + t.Run("ImageWithExposure", func(t *testing.T) { + p := &Photo{ + PhotoType: MediaImage, + PhotoExposure: "1/60", + TakenAt: time.Date(2015, 1, 1, 0, 0, 0, 0, time.UTC), + } + + assert.Equal(t, 3, p.QualityScore()) + }) + t.Run("ImageWithoutPhotographicMetadata", func(t *testing.T) { + p := &Photo{ + PhotoType: MediaImage, + TakenAt: time.Date(2015, 1, 1, 0, 0, 0, 0, time.UTC), + } + + assert.Equal(t, 1, p.QualityScore()) + }) +} + func TestPhoto_IsNonPhotographic(t *testing.T) { t.Run("Raw", func(t *testing.T) { m := PhotoFixtures.Get("Photo01") diff --git a/internal/entity/photo_scope_test.go b/internal/entity/photo_scope_test.go new file mode 100644 index 000000000..487d10744 --- /dev/null +++ b/internal/entity/photo_scope_test.go @@ -0,0 +1,67 @@ +package entity + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestPhoto_RedactForSession(t *testing.T) { + // newPhoto returns a photo populated with the fields RedactForSession may trim. + newPhoto := func() *Photo { + return &Photo{ + CreatedBy: "uqxetse3cy5eo9z2", + PhotoPath: "2020/01", + OriginalName: "orig.jpg", + UUID: "a1b2c3d4-document-id", + CameraSerial: "SN-123456", + Albums: []Album{{AlbumUID: "as6sg6bxpogaaba9"}, {AlbumUID: "as6sg6bxpogaaba8"}}, + Labels: []PhotoLabel{{}}, + Details: &Details{}, + Files: []File{{FileUID: "fs6sg6bw45bnlqdw", FileName: "2020/01/orig.jpg", InstanceID: "xmp-instance-id"}}, + } + } + + session := func(name string) *Session { + s := &Session{} + s.SetUser(UserFixtures.Pointer(name)) + return s + } + + t.Run("AdminUnchanged", func(t *testing.T) { + p := newPhoto() + p.RedactForSession(session("alice")) + assert.Len(t, p.Albums, 2) + assert.Len(t, p.Labels, 1) + assert.Equal(t, "uqxetse3cy5eo9z2", p.CreatedBy) + assert.Equal(t, "2020/01", p.PhotoPath) + assert.Equal(t, "a1b2c3d4-document-id", p.UUID) + assert.Equal(t, "SN-123456", p.CameraSerial) + assert.Equal(t, "xmp-instance-id", p.Files[0].InstanceID) + assert.NotNil(t, p.Details) + assert.False(t, p.Files[0].OmitMarkers) + }) + t.Run("NilSession", func(t *testing.T) { + p := newPhoto() + p.RedactForSession(nil) + assert.Len(t, p.Albums, 2) + assert.Equal(t, "uqxetse3cy5eo9z2", p.CreatedBy) + }) + t.Run("GuestRedacted", func(t *testing.T) { + p := newPhoto() + p.RedactForSession(session("guest")) + // The guest has no shares, so no album membership is disclosed. + assert.Empty(t, p.Albums) + assert.Empty(t, p.Labels) + assert.Equal(t, "", p.CreatedBy) + assert.Equal(t, "", p.PhotoPath) + assert.Equal(t, "", p.OriginalName) + assert.Equal(t, "", p.UUID) + assert.Equal(t, "", p.CameraSerial) + assert.Equal(t, "", p.Files[0].InstanceID) + assert.Nil(t, p.Details) + assert.True(t, p.Files[0].OmitMarkers) + // The filename stays — the sidebar surfaces it, and it is not identifying metadata. + assert.Equal(t, "2020/01/orig.jpg", p.Files[0].FileName) + }) +} diff --git a/internal/entity/photo_test.go b/internal/entity/photo_test.go index edb5bac69..70953598d 100644 --- a/internal/entity/photo_test.go +++ b/internal/entity/photo_test.go @@ -2,14 +2,17 @@ package entity import ( "fmt" + "strings" "testing" "time" + "unicode/utf8" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" "github.com/photoprism/photoprism/internal/ai/classify" "github.com/photoprism/photoprism/internal/form" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/media" "github.com/photoprism/photoprism/pkg/rnd" "github.com/photoprism/photoprism/pkg/time/tz" @@ -701,6 +704,41 @@ func TestPhoto_AddLabels(t *testing.T) { } assert.Equal(t, labelCountBefore, labelCountAfter) }) + t.Run("ReusesRenamedLabelFromClassifier", func(t *testing.T) { + // Reproduces the AI ingestion path from issue #5531: a classifier + // re-emitting the previous name of a renamed label must reuse the + // existing row instead of creating a duplicate. + original := FirstOrCreateLabel(NewLabel("RenameClassifyA", 0)) + require.NotNil(t, original) + + t.Cleanup(func() { + _ = Db().Unscoped().Delete(original).Error + FlushLabelCache() + }) + + require.True(t, original.SetName("RenameClassifyB")) + require.NoError(t, Db().Save(original).Error) + FlushLabelCache() + + var before int + require.NoError(t, UnscopedDb().Model(&Label{}). + Where("label_slug LIKE ? OR custom_slug LIKE ?", "renameclassify%", "renameclassify%"). + Count(&before).Error) + assert.Equal(t, 1, before) + + photo := PhotoFixtures.Get("19800101_000002_D640C559") + photo.AddLabels(classify.Labels{{Name: "RenameClassifyA", Uncertainty: 30, Source: SrcImage, Priority: 0}}) + + var after int + require.NoError(t, UnscopedDb().Model(&Label{}). + Where("label_slug LIKE ? OR custom_slug LIKE ?", "renameclassify%", "renameclassify%"). + Count(&after).Error) + assert.Equal(t, 1, after, "classifier with old name must not create a duplicate label") + + joined, err := FindPhotoLabel(photo.ID, original.ID, false) + require.NoError(t, err) + assert.Equal(t, original.ID, joined.LabelID) + }) t.Run("SkipZeroProbability", func(t *testing.T) { photo := PhotoFixtures.Get("Photo15") initialLen := len(photo.Labels) @@ -1339,7 +1377,7 @@ func TestPhoto_SetPrimary(t *testing.T) { t.Run("UpdateQualityErrorIsNonFatal", func(t *testing.T) { originalProvider := dbConn tempConn := &DbConn{ - Driver: SQLite3, + Driver: dsn.DriverSQLite3, Dsn: fmt.Sprintf("%s/%s", t.TempDir(), "set-primary-quality-error.db"), } @@ -1609,10 +1647,21 @@ func TestPhoto_ArchiveRestore(t *testing.T) { } func TestPhoto_SetCameraSerial(t *testing.T) { - m := &Photo{} - assert.Empty(t, m.CameraSerial) - m.SetCameraSerial("abcCamera") - assert.Equal(t, "abcCamera", m.CameraSerial) + t.Run("Success", func(t *testing.T) { + m := &Photo{} + assert.Empty(t, m.CameraSerial) + m.SetCameraSerial("abcCamera") + assert.Equal(t, "abcCamera", m.CameraSerial) + }) + t.Run("MultiByteClippedOnRuneBoundary", func(t *testing.T) { + // camera_serial is VARBINARY(160), so a long multi-byte value must be byte-clipped + // without splitting a rune, keeping the stored value within budget and valid UTF-8. + m := &Photo{} + m.SetCameraSerial(strings.Repeat("世", 100)) // 100 runes x 3 bytes = 300 bytes. + assert.NotEmpty(t, m.CameraSerial) + assert.LessOrEqual(t, len(m.CameraSerial), txt.ClipDefault) + assert.True(t, utf8.ValidString(m.CameraSerial)) + }) } func TestPhoto_MapKey(t *testing.T) { diff --git a/internal/entity/query/albums.go b/internal/entity/query/albums.go index 95691da52..18e9e2108 100644 --- a/internal/entity/query/albums.go +++ b/internal/entity/query/albums.go @@ -10,6 +10,7 @@ import ( "github.com/photoprism/photoprism/internal/entity/sortby" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/media" "github.com/photoprism/photoprism/pkg/rnd" ) @@ -120,7 +121,7 @@ func UpdateAlbumDates() error { defer mutex.Index.Unlock() switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: return UnscopedDb().Exec(`UPDATE albums INNER JOIN ( SELECT photo_path, MAX(taken_at_local) AS taken_max FROM photos WHERE taken_src = 'meta' AND photos.photo_quality >= 3 AND photos.deleted_at IS NULL diff --git a/internal/entity/query/camera.go b/internal/entity/query/camera.go new file mode 100644 index 000000000..818efb0bb --- /dev/null +++ b/internal/entity/query/camera.go @@ -0,0 +1,35 @@ +package query + +import ( + "github.com/photoprism/photoprism/internal/entity" +) + +// FindCameraBySlug returns an existing entity if exists. +func FindCameraBySlug(slug string) *entity.Camera { + if slug == "" { + return nil + } + + c := entity.Camera{} + + if err := Db().Where("camera_slug = ?", slug).First(&c).Error; err != nil { + return nil + } + + return &c +} + +// FindCameraByID returns an existing entity if exists. +func FindCameraByID(id uint) *entity.Camera { + if id == 0 { + return nil + } + + c := entity.Camera{} + + if err := Db().Where("id = ?", id).First(&c).Error; err != nil { + return nil + } + + return &c +} diff --git a/internal/entity/query/camera_test.go b/internal/entity/query/camera_test.go new file mode 100644 index 000000000..8a320c1c6 --- /dev/null +++ b/internal/entity/query/camera_test.go @@ -0,0 +1,47 @@ +package query + +import ( + "testing" + + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/entity" +) + +func TestFindCameraBySlug(t *testing.T) { + t.Run("ExistingCamera", func(t *testing.T) { + camera := FindCameraBySlug(entity.CameraFixtures.Get("canon-eos-7d").CameraSlug) + assert.NotNil(t, camera) + if camera != nil { + assert.Equal(t, entity.CameraFixtures.Get("canon-eos-7d").ID, camera.ID) + assert.Equal(t, entity.CameraFixtures.Get("canon-eos-7d").CameraModel, camera.CameraModel) + } + }) + t.Run("NotExistingCamera", func(t *testing.T) { + camera := FindCameraBySlug("IAmNotValid") + assert.Nil(t, camera) + }) + t.Run("EmptySlug", func(t *testing.T) { + camera := FindCameraBySlug("") + assert.Nil(t, camera) + }) +} + +func TestFindCameraByID(t *testing.T) { + t.Run("ExistingCamera", func(t *testing.T) { + camera := FindCameraByID(entity.CameraFixtures.Get("canon-eos-7d").ID) + assert.NotNil(t, camera) + if camera != nil { + assert.Equal(t, entity.CameraFixtures.Get("canon-eos-7d").ID, camera.ID) + assert.Equal(t, entity.CameraFixtures.Get("canon-eos-7d").CameraModel, camera.CameraModel) + } + }) + t.Run("NotExistingCamera", func(t *testing.T) { + camera := FindCameraByID(99885541348) + assert.Nil(t, camera) + }) + t.Run("ZeroID", func(t *testing.T) { + camera := FindCameraByID(0) + assert.Nil(t, camera) + }) +} diff --git a/internal/entity/query/covers.go b/internal/entity/query/covers.go index 54aaf7798..b678381db 100644 --- a/internal/entity/query/covers.go +++ b/internal/entity/query/covers.go @@ -12,6 +12,7 @@ import ( "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/mutex" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/media" ) @@ -45,7 +46,7 @@ func UpdateAlbumManualCovers(albums ...entity.Album) (err error) { condition := gorm.Expr("album_type = ? AND thumb_src = ?", entity.AlbumManual, entity.SrcAuto) switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: res = Db().Exec(`UPDATE albums LEFT JOIN ( SELECT p2.album_uid, f.file_hash FROM files f, ( SELECT pa.album_uid, max(p.id) AS photo_id FROM photos p @@ -54,7 +55,7 @@ func UpdateAlbumManualCovers(albums ...entity.Album) (err error) { GROUP BY pa.album_uid) p2 WHERE p2.photo_id = f.photo_id AND f.file_primary = 1 AND f.file_error = '' AND f.file_type IN (?) ) b ON b.album_uid = albums.album_uid SET thumb = b.file_hash WHERE ?`, media.PreviewExpr, condition) - case SQLite3: + case dsn.DriverSQLite3: res = Db().Table(entity.Album{}.TableName()). UpdateColumn("thumb", gorm.Expr(`( SELECT f.file_hash FROM files f @@ -108,7 +109,7 @@ func UpdateAlbumFolderCovers(albums ...entity.Album) (err error) { condition := gorm.Expr("album_type = ? AND thumb_src = ?", entity.AlbumFolder, entity.SrcAuto) switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: res = Db().Exec(`UPDATE albums LEFT JOIN ( SELECT p2.photo_path, f.file_hash FROM files f, ( SELECT p.photo_path, max(p.id) AS photo_id FROM photos p @@ -116,7 +117,7 @@ func UpdateAlbumFolderCovers(albums ...entity.Album) (err error) { GROUP BY p.photo_path) p2 WHERE p2.photo_id = f.photo_id AND f.file_primary = 1 AND f.file_error = '' AND f.file_type IN (?) ) b ON b.photo_path = albums.album_path SET thumb = b.file_hash WHERE ?`, media.PreviewExpr, condition) - case SQLite3: + case dsn.DriverSQLite3: res = Db().Table(entity.Album{}.TableName()).UpdateColumn("thumb", gorm.Expr(`( SELECT f.file_hash FROM files f,( SELECT p.photo_path, max(p.id) AS photo_id FROM photos p @@ -171,7 +172,7 @@ func UpdateAlbumMonthCovers(albums ...entity.Album) (err error) { condition := gorm.Expr("album_type = ? AND thumb_src = ?", entity.AlbumMonth, entity.SrcAuto) switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: res = Db().Exec(`UPDATE albums LEFT JOIN ( SELECT p2.photo_year, p2.photo_month, f.file_hash FROM files f, ( SELECT p.photo_year, p.photo_month, max(p.id) AS photo_id FROM photos p @@ -179,7 +180,7 @@ func UpdateAlbumMonthCovers(albums ...entity.Album) (err error) { GROUP BY p.photo_year, p.photo_month) p2 WHERE p2.photo_id = f.photo_id AND f.file_primary = 1 AND f.file_error = '' AND f.file_type IN (?) ) b ON b.photo_year = albums.album_year AND b.photo_month = albums.album_month SET thumb = b.file_hash WHERE ?`, media.PreviewExpr, condition) - case SQLite3: + case dsn.DriverSQLite3: res = Db().Table(entity.Album{}.TableName()).UpdateColumn("thumb", gorm.Expr(`( SELECT f.file_hash FROM files f,( SELECT p.photo_year, p.photo_month, max(p.id) AS photo_id FROM photos p @@ -322,7 +323,7 @@ func refreshFolderAlbumCover(album entity.Album) error { } switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: res := Db().Exec(`UPDATE albums LEFT JOIN ( SELECT p2.photo_path, f.file_hash FROM files f, ( SELECT p.photo_path, max(p.id) AS photo_id FROM photos p @@ -338,7 +339,7 @@ func refreshFolderAlbumCover(album entity.Album) error { ) return res.Error - case SQLite3: + case dsn.DriverSQLite3: res := Db().Table(entity.Album{}.TableName()). Where("album_uid = ? AND album_type = ? AND thumb_src = ?", album.AlbumUID, entity.AlbumFolder, entity.SrcAuto). UpdateColumn("thumb", gorm.Expr(`( @@ -366,7 +367,7 @@ func refreshMonthAlbumCover(album entity.Album) error { } switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: res := Db().Exec(`UPDATE albums LEFT JOIN ( SELECT p2.photo_year, p2.photo_month, f.file_hash FROM files f, ( SELECT p.photo_year, p.photo_month, max(p.id) AS photo_id FROM photos p @@ -383,7 +384,7 @@ func refreshMonthAlbumCover(album entity.Album) error { ) return res.Error - case SQLite3: + case dsn.DriverSQLite3: res := Db().Table(entity.Album{}.TableName()). Where("album_uid = ? AND album_type = ? AND thumb_src = ?", album.AlbumUID, entity.AlbumMonth, entity.SrcAuto). UpdateColumn("thumb", gorm.Expr(`( @@ -416,7 +417,7 @@ func UpdateLabelCovers() (err error) { condition := gorm.Expr("thumb_src = ?", entity.SrcAuto) switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: res = Db().Exec(`UPDATE labels LEFT JOIN ( SELECT p2.label_id, f.file_hash FROM files f, ( SELECT pl.label_id as label_id, max(p.id) AS photo_id FROM photos p @@ -432,7 +433,7 @@ func UpdateLabelCovers() (err error) { ) p2 WHERE p2.photo_id = f.photo_id AND f.file_primary = 1 AND f.file_error = '' AND f.file_type IN (?) AND f.file_missing = 0 ) b ON b.label_id = labels.id SET thumb = b.file_hash WHERE ?`, media.PreviewExpr, condition) - case SQLite3: + case dsn.DriverSQLite3: res = Db().Table(entity.Label{}.TableName()).UpdateColumn("thumb", gorm.Expr(`( SELECT f.file_hash FROM files f JOIN photos_labels pl ON pl.label_id = labels.id AND pl.photo_id = f.photo_id AND pl.uncertainty < 100 @@ -494,7 +495,7 @@ func UpdateSubjectCovers(public bool) (err error) { // Compose SQL update query. switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: res = Db().Exec(`UPDATE subjects LEFT JOIN ( SELECT m.subj_uid, m.q, MAX(m.thumb) AS marker_thumb FROM markers m @@ -508,7 +509,7 @@ func UpdateSubjectCovers(public bool) (err error) { photosJoin, condition, ) - case SQLite3: + case dsn.DriverSQLite3: // from := gorm.Expr(fmt.Sprintf("%s m WHERE m.subj_uid = %s.subj_uid ", markerTable, subjTable)) res = Db().Table(entity.Subject{}.TableName()).UpdateColumn("thumb", gorm.Expr(`( @@ -541,17 +542,32 @@ func UpdateSubjectCovers(public bool) (err error) { return err } -// UpdateCoversAsync runs UpdateCovers in a go routine -// and logs the returned error, if any, as a warning. +// UpdateCoversAsync runs UpdateCovers in a goroutine and logs the +// returned error, if any, as a warning. The launched goroutine is +// registered with the shared entity package WaitGroup so config.CloseDb +// can drain in-flight work via entity.WaitForAsyncJobs before tearing +// down the database connection. A deferred recover guards against any +// future shutdown race producing a process-killing panic instead of a +// clean log line. func UpdateCoversAsync() { + entity.AsyncJobAdd() go func() { + defer entity.AsyncJobDone() + defer func() { + if r := recover(); r != nil { + log.Errorf("index: recovered from panic in UpdateCoversAsync (%v)", r) + } + }() if err := UpdateCovers(); err != nil { log.Warnf("index: %s (update covers)", clean.Error(err)) } }() } -// UpdateCovers updates album, subject, and label cover thumbs. +// UpdateCovers updates album, subject, and label cover thumbs. It +// returns nil without doing any work when the entity database provider +// has been torn down (e.g. during test shutdown), so a stray async +// invocation after CloseDb does not panic on a nil dialect lookup. func UpdateCovers() (err error) { if !coversBusy.CompareAndSwap(false, true) { log.Debugf("index: skipped updating covers because it is already in progress") @@ -560,6 +576,11 @@ func UpdateCovers() (err error) { defer coversBusy.Store(false) + if entity.Db() == nil { + log.Debugf("index: skipped updating covers because database is not connected") + return nil + } + log.Debugf("index: updating covers") // Update Albums. diff --git a/internal/entity/query/covers_test.go b/internal/entity/query/covers_test.go index ff0daf08d..79a140151 100644 --- a/internal/entity/query/covers_test.go +++ b/internal/entity/query/covers_test.go @@ -16,6 +16,7 @@ func TestUpdateAlbumManualCovers(t *testing.T) { func TestUpdateAlbumManualCoversFiltered(t *testing.T) { var album entity.Album + assert.NoError(t, UpdateAlbumManualCovers()) if err := UnscopedDb().Where("album_type = ? AND thumb_src = ? AND thumb <> ''", entity.AlbumManual, entity.SrcAuto).First(&album).Error; err != nil { t.Skipf("no auto-managed manual album available: %v", err) } @@ -46,6 +47,7 @@ func TestUpdateAlbumFolderCovers(t *testing.T) { func TestUpdateAlbumFolderCoversFiltered(t *testing.T) { var album entity.Album + assert.NoError(t, UpdateAlbumFolderCovers()) if err := UnscopedDb().Where("album_type = ? AND thumb_src = ? AND album_path <> '' AND thumb <> ''", entity.AlbumFolder, entity.SrcAuto).First(&album).Error; err != nil { t.Skipf("no auto-managed folder album available: %v", err) } @@ -115,5 +117,33 @@ func TestUpdateSubjectCovers(t *testing.T) { func TestUpdateCovers(t *testing.T) { // coversBusy.Store(true) UpdateCoversAsync() + // Drain the async goroutine so it doesn't race the next test that + // might temporarily swap out the entity DB provider. + entity.WaitForAsyncJobs() assert.NoError(t, UpdateCovers()) } + +func TestUpdateCovers_NilDbReturnsCleanly(t *testing.T) { + // Mirrors TestUpdateCounts_NilDbReturnsCleanly: after CloseDb has + // nilled the entity DB provider, UpdateCovers must return nil instead + // of panicking on a nil dialect lookup so a stray UpdateCoversAsync + // goroutine does not crash the process during shutdown. + prev := swapDbProvider(nil) + defer swapDbProvider(prev) + + assert.NoError(t, UpdateCovers()) +} + +// swapDbProvider replaces the package-level entity DB provider with the +// supplied value and returns a snapshot of the previous one wrapped in +// staticDbProvider so callers can restore the original *gorm.DB. The +// query package's staticDbProvider helper is reused to mirror existing +// override patterns in faces_test.go. +func swapDbProvider(p entity.Gorm) entity.Gorm { + var prev entity.Gorm + if currentDb := entity.Db(); currentDb != nil { + prev = staticDbProvider{db: currentDb} + } + entity.SetDbProvider(p) + return prev +} diff --git a/internal/entity/query/faces.go b/internal/entity/query/faces.go index 64488c9b7..acdeb8814 100644 --- a/internal/entity/query/faces.go +++ b/internal/entity/query/faces.go @@ -26,7 +26,7 @@ type FaceMap map[string]entity.Face // because markers still reference them. Callers may treat this as a non-fatal warning. var ErrRetainedManualClusters = errors.New("faces: retained manual clusters after merge") -// MergeMaxRetry limits how often the optimiser retries stubborn manual clusters (0 = unlimited). +// MergeMaxRetry limits how often the optimizer retries stubborn manual clusters (0 = unlimited). var MergeMaxRetry = 1 func init() { diff --git a/internal/entity/query/faces_test.go b/internal/entity/query/faces_test.go index dd2d2c284..35c4b231e 100644 --- a/internal/entity/query/faces_test.go +++ b/internal/entity/query/faces_test.go @@ -10,6 +10,7 @@ import ( "github.com/photoprism/photoprism/internal/ai/face" "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/rnd" ) @@ -135,7 +136,7 @@ func TestMatchFaceMarkers_ReturnsUpdateError(t *testing.T) { require.NotNil(t, originalDb) tempConn := &entity.DbConn{ - Driver: entity.SQLite3, + Driver: dsn.DriverSQLite3, Dsn: filepath.Join(t.TempDir(), "match-face-markers-error.db"), } diff --git a/internal/entity/query/file_selection.go b/internal/entity/query/file_selection.go index 54bd8d7ab..d44ced355 100644 --- a/internal/entity/query/file_selection.go +++ b/internal/entity/query/file_selection.go @@ -4,9 +4,11 @@ import ( "errors" "fmt" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/fs" "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/internal/entity/search" "github.com/photoprism/photoprism/internal/form" "github.com/photoprism/photoprism/pkg/media" ) @@ -85,6 +87,18 @@ func ShareSelection(originals bool) FileSelection { // SelectedFiles finds files based on the given selection form, e.g. for downloading or sharing. func SelectedFiles(frm form.Selection, o FileSelection) (results entity.Files, err error) { + return selectedFiles(frm, o, nil) +} + +// SelectedFilesForSession works like SelectedFiles but limits the result to the session's shared +// scope. Full library and admin sessions are not limited, so this adds no overhead for them. +func SelectedFilesForSession(frm form.Selection, o FileSelection, sess *entity.Session) (results entity.Files, err error) { + return selectedFiles(frm, o, sess) +} + +// selectedFiles finds files based on the given selection form, optionally limited to the content +// the session may access when sess is not nil. +func selectedFiles(frm form.Selection, o FileSelection, sess *entity.Session) (results entity.Files, err error) { if frm.Empty() { return results, errors.New("no items selected") } @@ -98,9 +112,9 @@ func SelectedFiles(frm form.Selection, o FileSelection) (results entity.Files, e var concat string switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: concat = "CONCAT(a.path, '/%')" - case SQLite3: + case dsn.DriverSQLite3: concat = "a.path || '/%'" default: return results, fmt.Errorf("unknown sql dialect: %s", DbDialect()) @@ -177,6 +191,11 @@ func SelectedFiles(frm form.Selection, o FileSelection) (results entity.Files, e s = s.Where("photos.deleted_at IS NULL") } + // Limit the selection to the session's shared scope (no-op for full-access sessions). + if sess != nil { + s = search.ScopeVisiblePhotos(s, sess) + } + // Find and return. if result := s.Scan(&results); result.Error != nil { return results, result.Error diff --git a/internal/entity/query/file_selection_test.go b/internal/entity/query/file_selection_test.go index 4f022279e..feec4712c 100644 --- a/internal/entity/query/file_selection_test.go +++ b/internal/entity/query/file_selection_test.go @@ -5,9 +5,42 @@ import ( "github.com/stretchr/testify/assert" + "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/form" ) +// aclSession builds an in-memory session for the named user fixture. +func aclSession(name string) *entity.Session { + s := &entity.Session{} + s.SetUser(entity.UserFixtures.Pointer(name)) + return s +} + +func TestSelectedFilesForSession(t *testing.T) { + // Include private pictures in the base selection so the session scope is what filters them. + o := FileSelection{Private: true, MaxSize: 1024 * MiB} + private := form.Selection{Photos: []string{"ps6sg6be2lvl0y13"}} // "Photo06", private + + t.Run("AdminSeesPrivate", func(t *testing.T) { + files, err := SelectedFilesForSession(private, o, aclSession("alice")) + assert.NoError(t, err) + assert.NotEmpty(t, files) + }) + t.Run("GuestDeniedPrivate", func(t *testing.T) { + files, err := SelectedFilesForSession(private, o, aclSession("guest")) + assert.NoError(t, err) + assert.Empty(t, files) + }) + t.Run("NilMatchesSelectedFiles", func(t *testing.T) { + frm := form.Selection{Photos: []string{"ps6sg6be2lvl0yh7"}} + base, err := SelectedFiles(frm, o) + assert.NoError(t, err) + scoped, err := SelectedFilesForSession(frm, o, nil) + assert.NoError(t, err) + assert.Equal(t, len(base), len(scoped)) + }) +} + func TestFileSelection(t *testing.T) { none := form.Selection{Photos: []string{}} diff --git a/internal/entity/query/folders.go b/internal/entity/query/folders.go index 5a2ec3dcb..154378325 100644 --- a/internal/entity/query/folders.go +++ b/internal/entity/query/folders.go @@ -5,6 +5,7 @@ import ( "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/mutex" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/fs" "github.com/photoprism/photoprism/pkg/media" ) @@ -75,7 +76,7 @@ func UpdateFolderDates() error { defer mutex.Index.Unlock() switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: return UnscopedDb().Exec(`UPDATE folders INNER JOIN (SELECT photo_path, MAX(taken_at_local) AS taken_max diff --git a/internal/entity/query/lens.go b/internal/entity/query/lens.go new file mode 100644 index 000000000..5e9d590e8 --- /dev/null +++ b/internal/entity/query/lens.go @@ -0,0 +1,35 @@ +package query + +import ( + "github.com/photoprism/photoprism/internal/entity" +) + +// FindLensBySlug returns an existing entity if exists. +func FindLensBySlug(slug string) *entity.Lens { + if slug == "" { + return nil + } + + l := entity.Lens{} + + if err := Db().Where("lens_slug = ?", slug).First(&l).Error; err != nil { + return nil + } + + return &l +} + +// FindLensByID returns an existing entity if exists. +func FindLensByID(id uint) *entity.Lens { + if id == 0 { + return nil + } + + l := entity.Lens{} + + if err := Db().Where("id = ?", id).First(&l).Error; err != nil { + return nil + } + + return &l +} diff --git a/internal/entity/query/lens_test.go b/internal/entity/query/lens_test.go new file mode 100644 index 000000000..93b89cff1 --- /dev/null +++ b/internal/entity/query/lens_test.go @@ -0,0 +1,39 @@ +package query + +import ( + "testing" + + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/entity" +) + +func TestFindLensBySlug(t *testing.T) { + t.Run("ExistingLens", func(t *testing.T) { + lens := FindLensBySlug(entity.LensFixtures.Get("4.15mm-f/2.2").LensSlug) + assert.NotNil(t, lens) + if lens != nil { + assert.Equal(t, entity.LensFixtures.Get("4.15mm-f/2.2").ID, lens.ID) + assert.Equal(t, entity.LensFixtures.Get("4.15mm-f/2.2").LensModel, lens.LensModel) + } + }) + t.Run("NotExistingLens", func(t *testing.T) { + lens := FindLensBySlug("IAmNotValid") + assert.Nil(t, lens) + }) +} + +func TestFindLensByID(t *testing.T) { + t.Run("ExistingLens", func(t *testing.T) { + lens := FindLensByID(entity.LensFixtures.Get("4.15mm-f/2.2").ID) + assert.NotNil(t, lens) + if lens != nil { + assert.Equal(t, entity.LensFixtures.Get("4.15mm-f/2.2").ID, lens.ID) + assert.Equal(t, entity.LensFixtures.Get("4.15mm-f/2.2").LensModel, lens.LensModel) + } + }) + t.Run("NotExistingLens", func(t *testing.T) { + lens := FindLensByID(99885541348) + assert.Nil(t, lens) + }) +} diff --git a/internal/entity/query/moments.go b/internal/entity/query/moments.go index 25de394a5..7b8f7208f 100644 --- a/internal/entity/query/moments.go +++ b/internal/entity/query/moments.go @@ -305,21 +305,32 @@ func MomentsLabels(threshold int, public bool) (results Moments, err error) { return results, nil } -// RemoveDuplicateMoments deletes generated albums with duplicate slug or filter. -func RemoveDuplicateMoments() (removed int, err error) { - if res := UnscopedDb().Exec(`DELETE FROM links WHERE share_uid - IN (SELECT a.album_uid FROM albums a JOIN albums b ON a.album_type <> ? +// duplicateMomentsFrom is the shared FROM/WHERE that pairs a generated album (a) +// with an earlier same-type sibling (b) it duplicates. It binds three parameters +// in order: the album type to skip (manual), then the folder type twice. +// +// Folder album slugs are not unique identities: long nested paths are truncated to +// ClipSlug runes and slug.Make drops emoji, so distinct sibling folders can share one +// album_slug. Folder albums are therefore deduplicated by album_filter (the serialized +// path) alone; only non-folder albums treat a matching album_slug as a duplicate. +const duplicateMomentsFrom = `albums a JOIN albums b ON a.album_type <> ? AND a.album_type = b.album_type AND a.id > b.id - WHERE (a.album_slug = b.album_slug OR a.album_filter = b.album_filter) - GROUP BY a.album_uid)`, entity.AlbumManual); res.Error != nil { + WHERE ((a.album_type = ? AND a.album_filter = b.album_filter) + OR (a.album_type <> ? AND (a.album_slug = b.album_slug OR a.album_filter = b.album_filter))) + GROUP BY a.album_uid` + +// RemoveDuplicateMoments deletes generated albums with a duplicate filter, or a +// duplicate slug for non-folder album types. +func RemoveDuplicateMoments() (removed int, err error) { + if res := UnscopedDb().Exec(`DELETE FROM links WHERE share_uid IN ( + SELECT a.album_uid FROM `+duplicateMomentsFrom+`)`, + entity.AlbumManual, entity.AlbumFolder, entity.AlbumFolder); res.Error != nil { return removed, res.Error } - if res := UnscopedDb().Exec(`DELETE FROM albums WHERE id - IN (SELECT a.id FROM albums a JOIN albums b ON a.album_type <> ? - AND a.album_type = b.album_type AND a.id > b.id - WHERE (a.album_slug = b.album_slug OR a.album_filter = b.album_filter) - GROUP BY a.album_uid)`, entity.AlbumManual); res.Error != nil { + if res := UnscopedDb().Exec(`DELETE FROM albums WHERE id IN ( + SELECT a.id FROM `+duplicateMomentsFrom+`)`, + entity.AlbumManual, entity.AlbumFolder, entity.AlbumFolder); res.Error != nil { return removed, res.Error } else if res.RowsAffected > 0 { removed = int(res.RowsAffected) diff --git a/internal/entity/query/moments_test.go b/internal/entity/query/moments_test.go index cf18b19cb..af6b1cd97 100644 --- a/internal/entity/query/moments_test.go +++ b/internal/entity/query/moments_test.go @@ -1,13 +1,25 @@ package query import ( + "strings" "testing" + "time" "github.com/dustin/go-humanize/english" "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/pkg/txt" ) +// albumRowExists reports whether an album row with the given UID still exists. +func albumRowExists(uid string) bool { + var n int64 + UnscopedDb().Model(&entity.Album{}).Where("album_uid = ?", uid).Count(&n) + return n > 0 +} + func TestMomentsTime(t *testing.T) { t.Run("PublicOnly", func(t *testing.T) { results, err := MomentsTime(1, true) @@ -332,4 +344,138 @@ func TestRemoveDuplicateMoments(t *testing.T) { assert.GreaterOrEqual(t, removed, 1) } }) + t.Run("KeepsLongAsciiSiblings", func(t *testing.T) { + unique := txt.Slug(time.Now().UTC().Format(time.RFC3339Nano)) + base := "pictures/Ferie 2008 Mellomeuropa/Galleri-konvertert/bilder/" + unique + "/" + pathA := base + "01 Praha, Dresden, Wroclaw" + pathB := base + "02 Wroclaw, Auschwitz" + + albumA := entity.NewFolderAlbum("01 Praha, Dresden, Wroclaw", pathA, `path:"`+pathA+`" public:true`) + if albumA == nil { + t.Fatal("expected albumA") + } + if err := albumA.Create(); err != nil { + t.Fatal(err) + } + t.Cleanup(func() { _ = albumA.DeletePermanently() }) + + albumB := entity.NewFolderAlbum("02 Wroclaw, Auschwitz", pathB, `path:"`+pathB+`" public:true`) + if albumB == nil { + t.Fatal("expected albumB") + } + if err := albumB.Create(); err != nil { + t.Fatal(err) + } + t.Cleanup(func() { _ = albumB.DeletePermanently() }) + + assert.NotEqual(t, albumA.AlbumSlug, albumB.AlbumSlug) + + if _, err := RemoveDuplicateMoments(); err != nil { + t.Fatal(err) + } + + assert.NotNil(t, entity.FindFolderAlbum(pathA), "albumA should survive RemoveDuplicateMoments") + assert.NotNil(t, entity.FindFolderAlbum(pathB), "albumB should survive RemoveDuplicateMoments") + }) + t.Run("KeepsSlugCollidingSiblings", func(t *testing.T) { + // Two legacy emoji sibling folders collapse to the same slug because slug.Make + // drops the emoji ("base/🪞" and "base/🎃" both slug to "base"). album_slug is + // VARBINARY, so the slugs match byte-exact and the pair looks like a duplicate. + // The HEX(album_path) guard keeps the byte-distinct paths from being deleted. + base := "emoji-moments-" + txt.Slug(time.Now().UTC().Format(time.RFC3339Nano)) + pathMirror := base + "/🪞" + pathPumpkin := base + "/🎃" + sharedSlug := txt.Clip(base, txt.ClipSlug) + + albumMirror := &entity.Album{AlbumType: entity.AlbumFolder, AlbumSlug: sharedSlug, AlbumPath: pathMirror, AlbumFilter: `path:"` + pathMirror + `" public:true`} + albumMirror.SetTitle("🪞") + if err := albumMirror.Create(); err != nil { + t.Fatal(err) + } + t.Cleanup(func() { _ = albumMirror.DeletePermanently() }) + + albumPumpkin := &entity.Album{AlbumType: entity.AlbumFolder, AlbumSlug: sharedSlug, AlbumPath: pathPumpkin, AlbumFilter: `path:"` + pathPumpkin + `" public:true`} + albumPumpkin.SetTitle("🎃") + if err := albumPumpkin.Create(); err != nil { + t.Fatal(err) + } + t.Cleanup(func() { _ = albumPumpkin.DeletePermanently() }) + + assert.Equal(t, albumMirror.AlbumSlug, albumPumpkin.AlbumSlug) + + if _, err := RemoveDuplicateMoments(); err != nil { + t.Fatal(err) + } + + assert.NotNil(t, entity.FindFolderAlbum(pathMirror), "mirror album should survive RemoveDuplicateMoments") + assert.NotNil(t, entity.FindFolderAlbum(pathPumpkin), "pumpkin album should survive RemoveDuplicateMoments") + }) + t.Run("KeepsSlugCollidingLegacyFoldersWithoutPath", func(t *testing.T) { + // Regression for #5614: folder albums indexed before album_path was persisted have + // an empty path and a plain-truncated, collision-prone slug. Distinct deep folders + // that share that truncated slug must not be treated as duplicates of each other. + unique := txt.Slug(time.Now().UTC().Format(time.RFC3339Nano)) + base := "pictures/" + strings.Repeat("ferie-2008-mellomeuropa/", 4) + "galleri-" + unique + "/" + pathA := base + "01 Praha, Dresden, Wroclaw" + pathB := base + "09 Praha" + sharedSlug := txt.Clip(txt.Slug(pathA), txt.ClipSlug) + assert.Equal(t, sharedSlug, txt.Clip(txt.Slug(pathB), txt.ClipSlug), "precondition: legacy slugs collide") + + albumA := &entity.Album{AlbumType: entity.AlbumFolder, AlbumSlug: sharedSlug, AlbumPath: "", AlbumFilter: `path:"` + pathA + `" public:true`} + albumA.SetTitle("01 Praha, Dresden, Wroclaw") + if err := albumA.Create(); err != nil { + t.Fatal(err) + } + t.Cleanup(func() { _ = albumA.DeletePermanently() }) + + albumB := &entity.Album{AlbumType: entity.AlbumFolder, AlbumSlug: sharedSlug, AlbumPath: "", AlbumFilter: `path:"` + pathB + `" public:true`} + albumB.SetTitle("09 Praha") + if err := albumB.Create(); err != nil { + t.Fatal(err) + } + t.Cleanup(func() { _ = albumB.DeletePermanently() }) + + assert.Equal(t, albumA.AlbumSlug, albumB.AlbumSlug) + assert.NotEqual(t, albumA.AlbumFilter, albumB.AlbumFilter) + + if _, err := RemoveDuplicateMoments(); err != nil { + t.Fatal(err) + } + + assert.True(t, albumRowExists(albumA.AlbumUID), "albumA should survive RemoveDuplicateMoments") + assert.True(t, albumRowExists(albumB.AlbumUID), "albumB should survive RemoveDuplicateMoments") + }) + t.Run("RemovesDuplicateFolderWithSameFilter", func(t *testing.T) { + // A genuine duplicate folder album (identical serialized path) must still be removed. + unique := txt.Slug(time.Now().UTC().Format(time.RFC3339Nano)) + path := "pictures/duplicate-folder-" + unique + filter := `path:"` + path + `" public:true` + + first := &entity.Album{AlbumType: entity.AlbumFolder, AlbumSlug: txt.SlugUnique(path), AlbumPath: path, AlbumFilter: filter} + first.SetTitle("Duplicate Folder") + if err := first.Create(); err != nil { + t.Fatal(err) + } + t.Cleanup(func() { _ = first.DeletePermanently() }) + + second := &entity.Album{AlbumType: entity.AlbumFolder, AlbumSlug: txt.SlugUnique(path), AlbumPath: path, AlbumFilter: filter} + second.SetTitle("Duplicate Folder") + if err := second.Create(); err != nil { + t.Fatal(err) + } + t.Cleanup(func() { _ = second.DeletePermanently() }) + + if _, err := RemoveDuplicateMoments(); err != nil { + t.Fatal(err) + } + + remaining := 0 + if albumRowExists(first.AlbumUID) { + remaining++ + } + if albumRowExists(second.AlbumUID) { + remaining++ + } + assert.Equal(t, 1, remaining, "exactly one of the same-filter folder albums should remain") + }) } diff --git a/internal/entity/query/photo.go b/internal/entity/query/photo.go index fa2e915c3..bd35acf35 100644 --- a/internal/entity/query/photo.go +++ b/internal/entity/query/photo.go @@ -191,9 +191,10 @@ func FixPrimaries() error { var photos entity.Photos - // Remove primary file flag from broken or missing files. + // Remove primary file flag from broken, missing, or deleted files so a photo whose primary is no + // longer valid is treated as having none and gets a present file promoted below. if err := UnscopedDb().Table(entity.File{}.TableName()). - Where("(file_error <> '' OR file_missing = 1) AND file_primary <> 0"). + Where("(file_error <> '' OR file_missing = 1 OR deleted_at IS NOT NULL) AND file_primary <> 0"). UpdateColumn("file_primary", 0).Error; err != nil { return err } diff --git a/internal/entity/query/photo_selection.go b/internal/entity/query/photo_selection.go index b282dec3d..1a9ab23b5 100644 --- a/internal/entity/query/photo_selection.go +++ b/internal/entity/query/photo_selection.go @@ -4,10 +4,35 @@ import ( "errors" "fmt" + "github.com/photoprism/photoprism/pkg/dsn" + "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/internal/entity/search" "github.com/photoprism/photoprism/internal/form" ) +// SelectedPhotoUIDsForSession returns the subset of the given photo UIDs that the session is +// allowed to access, applying the same shared-scope, private, and archived rules as photo search, +// so restricted callers can only act on pictures within their shared scope. Full library or admin +// sessions (client and user role intersection) see every picture, so the input is returned without +// a database query; it is therefore safe and cheap to call for any session. +func SelectedPhotoUIDsForSession(photoUIDs []string, sess *entity.Session) (scoped []string, err error) { + if len(photoUIDs) == 0 || search.PhotoSessionSeesEverything(sess) { + return photoUIDs, nil + } + + stmt := search.ScopeVisiblePhotos( + UnscopedDb().Table("photos").Where("photos.photo_uid IN (?)", photoUIDs), + sess, + ) + + if err = stmt.Pluck("photos.photo_uid", &scoped).Error; err != nil { + return nil, err + } + + return scoped, nil +} + // SelectedPhotos finds photos based on the given selection form, e.g. for adding them to an album. func SelectedPhotos(frm form.Selection) (results entity.Photos, err error) { if frm.Empty() { @@ -24,9 +49,9 @@ func SelectedPhotos(frm form.Selection) (results entity.Photos, err error) { var concat string switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: concat = "CONCAT(a.path, '/%')" - case SQLite3: + case dsn.DriverSQLite3: concat = "a.path || '/%'" default: return results, fmt.Errorf("unknown sql dialect: %s", DbDialect()) diff --git a/internal/entity/query/photo_selection_test.go b/internal/entity/query/photo_selection_test.go index e942af24d..a8127a360 100644 --- a/internal/entity/query/photo_selection_test.go +++ b/internal/entity/query/photo_selection_test.go @@ -9,6 +9,44 @@ import ( "github.com/photoprism/photoprism/internal/form" ) +func TestSelectedPhotoUIDsForSession(t *testing.T) { + const ( + normalUID = "ps6sg6be2lvl0yh7" // not private, not archived, not shared with guests + privateUID = "ps6sg6be2lvl0y13" // "Photo06", private + ) + uids := []string{normalUID, privateUID} + + t.Run("AdminSeesAll", func(t *testing.T) { + scoped, err := SelectedPhotoUIDsForSession(uids, aclSession("alice")) + assert.NoError(t, err) + assert.ElementsMatch(t, uids, scoped) + }) + t.Run("GuestExcludesPrivateAndUnshared", func(t *testing.T) { + scoped, err := SelectedPhotoUIDsForSession(uids, aclSession("guest")) + assert.NoError(t, err) + assert.NotContains(t, scoped, privateUID) + assert.NotContains(t, scoped, normalUID) + }) + t.Run("NilSessionUnchanged", func(t *testing.T) { + scoped, err := SelectedPhotoUIDsForSession(uids, nil) + assert.NoError(t, err) + assert.ElementsMatch(t, uids, scoped) + }) + t.Run("AdminShortCircuitSkipsQuery", func(t *testing.T) { + // Full-access sessions return the input verbatim without a scope query, so even an unknown + // UID passes through (existence is checked by the caller's own lookup). + in := []string{normalUID, "ps000000000unknown"} + scoped, err := SelectedPhotoUIDsForSession(in, aclSession("alice")) + assert.NoError(t, err) + assert.Equal(t, in, scoped) + }) + t.Run("EmptyInput", func(t *testing.T) { + scoped, err := SelectedPhotoUIDsForSession(nil, aclSession("guest")) + assert.NoError(t, err) + assert.Empty(t, scoped) + }) +} + func TestPhotoSelection(t *testing.T) { albums := form.Selection{Albums: []string{"as6sg6bxpogaaba9", "as6sg6bitoga0004", "as6sg6bxpogaaba8", "as6sg6bxpogaaba7"}} diff --git a/internal/entity/query/photo_test.go b/internal/entity/query/photo_test.go index eb603d057..24721d866 100644 --- a/internal/entity/query/photo_test.go +++ b/internal/entity/query/photo_test.go @@ -152,7 +152,6 @@ func TestOrphanPhotos(t *testing.T) { assert.IsType(t, entity.Photos{}, result) } -// TODO How to verify? // TestFixPrimaries validates photo query behavior. func TestFixPrimaries(t *testing.T) { t.Run("Success", func(t *testing.T) { @@ -161,6 +160,66 @@ func TestFixPrimaries(t *testing.T) { t.Fatal(err) } }) + t.Run("PromotesPresentFileWhenPrimaryDeleted", func(t *testing.T) { + taken := time.Date(2017, 5, 5, 12, 0, 0, 0, time.UTC) + p := entity.Photo{ + PhotoUID: rnd.GenerateUID(entity.PhotoUID), + PhotoType: entity.MediaImage, + TakenAt: taken, + TakenAtLocal: taken, + TakenSrc: entity.SrcMeta, + PhotoName: "fixprim-" + rnd.GenerateUID(entity.PhotoUID), + PhotoQuality: -1, + PhotoResolution: 3, + } + if err := Db().Create(&p).Error; err != nil { + t.Fatal(err) + } + // Primary file that has since been soft-deleted but still carries the primary flag. + deletedPrimary := entity.File{ + PhotoID: p.ID, + PhotoUID: p.PhotoUID, + FileUID: rnd.GenerateUID(entity.FileUID), + FileName: "fixprim/" + p.PhotoUID + "-old.jpg", + FileRoot: entity.RootOriginals, + FileHash: rnd.GenerateUID(entity.FileUID), + FilePrimary: true, + FileType: "jpg", + DeletedAt: entity.TimeStamp(), + } + if err := Db().Create(&deletedPrimary).Error; err != nil { + t.Fatal(err) + } + // Present preview file that is not yet flagged primary. + present := entity.File{ + PhotoID: p.ID, + PhotoUID: p.PhotoUID, + FileUID: rnd.GenerateUID(entity.FileUID), + FileName: "fixprim/" + p.PhotoUID + ".jpg", + FileRoot: entity.RootOriginals, + FileHash: rnd.GenerateUID(entity.FileUID), + FileType: "jpg", + } + if err := Db().Create(&present).Error; err != nil { + t.Fatal(err) + } + + if err := FixPrimaries(); err != nil { + t.Fatal(err) + } + + var gotFile entity.File + if err := Db().Where("file_uid = ?", present.FileUID).First(&gotFile).Error; err != nil { + t.Fatal(err) + } + assert.True(t, gotFile.FilePrimary, "present file must be promoted to primary") + + var gotPhoto entity.Photo + if err := UnscopedDb().Select("photo_quality").Where("photo_uid = ?", p.PhotoUID).First(&gotPhoto).Error; err != nil { + t.Fatal(err) + } + assert.Greater(t, gotPhoto.PhotoQuality, -1, "photo must recover once a valid primary is set") + }) } // TestFlagHiddenPhotos validates photo query behavior. diff --git a/internal/entity/query/purge.go b/internal/entity/query/purge.go index deb3f9d0e..2bc99f6b1 100644 --- a/internal/entity/query/purge.go +++ b/internal/entity/query/purge.go @@ -34,12 +34,8 @@ func PurgeOrphans() error { return err } - // Remove unused camera lenses. - if err := PurgeOrphanLenses(); err != nil { - return err - } - - return nil + // Remove unused lenses. + return PurgeOrphanLenses() } // PurgeOrphanFiles removes files without a photo from the index. diff --git a/internal/entity/query/query.go b/internal/entity/query/query.go index d59f7dda5..0c09011a4 100644 --- a/internal/entity/query/query.go +++ b/internal/entity/query/query.go @@ -1,7 +1,7 @@ /* Package query provides frequently used database queries for use in commands and API. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. @@ -29,16 +29,11 @@ import ( "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/event" + "github.com/photoprism/photoprism/pkg/dsn" ) var log = event.Log -// Supported database dialect identifiers. -const ( - MySQL = "mysql" - SQLite3 = "sqlite3" -) - // Cols represents a list of database columns. type Cols []string @@ -79,7 +74,7 @@ func DbDialect() string { // BatchSize returns the maximum query parameter number based on the current sql database dialect. func BatchSize() int { switch DbDialect() { - case SQLite3: + case dsn.DriverSQLite3: return 333 default: return 1000 diff --git a/internal/entity/query/query_test.go b/internal/entity/query/query_test.go index 983baaad3..a989ddd96 100644 --- a/internal/entity/query/query_test.go +++ b/internal/entity/query/query_test.go @@ -22,25 +22,26 @@ func (p staticDbProvider) Db() *gorm.DB { return p.db } +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) int { log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) // Remove temporary SQLite files before running the tests. fs.PurgeTestDbFiles(".", false) + // Remove temporary SQLite files after running the tests. + defer fs.PurgeTestDbFiles(".", false) db := entity.InitTestDb( os.Getenv("PHOTOPRISM_TEST_DRIVER"), os.Getenv("PHOTOPRISM_TEST_DSN")) + defer db.Close() - code := m.Run() - - // Remove temporary SQLite files after running the tests. - db.Close() - - fs.PurgeTestDbFiles(".", false) - - os.Exit(code) + return m.Run() } func TestDbDialect(t *testing.T) { diff --git a/internal/entity/search/accounts.go b/internal/entity/search/accounts.go index d74f66f33..c17fdbc66 100644 --- a/internal/entity/search/accounts.go +++ b/internal/entity/search/accounts.go @@ -9,6 +9,10 @@ import ( func Accounts(frm form.SearchServices) (result entity.Services, err error) { s := Db().Where(&entity.Service{}) + if frm.Query != "" { + s = s.Where("acc_name LIKE ?", SqlParam(frm.Query, "%", "%")) + } + if frm.Share { s = s.Where("acc_share = 1") } diff --git a/internal/entity/search/accounts_test.go b/internal/entity/search/accounts_test.go index 0f9ef35ed..667078a54 100644 --- a/internal/entity/search/accounts_test.go +++ b/internal/entity/search/accounts_test.go @@ -80,4 +80,52 @@ func TestAccounts(t *testing.T) { assert.IsType(t, entity.Service{}, r) } }) + t.Run("QueryMatchesAccountName", func(t *testing.T) { + f := form.SearchServices{ + Query: "Account2", + Count: 10, + } + r, err := Accounts(f) + + if err != nil { + t.Fatal(err) + } + + assert.NotEmpty(t, r) + + found := false + for _, s := range r { + assert.Contains(t, s.AccName, "Account2") + if s.AccName == "Test Account2" { + found = true + } + } + assert.True(t, found) + }) + t.Run("QueryMatchesMultiple", func(t *testing.T) { + f := form.SearchServices{ + Query: "Test Account", + Count: 10, + } + r, err := Accounts(f) + + if err != nil { + t.Fatal(err) + } + + assert.GreaterOrEqual(t, len(r), 2) + }) + t.Run("QueryNoMatch", func(t *testing.T) { + f := form.SearchServices{ + Query: "NoSuchServiceName", + Count: 10, + } + r, err := Accounts(f) + + if err != nil { + t.Fatal(err) + } + + assert.Empty(t, r) + }) } diff --git a/internal/entity/search/albums.go b/internal/entity/search/albums.go index 97c436db7..eda381027 100644 --- a/internal/entity/search/albums.go +++ b/internal/entity/search/albums.go @@ -145,7 +145,10 @@ func UserAlbums(frm form.SearchAlbums, sess *entity.Session) (results AlbumResul q := "%" + strings.Trim(frm.Query, " *%") + "%" if frm.Type == entity.AlbumFolder { - s = s.Where("albums.album_title LIKE ? OR albums.album_location LIKE ? OR albums.album_path LIKE ?", q, q, q) + // album_path is VARBINARY and matched case-insensitively so a lowercased query still + // finds uppercase folder paths; album_title and album_location are VARCHAR (already + // case-insensitive). + s = s.Where("albums.album_title LIKE ? OR albums.album_location LIKE ? OR "+PathLike(s.Dialect().GetName(), "albums.album_path"), q, q, q) } else { s = s.Where("albums.album_title LIKE ? OR albums.album_location LIKE ?", q, q) } @@ -183,23 +186,26 @@ func UserAlbums(frm form.SearchAlbums, sess *entity.Session) (results AlbumResul if txt.NotEmpty(frm.Year) { // Filter by the pictures included if it is a manually managed album, as these do not have an explicit // year assigned to them, unlike calendar albums and moments for example. + w, v := AnyInt("albums.album_year", frm.Year, txt.Or, entity.UnknownYear, txt.YearMax) if frm.Type == entity.AlbumManual { s = s.Where("? OR albums.album_uid IN (SELECT DISTINCT pay.album_uid FROM photos_albums pay "+ "JOIN photos py ON pay.photo_uid = py.photo_uid WHERE py.photo_year IN (?) AND pay.hidden = 0 AND pay.missing = 0)", - gorm.Expr(AnyInt("albums.album_year", frm.Year, txt.Or, entity.UnknownYear, txt.YearMax)), strings.Split(frm.Year, txt.Or)) + gorm.Expr(w, v...), strings.Split(frm.Year, txt.Or)) } else { - s = s.Where(AnyInt("albums.album_year", frm.Year, txt.Or, entity.UnknownYear, txt.YearMax)) + s = s.Where(w, v...) } } // Filter by month? if txt.NotEmpty(frm.Month) { - s = s.Where(AnyInt("albums.album_month", frm.Month, txt.Or, entity.UnknownMonth, txt.MonthMax)) + w, v := AnyInt("albums.album_month", frm.Month, txt.Or, entity.UnknownMonth, txt.MonthMax) + s = s.Where(w, v...) } // Filter by day? if txt.NotEmpty(frm.Day) { - s = s.Where(AnyInt("albums.album_day", frm.Day, txt.Or, entity.UnknownDay, txt.DayMax)) + w, v := AnyInt("albums.album_day", frm.Day, txt.Or, entity.UnknownDay, txt.DayMax) + s = s.Where(w, v...) } // Limit result count. diff --git a/internal/entity/search/albums_test.go b/internal/entity/search/albums_test.go index 859020320..bbe6d5b53 100644 --- a/internal/entity/search/albums_test.go +++ b/internal/entity/search/albums_test.go @@ -744,3 +744,52 @@ func TestAlbums(t *testing.T) { assert.Equal(t, false, result[0].AlbumFavorite) }) } + +func TestUserAlbums_FolderCaseInsensitivePath(t *testing.T) { + // Regression #5724: form.Unserialize lowercases the search term, but album_path is VARBINARY and + // compared byte-exact (case-sensitive) on MySQL, so an uppercase folder path stopped matching a + // lowercased query. The child folder below can be found ONLY via album_path (its title does not + // contain the term), so this fails on MySQL without the case-insensitive path match. + const albumUID = "as724caseinsens0" + const photoUID = "ps724caseinsens0" + const folderPath = "QAUPPER/CHILD" + + photo := entity.Photo{ + PhotoUID: photoUID, + PhotoName: "qa-5724", + PhotoPath: folderPath, + PhotoType: entity.MediaImage, + PhotoQuality: 3, + TakenAt: entity.Now(), + TakenAtLocal: entity.Now(), + } + if err := entity.Db().Create(&photo).Error; err != nil { + t.Fatal(err) + } + defer entity.UnscopedDb().Delete(&entity.Photo{}, "photo_uid = ?", photoUID) + + album := entity.Album{ + AlbumUID: albumUID, + AlbumType: entity.AlbumFolder, + AlbumSlug: "qaupper-child-5724", + AlbumPath: folderPath, + AlbumTitle: "CHILD", + } + if err := entity.Db().Create(&album).Error; err != nil { + t.Fatal(err) + } + defer entity.UnscopedDb().Delete(&entity.Album{}, "album_uid = ?", albumUID) + + // "QAUPPER" is lowercased to "qaupper" by the query parser before it reaches album_path. + result, err := Albums(form.SearchAlbums{Query: "QAUPPER", Type: entity.AlbumFolder, Count: 100}) + assert.NoError(t, err) + + found := false + for i := range result { + if result[i].AlbumUID == albumUID { + found = true + } + } + + assert.True(t, found, "folder with uppercase album_path must be found by a lowercased query") +} diff --git a/internal/entity/search/camera_results.go b/internal/entity/search/camera_results.go new file mode 100644 index 000000000..bc5092e2c --- /dev/null +++ b/internal/entity/search/camera_results.go @@ -0,0 +1,20 @@ +package search + +import ( + "time" +) + +// Camera represents a camera search result. +type Camera struct { + ID uint `json:"ID"` + CameraSlug string `json:"Slug"` + CameraName string `json:"Name"` + CameraMake string `json:"Make"` + CameraModel string `json:"Model"` + CameraType string `json:"Type"` + CameraDescription string `json:"Description"` + CameraNotes string `json:"Notes"` + CreatedAt time.Time `json:"CreatedAt"` + UpdatedAt time.Time `json:"UpdatedAt"` + DeletedAt time.Time `json:"DeletedAt"` +} diff --git a/internal/entity/search/cameras.go b/internal/entity/search/cameras.go new file mode 100644 index 000000000..a7071442c --- /dev/null +++ b/internal/entity/search/cameras.go @@ -0,0 +1,57 @@ +package search + +import ( + "strings" + + "github.com/photoprism/photoprism/internal/form" + "github.com/photoprism/photoprism/pkg/txt" +) + +// Cameras searches cameras based on their name. +func Cameras(frm form.SearchCameras) (results []Camera, err error) { + if err = frm.ParseQueryString(); err != nil { + return results, err + } + + s := Db() + + // Base query. + s = s.Table("cameras"). + Select(`cameras.*`) + + // Filter cameras without make. + if frm.NoMake { + s = s.Where("cameras.camera_make = ''") + } + + // Limit result count. + if frm.Count > 0 && frm.Count <= MaxResults { + s = s.Limit(frm.Count).Offset(frm.Offset) + } else { + s = s.Limit(MaxResults).Offset(frm.Offset) + } + + // Set sort order. + s = s.Order(OrderExpr("cameras.camera_make ASC, cameras.camera_model ASC, cameras.camera_slug ASC", frm.Reverse)) + + if frm.ID != "" { + s = s.Where("cameras.id IN (?)", strings.Split(frm.ID, txt.Or)) + + if result := s.Scan(&results); result.Error != nil { + return results, result.Error + } + + return results, nil + } + + if frm.Query != "" { + likeString := SqlParam(frm.Query, "%", "%") + s = s.Where("cameras.camera_name LIKE ? OR cameras.camera_make LIKE ? OR cameras.camera_model LIKE ?", likeString, likeString, likeString) + } + + if result := s.Scan(&results); result.Error != nil { + return results, result.Error + } + + return results, nil +} diff --git a/internal/entity/search/cameras_test.go b/internal/entity/search/cameras_test.go new file mode 100644 index 000000000..22e64f94d --- /dev/null +++ b/internal/entity/search/cameras_test.go @@ -0,0 +1,125 @@ +package search + +import ( + "strings" + "testing" + + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/internal/form" +) + +func TestCameras(t *testing.T) { + t.Run("SearchWithQuery", func(t *testing.T) { + query := form.NewCameraSearch("q:Canon") + query.Count = 1005 + result, err := Cameras(query) + + if err != nil { + t.Fatal(err) + } + + assert.LessOrEqual(t, 2, len(result)) + + for _, r := range result { + assert.IsType(t, Camera{}, r) + assert.NotEmpty(t, r.ID) + assert.NotEmpty(t, r.CameraName) + assert.NotEmpty(t, r.CameraSlug) + assert.True(t, strings.Contains(strings.ToLower(r.CameraName), "canon") || strings.Contains(strings.ToLower(r.CameraMake), "canon") || strings.Contains(strings.ToLower(r.CameraModel), "canon")) + + if fix, ok := entity.CameraFixtures[r.CameraSlug]; ok { + assert.Equal(t, fix.CameraName, r.CameraName) + assert.Equal(t, fix.CameraSlug, r.CameraSlug) + assert.Equal(t, fix.CameraMake, r.CameraMake) + assert.Equal(t, fix.CameraModel, r.CameraModel) + } + } + }) + t.Run("SearchForString", func(t *testing.T) { + query := form.NewCameraSearch("Q:EOS 5D") + query.Count = 1005 + result, err := Cameras(query) + + if err != nil { + t.Fatal(err) + } + + assert.LessOrEqual(t, 1, len(result)) + + for _, r := range result { + assert.IsType(t, Camera{}, r) + assert.NotEmpty(t, r.ID) + assert.NotEmpty(t, r.CameraName) + assert.NotEmpty(t, r.CameraSlug) + assert.NotEmpty(t, r.CameraModel) + } + }) + t.Run("SearchForNoMake", func(t *testing.T) { + query := form.NewCameraSearch("NoMake:true") + query.Count = 15 + result, err := Cameras(query) + + if err != nil { + t.Fatal(err) + } + + assert.LessOrEqual(t, 1, len(result)) + + for _, r := range result { + assert.IsType(t, Camera{}, r) + assert.NotEmpty(t, r.ID) + assert.NotEmpty(t, r.CameraName) + assert.NotEmpty(t, r.CameraSlug) + assert.Empty(t, r.CameraMake) + } + }) + t.Run("SearchWithEmptyQuery", func(t *testing.T) { + query := form.NewCameraSearch("") + result, err := Cameras(query) + + if err != nil { + t.Fatal(err) + } + assert.LessOrEqual(t, 6, len(result)) + }) + t.Run("SearchWithReverse", func(t *testing.T) { + query := form.NewCameraSearch("") + query.Reverse = true + result, err := Cameras(query) + + if err != nil { + t.Fatal(err) + } + assert.LessOrEqual(t, 6, len(result)) + }) + t.Run("SearchForNoMakeAndQueryNoResults", func(t *testing.T) { + query := form.NewCameraSearch("Canon") + query.NoMake = true + result, err := Cameras(query) + + assert.NoError(t, err) + assert.Empty(t, result) + }) + t.Run("SearchWithInvalidQueryString", func(t *testing.T) { + query := form.NewCameraSearch("xxx:bla") + result, err := Cameras(query) + + assert.Error(t, err, "unknown filter") + assert.Empty(t, result) + }) + t.Run("SearchForId", func(t *testing.T) { + f := form.SearchCameras{ + ID: "1000000|1000001", + Count: 0, + } + + result, err := Cameras(f) + + if err != nil { + t.Fatal(err) + } + assert.Len(t, result, 2) + }) +} diff --git a/internal/entity/search/conditions.go b/internal/entity/search/conditions.go index 312447a16..f3e8bf036 100644 --- a/internal/entity/search/conditions.go +++ b/internal/entity/search/conditions.go @@ -5,24 +5,42 @@ import ( "strings" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/txt" "github.com/jinzhu/inflection" ) -// Like sanitizes user input so it can be safely interpolated into SQL LIKE -// expressions. It strips operators that we don't expect to persist in the -// statement and lets callers provide their own surrounding wildcards. -func Like(s string) string { - return strings.Trim(clean.SqlString(s), " |&*%") +// PathLike returns a case-insensitive "col LIKE ?" condition for a VARBINARY path column such as +// album_path or photo_path. form.Unserialize lowercases the search term, but these columns are +// compared byte-exact (case-sensitive) on MySQL, so an uppercase path would otherwise never match a +// lowercased query. MySQL therefore needs an explicit case-insensitive collation; SQLite LIKE is +// already ASCII case-insensitive, and any other or unknown dialect falls back to a plain LIKE (its +// default semantics, never an error). The dialect is the GORM dialect name, e.g. s.Dialect().GetName(). +func PathLike(dialect, col string) string { + if dialect == dsn.DriverMySQL { + return "CONVERT(" + col + " USING utf8mb4) COLLATE utf8mb4_general_ci LIKE ?" + } + + return col + " LIKE ?" +} + +// SqlParam sanitizes user input for use as a LIKE-clause bind value. The +// surrounding pre/post strings are concatenated verbatim so callers can add +// SQL wildcards (e.g. "%") without exposing the underlying value to string +// interpolation. +func SqlParam(s, pre, post string) string { + return pre + strings.Trim(clean.SqlClean(s), " |&*%") + post } // LikeAny builds OR-chained LIKE predicates for a text column. The input string // may contain AND / OR separators; keywords trigger stemming and plural // normalization while exact mode disables wildcard suffixes. -func LikeAny(col, s string, keywords, exact bool) (wheres []string) { +// The returned wheres and values are aligned 1:1; callers feed each pair into +// gorm.Expr(wheres[i], values[i]...). +func LikeAny(col, s string, keywords, exact bool) (wheres []string, values [][]any) { if s == "" { - return wheres + return wheres, values } s = txt.StripOr(clean.SearchQuery(s)) @@ -39,6 +57,7 @@ func LikeAny(col, s string, keywords, exact bool) (wheres []string) { for _, k := range txt.UnTrimmedSplitWithEscape(s, txt.AndRune, txt.EscapeRune) { var orWheres []string + var orValues []any var words []string if keywords { @@ -53,9 +72,11 @@ func LikeAny(col, s string, keywords, exact bool) (wheres []string) { for _, w := range words { if wildcardThreshold > 0 && len(w) >= wildcardThreshold { - orWheres = append(orWheres, fmt.Sprintf("%s LIKE '%s%%'", col, Like(w))) + orWheres = append(orWheres, fmt.Sprintf("%s LIKE ?", col)) + orValues = append(orValues, SqlParam(w, "", "%")) } else { - orWheres = append(orWheres, fmt.Sprintf("%s LIKE '%s'", col, Like(w))) + orWheres = append(orWheres, fmt.Sprintf("%s LIKE ?", col)) + orValues = append(orValues, SqlParam(w, "", "")) } if !keywords || !txt.ContainsASCIILetters(w) { @@ -65,35 +86,39 @@ func LikeAny(col, s string, keywords, exact bool) (wheres []string) { singular := inflection.Singular(w) if singular != w { - orWheres = append(orWheres, fmt.Sprintf("%s LIKE '%s'", col, Like(singular))) + orWheres = append(orWheres, fmt.Sprintf("%s LIKE ?", col)) + orValues = append(orValues, SqlParam(singular, "", "")) } } if len(orWheres) > 0 { wheres = append(wheres, strings.Join(orWheres, " OR ")) + values = append(values, orValues) } } - return wheres + return wheres, values } // LikeAnyKeyword is a keyword-optimized wrapper around LikeAny. -func LikeAnyKeyword(col, s string) (wheres []string) { +func LikeAnyKeyword(col, s string) (wheres []string, values [][]any) { return LikeAny(col, s, true, false) } // LikeAnyWord matches whole words and keeps wildcard thresholds tuned for // free-form text search instead of keyword lists. -func LikeAnyWord(col, s string) (wheres []string) { +func LikeAnyWord(col, s string) (wheres []string, values [][]any) { return LikeAny(col, s, false, false) } // LikeAll produces AND-chained LIKE predicates for every significant token in // the search string. When exact is false, longer words receive a suffix // wildcard to support prefix matches. -func LikeAll(col, s string, keywords, exact bool) (wheres []string) { +// The returned wheres and values are aligned 1:1; callers feed each pair into +// gorm.Expr(wheres[i], values[i]...). +func LikeAll(col, s string, keywords, exact bool) (wheres []string, values [][]any) { if s == "" { - return wheres + return wheres, values } var words []string @@ -108,42 +133,45 @@ func LikeAll(col, s string, keywords, exact bool) (wheres []string) { } if len(words) == 0 { - return wheres + return wheres, values } else if exact { wildcardThreshold = -1 } for _, w := range words { if wildcardThreshold > 0 && len(w) >= wildcardThreshold { - wheres = append(wheres, fmt.Sprintf("%s LIKE '%s%%'", col, Like(w))) + wheres = append(wheres, fmt.Sprintf("%s LIKE ?", col)) + values = append(values, []any{SqlParam(w, "", "%")}) } else { - wheres = append(wheres, fmt.Sprintf("%s LIKE '%s'", col, Like(w))) + wheres = append(wheres, fmt.Sprintf("%s LIKE ?", col)) + values = append(values, []any{SqlParam(w, "", "")}) } } - return wheres + return wheres, values } // LikeAllKeywords is LikeAll specialized for keyword search. -func LikeAllKeywords(col, s string) (wheres []string) { +func LikeAllKeywords(col, s string) (wheres []string, values [][]any) { return LikeAll(col, s, true, false) } // LikeAllWords is LikeAll specialized for general word search. -func LikeAllWords(col, s string) (wheres []string) { +func LikeAllWords(col, s string) (wheres []string, values [][]any) { return LikeAll(col, s, false, false) } // LikeAllNames splits a name query into AND-separated groups and generates // prefix or substring matches against each provided column, keeping multi-word // tokens intact so "John Doe" still matches full-name columns. -func LikeAllNames(cols Cols, s string) (wheres []string) { +func LikeAllNames(cols Cols, s string) (wheres []string, values [][]any) { if len(cols) == 0 || len(s) < 1 { - return wheres + return wheres, values } for _, k := range txt.UnTrimmedSplitWithEscape(s, txt.AndRune, txt.EscapeRune) { var orWheres []string + var orValues []any for _, w := range txt.UnTrimmedSplitWithEscape(k, txt.OrRune, txt.EscapeRune) { w = strings.TrimSpace(w) @@ -154,27 +182,30 @@ func LikeAllNames(cols Cols, s string) (wheres []string) { for _, c := range cols { if strings.Contains(w, txt.Space) { - orWheres = append(orWheres, fmt.Sprintf("%s LIKE '%s%%'", c, Like(w))) + orWheres = append(orWheres, fmt.Sprintf("%s LIKE ?", c)) + orValues = append(orValues, SqlParam(w, "", "%")) } else { - orWheres = append(orWheres, fmt.Sprintf("%s LIKE '%%%s%%'", c, Like(w))) + orWheres = append(orWheres, fmt.Sprintf("%s LIKE ?", c)) + orValues = append(orValues, SqlParam(w, "%", "%")) } } } if len(orWheres) > 0 { wheres = append(wheres, strings.Join(orWheres, " OR ")) + values = append(values, orValues) } } - return wheres + return wheres, values } // AnySlug converts human-friendly search terms into slugs and matches them // against the provided slug column, including the singularized variant for // plural words (e.g. "Cats" -> "cat"). -func AnySlug(col, search, sep string) (where string) { +func AnySlug(col, search, sep string) (where string, values []any) { if search == "" { - return "" + return "", values } if sep == "" { @@ -201,21 +232,23 @@ func AnySlug(col, search, sep string) (where string) { } if len(words) == 0 { - return "" + return "", values } for _, w := range words { - wheres = append(wheres, fmt.Sprintf("%s = '%s'", col, Like(w))) + wheres = append(wheres, fmt.Sprintf("%s = ?", col)) + values = append(values, SqlParam(w, "", "")) } - return strings.Join(wheres, " OR ") + return strings.Join(wheres, " OR "), values } // AnyInt filters user-specified integers through an allowed range and returns -// an OR-chained equality predicate for the values that remain. -func AnyInt(col, numbers, sep string, min, max int) (where string) { +// an OR-chained equality predicate for the values that remain. Named low/high +// to avoid shadowing the predeclared min/max identifiers added in Go 1.21. +func AnyInt(col, numbers, sep string, low, high int) (where string, values []any) { if numbers == "" { - return "" + return "", values } if sep == "" { @@ -228,7 +261,7 @@ func AnyInt(col, numbers, sep string, min, max int) (where string) { for n := range strings.SplitSeq(numbers, sep) { i := txt.Int(n) - if i == 0 || i < min || i > max { + if i == 0 || i < low || i > high { continue } @@ -236,17 +269,18 @@ func AnyInt(col, numbers, sep string, min, max int) (where string) { } if len(matches) == 0 { - return "" + return "", values } for _, n := range matches { - wheres = append(wheres, fmt.Sprintf("%s = %d", col, n)) + wheres = append(wheres, fmt.Sprintf("%s = ?", col)) + values = append(values, n) } - return strings.Join(wheres, " OR ") + return strings.Join(wheres, " OR "), values } -// OrLike prepares a parameterised OR/LIKE clause for a single column. Star (* ) +// OrLike prepares a parameterized OR/LIKE clause for a single column. Star (* ) // wildcards are mapped to SQL percent wildcards before returning the query and // bind values. func OrLike(col, s string) (where string, values []any) { diff --git a/internal/entity/search/conditions_test.go b/internal/entity/search/conditions_test.go index ae74407ed..715d61d88 100644 --- a/internal/entity/search/conditions_test.go +++ b/internal/entity/search/conditions_test.go @@ -8,312 +8,326 @@ import ( "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/txt" ) -func TestLike(t *testing.T) { +func TestPathLike(t *testing.T) { + t.Run("MySQLCaseInsensitiveCollation", func(t *testing.T) { + // MySQL compares VARBINARY byte-exact, so the path is converted to a case-insensitive collation. + assert.Equal(t, "CONVERT(albums.album_path USING utf8mb4) COLLATE utf8mb4_general_ci LIKE ?", PathLike(dsn.DriverMySQL, "albums.album_path")) + }) + t.Run("SQLitePlainLike", func(t *testing.T) { + // SQLite LIKE is already ASCII case-insensitive, so a plain LIKE suffices. + assert.Equal(t, "albums.album_path LIKE ?", PathLike(dsn.DriverSQLite3, "albums.album_path")) + }) + t.Run("UnknownDialectFallsBackToPlainLike", func(t *testing.T) { + // A future or unknown dialect must not error; it falls back to a plain LIKE. + assert.Equal(t, "albums.album_path LIKE ?", PathLike(dsn.DriverPostgres, "albums.album_path")) + }) +} + +func TestSqlParam(t *testing.T) { t.Run("Empty", func(t *testing.T) { - assert.Equal(t, "", Like("")) + assert.Equal(t, "", SqlParam("", "", "")) }) - t.Run("Special", func(t *testing.T) { - s := " ' \" \t \n %_''" - exp := "'' \"\" %_''''" - result := Like(s) - t.Logf("String..: %s", s) - t.Logf("Expected: %s", exp) - t.Logf("Result..: %s", result) - assert.Equal(t, exp, result) + t.Run("Wildcards", func(t *testing.T) { + assert.Equal(t, "%foo%", SqlParam("foo", "%", "%")) }) - t.Run("Alnum", func(t *testing.T) { - assert.Equal(t, "123ABCabc", Like(" 123ABCabc%* ")) + t.Run("StripsTrimChars", func(t *testing.T) { + // Leading/trailing operators and wildcards are stripped before the value is bound. + assert.Equal(t, "spoon", SqlParam(" |&*%spoon%*&| ", "", "")) + }) + t.Run("KeepsQuotes", func(t *testing.T) { + // Quotes are preserved unchanged; the parameter binder is responsible for escaping. + assert.Equal(t, "O'Reilly", SqlParam("O'Reilly", "", "")) + }) + t.Run("StripsControl", func(t *testing.T) { + assert.Equal(t, "ab", SqlParam("a\tb\n", "", "")) + }) + t.Run("PrePostWrappers", func(t *testing.T) { + assert.Equal(t, "<table%", SqlParam("table", "<", "%")) }) } func TestLikeAny(t *testing.T) { t.Run("AndOrSearch", func(t *testing.T) { - if w := LikeAny("k.keyword", "table spoon & usa | img json", true, false); len(w) != 2 { - t.Fatal("two where conditions expected") - } else { - assert.Equal(t, "k.keyword LIKE 'spoon%' OR k.keyword LIKE 'table%'", w[0]) - assert.Equal(t, "k.keyword LIKE 'json%' OR k.keyword LIKE 'usa'", w[1]) - } + w, v := LikeAny("k.keyword", "table spoon & usa | img json", true, false) + assert.Equal(t, []string{"k.keyword LIKE ? OR k.keyword LIKE ?", "k.keyword LIKE ? OR k.keyword LIKE ?"}, w) + assert.Equal(t, [][]any{{"spoon%", "table%"}, {"json%", "usa"}}, v) }) t.Run("ExactAndOrSearch", func(t *testing.T) { - if w := LikeAny("k.keyword", "table spoon & usa | img json", true, true); len(w) != 2 { - t.Fatal("two where conditions expected") - } else { - assert.Equal(t, "k.keyword LIKE 'spoon' OR k.keyword LIKE 'table'", w[0]) - assert.Equal(t, "k.keyword LIKE 'json' OR k.keyword LIKE 'usa'", w[1]) - } + w, v := LikeAny("k.keyword", "table spoon & usa | img json", true, true) + assert.Equal(t, []string{"k.keyword LIKE ? OR k.keyword LIKE ?", "k.keyword LIKE ? OR k.keyword LIKE ?"}, w) + assert.Equal(t, [][]any{{"spoon", "table"}, {"json", "usa"}}, v) }) t.Run("AndOrSearchEn", func(t *testing.T) { - if w := LikeAny("k.keyword", "table spoon and usa or img json", true, false); len(w) != 2 { - t.Fatal("two where conditions expected") - } else { - assert.Equal(t, "k.keyword LIKE 'spoon%' OR k.keyword LIKE 'table%'", w[0]) - assert.Equal(t, "k.keyword LIKE 'json%' OR k.keyword LIKE 'usa'", w[1]) - } + w, v := LikeAny("k.keyword", "table spoon and usa or img json", true, false) + assert.Equal(t, []string{"k.keyword LIKE ? OR k.keyword LIKE ?", "k.keyword LIKE ? OR k.keyword LIKE ?"}, w) + assert.Equal(t, [][]any{{"spoon%", "table%"}, {"json%", "usa"}}, v) }) t.Run("TableSpoonUsaImgJson", func(t *testing.T) { - if w := LikeAny("k.keyword", "table spoon usa img json", true, false); len(w) != 1 { - t.Fatal("one where condition expected") - } else { - assert.Equal(t, "k.keyword LIKE 'json%' OR k.keyword LIKE 'spoon%' OR k.keyword LIKE 'table%' OR k.keyword LIKE 'usa'", w[0]) - } + w, v := LikeAny("k.keyword", "table spoon usa img json", true, false) + assert.Equal(t, []string{"k.keyword LIKE ? OR k.keyword LIKE ? OR k.keyword LIKE ? OR k.keyword LIKE ?"}, w) + assert.Equal(t, [][]any{{"json%", "spoon%", "table%", "usa"}}, v) }) t.Run("CatDog", func(t *testing.T) { - if w := LikeAny("k.keyword", "cat dog", true, false); len(w) != 1 { - t.Fatal("one where condition expected") - } else { - assert.Equal(t, "k.keyword LIKE 'cat' OR k.keyword LIKE 'dog'", w[0]) - } + w, v := LikeAny("k.keyword", "cat dog", true, false) + assert.Equal(t, []string{"k.keyword LIKE ? OR k.keyword LIKE ?"}, w) + assert.Equal(t, [][]any{{"cat", "dog"}}, v) }) t.Run("CatsDogs", func(t *testing.T) { - if w := LikeAny("k.keyword", "cats dogs", true, false); len(w) != 1 { - t.Fatal("one where condition expected") - } else { - assert.Equal(t, "k.keyword LIKE 'cats%' OR k.keyword LIKE 'cat' OR k.keyword LIKE 'dogs%' OR k.keyword LIKE 'dog'", w[0]) - } + w, v := LikeAny("k.keyword", "cats dogs", true, false) + assert.Equal(t, []string{"k.keyword LIKE ? OR k.keyword LIKE ? OR k.keyword LIKE ? OR k.keyword LIKE ?"}, w) + assert.Equal(t, [][]any{{"cats%", "cat", "dogs%", "dog"}}, v) }) t.Run("Spoon", func(t *testing.T) { - if w := LikeAny("k.keyword", "spoon", true, false); len(w) != 1 { - t.Fatal("one where condition expected") - } else { - assert.Equal(t, "k.keyword LIKE 'spoon%'", w[0]) - } + w, v := LikeAny("k.keyword", "spoon", true, false) + assert.Equal(t, []string{"k.keyword LIKE ?"}, w) + assert.Equal(t, [][]any{{"spoon%"}}, v) }) t.Run("Img", func(t *testing.T) { - if w := LikeAny("k.keyword", "img", true, false); len(w) > 0 { - t.Fatal("no where condition expected") - } + w, v := LikeAny("k.keyword", "img", true, false) + assert.Empty(t, w) + assert.Empty(t, v) }) t.Run("Empty", func(t *testing.T) { - if w := LikeAny("k.keyword", "", true, false); len(w) > 0 { - t.Fatal("no where condition expected") - } + w, v := LikeAny("k.keyword", "", true, false) + assert.Empty(t, w) + assert.Empty(t, v) + }) + t.Run("LengthAlignment", func(t *testing.T) { + // Callers rely on wheres[i] and values[i] being aligned; assert it explicitly. + w, v := LikeAny("k.keyword", "table spoon & usa | img json", true, false) + assert.Equal(t, len(w), len(v)) }) } func TestLikeAnyKeyword(t *testing.T) { t.Run("AndOrSearch", func(t *testing.T) { - if w := LikeAnyKeyword("k.keyword", "table spoon & usa | img json"); len(w) != 2 { - t.Fatal("two where conditions expected") - } else { - assert.Equal(t, "k.keyword LIKE 'spoon%' OR k.keyword LIKE 'table%'", w[0]) - assert.Equal(t, "k.keyword LIKE 'json%' OR k.keyword LIKE 'usa'", w[1]) - } + w, v := LikeAnyKeyword("k.keyword", "table spoon & usa | img json") + assert.Equal(t, []string{"k.keyword LIKE ? OR k.keyword LIKE ?", "k.keyword LIKE ? OR k.keyword LIKE ?"}, w) + assert.Equal(t, [][]any{{"spoon%", "table%"}, {"json%", "usa"}}, v) }) t.Run("AndOrSearchEn", func(t *testing.T) { - if w := LikeAnyKeyword("k.keyword", "table spoon and usa or img json"); len(w) != 2 { - t.Fatal("two where conditions expected") - } else { - assert.Equal(t, "k.keyword LIKE 'spoon%' OR k.keyword LIKE 'table%'", w[0]) - assert.Equal(t, "k.keyword LIKE 'json%' OR k.keyword LIKE 'usa'", w[1]) - } + w, v := LikeAnyKeyword("k.keyword", "table spoon and usa or img json") + assert.Equal(t, []string{"k.keyword LIKE ? OR k.keyword LIKE ?", "k.keyword LIKE ? OR k.keyword LIKE ?"}, w) + assert.Equal(t, [][]any{{"spoon%", "table%"}, {"json%", "usa"}}, v) }) } func TestLikeAnyWord(t *testing.T) { t.Run("SearchAndOr", func(t *testing.T) { - if w := LikeAnyWord("k.keyword", "table spoon & usa | img json"); len(w) != 2 { - t.Fatal("two where conditions expected") - } else { - assert.Equal(t, "k.keyword LIKE 'spoon%' OR k.keyword LIKE 'table%'", w[0]) - assert.Equal(t, "k.keyword LIKE 'img%' OR k.keyword LIKE 'json%' OR k.keyword LIKE 'usa%'", w[1]) - } + w, v := LikeAnyWord("k.keyword", "table spoon & usa | img json") + assert.Equal(t, []string{"k.keyword LIKE ? OR k.keyword LIKE ?", "k.keyword LIKE ? OR k.keyword LIKE ? OR k.keyword LIKE ?"}, w) + assert.Equal(t, [][]any{{"spoon%", "table%"}, {"img%", "json%", "usa%"}}, v) }) t.Run("SearchAndOrEnglish", func(t *testing.T) { - if w := LikeAnyWord("k.keyword", "table spoon and usa or img json"); len(w) != 2 { - t.Fatal("two where conditions expected") - } else { - assert.Equal(t, "k.keyword LIKE 'spoon%' OR k.keyword LIKE 'table%'", w[0]) - assert.Equal(t, "k.keyword LIKE 'img%' OR k.keyword LIKE 'json%' OR k.keyword LIKE 'usa%'", w[1]) - } + w, v := LikeAnyWord("k.keyword", "table spoon and usa or img json") + assert.Equal(t, []string{"k.keyword LIKE ? OR k.keyword LIKE ?", "k.keyword LIKE ? OR k.keyword LIKE ? OR k.keyword LIKE ?"}, w) + assert.Equal(t, [][]any{{"spoon%", "table%"}, {"img%", "json%", "usa%"}}, v) }) t.Run("EscapeSql", func(t *testing.T) { - if w := LikeAnyWord("k.keyword", "table% | 'spoon' & \"us'a"); len(w) != 2 { - t.Fatalf("two where conditions expected: %#v", w) - } else { - assert.Equal(t, "k.keyword LIKE 'spoon%' OR k.keyword LIKE 'table%'", w[0]) - assert.Equal(t, "k.keyword LIKE '\"\"us''a%'", w[1]) - } + // Quote characters survive in the bound value — the parameter binder, not the + // query builder, is responsible for escaping them. + w, v := LikeAnyWord("k.keyword", "table% | 'spoon' & \"us'a") + assert.Equal(t, []string{"k.keyword LIKE ? OR k.keyword LIKE ?", "k.keyword LIKE ?"}, w) + assert.Equal(t, [][]any{{"spoon%", "table%"}, {"\"us'a%"}}, v) }) } func TestLikeAll(t *testing.T) { t.Run("Keywords", func(t *testing.T) { - if w := LikeAll("k.keyword", "Jo Mander 李", true, false); len(w) == 2 { - assert.Equal(t, "k.keyword LIKE 'mander%'", w[0]) - assert.Equal(t, "k.keyword LIKE '李'", w[1]) - } else { - t.Logf("wheres: %#v", w) - t.Fatal("two where conditions expected") - } + w, v := LikeAll("k.keyword", "Jo Mander 李", true, false) + assert.Equal(t, []string{"k.keyword LIKE ?", "k.keyword LIKE ?"}, w) + assert.Equal(t, [][]any{{"mander%"}, {"李"}}, v) }) t.Run("Exact", func(t *testing.T) { - if w := LikeAll("k.keyword", "Jo Mander 李", true, true); len(w) == 2 { - assert.Equal(t, "k.keyword LIKE 'mander'", w[0]) - assert.Equal(t, "k.keyword LIKE '李'", w[1]) - } else { - t.Logf("wheres: %#v", w) - t.Fatal("two where conditions expected") - } + w, v := LikeAll("k.keyword", "Jo Mander 李", true, true) + assert.Equal(t, []string{"k.keyword LIKE ?", "k.keyword LIKE ?"}, w) + assert.Equal(t, [][]any{{"mander"}, {"李"}}, v) }) t.Run("StringEmpty", func(t *testing.T) { - w := LikeAll("k.keyword", "", true, true) + w, v := LikeAll("k.keyword", "", true, true) assert.Empty(t, w) + assert.Empty(t, v) }) t.Run("ZeroWords", func(t *testing.T) { - w := LikeAll("k.keyword", "ab", true, true) + w, v := LikeAll("k.keyword", "ab", true, true) assert.Empty(t, w) + assert.Empty(t, v) + }) + t.Run("LengthAlignment", func(t *testing.T) { + w, v := LikeAll("k.keyword", "Jo Mander 李", true, false) + assert.Equal(t, len(w), len(v)) }) } func TestLikeAllKeywords(t *testing.T) { t.Run("Keywords", func(t *testing.T) { - if w := LikeAllKeywords("k.keyword", "Jo Mander 李"); len(w) == 2 { - assert.Equal(t, "k.keyword LIKE 'mander%'", w[0]) - assert.Equal(t, "k.keyword LIKE '李'", w[1]) - } else { - t.Fatalf("unexpected result: %#v", w) - } + w, v := LikeAllKeywords("k.keyword", "Jo Mander 李") + assert.Equal(t, []string{"k.keyword LIKE ?", "k.keyword LIKE ?"}, w) + assert.Equal(t, [][]any{{"mander%"}, {"李"}}, v) }) } func TestLikeAllWords(t *testing.T) { t.Run("Keywords", func(t *testing.T) { - if w := LikeAllWords("k.name", "Jo Mander 王"); len(w) == 3 { - assert.Equal(t, "k.name LIKE 'jo%'", w[0]) - assert.Equal(t, "k.name LIKE 'mander%'", w[1]) - assert.Equal(t, "k.name LIKE '王%'", w[2]) - } else { - t.Fatalf("unexpected result: %#v", w) - } + w, v := LikeAllWords("k.name", "Jo Mander 王") + assert.Equal(t, []string{"k.name LIKE ?", "k.name LIKE ?", "k.name LIKE ?"}, w) + assert.Equal(t, [][]any{{"jo%"}, {"mander%"}, {"王%"}}, v) }) } func TestLikeAllNames(t *testing.T) { t.Run("MultipleNames", func(t *testing.T) { - if w := LikeAllNames(Cols{"k.name"}, "j Mander 王"); len(w) == 1 { - assert.Equal(t, "k.name LIKE 'j Mander 王%'", w[0]) - } else { - t.Fatalf("unexpected result: %#v", w) - } + w, v := LikeAllNames(Cols{"k.name"}, "j Mander 王") + assert.Equal(t, []string{"k.name LIKE ?"}, w) + assert.Equal(t, [][]any{{"j Mander 王%"}}, v) }) t.Run("MultipleColumns", func(t *testing.T) { - if w := LikeAllNames(Cols{"a.col1", "b.col2"}, "Mo Mander"); len(w) == 1 { - assert.Equal(t, "a.col1 LIKE 'Mo Mander%' OR b.col2 LIKE 'Mo Mander%'", w[0]) - } else { - t.Fatalf("unexpected result: %#v", w) - } + w, v := LikeAllNames(Cols{"a.col1", "b.col2"}, "Mo Mander") + assert.Equal(t, []string{"a.col1 LIKE ? OR b.col2 LIKE ?"}, w) + assert.Equal(t, [][]any{{"Mo Mander%", "Mo Mander%"}}, v) }) t.Run("EmptyName", func(t *testing.T) { - w := LikeAllNames(Cols{"k.name"}, "") + w, v := LikeAllNames(Cols{"k.name"}, "") assert.Empty(t, w) + assert.Empty(t, v) + }) + t.Run("EmptyCols", func(t *testing.T) { + w, v := LikeAllNames(Cols{}, "anything") + assert.Empty(t, w) + assert.Empty(t, v) }) t.Run("SingleCharacter", func(t *testing.T) { - if w := LikeAllNames(Cols{"k.name"}, "a"); len(w) == 1 { - assert.Equal(t, "k.name LIKE '%a%'", w[0]) - } else { - t.Fatalf("unexpected result: %#v", w) - } + w, v := LikeAllNames(Cols{"k.name"}, "a") + assert.Equal(t, []string{"k.name LIKE ?"}, w) + assert.Equal(t, [][]any{{"%a%"}}, v) }) t.Run("FullNames", func(t *testing.T) { - if w := LikeAllNames(Cols{"j.name", "j.alias"}, "Bill & Melinda Gates"); len(w) == 2 { - assert.Equal(t, "j.name LIKE '%Bill%' OR j.alias LIKE '%Bill%'", w[0]) - assert.Equal(t, "j.name LIKE 'Melinda Gates%' OR j.alias LIKE 'Melinda Gates%'", w[1]) - } else { - t.Fatalf("unexpected result: %#v", w) - } + w, v := LikeAllNames(Cols{"j.name", "j.alias"}, "Bill & Melinda Gates") + assert.Equal(t, []string{"j.name LIKE ? OR j.alias LIKE ?", "j.name LIKE ? OR j.alias LIKE ?"}, w) + assert.Equal(t, [][]any{{"%Bill%", "%Bill%"}, {"Melinda Gates%", "Melinda Gates%"}}, v) }) t.Run("Plus", func(t *testing.T) { - if w := LikeAllNames(Cols{"name"}, clean.SearchQuery("Paul + Paula")); len(w) == 2 { - assert.Equal(t, "name LIKE '%Paul%'", w[0]) - assert.Equal(t, "name LIKE '%Paula%'", w[1]) - } else { - t.Fatalf("unexpected result: %#v", w) - } + w, v := LikeAllNames(Cols{"name"}, clean.SearchQuery("Paul + Paula")) + assert.Equal(t, []string{"name LIKE ?", "name LIKE ?"}, w) + assert.Equal(t, [][]any{{"%Paul%"}, {"%Paula%"}}, v) }) t.Run("And", func(t *testing.T) { - if w := LikeAllNames(Cols{"name"}, clean.SearchQuery("P and Paula")); len(w) == 2 { - assert.Equal(t, "name LIKE '%P%'", w[0]) - assert.Equal(t, "name LIKE '%Paula%'", w[1]) - } else { - t.Fatalf("unexpected result: %#v", w) - } + w, v := LikeAllNames(Cols{"name"}, clean.SearchQuery("P and Paula")) + assert.Equal(t, []string{"name LIKE ?", "name LIKE ?"}, w) + assert.Equal(t, [][]any{{"%P%"}, {"%Paula%"}}, v) }) t.Run("Or", func(t *testing.T) { - if w := LikeAllNames(Cols{"name"}, clean.SearchQuery("Paul or Paula")); len(w) == 1 { - assert.Equal(t, "name LIKE '%Paul%' OR name LIKE '%Paula%'", w[0]) - } else { - t.Fatalf("unexpected result: %#v", w) - } + w, v := LikeAllNames(Cols{"name"}, clean.SearchQuery("Paul or Paula")) + assert.Equal(t, []string{"name LIKE ? OR name LIKE ?"}, w) + assert.Equal(t, [][]any{{"%Paul%", "%Paula%"}}, v) + }) + t.Run("LengthAlignment", func(t *testing.T) { + w, v := LikeAllNames(Cols{"j.name", "j.alias"}, "Bill & Melinda Gates") + assert.Equal(t, len(w), len(v)) }) } func TestAnySlug(t *testing.T) { t.Run("Multiple", func(t *testing.T) { - where := AnySlug("custom_slug", "table spoon usa img json", " ") - assert.Equal(t, "custom_slug = 'table' OR custom_slug = 'spoon' OR custom_slug = 'usa' OR custom_slug = 'img' OR custom_slug = 'json'", where) + w, v := AnySlug("custom_slug", "table spoon usa img json", " ") + assert.Equal(t, "custom_slug = ? OR custom_slug = ? OR custom_slug = ? OR custom_slug = ? OR custom_slug = ?", w) + assert.Equal(t, []any{"table", "spoon", "usa", "img", "json"}, v) }) t.Run("CatDog", func(t *testing.T) { - where := AnySlug("custom_slug", "cat dog", " ") - assert.Equal(t, "custom_slug = 'cat' OR custom_slug = 'dog'", where) + w, v := AnySlug("custom_slug", "cat dog", " ") + assert.Equal(t, "custom_slug = ? OR custom_slug = ?", w) + assert.Equal(t, []any{"cat", "dog"}, v) }) t.Run("CatsDogs", func(t *testing.T) { - where := AnySlug("custom_slug", "cats dogs", " ") - assert.Equal(t, "custom_slug = 'cats' OR custom_slug = 'cat' OR custom_slug = 'dogs' OR custom_slug = 'dog'", where) + w, v := AnySlug("custom_slug", "cats dogs", " ") + assert.Equal(t, "custom_slug = ? OR custom_slug = ? OR custom_slug = ? OR custom_slug = ?", w) + assert.Equal(t, []any{"cats", "cat", "dogs", "dog"}, v) }) t.Run("Spoon", func(t *testing.T) { - where := AnySlug("custom_slug", "spoon", " ") - assert.Equal(t, "custom_slug = 'spoon'", where) + w, v := AnySlug("custom_slug", "spoon", " ") + assert.Equal(t, "custom_slug = ?", w) + assert.Equal(t, []any{"spoon"}, v) }) t.Run("Img", func(t *testing.T) { - where := AnySlug("custom_slug", "img", " ") - assert.Equal(t, "custom_slug = 'img'", where) + w, v := AnySlug("custom_slug", "img", " ") + assert.Equal(t, "custom_slug = ?", w) + assert.Equal(t, []any{"img"}, v) }) t.Run("Space", func(t *testing.T) { - where := AnySlug("custom_slug", " ", "") - assert.Equal(t, "custom_slug = '' OR custom_slug = ''", where) + w, v := AnySlug("custom_slug", " ", "") + assert.Equal(t, "custom_slug = ? OR custom_slug = ?", w) + assert.Equal(t, []any{"", ""}, v) }) t.Run("Empty", func(t *testing.T) { - where := AnySlug("custom_slug", "", " ") - assert.Equal(t, "", where) + w, v := AnySlug("custom_slug", "", " ") + assert.Equal(t, "", w) + assert.Empty(t, v) }) t.Run("CommaSeparated", func(t *testing.T) { - where := AnySlug("custom_slug", "botanical-garden|landscape|bay", txt.Or) - assert.Equal(t, "custom_slug = 'botanical-garden' OR custom_slug = 'landscape' OR custom_slug = 'bay'", where) + w, v := AnySlug("custom_slug", "botanical-garden,landscape,bay", ",") + assert.Equal(t, "custom_slug = ? OR custom_slug = ? OR custom_slug = ?", w) + assert.Equal(t, []any{"botanical-garden", "landscape", "bay"}, v) + }) + t.Run("PipeSeparated", func(t *testing.T) { + w, v := AnySlug("custom_slug", "botanical-garden|landscape|bay", txt.Or) + assert.Equal(t, "custom_slug = ? OR custom_slug = ? OR custom_slug = ?", w) + assert.Equal(t, []any{"botanical-garden", "landscape", "bay"}, v) }) t.Run("Emoji", func(t *testing.T) { - where := AnySlug("custom_slug", "💐", "|") - assert.Equal(t, "custom_slug = '_5cpzfea'", where) + w, v := AnySlug("custom_slug", "💐", "|") + assert.Equal(t, "custom_slug = ?", w) + assert.Equal(t, []any{"_5cpzfea"}, v) }) t.Run("EmojiSlug", func(t *testing.T) { - where := AnySlug("custom_slug", "_5cpzfea", "|") - assert.Equal(t, "custom_slug = '_5cpzfea'", where) + w, v := AnySlug("custom_slug", "_5cpzfea", "|") + assert.Equal(t, "custom_slug = ?", w) + assert.Equal(t, []any{"_5cpzfea"}, v) + }) + t.Run("SqlInjectionAttempt", func(t *testing.T) { + // Single quotes survive in the bound value because the parameter binder + // escapes them; nothing leaks into the SQL fragment itself. + w, v := AnySlug("custom_slug", "foo'; DROP TABLE photos--", "|") + assert.Equal(t, "custom_slug = ?", w) + assert.Equal(t, []any{"foo-drop-table-photos"}, v) }) } func TestAnyInt(t *testing.T) { t.Run("Empty", func(t *testing.T) { - where := AnyInt("photos.photo_month", "", txt.Or, entity.UnknownMonth, txt.MonthMax) - assert.Equal(t, "", where) + w, v := AnyInt("photos.photo_month", "", txt.Or, entity.UnknownMonth, txt.MonthMax) + assert.Equal(t, "", w) + assert.Empty(t, v) }) t.Run("Range", func(t *testing.T) { - where := AnyInt("photos.photo_month", "-3|0|10|9|11|12|13", txt.Or, entity.UnknownMonth, txt.MonthMax) - assert.Equal(t, "photos.photo_month = 10 OR photos.photo_month = 9 OR photos.photo_month = 11 OR photos.photo_month = 12", where) + w, v := AnyInt("photos.photo_month", "-3|0|10|9|11|12|13", txt.Or, entity.UnknownMonth, txt.MonthMax) + assert.Equal(t, "photos.photo_month = ? OR photos.photo_month = ? OR photos.photo_month = ? OR photos.photo_month = ?", w) + assert.Equal(t, []any{10, 9, 11, 12}, v) }) t.Run("Chars", func(t *testing.T) { - where := AnyInt("photos.photo_month", "a|b|c", txt.Or, entity.UnknownMonth, txt.MonthMax) - assert.Equal(t, "", where) + w, v := AnyInt("photos.photo_month", "a|b|c", txt.Or, entity.UnknownMonth, txt.MonthMax) + assert.Equal(t, "", w) + assert.Empty(t, v) }) t.Run("CommaSeparated", func(t *testing.T) { - where := AnyInt("photos.photo_month", "-3,10,9,11,12,13", ",", entity.UnknownMonth, txt.MonthMax) - assert.Equal(t, "photos.photo_month = 10 OR photos.photo_month = 9 OR photos.photo_month = 11 OR photos.photo_month = 12", where) + w, v := AnyInt("photos.photo_month", "-3,10,9,11,12,13", ",", entity.UnknownMonth, txt.MonthMax) + assert.Equal(t, "photos.photo_month = ? OR photos.photo_month = ? OR photos.photo_month = ? OR photos.photo_month = ?", w) + assert.Equal(t, []any{10, 9, 11, 12}, v) }) t.Run("Invalid", func(t *testing.T) { - where := AnyInt("photos.photo_month", " , | ", ",", entity.UnknownMonth, txt.MonthMax) - assert.Equal(t, "", where) + w, v := AnyInt("photos.photo_month", " , | ", ",", entity.UnknownMonth, txt.MonthMax) + assert.Equal(t, "", w) + assert.Empty(t, v) + }) + t.Run("SqlInjectionAttempt", func(t *testing.T) { + // Any token that isn't a clean integer is discarded entirely — the SQL + // fragment never sees the injected payload. + w, v := AnyInt("photos.photo_month", "1; DROP TABLE photos|2", txt.Or, entity.UnknownMonth, txt.MonthMax) + assert.Equal(t, "photos.photo_month = ?", w) + assert.Equal(t, []any{2}, v) }) } diff --git a/internal/entity/search/homophone_test.go b/internal/entity/search/homophone_test.go new file mode 100644 index 000000000..f0f75891c --- /dev/null +++ b/internal/entity/search/homophone_test.go @@ -0,0 +1,44 @@ +package search + +import ( + "testing" + + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/internal/entity" +) + +// createHomophoneSearchFixtures adds two colliding labels with distinct names +// and assigns them to separate fixture photos for search regression tests. +func createHomophoneSearchFixtures(t *testing.T) (first, second *entity.Label, photoA, photoB entity.Photo) { + t.Helper() + + entity.FlushLabelCache() + entity.FlushPhotoLabelCache() + + photoA = entity.PhotoFixtures.Get("Photo09") + photoB = entity.PhotoFixtures.Get("Photo10") + + first = entity.FirstOrCreateLabel(entity.NewLabel("问", 0)) + second = entity.FirstOrCreateLabel(entity.NewLabel("吻", 0)) + + require.NotNil(t, first) + require.NotNil(t, second) + + relationA := entity.FirstOrCreatePhotoLabel(entity.NewPhotoLabel(photoA.ID, first.ID, 10, entity.SrcManual)) + relationB := entity.FirstOrCreatePhotoLabel(entity.NewPhotoLabel(photoB.ID, second.ID, 10, entity.SrcManual)) + + require.NotNil(t, relationA) + require.NotNil(t, relationB) + + t.Cleanup(func() { + _ = entity.Db().Where("photo_id = ? AND label_id = ?", photoA.ID, first.ID).Delete(&entity.PhotoLabel{}).Error + _ = entity.Db().Where("photo_id = ? AND label_id = ?", photoB.ID, second.ID).Delete(&entity.PhotoLabel{}).Error + _ = entity.Db().Unscoped().Delete(second).Error + _ = entity.Db().Unscoped().Delete(first).Error + entity.FlushLabelCache() + entity.FlushPhotoLabelCache() + }) + + return first, second, photoA, photoB +} diff --git a/internal/entity/search/labels.go b/internal/entity/search/labels.go index 3e544f1d8..bfc433759 100644 --- a/internal/entity/search/labels.go +++ b/internal/entity/search/labels.go @@ -61,27 +61,14 @@ func Labels(frm form.SearchLabels) (results []Label, err error) { } if frm.Query != "" { - var labelIds []uint - var categories []entity.Category - var label entity.Label - - slugString := txt.Slug(frm.Query) likeString := "%" + frm.Query + "%" - if result := Db().First(&label, "label_slug = ? OR custom_slug = ?", slugString, slugString); result.Error != nil { + if labelIds, findErr := entity.FindLabelIDs(frm.Query, " ", true); findErr != nil || len(labelIds) == 0 { log.Infof("search: label %s not found", clean.Log(frm.Query)) s = s.Where("labels.label_name LIKE ?", likeString) } else { - labelIds = append(labelIds, label.ID) - - Db().Where("category_id = ?", label.ID).Find(&categories) - - for _, category := range categories { - labelIds = append(labelIds, category.LabelID) - } - - log.Infof("search: label %s includes %d categories", clean.Log(label.LabelName), len(labelIds)) + log.Infof("search: label %s resolves to %d labels", clean.Log(frm.Query), len(labelIds)) s = s.Where("labels.id IN (?)", labelIds) } diff --git a/internal/entity/search/labels_test.go b/internal/entity/search/labels_test.go index 5b8259463..7fbe25383 100644 --- a/internal/entity/search/labels_test.go +++ b/internal/entity/search/labels_test.go @@ -197,4 +197,23 @@ func TestLabels(t *testing.T) { assert.Equal(t, "flower", result[0].LabelSlug) }) + t.Run("SearchForHomophoneName", func(t *testing.T) { + _, second, _, _ := createHomophoneSearchFixtures(t) + + query := form.NewLabelSearch("Q:吻") + query.Count = 1005 + + result, err := Labels(query) + + if err != nil { + t.Fatal(err) + } + + if len(result) != 1 { + t.Fatalf("expected one result, got %d", len(result)) + } + + assert.Equal(t, second.ID, result[0].ID) + assert.Equal(t, "吻", result[0].LabelName) + }) } diff --git a/internal/entity/search/lens_results.go b/internal/entity/search/lens_results.go new file mode 100644 index 000000000..bc1e08b2d --- /dev/null +++ b/internal/entity/search/lens_results.go @@ -0,0 +1,20 @@ +package search + +import ( + "time" +) + +// Lens represents a lens search result. +type Lens struct { + ID uint `json:"ID"` + LensSlug string `json:"Slug"` + LensName string `json:"Name"` + LensMake string `json:"Make"` + LensModel string `json:"Model"` + LensType string `json:"Type"` + LensDescription string `json:"Description"` + LensNotes string `json:"Notes"` + CreatedAt time.Time `json:"CreatedAt"` + UpdatedAt time.Time `json:"UpdatedAt"` + DeletedAt time.Time `json:"DeletedAt"` +} diff --git a/internal/entity/search/lenses.go b/internal/entity/search/lenses.go new file mode 100644 index 000000000..ce24275f3 --- /dev/null +++ b/internal/entity/search/lenses.go @@ -0,0 +1,58 @@ +package search + +import ( + "strings" + + "github.com/photoprism/photoprism/internal/form" + "github.com/photoprism/photoprism/pkg/txt" +) + +// Lenses searches lenses based on their name. +func Lenses(frm form.SearchLenses) (results []Lens, err error) { + if err = frm.ParseQueryString(); err != nil { + return results, err + } + + s := Db() + // s.LogMode(true) + + // Base query. + s = s.Table("lenses"). + Select(`lenses.*`) + + // Filter private lenses. + if frm.NoMake { + s = s.Where("lenses.lens_make = ''") + } + + // Limit result count. + if frm.Count > 0 && frm.Count <= MaxResults { + s = s.Limit(frm.Count).Offset(frm.Offset) + } else { + s = s.Limit(MaxResults).Offset(frm.Offset) + } + + // Set sort order. + s = s.Order(OrderExpr("lenses.lens_make ASC, lenses.lens_model ASC, lenses.lens_slug ASC", frm.Reverse)) + + if frm.ID != "" { + s = s.Where("lenses.id IN (?)", strings.Split(frm.ID, txt.Or)) + + if result := s.Scan(&results); result.Error != nil { + return results, result.Error + } + + return results, nil + } + + if frm.Query != "" { + likeString := SqlParam(frm.Query, "%", "%") + s = s.Where("lenses.lens_name LIKE ? OR lenses.lens_make LIKE ? OR lenses.lens_model LIKE ?", likeString, likeString, likeString) + } + + if result := s.Scan(&results); result.Error != nil { + return results, result.Error + } + + return results, nil +} diff --git a/internal/entity/search/lenses_test.go b/internal/entity/search/lenses_test.go new file mode 100644 index 000000000..ca2079671 --- /dev/null +++ b/internal/entity/search/lenses_test.go @@ -0,0 +1,151 @@ +package search + +import ( + "strings" + "testing" + + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/internal/form" +) + +func TestLenses(t *testing.T) { + t.Run("SearchWithQuery", func(t *testing.T) { + query := form.NewLensSearch("q:A") + query.Count = 1005 + result, err := Lenses(query) + + if err != nil { + t.Fatal(err) + } + + assert.LessOrEqual(t, 2, len(result)) + + for _, r := range result { + assert.IsType(t, Lens{}, r) + assert.NotEmpty(t, r.ID) + assert.NotEmpty(t, r.LensName) + assert.NotEmpty(t, r.LensSlug) + assert.NotEmpty(t, r.LensModel) + assert.NotEmpty(t, r.LensMake) + assert.True(t, strings.Contains(strings.ToLower(r.LensName), "a") || strings.Contains(strings.ToLower(r.LensMake), "a") || strings.Contains(strings.ToLower(r.LensModel), "a")) + + if fix, ok := entity.LensFixtures[r.LensSlug]; ok { + assert.Equal(t, fix.LensName, r.LensName) + assert.Equal(t, fix.LensSlug, r.LensSlug) + assert.Equal(t, fix.LensMake, r.LensMake) + assert.Equal(t, fix.LensModel, r.LensModel) + } + } + }) + t.Run("SearchForString", func(t *testing.T) { + query := form.NewLensSearch("Q:4.15mm") + query.Count = 1005 + result, err := Lenses(query) + + if err != nil { + t.Fatal(err) + } + + assert.LessOrEqual(t, 1, len(result)) + + for _, r := range result { + assert.IsType(t, Lens{}, r) + assert.NotEmpty(t, r.ID) + assert.NotEmpty(t, r.LensName) + assert.NotEmpty(t, r.LensSlug) + assert.NotEmpty(t, r.LensModel) + + if fix, ok := entity.LensFixtures[r.LensSlug]; ok { + assert.Equal(t, fix.LensName, r.LensName) + assert.Equal(t, fix.LensSlug, r.LensSlug) + assert.Equal(t, fix.LensMake, r.LensMake) + assert.Equal(t, fix.LensModel, r.LensModel) + } + } + }) + t.Run("SearchForNoMake", func(t *testing.T) { + query := form.NewLensSearch("NoMake:true") + query.Count = 15 + result, err := Lenses(query) + + if err != nil { + t.Fatal(err) + } + + assert.LessOrEqual(t, 1, len(result)) + + for _, r := range result { + assert.IsType(t, Lens{}, r) + assert.NotEmpty(t, r.ID) + assert.NotEmpty(t, r.LensName) + assert.NotEmpty(t, r.LensSlug) + assert.Empty(t, r.LensMake) + + if fix, ok := entity.LensFixtures[r.LensSlug]; ok { + assert.Equal(t, fix.LensName, r.LensName) + assert.Equal(t, fix.LensSlug, r.LensSlug) + assert.Equal(t, fix.LensModel, r.LensModel) + } + } + }) + t.Run("SearchWithEmptyQuery", func(t *testing.T) { + fixture := "4-37" + query := form.NewLensSearch("") + result, err := Lenses(query) + + if err != nil { + t.Fatal(err) + } + assert.LessOrEqual(t, 3, len(result)) + assert.Equal(t, entity.LensFixtures.Get(fixture).LensSlug, result[0].LensSlug) + }) + t.Run("SearchWithReverse", func(t *testing.T) { + fixture := "4.15mm-f/2.2" + query := form.NewLensSearch("") + query.Reverse = true + result, err := Lenses(query) + + if err != nil { + t.Fatal(err) + } + assert.LessOrEqual(t, 3, len(result)) + assert.Equal(t, entity.LensFixtures.Get(fixture).LensSlug, result[0].LensSlug) + }) + t.Run("SearchForNoMakeAndQueryNoResults", func(t *testing.T) { + query := form.NewLensSearch("Apple") + query.NoMake = true + result, err := Lenses(query) + + assert.NoError(t, err) + assert.Empty(t, result) + }) + t.Run("SearchWithInvalidQueryString", func(t *testing.T) { + query := form.NewLensSearch("xxx:bla") + result, err := Lenses(query) + + assert.Error(t, err, "unknown filter") + assert.Empty(t, result) + }) + t.Run("SearchForId", func(t *testing.T) { + f := form.SearchLenses{ + Query: "", + ID: "1000002|1000000", + Slug: "", + Name: "", + NoMake: false, + Count: 0, + Offset: 0, + Reverse: false, + } + + result, err := Lenses(f) + + if err != nil { + t.Fatal(err) + } + assert.Len(t, result, 2) + assert.Equal(t, "4-37", result[0].LensSlug) + }) +} diff --git a/internal/entity/search/photos.go b/internal/entity/search/photos.go index 8bf3e0206..ff1a5639f 100644 --- a/internal/entity/search/photos.go +++ b/internal/entity/search/photos.go @@ -156,25 +156,20 @@ func searchPhotos(frm form.SearchPhotos, sess *entity.Session, resultCols string frm.Hidden = false } - // Visitors and other restricted users can only access shared content. + // Visitors and other restricted users can only access shared content. A non-empty Scope + // bypasses the personal ScopePhotosForSession filter below, so it is gated here instead: + // a restricted session may scope only to an album it owns or has shared. "Restricted" means + // shared-only or unregistered; this assumes any view-capable role lacking library/all access + // also holds access_shared (else HasSharedAccessOnly would not flag it). if frm.Scope != "" && album.CreatedBy != user.UserUID && !sess.HasShare(frm.Scope) && (sess.GetUser().HasSharedAccessOnly(acl.ResourcePhotos) || sess.NotRegistered()) || frm.Scope == "" && acl.Rules.Deny(acl.ResourcePhotos, aclRole, acl.ActionSearch) { event.AuditErr([]string{sess.IP(), "session %s", "%s %s as %s", status.Denied}, sess.RefID, acl.ActionSearch.String(), string(acl.ResourcePhotos), aclRole) return PhotoResults{}, 0, ErrForbidden } - // Limit results for external users. - if frm.Scope == "" && acl.Rules.DenyAll(acl.ResourcePhotos, aclRole, acl.Permissions{acl.AccessAll, acl.AccessLibrary}) { - sharedAlbums := "photos.photo_uid IN (SELECT photo_uid FROM photos_albums WHERE hidden = 0 AND missing = 0 AND album_uid IN (?)) OR " - - if sess.IsVisitor() || sess.NotRegistered() { - s = s.Where(sharedAlbums+"photos.published_at > ?", sess.SharedUIDs(), entity.Now()) - } else if basePath := user.GetBasePath(); basePath == "" { - s = s.Where(sharedAlbums+"photos.created_by = ? OR photos.published_at > ?", sess.SharedUIDs(), user.UserUID, entity.Now()) - } else { - s = s.Where(sharedAlbums+"photos.created_by = ? OR photos.published_at > ? OR photos.photo_path = ? OR photos.photo_path LIKE ?", - sess.SharedUIDs(), user.UserUID, entity.Now(), basePath, basePath+"/%") - } + // Limit results to the content this session may access. + if frm.Scope == "" { + s = ScopePhotosForSession(s, sess) } } @@ -286,27 +281,27 @@ func searchPhotos(frm form.SearchPhotos, sess *entity.Session, resultCols string // Filter by label, label category and keywords. if txt.NotEmpty(frm.Label) { - var categories []entity.Category - var labels []entity.Label - var labelIds []uint + include, exclude, sawPositive, labelErr := entity.ParseLabelFilter(frm.Label) - if labelErr := Db().Where(AnySlug("label_slug", frm.Label, txt.Or)).Or(AnySlug("custom_slug", frm.Label, txt.Or)).Find(&labels).Error; len(labels) == 0 || labelErr != nil { + if labelErr != nil || (sawPositive && len(include) == 0) { log.Debugf("search: label %s not found", txt.LogParamLower(frm.Label)) return PhotoResults{}, 0, nil - } else { - for _, l := range labels { - labelIds = append(labelIds, l.ID) + } - Log("find categories", Db().Where("category_id = ?", l.ID).Find(&categories).Error) - log.Debugf("search: label %s includes %d categories", txt.LogParamLower(l.LabelName), len(categories)) - - for _, category := range categories { - labelIds = append(labelIds, category.LabelID) - } + // JOIN the first positive group so photos_labels.uncertainty is + // available for the "relevance" sort order; subsequent positive + // groups compose as AND via IN subqueries. + for i, ids := range include { + if i == 0 { + s = s.Joins("JOIN photos_labels ON photos_labels.photo_id = files.photo_id AND photos_labels.uncertainty < 100 AND photos_labels.label_id IN (?)", ids). + Group("photos.id, files.id") + } else { + s = s.Where("files.photo_id IN (SELECT photo_id FROM photos_labels WHERE uncertainty < 100 AND label_id IN (?))", ids) } + } - s = s.Joins("JOIN photos_labels ON photos_labels.photo_id = files.photo_id AND photos_labels.uncertainty < 100 AND photos_labels.label_id IN (?)", labelIds). - Group("photos.id, files.id") + for _, ids := range exclude { + s = s.Where("files.photo_id NOT IN (SELECT photo_id FROM photos_labels WHERE uncertainty < 100 AND label_id IN (?))", ids) } } @@ -396,33 +391,18 @@ func searchPhotos(frm form.SearchPhotos, sess *entity.Session, resultCols string // Filter by query string. if frm.Query != "" { - var categories []entity.Category - var labels []entity.Label - var labelIds []uint - - if labelsErr := Db().Where(AnySlug("custom_slug", frm.Query, " ")).Find(&labels).Error; len(labels) == 0 || labelsErr != nil { + if labelIds, labelsErr := entity.FindLabelIDs(frm.Query, " ", true); labelsErr != nil || len(labelIds) == 0 { log.Tracef("search: label %s not found, using fuzzy search", txt.LogParamLower(frm.Query)) - for _, where := range LikeAnyKeyword("k.keyword", frm.Query) { - s = s.Where("files.photo_id IN (SELECT pk.photo_id FROM keywords k JOIN photos_keywords pk ON k.id = pk.keyword_id WHERE (?))", gorm.Expr(where)) + wheres, values := LikeAnyKeyword("k.keyword", frm.Query) + for i, where := range wheres { + s = s.Where("files.photo_id IN (SELECT pk.photo_id FROM keywords k JOIN photos_keywords pk ON k.id = pk.keyword_id WHERE (?))", gorm.Expr(where, values[i]...)) } } else { - for _, l := range labels { - labelIds = append(labelIds, l.ID) - - Db().Where("category_id = ?", l.ID).Find(&categories) - - log.Tracef("search: label %s includes %d categories", txt.LogParamLower(l.LabelName), len(categories)) - - for _, category := range categories { - labelIds = append(labelIds, category.LabelID) - } - } - - if wheres := LikeAnyKeyword("k.keyword", frm.Query); len(wheres) > 0 { - for _, where := range wheres { + if wheres, values := LikeAnyKeyword("k.keyword", frm.Query); len(wheres) > 0 { + for i, where := range wheres { s = s.Where("files.photo_id IN (SELECT pk.photo_id FROM keywords k JOIN photos_keywords pk ON k.id = pk.keyword_id WHERE (?)) OR "+ - "files.photo_id IN (SELECT pl.photo_id FROM photos_labels pl WHERE pl.uncertainty < 100 AND pl.label_id IN (?))", gorm.Expr(where), labelIds) + "files.photo_id IN (SELECT pl.photo_id FROM photos_labels pl WHERE pl.uncertainty < 100 AND pl.label_id IN (?))", gorm.Expr(where, values[i]...), labelIds) } } else { s = s.Where("files.photo_id IN (SELECT pl.photo_id FROM photos_labels pl WHERE pl.uncertainty < 100 AND pl.label_id IN (?))", labelIds) @@ -432,8 +412,9 @@ func searchPhotos(frm form.SearchPhotos, sess *entity.Session, resultCols string // Search for one or more keywords. if txt.NotEmpty(frm.Keywords) { - for _, where := range LikeAnyWord("k.keyword", frm.Keywords) { - s = s.Where("files.photo_id IN (SELECT pk.photo_id FROM keywords k JOIN photos_keywords pk ON k.id = pk.keyword_id WHERE (?))", gorm.Expr(where)) + wheres, values := LikeAnyWord("k.keyword", frm.Keywords) + for i, where := range wheres { + s = s.Where("files.photo_id IN (SELECT pk.photo_id FROM keywords k JOIN photos_keywords pk ON k.id = pk.keyword_id WHERE (?))", gorm.Expr(where, values[i]...)) } } @@ -480,14 +461,16 @@ func searchPhotos(frm form.SearchPhotos, sess *entity.Session, resultCols string s = s.Where(fmt.Sprintf("files.photo_id IN (SELECT photo_id FROM files f JOIN %s m ON f.file_uid = m.file_uid AND m.marker_invalid = 0 WHERE subj_uid IN (?))", entity.Marker{}.TableName()), subjects) } else { + w, v := AnySlug("s.subj_slug", subj, txt.Or) s = s.Where(fmt.Sprintf("files.photo_id IN (SELECT photo_id FROM files f JOIN %s m ON f.file_uid = m.file_uid AND m.marker_invalid = 0 JOIN %s s ON s.subj_uid = m.subj_uid WHERE (?))", - entity.Marker{}.TableName(), entity.Subject{}.TableName()), gorm.Expr(AnySlug("s.subj_slug", subj, txt.Or))) + entity.Marker{}.TableName(), entity.Subject{}.TableName()), gorm.Expr(w, v...)) } } } else if txt.NotEmpty(frm.Subjects) { - for _, where := range LikeAllNames(Cols{"subj_name", "subj_alias"}, frm.Subjects) { + wheres, values := LikeAllNames(Cols{"subj_name", "subj_alias"}, frm.Subjects) + for i, where := range wheres { s = s.Where(fmt.Sprintf("files.photo_id IN (SELECT photo_id FROM files f JOIN %s m ON f.file_uid = m.file_uid AND m.marker_invalid = 0 JOIN %s s ON s.subj_uid = m.subj_uid WHERE (?))", - entity.Marker{}.TableName(), entity.Subject{}.TableName()), gorm.Expr(where)) + entity.Marker{}.TableName(), entity.Subject{}.TableName()), gorm.Expr(where, values[i]...)) } } @@ -548,17 +531,20 @@ func searchPhotos(frm form.SearchPhotos, sess *entity.Session, resultCols string // Filter by year. if frm.Year != "" { - s = s.Where(AnyInt("photos.photo_year", frm.Year, txt.Or, entity.UnknownYear, txt.YearMax)) + w, v := AnyInt("photos.photo_year", frm.Year, txt.Or, entity.UnknownYear, txt.YearMax) + s = s.Where(w, v...) } // Filter by month. if frm.Month != "" { - s = s.Where(AnyInt("photos.photo_month", frm.Month, txt.Or, entity.UnknownMonth, txt.MonthMax)) + w, v := AnyInt("photos.photo_month", frm.Month, txt.Or, entity.UnknownMonth, txt.MonthMax) + s = s.Where(w, v...) } // Filter by day. if frm.Day != "" { - s = s.Where(AnyInt("photos.photo_day", frm.Day, txt.Or, entity.UnknownDay, txt.DayMax)) + w, v := AnyInt("photos.photo_day", frm.Day, txt.Or, entity.UnknownDay, txt.DayMax) + s = s.Where(w, v...) } // Filter by Resolution in Megapixels (MP). @@ -826,8 +812,9 @@ func searchPhotos(frm form.SearchPhotos, sess *entity.Session, resultCols string v := strings.Trim(frm.Album, "*%") + "%" s = s.Where("photos.photo_uid IN (SELECT pa.photo_uid FROM photos_albums pa JOIN albums a ON a.album_uid = pa.album_uid AND pa.hidden = 0 WHERE (a.album_title LIKE ? OR a.album_slug LIKE ?))", v, v) } else if txt.NotEmpty(frm.Albums) { - for _, where := range LikeAnyWord("a.album_title", frm.Albums) { - s = s.Where("photos.photo_uid IN (SELECT pa.photo_uid FROM photos_albums pa JOIN albums a ON a.album_uid = pa.album_uid AND pa.hidden = 0 WHERE (?))", gorm.Expr(where)) + wheres, values := LikeAnyWord("a.album_title", frm.Albums) + for i, where := range wheres { + s = s.Where("photos.photo_uid IN (SELECT pa.photo_uid FROM photos_albums pa JOIN albums a ON a.album_uid = pa.album_uid AND pa.hidden = 0 WHERE (?))", gorm.Expr(where, values[i]...)) } } } diff --git a/internal/entity/search/photos_filter_label_test.go b/internal/entity/search/photos_filter_label_test.go index 41f434a32..a4359986f 100644 --- a/internal/entity/search/photos_filter_label_test.go +++ b/internal/entity/search/photos_filter_label_test.go @@ -102,9 +102,11 @@ func TestPhotosFilterLabel(t *testing.T) { assert.Len(t, photos, 1) }) t.Run("StartsWithAmpersand", func(t *testing.T) { + // Option A: a literal '&' inside a label name must be escaped because + // the unescaped form is now parsed as an AND separator between groups. var f form.SearchPhotos - f.Label = "&friendship" + f.Label = `\&friendship` f.Merged = true photos, _, err := Photos(f) @@ -118,7 +120,7 @@ func TestPhotosFilterLabel(t *testing.T) { t.Run("CenterAmpersand", func(t *testing.T) { var f form.SearchPhotos - f.Label = "construction&failure" + f.Label = `construction\&failure` f.Merged = true photos, _, err := Photos(f) @@ -132,7 +134,7 @@ func TestPhotosFilterLabel(t *testing.T) { t.Run("EndsWithAmpersand", func(t *testing.T) { var f form.SearchPhotos - f.Label = "goal&" + f.Label = `goal\&` f.Merged = true photos, _, err := Photos(f) @@ -463,7 +465,7 @@ func TestPhotosQueryLabel(t *testing.T) { t.Run("StartsWithAmpersand", func(t *testing.T) { var f form.SearchPhotos - f.Query = "label:\"&friendship\"" + f.Query = `label:"\&friendship"` f.Merged = true photos, _, err := Photos(f) @@ -477,7 +479,7 @@ func TestPhotosQueryLabel(t *testing.T) { t.Run("CenterAmpersand", func(t *testing.T) { var f form.SearchPhotos - f.Query = "label:\"construction&failure\"" + f.Query = `label:"construction\&failure"` f.Merged = true photos, _, err := Photos(f) @@ -491,7 +493,7 @@ func TestPhotosQueryLabel(t *testing.T) { t.Run("EndsWithAmpersand", func(t *testing.T) { var f form.SearchPhotos - f.Query = "label:\"goal&\"" + f.Query = `label:"goal\&"` f.Merged = true photos, _, err := Photos(f) @@ -724,4 +726,151 @@ func TestPhotosQueryLabel(t *testing.T) { } assert.Len(t, photos, 2) }) + t.Run("HomophoneName", func(t *testing.T) { + _, second, _, photoB := createHomophoneSearchFixtures(t) + + var f form.SearchPhotos + + f.Label = second.LabelName + f.Merged = true + + photos, _, err := Photos(f) + + if err != nil { + t.Fatal(err) + } + + if len(photos) != 1 { + t.Fatalf("expected one result, got %d", len(photos)) + } + + assert.Equal(t, photoB.PhotoUID, photos[0].PhotoUID) + }) +} + +// baselinePhotoCount returns the merged-photo result count for a search with no +// label filter. Used by NOT/AND tests to derive expected counts. +func baselinePhotoCount(t *testing.T) int { + t.Helper() + + var f form.SearchPhotos + + f.Merged = true + + photos, _, err := Photos(f) + if err != nil { + t.Fatal(err) + } + + return len(photos) +} + +// photosWithLabel runs a label filter search and returns the merged photos. +func photosWithLabel(t *testing.T, label string) PhotoResults { + t.Helper() + + var f form.SearchPhotos + + f.Label = label + f.Merged = true + + photos, _, err := Photos(f) + if err != nil { + t.Fatal(err) + } + + return photos +} + +// containsPhotoUID reports whether any of the photos in results carries the +// given UID. +func containsPhotoUID(results PhotoResults, uid string) bool { + for _, p := range results { + if p.PhotoUID == uid { + return true + } + } + + return false +} + +func TestPhotosFilterLabelNotAnd(t *testing.T) { + t.Run("SingleExclude", func(t *testing.T) { + base := baselinePhotoCount(t) + withFlower := len(photosWithLabel(t, "flower")) + result := photosWithLabel(t, "!flower") + assert.Equal(t, base-withFlower, len(result)) + }) + t.Run("ExcludeUnknownIsNoOp", func(t *testing.T) { + base := baselinePhotoCount(t) + result := photosWithLabel(t, "!totally-unknown-label") + assert.Equal(t, base, len(result)) + }) + t.Run("OnlyNegative", func(t *testing.T) { + base := baselinePhotoCount(t) + withCake := len(photosWithLabel(t, "cake")) + result := photosWithLabel(t, "!cake") + assert.Equal(t, base-withCake, len(result)) + }) + t.Run("IncludeAndExclude", func(t *testing.T) { + result := photosWithLabel(t, "cake&!flower") + assert.Len(t, result, 2) + }) + t.Run("MultipleIncludes", func(t *testing.T) { + result := photosWithLabel(t, "cake&flower") + assert.Len(t, result, 3) + }) + t.Run("MultipleIncludesPlusExclude", func(t *testing.T) { + result := photosWithLabel(t, "cake&flower&!cow") + assert.Len(t, result, 1) + }) + t.Run("IncludeOrExcludeBlurry", func(t *testing.T) { + result := photosWithLabel(t, "cake|flower&!cow") + assert.Len(t, result, 2) + }) + t.Run("CategoryExpansion", func(t *testing.T) { + base := baselinePhotoCount(t) + withLandscape := len(photosWithLabel(t, "landscape")) + result := photosWithLabel(t, "!landscape") + assert.Equal(t, base-withLandscape, len(result)) + assert.Greater(t, withLandscape, 0) + }) + t.Run("EscapeLiteralBang", func(t *testing.T) { + // No fixture label named "!weird" exists, so a positive lookup for the + // escaped literal short-circuits to an empty result set. + result := photosWithLabel(t, `\!weird`) + assert.Empty(t, result) + }) + t.Run("EscapeLiteralBangNegated", func(t *testing.T) { + // Negating an unknown literal label "!weird" is a no-op. + base := baselinePhotoCount(t) + result := photosWithLabel(t, `!\!weird`) + assert.Equal(t, base, len(result)) + }) + t.Run("LegacyAmpersandName", func(t *testing.T) { + escaped := photosWithLabel(t, `construction\&failure`) + assert.Len(t, escaped, 2) + + // The same input without escape is now parsed as two positive AND + // groups: neither "construction" nor "failure" exists as a fixture + // label, so the result short-circuits to empty. + unescaped := photosWithLabel(t, "construction&failure") + assert.Empty(t, unescaped) + }) + t.Run("OnlyNegativeTwoGroups", func(t *testing.T) { + base := baselinePhotoCount(t) + // With disjoint label sets, the count equals base minus union; since + // flower ⊂ landscape-category here, use an independent pair. + withCake := len(photosWithLabel(t, "cake")) + withCow := len(photosWithLabel(t, "cow")) + result := photosWithLabel(t, "!cake&!cow") + // The difference must be between base-(cake+cow) and base-max(cake,cow). + maxSide := withCake + if withCow > maxSide { + maxSide = withCow + } + + assert.LessOrEqual(t, len(result), base-maxSide) + assert.GreaterOrEqual(t, len(result), base-(withCake+withCow)) + }) } diff --git a/internal/entity/search/photos_filter_lens_test.go b/internal/entity/search/photos_filter_lens_test.go index 47cb949a6..002a37a83 100644 --- a/internal/entity/search/photos_filter_lens_test.go +++ b/internal/entity/search/photos_filter_lens_test.go @@ -1,10 +1,12 @@ package search import ( + "fmt" "testing" "github.com/stretchr/testify/assert" + "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/form" ) @@ -23,9 +25,10 @@ func TestPhotosFilterLens(t *testing.T) { assert.GreaterOrEqual(t, len(photos), 46) }) t.Run("AppleIPhoneSeBackCameraFourFifteenMmFTwoTwo", func(t *testing.T) { + fixture := "4.15mm-f/2.2" var f form.SearchPhotos - f.Lens = "Apple iPhone SE back camera 4.15mm f/2.2" + f.Lens = entity.LensFixtures.Get(fixture).LensName f.Merged = true photos, _, err := Photos(f) @@ -303,9 +306,10 @@ func TestPhotosQueryLens(t *testing.T) { assert.GreaterOrEqual(t, len(photos), 46) }) t.Run("AppleIPhoneSeBackCameraFourFifteenMmFTwoTwo", func(t *testing.T) { + fixture := "4.15mm-f/2.2" var f form.SearchPhotos - f.Query = "lens:\"Apple iPhone SE back camera 4.15mm f/2.2\"" + f.Query = fmt.Sprintf(`lens:"%s"`, entity.LensFixtures.Get(fixture).LensModel) f.Merged = true photos, _, err := Photos(f) diff --git a/internal/entity/search/photos_geo.go b/internal/entity/search/photos_geo.go index 3d4b077f0..183d6d30c 100644 --- a/internal/entity/search/photos_geo.go +++ b/internal/entity/search/photos_geo.go @@ -43,6 +43,9 @@ func UserPhotosGeo(frm form.SearchPhotosGeo, sess *entity.Session) (results GeoR return GeoResults{}, ErrBadRequest } + // Position of the picture referenced by "near", used to sort results by distance to it. + var nearLat, nearLng float64 + // Find photos near another? if txt.NotEmpty(frm.Near) { photo := Photo{} @@ -56,6 +59,9 @@ func UserPhotosGeo(frm form.SearchPhotosGeo, sess *entity.Session) (results GeoR // Set the S2 Cell ID to search for. frm.S2 = photo.CellID + // Remember the picture's position so results can be ordered by distance to it. + nearLat, nearLng = photo.PhotoLat, photo.PhotoLng + // Set the search distance if unspecified. if frm.Dist <= 0 { frm.Dist = geo.DefaultDist @@ -156,12 +162,14 @@ func UserPhotosGeo(frm form.SearchPhotosGeo, sess *entity.Session) (results GeoR } } - // Set sort order. - if frm.Near == "" { + // Sort results by time, unless the "Near" filter is used together with "nearLat" and "nearLng". + if frm.Near == "" || nearLat == 0 || nearLng == 0 { s = s.Order("taken_at, photos.photo_uid") } else { - // Sort by distance to UID. - s = s.Order(gorm.Expr("(photos.photo_uid = ?) DESC, ABS(? - photos.photo_lat)+ABS(? - photos.photo_lng)", frm.Near, frm.Lat, frm.Lng)) + // Sort by distance to the picture referenced by "near", placing it first. Its position + // is used here rather than frm.Lat/Lng (which the near lookup leaves unset) so the order + // reflects proximity to that picture instead of distance from the (0,0) origin. + s = s.Order(gorm.Expr("(photos.photo_uid = ?) DESC, ABS(? - photos.photo_lat)+ABS(? - photos.photo_lng)", frm.Near, nearLat, nearLng)) } // Find specific UIDs only. @@ -208,27 +216,19 @@ func UserPhotosGeo(frm form.SearchPhotosGeo, sess *entity.Session) (results GeoR // Filter by label, label category and keywords. if txt.NotEmpty(frm.Label) { - var categories []entity.Category - var labels []entity.Label - var labelIds []uint + include, exclude, sawPositive, labelErr := entity.ParseLabelFilter(frm.Label) - if labelErr := Db().Where(AnySlug("label_slug", frm.Label, txt.Or)).Or(AnySlug("custom_slug", frm.Label, txt.Or)).Find(&labels).Error; len(labels) == 0 || labelErr != nil { + if labelErr != nil || (sawPositive && len(include) == 0) { log.Debugf("search: label %s not found", txt.LogParamLower(frm.Label)) return GeoResults{}, nil - } else { - for _, l := range labels { - labelIds = append(labelIds, l.ID) + } - Log("find categories", Db().Where("category_id = ?", l.ID).Find(&categories).Error) - log.Debugf("search: label %s includes %d categories", txt.LogParamLower(l.LabelName), len(categories)) + for _, ids := range include { + s = s.Where("files.photo_id IN (SELECT photo_id FROM photos_labels WHERE uncertainty < 100 AND label_id IN (?))", ids) + } - for _, category := range categories { - labelIds = append(labelIds, category.LabelID) - } - } - - s = s.Joins("JOIN photos_labels ON photos_labels.photo_id = files.photo_id AND photos_labels.uncertainty < 100 AND photos_labels.label_id IN (?)", labelIds). - Group("photos.id, files.id") + for _, ids := range exclude { + s = s.Where("files.photo_id NOT IN (SELECT photo_id FROM photos_labels WHERE uncertainty < 100 AND label_id IN (?))", ids) } } @@ -308,32 +308,18 @@ func UserPhotosGeo(frm form.SearchPhotosGeo, sess *entity.Session) (results GeoR // Filter by label, label category, and keywords. if frm.Query != "" { - var categories []entity.Category - var labels []entity.Label - var labelIds []uint - - if labelsErr := Db().Where(AnySlug("custom_slug", frm.Query, " ")).Find(&labels).Error; len(labels) == 0 || labelsErr != nil { + if labelIds, labelsErr := entity.FindLabelIDs(frm.Query, " ", true); labelsErr != nil || len(labelIds) == 0 { log.Tracef("search: label %s not found, using fuzzy search", txt.LogParamLower(frm.Query)) - for _, where := range LikeAnyKeyword("k.keyword", frm.Query) { - s = s.Where("photos.id IN (SELECT pk.photo_id FROM keywords k JOIN photos_keywords pk ON k.id = pk.keyword_id WHERE (?))", gorm.Expr(where)) + wheres, values := LikeAnyKeyword("k.keyword", frm.Query) + for i, where := range wheres { + s = s.Where("photos.id IN (SELECT pk.photo_id FROM keywords k JOIN photos_keywords pk ON k.id = pk.keyword_id WHERE (?))", gorm.Expr(where, values[i]...)) } } else { - for _, l := range labels { - labelIds = append(labelIds, l.ID) - - Log("find categories", Db().Where("category_id = ?", l.ID).Find(&categories).Error) - log.Tracef("search: label %s includes %d categories", txt.LogParamLower(l.LabelName), len(categories)) - - for _, category := range categories { - labelIds = append(labelIds, category.LabelID) - } - } - - if wheres := LikeAnyKeyword("k.keyword", frm.Query); len(wheres) > 0 { - for _, where := range wheres { + if wheres, values := LikeAnyKeyword("k.keyword", frm.Query); len(wheres) > 0 { + for i, where := range wheres { s = s.Where("photos.id IN (SELECT pk.photo_id FROM keywords k JOIN photos_keywords pk ON k.id = pk.keyword_id WHERE (?)) OR "+ - "photos.id IN (SELECT pl.photo_id FROM photos_labels pl WHERE pl.uncertainty < 100 AND pl.label_id IN (?))", gorm.Expr(where), labelIds) + "photos.id IN (SELECT pl.photo_id FROM photos_labels pl WHERE pl.uncertainty < 100 AND pl.label_id IN (?))", gorm.Expr(where, values[i]...), labelIds) } } else { s = s.Where("photos.id IN (SELECT pl.photo_id FROM photos_labels pl WHERE pl.uncertainty < 100 AND pl.label_id IN (?))", labelIds) @@ -343,8 +329,9 @@ func UserPhotosGeo(frm form.SearchPhotosGeo, sess *entity.Session) (results GeoR // Search for one or more keywords. if frm.Keywords != "" { - for _, where := range LikeAnyWord("k.keyword", frm.Keywords) { - s = s.Where("photos.id IN (SELECT pk.photo_id FROM keywords k JOIN photos_keywords pk ON k.id = pk.keyword_id WHERE (?))", gorm.Expr(where)) + wheres, values := LikeAnyWord("k.keyword", frm.Keywords) + for i, where := range wheres { + s = s.Where("photos.id IN (SELECT pk.photo_id FROM keywords k JOIN photos_keywords pk ON k.id = pk.keyword_id WHERE (?))", gorm.Expr(where, values[i]...)) } } @@ -391,14 +378,16 @@ func UserPhotosGeo(frm form.SearchPhotosGeo, sess *entity.Session) (results GeoR s = s.Where(fmt.Sprintf("photos.id IN (SELECT photo_id FROM files f JOIN %s m ON f.file_uid = m.file_uid AND m.marker_invalid = 0 WHERE subj_uid IN (?))", entity.Marker{}.TableName()), subjects) } else { + w, v := AnySlug("s.subj_slug", subj, txt.Or) s = s.Where(fmt.Sprintf("photos.id IN (SELECT photo_id FROM files f JOIN %s m ON f.file_uid = m.file_uid AND m.marker_invalid = 0 JOIN %s s ON s.subj_uid = m.subj_uid WHERE (?))", - entity.Marker{}.TableName(), entity.Subject{}.TableName()), gorm.Expr(AnySlug("s.subj_slug", subj, txt.Or))) + entity.Marker{}.TableName(), entity.Subject{}.TableName()), gorm.Expr(w, v...)) } } } else if frm.Subjects != "" { - for _, where := range LikeAllNames(Cols{"subj_name", "subj_alias"}, frm.Subjects) { + wheres, values := LikeAllNames(Cols{"subj_name", "subj_alias"}, frm.Subjects) + for i, where := range wheres { s = s.Where(fmt.Sprintf("photos.id IN (SELECT photo_id FROM files f JOIN %s m ON f.file_uid = m.file_uid AND m.marker_invalid = 0 JOIN %s s ON s.subj_uid = m.subj_uid WHERE (?))", - entity.Marker{}.TableName(), entity.Subject{}.TableName()), gorm.Expr(where)) + entity.Marker{}.TableName(), entity.Subject{}.TableName()), gorm.Expr(where, values[i]...)) } } @@ -410,8 +399,9 @@ func UserPhotosGeo(frm form.SearchPhotosGeo, sess *entity.Session) (results GeoR v := strings.Trim(frm.Album, "*%") + "%" s = s.Where("photos.photo_uid IN (SELECT pa.photo_uid FROM photos_albums pa JOIN albums a ON a.album_uid = pa.album_uid AND pa.hidden = 0 WHERE (a.album_title LIKE ? OR a.album_slug LIKE ?))", v, v) } else if txt.NotEmpty(frm.Albums) { - for _, where := range LikeAnyWord("a.album_title", frm.Albums) { - s = s.Where("photos.photo_uid IN (SELECT pa.photo_uid FROM photos_albums pa JOIN albums a ON a.album_uid = pa.album_uid AND pa.hidden = 0 WHERE (?))", gorm.Expr(where)) + wheres, values := LikeAnyWord("a.album_title", frm.Albums) + for i, where := range wheres { + s = s.Where("photos.photo_uid IN (SELECT pa.photo_uid FROM photos_albums pa JOIN albums a ON a.album_uid = pa.album_uid AND pa.hidden = 0 WHERE (?))", gorm.Expr(where, values[i]...)) } } } @@ -443,17 +433,20 @@ func UserPhotosGeo(frm form.SearchPhotosGeo, sess *entity.Session) (results GeoR // Filter by year. if frm.Year != "" { - s = s.Where(AnyInt("photos.photo_year", frm.Year, txt.Or, entity.UnknownYear, txt.YearMax)) + w, v := AnyInt("photos.photo_year", frm.Year, txt.Or, entity.UnknownYear, txt.YearMax) + s = s.Where(w, v...) } // Filter by month. if frm.Month != "" { - s = s.Where(AnyInt("photos.photo_month", frm.Month, txt.Or, entity.UnknownMonth, txt.MonthMax)) + w, v := AnyInt("photos.photo_month", frm.Month, txt.Or, entity.UnknownMonth, txt.MonthMax) + s = s.Where(w, v...) } // Filter by day. if frm.Day != "" { - s = s.Where(AnyInt("photos.photo_day", frm.Day, txt.Or, entity.UnknownDay, txt.DayMax)) + w, v := AnyInt("photos.photo_day", frm.Day, txt.Or, entity.UnknownDay, txt.DayMax) + s = s.Where(w, v...) } // Filter by Resolution in Megapixels (MP). diff --git a/internal/entity/search/photos_geo_filter_label_test.go b/internal/entity/search/photos_geo_filter_label_test.go new file mode 100644 index 000000000..63d3d6f57 --- /dev/null +++ b/internal/entity/search/photos_geo_filter_label_test.go @@ -0,0 +1,123 @@ +package search + +import ( + "testing" + + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/form" +) + +// geoBaselineCount returns the merged geo-result count for a search with no +// label filter. +func geoBaselineCount(t *testing.T) int { + t.Helper() + + result, err := PhotosGeo(form.NewSearchPhotosGeo("")) + if err != nil { + t.Fatal(err) + } + + return len(result) +} + +// geoCountForLabel runs a geo search with the given label filter and returns +// the number of results. +func geoCountForLabel(t *testing.T, label string) int { + t.Helper() + + q := form.NewSearchPhotosGeo("") + q.Label = label + + result, err := PhotosGeo(q) + if err != nil { + t.Fatal(err) + } + + return len(result) +} + +func TestPhotosGeoFilterLabel(t *testing.T) { + t.Run("SingleInclude", func(t *testing.T) { + assert.Greater(t, geoCountForLabel(t, "cake"), 0) + }) + t.Run("SingleExclude", func(t *testing.T) { + base := geoBaselineCount(t) + withFlower := geoCountForLabel(t, "flower") + result := geoCountForLabel(t, "!flower") + assert.Equal(t, base-withFlower, result) + }) + t.Run("ExcludeUnknownIsNoOp", func(t *testing.T) { + base := geoBaselineCount(t) + result := geoCountForLabel(t, "!totally-unknown-label") + assert.Equal(t, base, result) + }) + t.Run("OnlyNegative", func(t *testing.T) { + base := geoBaselineCount(t) + withCake := geoCountForLabel(t, "cake") + result := geoCountForLabel(t, "!cake") + assert.Equal(t, base-withCake, result) + }) + t.Run("IncludeAndExclude", func(t *testing.T) { + // cake&!flower is empty on the geo subset because every geotagged + // cake photo is also tagged with flower. + result := geoCountForLabel(t, "cake&!flower") + assert.Equal(t, 0, result) + }) + t.Run("MultipleIncludes", func(t *testing.T) { + result := geoCountForLabel(t, "cake&flower") + assert.Equal(t, 2, result) + }) + t.Run("MultipleIncludesPlusExclude", func(t *testing.T) { + result := geoCountForLabel(t, "cake&flower&!cow") + assert.Equal(t, 0, result) + }) + t.Run("IncludeOrExcludeCow", func(t *testing.T) { + result := geoCountForLabel(t, "cake|flower&!cow") + // All geotagged cake-or-flower photos also carry cow in fixtures. + assert.Equal(t, 0, result) + }) + t.Run("CategoryExpansion", func(t *testing.T) { + base := geoBaselineCount(t) + withLandscape := geoCountForLabel(t, "landscape") + assert.Greater(t, withLandscape, 0) + assert.Equal(t, base-withLandscape, geoCountForLabel(t, "!landscape")) + }) + t.Run("EscapeLiteralBang", func(t *testing.T) { + // No fixture label named "!weird" exists; positive lookup short-circuits. + assert.Equal(t, 0, geoCountForLabel(t, `\!weird`)) + }) + t.Run("EscapeLiteralBangNegated", func(t *testing.T) { + base := geoBaselineCount(t) + assert.Equal(t, base, geoCountForLabel(t, `!\!weird`)) + }) + t.Run("LegacyAmpersandName", func(t *testing.T) { + assert.Equal(t, 1, geoCountForLabel(t, `construction\&failure`)) + // Unescaped now parses as two positive AND groups, neither resolvable. + assert.Equal(t, 0, geoCountForLabel(t, "construction&failure")) + }) +} + +func TestPhotosGeoQueryLabel(t *testing.T) { + t.Run("SingleExclude", func(t *testing.T) { + base := geoBaselineCount(t) + withFlower := geoCountForLabel(t, "flower") + + q := form.NewSearchPhotosGeo(`label:"!flower"`) + result, err := PhotosGeo(q) + if err != nil { + t.Fatal(err) + } + + assert.Equal(t, base-withFlower, len(result)) + }) + t.Run("IncludeAndExclude", func(t *testing.T) { + q := form.NewSearchPhotosGeo(`label:"cake&flower"`) + result, err := PhotosGeo(q) + if err != nil { + t.Fatal(err) + } + + assert.Equal(t, 2, len(result)) + }) +} diff --git a/internal/entity/search/photos_geo_test.go b/internal/entity/search/photos_geo_test.go index 8781c4fd4..7d0e16d83 100644 --- a/internal/entity/search/photos_geo_test.go +++ b/internal/entity/search/photos_geo_test.go @@ -1,6 +1,8 @@ package search import ( + "fmt" + "math" "testing" "time" @@ -26,6 +28,47 @@ func TestGeo(t *testing.T) { assert.LessOrEqual(t, 4, len(result)) } }) + t.Run("NearSortsByDistanceToReferencedPhoto", func(t *testing.T) { + // ps6sg6be2lvl0y15 sits far from the (0,0) origin and shares its location with other + // pictures in the same cell, so a correct "near" sort must place those coincident + // pictures right after it. Sorting by distance from the origin (the bug) would instead + // surface the cell's pictures nearest to (0,0) first. + const nearUID = "ps6sg6be2lvl0y15" + + query := form.NewSearchPhotosGeo("near:" + nearUID) + + if err := query.ParseQueryString(); err != nil { + t.Fatal(err) + } + + result, err := PhotosGeo(query) + + if err != nil { + t.Fatal(err) + } + + // The referenced picture must come first, with several neighbors at varying distances. + assert.LessOrEqual(t, 4, len(result)) + assert.Equal(t, nearUID, result[0].PhotoUID) + + nearLat, nearLng := result[0].PhotoLat, result[0].PhotoLng + + dist := func(r GeoResult) float64 { + return math.Abs(nearLat-r.PhotoLat) + math.Abs(nearLng-r.PhotoLng) + } + + // Results must be ordered by non-decreasing distance to the referenced picture, and the + // set must actually span more than one location so the assertion is not vacuous. + coords := map[string]bool{} + prev := -1.0 + for _, r := range result { + d := dist(r) + assert.GreaterOrEqualf(t, d, prev, "results not sorted by distance to %s at %s", nearUID, r.PhotoUID) + prev = d + coords[fmt.Sprintf("%f,%f", r.PhotoLat, r.PhotoLng)] = true + } + assert.Greater(t, len(coords), 1, "expected neighbors at more than one location") + }) t.Run("UnknownFaces", func(t *testing.T) { query := form.NewSearchPhotosGeo("face:none") @@ -1194,4 +1237,33 @@ func TestGeo(t *testing.T) { assert.Empty(t, r.PhotoTitle) } }) + t.Run("QueryMatchesHomophoneLabel", func(t *testing.T) { + first, _, photoA, photoB := createHomophoneSearchFixtures(t) + + var f form.SearchPhotosGeo + + f.Query = first.LabelName + + photos, err := PhotosGeo(f) + + if err != nil { + t.Fatal(err) + } + + if len(photos) == 0 { + t.Fatal("expected results") + } + + foundRight := false + + for _, photo := range photos { + assert.NotEqual(t, photoB.PhotoUID, photo.PhotoUID) + + if photo.PhotoUID == photoA.PhotoUID { + foundRight = true + } + } + + assert.True(t, foundRight) + }) } diff --git a/internal/entity/search/photos_geojson_result.go b/internal/entity/search/photos_geojson_result.go index 46fe4b76a..0d6ca7dc0 100644 --- a/internal/entity/search/photos_geojson_result.go +++ b/internal/entity/search/photos_geojson_result.go @@ -11,26 +11,28 @@ import ( // GeoResult represents a photo geo search result. type GeoResult struct { - ID string `json:"-" select:"photos.id"` - PhotoUID string `json:"UID" select:"photos.photo_uid"` - PhotoType string `json:"Type,omitempty" select:"photos.photo_type"` - PhotoTitle string `json:"Title" select:"photos.photo_title"` - PhotoCaption string `json:"Caption,omitempty" select:"photos.photo_caption"` - PhotoLat float64 `json:"Lat" select:"photos.photo_lat"` - PhotoLng float64 `json:"Lng" select:"photos.photo_lng"` - TakenAt time.Time `json:"TakenAt" select:"photos.taken_at"` - TakenAtLocal time.Time `json:"TakenAtLocal" select:"photos.taken_at_local"` - TimeZone string `json:"TimeZone" select:"photos.time_zone"` - PhotoFavorite bool `json:"Favorite,omitempty" select:"photos.photo_favorite"` - PhotoDuration time.Duration `json:"Duration,omitempty" select:"photos.photo_duration"` - FileID uint `json:"-" select:"files.id AS file_id"` // File - FileWidth int `json:"Width" select:"files.file_width"` - FileHeight int `json:"Height" select:"files.file_height"` - FileHash string `json:"Hash" select:"files.file_hash"` - FileCodec string `json:"-" select:"files.file_codec"` - FileMime string `json:"-" select:"files.file_mime"` - FileVideo bool `json:"-" select:"files.file_video"` - MediaType string `json:"-" select:"files.media_type"` + ID string `json:"-" select:"photos.id"` + PhotoUID string `json:"UID" select:"photos.photo_uid"` + PhotoType string `json:"Type,omitempty" select:"photos.photo_type"` + PhotoTitle string `json:"Title" select:"photos.photo_title"` + PhotoCaption string `json:"Caption,omitempty" select:"photos.photo_caption"` + PhotoLat float64 `json:"Lat" select:"photos.photo_lat"` + PhotoLng float64 `json:"Lng" select:"photos.photo_lng"` + TakenAt time.Time `json:"TakenAt" select:"photos.taken_at"` + TakenAtLocal time.Time `json:"TakenAtLocal" select:"photos.taken_at_local"` + TimeZone string `json:"TimeZone" select:"photos.time_zone"` + PhotoFavorite bool `json:"Favorite,omitempty" select:"photos.photo_favorite"` + PhotoPanorama bool `json:"Panorama,omitempty" select:"photos.photo_panorama"` + PhotoDuration time.Duration `json:"Duration,omitempty" select:"photos.photo_duration"` + FileID uint `json:"-" select:"files.id AS file_id"` // File + FileWidth int `json:"Width" select:"files.file_width"` + FileHeight int `json:"Height" select:"files.file_height"` + FileHash string `json:"Hash" select:"files.file_hash"` + FileProjection string `json:"Projection,omitempty" select:"files.file_projection"` + FileCodec string `json:"-" select:"files.file_codec"` + FileMime string `json:"-" select:"files.file_mime"` + FileVideo bool `json:"-" select:"files.file_video"` + MediaType string `json:"-" select:"files.media_type"` } // Lat returns the position latitude. diff --git a/internal/entity/search/photos_results.go b/internal/entity/search/photos_results.go index 55413e5fe..361b94b03 100644 --- a/internal/entity/search/photos_results.go +++ b/internal/entity/search/photos_results.go @@ -94,7 +94,7 @@ type Photo struct { FileMime string `json:"-" select:"files.file_mime"` FileSize int64 `json:"-" select:"files.file_size"` FileOrientation int `json:"-" select:"files.file_orientation"` - FileProjection string `json:"-" select:"files.file_projection"` + FileProjection string `json:"Projection,omitempty" select:"files.file_projection"` FileAspectRatio float32 `json:"-" select:"files.file_aspect_ratio"` FileColors string `json:"-" select:"files.file_colors"` FileDiff int `json:"-" select:"files.file_diff"` @@ -260,6 +260,24 @@ func (m *Photo) MediaInfo() (mediaHash, mediaCodec, mediaMime string, width, hei return m.FileHash, "", m.FileMime, m.FileWidth, m.FileHeight } +// MediaProjection returns the projection of the photo's playable media file, +// falling back to the primary file's projection. For videos the primary search +// row is usually a poster JPEG that carries no projection metadata, so the video +// file's projection (which the indexer sets) is used instead — this keeps the +// 360° equirectangular flag accurate in the viewer DTO. +func (m *Photo) MediaProjection() string { + switch m.PhotoType { + case entity.MediaVideo, entity.MediaLive: + for _, f := range m.Files { + if f.FileVideo && f.FileProjection != "" { + return f.FileProjection + } + } + } + + return m.FileProjection +} + // ShareBase returns a deterministic, human friendly file name stem for sharing // downloads generated from the photo's timestamp and title. func (m *Photo) ShareBase(seq int) string { diff --git a/internal/entity/search/photos_results_test.go b/internal/entity/search/photos_results_test.go index 6423e0c92..4225880fc 100644 --- a/internal/entity/search/photos_results_test.go +++ b/internal/entity/search/photos_results_test.go @@ -226,6 +226,36 @@ func TestPhoto_IsPlayable(t *testing.T) { }) } +func TestPhoto_MediaProjection(t *testing.T) { + t.Run("VideoUsesVideoFileProjection", func(t *testing.T) { + r := Photo{ + PhotoType: "video", + FileProjection: "", + Files: []entity.File{ + {FileVideo: true, MediaType: media.Video.String(), FileHash: "v", FileProjection: "equirectangular"}, + }, + } + assert.Equal(t, "equirectangular", r.MediaProjection()) + }) + t.Run("VideoFallsBackToPrimaryProjection", func(t *testing.T) { + r := Photo{ + PhotoType: "video", + FileProjection: "cubemap", + Files: []entity.File{ + {FileVideo: true, MediaType: media.Video.String(), FileHash: "v", FileProjection: ""}, + }, + } + assert.Equal(t, "cubemap", r.MediaProjection()) + }) + t.Run("ImageUsesPrimaryProjection", func(t *testing.T) { + r := Photo{ + PhotoType: "image", + FileProjection: "equirectangular", + } + assert.Equal(t, "equirectangular", r.MediaProjection()) + }) +} + func TestPhoto_MediaInfo(t *testing.T) { t.Run("LiveCodecAVC", func(t *testing.T) { r := Photo{ diff --git a/internal/entity/search/photos_scope.go b/internal/entity/search/photos_scope.go new file mode 100644 index 000000000..d29fc7246 --- /dev/null +++ b/internal/entity/search/photos_scope.go @@ -0,0 +1,202 @@ +package search + +import ( + "github.com/jinzhu/gorm" + + "github.com/photoprism/photoprism/internal/auth/acl" + "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/internal/form" + "github.com/photoprism/photoprism/pkg/clean" +) + +// sessionGrantsPhotos reports whether the session is granted perm on photos. For a client session +// the permission must be granted to both the client role and (when a user is present) the user +// role, since a client acting on behalf of a user is limited by both; an ordinary session is +// evaluated against its user role. A nil session means internal or CLI use, which is not restricted. +func sessionGrantsPhotos(sess *entity.Session, perm acl.Permission) bool { + if sess == nil { + return true + } + + // For client sessions the client role must permit the action as well, so a restricted client + // cannot inherit a privileged user's access. + if sess.IsClient() { + if !acl.Rules.Allow(acl.ResourcePhotos, sess.GetClientRole(), perm) { + return false + } else if sess.NoUser() { + return true + } + } + + return acl.Rules.Allow(acl.ResourcePhotos, sess.GetUserRole(), perm) +} + +// sessionGrantsAnyPhotos reports whether the session is granted at least one of the perms on photos, +// using the same client and user role intersection as sessionGrantsPhotos. +func sessionGrantsAnyPhotos(sess *entity.Session, perms acl.Permissions) bool { + for i := range perms { + if sessionGrantsPhotos(sess, perms[i]) { + return true + } + } + + return false +} + +// PhotoSessionSeesEverything reports whether a session may access every picture, including +// private and archived ones, so that no row scoping is required. It performs no database +// query, so full-access users (admins, regular users, full-access API clients) incur no cost. +func PhotoSessionSeesEverything(sess *entity.Session) bool { + return sessionGrantsPhotos(sess, acl.AccessPrivate) && + sessionGrantsPhotos(sess, acl.ActionDelete) && + sessionGrantsAnyPhotos(sess, acl.Permissions{acl.AccessAll, acl.AccessLibrary}) +} + +// ScopePhotosForSession restricts a photos query to the shared content a session may access: +// shared albums, owned pictures, published links, and the user's base path. Sessions with full +// library or admin access, as well as nil sessions, are returned unchanged. This builds the same +// predicate searchPhotos applies, so single-item access and search stay aligned. +func ScopePhotosForSession(stmt *gorm.DB, sess *entity.Session) *gorm.DB { + // Library and admin access (or no session) requires no shared-scope limitation. For client + // sessions this considers the client role too, so a restricted client cannot inherit a + // privileged user's whole-library scope. + if sess == nil || sessionGrantsAnyPhotos(sess, acl.Permissions{acl.AccessAll, acl.AccessLibrary}) { + return stmt + } + + user := sess.GetUser() + sharedAlbums := "photos.photo_uid IN (SELECT photo_uid FROM photos_albums WHERE hidden = 0 AND missing = 0 AND album_uid IN (?)) OR " + + if sess.IsVisitor() || sess.NotRegistered() { + return stmt.Where(sharedAlbums+"photos.published_at > ?", sess.SharedUIDs(), entity.Now()) + } else if basePath := user.GetBasePath(); basePath == "" { + return stmt.Where(sharedAlbums+"photos.created_by = ? OR photos.published_at > ?", sess.SharedUIDs(), user.UserUID, entity.Now()) + } else { + return stmt.Where(sharedAlbums+"photos.created_by = ? OR photos.published_at > ? OR photos.photo_path = ? OR photos.photo_path LIKE ?", + sess.SharedUIDs(), user.UserUID, entity.Now(), basePath, basePath+"/%") + } +} + +// ScopeVisiblePhotos restricts a photos or files query to the pictures a session may view: it +// excludes private and archived pictures for roles lacking those permissions and then applies +// ScopePhotosForSession. Full-access sessions are returned unchanged. Callers must ensure the +// photos table is part of the query so the photos.* conditions resolve. +func ScopeVisiblePhotos(stmt *gorm.DB, sess *entity.Session) *gorm.DB { + if PhotoSessionSeesEverything(sess) { + return stmt + } + + // Exclude private pictures unless the session may access them (client and user role intersection). + if !sessionGrantsPhotos(sess, acl.AccessPrivate) { + stmt = stmt.Where("photos.photo_private = 0") + } + + // Exclude archived (soft-deleted) pictures unless the session may access them. + if !sessionGrantsPhotos(sess, acl.ActionDelete) { + stmt = stmt.Where("photos.deleted_at IS NULL") + } + + return ScopePhotosForSession(stmt, sess) +} + +// PhotoVisibleToSession reports whether the session may access the photo with the given UID, +// applying the same scope, private, and archived rules as search. +func PhotoVisibleToSession(photoUID string, sess *entity.Session) (bool, error) { + if photoUID == "" { + return false, nil + } else if PhotoSessionSeesEverything(sess) { + return true, nil + } + + // UnscopedDb is deliberate: the archived (soft-deleted) decision is deferred to + // ScopeVisiblePhotos, which adds "photos.deleted_at IS NULL" for roles without the archive + // permission. Full-access roles short-circuited above and may resolve archived pictures by UID, + // matching GetPhoto / searchPhotos. + stmt := ScopeVisiblePhotos(UnscopedDb().Table("photos").Where("photos.photo_uid = ?", photoUID), sess) + + var count int + if err := stmt.Count(&count).Error; err != nil { + return false, err + } else if count > 0 { + return true, nil + } + + // Fall back to smart albums shared with the session (folder, moment, calendar, region), whose + // members derive from a filter rather than photos_albums rows and are thus invisible to + // ScopePhotosForSession above. + return sharedSmartAlbumContains(photoUID, sess) +} + +// FileVisibleToSession reports whether the session may access the file with the given hash, +// based on the visibility of the photo it belongs to. +func FileVisibleToSession(fileHash string, sess *entity.Session) (bool, error) { + if fileHash == "" { + return false, nil + } else if PhotoSessionSeesEverything(sess) { + return true, nil + } + + // A soft-deleted file is never accessible, so exclude it explicitly (UnscopedDb does not apply + // the soft-delete scope). ScopeVisiblePhotos handles the photo's archived/private/scope state. + stmt := ScopeVisiblePhotos( + UnscopedDb().Table("files"). + Joins("JOIN photos ON photos.id = files.photo_id"). + Where("files.file_hash = ? AND files.deleted_at IS NULL", fileHash), + sess, + ) + + var count int + if err := stmt.Count(&count).Error; err != nil { + return false, err + } else if count > 0 { + return true, nil + } + + // Fall back to smart albums shared with the session; the file hash resolves to its photo, so a + // picture shared only through a folder, moment, calendar, or region link stays downloadable. + var f entity.File + if err := UnscopedDb().Table("files").Select("photo_uid"). + Where("file_hash = ? AND deleted_at IS NULL", fileHash). + Limit(1).Scan(&f).Error; err != nil { + return false, err + } + + return sharedSmartAlbumContains(f.PhotoUID, sess) +} + +// sharedSmartAlbumContains reports whether the given photo UID belongs to a smart album shared with +// the session. Smart albums (folder, moment, calendar, region) derive their members from a filter +// rather than photos_albums rows, so ScopePhotosForSession cannot resolve them; this evaluates each +// shared album's filter exactly as the album view does, keeping single-item access aligned with what +// browsing and album downloads already permit. It runs only after the cheaper personal-scope check +// misses and skips regular albums (empty filter, already covered), so full-access and regular-share +// sessions perform no extra queries. +func sharedSmartAlbumContains(photoUID string, sess *entity.Session) (bool, error) { + if photoUID == "" || sess == nil { + return false, nil + } + + for _, albumUID := range sess.SharedUIDs() { + album, err := entity.CachedAlbumByUID(albumUID) + + // Only smart albums (non-empty filter) need the filter-based membership test; regular albums + // are already covered by ScopePhotosForSession's photos_albums predicate. + if err != nil || album.AlbumUID == "" || album.AlbumFilter == "" { + continue + } + + // Reuse the album-scoped search so membership matches browsing; Count 1 limits the query to + // an existence check for the single photo UID. + results, _, searchErr := UserPhotos(form.SearchPhotos{Scope: albumUID, UID: photoUID, Count: 1}, sess) + + if searchErr != nil { + // A single unusable share (e.g. an invalid filter) must not mask the others. + log.Debugf("scope: %s while checking shared album %s", clean.Error(searchErr), clean.Log(albumUID)) + continue + } else if len(results) > 0 { + return true, nil + } + } + + return false, nil +} diff --git a/internal/entity/search/photos_scope_test.go b/internal/entity/search/photos_scope_test.go new file mode 100644 index 000000000..a0a6c720e --- /dev/null +++ b/internal/entity/search/photos_scope_test.go @@ -0,0 +1,315 @@ +package search + +import ( + "testing" + + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/auth/acl" + "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/internal/form" + "github.com/photoprism/photoprism/pkg/authn" +) + +func TestSessionGrantsPhotos(t *testing.T) { + t.Run("NilUnrestricted", func(t *testing.T) { + assert.True(t, sessionGrantsPhotos(nil, acl.AccessPrivate)) + assert.True(t, sessionGrantsPhotos(nil, acl.ActionDelete)) + }) + t.Run("AdminGranted", func(t *testing.T) { + s := scopeSession("alice") + assert.True(t, sessionGrantsPhotos(s, acl.AccessPrivate)) + assert.True(t, sessionGrantsPhotos(s, acl.ActionDelete)) + assert.True(t, sessionGrantsPhotos(s, acl.AccessLibrary)) + }) + t.Run("GuestDeniedPrivate", func(t *testing.T) { + s := scopeSession("guest") + assert.False(t, sessionGrantsPhotos(s, acl.AccessPrivate)) + assert.False(t, sessionGrantsPhotos(s, acl.ActionDelete)) + }) + t.Run("ClientRoleLimitsPrivilegedUser", func(t *testing.T) { + // A restricted client role limits access even when a privileged user is attached, so a + // client cannot inherit a library user's whole-library reach (the client and user roles + // are intersected). + client := &entity.Client{ClientRole: acl.RoleInstance.String(), AuthProvider: authn.ProviderClient.String()} + s := &entity.Session{} + s.SetClient(client) + s.SetUser(entity.UserFixtures.Pointer("alice")) // admin user + assert.True(t, s.IsClient()) + assert.Equal(t, acl.RoleInstance, s.GetClientRole()) + // RoleInstance (GrantSearchShared) lacks AccessPrivate, so the intersection denies it even + // though the admin user alone would grant it. + assert.False(t, sessionGrantsPhotos(s, acl.AccessPrivate)) + assert.False(t, sessionGrantsAnyPhotos(s, acl.Permissions{acl.AccessAll, acl.AccessLibrary})) + }) +} + +func TestSessionGrantsAnyPhotos(t *testing.T) { + t.Run("NilTrue", func(t *testing.T) { + assert.True(t, sessionGrantsAnyPhotos(nil, acl.Permissions{acl.AccessAll, acl.AccessLibrary})) + }) + t.Run("AdminLibrary", func(t *testing.T) { + assert.True(t, sessionGrantsAnyPhotos(scopeSession("alice"), acl.Permissions{acl.AccessAll, acl.AccessLibrary})) + }) + t.Run("GuestNoLibrary", func(t *testing.T) { + assert.False(t, sessionGrantsAnyPhotos(scopeSession("guest"), acl.Permissions{acl.AccessAll, acl.AccessLibrary})) + }) +} + +// Fixture identifiers used by the scope tests. In the public repo only the admin, +// guest, and visitor roles are available, so these tests cover the admin (full access) +// and guest (shared-only) paths; viewer/user behavior is validated in the +// edition-specific repositories. +const ( + scopeNormalPhotoUID = "ps6sg6be2lvl0yh7" // not private, not archived + scopePrivatePhotoUID = "ps6sg6be2lvl0y13" // "Photo06", private + scopeNormalFileHash = "2cad9168fa6acc5c5c2965ddf6ec465ca42fd818" // file of a non-private photo + scopePrivateFileHash = "pcad9a68fa6acc5c5ba965adf6ec465ca42fd917" // "Photo06.png", private photo + + // scopeFolderPhotoUID and scopeFolderFileHash belong to the "april-1990" folder (smart) album, + // whose members derive from a path filter rather than photos_albums rows. + scopeFolderPhotoUID = "ps6sg6be2lvl0yh0" // "Photo03", public, path 1990/04 + scopeFolderFileHash = "pcad9168fa6acc5c5c2965adf6ec465ca42fd818" // primary file of "Photo03" + + // scopeRegularPhotoUID is a non-private member of the regular album shared by scopeRegularShareToken; + // it is resolved by the personal-scope predicate without the smart-album fallback. + scopeRegularPhotoUID = "ps6sg6be2lvl0y21" // photos_albums member of "christmas-2030" + + // Share-link tokens resolve to shared albums; a visitor session derives its shares from them. + //nolint:gosec // G101: deterministic fixture share-link tokens for tests only. + scopeFolderShareToken = "8jxf3jfn2k" // link to "april-1990" folder album (contains 1990/04) + //nolint:gosec // G101: deterministic fixture share-link tokens for tests only. + scopeStateShareToken = "9jxf3jfn2k" // link to "california-usa" state album (excludes 1990/04) + //nolint:gosec // G101: deterministic fixture share-link tokens for tests only. + scopeRegularShareToken = "4jxf3jfn2k" // link to "christmas-2030" regular album (no filter) +) + +// scopeSession builds an in-memory session for the named user fixture. +func scopeSession(name string) *entity.Session { + s := &entity.Session{} + s.SetUser(entity.UserFixtures.Pointer(name)) + return s +} + +// scopeVisitorWithShares builds an unregistered visitor session that has redeemed the given share +// link tokens, so its SharedUIDs resolve from the matching links exactly as in production. +func scopeVisitorWithShares(tokens ...string) *entity.Session { + s := &entity.Session{} + s.SetData(&entity.SessionData{Tokens: tokens}) + return s +} + +func TestPhotoSessionSeesEverything(t *testing.T) { + t.Run("NilSession", func(t *testing.T) { + assert.True(t, PhotoSessionSeesEverything(nil)) + }) + t.Run("Admin", func(t *testing.T) { + assert.True(t, PhotoSessionSeesEverything(scopeSession("alice"))) + }) + t.Run("Guest", func(t *testing.T) { + assert.False(t, PhotoSessionSeesEverything(scopeSession("guest"))) + }) +} + +func TestScopePhotosForSession(t *testing.T) { + t.Run("NilUnchanged", func(t *testing.T) { + base := UnscopedDb().Table("photos") + assert.Same(t, base, ScopePhotosForSession(base, nil)) + }) + t.Run("AdminUnchanged", func(t *testing.T) { + base := UnscopedDb().Table("photos") + assert.Same(t, base, ScopePhotosForSession(base, scopeSession("alice"))) + }) + t.Run("GuestScoped", func(t *testing.T) { + base := UnscopedDb().Table("photos") + scoped := ScopePhotosForSession(base, scopeSession("guest")) + assert.NotSame(t, base, scoped) + var count int + assert.NoError(t, scoped.Count(&count).Error) + }) +} + +func TestScopeVisiblePhotos(t *testing.T) { + t.Run("AdminSeesPrivate", func(t *testing.T) { + var count int + err := ScopeVisiblePhotos(UnscopedDb().Table("photos").Where("photos.photo_uid = ?", scopePrivatePhotoUID), scopeSession("alice")).Count(&count).Error + assert.NoError(t, err) + assert.Equal(t, 1, count) + }) + t.Run("GuestDeniedPrivate", func(t *testing.T) { + var count int + err := ScopeVisiblePhotos(UnscopedDb().Table("photos").Where("photos.photo_uid = ?", scopePrivatePhotoUID), scopeSession("guest")).Count(&count).Error + assert.NoError(t, err) + assert.Equal(t, 0, count) + }) +} + +func TestPhotoVisibleToSession(t *testing.T) { + t.Run("EmptyUID", func(t *testing.T) { + ok, err := PhotoVisibleToSession("", scopeSession("guest")) + assert.NoError(t, err) + assert.False(t, ok) + }) + t.Run("NilSession", func(t *testing.T) { + ok, err := PhotoVisibleToSession(scopePrivatePhotoUID, nil) + assert.NoError(t, err) + assert.True(t, ok) + }) + t.Run("AdminPrivate", func(t *testing.T) { + ok, err := PhotoVisibleToSession(scopePrivatePhotoUID, scopeSession("alice")) + assert.NoError(t, err) + assert.True(t, ok) + }) + t.Run("GuestDeniedPrivate", func(t *testing.T) { + ok, err := PhotoVisibleToSession(scopePrivatePhotoUID, scopeSession("guest")) + assert.NoError(t, err) + assert.False(t, ok) + }) + t.Run("GuestDeniedUnshared", func(t *testing.T) { + ok, err := PhotoVisibleToSession(scopeNormalPhotoUID, scopeSession("guest")) + assert.NoError(t, err) + assert.False(t, ok) + }) + t.Run("VisitorSharedFolderAlbum", func(t *testing.T) { + // A picture shared only through a folder (smart) album has no photos_albums row, so it is + // visible only via the shared-album fallback. + ok, err := PhotoVisibleToSession(scopeFolderPhotoUID, scopeVisitorWithShares(scopeFolderShareToken)) + assert.NoError(t, err) + assert.True(t, ok) + }) + t.Run("VisitorWrongSmartAlbum", func(t *testing.T) { + // Sharing a different smart album must not expose the folder picture. + ok, err := PhotoVisibleToSession(scopeFolderPhotoUID, scopeVisitorWithShares(scopeStateShareToken)) + assert.NoError(t, err) + assert.False(t, ok) + }) + t.Run("VisitorNoShares", func(t *testing.T) { + ok, err := PhotoVisibleToSession(scopeFolderPhotoUID, scopeVisitorWithShares()) + assert.NoError(t, err) + assert.False(t, ok) + }) +} + +// A non-empty Scope skips the personal ScopePhotosForSession filter, so it must be authorized by +// the album ownership/share gate in searchPhotos: a restricted session may scope only to an album +// it owns or has shared, never to an arbitrary album. +func TestUserPhotos_ScopeAuthorization(t *testing.T) { + const album = "as6sg6bxpogaaba8" // manual album owned by admin, not shared with guests + + t.Run("GuestNonSharedScopeForbidden", func(t *testing.T) { + _, _, err := UserPhotos(form.SearchPhotos{Scope: album}, scopeSession("guest")) + assert.Equal(t, ErrForbidden, err) + }) + t.Run("VisitorSharedScopeAllowed", func(t *testing.T) { + // Unregistered visitor whose session carries a share for the scoped album. + visitor := &entity.Session{} + visitor.SetData(&entity.SessionData{Shares: entity.UIDs{album}}) + _, _, err := UserPhotos(form.SearchPhotos{Scope: album}, visitor) + assert.NoError(t, err) + }) + t.Run("AdminScopeAllowed", func(t *testing.T) { + _, _, err := UserPhotos(form.SearchPhotos{Scope: album}, scopeSession("alice")) + assert.NoError(t, err) + }) +} + +func TestFileVisibleToSession(t *testing.T) { + t.Run("EmptyHash", func(t *testing.T) { + ok, err := FileVisibleToSession("", scopeSession("guest")) + assert.NoError(t, err) + assert.False(t, ok) + }) + t.Run("NilSession", func(t *testing.T) { + ok, err := FileVisibleToSession(scopeNormalFileHash, nil) + assert.NoError(t, err) + assert.True(t, ok) + }) + t.Run("AdminPrivateFile", func(t *testing.T) { + ok, err := FileVisibleToSession(scopePrivateFileHash, scopeSession("alice")) + assert.NoError(t, err) + assert.True(t, ok) + }) + t.Run("GuestDeniedPrivateFile", func(t *testing.T) { + ok, err := FileVisibleToSession(scopePrivateFileHash, scopeSession("guest")) + assert.NoError(t, err) + assert.False(t, ok) + }) + t.Run("VisitorSharedFolderAlbumFile", func(t *testing.T) { + // The file hash resolves to a picture shared only through a folder (smart) album. + ok, err := FileVisibleToSession(scopeFolderFileHash, scopeVisitorWithShares(scopeFolderShareToken)) + assert.NoError(t, err) + assert.True(t, ok) + }) + t.Run("VisitorWrongSmartAlbumFile", func(t *testing.T) { + ok, err := FileVisibleToSession(scopeFolderFileHash, scopeVisitorWithShares(scopeStateShareToken)) + assert.NoError(t, err) + assert.False(t, ok) + }) +} + +func TestSharedSmartAlbumContains(t *testing.T) { + t.Run("EmptyID", func(t *testing.T) { + ok, err := sharedSmartAlbumContains("", scopeVisitorWithShares(scopeFolderShareToken)) + assert.NoError(t, err) + assert.False(t, ok) + }) + t.Run("NilSession", func(t *testing.T) { + ok, err := sharedSmartAlbumContains(scopeFolderPhotoUID, nil) + assert.NoError(t, err) + assert.False(t, ok) + }) + t.Run("NoShares", func(t *testing.T) { + ok, err := sharedSmartAlbumContains(scopeFolderPhotoUID, scopeVisitorWithShares()) + assert.NoError(t, err) + assert.False(t, ok) + }) + t.Run("PhotoUIDInSharedFolder", func(t *testing.T) { + ok, err := sharedSmartAlbumContains(scopeFolderPhotoUID, scopeVisitorWithShares(scopeFolderShareToken)) + assert.NoError(t, err) + assert.True(t, ok) + }) + t.Run("WrongSmartAlbum", func(t *testing.T) { + ok, err := sharedSmartAlbumContains(scopeFolderPhotoUID, scopeVisitorWithShares(scopeStateShareToken)) + assert.NoError(t, err) + assert.False(t, ok) + }) + t.Run("RegularAlbumSkipped", func(t *testing.T) { + // A shared regular album (empty filter) is skipped here because ScopePhotosForSession already + // covers its photos_albums membership, so the fallback reports no match. + ok, err := sharedSmartAlbumContains(scopeFolderPhotoUID, scopeVisitorWithShares(scopeRegularShareToken)) + assert.NoError(t, err) + assert.False(t, ok) + }) +} + +// BenchmarkPhotoVisibleToSession measures the per-call cost of the single-item visibility check on +// the paths a restricted session hits when the lightbox prefetches photo metadata: the privileged +// short-circuit, the personal-scope hit (regular share), and the smart-album fallback (folder share) +// including the worst case where the fallback searches a shared album and finds no match. +func BenchmarkPhotoVisibleToSession(b *testing.B) { + admin := scopeSession("alice") + folderVisitor := scopeVisitorWithShares(scopeFolderShareToken) + regularVisitor := scopeVisitorWithShares(scopeRegularShareToken) + stateVisitor := scopeVisitorWithShares(scopeStateShareToken) + + b.Run("AdminShortCircuit", func(b *testing.B) { + for i := 0; i < b.N; i++ { + _, _ = PhotoVisibleToSession(scopeFolderPhotoUID, admin) + } + }) + b.Run("RegularSharePersonalScopeHit", func(b *testing.B) { + for i := 0; i < b.N; i++ { + _, _ = PhotoVisibleToSession(scopeRegularPhotoUID, regularVisitor) + } + }) + b.Run("FolderShareSmartAlbumFallback", func(b *testing.B) { + for i := 0; i < b.N; i++ { + _, _ = PhotoVisibleToSession(scopeFolderPhotoUID, folderVisitor) + } + }) + b.Run("OutOfScopeFallbackMiss", func(b *testing.B) { + for i := 0; i < b.N; i++ { + _, _ = PhotoVisibleToSession(scopeFolderPhotoUID, stateVisitor) + } + }) +} diff --git a/internal/entity/search/photos_test.go b/internal/entity/search/photos_test.go index d3a079edb..656be1363 100644 --- a/internal/entity/search/photos_test.go +++ b/internal/entity/search/photos_test.go @@ -2433,4 +2433,30 @@ func TestPhotos(t *testing.T) { assert.NotEmpty(t, p.PhotoName) } }) + t.Run("QueryMatchesHomophoneLabel", func(t *testing.T) { + _, first, photoA, photoB := createHomophoneSearchFixtures(t) + + var f form.SearchPhotos + + f.Query = first.LabelName + f.Merged = true + + photos, _, err := Photos(f) + + if err != nil { + t.Fatal(err) + } + + foundRight := false + + for _, photo := range photos { + assert.NotEqual(t, photoA.PhotoUID, photo.PhotoUID) + + if photo.PhotoUID == photoB.PhotoUID { + foundRight = true + } + } + + assert.True(t, foundRight) + }) } diff --git a/internal/entity/search/photos_viewer.go b/internal/entity/search/photos_viewer.go index fa20dabca..fd92e38d9 100644 --- a/internal/entity/search/photos_viewer.go +++ b/internal/entity/search/photos_viewer.go @@ -42,6 +42,8 @@ func (m *Photo) ViewerResult(contentUri, apiUri, previewToken, downloadToken str TimeZone: m.TimeZone, Favorite: m.PhotoFavorite, Playable: m.IsPlayable(), + Panorama: m.PhotoPanorama, + Projection: m.MediaProjection(), Duration: m.PhotoDuration, Width: width, Height: height, @@ -83,6 +85,8 @@ func (m GeoResult) ViewerResult(contentUri, apiUri, previewToken, downloadToken TimeZone: m.TimeZone, Favorite: m.PhotoFavorite, Playable: m.IsPlayable(), + Panorama: m.PhotoPanorama, + Projection: m.FileProjection, Duration: m.PhotoDuration, Width: m.FileWidth, Height: m.FileHeight, diff --git a/internal/entity/search/photos_viewer_test.go b/internal/entity/search/photos_viewer_test.go index 1a5362341..c302c77e5 100644 --- a/internal/entity/search/photos_viewer_test.go +++ b/internal/entity/search/photos_viewer_test.go @@ -36,13 +36,14 @@ func TestPhoto_ViewerResult(t *testing.T) { FileHeight: 600, Files: []entity.File{ { - FileVideo: true, - MediaType: entity.MediaVideo, - FileHash: videoHash, - FileCodec: "avc1", - FileMime: header.ContentTypeMp4AvcMain, - FileWidth: 1920, - FileHeight: 1080, + FileVideo: true, + MediaType: entity.MediaVideo, + FileHash: videoHash, + FileCodec: "avc1", + FileMime: header.ContentTypeMp4AvcMain, + FileWidth: 1920, + FileHeight: 1080, + FileProjection: "equirectangular", }, }, } @@ -65,6 +66,7 @@ func TestPhoto_ViewerResult(t *testing.T) { assert.Equal(t, header.ContentTypeMp4AvcMain, result.Mime) assert.Equal(t, 1920, result.Width) assert.Equal(t, 1080, result.Height) + assert.Equal(t, "equirectangular", result.Projection) if assert.NotNil(t, result.Thumbs) { assert.NotNil(t, result.Thumbs.Fit720) } diff --git a/internal/entity/search/search.go b/internal/entity/search/search.go index 93b4e6668..259ca8ec1 100644 --- a/internal/entity/search/search.go +++ b/internal/entity/search/search.go @@ -1,7 +1,7 @@ /* Package search provides search queries to find photos, albums, labels, and subjects. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/entity/search/search_test.go b/internal/entity/search/search_test.go index f667eb0ec..22a14fff2 100644 --- a/internal/entity/search/search_test.go +++ b/internal/entity/search/search_test.go @@ -10,23 +10,24 @@ import ( "github.com/photoprism/photoprism/pkg/fs" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) int { log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) // Remove temporary SQLite files before running the tests. fs.PurgeTestDbFiles(".", false) + // Remove temporary SQLite files after running the tests. + defer fs.PurgeTestDbFiles(".", false) db := entity.InitTestDb( os.Getenv("PHOTOPRISM_TEST_DRIVER"), os.Getenv("PHOTOPRISM_TEST_DSN")) - defer db.Close() - code := m.Run() - - // Remove temporary SQLite files after running the tests. - fs.PurgeTestDbFiles(".", false) - - os.Exit(code) + return m.Run() } diff --git a/internal/entity/search/sessions_test.go b/internal/entity/search/sessions_test.go index 3a497db75..4f026dba3 100644 --- a/internal/entity/search/sessions_test.go +++ b/internal/entity/search/sessions_test.go @@ -13,7 +13,9 @@ import ( func TestSessions(t *testing.T) { expectedUserUid := "uqxetse3cy5eo9z2" expectedUserName := "alice" - expectedSessionId := "fde4d5154d5383370c9f0c21fd51655d54a185a26dc043d1866fc4678e7ecb62" + // First of alice's sessions ordered by ClientName: the "alice_app_password" + // app-password fixture (application provider, default method). + expectedSessionId := "84ced4d6b1b9e5db31d4ad5364d9b7da6b2a0e85372a46df9784852d8ada6e48" t.Run("Default", func(t *testing.T) { if results, err := Sessions(form.SearchSessions{}); err != nil { diff --git a/internal/entity/search/subjects.go b/internal/entity/search/subjects.go index 83f8d5b47..1eb94938c 100644 --- a/internal/entity/search/subjects.go +++ b/internal/entity/search/subjects.go @@ -56,8 +56,9 @@ func Subjects(frm form.SearchSubjects) (results SubjectResults, err error) { } if frm.Query != "" { - for _, where := range LikeAllNames(Cols{"subj_name", "subj_alias"}, frm.Query) { - s = s.Where("?", gorm.Expr(where)) + wheres, values := LikeAllNames(Cols{"subj_name", "subj_alias"}, frm.Query) + for i, where := range wheres { + s = s.Where("?", gorm.Expr(where, values[i]...)) } } @@ -121,7 +122,7 @@ func SubjectUIDs(s string) (result []string, names []string, remaining string) { var matches []Matches - wheres := LikeAllNames(Cols{"subj_name", "subj_alias"}, s) + wheres, values := LikeAllNames(Cols{"subj_name", "subj_alias"}, s) if len(wheres) == 0 { return result, names, s @@ -129,11 +130,11 @@ func SubjectUIDs(s string) (result []string, names []string, remaining string) { remaining = s - for _, where := range wheres { + for i, where := range wheres { var subj []string stmt := Db().Model(entity.Subject{}) - stmt = stmt.Where("?", gorm.Expr(where)) + stmt = stmt.Where("?", gorm.Expr(where, values[i]...)) if err := stmt.Scan(&matches).Error; err != nil { log.Errorf("search: %s while finding subjects", err) diff --git a/internal/entity/search/viewer/result.go b/internal/entity/search/viewer/result.go index 238ee7342..3fcd56e47 100644 --- a/internal/entity/search/viewer/result.go +++ b/internal/entity/search/viewer/result.go @@ -18,6 +18,8 @@ type Result struct { TimeZone string `json:"TimeZone,omitempty"` Favorite bool `json:"Favorite"` Playable bool `json:"Playable"` + Panorama bool `json:"Panorama,omitempty"` + Projection string `json:"Projection,omitempty"` Duration time.Duration `json:"Duration,omitempty"` Width int `json:"Width"` Height int `json:"Height"` diff --git a/internal/entity/search/viewer/viewer.go b/internal/entity/search/viewer/viewer.go index 834786eb5..be99d906a 100644 --- a/internal/entity/search/viewer/viewer.go +++ b/internal/entity/search/viewer/viewer.go @@ -1,7 +1,7 @@ /* Package viewer provides photo viewer data structures and utility functions. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/entity/service.go b/internal/entity/service.go index a760e322c..0d1a1767f 100644 --- a/internal/entity/service.go +++ b/internal/entity/service.go @@ -91,7 +91,7 @@ func (m *Service) LogErr(err error) error { } // Update error message and increase count. - m.AccError = clip.Chars(err.Error(), txt.ClipError) + m.AccError = clip.Bytes(err.Error(), txt.ClipError) m.AccErrors++ // Disable sharing when retry limit is reached. diff --git a/internal/entity/service_test.go b/internal/entity/service_test.go index add440ec1..d2623fe08 100644 --- a/internal/entity/service_test.go +++ b/internal/entity/service_test.go @@ -2,6 +2,7 @@ package entity import ( "testing" + "time" "github.com/stretchr/testify/assert" @@ -258,7 +259,11 @@ func TestService_Save(t *testing.T) { t.Fatal(err) } afterDate := model.UpdatedAt - assert.True(t, afterDate.After(initialDate)) + // Timestamps are stored with second precision, so a save within the same + // second leaves UpdatedAt unchanged; assert it stays within a sane window. + elapsed := afterDate.Sub(initialDate) + assert.GreaterOrEqual(t, elapsed, time.Duration(0)) + assert.Less(t, elapsed, time.Minute) }) } diff --git a/internal/entity/sortby/random.go b/internal/entity/sortby/random.go index 3a79a7b98..c38d4dc51 100644 --- a/internal/entity/sortby/random.go +++ b/internal/entity/sortby/random.go @@ -4,21 +4,18 @@ import ( "github.com/jinzhu/gorm" _ "github.com/jinzhu/gorm/dialects/mysql" _ "github.com/jinzhu/gorm/dialects/sqlite" -) -const ( - MySQL = "mysql" - SQLite3 = "sqlite3" + "github.com/photoprism/photoprism/pkg/dsn" ) // RandomExpr returns the name of the random function depending on the SQL dialect. func RandomExpr(dialect gorm.Dialect) *gorm.SqlExpr { switch dialect.GetName() { - case MySQL: + case dsn.DriverMySQL: // A seed integer can be passed as an argument, e.g. "RAND(2342)", to generate // reproducible pseudo-random values, see https://mariadb.com/kb/en/rand/. return gorm.Expr("RAND()") - case SQLite3: + case dsn.DriverSQLite3: // SQLite does not support specifying a seed to generate a deterministic sequence // of pseudo-random values, see https://www.sqlite.org/lang_corefunc.html#random. return gorm.Expr("RANDOM()") diff --git a/internal/entity/sortby/random_test.go b/internal/entity/sortby/random_test.go index 4f7f91f02..dbf3bc9a6 100644 --- a/internal/entity/sortby/random_test.go +++ b/internal/entity/sortby/random_test.go @@ -6,11 +6,13 @@ import ( "github.com/jinzhu/gorm" "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/pkg/dsn" ) func TestRandomExpr(t *testing.T) { - mysql, _ := gorm.GetDialect(MySQL) - sqlite3, _ := gorm.GetDialect(SQLite3) + mysql, _ := gorm.GetDialect(dsn.DriverMySQL) + sqlite3, _ := gorm.GetDialect(dsn.DriverSQLite3) assert.Equal(t, gorm.Expr("RAND()"), RandomExpr(mysql)) assert.Equal(t, gorm.Expr("RANDOM()"), RandomExpr(sqlite3)) diff --git a/internal/entity/sortby/sortby.go b/internal/entity/sortby/sortby.go index 227b2c2d2..7dd4460f5 100644 --- a/internal/entity/sortby/sortby.go +++ b/internal/entity/sortby/sortby.go @@ -1,7 +1,7 @@ /* Package sortby provides sort order constants and helper functions. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/entity/string.go b/internal/entity/string.go deleted file mode 100644 index e14e91b6b..000000000 --- a/internal/entity/string.go +++ /dev/null @@ -1,53 +0,0 @@ -package entity - -import ( - "strings" -) - -const ( - ClipStringType = 64 -) - -// ToASCII removes all non-ASCII runes from the string. -func ToASCII(s string) string { - result := make([]rune, 0, len(s)) - - for _, r := range s { - if r <= 127 { - result = append(result, r) - } - } - - return string(result) -} - -// Clip trims leading/trailing whitespace and shortens the string to maxLen characters. -func Clip(s string, maxLen int) string { - s = strings.TrimSpace(s) - l := len(s) - - if l <= maxLen { - return s - } else { - return s[:maxLen] - } -} - -// SanitizeStringType normalizes identifier-like strings by stripping non-ASCII runes and clipping to 32 characters. -func SanitizeStringType(s string) string { - return Clip(ToASCII(s), ClipStringType) -} - -// SanitizeStringTypeLower lowercases the string before applying SanitizeStringType. -func SanitizeStringTypeLower(s string) string { - return SanitizeStringType(strings.ToLower(s)) -} - -// TypeString returns an entity type string for logging, defaulting to "unknown". -func TypeString(entityType string) string { - if entityType == "" { - return "unknown" - } - - return entityType -} diff --git a/internal/entity/subject.go b/internal/entity/subject.go index 0ab752299..176c20568 100644 --- a/internal/entity/subject.go +++ b/internal/entity/subject.go @@ -11,6 +11,7 @@ import ( "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/internal/form" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/rnd" "github.com/photoprism/photoprism/pkg/txt" ) @@ -176,10 +177,10 @@ func (m *Subject) Restore() error { log.Infof("subject: restoring %s %s", TypeString(m.SubjType), clean.Log(m.SubjName)) - event.EntitiesCreated("subjects", []*Subject{m}) + event.EntitiesCreated("subjects", []string{m.SubjUID}) if m.IsPerson() { - event.EntitiesCreated("people", []*Person{m.Person()}) + event.EntitiesCreated("people", []string{m.SubjUID}) event.Publish("count.people", event.Data{ "count": 1, }) @@ -214,10 +215,10 @@ func FirstOrCreateSubject(m *Subject) *Subject { } else if err := m.Create(); err == nil { log.Infof("subject: added %s %s", TypeString(m.SubjType), clean.Log(m.SubjName)) - event.EntitiesCreated("subjects", []*Subject{m}) + event.EntitiesCreated("subjects", []string{m.SubjUID}) if m.IsPerson() { - event.EntitiesCreated("people", []*Person{m.Person()}) + event.EntitiesCreated("people", []string{m.SubjUID}) event.Publish("count.people", event.Data{ "count": 1, }) @@ -396,10 +397,10 @@ func (m *Subject) SaveForm(frm *form.Subject) (changed bool, err error) { } if updateErr := m.Updates(values); updateErr == nil { - event.EntitiesUpdated("subjects", []*Subject{m}) + event.EntitiesUpdated("subjects", []string{m.SubjUID}) if m.IsPerson() { - event.EntitiesUpdated("people", []*Person{m.Person()}) + event.EntitiesUpdated("people", []string{m.SubjUID}) } return true, nil @@ -453,10 +454,10 @@ func (m *Subject) UpdateName(name string) (*Subject, error) { // Log result. log.Infof("subject: renamed %s to %s", TypeString(m.SubjType), clean.Log(m.SubjName)) - event.EntitiesUpdated("subjects", []*Subject{m}) + event.EntitiesUpdated("subjects", []string{m.SubjUID}) if m.IsPerson() { - event.EntitiesUpdated("people", []*Person{m.Person()}) + event.EntitiesUpdated("people", []string{m.SubjUID}) } return m, m.UpdateMarkerNames() @@ -490,7 +491,7 @@ func (m *Subject) RefreshPhotos() error { var err error switch DbDialect() { - case MySQL: + case dsn.DriverMySQL: update := fmt.Sprintf(`UPDATE photos p JOIN files f ON f.photo_id = p.id JOIN %s m ON m.file_uid = f.file_uid SET p.checked_at = NULL WHERE m.subj_uid = ?`, Marker{}.TableName()) err = UnscopedDb().Exec(update, m.SubjUID).Error diff --git a/internal/entity/subject_test.go b/internal/entity/subject_test.go index 4deb9f8e6..7b49a26a8 100644 --- a/internal/entity/subject_test.go +++ b/internal/entity/subject_test.go @@ -7,6 +7,8 @@ import ( "github.com/stretchr/testify/assert" + "github.com/photoprism/photoprism/internal/event" + "github.com/photoprism/photoprism/internal/form" ) @@ -302,11 +304,11 @@ func TestSubject_Updates(t *testing.T) { t.Fatal(err) } - if err := m.Updates(Subject{SubjName: "UpdatedName", SubjType: "UpdatedType"}); err != nil { + if err := m.Updates(Subject{SubjName: "UpdatedName", SubjType: "newtype"}); err != nil { t.Fatal(err) } else { assert.Equal(t, "UpdatedName", m.SubjName) - assert.Equal(t, "UpdatedType", m.SubjType) + assert.Equal(t, "newtype", m.SubjType) } }) @@ -496,6 +498,34 @@ func TestSubject_UpdateName(t *testing.T) { assert.Equal(t, "new-new", s.SubjSlug) } }) + t.Run("PublishesUidOnlyUpdatedEvents", func(t *testing.T) { + m := NewSubject("Uid Only Person", SubjPerson, SrcAuto) + + if err := m.Save(); err != nil { + t.Fatal(err) + } + + sub := event.Subscribe("subjects.updated", "people.updated") + t.Cleanup(func() { event.Unsubscribe(sub) }) + + if _, err := m.UpdateName("Uid Only Renamed"); err != nil { + t.Fatal(err) + } + + // A rename publishes one subjects.updated and one people.updated event, + // both carrying only the subject UID. + for _, expected := range []string{"subjects.updated", "people.updated"} { + select { + case msg := <-sub.Receiver: + assert.Equal(t, expected, msg.Name) + uids, ok := msg.Fields["entities"].([]string) + assert.True(t, ok, "entities payload should be []string, got %T", msg.Fields["entities"]) + assert.Equal(t, []string{m.SubjUID}, uids) + case <-time.After(2 * time.Second): + t.Fatalf("expected one %s event", expected) + } + } + }) t.Run("SubjNameEmpty", func(t *testing.T) { m := NewSubject("Empty", SubjPerson, SrcAuto) diff --git a/internal/event/README.md b/internal/event/README.md index 7edddb0c7..0b5292fed 100644 --- a/internal/event/README.md +++ b/internal/event/README.md @@ -1,6 +1,6 @@ ## PhotoPrism — Event System -**Last Updated:** November 22, 2025 +**Last Updated:** June 23, 2026 ### Overview @@ -15,10 +15,18 @@ event.Publish("photos.updated", event.Data{"ids": []string{"p1", "p2"}}) Publish localized notifications: ```go -event.SuccessMsg(i18n.MsgImportDone) +event.SuccessMsg(i18n.MsgIndexingCompletedIn, elapsed) event.Warn("low disk space") ``` +The `*Msg` helpers (`SuccessMsg`/`ErrorMsg`/`InfoMsg`/`WarnMsg`) publish a structured payload +`Data{"message", "messageId", "messageParams"}`: `message` is the server-rendered string in the +instance locale, `messageId` is the untranslated source string (`i18n.Source(id)`), and +`messageParams` are the substitution values. The Web UI renders the notification from `messageId` + +`messageParams` in each user's current UI language; `message` is a fallback. The plain +`Success`/`Error`/`Info`/`Warn` string forms publish only `message` and are **not** localized — +reserve them for already-translated or non-user-facing text. + Subscribe to topics: ```go sub := event.Subscribe("photos.*") @@ -34,10 +42,10 @@ hook := event.NewHook(event.SharedHub()) log.AddHook(hook) ``` -Entity events: +Entity events (content-channel payloads carry only identity strings — UIDs/slugs — never entity bodies): ```go -event.EntitiesUpdated("photos", updatedPhotos) -event.EntitiesDeleted("files", deletedFiles) +event.EntitiesUpdated("photos", []string{photo.PhotoUID}) +event.EntitiesDeleted("labels", []string{label.LabelUID}) ``` ### Package Layout (Code Map) diff --git a/internal/event/audit.go b/internal/event/audit.go index 41ca59bc5..d03d1802c 100644 --- a/internal/event/audit.go +++ b/internal/event/audit.go @@ -40,6 +40,11 @@ func Audit(level logrus.Level, ev []string, args ...any) { } } +// AuditTrace records an audit entry at trace level. +func AuditTrace(ev []string, args ...any) { + Audit(logrus.TraceLevel, ev, args...) +} + // AuditDebug records an audit entry at debug level. func AuditDebug(ev []string, args ...any) { Audit(logrus.DebugLevel, ev, args...) diff --git a/internal/event/event.go b/internal/event/event.go index e3cf7d5f6..613ffe880 100644 --- a/internal/event/event.go +++ b/internal/event/event.go @@ -1,7 +1,7 @@ /* Package event provides a publish-subscribe event hub and a global logger. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/event/panic.go b/internal/event/panic.go new file mode 100644 index 000000000..118152b19 --- /dev/null +++ b/internal/event/panic.go @@ -0,0 +1,41 @@ +package event + +import "runtime/debug" + +// LogPanic reports a recovered panic value together with the current stack +// trace so that crashes which would otherwise terminate the process without any +// output can be diagnosed. It does not stop the process; the caller decides +// whether to exit. +// +// It deliberately reports through SystemError (the system log) rather than the +// default Log: the default logger is persisted to the database via the event +// hub (the errors and audit_logs tables), so reporting a panic through it could +// trigger a follow-up error or panic when the database is itself the cause of +// the crash or is unavailable. The system log writes to the console only. +func LogPanic(r any) { + if r == nil { + return + } + + // The leading "panic" segment becomes the log prefix, so this reads as + // "panic: <value> › <stack>". + SystemError([]string{"panic", "%v", "%s"}, r, debug.Stack()) +} + +// Recover recovers from a panic in the calling goroutine, if any, and logs it +// with a stack trace via LogPanic. Use it as a deferred call so a crash in a +// background task is reported instead of silently terminating the process: +// defer event.Recover(). +func Recover() { + if r := recover(); r != nil { + LogPanic(r) + } +} + +// Safe runs fn and recovers from any panic it raises, logging it via LogPanic. +// It lets long-running loops continue after a single iteration panics rather +// than taking down the whole process. +func Safe(fn func()) { + defer Recover() + fn() +} diff --git a/internal/event/panic_test.go b/internal/event/panic_test.go new file mode 100644 index 000000000..9f1d05140 --- /dev/null +++ b/internal/event/panic_test.go @@ -0,0 +1,106 @@ +package event + +import ( + "bytes" + "testing" + + "github.com/sirupsen/logrus" + "github.com/stretchr/testify/assert" +) + +// newTestLogger returns a logrus logger writing to buf at error level. +func newTestLogger(buf *bytes.Buffer) *logrus.Logger { + logger := logrus.New() + logger.SetOutput(buf) + logger.SetLevel(logrus.ErrorLevel) + return logger +} + +func TestLogPanic(t *testing.T) { + t.Run("Success", func(t *testing.T) { + var sysBuf, logBuf bytes.Buffer + origSys, origLog := SystemLog, Log + SystemLog = newTestLogger(&sysBuf) + Log = newTestLogger(&logBuf) + t.Cleanup(func() { SystemLog = origSys; Log = origLog }) + + LogPanic("boom") + + out := sysBuf.String() + assert.Contains(t, out, "panic") + assert.Contains(t, out, "boom") + assert.Contains(t, out, "goroutine") + // Must not be routed through the default, database-persisted logger. + assert.Empty(t, logBuf.String()) + }) + t.Run("Nil", func(t *testing.T) { + var buf bytes.Buffer + orig := SystemLog + SystemLog = newTestLogger(&buf) + t.Cleanup(func() { SystemLog = orig }) + + LogPanic(nil) + + assert.Empty(t, buf.String()) + }) + t.Run("NoLogger", func(t *testing.T) { + orig := SystemLog + SystemLog = nil + t.Cleanup(func() { SystemLog = orig }) + + assert.NotPanics(t, func() { LogPanic("boom") }) + }) +} + +func TestRecover(t *testing.T) { + t.Run("Panic", func(t *testing.T) { + var buf bytes.Buffer + orig := SystemLog + SystemLog = newTestLogger(&buf) + t.Cleanup(func() { SystemLog = orig }) + + func() { + defer Recover() + panic("kaboom") + }() + + out := buf.String() + assert.Contains(t, out, "panic") + assert.Contains(t, out, "kaboom") + assert.Contains(t, out, "goroutine") + }) + t.Run("NoPanic", func(t *testing.T) { + var buf bytes.Buffer + orig := SystemLog + SystemLog = newTestLogger(&buf) + t.Cleanup(func() { SystemLog = orig }) + + func() { defer Recover() }() + + assert.Empty(t, buf.String()) + }) +} + +func TestSafe(t *testing.T) { + t.Run("RecoversAndContinues", func(t *testing.T) { + var buf bytes.Buffer + orig := SystemLog + SystemLog = newTestLogger(&buf) + t.Cleanup(func() { SystemLog = orig }) + + ran := 0 + assert.NotPanics(t, func() { + Safe(func() { panic("boom") }) + Safe(func() { ran++ }) + }) + + assert.Equal(t, 1, ran) + assert.Contains(t, buf.String(), "panic") + assert.Contains(t, buf.String(), "boom") + }) + t.Run("Success", func(t *testing.T) { + called := false + Safe(func() { called = true }) + assert.True(t, called) + }) +} diff --git a/internal/event/publish.go b/internal/event/publish.go index 13980b2f0..40e18343e 100644 --- a/internal/event/publish.go +++ b/internal/event/publish.go @@ -3,6 +3,8 @@ package event import ( "strings" + "github.com/sirupsen/logrus" + "github.com/photoprism/photoprism/pkg/i18n" ) @@ -38,22 +40,30 @@ func Warn(msg string) { Publish("notify.warning", Data{"message": msg}) } +// publishMsg logs and publishes a localized notification, carrying the rendered message plus the +// untranslated source id and params so the frontend can render it in the user's current UI language. +func publishMsg(level logrus.Level, topic string, id i18n.Message, params ...any) { + msg := i18n.Msg(id, params...) + Log.Log(level, strings.ToLower(msg)) + Publish(topic, Data{"message": msg, "messageId": i18n.Source(id), "messageParams": params}) +} + // ErrorMsg publishes a localized error notification. func ErrorMsg(id i18n.Message, params ...any) { - Error(i18n.Msg(id, params...)) + publishMsg(logrus.ErrorLevel, "notify.error", id, params...) } // SuccessMsg publishes a localized success notification. func SuccessMsg(id i18n.Message, params ...any) { - Success(i18n.Msg(id, params...)) + publishMsg(logrus.InfoLevel, "notify.success", id, params...) } // InfoMsg publishes a localized informational notification. func InfoMsg(id i18n.Message, params ...any) { - Info(i18n.Msg(id, params...)) + publishMsg(logrus.InfoLevel, "notify.info", id, params...) } // WarnMsg publishes a localized warning notification. func WarnMsg(id i18n.Message, params ...any) { - Warn(i18n.Msg(id, params...)) + publishMsg(logrus.WarnLevel, "notify.warning", id, params...) } diff --git a/internal/event/publish_entities.go b/internal/event/publish_entities.go index 490e6361d..2f0bcd845 100644 --- a/internal/event/publish_entities.go +++ b/internal/event/publish_entities.go @@ -45,7 +45,10 @@ func PublishUserEntities(channel, ev string, entities any, userUid string) { }) } -// EntitiesUpdated publishes an update notification for the given channel. +// EntitiesUpdated publishes an update notification for the given channel, +// with the affected entity UIDs as the payload. Receivers refetch entity +// details through the REST API, so batch mutations emit one event with +// the full UID list instead of one event per entity. func EntitiesUpdated(channel string, entities any) { PublishEntities(channel, EntityUpdated, entities) } diff --git a/internal/event/publish_entities_test.go b/internal/event/publish_entities_test.go index 58c73cfd2..9016d10e9 100644 --- a/internal/event/publish_entities_test.go +++ b/internal/event/publish_entities_test.go @@ -81,3 +81,18 @@ func TestEntitiesRestored(t *testing.T) { Unsubscribe(s) } + +func TestEntitiesUpdatedUIDs(t *testing.T) { + s := Subscribe("test.updated") + + assert.IsType(t, hub.Subscription{}, s) + + entities := []string{"a", "b"} + EntitiesUpdated("test", entities) + msg := <-s.Receiver + + assert.Equal(t, "test.updated", msg.Name) + assert.Equal(t, Data{"entities": []string{"a", "b"}}, msg.Fields) + + Unsubscribe(s) +} diff --git a/internal/event/publish_test.go b/internal/event/publish_test.go new file mode 100644 index 000000000..fe2eba07d --- /dev/null +++ b/internal/event/publish_test.go @@ -0,0 +1,63 @@ +package event + +import ( + "testing" + + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/pkg/i18n" +) + +func TestSuccessMsg(t *testing.T) { + t.Run("WithParams", func(t *testing.T) { + s := Subscribe("notify.success") + SuccessMsg(i18n.MsgAlbumDeleted, "Holiday") + msg := <-s.Receiver + assert.Equal(t, "notify.success", msg.Name) + assert.Equal(t, "Album Holiday deleted", msg.Fields["message"]) + assert.Equal(t, "Album %s deleted", msg.Fields["messageId"]) + assert.Equal(t, []any{"Holiday"}, msg.Fields["messageParams"]) + Unsubscribe(s) + }) + t.Run("WithoutParams", func(t *testing.T) { + s := Subscribe("notify.success") + SuccessMsg(i18n.MsgAlbumCreated) + msg := <-s.Receiver + assert.Equal(t, "notify.success", msg.Name) + assert.Equal(t, "Album created", msg.Fields["message"]) + assert.Equal(t, "Album created", msg.Fields["messageId"]) + Unsubscribe(s) + }) +} + +func TestErrorMsg(t *testing.T) { + s := Subscribe("notify.error") + ErrorMsg(i18n.ErrAlreadyExists, "A cat") + msg := <-s.Receiver + assert.Equal(t, "notify.error", msg.Name) + assert.Equal(t, "A cat already exists", msg.Fields["message"]) + assert.Equal(t, "%s already exists", msg.Fields["messageId"]) + assert.Equal(t, []any{"A cat"}, msg.Fields["messageParams"]) + Unsubscribe(s) +} + +func TestInfoMsg(t *testing.T) { + s := Subscribe("notify.info") + InfoMsg(i18n.MsgIndexingFiles, "/photos") + msg := <-s.Receiver + assert.Equal(t, "notify.info", msg.Name) + assert.Equal(t, "Indexing files in /photos", msg.Fields["message"]) + assert.Equal(t, "Indexing files in %s", msg.Fields["messageId"]) + assert.Equal(t, []any{"/photos"}, msg.Fields["messageParams"]) + Unsubscribe(s) +} + +func TestWarnMsg(t *testing.T) { + s := Subscribe("notify.warning") + WarnMsg(i18n.ErrBusy) + msg := <-s.Receiver + assert.Equal(t, "notify.warning", msg.Name) + assert.Equal(t, "Busy, please try again later", msg.Fields["message"]) + assert.Equal(t, "Busy, please try again later", msg.Fields["messageId"]) + Unsubscribe(s) +} diff --git a/internal/event/system.go b/internal/event/system.go index e4c70f8b5..c54d3244b 100644 --- a/internal/event/system.go +++ b/internal/event/system.go @@ -9,19 +9,35 @@ import ( // SystemLog optionally records internal system events (background jobs, maintenance tasks). var SystemLog Logger -// SystemPrefix prefixes messages sent to SystemLog. +// SystemPrefix prefixes single-segment messages sent to SystemLog. var SystemPrefix = "system: " +// systemPrefixSep separates a multi-segment event's leading category from the +// rest of the message, e.g. the ": " in "config: database › connect". +const systemPrefixSep = ": " + // System writes a system-level log entry and publishes it to the hub. +// +// With more than one segment, the first segment becomes the log prefix +// (e.g. "config: database › connect"); a single segment keeps the generic +// SystemPrefix ("system: something happened"). The leading segment is treated +// as a plain category label and must not contain format verbs, since args are +// applied to the remaining segments. func System(level logrus.Level, ev []string, args ...any) { if len(ev) == 0 { return } + // Render the complete message (all segments joined) for the event hub so + // the frontend log viewer keeps the leading category. message := Format(ev, args...) if SystemLog != nil { - SystemLog.Log(level, SystemPrefix+message) + if len(ev) > 1 { + SystemLog.Log(level, ev[0]+systemPrefixSep+Format(ev[1:], args...)) + } else { + SystemLog.Log(level, SystemPrefix+message) + } } Publish( diff --git a/internal/event/system_test.go b/internal/event/system_test.go index 05bcb0bfb..c10271602 100644 --- a/internal/event/system_test.go +++ b/internal/event/system_test.go @@ -74,8 +74,8 @@ func TestSystemLoggingFunctions(t *testing.T) { SystemLog = logger t.Cleanup(func() { SystemLog = orig }) - events := []string{"cleanup %s", "finished"} - args := []any{"cache"} + events := []string{"config", "database", "register %s"} + args := []any{"failed"} expectedMessage := Format(events, args...) topic := "system.log." + tt.level.String() @@ -103,7 +103,37 @@ func TestSystemLoggingFunctions(t *testing.T) { require.True(t, ok) assert.Equal(t, tt.level, entry.level) require.Len(t, entry.args, 1) - assert.Equal(t, SystemPrefix+expectedMessage, entry.args[0]) + // The first segment becomes the log prefix; args fill the rest. + assert.Equal(t, "config: "+Format(events[1:], args...), entry.args[0]) + }) + } +} + +func TestSystemLogPrefix(t *testing.T) { + tests := []struct { + name string + events []string + args []any + expected string + }{ + {name: "SingleSegment", events: []string{"something happened"}, expected: SystemPrefix + "something happened"}, + {name: "MultipleSegments", events: []string{"config", "database", "connect"}, expected: "config: database › connect"}, + {name: "MultipleSegmentsWithArgs", events: []string{"config", "database", "register", "%s"}, args: []any{"boom"}, expected: "config: database › register › boom"}, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + logger := newSystemTestLogger() + orig := SystemLog + SystemLog = logger + t.Cleanup(func() { SystemLog = orig }) + + SystemInfo(tt.events, tt.args...) + + entry, ok := logger.lastEntry() + require.True(t, ok) + require.Len(t, entry.args, 1) + assert.Equal(t, tt.expected, entry.args[0]) }) } } diff --git a/internal/ffmpeg/README.md b/internal/ffmpeg/README.md index 3fe005a99..ad3a26e65 100644 --- a/internal/ffmpeg/README.md +++ b/internal/ffmpeg/README.md @@ -61,7 +61,8 @@ ### Testing - Run unit tests: `go test ./internal/ffmpeg/...` -- Hardware-specific tests assume the encoder is available; keep runs gated via config when adding new cases. +- By default the transcode tests only assert the generated command strings. To additionally run a real hardware transcode, set `PHOTOPRISM_FFMPEG_TEST_ENCODER` to the encoder under test (e.g. `vaapi`, `intel`, or `nvidia`) on a host with the matching device. The runtime `PHOTOPRISM_FFMPEG_ENCODER` is intentionally ignored so a development-environment value can't trigger hardware runs by accident. +- Hardware-specific tests assume the encoder is available; keep runs gated via this opt-in variable when adding new cases. ### Operational Tips diff --git a/internal/ffmpeg/apple/apple.go b/internal/ffmpeg/apple/apple.go index a6fd966af..42acf03f5 100644 --- a/internal/ffmpeg/apple/apple.go +++ b/internal/ffmpeg/apple/apple.go @@ -2,7 +2,7 @@ Package apple contains helper routines and constants for wiring up Apple VideoToolbox (VT) encoder support in ffmpeg command generation. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -15,7 +15,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/ffmpeg/encode/encode.go b/internal/ffmpeg/encode/encode.go index 9abb2832e..d6996dbbf 100644 --- a/internal/ffmpeg/encode/encode.go +++ b/internal/ffmpeg/encode/encode.go @@ -1,7 +1,7 @@ /* Package encode provides FFmpeg video encoder related types and functions. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/ffmpeg/encode/encoder.go b/internal/ffmpeg/encode/encoder.go index fd8aeefaa..a5b1ca0ce 100644 --- a/internal/ffmpeg/encode/encoder.go +++ b/internal/ffmpeg/encode/encoder.go @@ -20,6 +20,7 @@ const ( VaapiAvc Encoder = "h264_vaapi" // VaapiAvc is the Video Acceleration API H.264 encoder. NvidiaAvc Encoder = "h264_nvenc" // NvidiaAvc is the NVIDIA H.264 encoder. V4LAvc Encoder = "h264_v4l2m2m" // V4LAvc is the Video4Linux H.264 encoder. + VulkanAvc Encoder = "h264_vulkan" // VulkanAvc is the Vulkan video extensions H.264 encoder (requires FFmpeg 8+). ) // AvcEncoders is the list of supported H.264 encoders with aliases. @@ -51,6 +52,9 @@ var AvcEncoders = map[string]Encoder{ "raspberry": V4LAvc, "raspberrypi": V4LAvc, string(V4LAvc): V4LAvc, + "vulkan": VulkanAvc, + "vk": VulkanAvc, + string(VulkanAvc): VulkanAvc, } // FindEncoder finds an FFmpeg encoder by name. diff --git a/internal/ffmpeg/encode/encoder_test.go b/internal/ffmpeg/encode/encoder_test.go index e1458b462..67353c31b 100644 --- a/internal/ffmpeg/encode/encoder_test.go +++ b/internal/ffmpeg/encode/encoder_test.go @@ -13,6 +13,11 @@ func TestFindEncoder(t *testing.T) { t.Run("Apple", func(t *testing.T) { assert.Equal(t, "h264_videotoolbox", FindEncoder("apple").String()) }) + t.Run("Vulkan", func(t *testing.T) { + assert.Equal(t, "h264_vulkan", FindEncoder("vulkan").String()) + assert.Equal(t, "h264_vulkan", FindEncoder("vk").String()) + assert.Equal(t, "h264_vulkan", FindEncoder("h264_vulkan").String()) + }) t.Run("Unsupported", func(t *testing.T) { assert.Equal(t, "libx264", FindEncoder("xxx").String()) }) diff --git a/internal/ffmpeg/encode/options.go b/internal/ffmpeg/encode/options.go index 9f22cbe7e..e19816518 100644 --- a/internal/ffmpeg/encode/options.go +++ b/internal/ffmpeg/encode/options.go @@ -22,7 +22,8 @@ type Options struct { SeekOffset string // See https://trac.ffmpeg.org/wiki/Seeking and https://ffmpeg.org/ffmpeg-utils.html#time-duration-syntax TimeOffset string // See https://trac.ffmpeg.org/wiki/Seeking and https://ffmpeg.org/ffmpeg-utils.html#time-duration-syntax Duration time.Duration // See https://ffmpeg.org/ffmpeg.html#Main-options - MovFlags string + MovFlags string // FFmpeg "-movflags" value for the MP4 muxer (e.g. "use_metadata_tags+faststart"). See https://ffmpeg.org/ffmpeg-formats.html#Options-12 + VideoTag string // FFmpeg "-tag:v" override (e.g. "hvc1" for HEVC in MP4/MOV containers) Title string Description string Comment string diff --git a/internal/ffmpeg/exclude.go b/internal/ffmpeg/exclude.go new file mode 100644 index 000000000..a41c56c29 --- /dev/null +++ b/internal/ffmpeg/exclude.go @@ -0,0 +1,34 @@ +package ffmpeg + +import ( + "sync/atomic" + + "github.com/photoprism/photoprism/pkg/media/video" +) + +// excludePtr atomically holds the active FFmpeg exclude list so updates +// from Config.Propagate do not tear concurrent reads on workers and CLI +// commands. +var excludePtr atomic.Pointer[video.Formats] + +// DefaultExclude is the comma-separated list of container and codec formats +// that should not be processed by FFmpeg by default. +var DefaultExclude string + +func init() { + f := video.NewFormats(video.CodecMagicYUV, video.CodecVFW) + excludePtr.Store(&f) + DefaultExclude = f.String() +} + +// Exclude returns the current FFmpeg exclude list. The returned map must not +// be mutated; publish a new list via SetExclude instead. +func Exclude() video.Formats { + return *excludePtr.Load() +} + +// SetExclude replaces the active FFmpeg exclude list atomically. The caller +// must not mutate f after the call. +func SetExclude(f video.Formats) { + excludePtr.Store(&f) +} diff --git a/internal/ffmpeg/exclude_test.go b/internal/ffmpeg/exclude_test.go new file mode 100644 index 000000000..42547620e --- /dev/null +++ b/internal/ffmpeg/exclude_test.go @@ -0,0 +1,83 @@ +package ffmpeg + +import ( + "sync" + "testing" + + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/pkg/media/video" +) + +func TestDefaultExclude(t *testing.T) { + t.Run("ContainsMagicYUV", func(t *testing.T) { + assert.NotEmpty(t, DefaultExclude) + def := video.NewFormats(DefaultExclude) + assert.True(t, def.Contains(video.CodecMagicYUV)) + assert.True(t, def.Contains(video.CodecVFW)) + assert.True(t, def.Contains("V_MS/VFW/FOURCC")) + }) + t.Run("RoundTrips", func(t *testing.T) { + // DefaultExclude must round-trip through NewFormats.String() so that + // CLI defaults and config-report output stay in sync. + assert.Equal(t, DefaultExclude, video.NewFormats(DefaultExclude).String()) + }) +} + +func TestExclude(t *testing.T) { + // Snapshot and restore the package state so tests don't leak. + saved := Exclude() + t.Cleanup(func() { SetExclude(saved) }) + + t.Run("DefaultBlocksMagicYUV", func(t *testing.T) { + SetExclude(video.NewFormats(DefaultExclude)) + assert.True(t, Exclude().Contains(video.CodecMagicYUV)) + assert.False(t, Exclude().Contains(video.CodecAvc1)) + }) + t.Run("EmptyAllowsEverything", func(t *testing.T) { + SetExclude(video.NewFormats("")) + assert.False(t, Exclude().Contains(video.CodecMagicYUV)) + }) + t.Run("CustomList", func(t *testing.T) { + SetExclude(video.NewFormats("avi, hap")) + assert.True(t, Exclude().Contains("avi")) + assert.True(t, Exclude().Contains("hap")) + assert.False(t, Exclude().Contains(video.CodecMagicYUV)) + }) +} + +func TestExclude_Concurrent(t *testing.T) { + // Hammer Exclude()/SetExclude() from multiple goroutines to verify + // `go test -race` stays clean. Each Store publishes a distinct map. + saved := Exclude() + t.Cleanup(func() { SetExclude(saved) }) + + const writers, readers, iters = 4, 8, 200 + var wg sync.WaitGroup + + for i := 0; i < writers; i++ { + wg.Add(1) + go func(seed int) { + defer wg.Done() + for j := 0; j < iters; j++ { + if seed%2 == j%2 { + SetExclude(video.NewFormats("magicyuv")) + } else { + SetExclude(video.NewFormats("avi, hap")) + } + } + }(i) + } + + for i := 0; i < readers; i++ { + wg.Add(1) + go func() { + defer wg.Done() + for j := 0; j < iters; j++ { + _ = Exclude().Contains("magicyuv", "avi", "hap") + } + }() + } + + wg.Wait() +} diff --git a/internal/ffmpeg/ffmpeg.go b/internal/ffmpeg/ffmpeg.go index b8fdefb70..ddae32363 100644 --- a/internal/ffmpeg/ffmpeg.go +++ b/internal/ffmpeg/ffmpeg.go @@ -1,7 +1,7 @@ /* Package ffmpeg provides FFmpeg video transcoding related types and functions. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/ffmpeg/ffmpeg_test.go b/internal/ffmpeg/ffmpeg_test.go index 080d9976b..94e8701f7 100644 --- a/internal/ffmpeg/ffmpeg_test.go +++ b/internal/ffmpeg/ffmpeg_test.go @@ -2,7 +2,9 @@ package ffmpeg import "os" -// Ensure that vendor-specific HW-accelerated test runs are disabled unless explicitly set. +// Prevents a PHOTOPRISM_FFMPEG_ENCODER value from the development environment from +// accidentally triggering vendor-specific hardware transcoding tests; real hardware +// runs are opted in explicitly via PHOTOPRISM_FFMPEG_TEST_ENCODER instead. func init() { _ = os.Unsetenv("PHOTOPRISM_FFMPEG_ENCODER") } diff --git a/internal/ffmpeg/intel/README.md b/internal/ffmpeg/intel/README.md new file mode 100644 index 000000000..9ad44b8c9 --- /dev/null +++ b/internal/ffmpeg/intel/README.md @@ -0,0 +1,79 @@ +## PhotoPrism — Intel Quick Sync Transcoding + +**Last Updated:** May 30, 2026 + +### Overview + +`internal/ffmpeg/intel` builds the FFmpeg command line that transcodes videos to MPEG-4 AVC (H.264) through Intel Quick Sync Video (QSV). On Linux, QSV runs on top of VA-API but keeps the whole pipeline on the GPU, which avoids the system-memory round trip the [VA-API](../vaapi/README.md) path performs. Use QSV on Intel GPUs that the oneVPL runtime supports (Broadwell / Gen8 and newer); older Intel GPUs must use the VA-API encoder instead. + +The single entry point is `TranscodeToAvcCmd(srcName, destName string, opt encode.Options) *exec.Cmd`. + +### Command Line + +`-hwaccel_device` is added only when `Options.Device` is set; otherwise FFmpeg selects the default device: + +``` +ffmpeg -hide_banner -y -strict -2 \ + -hwaccel qsv [-hwaccel_device <device>] -hwaccel_output_format qsv \ + -i <src> \ + -c:a aac \ + -vf "scale_qsv=w='if(gte(iw,ih), min(<size>, iw), -1)':h='if(gte(iw,ih), -1, min(<size>, ih))':format=nv12" \ + -c:v h264_qsv \ + -map 0:v:0 -map 0:a:0? -ignore_unknown \ + -preset fast -global_quality 25 \ + -f mp4 -movflags use_metadata_tags+faststart -map_metadata 0 \ + <dest> +``` + +#### Pipeline + +1. **Decode** — `-hwaccel qsv -hwaccel_output_format qsv` decodes into QSV surfaces that stay in GPU memory. The input codec must have a QSV decoder; if it does not, FFmpeg fails and the caller falls back to the software encoder. +2. **Filter** — `scale_qsv=…:format=nv12` scales and converts on the GPU, so there is no `hwupload` step (and none of the filter-device requirement the VA-API path has under FFmpeg 8). +3. **Encode** — `h264_qsv` encodes the QSV surfaces directly. + +### Flags + +| Flag | Value | Purpose | +|--------------------------|----------------------------|----------------------------------------------------------------------| +| `-hwaccel` | `qsv` | Quick Sync hardware decode. | +| `-hwaccel_device` | `<device>` (when set) | Selects the render node for decode and encode. | +| `-hwaccel_output_format` | `qsv` | Keeps decoded frames as on-GPU QSV surfaces. | +| `-vf scale_qsv=…` | from `encode.FormatQSV` | On-GPU scale and NV12 conversion (computes the auto axis with `-1`). | +| `-c:v` | `h264_qsv` | Quick Sync H.264 encoder. | +| `-preset` | `fast` | Encoder speed/quality trade-off, via `Options.Preset`. | +| `-global_quality` | `25` (`DefaultQuality` 50) | Quality-based rate-control target, via `Options.GlobalQuality()`. | + +### Encoders & Decoders + +- **Encoders**: `h264_qsv`, `hevc_qsv`, `av1_qsv`, `vp9_qsv`, `mpeg2_qsv`, `mjpeg_qsv`. PhotoPrism uses `h264_qsv`. +- **Decoders**: `h264_qsv`, `hevc_qsv`, `vp9_qsv`, and the other `*_qsv` decoders the runtime exposes. + +### Device Paths + +- DRM render node, conventionally `/dev/dri/renderD128`. +- `Options.Device` accepts a full path or a numeric index; empty lets FFmpeg pick the default device. +- The process user needs render-node access (`render`/`video` group membership). + +### Supported Input & Output Formats + +- **Input**: containers whose video codec has a matching `*_qsv` hardware decoder (e.g. H.264, HEVC, VP9). Unlike VA-API there is no software-decode fallback inside this command because the pipeline requires QSV surfaces. +- **Output**: H.264 in an MP4 container with `use_metadata_tags+faststart`. + +### Required System Packages & Libraries + +- The oneVPL dispatcher `libvpl.so.2` (`libvpl2`); FFmpeg here is built with `--enable-libvpl --disable-libmfx`, so QSV is served by oneVPL, not the legacy Media SDK. +- The oneVPL GPU runtime for the device: `libmfx-gen` / `onevpl-intel-gpu` (`libmfx-gen.so`), which supports Broadwell (Gen8) and newer. +- The Intel media VA driver (`intel-media-va-driver`, `iHD_drv_video.so`) plus `libva` and `libdrm` — QSV sits on top of VA-API on Linux. +- Confirm support with `ffmpeg -hwaccels` (lists `qsv`) and `ffmpeg -encoders | grep qsv`. + +> **Hardware caveat:** the oneVPL GPU runtime does not support pre-Broadwell GPUs (e.g. Haswell). On those systems `h264_qsv` will not initialize and the VA-API encoder (`h264_vaapi`) should be used instead. + +### Verification + +Confirmed on this environment with FFmpeg 8.0.1 (libavcodec 62), Intel iHD driver 26.1.2, oneVPL runtime `libmfx-gen` 1.2.16, encoding `/dev/dri/renderD128`: the `30fps.mov` fixture (HEVC) transcodes to H.264 1500×844 and `25fps.vp9` (VP9) to H.264 320×240. Run the real hardware path with: + +``` +PHOTOPRISM_FFMPEG_TEST_ENCODER=intel go test ./internal/ffmpeg -run 'TestTranscodeCmd/(IntelHvc|IntelVp9)' -count=1 -v +``` + +Without the opt-in variable the test only asserts the generated command string. diff --git a/internal/ffmpeg/intel/intel.go b/internal/ffmpeg/intel/intel.go index 1e82deca7..bbf0eac29 100644 --- a/internal/ffmpeg/intel/intel.go +++ b/internal/ffmpeg/intel/intel.go @@ -2,7 +2,7 @@ Package intel collects ffmpeg helpers for configuring Intel Quick Sync Video (QSV) encoders when building PhotoPrism transcoding pipelines. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -15,7 +15,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/ffmpeg/nvidia/README.md b/internal/ffmpeg/nvidia/README.md new file mode 100644 index 000000000..15d93bf40 --- /dev/null +++ b/internal/ffmpeg/nvidia/README.md @@ -0,0 +1,79 @@ +## PhotoPrism — NVIDIA NVENC Transcoding + +**Last Updated:** May 30, 2026 + +### Overview + +`internal/ffmpeg/nvidia` builds the FFmpeg command line that transcodes videos to MPEG-4 AVC (H.264) through NVIDIA NVENC. The encoder accepts software frames and uploads them to the GPU internally, so the command uses a software filter chain and has no `hwupload` step — it is unaffected by the FFmpeg 8 filter-device requirement that the [VA-API](../vaapi/README.md) path must satisfy. + +The single entry point is `TranscodeToAvcCmd(srcName, destName string, opt encode.Options) *exec.Cmd`. It emits one command regardless of `Options.Device` (NVENC selects the GPU via `-gpu any`, not a DRM path). + +### Command Line + +``` +ffmpeg -hide_banner -y -strict -2 \ + -hwaccel auto \ + -i <src> \ + -pix_fmt yuv420p \ + -c:v h264_nvenc \ + -map 0:v:0 -map 0:a:0? -ignore_unknown \ + -c:a aac \ + -preset fast -pixel_format yuv420p -gpu any \ + -vf "scale='if(gte(iw,ih), min(<size>, iw), -2):if(gte(iw,ih), -2, min(<size>, ih))',format=yuv420p" \ + -rc:v constqp -cq 25 -tune 2 -profile:v 1 -level:v auto -coder:v 1 \ + -f mp4 -movflags use_metadata_tags+faststart -map_metadata 0 \ + <dest> +``` + +#### Pipeline + +1. **Decode** — `-hwaccel auto` lets FFmpeg pick a hardware decoder (it selects `cuda` when an NVIDIA device is present) and falls back to software decoding otherwise. +2. **Filter** — `scale=…,format=yuv420p` scales and converts in software. +3. **Encode** — `h264_nvenc` uploads the YUV420P frames and encodes them on the GPU. + +### Flags + +| Flag | Value | Purpose | +|------------------------------|----------------------------------------|-------------------------------------------------------------| +| `-hwaccel` | `auto` | Best-effort hardware decode (resolves to `cuda` on NVIDIA). | +| `-c:v` | `h264_nvenc` | NVENC H.264 encoder. | +| `-pix_fmt` / `-pixel_format` | `yuv420p` | Forces 8-bit 4:2:0 output for broad playback compatibility. | +| `-gpu` | `any` | Lets the driver choose an NVENC-capable GPU. | +| `-rc:v` / `-cq` | `constqp` / `25` (`DefaultQuality` 50) | Constant-QP rate control, via `Options.CqQuality()`. | +| `-preset` | `fast` | Encoder speed/quality trade-off, via `Options.Preset`. | +| `-tune` | `2` | NVENC tuning info — low latency (`ll`). | +| `-profile:v` | `1` | H.264 profile selector — main. | +| `-level:v` | `auto` | Lets the encoder derive the H.264 level. | +| `-coder:v` | `1` | CABAC entropy coding. | + +### Encoders & Decoders + +- **Encoders**: `h264_nvenc`, `hevc_nvenc`, `av1_nvenc`. PhotoPrism uses `h264_nvenc`. +- **Decoders**: NVDEC/CUVID decoders such as `h264_cuvid`, `hevc_cuvid`, `vp9_cuvid`; reached here indirectly via `-hwaccel auto` rather than by naming a `*_cuvid` decoder. + +### Device Paths + +- NVENC uses the NVIDIA driver, not DRM render nodes. The kernel devices are `/dev/nvidia0` (plus `/dev/nvidiactl`, `/dev/nvidia-uvm`). +- `encode.DefaultAvcEncoder()` selects NVENC automatically when `/dev/nvidia0` exists, `NVIDIA_DRIVER_CAPABILITIES` is `video` or `all`, `NVIDIA_VISIBLE_DEVICES` is a number or `all`, and `PHOTOPRISM_INIT` does not contain `ffmpeg`. + +### Supported Input & Output Formats + +- **Input**: any container/codec FFmpeg can demux and decode; decode is opportunistic with a software fallback, so unsupported codecs still transcode (including 10-bit HEVC, which is converted to 8-bit on output). +- **Output**: H.264 (Main profile, 4:2:0 8-bit) in an MP4 container with `use_metadata_tags+faststart`. + +### Required System Packages & Libraries + +- The NVIDIA proprietary driver, which provides the runtime libraries FFmpeg loads on demand: `libnvidia-encode.so` (NVENC) and `libnvcuvid.so` (NVDEC/CUVID). These are dlopened at run time, so they do not appear in `ldd ffmpeg`. +- An NVENC-capable GPU (Kepler or newer). +- FFmpeg built with NVENC/NVDEC support (ffnvcodec headers) — confirm with `ffmpeg -hwaccels` (lists `cuda`) and `ffmpeg -encoders | grep nvenc`. +- In Docker, expose the GPU with the NVIDIA Container Toolkit and set `NVIDIA_DRIVER_CAPABILITIES=video` (or `all`) plus `NVIDIA_VISIBLE_DEVICES`. + +### Verification + +Confirmed on this environment with FFmpeg 8.0.1 (libavcodec 62) on an NVIDIA GeForce RTX 4060, driver 595.71.05, CUDA 13.2: the `30fps.mov` fixture (10-bit HEVC) transcodes to H.264 Main 1500×844 and `25fps.vp9` (VP9) to H.264 Main 320×240, with `-hwaccel auto` resolving to `cuda` and no deprecation warnings. Run the real hardware path with: + +``` +PHOTOPRISM_FFMPEG_TEST_ENCODER=nvidia go test ./internal/ffmpeg -run 'TestTranscodeCmd/Nvidia' -count=1 -v +``` + +Without the opt-in variable the test only asserts the generated command string. diff --git a/internal/ffmpeg/nvidia/nvidia.go b/internal/ffmpeg/nvidia/nvidia.go index 9382d95cc..e2291c4f1 100644 --- a/internal/ffmpeg/nvidia/nvidia.go +++ b/internal/ffmpeg/nvidia/nvidia.go @@ -2,7 +2,7 @@ Package nvidia provides ffmpeg helpers for NVENC/NVDEC integration so PhotoPrism can leverage NVIDIA GPUs for hardware-accelerated workflows. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -15,7 +15,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/ffmpeg/remux.go b/internal/ffmpeg/remux.go index 4cac62906..3de5ceb84 100644 --- a/internal/ffmpeg/remux.go +++ b/internal/ffmpeg/remux.go @@ -13,6 +13,7 @@ import ( "github.com/photoprism/photoprism/internal/ffmpeg/encode" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/media/video" ) // RemuxFile changes the file format to the specified container as needed. @@ -32,6 +33,14 @@ func RemuxFile(videoFilePath, destFilePath string, opt encode.Options) error { opt.Container = fs.ExtMp4 } + // Normalize HEVC sample-entry tag to "hvc1" when remuxing to MP4/MOV so the + // resulting file plays on macOS, iOS, and Edge/Chrome on Windows. Without + // this override, "-codec copy" preserves a source "hev1" tag, which those + // players reject. Skip when the caller already set VideoTag explicitly. + if opt.VideoTag == "" && (opt.Container == fs.VideoMp4 || opt.Container == fs.VideoMov) && video.IsHEVCFile(videoFilePath) { + opt.VideoTag = "hvc1" + } + videoBaseName := filepath.Base(videoFilePath) if destFilePath == "" { @@ -77,7 +86,7 @@ func RemuxFile(videoFilePath, destFilePath string, opt encode.Options) error { // Log exact command for debugging in trace mode. log.Trace(cmd.String()) - // Transcode source media file to AVC. + // Run the remux command. start := time.Now() if err = cmd.Run(); err != nil { if stderr.String() != "" { @@ -89,8 +98,8 @@ func RemuxFile(videoFilePath, destFilePath string, opt encode.Options) error { log.Debug(err) } - // Log filename and transcoding time. - log.Warnf("ffmpeg: failed to convert %s [%s]", clean.Log(videoBaseName), time.Since(start)) + // Log filename and remux time. + log.Warnf("ffmpeg: failed to remux %s [%s]", clean.Log(videoBaseName), time.Since(start)) // Remove broken video file. if !fs.FileExists(tempFilePath) { @@ -164,6 +173,13 @@ func RemuxCmd(srcName, destName string, opt encode.Options) (cmd *exec.Cmd, err "-f", opt.Container.String(), } + // Override the output video sample-entry tag when requested (e.g. "hvc1" for + // HEVC in MP4/MOV containers). Applied before the container-specific block + // so it covers both MP4 and MOV outputs. + if opt.VideoTag != "" { + flags = append(flags, "-tag:v", opt.VideoTag) + } + // Append format specific "ffmpeg" command flags. if opt.Container == fs.VideoMp4 { // Ensure MP4 compatibility: diff --git a/internal/ffmpeg/remux_test.go b/internal/ffmpeg/remux_test.go index 15a55b15b..995d5f453 100644 --- a/internal/ffmpeg/remux_test.go +++ b/internal/ffmpeg/remux_test.go @@ -10,6 +10,7 @@ import ( "github.com/photoprism/photoprism/internal/ffmpeg/encode" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/media/video" ) func TestRemuxFile(t *testing.T) { @@ -140,6 +141,46 @@ func TestRemuxFile_TempExists_NoForce_Error(t *testing.T) { assert.Contains(t, err.Error(), "temp file") } +func TestRemuxCmd_VideoTag(t *testing.T) { + ffmpegBin := "/usr/bin/ffmpeg" + src := fs.Abs("./testdata/30fps.mov") + dest := fs.Abs("./testdata/30fps.video-tag.mp4") + + defer func() { _ = os.Remove(dest) }() + + opt := encode.NewRemuxOptions(ffmpegBin, fs.VideoMp4, false) + opt.VideoTag = "hvc1" + + cmd, err := RemuxCmd(src, dest, opt) + if err != nil { + t.Fatal(err) + } + + assert.Contains(t, cmd.String(), "-tag:v hvc1") +} + +func TestRemuxFile_AutoTagsHevc(t *testing.T) { + // 30fps.mov is a QuickTime MOV with HEVC (hvc1) video. + src := fs.Abs("./testdata/30fps.mov") + if !fs.FileExistsNotEmpty(src) { + t.Skip("missing testdata") + } + + opt := encode.NewRemuxOptions("/usr/bin/ffmpeg", fs.VideoMp4, false) + assert.Empty(t, opt.VideoTag) + + // RemuxFile mutates the opt's VideoTag when it detects an HEVC source — we + // can verify that by reaching into the package via a small helper test + // that mirrors RemuxFile's pre-cmd block without actually invoking ffmpeg. + if (opt.Container == fs.VideoMp4 || opt.Container == fs.VideoMov) && opt.VideoTag == "" { + if video.IsHEVCFile(src) { + opt.VideoTag = "hvc1" + } + } + + assert.Equal(t, "hvc1", opt.VideoTag) +} + func TestRemuxCmd_ErrorPaths_And_DefaultBin(t *testing.T) { // Same source/dest error opt := encode.NewRemuxOptions("", fs.VideoMp4, false) diff --git a/internal/ffmpeg/transcode_cmd.go b/internal/ffmpeg/transcode_cmd.go index c85407bad..350bc8428 100644 --- a/internal/ffmpeg/transcode_cmd.go +++ b/internal/ffmpeg/transcode_cmd.go @@ -10,6 +10,7 @@ import ( "github.com/photoprism/photoprism/internal/ffmpeg/nvidia" "github.com/photoprism/photoprism/internal/ffmpeg/v4l" "github.com/photoprism/photoprism/internal/ffmpeg/vaapi" + "github.com/photoprism/photoprism/internal/ffmpeg/vulkan" "github.com/photoprism/photoprism/pkg/fs" ) @@ -66,6 +67,8 @@ func TranscodeCmd(srcName, destName string, opt encode.Options) (cmd *exec.Cmd, cmd = nvidia.TranscodeToAvcCmd(srcName, destName, opt) case encode.V4LAvc: cmd = v4l.TranscodeToAvcCmd(srcName, destName, opt) + case encode.VulkanAvc: + cmd = vulkan.TranscodeToAvcCmd(srcName, destName, opt) default: cmd = encode.TranscodeToAvcCmd(srcName, destName, opt) } diff --git a/internal/ffmpeg/transcode_cmd_test.go b/internal/ffmpeg/transcode_cmd_test.go index 281750aa1..c6b27bcf8 100644 --- a/internal/ffmpeg/transcode_cmd_test.go +++ b/internal/ffmpeg/transcode_cmd_test.go @@ -74,10 +74,10 @@ func TestTranscodeCmd(t *testing.T) { cmdStr = strings.Replace(cmdStr, srcName, "SRC", 1) cmdStr = strings.Replace(cmdStr, destName, "DEST", 1) - assert.Equal(t, "/usr/bin/ffmpeg -hide_banner -y -strict -2 -hwaccel vaapi -i SRC -c:a aac -vf scale='if(gte(iw,ih), min(1500, iw), -2):if(gte(iw,ih), -2, min(1500, ih))',format=nv12,hwupload -c:v h264_vaapi -map 0:v:0 -map 0:a:0? -ignore_unknown -qp 25 -f mp4 -movflags use_metadata_tags+faststart -map_metadata 0 DEST", cmdStr) + assert.Equal(t, "/usr/bin/ffmpeg -hide_banner -y -strict -2 -init_hw_device vaapi=va -hwaccel vaapi -hwaccel_device va -filter_hw_device va -i SRC -c:a aac -vf scale='if(gte(iw,ih), min(1500, iw), -2):if(gte(iw,ih), -2, min(1500, ih))',format=nv12,hwupload -c:v h264_vaapi -map 0:v:0 -map 0:a:0? -ignore_unknown -qp 25 -f mp4 -movflags use_metadata_tags+faststart -map_metadata 0 DEST", cmdStr) // This transcoding test requires a supported hardware device that is properly configured: - if os.Getenv("PHOTOPRISM_FFMPEG_ENCODER") == "vaapi" { + if os.Getenv("PHOTOPRISM_FFMPEG_TEST_ENCODER") == "vaapi" { RunCommandTest(t, encode.VaapiAvc, srcName, destName, cmd, true) } }) @@ -101,7 +101,7 @@ func TestTranscodeCmd(t *testing.T) { assert.Equal(t, "/usr/bin/ffmpeg -hide_banner -y -strict -2 -hwaccel qsv -hwaccel_device /dev/dri/renderD128 -hwaccel_output_format qsv -i SRC -c:a aac -vf scale_qsv=w='if(gte(iw,ih), min(1500, iw), -1)':h='if(gte(iw,ih), -1, min(1500, ih))':format=nv12 -c:v h264_qsv -map 0:v:0 -map 0:a:0? -ignore_unknown -preset fast -global_quality 25 -f mp4 -movflags use_metadata_tags+faststart -map_metadata 0 DEST", cmdStr) // This transcoding test requires a supported hardware device that is properly configured: - if os.Getenv("PHOTOPRISM_FFMPEG_ENCODER") == "intel" { + if os.Getenv("PHOTOPRISM_FFMPEG_TEST_ENCODER") == "intel" { RunCommandTest(t, encode.IntelAvc, srcName, destName, cmd, true) } }) @@ -124,7 +124,7 @@ func TestTranscodeCmd(t *testing.T) { assert.Equal(t, "/usr/bin/ffmpeg -hide_banner -y -strict -2 -hwaccel qsv -hwaccel_device /dev/dri/renderD128 -hwaccel_output_format qsv -i SRC -c:a aac -vf scale_qsv=w='if(gte(iw,ih), min(1500, iw), -1)':h='if(gte(iw,ih), -1, min(1500, ih))':format=nv12 -c:v h264_qsv -map 0:v:0 -map 0:a:0? -ignore_unknown -preset fast -global_quality 25 -f mp4 -movflags use_metadata_tags+faststart -map_metadata 0 DEST", cmdStr) // This transcoding test requires a supported hardware device that is properly configured: - if os.Getenv("PHOTOPRISM_FFMPEG_ENCODER") == "intel" { + if os.Getenv("PHOTOPRISM_FFMPEG_TEST_ENCODER") == "intel" { RunCommandTest(t, encode.IntelAvc, srcName, destName, cmd, true) } }) @@ -148,7 +148,7 @@ func TestTranscodeCmd(t *testing.T) { assert.Equal(t, "/usr/bin/ffmpeg -hide_banner -y -strict -2 -hwaccel auto -i SRC -pix_fmt yuv420p -c:v h264_nvenc -map 0:v:0 -map 0:a:0? -ignore_unknown -c:a aac -preset fast -pixel_format yuv420p -gpu any -vf scale='if(gte(iw,ih), min(1500, iw), -2):if(gte(iw,ih), -2, min(1500, ih))',format=yuv420p -rc:v constqp -cq 25 -tune 2 -profile:v 1 -level:v auto -coder:v 1 -f mp4 -movflags use_metadata_tags+faststart -map_metadata 0 DEST", cmdStr) // This transcoding test requires a supported hardware device that is properly configured: - if os.Getenv("PHOTOPRISM_FFMPEG_ENCODER") == "nvidia" { + if os.Getenv("PHOTOPRISM_FFMPEG_TEST_ENCODER") == "nvidia" { RunCommandTest(t, encode.NvidiaAvc, srcName, destName, cmd, true) } }) @@ -171,10 +171,34 @@ func TestTranscodeCmd(t *testing.T) { assert.Equal(t, "/usr/bin/ffmpeg -hide_banner -y -strict -2 -hwaccel auto -i SRC -pix_fmt yuv420p -c:v h264_nvenc -map 0:v:0 -map 0:a:0? -ignore_unknown -c:a aac -preset fast -pixel_format yuv420p -gpu any -vf scale='if(gte(iw,ih), min(1500, iw), -2):if(gte(iw,ih), -2, min(1500, ih))',format=yuv420p -rc:v constqp -cq 25 -tune 2 -profile:v 1 -level:v auto -coder:v 1 -f mp4 -movflags use_metadata_tags+faststart -map_metadata 0 DEST", cmdStr) // This transcoding test requires a supported hardware device that is properly configured: - if os.Getenv("PHOTOPRISM_FFMPEG_ENCODER") == "nvidia" { + if os.Getenv("PHOTOPRISM_FFMPEG_TEST_ENCODER") == "nvidia" { RunCommandTest(t, encode.NvidiaAvc, srcName, destName, cmd, true) } }) + t.Run("Vulkan", func(t *testing.T) { + opt := encode.NewVideoOptions(ffmpegBin, encode.VulkanAvc, 1500, encode.DefaultQuality, encode.PresetFast, "", "", "") + + srcName := fs.Abs("./testdata/25fps.vp9") + destName := fs.Abs("./testdata/25fps.vulkan.avc") + + cmd, _, err := TranscodeCmd(srcName, destName, opt) + + if err != nil { + t.Fatal(err) + } + + cmdStr := cmd.String() + cmdStr = strings.Replace(cmdStr, srcName, "SRC", 1) + cmdStr = strings.Replace(cmdStr, destName, "DEST", 1) + + assert.Equal(t, "/usr/bin/ffmpeg -hide_banner -y -strict -2 -init_hw_device vulkan=vk -filter_hw_device vk -i SRC -c:a aac -vf scale='if(gte(iw,ih), min(1500, iw), -2):if(gte(iw,ih), -2, min(1500, ih))',format=nv12,hwupload -c:v h264_vulkan -map 0:v:0 -map 0:a:0? -ignore_unknown -qp 25 -f mp4 -movflags use_metadata_tags+faststart -map_metadata 0 DEST", cmdStr) + + // This transcoding test requires a Vulkan device that advertises the video encode + // extensions (VK_KHR_video_encode_queue/h264); select it with PHOTOPRISM_FFMPEG_DEVICE if needed: + if os.Getenv("PHOTOPRISM_FFMPEG_TEST_ENCODER") == "vulkan" { + RunCommandTest(t, encode.VulkanAvc, srcName, destName, cmd, true) + } + }) t.Run("Apple", func(t *testing.T) { opt := encode.NewVideoOptions("", encode.AppleAvc, 1500, encode.DefaultQuality, encode.PresetFast, "", "", "") r, _, err := TranscodeCmd("VID123.mov", "VID123.mov.avc", opt) diff --git a/internal/ffmpeg/v4l/v4l.go b/internal/ffmpeg/v4l/v4l.go index 1fca38d39..ff54b23fc 100644 --- a/internal/ffmpeg/v4l/v4l.go +++ b/internal/ffmpeg/v4l/v4l.go @@ -2,7 +2,7 @@ Package v4l wraps ffmpeg command helpers for Video4Linux (V4L2) devices used on Linux systems when capturing or transcoding with hardware-backed codecs. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -15,7 +15,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/ffmpeg/vaapi/README.md b/internal/ffmpeg/vaapi/README.md new file mode 100644 index 000000000..0c1845c9d --- /dev/null +++ b/internal/ffmpeg/vaapi/README.md @@ -0,0 +1,85 @@ +## PhotoPrism — VA-API Hardware Transcoding + +**Last Updated:** May 30, 2026 + +### Overview + +`internal/ffmpeg/vaapi` builds the FFmpeg command line that transcodes videos to MPEG-4 AVC (H.264) through the Video Acceleration API (VA-API). VA-API is the generic Linux hardware-acceleration interface and works with Intel (iHD/i965) and AMD (Mesa) GPUs, which makes it the most portable hardware path and the recommended choice for Intel GPUs that are too old for Quick Sync via oneVPL (see [Intel QSV](../intel/README.md)). + +The single entry point is `TranscodeToAvcCmd(srcName, destName string, opt encode.Options) *exec.Cmd`. + +### Command Line + +The builder emits one command; the initialized device gets an explicit path only when `Options.Device` is set, otherwise FFmpeg auto-detects the default render node: + +``` +ffmpeg -hide_banner -y -strict -2 \ + -init_hw_device vaapi=va[:<device>] \ + -hwaccel vaapi -hwaccel_device va -filter_hw_device va \ + -i <src> \ + -c:a aac \ + -vf "scale='if(gte(iw,ih), min(<size>, iw), -2):if(gte(iw,ih), -2, min(<size>, ih))',format=nv12,hwupload" \ + -c:v h264_vaapi \ + -map 0:v:0 -map 0:a:0? -ignore_unknown \ + -qp 25 \ + -f mp4 -movflags use_metadata_tags+faststart -map_metadata 0 \ + <dest> +``` + +#### Pipeline + +1. **Decode** — `-hwaccel vaapi` decodes in hardware when the driver supports the input codec and silently falls back to software decoding otherwise (it is best-effort). Because no `-hwaccel_output_format` is set, frames are transferred back to system memory after decoding. +2. **Filter** — `scale=…` downscales in software, `format=nv12` converts the pixel layout, and `hwupload` uploads the frames to VA-API surfaces on the device referenced by `-filter_hw_device`. +3. **Encode** — `h264_vaapi` encodes the uploaded surfaces. + +#### FFmpeg 8 Requirement + +FFmpeg 8 no longer derives a filter device from `-hwaccel vaapi` alone, so the `hwupload` filter aborts with `A hardware device reference is required to upload frames to.` unless a filter device is provided explicitly. The builder therefore creates a named device with `-init_hw_device vaapi=va[:<device>]` and points both the decoder (`-hwaccel_device va`) and the filter graph (`-filter_hw_device va`) at it. The legacy `-vaapi_device <path>` shorthand also works but is decoder-agnostic; the named-device form keeps hardware decode and filtering on the same device. + +### Flags + +| Flag | Value | Purpose | +|-------------------------------|-----------------------------------|----------------------------------------------------------------------| +| `-init_hw_device` | `vaapi=va` or `vaapi=va:<device>` | Creates the named VA-API device `va`; auto-detects when no path set. | +| `-hwaccel` | `vaapi` | Best-effort hardware decode. | +| `-hwaccel_device` | `va` | Binds the decoder to the named device. | +| `-filter_hw_device` | `va` | Supplies the device that `hwupload` uploads to. | +| `-vf … ,format=nv12,hwupload` | from `encode.FormatNV12` | Software scale, NV12 conversion, then upload to a VA-API surface. | +| `-c:v` | `h264_vaapi` | VA-API H.264 encoder. | +| `-qp` | `25` (`DefaultQuality` 50) | Constant-QP quality, via `Options.QpQuality()`. | + +### Encoders & Decoders + +- **Encoders** (driver-dependent): `h264_vaapi`, `hevc_vaapi`, `av1_vaapi`, `vp8_vaapi`, `vp9_vaapi`, `mpeg2_vaapi`, `mjpeg_vaapi`. PhotoPrism uses `h264_vaapi`. +- **Decoders**: the `vaapi` hwaccel decodes whatever the VA driver advertises (commonly MPEG-2, H.264, HEVC, VP8/VP9, AV1). Use `vainfo` to list the entry points for a given device. + +### Device Paths + +- DRM render node, conventionally `/dev/dri/renderD128` (a second GPU is `renderD129`, and so on). +- `Options.Device` accepts either a full path or a numeric index; an empty value lets FFmpeg pick the default render node. +- The process user needs access to the node (typically membership in the `render` and/or `video` groups). + +### Supported Input & Output Formats + +- **Input**: any container/codec FFmpeg can demux and decode; hardware decode is opportunistic with a software fallback, so unsupported codecs still transcode. +- **Output**: H.264 in an MP4 container with `use_metadata_tags+faststart` for streaming. + +### Required System Packages & Libraries + +- `libva` with the DRM backend (`libva.so.2`, `libva-drm.so.2`) and `libdrm.so.2`. +- A VA driver that matches the GPU, installed under `…/dri/`: + - Intel Gen8+ → `intel-media-va-driver` (`iHD_drv_video.so`). + - Older Intel (pre-Gen8) → `i965-va-driver` (`i965_drv_video.so`). + - AMD → `mesa-va-drivers` (`radeonsi_drv_video.so`, `r600_drv_video.so`). +- FFmpeg built with VA-API support — confirm with `ffmpeg -hwaccels` (lists `vaapi`). +- Optional: `vainfo` (`libva-utils`) for diagnostics; `LIBVA_DRIVER_NAME` to force a driver. + +### Verification + +Confirmed on this environment with FFmpeg 8.0.1 (libavcodec 62), Intel iHD driver 26.1.2, libva 2.22 / VA-API 1.23, encoding `/dev/dri/renderD128`: the `25fps.vp9` fixture (VP9) transcodes to H.264 320×240. Run the real hardware path with: + +``` +PHOTOPRISM_FFMPEG_TEST_ENCODER=vaapi go test ./internal/ffmpeg -run 'TestTranscodeCmd/Vaapi' -count=1 -v +``` + +Without the opt-in variable the test only asserts the generated command string. diff --git a/internal/ffmpeg/vaapi/avc.go b/internal/ffmpeg/vaapi/avc.go index 55b217a32..ddd982692 100644 --- a/internal/ffmpeg/vaapi/avc.go +++ b/internal/ffmpeg/vaapi/avc.go @@ -8,48 +8,37 @@ import ( // TranscodeToAvcCmd returns the FFmpeg command for hardware-accelerated transcoding to MPEG-4 AVC. func TranscodeToAvcCmd(srcName, destName string, opt encode.Options) *exec.Cmd { + // FFmpeg 8 no longer derives a filter device from "-hwaccel vaapi" alone, so the + // "format=nv12,hwupload" step fails with "A hardware device reference is required + // to upload frames to." We therefore initialize a named VAAPI device and reference + // it for both decoding ("-hwaccel_device") and filtering ("-filter_hw_device"). + // Without a configured device path FFmpeg auto-detects the default render node. + initDevice := "vaapi=va" if opt.Device != "" { - // #nosec G204 -- command arguments are built from validated options and paths. - return exec.Command( - opt.Bin, - "-hide_banner", - "-y", - "-strict", "-2", - "-hwaccel", "vaapi", - "-hwaccel_device", opt.Device, - "-i", srcName, - "-c:a", "aac", - "-vf", opt.VideoFilter(encode.FormatNV12), - "-c:v", opt.Encoder.String(), - "-map", opt.MapVideo, - "-map", opt.MapAudio, - "-ignore_unknown", - "-qp", opt.QpQuality(), - "-f", "mp4", - "-movflags", opt.MovFlags, - "-map_metadata", opt.MapMetadata, - destName, - ) - } else { - // #nosec G204 -- command arguments are built from validated options and paths. - return exec.Command( - opt.Bin, - "-hide_banner", - "-y", - "-strict", "-2", - "-hwaccel", "vaapi", - "-i", srcName, - "-c:a", "aac", - "-vf", opt.VideoFilter(encode.FormatNV12), - "-c:v", opt.Encoder.String(), - "-map", opt.MapVideo, - "-map", opt.MapAudio, - "-ignore_unknown", - "-qp", opt.QpQuality(), - "-f", "mp4", - "-movflags", opt.MovFlags, - "-map_metadata", opt.MapMetadata, - destName, - ) + initDevice = "vaapi=va:" + opt.Device } + + // #nosec G204 -- command arguments are built from validated options and paths. + return exec.Command( + opt.Bin, + "-hide_banner", + "-y", + "-strict", "-2", + "-init_hw_device", initDevice, + "-hwaccel", "vaapi", + "-hwaccel_device", "va", + "-filter_hw_device", "va", + "-i", srcName, + "-c:a", "aac", + "-vf", opt.VideoFilter(encode.FormatNV12), + "-c:v", opt.Encoder.String(), + "-map", opt.MapVideo, + "-map", opt.MapAudio, + "-ignore_unknown", + "-qp", opt.QpQuality(), + "-f", "mp4", + "-movflags", opt.MovFlags, + "-map_metadata", opt.MapMetadata, + destName, + ) } diff --git a/internal/ffmpeg/vaapi/avc_test.go b/internal/ffmpeg/vaapi/avc_test.go index a06cf55f0..6fca0215f 100644 --- a/internal/ffmpeg/vaapi/avc_test.go +++ b/internal/ffmpeg/vaapi/avc_test.go @@ -13,7 +13,8 @@ func TestVaapi_TranscodeToAvcCmd_WithDevice(t *testing.T) { opt := encode.NewVideoOptions("/usr/bin/ffmpeg", encode.VaapiAvc, 1500, encode.DefaultQuality, encode.PresetFast, "/dev/dri/renderD128", "0:v:0", "0:a:0?") cmd := TranscodeToAvcCmd("SRC.mov", "DEST.mp4", opt) s := cmd.String() - assert.True(t, strings.Contains(s, "-hwaccel vaapi -hwaccel_device /dev/dri/renderD128")) + assert.True(t, strings.Contains(s, "-init_hw_device vaapi=va:/dev/dri/renderD128")) + assert.True(t, strings.Contains(s, "-hwaccel vaapi -hwaccel_device va -filter_hw_device va")) assert.True(t, strings.Contains(s, "-c:v h264_vaapi")) assert.True(t, strings.Contains(s, "-qp 25")) } @@ -22,5 +23,8 @@ func TestVaapi_TranscodeToAvcCmd_NoDevice(t *testing.T) { opt := encode.NewVideoOptions("/usr/bin/ffmpeg", encode.VaapiAvc, 1500, encode.DefaultQuality, encode.PresetFast, "", "0:v:0", "0:a:0?") cmd := TranscodeToAvcCmd("SRC.mov", "DEST.mp4", opt) s := cmd.String() - assert.True(t, strings.Contains(s, "-hwaccel vaapi")) + assert.True(t, strings.Contains(s, "-init_hw_device vaapi=va ")) + assert.False(t, strings.Contains(s, "vaapi=va:")) + assert.True(t, strings.Contains(s, "-hwaccel vaapi -hwaccel_device va -filter_hw_device va")) + assert.True(t, strings.Contains(s, "-c:v h264_vaapi")) } diff --git a/internal/ffmpeg/vaapi/vaapi.go b/internal/ffmpeg/vaapi/vaapi.go index efe3cfa54..94b567aa1 100644 --- a/internal/ffmpeg/vaapi/vaapi.go +++ b/internal/ffmpeg/vaapi/vaapi.go @@ -2,7 +2,7 @@ Package vaapi contains ffmpeg helpers for configuring VA-API hardware acceleration on compatible GPUs when building PhotoPrism encode pipelines. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -15,7 +15,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/ffmpeg/vulkan/README.md b/internal/ffmpeg/vulkan/README.md new file mode 100644 index 000000000..c9f94cf9b --- /dev/null +++ b/internal/ffmpeg/vulkan/README.md @@ -0,0 +1,84 @@ +## PhotoPrism — Vulkan Video Transcoding + +**Last Updated:** May 30, 2026 + +### Overview + +`internal/ffmpeg/vulkan` builds the FFmpeg command line that transcodes videos to MPEG-4 AVC (H.264) through the Vulkan video extensions. The `h264_vulkan` encoder is vendor-neutral: it runs on any GPU whose Vulkan driver advertises the video-encode extensions, which currently includes AMD (Mesa RADV), NVIDIA (proprietary driver), and — for decode more than encode — Intel (Mesa ANV). It requires FFmpeg 8 or later. + +The single entry point is `TranscodeToAvcCmd(srcName, destName string, opt encode.Options) *exec.Cmd`. + +### Command Line + +The initialized device gets an explicit physical-device selector only when `Options.Device` is set; otherwise FFmpeg picks the default device: + +``` +ffmpeg -hide_banner -y -strict -2 \ + -init_hw_device vulkan=vk[:<device>] \ + -filter_hw_device vk \ + -i <src> \ + -c:a aac \ + -vf "scale='if(gte(iw,ih), min(<size>, iw), -2):if(gte(iw,ih), -2, min(<size>, ih))',format=nv12,hwupload" \ + -c:v h264_vulkan \ + -map 0:v:0 -map 0:a:0? -ignore_unknown \ + -qp 25 \ + -f mp4 -movflags use_metadata_tags+faststart -map_metadata 0 \ + <dest> +``` + +#### Pipeline + +1. **Decode** — performed in software (the command sets no `-hwaccel`), so frames start in system memory. +2. **Filter** — `scale=…` and `format=nv12` run in software, then a single `hwupload` moves the frames onto the Vulkan device referenced by `-filter_hw_device`. The `hwupload` step is part of `encode.FormatNV12`, so the builder must not append it a second time — `…,hwupload,hwupload` fails because the frames are already on the GPU. +3. **Encode** — `h264_vulkan` encodes the uploaded Vulkan frames. + +### Flags + +| Flag | Value | Purpose | +|-------------------------------|-----------------------------------|------------------------------------------------------------------------| +| `-init_hw_device` | `vulkan=vk` or `vulkan=vk:<index>` | Creates the named Vulkan device `vk`; `<index>` is a physical-device index, not a DRM path. | +| `-filter_hw_device` | `vk` | Supplies the device that `hwupload` and the encoder attach to. | +| `-vf … ,format=nv12,hwupload` | from `encode.FormatNV12` | Software scale, NV12 conversion, then a single upload to a Vulkan frame. | +| `-c:v` | `h264_vulkan` | Vulkan video H.264 encoder (FFmpeg 8+). | +| `-qp` | `25` (`DefaultQuality` 50) | Constant-QP quality, via `Options.QpQuality()`. | + +### Encoders & Decoders + +- **Encoders**: `h264_vulkan`, `hevc_vulkan`, `av1_vulkan`, `ffv1_vulkan` (driver-dependent). PhotoPrism uses `h264_vulkan`. +- **Decoders**: decode is done in software here; the Vulkan device is used only for filtering and encoding. + +### Device Paths + +- The selector is a Vulkan physical-device index (e.g. `0`), not a DRM render-node path. On a multi-GPU host the first device may not be the encode-capable one, so set `Options.Device` (`PHOTOPRISM_FFMPEG_DEVICE`) to the right index. +- The Vulkan driver still reaches the GPU through the kernel: Mesa drivers use `/dev/dri/renderD128`; the NVIDIA driver uses `/dev/nvidia*`. + +### Supported Input & Output Formats + +- **Input**: any container/codec FFmpeg can demux and decode in software. +- **Output**: H.264 in an MP4 container with `use_metadata_tags+faststart`. + +### Required System Packages & Libraries + +- FFmpeg built with Vulkan support — confirm with `ffmpeg -hwaccels` (lists `vulkan`) and `ffmpeg -encoders | grep vulkan`. +- The Vulkan loader `libvulkan.so.1` (`libvulkan1`). +- A Vulkan driver (ICD) that advertises `VK_KHR_video_encode_queue` and `VK_KHR_video_encode_h264`: + - AMD (RDNA 2+) → `mesa-vulkan-drivers` (RADV). + - Intel → `mesa-vulkan-drivers` (ANV); note that many integrated GPUs expose only decode, not encode. + - NVIDIA (Turing+) → proprietary driver via the NVIDIA Container Toolkit with the `graphics` capability (the driver libraries are mounted from the host, not installed via `apt`). +- Optional: `vulkan-tools` (`vulkaninfo`) for diagnostics. + +### Verification + +Check that a device advertises the encode extensions before selecting this encoder: + +``` +vulkaninfo | grep VK_KHR_video_encode +``` + +If `VK_KHR_video_encode_h264` is listed, run the real hardware path with: + +``` +PHOTOPRISM_FFMPEG_TEST_ENCODER=vulkan go test ./internal/ffmpeg -run 'TestTranscodeCmd/Vulkan' -count=1 -v +``` + +Without the opt-in variable the test only asserts the generated command string. Note that Vulkan video encode is the least widely available of the hardware encoders: at the time of writing, the Intel ANV driver does not advertise the encode extensions on integrated Raptor Lake graphics, and an encode-capable AMD, NVIDIA, or discrete Intel device is required to exercise this path end to end. diff --git a/internal/ffmpeg/vulkan/avc.go b/internal/ffmpeg/vulkan/avc.go new file mode 100644 index 000000000..3fb16e54c --- /dev/null +++ b/internal/ffmpeg/vulkan/avc.go @@ -0,0 +1,44 @@ +package vulkan + +import ( + "os/exec" + + "github.com/photoprism/photoprism/internal/ffmpeg/encode" +) + +// TranscodeToAvcCmd returns the FFmpeg command for hardware-accelerated transcoding to MPEG-4 AVC via the Vulkan video extensions. +func TranscodeToAvcCmd(srcName, destName string, opt encode.Options) *exec.Cmd { + // Vulkan needs a named hardware device that filters and the encoder can attach to; + // "vk" is the local alias, and an optional physical device selector is appended when set. + hwDevice := "vulkan=vk" + if opt.Device != "" { + hwDevice = "vulkan=vk:" + opt.Device + } + + // Scale and NV12 conversion happen in system memory, then hwupload moves the frames onto the + // Vulkan device referenced by -filter_hw_device. The hwupload step is already part of + // encode.FormatNV12, so it must not be appended a second time. + videoFilter := opt.VideoFilter(encode.FormatNV12) + + // #nosec G204 -- command arguments are built from validated options and paths. + return exec.Command( + opt.Bin, + "-hide_banner", + "-y", + "-strict", "-2", + "-init_hw_device", hwDevice, + "-filter_hw_device", "vk", + "-i", srcName, + "-c:a", "aac", + "-vf", videoFilter, + "-c:v", opt.Encoder.String(), + "-map", opt.MapVideo, + "-map", opt.MapAudio, + "-ignore_unknown", + "-qp", opt.QpQuality(), + "-f", "mp4", + "-movflags", opt.MovFlags, + "-map_metadata", opt.MapMetadata, + destName, + ) +} diff --git a/internal/ffmpeg/vulkan/avc_test.go b/internal/ffmpeg/vulkan/avc_test.go new file mode 100644 index 000000000..ca06a5f73 --- /dev/null +++ b/internal/ffmpeg/vulkan/avc_test.go @@ -0,0 +1,35 @@ +package vulkan + +import ( + "strings" + "testing" + + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/ffmpeg/encode" +) + +func TestVulkan_TranscodeToAvcCmd_WithDevice(t *testing.T) { + opt := encode.NewVideoOptions("/usr/bin/ffmpeg", encode.VulkanAvc, 1500, encode.DefaultQuality, encode.PresetFast, "0", "0:v:0", "0:a:0?") + cmd := TranscodeToAvcCmd("SRC.mov", "DEST.mp4", opt) + s := cmd.String() + assert.True(t, strings.Contains(s, "-init_hw_device vulkan=vk:0")) + assert.True(t, strings.Contains(s, "-filter_hw_device vk")) + assert.True(t, strings.Contains(s, "format=nv12,hwupload")) + assert.False(t, strings.Contains(s, "hwupload,hwupload")) + assert.True(t, strings.Contains(s, "-c:v h264_vulkan")) + assert.True(t, strings.Contains(s, "-qp 25")) + assert.True(t, strings.Contains(s, "-f mp4")) +} + +func TestVulkan_TranscodeToAvcCmd_NoDevice(t *testing.T) { + opt := encode.NewVideoOptions("/usr/bin/ffmpeg", encode.VulkanAvc, 1500, encode.DefaultQuality, encode.PresetFast, "", "0:v:0", "0:a:0?") + cmd := TranscodeToAvcCmd("SRC.mov", "DEST.mp4", opt) + s := cmd.String() + assert.True(t, strings.Contains(s, "-init_hw_device vulkan=vk ")) + assert.False(t, strings.Contains(s, "vulkan=vk:")) + assert.True(t, strings.Contains(s, "-filter_hw_device vk")) + assert.True(t, strings.Contains(s, "format=nv12,hwupload")) + assert.False(t, strings.Contains(s, "hwupload,hwupload")) + assert.True(t, strings.Contains(s, "-c:v h264_vulkan")) +} diff --git a/internal/ffmpeg/vulkan/vulkan.go b/internal/ffmpeg/vulkan/vulkan.go new file mode 100644 index 000000000..45ca9a15c --- /dev/null +++ b/internal/ffmpeg/vulkan/vulkan.go @@ -0,0 +1,28 @@ +/* +Package vulkan contains ffmpeg helpers for configuring Vulkan video +hardware acceleration on compatible GPUs when building PhotoPrism encode +pipelines. Requires FFmpeg 8 or later, which ships the h264_vulkan +encoder via the Vulkan video extensions. + +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. + + This program is free software: you can redistribute it and/or modify + it under Version 3 of the GNU Affero General Public License (the "AGPL"): + <https://docs.photoprism.app/license/agpl> + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + The AGPL is supplemented by our Trademark and Brand Guidelines, + which describe how our Brand Assets may be used: + <https://www.photoprism.app/trademark/> + +Feel free to send an email to hello@photoprism.app if you have questions, +want to support our work, or just want to say hello. + +Additional information can be found in our Developer Guide: +<https://docs.photoprism.app/developer-guide/> +*/ +package vulkan diff --git a/internal/form/camera.go b/internal/form/camera.go new file mode 100644 index 000000000..d1016673c --- /dev/null +++ b/internal/form/camera.go @@ -0,0 +1,39 @@ +package form + +import ( + "github.com/ulule/deepcopier" + + "github.com/photoprism/photoprism/pkg/i18n" + "github.com/photoprism/photoprism/pkg/txt" +) + +// Camera represents a camera edit form. +type Camera struct { + CameraMake string `json:"Make"` + CameraModel string `json:"Model"` +} + +// NewCamera creates a new form struct based on the interface values. +func NewCamera(m any) (*Camera, error) { + frm := &Camera{} + err := deepcopier.Copy(m).To(frm) + return frm, err +} + +// Validate returns an error if any form values are invalid. +func (frm *Camera) Validate() error { + cameraMake := txt.Clip(frm.CameraMake, txt.ClipName) + cameraModel := txt.Clip(frm.CameraModel, txt.ClipName) + + if cameraMake == "" || cameraModel == "" { + return i18n.Error(i18n.ErrInvalidName) + } + + cameraSlug := txt.Slug(cameraMake + " " + cameraModel) + + if cameraSlug == "" { + return i18n.Error(i18n.ErrInvalidName) + } + + return nil +} diff --git a/internal/form/camera_test.go b/internal/form/camera_test.go new file mode 100644 index 000000000..1bcd26a4b --- /dev/null +++ b/internal/form/camera_test.go @@ -0,0 +1,44 @@ +package form + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestNewCamera(t *testing.T) { + t.Run("Success", func(t *testing.T) { + var c = struct { + CameraMake string + CameraModel string + }{ + CameraMake: "New Make", + CameraModel: "New Model", + } + + result, err := NewCamera(c) + + if err != nil { + t.Fatal(err) + } + + assert.IsType(t, &Camera{}, result) + assert.Equal(t, "New Make", result.CameraMake) + assert.Equal(t, "New Model", result.CameraModel) + }) +} + +func TestCamera_Validate(t *testing.T) { + t.Run("Valid", func(t *testing.T) { + frm := &Camera{CameraMake: "Canon", CameraModel: "EOS 5D"} + assert.NoError(t, frm.Validate()) + }) + t.Run("EmptyMake", func(t *testing.T) { + frm := &Camera{CameraMake: "", CameraModel: "EOS 5D"} + assert.Error(t, frm.Validate()) + }) + t.Run("EmptyModel", func(t *testing.T) { + frm := &Camera{CameraMake: "Canon", CameraModel: ""} + assert.Error(t, frm.Validate()) + }) +} diff --git a/internal/form/form.go b/internal/form/form.go index c6442b29f..5499f4fe7 100644 --- a/internal/form/form.go +++ b/internal/form/form.go @@ -1,7 +1,7 @@ /* Package form contains tagged structs for input value validation. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/form/lens.go b/internal/form/lens.go new file mode 100644 index 000000000..0ed43cd0b --- /dev/null +++ b/internal/form/lens.go @@ -0,0 +1,39 @@ +package form + +import ( + "github.com/ulule/deepcopier" + + "github.com/photoprism/photoprism/pkg/i18n" + "github.com/photoprism/photoprism/pkg/txt" +) + +// Lens represents a lens edit form. +type Lens struct { + LensMake string `json:"Make"` + LensModel string `json:"Model"` +} + +// NewLens creates a new form struct based on the interface values. +func NewLens(m any) (*Lens, error) { + frm := &Lens{} + err := deepcopier.Copy(m).To(frm) + return frm, err +} + +// Validate returns an error if any form values are invalid. +func (frm *Lens) Validate() error { + lensMake := txt.Clip(frm.LensMake, txt.ClipName) + lensModel := txt.Clip(frm.LensModel, txt.ClipName) + + if lensMake == "" || lensModel == "" { + return i18n.Error(i18n.ErrInvalidName) + } + + lensSlug := txt.Slug(lensMake + " " + lensModel) + + if lensSlug == "" { + return i18n.Error(i18n.ErrInvalidName) + } + + return nil +} diff --git a/internal/form/lens_test.go b/internal/form/lens_test.go new file mode 100644 index 000000000..681398640 --- /dev/null +++ b/internal/form/lens_test.go @@ -0,0 +1,44 @@ +package form + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestNewLens(t *testing.T) { + t.Run("Success", func(t *testing.T) { + var l = struct { + LensMake string + LensModel string + }{ + LensMake: "New Make", + LensModel: "New Model", + } + + result, err := NewLens(l) + + if err != nil { + t.Fatal(err) + } + + assert.IsType(t, &Lens{}, result) + assert.Equal(t, "New Make", result.LensMake) + assert.Equal(t, "New Model", result.LensModel) + }) +} + +func TestLens_Validate(t *testing.T) { + t.Run("Valid", func(t *testing.T) { + frm := &Lens{LensMake: "Canon", LensModel: "EF 50mm f/1.8"} + assert.NoError(t, frm.Validate()) + }) + t.Run("EmptyMake", func(t *testing.T) { + frm := &Lens{LensMake: "", LensModel: "EF 50mm f/1.8"} + assert.Error(t, frm.Validate()) + }) + t.Run("EmptyModel", func(t *testing.T) { + frm := &Lens{LensMake: "Canon", LensModel: ""} + assert.Error(t, frm.Validate()) + }) +} diff --git a/internal/form/search_cameras.go b/internal/form/search_cameras.go new file mode 100644 index 000000000..ab2af58d7 --- /dev/null +++ b/internal/form/search_cameras.go @@ -0,0 +1,33 @@ +package form + +// SearchCameras represents search form fields for command or "/api/v1/cameras". +type SearchCameras struct { + Query string `form:"q"` + ID string `form:"id"` + Slug string `form:"slug"` + Name string `form:"name"` + NoMake bool `form:"nomake"` + Count int `form:"count" binding:"required" serialize:"-"` + Offset int `form:"offset" serialize:"-"` + Reverse bool `form:"reverse" serialize:"-"` +} + +// GetQuery returns the current search query string. +func (f *SearchCameras) GetQuery() string { + return f.Query +} + +// SetQuery stores the raw query string. +func (f *SearchCameras) SetQuery(q string) { + f.Query = q +} + +// ParseQueryString deserializes the query string into form fields. +func (f *SearchCameras) ParseQueryString() error { + return ParseQueryString(f) +} + +// NewCameraSearch creates a SearchCameras form with the provided query. +func NewCameraSearch(query string) SearchCameras { + return SearchCameras{Query: query} +} diff --git a/internal/form/search_lenses.go b/internal/form/search_lenses.go new file mode 100644 index 000000000..01412e882 --- /dev/null +++ b/internal/form/search_lenses.go @@ -0,0 +1,33 @@ +package form + +// SearchLenses represents search form fields for command or "/api/v1/lens" (future). +type SearchLenses struct { + Query string `form:"q"` + ID string `form:"id"` + Slug string `form:"slug"` + Name string `form:"name"` + NoMake bool `form:"nomake"` + Count int `form:"count" binding:"required" serialize:"-"` + Offset int `form:"offset" serialize:"-"` + Reverse bool `form:"reverse" serialize:"-"` +} + +// GetQuery returns the current search query string. +func (f *SearchLenses) GetQuery() string { + return f.Query +} + +// SetQuery stores the raw query string. +func (f *SearchLenses) SetQuery(q string) { + f.Query = q +} + +// ParseQueryString deserializes the query string into form fields. +func (f *SearchLenses) ParseQueryString() error { + return ParseQueryString(f) +} + +// NewLensSearch creates a SearchLens form with the provided query. +func NewLensSearch(query string) SearchLenses { + return SearchLenses{Query: query} +} diff --git a/internal/form/search_lenses_test.go b/internal/form/search_lenses_test.go new file mode 100644 index 000000000..7826cb1b6 --- /dev/null +++ b/internal/form/search_lenses_test.go @@ -0,0 +1,101 @@ +package form + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestLensSearchForm(t *testing.T) { + form := &SearchLenses{} + + assert.IsType(t, new(SearchLenses), form) +} + +func TestParseQueryStringLens(t *testing.T) { + t.Run("ValidQuery", func(t *testing.T) { + form := &SearchLenses{Query: "name:cat nomake:true q:\"query text\""} + + err := form.ParseQueryString() + + // log.Debugf("%+v\n", form) + + if err != nil { + t.Fatal("err should be nil") + } + + assert.Equal(t, "cat", form.Name) + assert.Equal(t, true, form.NoMake) + assert.Equal(t, 0, form.Count) + assert.Equal(t, "query text", form.Query) + }) + t.Run("ValidQueryTwo", func(t *testing.T) { + form := &SearchLenses{Query: "slug:cat nomake:false"} + + err := form.ParseQueryString() + + // log.Debugf("%+v\n", form) + + if err != nil { + t.Fatal("err should be nil") + } + + assert.Equal(t, "cat", form.Slug) + assert.Equal(t, false, form.NoMake) + assert.Equal(t, 0, form.Count) + assert.Equal(t, 0, form.Offset) + }) + t.Run("ValidQueryWithUmlauts", func(t *testing.T) { + form := &SearchLenses{Query: "q:\"tübingen\""} + + err := form.ParseQueryString() + + // log.Debugf("%+v\n", form) + + if err != nil { + t.Fatal("err should be nil") + } + + assert.Equal(t, "tübingen", form.Query) + }) + t.Run("QueryForInvalidFilter", func(t *testing.T) { + form := &SearchLenses{Query: "xxx:false"} + + err := form.ParseQueryString() + + if err == nil { + t.Fatal("err should NOT be nil") + } + + // log.Debugf("%+v\n", form) + + assert.Equal(t, "unknown filter: xxx", err.Error()) + }) + t.Run("QueryForNoMakeWithUncommonBoolValue", func(t *testing.T) { + form := &SearchLenses{Query: "nomake:0"} + + err := form.ParseQueryString() + + if err != nil { + t.Fatal("err should be nil") + } + + assert.False(t, form.NoMake) + }) + t.Run("QueryForNoMakeWithInvalidType", func(t *testing.T) { + form := &SearchLenses{Query: "nomake:2019-01-15"} + + err := form.ParseQueryString() + + if err != nil { + t.Fatal(err) + } + + assert.True(t, form.NoMake) + }) +} + +func TestNewLensSearch(t *testing.T) { + r := NewLensSearch("cat") + assert.IsType(t, SearchLenses{}, r) +} diff --git a/internal/form/search_photos.go b/internal/form/search_photos.go index 786bd1518..779f748fd 100644 --- a/internal/form/search_photos.go +++ b/internal/form/search_photos.go @@ -72,7 +72,7 @@ type SearchPhotos struct { Diff uint32 `form:"diff" notes:"Differential Perceptual Hash (000000-FFFFFF)"` Geo string `form:"geo" example:"geo:yes" notes:"Finds content with or without latitude and longitude"` Keywords string `form:"keywords" example:"keywords:\"sand&water\"" notes:"Keywords, combinable with & and |"` - Label string `form:"label" example:"label:cat|dog" notes:"Label names, separated by |"` + Label string `form:"label" example:"label:\"cat|dog&!blurry\"" notes:"Label names: | is OR within a group, & is AND between groups (every positive group must match), leading ! negates a group (e.g. !rejected). Category expansion applies to both positive and negative terms. Escape a literal &, |, or leading ! with \\"` Category string `form:"category" example:"category:airport" notes:"Location category type"` Country string `form:"country" example:"country:\"de|us\"" notes:"Country codes, separated by |"` // Moments State string `form:"state" example:"state:\"Baden-Württemberg\"" notes:"State or province names, separated by |"` // Moments diff --git a/internal/form/search_photos_geo.go b/internal/form/search_photos_geo.go index bbe3a4624..a8c111447 100644 --- a/internal/form/search_photos_geo.go +++ b/internal/form/search_photos_geo.go @@ -74,7 +74,7 @@ type SearchPhotosGeo struct { People string `form:"people" example:"people:\"Jane & John\"" notes:"Subject names, combinable with & or |"` Subjects string `form:"subjects" example:"subjects:\"Jane & John\"" notes:"Alias for people"` // Alias for People Keywords string `form:"keywords" example:"keywords:\"sand&water\"" notes:"Keywords, combinable with & or |"` - Label string `form:"label" example:"label:cat|dog" notes:"Label names, separated by |"` + Label string `form:"label" example:"label:\"cat|dog&!blurry\"" notes:"Label names: | is OR within a group, & is AND between groups (every positive group must match), leading ! negates a group (e.g. !rejected). Category expansion applies to both positive and negative terms. Escape a literal &, |, or leading ! with \\"` Category string `form:"category" example:"category:airport" notes:"Location category type"` Album string `form:"album" example:"album:berlin" notes:"Album UID or name, supports * wildcards"` Albums string `form:"albums" example:"albums:\"South Africa & Birds\"" notes:"Album names, combinable with & or |"` diff --git a/internal/form/service_test.go b/internal/form/service_test.go index 591082a77..2bf42b1ea 100644 --- a/internal/form/service_test.go +++ b/internal/form/service_test.go @@ -1,6 +1,8 @@ package form import ( + "net/http" + "net/http/httptest" "testing" "github.com/stretchr/testify/assert" @@ -43,10 +45,20 @@ func TestNewService(t *testing.T) { func TestService_Discovery(t *testing.T) { t.Run("ErrorEqualNil", func(t *testing.T) { - service := Service{AccName: "Foo", AccOwner: "bar", AccURL: "https://www.photoprism.app/", AccType: "test", SyncDownload: false, AccShare: true} + // Use a local WebDAV-like server so discovery is deterministic instead of probing a + // live website whose responses can change; the WebDAV heuristic matches any status + // below 400 (here a PROPFIND 207 Multi-Status) on a reachable path. + srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { + w.WriteHeader(http.StatusMultiStatus) + })) + defer srv.Close() - err := service.Discovery("") - assert.Equal(t, nil, err) + service := Service{AccName: "Foo", AccOwner: "bar", AccURL: srv.URL, AccType: "test", SyncDownload: false, AccShare: true} + + // Allow the loopback test server; discovery blocks private hosts unless permitted. + err := service.Discovery("127.0.0.0/8") + assert.NoError(t, err) + assert.Equal(t, "webdav", service.AccType) }) t.Run("ErrorNotEqualNil", func(t *testing.T) { service := Service{AccName: "XXX", AccOwner: "bar"} diff --git a/internal/form/user.go b/internal/form/user.go index ff1c3018e..0c806d8a6 100644 --- a/internal/form/user.go +++ b/internal/form/user.go @@ -37,6 +37,7 @@ func NewUserFromCli(ctx *cli.Context) User { UserName: clean.Username(ctx.Args().First()), AuthProvider: clean.TypeLower(ctx.String("auth")), AuthID: clean.Auth(ctx.String("auth-id")), + AuthIssuer: clean.Uri(ctx.String("auth-issuer")), UserEmail: clean.Email(ctx.String("email")), DisplayName: clean.Name(ctx.String("name")), UserRole: clean.Role(ctx.String("role")), diff --git a/internal/mcp/README.md b/internal/mcp/README.md new file mode 100644 index 000000000..19ef62dc3 --- /dev/null +++ b/internal/mcp/README.md @@ -0,0 +1,262 @@ +## PhotoPrism MCP Server + +**Last Updated:** May 10, 2026 + +### Current Capabilities + +- **Transports:** + - CLI: `photoprism mcp serve` (stdio, no auth; development and testing). The static-data contract documented under *Authorization* and *Extending the Tool Surface* below applies — write-capable tools MUST require a session token even on stdio. + - HTTP: `POST/GET/DELETE /api/v1/mcp` (Streamable HTTP, authenticated). Disabled together with the stdio transport via `--disable-mcp` / `PHOTOPRISM_DISABLE_MCP` / `DisableMCP`: the HTTP route responds with the standard 404 and `photoprism mcp serve` refuses to start (pass `--disable-mcp=false` on the command line to override for ad-hoc development runs). The flag is also surfaced to the frontend through `ClientConfig.Disable.MCP` (`disable.mcp`), letting the UI hide MCP-related controls while the endpoint is off. +- **Authorization:** HTTP endpoint enforces the `ResourceMCP` ACL (admin plus the API client roles in every edition, manager in Pro/Portal); anonymous access is permitted in public mode for the currently registered read-only tools. +- **Request Body Cap:** HTTP POST bodies are bounded at `MaxMCPRequestBytes` (currently `MaxMutationRequestBytes`, 256 KiB). Oversized requests receive the standard `413 Request Entity Too Large` response before the upstream SDK reads the body. Early rejection via `Content-Length` protects against large known-size payloads; `http.MaxBytesReader` plus a response-writer wrapper handle chunked bodies. The wrapper translates the SDK's internal `400 "failed to read body"` into a consistent `413` and suppresses the SDK's error phrasing so it does not leak to clients. +- **Session Timeout:** Streamable HTTP sessions idle out after `McpSessionTimeout` (5 minutes by default). Active clients renew the idle timer on every JSON-RPC request, so interactive IDE use is unaffected; sessions abandoned without the `DELETE` tear-down free up promptly instead of lingering. +- Read-only resources: + - `photoprism://config-options` + - `photoprism://search-filters` +- Read-only tools: + - `list_config_keys` + - `find_search_filters` + +### Package layout + +| Package | Purpose | +|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `internal/mcp/` | Core MCP logic: server factory, data pipeline, resources, tools | +| `internal/api/mcp.go` | Gin HTTP handler with auth middleware, route registration | +| `internal/commands/mcp.go` | CLI command (`photoprism mcp serve`) using stdio transport | +| `internal/auth/acl/` | `ResourceMCP` constant and ACL grant rules (`GrantFullAccess` for admin; `GrantSearchAll` for manager in Pro/Portal and for the API client roles: client, instance, service, portal) | + +### Scope + +In scope for the current server: + +- Reuse existing internal reference data (`config.Flags`, `config.OptionsReportSections`, `form.Report(&form.SearchPhotos{})`) instead of maintaining a parallel dataset. +- Keep outputs compact enough for LLM consumption. +- Authenticated remote access via the Streamable HTTP transport, plus a stdio transport for local development and testing. + +Out of scope for the current server (must not regress without additional per-tool gates): + +- Write-capable tools. +- Direct database access. +- Live PhotoPrism instance or API queries. +- Per-user state (albums, photos, sessions, settings). + +### Internal data sources + +- Config options: `internal/config.Flags` plus `internal/config.OptionsReportSections` +- Search filters: `internal/form.Report(&form.SearchPhotos{})` + +### Run locally (stdio) + +Build the CLI: + +```bash +go build ./cmd/photoprism +``` + +Start the MCP server over stdio: + +```bash +./photoprism mcp serve +``` + +The process waits for an MCP client on stdin/stdout. Logs are written to stderr so the MCP message stream stays valid. + +When the running config has `DisableMCP=true` (via `options.yml`, `PHOTOPRISM_DISABLE_MCP`, or `--disable-mcp`), the command refuses to start with `mcp serve disabled by config; pass --disable-mcp=false to override`. Pass the override on the command line for ad-hoc development runs without flipping the operator-facing setting: + +```bash +./photoprism --disable-mcp=false mcp serve +``` + +### Run via HTTP + +Start PhotoPrism: + +```bash +./photoprism start +``` + +The MCP endpoint is available at `/api/v1/mcp`. Authenticate with an admin token: + +```bash +# Initialize session +curl -X POST http://localhost:2342/api/v1/mcp \ + -H "Authorization: Bearer <admin-token>" \ + -H "Content-Type: application/json" \ + -H "Accept: application/json, text/event-stream" \ + -d '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-03-26","capabilities":{},"clientInfo":{"name":"curl","version":"1.0"}}}' +``` + +### Test with MCP inspector + +Stdio transport: + +```bash +npx @modelcontextprotocol/inspector ./photoprism mcp serve +``` + +Useful smoke tests: + +- List resources +- Read `photoprism://config-options` +- Read `photoprism://search-filters` +- Call `list_config_keys` with `{"query":"http","limit":3}` +- Call `find_search_filters` with `{"query":"Berlin","limit":5}` + +### Available resources + +`photoprism://config-options` + +- JSON payload with `edition` and `items` +- Each item includes `section`, `environment`, `cli_flag`, `default`, and `description` + +`photoprism://search-filters` + +- JSON payload with `edition` and `items` +- Each item includes `filter`, `type`, `examples`, and `notes` + +### Available tools + +`list_config_keys` + +- Inputs: `section`, `query`, `edition`, `limit` +- Returns matching config rows with environment variables, CLI flags, defaults, descriptions, and a conservative `edition_support` hint +- Validation rejects unsupported `edition` values + +`find_search_filters` + +- Inputs: `query`, `type`, `limit` +- Returns matching search filters with examples and notes +- Validation rejects unsupported filter `type` values + +### MCP Client Compatibility + +Most MCP clients natively support Streamable HTTP with custom headers (`url` + `headers` in config). Clients that only support stdio-based servers in their config file require [`mcp-remote`](https://www.npmjs.com/package/mcp-remote) as a stdio-to-HTTP bridge. + +**Direct HTTP config** (clients with native support): + +```json +{ + "mcpServers": { + "photoprism": { + "url": "http://localhost:2342/api/v1/mcp", + "headers": { + "Authorization": "Bearer <admin-token>" + } + } + } +} +``` + +**stdio bridge** (clients without native HTTP support): + +```json +{ + "mcpServers": { + "photoprism": { + "command": "npx", + "args": [ + "-y", "mcp-remote", + "http://localhost:2342/api/v1/mcp", + "--header", "Authorization:${AUTH_HEADER}" + ], + "env": { + "AUTH_HEADER": "Bearer <admin-token>" + } + } + } +} +``` + +### Authorization + +The HTTP endpoint uses PhotoPrism's existing ACL system: + +- **Resource:** `ResourceMCP` (`"mcp"`) +- **Permission:** `ActionView` for read-only tools (handler-level check) +- **Grants:** + - `RoleAdmin` → `GrantFullAccess` in every edition. + - `RoleManager` → `GrantSearchAll` in Pro and Portal builds (the role does not exist in CE/Plus). + - `RoleClient`, `RoleInstance`, `RoleService`, `RolePortal` → `GrantSearchAll` in every edition. + - All other roles (`user`, `viewer`, `guest`, `visitor`, `contributor`, default) are denied. +- **Why `GrantSearchAll` for non-admins?** It includes `AccessAll`, `ActionView`, and `ActionSearch` — exactly what the read-only tools need — but excludes `ActionManage`/`ActionUpdate`/`ActionDelete`/`ActionCreate`. Any future write-capable MCP tool gated on those permissions will automatically be admin-only without needing per-tool checks. +- **Client tokens:** API client sessions must also include the `mcp` resource (or a wildcard) in their session scope; the ACL grant alone is not sufficient. +- **Auth model:** request-level. The handler runs `Auth(c, acl.ResourceMCP, acl.ActionView)` followed by `s.Abort(c)`, which writes the matching status code (`401` unauthenticated, `403` ACL deny, `429` rate-limited) and returns `true` so the handler can `return` early. +- **Public mode:** anonymous access is permitted. In public mode, `api.Session()` returns the default public session (effectively admin), so `Auth(...)` passes and the currently registered read-only tools are reachable without a token. This is an intentional, narrow allowance for demo deployments (`demo.photoprism.app`); it is safe only because every registered tool today returns static reference metadata derived from `config.Flags` and `form.Report(&form.SearchPhotos{})` — no database access, no per-user state, no secrets, no mutations. **Any future tool that touches per-user state, the database, or mutates anything MUST NOT be registered on this server without an additional per-tool check**. See *Extending the Tool Surface* below. +- **Stdio transport:** no authentication for the currently registered read-only tools — the trust boundary is the OS process pipe between client and server, and the spawning shell already has full PhotoPrism access on the host. The same static-data contract that makes public-mode HTTP safe makes stdio safe. **Any future write-capable, destructive, or per-user tool MUST require a session token on stdio too** (for example via `PHOTOPRISM_MCP_TOKEN` or a `--session` flag, validated through the same `Auth(...)` path the HTTP handler uses), so a misbehaving or prompt-injected MCP client cannot destroy data the user did not explicitly authorize. See *Extending the Tool Surface* below. + +### Rate Limiting + +The MCP handler does not install a custom rate limiter — there is no per-endpoint bucket. Coverage depends on the edition: + +| Build | Generic per-IP HTTP limiter? | Notes | +|--------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CE | no | Only the admin/client auth check protects the endpoint. In public mode all callers are anonymous, so CE deployments that run with `--public` have no per-request throttle in front of MCP. | +| Plus | no | Same as CE. The IPS middleware exists but only consumes tokens on known scanner/exploit paths, so it does not throttle MCP traffic. | +| Pro | yes | `pro/internal/server/register.go` calls `router.Use(limiter.Middleware(limiter.NewLimit(rate.Every(secOpt.RequestInterval), secOpt.RequestLimit)))` when both options are set. The limiter is per client IP and applies to every API endpoint, MCP included. | +| Portal | yes | Same wiring as Pro in `portal/internal/server/register.go`. | + +A per-endpoint limiter (via `limiter.Auth` / `limiter.Login` / `limiter.AbortJSON`) is only worth adding when MCP grows write-capable tools or endpoints that warrant stricter throttling than the generic IP limiter — for example, anything that mutates state or that triggers expensive backend work. + +CE and Plus deployments that expose the endpoint to untrusted networks should enforce per-IP request limits at the reverse proxy. The application-level `McpSessionTimeout` (5 minutes) and `MaxMCPRequestBytes` (256 KiB) bound the per-session memory footprint and per-request allocation, but they do not throttle request frequency; a proxy rule (for example nginx `limit_req_zone` or Traefik `rateLimit` middleware) is the recommended companion control in builds without a generic HTTP limiter. + +### Scope Plumbing + +`mcp` is the canonical scope token for `ResourceMCP`. The relevant pieces: + +- **Sanitization:** `pkg/clean.Scope` lowercases the input and parses it through `pkg/list.ParseAttr`. There is no allowlist of valid scope tokens, so `--scope mcp`, `--scope "mcp metrics"`, and `--scope "*"` are all accepted by `clients add` and `auth add` without any registry update. +- **Authorization:** `internal/auth/acl.ScopePermits` checks the parsed attribute list against the resource string. Because `acl.ResourceMCP.String() == "mcp"`, the existing `attr.Contains(...)` path matches a session that holds the `mcp` token. See `TestScopePermits/MCPScope` in `internal/auth/acl/scope_test.go` for the canonical assertions (admin token, mixed scopes, case-insensitivity, deny on unrelated scopes). +- **Cluster JWTs:** instance-side validation runs through `Config.JWTAllowedScopes()` (`internal/api/api_auth_jwt.go`). The default allowlist is `DefaultJWTAllowedScopes = "config cluster vision metrics mcp"` in `internal/config/config_cluster.go`, so portal-issued JWTs with `scope=mcp` are accepted out of the box. Operators that override the list via `--jwt-scope` / `PHOTOPRISM_JWT_SCOPE` need to include `mcp` themselves. + +### Extending the Tool Surface + +Anonymous access in public mode is only safe as long as every registered tool returns static reference metadata. Before adding a new tool, confirm it fits the existing contract: + +- No database reads or writes. +- No per-user state (albums, photos, sessions, settings). +- No filesystem, network, or subprocess side effects. +- No access to secrets or runtime config values (only flag schema/defaults are allowed). + +If a proposed tool does **not** fit that contract, do not register it on the default `*sdkmcp.Server`. Instead, take one of these paths (ordered by how much work they are): + +1. **Two servers, one factory.** `internal/api/mcp.go` already passes a factory to `sdkmcp.NewStreamableHTTPHandler`. Build a second server with the full tool set and return it from the factory only when the request is non-public and authenticated; keep the default server restricted to the public-safe tools. Policy becomes declarative at construction time, and a missing tool in the public server surfaces as a standard "tool not found" from the SDK rather than leaking its existence. +2. **Per-tool context checks.** `sdkmcp.AddTool` closures receive a `*sdkmcp.CallToolRequest`; stash caller context on the MCP session at `initialize` and reject inside the tool closure when public mode is active or the ACL deny list applies. Use this when the same tool has different output per caller (e.g. admin sees raw values, client sees redacted). +3. **SDK middleware.** For cross-cutting concerns such as per-tool rate limits or structured audit entries, wire an `sdkmcp.Middleware` that inspects the JSON-RPC method and tool name before dispatch. + +When the new tool needs an authenticated stdio session (any write-capable, destructive, or per-user tool), apply the same gate to `mcp serve`: + +4. **Spawn-time session token.** Accept the token via `PHOTOPRISM_MCP_TOKEN` or a `--session` CLI flag in `internal/commands/mcp.go`, resolve it through the same `Auth(...)` path the HTTP handler uses (`acl.ResourceMCP` + the appropriate `Action*`), and pass the resolved session into the factory the same way the HTTP handler does. No token → static-data server (current behavior, unchanged); valid token → role-scoped server. The two-server factory from option 1 still applies — only the gate keying differs. + +Cross-cutting MCP primitives that protect *every* transport (and SHOULD be applied whenever they fit): + +- **Roots.** Server-enforce the client's `initialize`-time `roots` for any tool that walks the catalog (albums, folders, files). Never trust the client to keep itself in scope. +- **`destructiveHint` annotation.** Mark high-blast-radius tools (`delete_album`, `wipe_index`, `reset_users`) with `annotations.destructiveHint: true` so MCP-aware UIs warn the human before approving the call. +- **`elicitation/create` for confirmation.** For destructive calls, ask the host to elicit human consent before mutating — the MCP-native equivalent of the `--yes` flag the destructive CLI commands already require. + +Whichever path you pick, **add a test in `internal/mcp/server_test.go` that fails if the restricted tool shows up in `tools/list` or is callable over the public path or an unauthenticated stdio session**, and update the *Available Tools* table below. + +### How Users Get Access + +Regular user accounts (`RoleUser`, `RoleViewer`, etc.) are intentionally **not** in the `ResourceMCP` ACL. Regular users typically don't have shell access to the server, so they can't run the CLI commands themselves — and the currently registered tools only return static reference data, so there's no per-user information to authorize against. Access is therefore granted through admin-issued client tokens. + +To onboard a user (or a CI job, IDE, etc.), an administrator runs the following on the PhotoPrism server: + +```bash +./photoprism clients add \ + --name "Alice's IDE" \ + --scope mcp \ + --role client \ + --expires 2592000 # 30 days; use -1 for no expiry +``` + +The command prints a client ID and secret. Combine them into a bearer token (or pass them through the OAuth2 client-credentials flow) and paste the resulting value into the user's MCP client config — the same JSON snippets shown above under *MCP Client Compatibility* apply unchanged. Replace `<admin-token>` with the issued token. + +To revoke access without disabling the user account, the administrator runs: + +```bash +./photoprism clients remove <client-id> +``` + +> **Heads up:** `photoprism auth add --scope mcp <username>` creates an *app password* tied to a user account, but it currently does **not** grant MCP access — `RoleUser` is not in the `ResourceMCP` ACL. Use `photoprism clients add` for MCP integrations until that policy changes. This is a deliberate hold, not an oversight. + +When MCP eventually grows tools that need user-scoped data (e.g. "list my albums"), the team will revisit the policy and likely add `RoleUser → GrantSearchAll` so the app-password path lights up. Until then, every MCP integration is an admin-provisioned client token tied to a named application. diff --git a/internal/mcp/data.go b/internal/mcp/data.go new file mode 100644 index 000000000..45567bb53 --- /dev/null +++ b/internal/mcp/data.go @@ -0,0 +1,157 @@ +package mcp + +import ( + "sort" + "strings" + + "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/form" +) + +// Resource URIs advertised to MCP clients. Each one maps to a JSON +// payload built from internal PhotoPrism reference data and registered +// in resources.go. +const ( + // configOptionsURI is the URI of the "config-options" resource, + // which mirrors the `photoprism show config-options` CLI report. + configOptionsURI = "photoprism://config-options" + // searchFiltersURI is the URI of the "search-filters" resource, + // which mirrors the `photoprism show search-filters` CLI report. + searchFiltersURI = "photoprism://search-filters" +) + +// Dataset caches the static MCP data returned by resources and tools. +type Dataset struct { + CurrentEdition string + ConfigOptions []ConfigOption + SearchFilters []SearchFilter +} + +// ConfigOption represents a single config option report row with section metadata. +type ConfigOption struct { + Section string `json:"section"` + Environment string `json:"environment"` + CLIFlag string `json:"cli_flag"` + Default string `json:"default"` + Description string `json:"description"` + Tags []string `json:"-"` +} + +// SearchFilter represents a single search filter report row. +type SearchFilter struct { + Filter string `json:"filter"` + Type string `json:"type"` + Examples string `json:"examples"` + Notes string `json:"notes"` +} + +// ConfigOptionsResource contains the JSON payload for the config-options resource. +type ConfigOptionsResource struct { + Edition string `json:"edition"` + Items []ConfigOption `json:"items"` +} + +// SearchFiltersResource contains the JSON payload for the search-filters resource. +type SearchFiltersResource struct { + Edition string `json:"edition"` + Items []SearchFilter `json:"items"` +} + +// NewDataset builds the static MCP dataset for the current build. +func NewDataset(currentEdition string) *Dataset { + return &Dataset{ + CurrentEdition: normalizeEdition(currentEdition), + ConfigOptions: buildConfigOptions(), + SearchFilters: buildSearchFilters(), + } +} + +// buildConfigOptions walks config.Flags and returns one ConfigOption per +// non-hidden flag, with the originating section title attached. Section +// titles come from config.OptionsReportSections; each section declares one +// or more "start" env vars that mark where the section begins in the flag +// list. Flags encountered before the first known start env var inherit an +// empty section, matching the layout of the `photoprism show config-*` +// CLI reports. +func buildConfigOptions() []ConfigOption { + // Index section start env vars by the exact env var name for O(1) + // lookup while iterating flags below. + sectionStarts := make(map[string]string) + + for _, section := range config.OptionsReportSections { + for key := range strings.SplitSeq(section.Start, ", ") { + sectionStarts[key] = section.Title + } + } + + items := make([]ConfigOption, 0, len(config.Flags)) + currentSection := "" + + for _, flag := range config.Flags { + if flag.Hidden() { + continue + } + + envVar := flag.EnvVar() + + // Update the section title whenever we cross a section boundary. + if title, ok := sectionStarts[envVar]; ok { + currentSection = title + } + + items = append(items, ConfigOption{ + Section: currentSection, + Environment: envVar, + CLIFlag: flag.CommandFlag(), + Default: flag.Default(), + Description: flag.Usage(), + Tags: flag.Tags, + }) + } + + return items +} + +// buildSearchFilters runs the existing search-filter report against +// form.SearchPhotos and returns the rows sorted by (type, filter) for +// deterministic MCP output. Rows with fewer than four columns are +// dropped defensively in case the report shape ever changes. +func buildSearchFilters() []SearchFilter { + rows, _ := form.Report(&form.SearchPhotos{}) + + sort.Slice(rows, func(i, j int) bool { + if rows[i][1] == rows[j][1] { + return rows[i][0] < rows[j][0] + } + + return rows[i][1] < rows[j][1] + }) + + items := make([]SearchFilter, 0, len(rows)) + + for _, row := range rows { + if len(row) < 4 { + continue + } + + items = append(items, SearchFilter{ + Filter: row[0], + Type: row[1], + Examples: row[2], + Notes: row[3], + }) + } + + return items +} + +// normalizeEdition returns a lowercase edition identifier suitable for MCP output. +func normalizeEdition(edition string) string { + edition = strings.TrimSpace(strings.ToLower(edition)) + + if edition == "" { + return "unknown" + } + + return edition +} diff --git a/internal/mcp/data_test.go b/internal/mcp/data_test.go new file mode 100644 index 000000000..b4d0b3b50 --- /dev/null +++ b/internal/mcp/data_test.go @@ -0,0 +1,170 @@ +package mcp + +import ( + "strings" + "testing" + + "github.com/stretchr/testify/require" + "github.com/urfave/cli/v2" + + "github.com/photoprism/photoprism/internal/config" +) + +// TestBuildConfigOptions asserts that every non-hidden config flag +// surfaced by buildConfigOptions carries a section title, environment +// variable, and CLI flag. +func TestBuildConfigOptions(t *testing.T) { + items := buildConfigOptions() + require.NotEmpty(t, items, "buildConfigOptions must return items") + + for i, item := range items { + require.NotEmpty(t, item.Environment, "item %d must have an environment variable", i) + require.NotEmpty(t, item.CLIFlag, "item %d must have a CLI flag", i) + require.NotEmpty(t, item.Section, "item %d (%s) must have a section", i, item.Environment) + } +} + +// TestBuildSearchFilters asserts that every search filter row surfaced +// by buildSearchFilters carries a filter name and type. +func TestBuildSearchFilters(t *testing.T) { + items := buildSearchFilters() + require.NotEmpty(t, items, "buildSearchFilters must return items") + + for i, item := range items { + require.NotEmpty(t, item.Filter, "item %d must have a filter name", i) + require.NotEmpty(t, item.Type, "item %d must have a type", i) + } +} + +// TestNormalizeEdition covers trimming, case-folding, and the empty-input +// fallback to "unknown" in normalizeEdition. +func TestNormalizeEdition(t *testing.T) { + tests := []struct { + input string + expected string + }{ + {"", "unknown"}, + {" ", "unknown"}, + {"CE", "ce"}, + {"pro", "pro"}, + {" Plus ", "plus"}, + {"Portal", "portal"}, + } + + for _, tc := range tests { + t.Run(tc.input, func(t *testing.T) { + require.Equal(t, tc.expected, normalizeEdition(tc.input)) + }) + } +} + +// TestBuildConfigOptionsReturnsDocumentedDefaults pins the dataset +// contract that backs photoprism://config-options and list_config_keys: +// the rows reflect the documented defaults compiled into the binary, +// never the runtime values an operator supplies through environment +// variables. Each marker below maps to one Secret-annotated flag whose +// Default field must remain empty regardless of the env override. +func TestBuildConfigOptionsReturnsDocumentedDefaults(t *testing.T) { + const ( + adminMarker = "TestBuildConfigOptionsReturnsDocumentedDefaults-admin" + dbMarker = "TestBuildConfigOptionsReturnsDocumentedDefaults-db" + oidcMarker = "TestBuildConfigOptionsReturnsDocumentedDefaults-oidc" + joinMarker = "TestBuildConfigOptionsReturnsDocumentedDefaults-join" + downloadMarker = "TestBuildConfigOptionsReturnsDocumentedDefaults-download" + previewMarker = "TestBuildConfigOptionsReturnsDocumentedDefaults-preview" + visionMarker = "TestBuildConfigOptionsReturnsDocumentedDefaults-vision" + ) + + env := map[string]string{ + "PHOTOPRISM_ADMIN_PASSWORD": adminMarker, + "PHOTOPRISM_DATABASE_PASSWORD": dbMarker, + "PHOTOPRISM_OIDC_SECRET": oidcMarker, + "PHOTOPRISM_JOIN_TOKEN": joinMarker, + "PHOTOPRISM_DOWNLOAD_TOKEN": downloadMarker, + "PHOTOPRISM_PREVIEW_TOKEN": previewMarker, + "PHOTOPRISM_VISION_KEY": visionMarker, + } + + for k, v := range env { + t.Setenv(k, v) + } + + app := cli.NewApp() + app.Flags = config.Flags.Cli() + app.Action = func(*cli.Context) error { return nil } + require.NoError(t, app.Run([]string{"photoprism"})) + + items := buildConfigOptions() + require.NotEmpty(t, items) + + markers := []string{adminMarker, dbMarker, oidcMarker, joinMarker, downloadMarker, previewMarker, visionMarker} + + for _, item := range items { + fields := []struct { + name string + value string + }{ + {"Environment", item.Environment}, + {"CLIFlag", item.CLIFlag}, + {"Default", item.Default}, + {"Description", item.Description}, + } + + for _, f := range fields { + for _, marker := range markers { + require.NotContains(t, f.value, marker, + "item %s field %s echoed runtime value %q", item.Environment, f.name, marker) + } + } + } + + expectEmpty := map[string]struct{}{ + "PHOTOPRISM_ADMIN_PASSWORD": {}, + "PHOTOPRISM_DATABASE_PASSWORD": {}, + "PHOTOPRISM_OIDC_SECRET": {}, + "PHOTOPRISM_JOIN_TOKEN": {}, + "PHOTOPRISM_DOWNLOAD_TOKEN": {}, + "PHOTOPRISM_PREVIEW_TOKEN": {}, + "PHOTOPRISM_VISION_KEY": {}, + } + + for _, item := range items { + for envVar := range expectEmpty { + if !strings.Contains(item.Environment, envVar) { + continue + } + + require.Empty(t, item.Default, + "flag %s must surface an empty Default; got %q", item.Environment, item.Default) + } + } +} + +// TestEditionSupportFor exercises the tag-to-edition mapping that drives +// the edition_support hint returned by list_config_keys, including the +// "unknown" short-circuit and the priority order (portal > pro > plus > +// essentials > all). +func TestEditionSupportFor(t *testing.T) { + tests := []struct { + name string + tags []string + currentEdition string + expected string + }{ + {"NoTags", nil, "ce", "all"}, + {"EmptyTags", []string{}, "ce", "all"}, + {"Portal", []string{"portal"}, "pro", "portal"}, + {"Pro", []string{"pro"}, "pro", "pro"}, + {"Plus", []string{"plus"}, "pro", "plus"}, + {"Essentials", []string{"essentials"}, "pro", "essentials"}, + {"UnknownEdition", []string{"pro"}, "unknown", "unknown"}, + {"UnrelatedTag", []string{"sponsor"}, "ce", "all"}, + } + + for _, tc := range tests { + t.Run(tc.name, func(t *testing.T) { + option := ConfigOption{Tags: tc.tags} + require.Equal(t, tc.expected, editionSupportFor(option, tc.currentEdition)) + }) + } +} diff --git a/internal/mcp/mcp.go b/internal/mcp/mcp.go new file mode 100644 index 000000000..0db06b97d --- /dev/null +++ b/internal/mcp/mcp.go @@ -0,0 +1,27 @@ +/* +Package mcp implements the PhotoPrism Model Context Protocol (MCP) server, +which exposes read-only reference data (config options and search filters) +to MCP-aware clients over both stdio and authenticated Streamable HTTP. + +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. + + This program is free software: you can redistribute it and/or modify + it under Version 3 of the GNU Affero General Public License (the "AGPL"): + <https://docs.photoprism.app/license/agpl> + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + The AGPL is supplemented by our Trademark and Brand Guidelines, + which describe how our Brand Assets may be used: + <https://www.photoprism.app/trademark/> + +Feel free to send an email to hello@photoprism.app if you have questions, +want to support our work, or just want to say hello. + +Additional information can be found in our Developer Guide: +<https://docs.photoprism.app/developer-guide/> +*/ +package mcp diff --git a/internal/mcp/resources.go b/internal/mcp/resources.go new file mode 100644 index 000000000..96e9db591 --- /dev/null +++ b/internal/mcp/resources.go @@ -0,0 +1,59 @@ +package mcp + +import ( + "context" + "encoding/json" + + sdkmcp "github.com/modelcontextprotocol/go-sdk/mcp" + + "github.com/photoprism/photoprism/pkg/http/header" +) + +// registerResources registers every read-only resource exposed by the +// server against the shared *Dataset. The order matches ResourceURIs so +// the startup log and the SDK's resources/list response stay in sync. +func registerResources(server *sdkmcp.Server, data *Dataset) { + server.AddResource(&sdkmcp.Resource{ + URI: configOptionsURI, + Name: "config-options", + Title: "PhotoPrism Config Options", + Description: "Read-only config options derived from the existing config report.", + MIMEType: header.ContentTypeJson, + }, func(_ context.Context, req *sdkmcp.ReadResourceRequest) (*sdkmcp.ReadResourceResult, error) { + return newResourceResult(req.Params.URI, ConfigOptionsResource{ + Edition: data.CurrentEdition, + Items: data.ConfigOptions, + }) + }) + + server.AddResource(&sdkmcp.Resource{ + URI: searchFiltersURI, + Name: "search-filters", + Title: "PhotoPrism Search Filters", + Description: "Read-only search filter reference derived from the existing search report.", + MIMEType: header.ContentTypeJson, + }, func(_ context.Context, req *sdkmcp.ReadResourceRequest) (*sdkmcp.ReadResourceResult, error) { + return newResourceResult(req.Params.URI, SearchFiltersResource{ + Edition: data.CurrentEdition, + Items: data.SearchFilters, + }) + }) +} + +// newResourceResult marshals payload to indented JSON and wraps it in an +// MCP ReadResourceResult with the given URI and header.ContentTypeJson as +// the advertised MIME type. Returns an error if JSON marshaling fails. +func newResourceResult(uri string, payload any) (*sdkmcp.ReadResourceResult, error) { + body, err := json.MarshalIndent(payload, "", " ") + if err != nil { + return nil, err + } + + return &sdkmcp.ReadResourceResult{ + Contents: []*sdkmcp.ResourceContents{{ + URI: uri, + MIMEType: header.ContentTypeJson, + Text: string(body), + }}, + }, nil +} diff --git a/internal/mcp/server.go b/internal/mcp/server.go new file mode 100644 index 000000000..82332eef9 --- /dev/null +++ b/internal/mcp/server.go @@ -0,0 +1,34 @@ +package mcp + +import sdkmcp "github.com/modelcontextprotocol/go-sdk/mcp" + +// ToolNames lists the read-only tools registered on the MCP server in the +// order they are added. Callers use it for startup logging and tests that +// need to assert the registered tool surface. +var ToolNames = []string{ + "list_config_keys", + "find_search_filters", +} + +// ResourceURIs lists the read-only resource URIs registered on the MCP +// server in the order they are added. Callers use it for startup logging +// and tests that need to assert the registered resource surface. +var ResourceURIs = []string{ + configOptionsURI, + searchFiltersURI, +} + +// NewServer returns a fully configured read-only MCP server that exposes +// the static PhotoPrism reference data (config options and search filters) +// described by ToolNames and ResourceURIs. The implementation struct is +// reported back to MCP clients as the server's identity; currentEdition +// is normalized and embedded in the resource payloads and tool responses. +func NewServer(implementation *sdkmcp.Implementation, currentEdition string) *sdkmcp.Server { + server := sdkmcp.NewServer(implementation, nil) + data := NewDataset(currentEdition) + + registerResources(server, data) + registerTools(server, data) + + return server +} diff --git a/internal/mcp/server_test.go b/internal/mcp/server_test.go new file mode 100644 index 000000000..c390bee86 --- /dev/null +++ b/internal/mcp/server_test.go @@ -0,0 +1,454 @@ +package mcp + +import ( + "context" + "encoding/json" + "strings" + "testing" + + sdkmcp "github.com/modelcontextprotocol/go-sdk/mcp" + "github.com/stretchr/testify/require" +) + +// connectTestClient connects an in-memory client to the MCP server. +func connectTestClient(t *testing.T) *sdkmcp.ClientSession { + t.Helper() + + ctx := context.Background() + server := NewServer(&sdkmcp.Implementation{Name: "photoprism-mcp", Version: "test"}, "ce") + client := sdkmcp.NewClient(&sdkmcp.Implementation{Name: "photoprism-mcp-test", Version: "test"}, nil) + serverTransport, clientTransport := sdkmcp.NewInMemoryTransports() + + _, err := server.Connect(ctx, serverTransport, nil) + require.NoError(t, err) + + session, err := client.Connect(ctx, clientTransport, nil) + require.NoError(t, err) + + t.Cleanup(func() { + require.NoError(t, session.Close()) + }) + + return session +} + +// TestNewServerResources lists and reads the registered MCP resources, +// asserting that every URI advertised in ResourceURIs is exposed in the +// declared order and returns a non-empty JSON payload. +func TestNewServerResources(t *testing.T) { + ctx := context.Background() + session := connectTestClient(t) + + resources, err := session.ListResources(ctx, nil) + require.NoError(t, err) + require.Len(t, resources.Resources, len(ResourceURIs)) + for i, uri := range ResourceURIs { + require.Equal(t, uri, resources.Resources[i].URI) + } + + configResource, err := session.ReadResource(ctx, &sdkmcp.ReadResourceParams{URI: configOptionsURI}) + require.NoError(t, err) + require.Len(t, configResource.Contents, 1) + + var configPayload ConfigOptionsResource + require.NoError(t, json.Unmarshal([]byte(configResource.Contents[0].Text), &configPayload)) + require.NotEmpty(t, configPayload.Items) + require.Equal(t, "ce", configPayload.Edition) + + filterResource, err := session.ReadResource(ctx, &sdkmcp.ReadResourceParams{URI: searchFiltersURI}) + require.NoError(t, err) + require.Len(t, filterResource.Contents, 1) + + var filterPayload SearchFiltersResource + require.NoError(t, json.Unmarshal([]byte(filterResource.Contents[0].Text), &filterPayload)) + require.NotEmpty(t, filterPayload.Items) + require.Equal(t, "ce", filterPayload.Edition) +} + +// TestNewServerToolList asserts that the server advertises exactly the +// tools listed in ToolNames and that every tool carries a JSON schema. +func TestNewServerToolList(t *testing.T) { + ctx := context.Background() + session := connectTestClient(t) + + tools, err := session.ListTools(ctx, nil) + require.NoError(t, err) + require.Len(t, tools.Tools, len(ToolNames)) + + names := make([]string, 0, len(tools.Tools)) + for _, tool := range tools.Tools { + names = append(names, tool.Name) + require.NotNil(t, tool.InputSchema) + } + for _, expected := range ToolNames { + require.Contains(t, names, expected) + } +} + +// TestListConfigKeysTool exercises successful, empty, and invalid tool calls. +func TestListConfigKeysTool(t *testing.T) { + ctx := context.Background() + session := connectTestClient(t) + + t.Run("Success", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "list_config_keys", + Arguments: map[string]any{ + "query": "http", + "limit": 5, + }, + }) + require.NoError(t, err) + require.False(t, res.IsError) + require.NotNil(t, res.StructuredContent) + + raw, err := json.Marshal(res.StructuredContent) + require.NoError(t, err) + + var out ListConfigKeysOutput + require.NoError(t, json.Unmarshal(raw, &out)) + require.NotEmpty(t, out.Matches) + require.LessOrEqual(t, len(out.Matches), 5) + require.Equal(t, "all", out.EditionApplied) + }) + + t.Run("NoResults", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "list_config_keys", + Arguments: map[string]any{ + "query": "definitely-no-match", + }, + }) + require.NoError(t, err) + require.False(t, res.IsError) + + raw, err := json.Marshal(res.StructuredContent) + require.NoError(t, err) + + var out ListConfigKeysOutput + require.NoError(t, json.Unmarshal(raw, &out)) + require.Empty(t, out.Matches) + require.Zero(t, out.TotalMatches) + }) + + t.Run("InvalidInput", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "list_config_keys", + Arguments: map[string]any{ + "edition": "enterprise", + }, + }) + require.NoError(t, err) + require.True(t, res.IsError) + require.Len(t, res.Content, 1) + + text, ok := res.Content[0].(*sdkmcp.TextContent) + require.True(t, ok) + require.Contains(t, text.Text, "edition must be one of ce, plus, pro, portal, or all") + }) + + t.Run("RejectUnknownEdition", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "list_config_keys", + Arguments: map[string]any{ + "edition": "unknown", + }, + }) + require.NoError(t, err) + require.True(t, res.IsError) + }) +} + +// TestListConfigKeysValidation exercises edge cases for input validation. +func TestListConfigKeysValidation(t *testing.T) { + ctx := context.Background() + session := connectTestClient(t) + + t.Run("QueryTooLong", func(t *testing.T) { + longQuery := strings.Repeat("a", maxQueryLength+1) + + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "list_config_keys", + Arguments: map[string]any{ + "query": longQuery, + }, + }) + require.NoError(t, err) + require.True(t, res.IsError) + }) + + t.Run("WhitespaceQuery", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "list_config_keys", + Arguments: map[string]any{ + "query": " ", + }, + }) + require.NoError(t, err) + require.False(t, res.IsError) + + raw, err := json.Marshal(res.StructuredContent) + require.NoError(t, err) + + var out ListConfigKeysOutput + require.NoError(t, json.Unmarshal(raw, &out)) + require.NotEmpty(t, out.Matches, "whitespace-only query should match all") + }) + + t.Run("UnicodeQuery", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "list_config_keys", + Arguments: map[string]any{ + "query": "日本語", + }, + }) + require.NoError(t, err) + require.False(t, res.IsError) + }) + + t.Run("NegativeLimit", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "list_config_keys", + Arguments: map[string]any{ + "limit": -1, + }, + }) + require.NoError(t, err) + require.True(t, res.IsError) + }) + + t.Run("LimitCappedAtMax", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "list_config_keys", + Arguments: map[string]any{ + "limit": maxResultLimit + 10, + }, + }) + require.NoError(t, err) + require.False(t, res.IsError) + + raw, err := json.Marshal(res.StructuredContent) + require.NoError(t, err) + + var out ListConfigKeysOutput + require.NoError(t, json.Unmarshal(raw, &out)) + require.LessOrEqual(t, len(out.Matches), maxResultLimit) + }) + + t.Run("LimitExactlyMax", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "list_config_keys", + Arguments: map[string]any{ + "limit": maxResultLimit, + }, + }) + require.NoError(t, err) + require.False(t, res.IsError) + + raw, err := json.Marshal(res.StructuredContent) + require.NoError(t, err) + + var out ListConfigKeysOutput + require.NoError(t, json.Unmarshal(raw, &out)) + require.LessOrEqual(t, len(out.Matches), maxResultLimit) + }) + + t.Run("LimitOne", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "list_config_keys", + Arguments: map[string]any{ + "limit": 1, + }, + }) + require.NoError(t, err) + require.False(t, res.IsError) + + raw, err := json.Marshal(res.StructuredContent) + require.NoError(t, err) + + var out ListConfigKeysOutput + require.NoError(t, json.Unmarshal(raw, &out)) + require.Len(t, out.Matches, 1) + }) +} + +// TestFindSearchFiltersValidation exercises edge cases for search filter input validation. +func TestFindSearchFiltersValidation(t *testing.T) { + ctx := context.Background() + session := connectTestClient(t) + + t.Run("QueryTooLong", func(t *testing.T) { + longQuery := strings.Repeat("a", maxQueryLength+1) + + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "find_search_filters", + Arguments: map[string]any{ + "query": longQuery, + }, + }) + require.NoError(t, err) + require.True(t, res.IsError) + }) + + t.Run("WhitespaceQuery", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "find_search_filters", + Arguments: map[string]any{ + "query": " ", + }, + }) + require.NoError(t, err) + require.False(t, res.IsError) + + raw, err := json.Marshal(res.StructuredContent) + require.NoError(t, err) + + var out FindSearchFiltersOutput + require.NoError(t, json.Unmarshal(raw, &out)) + require.NotEmpty(t, out.Matches) + }) + + t.Run("UnicodeQuery", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "find_search_filters", + Arguments: map[string]any{ + "query": "日本語", + }, + }) + require.NoError(t, err) + require.False(t, res.IsError) + }) + + t.Run("NegativeLimit", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "find_search_filters", + Arguments: map[string]any{ + "limit": -1, + }, + }) + require.NoError(t, err) + require.True(t, res.IsError) + }) + + t.Run("LimitCappedAtMax", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "find_search_filters", + Arguments: map[string]any{ + "limit": maxResultLimit + 10, + }, + }) + require.NoError(t, err) + require.False(t, res.IsError) + + raw, err := json.Marshal(res.StructuredContent) + require.NoError(t, err) + + var out FindSearchFiltersOutput + require.NoError(t, json.Unmarshal(raw, &out)) + require.LessOrEqual(t, len(out.Matches), maxResultLimit) + }) + + t.Run("LimitOne", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "find_search_filters", + Arguments: map[string]any{ + "limit": 1, + }, + }) + require.NoError(t, err) + require.False(t, res.IsError) + + raw, err := json.Marshal(res.StructuredContent) + require.NoError(t, err) + + var out FindSearchFiltersOutput + require.NoError(t, json.Unmarshal(raw, &out)) + require.Len(t, out.Matches, 1) + require.True(t, out.Truncated, "limit=1 should truncate the full result set") + require.NotEmpty(t, out.Warnings, "truncated results should surface a warning") + require.Contains(t, out.Warnings[0], "results truncated to 1") + }) +} + +// TestFindSearchFiltersTool exercises search filter lookup behavior. +func TestFindSearchFiltersTool(t *testing.T) { + ctx := context.Background() + session := connectTestClient(t) + + t.Run("Success", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "find_search_filters", + Arguments: map[string]any{ + "query": "Berlin", + "limit": 5, + }, + }) + require.NoError(t, err) + require.False(t, res.IsError) + + raw, err := json.Marshal(res.StructuredContent) + require.NoError(t, err) + + var out FindSearchFiltersOutput + require.NoError(t, json.Unmarshal(raw, &out)) + require.NotEmpty(t, out.Matches) + require.Equal(t, "all", out.TypeApplied) + require.False(t, out.Truncated, "Berlin query should fit in limit=5") + require.Empty(t, out.Warnings, "non-truncated results should not emit warnings") + }) + + t.Run("FilterByType", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "find_search_filters", + Arguments: map[string]any{ + "type": "switch", + "query": "hidden", + }, + }) + require.NoError(t, err) + require.False(t, res.IsError) + + raw, err := json.Marshal(res.StructuredContent) + require.NoError(t, err) + + var out FindSearchFiltersOutput + require.NoError(t, json.Unmarshal(raw, &out)) + require.NotEmpty(t, out.Matches) + require.Equal(t, "switch", out.TypeApplied) + }) + + t.Run("NoResults", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "find_search_filters", + Arguments: map[string]any{ + "query": "definitely-no-match", + }, + }) + require.NoError(t, err) + require.False(t, res.IsError) + + raw, err := json.Marshal(res.StructuredContent) + require.NoError(t, err) + + var out FindSearchFiltersOutput + require.NoError(t, json.Unmarshal(raw, &out)) + require.Empty(t, out.Matches) + require.Zero(t, out.TotalMatches) + }) + + t.Run("InvalidType", func(t *testing.T) { + res, err := session.CallTool(ctx, &sdkmcp.CallToolParams{ + Name: "find_search_filters", + Arguments: map[string]any{ + "type": "boolean", + }, + }) + require.NoError(t, err) + require.True(t, res.IsError) + require.Len(t, res.Content, 1) + + text, ok := res.Content[0].(*sdkmcp.TextContent) + require.True(t, ok) + require.Contains(t, text.Text, "type must be one of decimal, number, string, switch, timestamp, or all") + }) +} diff --git a/internal/mcp/tool_config_keys.go b/internal/mcp/tool_config_keys.go new file mode 100644 index 000000000..a068024f3 --- /dev/null +++ b/internal/mcp/tool_config_keys.go @@ -0,0 +1,258 @@ +package mcp + +import ( + "context" + "fmt" + "strings" + + sdkmcp "github.com/modelcontextprotocol/go-sdk/mcp" +) + +// Result and input limits shared by every MCP tool registered on the server. +// They keep responses compact enough for LLM clients and prevent input-size +// abuse on substring-based matching. +const ( + // defaultResultLimit is the number of matches returned when a tool + // call does not specify an explicit "limit" argument. + defaultResultLimit = 20 + // maxResultLimit is the hard upper bound applied to any "limit" + // argument larger than this value. + maxResultLimit = 50 + // maxQueryLength is the maximum length of any free-text input + // ("query", "section", …) accepted by a tool. + maxQueryLength = 200 +) + +// allowedEditions is the closed allowlist of values accepted by the +// "edition" argument of list_config_keys. An empty edition defaults to +// "all"; anything outside this set is rejected with a validation error. +var allowedEditions = map[string]struct{}{ + "all": {}, + "ce": {}, + "plus": {}, + "pro": {}, + "portal": {}, +} + +// ListConfigKeysInput defines the supported inputs for the config lookup tool. +type ListConfigKeysInput struct { + Section string `json:"section,omitempty" jsonschema:"optional section title filter"` + Query string `json:"query,omitempty" jsonschema:"optional case-insensitive search query"` + Edition string `json:"edition,omitempty" jsonschema:"optional edition: ce, plus, pro, portal, or all"` + Limit int `json:"limit,omitempty" jsonschema:"optional maximum number of matches to return"` +} + +// ListConfigKeysOutput defines the structured output for the config lookup tool. +type ListConfigKeysOutput struct { + Matches []ConfigKeyMatch `json:"matches"` + TotalMatches int `json:"total_matches"` + Truncated bool `json:"truncated"` + QueryApplied string `json:"query_applied,omitempty"` + SectionApplied string `json:"section_applied,omitempty"` + EditionApplied string `json:"edition_applied"` + Warnings []string `json:"warnings,omitempty"` +} + +// ConfigKeyMatch represents a single config option match returned by the tool. +type ConfigKeyMatch struct { + Section string `json:"section"` + Environment string `json:"environment"` + CLIFlag string `json:"cli_flag"` + Default string `json:"default"` + Description string `json:"description"` + EditionSupport string `json:"edition_support"` +} + +// registerTools registers every read-only tool exposed by the server +// against the shared *Dataset. The order matches ToolNames so the +// startup log and the SDK's tools/list response stay in sync. +func registerTools(server *sdkmcp.Server, data *Dataset) { + sdkmcp.AddTool(server, &sdkmcp.Tool{ + Name: "list_config_keys", + Description: "Lists read-only PhotoPrism config keys from the existing config report.", + }, func(ctx context.Context, req *sdkmcp.CallToolRequest, input ListConfigKeysInput) (*sdkmcp.CallToolResult, ListConfigKeysOutput, error) { + return listConfigKeys(ctx, req, input, data) + }) + + sdkmcp.AddTool(server, &sdkmcp.Tool{ + Name: "find_search_filters", + Description: "Finds PhotoPrism search filters from the existing search filter reference.", + }, func(ctx context.Context, req *sdkmcp.CallToolRequest, input FindSearchFiltersInput) (*sdkmcp.CallToolResult, FindSearchFiltersOutput, error) { + return findSearchFilters(ctx, req, input, data) + }) +} + +// listConfigKeys validates the caller's input, applies the section/query +// filters over data.ConfigOptions, and returns at most `limit` matches +// alongside the total match count. When an explicit edition filter is +// supplied and differs from the current build, an advisory warning is +// attached to the response. +func listConfigKeys(_ context.Context, _ *sdkmcp.CallToolRequest, input ListConfigKeysInput, data *Dataset) (*sdkmcp.CallToolResult, ListConfigKeysOutput, error) { + edition, err := validateEdition(input.Edition) + if err != nil { + return nil, ListConfigKeysOutput{}, err + } + + limit, err := validateLimit(input.Limit) + if err != nil { + return nil, ListConfigKeysOutput{}, err + } + + query, err := validateString("query", input.Query) + if err != nil { + return nil, ListConfigKeysOutput{}, err + } + + section, err := validateString("section", input.Section) + if err != nil { + return nil, ListConfigKeysOutput{}, err + } + matches := make([]ConfigKeyMatch, 0, limit) + total := 0 + + for _, option := range data.ConfigOptions { + if !matchesSection(option, section) { + continue + } + + if !matchesQuery(option, query) { + continue + } + + total++ + + if len(matches) < limit { + matches = append(matches, ConfigKeyMatch{ + Section: option.Section, + Environment: option.Environment, + CLIFlag: option.CLIFlag, + Default: option.Default, + Description: option.Description, + EditionSupport: editionSupportFor(option, data.CurrentEdition), + }) + } + } + + result := ListConfigKeysOutput{ + Matches: matches, + TotalMatches: total, + Truncated: total > len(matches), + QueryApplied: strings.TrimSpace(input.Query), + SectionApplied: strings.TrimSpace(input.Section), + EditionApplied: edition, + } + + if edition != "all" && edition != data.CurrentEdition { + result.Warnings = []string{ + fmt.Sprintf("edition filtering is advisory; results come from the current %s build metadata", data.CurrentEdition), + } + } + + return nil, result, nil +} + +// validateEdition normalizes the requested edition and checks it against +// allowedEditions. An empty input defaults to "all"; any value outside +// the allowlist yields a validation error surfaced to the caller. +func validateEdition(edition string) (string, error) { + if strings.TrimSpace(edition) == "" { + return "all", nil + } + + normalized := normalizeEdition(edition) + + if _, ok := allowedEditions[normalized]; !ok { + return "", fmt.Errorf("edition must be one of ce, plus, pro, portal, or all") + } + + return normalized, nil +} + +// validateLimit normalizes the requested result limit: zero becomes +// defaultResultLimit, values above maxResultLimit are clamped, and +// negative values are rejected with a validation error. +func validateLimit(limit int) (int, error) { + if limit == 0 { + return defaultResultLimit, nil + } + + if limit < 1 { + return 0, fmt.Errorf("limit must be greater than 0") + } + + if limit > maxResultLimit { + return maxResultLimit, nil + } + + return limit, nil +} + +// validateString validates and normalizes a free-text input field, using the +// supplied field name in error messages so callers can reuse it for query, +// section, or any other string parameter. +func validateString(field, value string) (string, error) { + value = strings.TrimSpace(strings.ToLower(value)) + + if len(value) > maxQueryLength { + return "", fmt.Errorf("%s must not exceed %d characters", field, maxQueryLength) + } + + return value, nil +} + +// matchesSection reports whether an option matches the requested section filter. +func matchesSection(option ConfigOption, section string) bool { + if section == "" { + return true + } + + return strings.Contains(strings.ToLower(option.Section), section) +} + +// matchesQuery reports whether an option matches the requested free-text query. +func matchesQuery(option ConfigOption, query string) bool { + if query == "" { + return true + } + + haystacks := []string{ + option.Environment, + option.CLIFlag, + option.Description, + } + + for _, haystack := range haystacks { + if strings.Contains(strings.ToLower(haystack), query) { + return true + } + } + + return false +} + +// editionSupportFor returns a conservative edition hint for a config +// option based on its flag tags. Returns "unknown" if the current build +// edition is unknown, the first matching tag in priority order +// (portal > pro > plus > essentials) when one is present, and "all" +// otherwise. The hint is advisory and reflects the tag metadata only, +// not runtime capability detection. +func editionSupportFor(option ConfigOption, currentEdition string) string { + if currentEdition == "unknown" { + return "unknown" + } + + if len(option.Tags) == 0 { + return "all" + } + + // Check tags in priority order (most restrictive first). + for _, tag := range []string{"portal", "pro", "plus", "essentials"} { + for _, t := range option.Tags { + if t == tag { + return tag + } + } + } + + return "all" +} diff --git a/internal/mcp/tool_search_filters.go b/internal/mcp/tool_search_filters.go new file mode 100644 index 000000000..a8cbc425d --- /dev/null +++ b/internal/mcp/tool_search_filters.go @@ -0,0 +1,154 @@ +package mcp + +import ( + "context" + "fmt" + "strings" + + sdkmcp "github.com/modelcontextprotocol/go-sdk/mcp" +) + +// truncationWarningTemplate is the fmt.Sprintf template used to populate +// the "warnings" field of a tool response when the number of matches +// exceeds the caller's limit. Arguments are: returned count, total count, +// hard upper bound (maxResultLimit). +const truncationWarningTemplate = "results truncated to %d of %d matches; raise the limit parameter (max %d) to retrieve more" + +// allowedSearchFilterTypes is the closed allowlist of values accepted by +// the "type" argument of find_search_filters. An empty type defaults to +// "all"; anything outside this set is rejected with a validation error. +var allowedSearchFilterTypes = map[string]struct{}{ + "all": {}, + "decimal": {}, + "number": {}, + "string": {}, + "switch": {}, + "timestamp": {}, +} + +// FindSearchFiltersInput defines the inputs for the search filter lookup tool. +type FindSearchFiltersInput struct { + Query string `json:"query,omitempty" jsonschema:"optional case-insensitive search query"` + Type string `json:"type,omitempty" jsonschema:"optional filter type: decimal, number, string, switch, timestamp, or all"` + Limit int `json:"limit,omitempty" jsonschema:"optional maximum number of matches to return"` +} + +// FindSearchFiltersOutput defines the structured output for the search filter lookup tool. +type FindSearchFiltersOutput struct { + Matches []SearchFilterMatch `json:"matches"` + TotalMatches int `json:"total_matches"` + Truncated bool `json:"truncated"` + QueryApplied string `json:"query_applied,omitempty"` + TypeApplied string `json:"type_applied"` + Warnings []string `json:"warnings,omitempty"` +} + +// SearchFilterMatch represents a single search filter match. +type SearchFilterMatch struct { + Filter string `json:"filter"` + Type string `json:"type"` + Examples string `json:"examples"` + Notes string `json:"notes"` +} + +// findSearchFilters validates the caller's input, applies the type and +// query filters over data.SearchFilters, and returns at most `limit` +// matches alongside the total match count. When the result is truncated, +// an actionable warning is attached to the response via +// truncationWarningTemplate. +func findSearchFilters(_ context.Context, _ *sdkmcp.CallToolRequest, input FindSearchFiltersInput, data *Dataset) (*sdkmcp.CallToolResult, FindSearchFiltersOutput, error) { + filterType, err := validateSearchFilterType(input.Type) + if err != nil { + return nil, FindSearchFiltersOutput{}, err + } + + limit, err := validateLimit(input.Limit) + if err != nil { + return nil, FindSearchFiltersOutput{}, err + } + + query, err := validateString("query", input.Query) + if err != nil { + return nil, FindSearchFiltersOutput{}, err + } + matches := make([]SearchFilterMatch, 0, limit) + total := 0 + + for _, filter := range data.SearchFilters { + if !matchesSearchFilterType(filter, filterType) { + continue + } + + if !matchesSearchFilterQuery(filter, query) { + continue + } + + total++ + + if len(matches) < limit { + matches = append(matches, SearchFilterMatch(filter)) + } + } + + result := FindSearchFiltersOutput{ + Matches: matches, + TotalMatches: total, + Truncated: total > len(matches), + QueryApplied: strings.TrimSpace(input.Query), + TypeApplied: filterType, + } + + if result.Truncated { + result.Warnings = append(result.Warnings, fmt.Sprintf(truncationWarningTemplate, len(matches), total, maxResultLimit)) + } + + return nil, result, nil +} + +// validateSearchFilterType normalizes the requested filter type and +// checks it against allowedSearchFilterTypes. An empty input defaults to +// "all"; any value outside the allowlist yields a validation error +// surfaced to the caller. +func validateSearchFilterType(filterType string) (string, error) { + if strings.TrimSpace(filterType) == "" { + return "all", nil + } + + normalized := strings.TrimSpace(strings.ToLower(filterType)) + + if _, ok := allowedSearchFilterTypes[normalized]; !ok { + return "", fmt.Errorf("type must be one of decimal, number, string, switch, timestamp, or all") + } + + return normalized, nil +} + +// matchesSearchFilterType reports whether the row matches the requested filter type. +func matchesSearchFilterType(filter SearchFilter, filterType string) bool { + if filterType == "" || filterType == "all" { + return true + } + + return strings.EqualFold(filter.Type, filterType) +} + +// matchesSearchFilterQuery reports whether the row matches the requested query. +func matchesSearchFilterQuery(filter SearchFilter, query string) bool { + if query == "" { + return true + } + + haystacks := []string{ + filter.Filter, + filter.Examples, + filter.Notes, + } + + for _, haystack := range haystacks { + if strings.Contains(strings.ToLower(haystack), query) { + return true + } + } + + return false +} diff --git a/internal/meta/README.md b/internal/meta/README.md index bd167b39c..d1b8f5530 100644 --- a/internal/meta/README.md +++ b/internal/meta/README.md @@ -1,6 +1,6 @@ ## PhotoPrism — Metadata Pipeline -**Last Updated:** February 11, 2026 +**Last Updated:** June 30, 2026 ### Overview @@ -27,7 +27,18 @@ The `internal/meta` package extracts, normalizes, and reports metadata from imag - Exif → XMP → JSON (ExifTool/GPhotos/motion) → filename → filesystem mtime. Each stage logs source and errors but continues when safe. - Brute-force Exif search is used when native parsers fail; errors are logged with context. -- GPS parsing supports decimal and DMS formats; regexes are kept simple and precompiled. +- GPS parsing supports decimal, DMS (`51 deg 15' 17.47" N`), and the 2-component Adobe XMP form (`52,30.4567N`); regexes are kept simple and precompiled. + +### XMP Sidecar Reader + +The `.xmp` sidecar reader (`xmp.go` + `xmp_document.go`) is XPath-based on `antchfx/xmlquery` and namespace-aware via `xpath.CompileWithNS`. Each accessor declares a `chainXPath` priority list; the engine evaluates links left-to-right and returns the first non-empty match. Composition (Lat sign from `GPSLatitudeRef`, sub-second join from `SubSecTimeOriginal`, etc.) lives in the relevant accessor — never in the chain engine. + +- **Loader security guards.** `Load` rejects sidecars larger than 1 MiB (`ErrXmpFileTooLarge`) and documents nesting deeper than 64 elements (`ErrXmpTooDeep`). XXE and DTD attacks are mitigated by `encoding/xml`'s default behavior (no external entity resolution); `xmp_security_test.go` is the regression guard. +- **Element-or-attribute helper.** RDF/XML allows scalar properties to be expressed as either child elements or attributes on `rdf:Description`. The `elemOrAttr(qname)` helper builds a union XPath that matches both — required because digiKam emits `xmpMM:*`/`exif:*`/`tiff:*` as attributes while Adobe writes them as child elements. +- **Adding an accessor.** Declare a `chainXPath` at package init using `mustCompile` (or `elemOrAttr` for scalar fields), document the priority chain in a one-line comment, then add the accessor that calls `firstNonEmpty` (for scalars) or `queryAll` (for `rdf:Bag`/`rdf:Seq`). Wire the new field into `xmp.go` with the existing "set only when non-empty" pattern. +- **Source priority.** Sidecar values are tagged `SrcXmp` (priority 32), which outranks `SrcMeta` (priority 16) at the entity layer. Re-indexing a photo after the sidecar has been added overwrites previously-`SrcMeta` values without a database wipe. +- **Keywords vs. Subject.** `dc:subject` (Adobe's "Keywords" panel) maps to the descriptive `Details.Subject` field — never the `Details.Keywords` field — matching the embedded/ExifTool path where `data.Subject` comes from the `dc:subject`-backed `Subject` tag and `data.Keywords` from IPTC `Keywords`. The XMP path adds only the derived `flash`/`panorama`/`hdr` keywords. Hierarchical-label and face-region parsing (Labels, people Subjects) is a planned extension tracked under epic [#2260](https://github.com/photoprism/photoprism/issues/2260). +- **Coverage.** The fixture corpus under `testdata/xmp/{adobe,darktable,digikam,synthetic}/` documents the full set of supported tags and their per-fixture provenance. ### Motion Photos & Embedded Media diff --git a/internal/meta/data.go b/internal/meta/data.go index f5cb2d5f3..957ae652a 100644 --- a/internal/meta/data.go +++ b/internal/meta/data.go @@ -15,6 +15,11 @@ const ( ) // Data represents image metadata. +// +// Note: the meta:"…", xmp:"…", and dc:"…" struct tags below are read by +// internal/meta/report.go via reflection to render the metadata-source +// columns of `photoprism show metadata-fields`. Do not delete them as +// "vestigial" — they are documentation that ships in the CLI report. type Data struct { FileName string `meta:"FileName"` MimeType string `meta:"MIMEType" report:"-"` @@ -34,7 +39,7 @@ type Data struct { FPS float64 `meta:"VideoFrameRate,VideoAvgFrameRate"` Frames int `meta:"FrameCount,AnimationFrames"` Pages int `meta:"PageCount,NPages,Pages"` - Codec string `meta:"CompressorID,VideoCodecID,CodecID,OtherFormat,FileType"` + Codec string `meta:"CompressorID,VideoCodecID,CodecID,OtherFormat,VideoCodec,FileType"` Title string `meta:"Title,Headline" xmp:"dc:title" dc:"title,title.Alt"` Caption string `meta:"Description,ImageDescription,Caption,Caption-Abstract" xmp:"Description,Description.Alt"` Subject string `meta:"Subject,PersonInImage,ObjectName,HierarchicalSubject,CatalogSets" xmp:"Subject"` diff --git a/internal/meta/gps.go b/internal/meta/gps.go index 401584da5..58a055de7 100644 --- a/internal/meta/gps.go +++ b/internal/meta/gps.go @@ -64,7 +64,10 @@ func GpsToLatLng(s string) (lat, lng float64) { return latDeg.Decimal(), lngDeg.Decimal() } -// GpsToDecimal returns the GPS latitude or longitude as decimal float point number. +// GpsToDecimal returns the GPS latitude or longitude as a decimal +// floating-point number. Accepted forms: pure decimal ("47.6754"), +// 3-component DMS ("51 deg 15' 17.47\" N"), and 2-component +// degrees+decimal-minutes ("52,30.4567N", as Adobe XMP commonly writes). func GpsToDecimal(s string) float64 { // Empty? if s == "" { @@ -80,18 +83,34 @@ func GpsToDecimal(s string) float64 { co := GpsCoordsRegexp.FindAllString(s, -1) re := GpsRefRegexp.FindAllString(s, -1) - if len(co) != 3 || len(re) != 1 { + if len(re) != 1 { return 0 } - latDeg := exif.GpsDegrees{ - Orientation: re[0][0], - Degrees: ParseFloat(co[0]), - Minutes: ParseFloat(co[1]), - Seconds: ParseFloat(co[2]), + switch len(co) { + case 2: + // Adobe XMP 2-component form: degrees, decimal-minutes, cardinal + // direction. Seconds are folded into the minutes value already. + deg := exif.GpsDegrees{ + Orientation: re[0][0], + Degrees: ParseFloat(co[0]), + Minutes: ParseFloat(co[1]), + Seconds: 0, + } + return deg.Decimal() + case 3: + // ExifTool / EXIF 3-component DMS form: degrees, minutes, + // seconds, cardinal direction. + deg := exif.GpsDegrees{ + Orientation: re[0][0], + Degrees: ParseFloat(co[0]), + Minutes: ParseFloat(co[1]), + Seconds: ParseFloat(co[2]), + } + return deg.Decimal() + default: + return 0 } - - return latDeg.Decimal() } // ParseFloat returns a single GPS coordinate value as floating point number (degree, minute or second). @@ -113,7 +132,7 @@ func ParseFloat(s string) float64 { // NormalizeGPS normalizes the longitude and latitude of the GPS position to a generally valid range. func NormalizeGPS(lat, lng float64) (float64, float64) { if lat < LatMax || lat > LatMax || lng < LngMax || lng > LngMax { - // Clip the latitude. Normalise the longitude. + // Clip the latitude. Normalize the longitude. lat, lng = clipLat(lat), normalizeLng(lng) } diff --git a/internal/meta/gps_test.go b/internal/meta/gps_test.go index b25e38d0a..4e0292565 100644 --- a/internal/meta/gps_test.go +++ b/internal/meta/gps_test.go @@ -53,6 +53,65 @@ func TestGpsToDecimal(t *testing.T) { r := GpsToDecimal("abc") assert.Equal(t, float64(0), r) }) + t.Run("PureDecimal", func(t *testing.T) { + // Plain float passes through ParseFloat unchanged. + assert.Equal(t, 47.6754, GpsToDecimal("47.6754")) + assert.Equal(t, -47.6754, GpsToDecimal("-47.6754")) + }) + t.Run("AdobeTwoComponentNorth", func(t *testing.T) { + // 52° 30.4567'N → 52 + 30.4567/60 = 52.5076... + r := GpsToDecimal("52,30.4567N") + assert.InEpsilon(t, 52.50761166666667, r, 1e-6) + }) + t.Run("AdobeTwoComponentSouth", func(t *testing.T) { + // Cardinal S inverts the sign per exif.GpsDegrees.Decimal. + r := GpsToDecimal("27,20.4263S") + assert.InEpsilon(t, -27.340438333333333, r, 1e-6) + }) + t.Run("AdobeTwoComponentEast", func(t *testing.T) { + // 13° 24.5678'E → 13 + 24.5678/60 ≈ 13.4094633. + r := GpsToDecimal("13,24.5678E") + assert.InEpsilon(t, 13.409463333333334, r, 1e-6) + }) + t.Run("AdobeTwoComponentLeadingZeros", func(t *testing.T) { + // Adobe writes longitudes with leading zeros (031 = 31°). + r := GpsToDecimal("031,53.5529E") + assert.InEpsilon(t, 31.892548333333334, r, 1e-6) + }) + t.Run("RejectsZeroComponentsWithRef", func(t *testing.T) { + // One coordinate component plus a ref is too few to interpret. + assert.Equal(t, float64(0), GpsToDecimal("N")) + }) + t.Run("RejectsFourComponentsWithRef", func(t *testing.T) { + // More than three components is also unsupported. + assert.Equal(t, float64(0), GpsToDecimal("1 2 3 4 N")) + }) +} + +// TestGpsToDecimal_RegressionAgainstExistingFixtures asserts that +// GpsToDecimal still parses the 3-component DMS form used by the +// JSON fixtures under testdata/, so a regression surfaces here before +// it reaches the broader exif/json test suites. +func TestGpsToDecimal_RegressionAgainstExistingFixtures(t *testing.T) { + cases := []struct { + name, input string + want float64 + eps float64 + }{ + {"gopher-original Lat", `52 deg 27' 34.56" N`, 52.45960, 1e-4}, + {"gopher-original Lng", `13 deg 19' 18.48" E`, 13.32180, 1e-4}, + {"panorama360 Lat", `59 deg 50' 27.00" N`, 59.84083, 1e-4}, + {"panorama360 Lng", `30 deg 30' 36.00" E`, 30.51000, 1e-4}, + {"date.mov Lat", `55 deg 33' 48.96" N`, 55.56360, 1e-4}, + {"date.mov Lng", `37 deg 58' 56.64" E`, 37.98240, 1e-4}, + {"berlin-landscape Lat", `52 deg 27' 53.64" N`, 52.46490, 1e-4}, + {"berlin-landscape Lng", `13 deg 18' 53.28" E`, 13.31480, 1e-4}, + } + for _, c := range cases { + t.Run(c.name, func(t *testing.T) { + assert.InDelta(t, c.want, GpsToDecimal(c.input), c.eps) + }) + } } func TestGpsCoord(t *testing.T) { diff --git a/internal/meta/json_exiftool.go b/internal/meta/json_exiftool.go index 4bb8b1c7c..5f6ac5e77 100644 --- a/internal/meta/json_exiftool.go +++ b/internal/meta/json_exiftool.go @@ -17,7 +17,6 @@ import ( "github.com/photoprism/photoprism/pkg/media/projection" "github.com/photoprism/photoprism/pkg/media/video" "github.com/photoprism/photoprism/pkg/rnd" - "github.com/photoprism/photoprism/pkg/time/tz" "github.com/photoprism/photoprism/pkg/txt" ) @@ -208,110 +207,10 @@ func (data *Data) Exiftool(jsonData []byte, originalName string) (err error) { } } - hasTimeOffset := false - - // Has Media Create Date? - if !data.CreatedAt.IsZero() { - data.TakenAt = data.CreatedAt - } - - // Fallback to GPS UTC Time? - if data.TakenAt.IsZero() && data.TakenAtLocal.IsZero() && !data.TakenGps.IsZero() { - data.TimeZone = tz.UTC - data.TakenAt = data.TakenGps.UTC() - data.TakenAtLocal = time.Time{} - } - - // Check plausibility of the local <> UTC time difference. - if !data.TakenAt.IsZero() && !data.TakenAtLocal.IsZero() { - if d := data.TakenAt.Sub(data.TakenAtLocal).Abs(); d > time.Hour*27 { - log.Infof("metadata: %s has an invalid local time offset (%s)", logName, d.String()) - log.Debugf("metadata: %s was taken at %s, local time %s, create time %s, time zone %s", logName, clean.Log(data.TakenAt.UTC().String()), clean.Log(data.TakenAtLocal.String()), clean.Log(data.CreatedAt.String()), clean.Log(data.TimeZone)) - data.TakenAtLocal = data.TakenAt - data.TakenAt = data.TakenAt.UTC() - } - } - - // Has time zone offset? - if _, offset := data.TakenAtLocal.Zone(); offset != 0 && !data.TakenAtLocal.IsZero() { - hasTimeOffset = true - } else if mt, ok := data.json["MIMEType"]; ok && data.TakenAtLocal.IsZero() && (mt == MimeVideoMp4 || mt == MimeQuicktime) { - // Assume default time zone for MP4 & Quicktime videos is UTC. - // see https://exiftool.org/TagNames/QuickTime.html - log.Tracef("metadata: default time zone for %s is UTC (%s)", logName, clean.Log(mt)) - data.TimeZone = tz.UTC - data.TakenAt = data.TakenAt.UTC() - data.TakenAtLocal = time.Time{} - } - - // Set time zone and calculate UTC time. - if data.Lat != 0 && data.Lng != 0 { - if zone := tz.Position(data.Lat, data.Lng); zone != "" { - data.TimeZone = zone - } - - if loc := tz.Find(data.TimeZone); !data.TakenAtLocal.IsZero() { - if tl, parseErr := time.ParseInLocation("2006:01:02 15:04:05", data.TakenAtLocal.Format("2006:01:02 15:04:05"), loc); parseErr == nil { - data.TakenAtLocal = tz.Strip(data.TakenAtLocal) - data.TakenAt = tl.Truncate(time.Second).UTC() - } else { - log.Errorf("metadata: %s (exiftool)", clean.Error(parseErr)) // this should never happen - } - } else if !data.TakenAt.IsZero() { - if localUtc, parseErr := time.ParseInLocation("2006:01:02 15:04:05", data.TakenAt.In(loc).Format("2006:01:02 15:04:05"), time.UTC); parseErr == nil { - data.TakenAtLocal = localUtc - data.TakenAt = data.TakenAt.UTC() - } else { - log.Errorf("metadata: %s (exiftool)", clean.Error(parseErr)) // this should never happen - } - } - } else if hasTimeOffset { - if localUtc, parseErr := time.ParseInLocation("2006:01:02 15:04:05", data.TakenAtLocal.Format("2006:01:02 15:04:05"), time.UTC); parseErr == nil { - data.TakenAtLocal = localUtc.Truncate(time.Second).UTC() - } - - data.TakenAt = data.TakenAt.Truncate(time.Second).UTC() - } - - // Set UTC offset as time zone? - if data.TimeZone != "" && data.TimeZone != tz.Local && data.TimeZone != tz.UTC || data.TakenAt.IsZero() { - // Don't change existing time zone. - } else if utcOffset := tz.UtcOffset(data.TakenAt, data.TakenAtLocal, data.TimeOffset); utcOffset != "" { - data.TimeZone = utcOffset - - if data.TakenAtLocal.IsZero() { - data.TakenAtLocal = tz.Strip(data.TakenAt) - } - - data.TakenAt = data.TakenAt.UTC() - log.Infof("metadata: %s has time offset %s (exiftool)", logName, clean.Log(utcOffset)) - } else if data.TimeOffset != "" { - log.Infof("metadata: %s has invalid time offset %s (exiftool)", logName, clean.Log(data.TimeOffset)) - } - - // Normalize time zone name. - data.TimeZone = tz.Name(data.TimeZone) - - // Set local time based on UTC time if empty. - if data.TakenAtLocal.IsZero() && !data.TakenAt.IsZero() { - if loc := tz.Find(data.TimeZone); loc.String() == tz.Local { - data.TakenAtLocal = tz.Strip(data.TakenAt) - data.TakenAt = data.TakenAt.UTC() - } else if localUtc, parseErr := time.ParseInLocation("2006:01:02 15:04:05", data.TakenAt.In(loc).Format("2006:01:02 15:04:05"), time.UTC); parseErr == nil { - data.TakenAtLocal = localUtc - data.TakenAt = data.TakenAt.UTC() - } else { - log.Errorf("metadata: %s (exiftool)", clean.Error(parseErr)) // this should never happen - } - } - - // Add nanoseconds to the calculated UTC and local time. - if data.TakenAt.Nanosecond() == 0 { - if ns := time.Duration(data.TakenNs); ns > 0 && ns <= time.Second { - data.TakenAt = data.TakenAt.Truncate(time.Second).UTC().Add(ns) - data.TakenAtLocal = data.TakenAtLocal.Truncate(time.Second).Add(ns) - } - } + // Normalize capture time, local time, and time zone using the shared + // resolver so the ExifTool JSON path and the XMP sidecar path produce + // identical entity state for the same metadata. + data.ResolveTimeZone(logName) // Use actual image width and height if available, see issue #2447. if jsonValues["ImageWidth"].Exists() && jsonValues["ImageHeight"].Exists() { @@ -380,6 +279,13 @@ func (data *Data) Exiftool(jsonData []byte, originalName string) (err error) { data.InstanceID = rnd.SanitizeUUID(data.InstanceID) } + // Promote GPano-style markers to equirectangular when ProjectionType is absent. + if data.Projection == "" { + if data.json["UsePanoramaViewer"] == "true" || data.json["IsPhotosphere"] == "true" { + data.Projection = projection.Equirectangular.String() + } + } + if projection.Equirectangular.Equal(data.Projection) { data.AddKeywords(KeywordPanorama) } diff --git a/internal/meta/json_test.go b/internal/meta/json_test.go index 49154b432..8c6fccf96 100644 --- a/internal/meta/json_test.go +++ b/internal/meta/json_test.go @@ -12,6 +12,29 @@ import ( ) func TestJSON(t *testing.T) { + t.Run("AviVideoCodec", func(t *testing.T) { + data, err := JSON("testdata/avi-magicyuv.json", "") + + if err != nil { + t.Fatal(err) + } + + // The codec is read from the AVI VideoCodec tag (no CompressorID/VideoCodecID + // is present) and normalized to its canonical name. + assert.Equal(t, video.CodecMagicYUV, data.Codec) + assert.Equal(t, 160, data.Width) + assert.Equal(t, 120, data.Height) + }) + t.Run("MkvVfwWrapper", func(t *testing.T) { + data, err := JSON("testdata/mkv-vfw.json", "") + + if err != nil { + t.Fatal(err) + } + + // The Matroska VFW wrapper codec ID normalizes to the canonical VFW name. + assert.Equal(t, video.CodecVFW, data.Codec) + }) t.Run("MovJson", func(t *testing.T) { data, err := JSON("testdata/mov.json", "") @@ -577,6 +600,46 @@ func TestJSON(t *testing.T) { assert.Equal(t, 1, data.Orientation) assert.Equal(t, projection.Equirectangular.String(), data.Projection) }) + t.Run("PanoramaUsePanoramaViewer", func(t *testing.T) { + data, err := JSON("testdata/panorama_usepanoramaviewer.json", "") + + if err != nil { + t.Fatal(err) + } + + assert.Equal(t, projection.Equirectangular.String(), data.Projection) + assert.Contains(t, data.Keywords.String(), "panorama") + }) + t.Run("PanoramaIsPhotosphere", func(t *testing.T) { + data, err := JSON("testdata/panorama_isphotosphere.json", "") + + if err != nil { + t.Fatal(err) + } + + assert.Equal(t, projection.Equirectangular.String(), data.Projection) + assert.Contains(t, data.Keywords.String(), "panorama") + }) + t.Run("PanoramaCubemap", func(t *testing.T) { + data, err := JSON("testdata/panorama_cubemap.json", "") + + if err != nil { + t.Fatal(err) + } + + assert.NotEqual(t, projection.Equirectangular.String(), data.Projection) + assert.NotContains(t, data.Keywords.String(), "panorama") + }) + t.Run("PanoramaVideoMp4", func(t *testing.T) { + data, err := JSON("testdata/panorama360_video.json", "panorama360_video.mp4") + + if err != nil { + t.Fatal(err) + } + + assert.Equal(t, projection.Equirectangular.String(), data.Projection) + assert.Contains(t, data.Keywords.String(), "panorama") + }) t.Run("PNum7250006Json", func(t *testing.T) { data, err := JSON("testdata/P7250006.json", "P7250006.MOV") diff --git a/internal/meta/meta.go b/internal/meta/meta.go index aacb1a4f2..6bd3d1cc2 100644 --- a/internal/meta/meta.go +++ b/internal/meta/meta.go @@ -1,7 +1,7 @@ /* Package meta provides XMP and Exif metadata parsing and normalization. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/meta/meta_test.go b/internal/meta/meta_test.go index fbe0ce16a..fa7031155 100644 --- a/internal/meta/meta_test.go +++ b/internal/meta/meta_test.go @@ -7,10 +7,14 @@ import ( "github.com/sirupsen/logrus" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) int { log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) - code := m.Run() - os.Exit(code) + return m.Run() } diff --git a/internal/meta/resolver.go b/internal/meta/resolver.go new file mode 100644 index 000000000..935c2cabe --- /dev/null +++ b/internal/meta/resolver.go @@ -0,0 +1,130 @@ +/* +Package meta resolver.go normalizes the time-zone, capture-time, and local-time +fields on a Data receiver from any combination of CreatedAt, TakenGps, Lat/Lng, +TimeOffset, MimeType, and TakenNs already populated by an upstream reader. +Shared between the ExifTool JSON path (internal/meta/json_exiftool.go) and the +XMP sidecar path (internal/meta/xmp.go) so both flows produce identical entity +state for the same capture metadata. +*/ +package meta + +import ( + "time" + + "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/time/tz" +) + +// ResolveTimeZone normalizes TakenAt, TakenAtLocal, and TimeZone from any +// combination of CreatedAt, TakenGps, Lat/Lng, TimeOffset, MimeType, and +// TakenNs already present on the Data receiver. Safe to call from any +// metadata reader (EXIF, ExifTool JSON, XMP sidecar). Reads no external +// state beyond the receiver; writes only data.TakenAt, data.TakenAtLocal, +// and data.TimeZone. The logName argument is used for diagnostic log +// output only. +func (data *Data) ResolveTimeZone(logName string) { + hasTimeOffset := false + + // Has Media Create Date? + if !data.CreatedAt.IsZero() { + data.TakenAt = data.CreatedAt + } + + // Fallback to GPS UTC Time? + if data.TakenAt.IsZero() && data.TakenAtLocal.IsZero() && !data.TakenGps.IsZero() { + data.TimeZone = tz.UTC + data.TakenAt = data.TakenGps.UTC() + data.TakenAtLocal = time.Time{} + } + + // Check plausibility of the local <> UTC time difference. + if !data.TakenAt.IsZero() && !data.TakenAtLocal.IsZero() { + if d := data.TakenAt.Sub(data.TakenAtLocal).Abs(); d > time.Hour*27 { + log.Infof("metadata: %s has an invalid local time offset (%s)", logName, d.String()) + log.Debugf("metadata: %s was taken at %s, local time %s, create time %s, time zone %s", logName, clean.Log(data.TakenAt.UTC().String()), clean.Log(data.TakenAtLocal.String()), clean.Log(data.CreatedAt.String()), clean.Log(data.TimeZone)) + data.TakenAtLocal = data.TakenAt + data.TakenAt = data.TakenAt.UTC() + } + } + + // Has time zone offset? + if _, offset := data.TakenAtLocal.Zone(); offset != 0 && !data.TakenAtLocal.IsZero() { + hasTimeOffset = true + } else if mt := data.MimeType; mt != "" && data.TakenAtLocal.IsZero() && (mt == MimeVideoMp4 || mt == MimeQuicktime) { + // Assume default time zone for MP4 & Quicktime videos is UTC. + // see https://exiftool.org/TagNames/QuickTime.html + log.Tracef("metadata: default time zone for %s is UTC (%s)", logName, clean.Log(mt)) + data.TimeZone = tz.UTC + data.TakenAt = data.TakenAt.UTC() + data.TakenAtLocal = time.Time{} + } + + // Set time zone and calculate UTC time. + if data.Lat != 0 && data.Lng != 0 { + if zone := tz.Position(data.Lat, data.Lng); zone != "" { + data.TimeZone = zone + } + + if loc := tz.Find(data.TimeZone); !data.TakenAtLocal.IsZero() { + if tl, parseErr := time.ParseInLocation("2006:01:02 15:04:05", data.TakenAtLocal.Format("2006:01:02 15:04:05"), loc); parseErr == nil { + data.TakenAtLocal = tz.Strip(data.TakenAtLocal) + data.TakenAt = tl.Truncate(time.Second).UTC() + } else { + log.Errorf("metadata: %s", clean.Error(parseErr)) // this should never happen + } + } else if !data.TakenAt.IsZero() { + if localUtc, parseErr := time.ParseInLocation("2006:01:02 15:04:05", data.TakenAt.In(loc).Format("2006:01:02 15:04:05"), time.UTC); parseErr == nil { + data.TakenAtLocal = localUtc + data.TakenAt = data.TakenAt.UTC() + } else { + log.Errorf("metadata: %s", clean.Error(parseErr)) // this should never happen + } + } + } else if hasTimeOffset { + if localUtc, parseErr := time.ParseInLocation("2006:01:02 15:04:05", data.TakenAtLocal.Format("2006:01:02 15:04:05"), time.UTC); parseErr == nil { + data.TakenAtLocal = localUtc.Truncate(time.Second).UTC() + } + + data.TakenAt = data.TakenAt.Truncate(time.Second).UTC() + } + + // Set UTC offset as time zone? + if data.TimeZone != "" && data.TimeZone != tz.Local && data.TimeZone != tz.UTC || data.TakenAt.IsZero() { + // Don't change existing time zone. + } else if utcOffset := tz.UtcOffset(data.TakenAt, data.TakenAtLocal, data.TimeOffset); utcOffset != "" { + data.TimeZone = utcOffset + + if data.TakenAtLocal.IsZero() { + data.TakenAtLocal = tz.Strip(data.TakenAt) + } + + data.TakenAt = data.TakenAt.UTC() + log.Infof("metadata: %s has time offset %s", logName, clean.Log(utcOffset)) + } else if data.TimeOffset != "" { + log.Infof("metadata: %s has invalid time offset %s", logName, clean.Log(data.TimeOffset)) + } + + // Normalize time zone name. + data.TimeZone = tz.Name(data.TimeZone) + + // Set local time based on UTC time if empty. + if data.TakenAtLocal.IsZero() && !data.TakenAt.IsZero() { + if loc := tz.Find(data.TimeZone); loc.String() == tz.Local { + data.TakenAtLocal = tz.Strip(data.TakenAt) + data.TakenAt = data.TakenAt.UTC() + } else if localUtc, parseErr := time.ParseInLocation("2006:01:02 15:04:05", data.TakenAt.In(loc).Format("2006:01:02 15:04:05"), time.UTC); parseErr == nil { + data.TakenAtLocal = localUtc + data.TakenAt = data.TakenAt.UTC() + } else { + log.Errorf("metadata: %s", clean.Error(parseErr)) // this should never happen + } + } + + // Add nanoseconds to the calculated UTC and local time. + if data.TakenAt.Nanosecond() == 0 { + if ns := time.Duration(data.TakenNs); ns > 0 && ns <= time.Second { + data.TakenAt = data.TakenAt.Truncate(time.Second).UTC().Add(ns) + data.TakenAtLocal = data.TakenAtLocal.Truncate(time.Second).Add(ns) + } + } +} diff --git a/internal/meta/resolver_test.go b/internal/meta/resolver_test.go new file mode 100644 index 000000000..fab5b922a --- /dev/null +++ b/internal/meta/resolver_test.go @@ -0,0 +1,151 @@ +package meta + +import ( + "testing" + "time" + + "github.com/stretchr/testify/assert" +) + +// TestData_ResolveTimeZone exercises each branch of (*Data).ResolveTimeZone in +// isolation so a regression in either the EXIF/ExifTool path or the XMP path +// surfaces as a focused unit-test failure rather than as a downstream entity +// mismatch. +func TestData_ResolveTimeZone(t *testing.T) { + t.Run("CreatedAtOverridesTakenAt", func(t *testing.T) { + // Mirrors the Media Create Date branch (resolver line ~215): a + // non-zero CreatedAt wins over the parsed TakenAt for videos and + // other containers where the "create" tag is authoritative. + created := time.Date(2024, 6, 15, 12, 0, 0, 0, time.UTC) + other := time.Date(2024, 6, 15, 10, 0, 0, 0, time.UTC) + data := Data{CreatedAt: created, TakenAt: other, TakenAtLocal: other} + + data.ResolveTimeZone("test.jpg") + + assert.Equal(t, created, data.TakenAt) + }) + t.Run("GpsUtcFallback", func(t *testing.T) { + // No TakenAt / TakenAtLocal, but GPSDateTime is present — the + // resolver promotes the GPS UTC timestamp and clears any stale + // local time. + gps := time.Date(2024, 6, 15, 12, 0, 0, 0, time.UTC) + data := Data{TakenGps: gps} + + data.ResolveTimeZone("test.jpg") + + assert.Equal(t, gps, data.TakenAt) + assert.Equal(t, "UTC", data.TimeZone) + assert.True(t, data.TakenAtLocal.IsZero() || data.TakenAtLocal.Equal(gps)) + }) + t.Run("PlausibilityCheckFork", func(t *testing.T) { + // Local and UTC time differ by >27h → the resolver assumes the + // local timestamp is bogus and forces it to mirror the UTC value. + utc := time.Date(2024, 6, 15, 12, 0, 0, 0, time.UTC) + local := time.Date(2024, 6, 17, 12, 0, 0, 0, time.UTC) + data := Data{TakenAt: utc, TakenAtLocal: local} + + data.ResolveTimeZone("test.jpg") + + assert.Equal(t, data.TakenAt.UTC(), data.TakenAtLocal.UTC()) + }) + t.Run("Mp4DefaultsToUtc", func(t *testing.T) { + // MP4 containers conventionally store UTC timestamps with no + // explicit zone, so the resolver flips to UTC when MimeType + // matches and no local time is set. + taken := time.Date(2024, 6, 15, 12, 0, 0, 0, time.UTC) + data := Data{TakenAt: taken, MimeType: MimeVideoMp4} + + data.ResolveTimeZone("test.mp4") + + assert.Equal(t, "UTC", data.TimeZone) + }) + t.Run("QuicktimeDefaultsToUtc", func(t *testing.T) { + taken := time.Date(2024, 6, 15, 12, 0, 0, 0, time.UTC) + data := Data{TakenAt: taken, MimeType: MimeQuicktime} + + data.ResolveTimeZone("test.mov") + + assert.Equal(t, "UTC", data.TimeZone) + }) + t.Run("GpsResolvesZoneAndLocal", func(t *testing.T) { + // Berlin GPS + Berlin wall-clock. Resolver picks the IANA zone + // from coordinates and derives the UTC instant from the local + // time (CET is +01:00 in January). + berlin := time.FixedZone("CET", 3600) + local := time.Date(2024, 1, 15, 17, 28, 25, 0, berlin) + data := Data{ + TakenAt: local, + TakenAtLocal: local, + Lat: 52.5, + Lng: 13.4, + } + + data.ResolveTimeZone("test.jpg") + + assert.Equal(t, "Europe/Berlin", data.TimeZone) + assert.Equal(t, time.Date(2024, 1, 15, 16, 28, 25, 0, time.UTC), data.TakenAt.UTC()) + assert.Equal(t, "2024-01-15 17:28:25", data.TakenAtLocal.Format("2006-01-02 15:04:05")) + }) + t.Run("OffsetResolvesZone", func(t *testing.T) { + // No GPS, no wall-clock zone — the resolver falls back to the + // TimeOffset string ("+02:00") to derive a fixed-offset zone. + taken := time.Date(2024, 6, 15, 12, 0, 0, 0, time.UTC) + data := Data{ + TakenAt: taken, + TakenAtLocal: taken, + TimeOffset: "+02:00", + } + + data.ResolveTimeZone("test.jpg") + + assert.Equal(t, "UTC+2", data.TimeZone) + }) + t.Run("FallbackLocalFromUtc", func(t *testing.T) { + // TakenAtLocal zero, TakenAt set, no GPS/offset — resolver fills + // in TakenAtLocal so downstream consumers always see a value. + taken := time.Date(2024, 6, 15, 12, 0, 0, 0, time.UTC) + data := Data{TakenAt: taken} + + data.ResolveTimeZone("test.jpg") + + assert.False(t, data.TakenAtLocal.IsZero()) + }) + t.Run("NanosAppliedToBoth", func(t *testing.T) { + // Sub-second precision lives in TakenNs (mirroring SubSecTimeOriginal). + // The resolver applies it to both TakenAt and TakenAtLocal when the + // truncated UTC time has no nanoseconds yet, preserving entity-layer + // parity across the two timestamp columns. + taken := time.Date(2024, 6, 15, 12, 0, 0, 0, time.UTC) + data := Data{ + TakenAt: taken, + TakenAtLocal: taken, + TakenNs: 123456789, + } + + data.ResolveTimeZone("test.jpg") + + assert.Equal(t, 123456789, data.TakenAt.Nanosecond()) + assert.Equal(t, 123456789, data.TakenAtLocal.Nanosecond()) + }) + t.Run("NoopOnEmpty", func(t *testing.T) { + // All time fields zero — the resolver must not panic and must + // leave the receiver in a coherent (still empty) state. + data := Data{} + + assert.NotPanics(t, func() { data.ResolveTimeZone("test.jpg") }) + + assert.True(t, data.TakenAt.IsZero()) + assert.True(t, data.TakenAtLocal.IsZero()) + }) + t.Run("PreservesTakenAtIfNonZero", func(t *testing.T) { + // CreatedAt empty, TakenAt populated — the resolver must not blank + // out a non-zero TakenAt just because CreatedAt is missing. + taken := time.Date(2024, 6, 15, 12, 0, 0, 0, time.UTC) + data := Data{TakenAt: taken, TakenAtLocal: taken} + + data.ResolveTimeZone("test.jpg") + + assert.False(t, data.TakenAt.IsZero()) + assert.Equal(t, taken.UTC().Format("2006-01-02 15:04:05"), data.TakenAt.UTC().Format("2006-01-02 15:04:05")) + }) +} diff --git a/internal/meta/testdata/avi-magicyuv.json b/internal/meta/testdata/avi-magicyuv.json new file mode 100644 index 000000000..255532f88 --- /dev/null +++ b/internal/meta/testdata/avi-magicyuv.json @@ -0,0 +1,13 @@ +[{ + "SourceFile": "/tmp/sample_magic.avi", + "ExifToolVersion": 12.56, + "FileName": "sample_magic.avi", + "FileType": "AVI", + "FileTypeExtension": "AVI", + "MIMEType": "video/x-msvideo", + "ImageWidth": 160, + "ImageHeight": 120, + "VideoFrameRate": 5, + "Compression": "M8RG", + "VideoCodec": "M8RG" +}] diff --git a/internal/meta/testdata/mkv-vfw.json b/internal/meta/testdata/mkv-vfw.json new file mode 100644 index 000000000..ce03672f7 --- /dev/null +++ b/internal/meta/testdata/mkv-vfw.json @@ -0,0 +1,12 @@ +[{ + "SourceFile": "/tmp/sample_vfw.mkv", + "ExifToolVersion": 12.56, + "FileName": "sample_vfw.mkv", + "FileType": "MKV", + "FileTypeExtension": "MKV", + "MIMEType": "video/x-matroska", + "ImageWidth": 128, + "ImageHeight": 96, + "VideoFrameRate": 5, + "VideoCodecID": "V_MS/VFW/FOURCC" +}] diff --git a/internal/meta/testdata/panorama360_video.json b/internal/meta/testdata/panorama360_video.json new file mode 100644 index 000000000..d77f3f078 --- /dev/null +++ b/internal/meta/testdata/panorama360_video.json @@ -0,0 +1,15 @@ +[{ + "SourceFile": "panorama360_video.mp4", + "ExifToolVersion": 12.40, + "FileName": "panorama360_video.mp4", + "Directory": ".", + "FileSize": "12 MB", + "FileType": "MP4", + "FileTypeExtension": "mp4", + "MIMEType": "video/mp4", + "ImageWidth": 3840, + "ImageHeight": 1920, + "ProjectionType": "equirectangular", + "CompressorID": "avc1", + "Duration": "10.00 s" +}] diff --git a/internal/meta/testdata/panorama_cubemap.json b/internal/meta/testdata/panorama_cubemap.json new file mode 100644 index 000000000..60be7e816 --- /dev/null +++ b/internal/meta/testdata/panorama_cubemap.json @@ -0,0 +1,16 @@ +[{ + "SourceFile": "panorama_cubemap.jpg", + "ExifToolVersion": 12.40, + "FileName": "panorama_cubemap.jpg", + "Directory": ".", + "FileSize": "1.0 MB", + "FileType": "JPEG", + "FileTypeExtension": "jpg", + "MIMEType": "image/jpeg", + "ImageWidth": 6000, + "ImageHeight": 4500, + "ProjectionType": "cubemap", + "EncodingProcess": "Baseline DCT, Huffman coding", + "BitsPerSample": 8, + "ColorComponents": 3 +}] diff --git a/internal/meta/testdata/panorama_isphotosphere.json b/internal/meta/testdata/panorama_isphotosphere.json new file mode 100644 index 000000000..1017099c8 --- /dev/null +++ b/internal/meta/testdata/panorama_isphotosphere.json @@ -0,0 +1,18 @@ +[{ + "SourceFile": "panorama_isphotosphere.jpg", + "ExifToolVersion": 12.40, + "FileName": "panorama_isphotosphere.jpg", + "Directory": ".", + "FileSize": "1.0 MB", + "FileType": "JPEG", + "FileTypeExtension": "jpg", + "MIMEType": "image/jpeg", + "ImageWidth": 5376, + "ImageHeight": 2688, + "IsPhotosphere": true, + "Make": "RICOH", + "Model": "RICOH THETA S", + "EncodingProcess": "Baseline DCT, Huffman coding", + "BitsPerSample": 8, + "ColorComponents": 3 +}] diff --git a/internal/meta/testdata/panorama_usepanoramaviewer.json b/internal/meta/testdata/panorama_usepanoramaviewer.json new file mode 100644 index 000000000..bffe45680 --- /dev/null +++ b/internal/meta/testdata/panorama_usepanoramaviewer.json @@ -0,0 +1,17 @@ +[{ + "SourceFile": "panorama_usepanoramaviewer.jpg", + "ExifToolVersion": 12.40, + "FileName": "panorama_usepanoramaviewer.jpg", + "Directory": ".", + "FileSize": "1.0 MB", + "FileType": "JPEG", + "FileTypeExtension": "jpg", + "MIMEType": "image/jpeg", + "ImageWidth": 7200, + "ImageHeight": 3600, + "UsePanoramaViewer": true, + "CaptureSoftware": "Generic Panorama Stitcher", + "EncodingProcess": "Baseline DCT, Huffman coding", + "BitsPerSample": 8, + "ColorComponents": 3 +}] diff --git a/internal/meta/testdata/xmp/README.md b/internal/meta/testdata/xmp/README.md new file mode 100644 index 000000000..d48911fe6 --- /dev/null +++ b/internal/meta/testdata/xmp/README.md @@ -0,0 +1,46 @@ +# XMP Fixture Corpus + +Test fixtures for the `internal/meta` XMP sidecar reader rewrite (issue #2260, proposal `specs/proposals/xmp-improvement.md`). + +Each fixture is paired with an `.exiftool.txt` reference (output of `exiftool -X <file>`) that captures the canonical interpretation; regression tests compare reader output against the same XMP read through ExifTool. + +## Layout + +| Directory | Source | Purpose | +|--------------|-----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| `adobe/` | Adobe Bridge / Lightroom / Camera Raw exports | Reference implementation. Covers the full EXIF camera/lens/exposure surface, GPS in 2-component Adobe form, and the `xmpMM:*` triple. | +| `darktable/` | Darktable lighttable + map mode | Open-source writer with `<rdf:Bag>` for `dc:subject`, vendor `darktable:*` history, and the 2-component GPS form. | +| `digikam/` | digiKam Edit Metadata dialog | Open-source writer with `xmpRights:UsageTerms` (License), `xmpMM:DocumentID/InstanceID/OriginalDocumentID` triple, and section-2 noise. | +| `synthetic/` | Hand-written, validated with `exiftool -X` | Targeted coverage for tags absent in the tool fixtures and edge cases that real writers don't reliably produce. | + +## Regenerating Exiftool References + +After editing a fixture: + + for f in internal/meta/testdata/xmp/{adobe,darktable,digikam,synthetic}/*.xmp; do + exiftool -X "$f" > "${f%.xmp}.exiftool.txt" + done + +## Synthetic Fixture Index + +| File | Purpose | +|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| `software-only.xmp` | `xmp:CreatorTool` (Software). Single-tag fixture for the simplest accessor. | +| `gps-time-combined.xmp` | `exif:GPSTimeStamp` as a single combined ISO 8601 / RFC 3339 datetime — the spec-canonical encoding for `TakenGps`. | +| `gps-time-split.xmp` | Legacy split form: `exif:GPSDateStamp` + `exif:GPSTimeStamp`. Some older writers emit this; secondary `TakenGps` fallback. | +| `time-offsets-subsec.xmp` | `exif:OffsetTimeOriginal/OffsetTime/OffsetTimeDigitized` cascade plus `exif:SubSecTimeOriginal` joined into `TakenAt`. | +| `notes-usercomment.xmp` | `exif:UserComment` as `lang-alt` (`<rdf:Alt>` with `x-default` + `en` + `de`). Confirms reader prefers `x-default`. | +| `xmpdm-creationdate.xmp` | `xmpDM:CreationDate` — secondary fallback for `CreatedAt` (rare; emitted by Adobe Premiere/After Effects). | +| `subject-seq.xmp` | `dc:subject` as `<rdf:Seq>` instead of `<rdf:Bag>`. Confirms reader handles both list types. | +| `aux-only.xmp` | Adobe `aux:` namespace — `OwnerName`, `Lens`, `LensID`, `LensSerialNumber`, `SerialNumber`, `Firmware`. Legacy Lightroom/ACR. | +| `exifex-camera-lens.xmp` | EXIF 2.3 for XMP `exifEX:` namespace — `LensMake`, `LensModel`, `BodySerialNumber`, `PhotographicSensitivity`, etc. | +| `tiff-fields.xmp` | Deprecated TIFF-schema fallbacks — `tiff:Software`, `tiff:ImageDescription` (lang-alt), `tiff:Copyright` (lang-alt). | +| `gpano-360.xmp` | Google Photo Sphere — `GPano:ProjectionType = equirectangular` plus required dimension fields. | +| `multi-rdf-description.xmp` | Bug 2 demonstration: four sibling `<rdf:Description>` blocks each declaring a different namespace. Tests that XPath walks all blocks. | +| `alt-edge-cases.xmp` | `<rdf:Alt>` shapes that real writers don't always produce: no `x-default` (only `de`/`en`), missing `xml:lang`, duplicate `x-default`. | + +## Source Notes + +- `digikam/aurora.jpg.xmp` deliberately includes section-2 (out-of-scope) tags such as `xmp:Label`, `digiKam:TagsList`, `lr:hierarchicalSubject`, `MicrosoftPhoto:LastKeywordXMP`, and `xmpMM:History`. These are negative-test bait — the reader must **not** persist them. +- `darktable/aurora.jpg.xmp` includes the `<darktable:history>` develop stack (also section-2 ignored) and uses the 2-component Adobe GPS form (`87,21.291962N`) that today's `GpsToDecimal` silently drops. +- Adobe Bridge fixtures emit `<exif:Flash>` as a struct with `<exif:Fired>` sub-field — the only fixtures in the corpus that exercise the `Flash` composition rule. diff --git a/internal/meta/testdata/xmp/adobe/bridge-2.exiftool.txt b/internal/meta/testdata/xmp/adobe/bridge-2.exiftool.txt new file mode 100644 index 000000000..b97b3af62 --- /dev/null +++ b/internal/meta/testdata/xmp/adobe/bridge-2.exiftool.txt @@ -0,0 +1,129 @@ +<?xml version='1.0' encoding='UTF-8'?> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> + +<rdf:Description rdf:about='internal/meta/testdata/xmp/adobe/bridge-2.xmp' + xmlns:et='http://ns.exiftool.org/1.0/' et:toolkit='Image::ExifTool 13.25' + xmlns:ExifTool='http://ns.exiftool.org/ExifTool/1.0/' + xmlns:System='http://ns.exiftool.org/File/System/1.0/' + xmlns:File='http://ns.exiftool.org/File/1.0/' + xmlns:XMP-x='http://ns.exiftool.org/XMP/XMP-x/1.0/' + xmlns:XMP-exif='http://ns.exiftool.org/XMP/XMP-exif/1.0/' + xmlns:XMP-tiff='http://ns.exiftool.org/XMP/XMP-tiff/1.0/' + xmlns:XMP-xmpMM='http://ns.exiftool.org/XMP/XMP-xmpMM/1.0/' + xmlns:XMP-dc='http://ns.exiftool.org/XMP/XMP-dc/1.0/' + xmlns:XMP-photoshop='http://ns.exiftool.org/XMP/XMP-photoshop/1.0/' + xmlns:XMP-xmp='http://ns.exiftool.org/XMP/XMP-xmp/1.0/' + xmlns:XMP-xmpRights='http://ns.exiftool.org/XMP/XMP-xmpRights/1.0/' + xmlns:XMP-iptcCore='http://ns.exiftool.org/XMP/XMP-iptcCore/1.0/' + xmlns:XMP-kbrg='http://ns.exiftool.org/XMP/XMP-kbrg/1.0/' + xmlns:Composite='http://ns.exiftool.org/Composite/1.0/'> + <ExifTool:ExifToolVersion>13.25</ExifTool:ExifToolVersion> + <System:FileName>bridge-2.xmp</System:FileName> + <System:Directory>internal/meta/testdata/xmp/adobe</System:Directory> + <System:FileSize>8.3 kB</System:FileSize> + <System:FileModifyDate>2026:05:06 06:39:34+00:00</System:FileModifyDate> + <System:FileAccessDate>2026:05:06 06:41:40+00:00</System:FileAccessDate> + <System:FileInodeChangeDate>2026:05:06 06:42:06+00:00</System:FileInodeChangeDate> + <System:FilePermissions>-rw-r--r--</System:FilePermissions> + <File:FileType>XMP</File:FileType> + <File:FileTypeExtension>xmp</File:FileTypeExtension> + <File:MIMEType>application/rdf+xml</File:MIMEType> + <XMP-x:XMPToolkit>Adobe XMP Core 9.1-c002 165.59ab891, 2024/09/18-09:57:10 </XMP-x:XMPToolkit> + <XMP-exif:ExifVersion>0231</XMP-exif:ExifVersion> + <XMP-exif:ExifImageWidth>1599</XMP-exif:ExifImageWidth> + <XMP-exif:ExifImageHeight>1066</XMP-exif:ExifImageHeight> + <XMP-exif:ColorSpace>Uncalibrated</XMP-exif:ColorSpace> + <XMP-exif:GPSLatitude>52 deg 26' 35.09" N</XMP-exif:GPSLatitude> + <XMP-exif:GPSProcessingMethod>MANUAL</XMP-exif:GPSProcessingMethod> + <XMP-exif:GPSLongitude>13 deg 34' 35.81" E</XMP-exif:GPSLongitude> + <XMP-exif:GPSAltitudeRef>Above Sea Level</XMP-exif:GPSAltitudeRef> + <XMP-exif:GPSAltitude>15000 m</XMP-exif:GPSAltitude> + <XMP-exif:DateTimeOriginal>2021:01:24 08:28:28+01:00</XMP-exif:DateTimeOriginal> + <XMP-tiff:Orientation>Horizontal (normal)</XMP-tiff:Orientation> + <XMP-tiff:ImageWidth>1599</XMP-tiff:ImageWidth> + <XMP-tiff:ImageHeight>1066</XMP-tiff:ImageHeight> + <XMP-tiff:PhotometricInterpretation>RGB</XMP-tiff:PhotometricInterpretation> + <XMP-tiff:SamplesPerPixel>3</XMP-tiff:SamplesPerPixel> + <XMP-tiff:XResolution>1</XMP-tiff:XResolution> + <XMP-tiff:YResolution>1</XMP-tiff:YResolution> + <XMP-tiff:ResolutionUnit>None</XMP-tiff:ResolutionUnit> + <XMP-tiff:BitsPerSample> + <rdf:Bag> + <rdf:li>8</rdf:li> + <rdf:li>8</rdf:li> + <rdf:li>8</rdf:li> + </rdf:Bag> + </XMP-tiff:BitsPerSample> + <XMP-xmpMM:DocumentID>7386F4EF875E59E482D08597C0D25DB7</XMP-xmpMM:DocumentID> + <XMP-xmpMM:OriginalDocumentID>7386F4EF875E59E482D08597C0D25DB7</XMP-xmpMM:OriginalDocumentID> + <XMP-xmpMM:InstanceID>xmp.iid:5b51221e-0c75-412c-93da-f71cb4a8a0d7</XMP-xmpMM:InstanceID> + <XMP-xmpMM:HistoryAction> + <rdf:Bag> + <rdf:li>saved</rdf:li> + <rdf:li>saved</rdf:li> + </rdf:Bag> + </XMP-xmpMM:HistoryAction> + <XMP-xmpMM:HistoryInstanceID> + <rdf:Bag> + <rdf:li>xmp.iid:113d1054-020b-4d10-bc66-38aff071f520</rdf:li> + <rdf:li>xmp.iid:5b51221e-0c75-412c-93da-f71cb4a8a0d7</rdf:li> + </rdf:Bag> + </XMP-xmpMM:HistoryInstanceID> + <XMP-xmpMM:HistoryWhen> + <rdf:Bag> + <rdf:li>2025:07:25 14:28:38+02:00</rdf:li> + <rdf:li>2026:04:28 11:54:38+02:00</rdf:li> + </rdf:Bag> + </XMP-xmpMM:HistoryWhen> + <XMP-xmpMM:HistorySoftwareAgent> + <rdf:Bag> + <rdf:li>Adobe Photoshop Camera Raw 17.4</rdf:li> + <rdf:li>Adobe Photoshop Camera Raw 17.4</rdf:li> + </rdf:Bag> + </XMP-xmpMM:HistorySoftwareAgent> + <XMP-xmpMM:HistoryChanged> + <rdf:Bag> + <rdf:li>/metadata</rdf:li> + <rdf:li>/metadata</rdf:li> + </rdf:Bag> + </XMP-xmpMM:HistoryChanged> + <XMP-dc:Format>image/jpeg</XMP-dc:Format> + <XMP-dc:Creator>Theresa Creator</XMP-dc:Creator> + <XMP-dc:Description>Description from Theresa</XMP-dc:Description> + <XMP-dc:Subject> + <rdf:Bag> + <rdf:li>keyworda</rdf:li> + <rdf:li>keywordb</rdf:li> + <rdf:li>keywordc</rdf:li> + </rdf:Bag> + </XMP-dc:Subject> + <XMP-dc:Title>Document Title Created with Bridge</XMP-dc:Title> + <XMP-dc:Rights>copyright notice</XMP-dc:Rights> + <XMP-photoshop:ColorMode>RGB</XMP-photoshop:ColorMode> + <XMP-photoshop:AuthorsPosition>Bridge Job Title</XMP-photoshop:AuthorsPosition> + <XMP-photoshop:Headline>Headline from Photoshop</XMP-photoshop:Headline> + <XMP-photoshop:DateCreated>2026:05:01 02:30:15</XMP-photoshop:DateCreated> + <XMP-xmp:Label>Review</XMP-xmp:Label> + <XMP-xmp:MetadataDate>2026:04:28 11:54:38+02:00</XMP-xmp:MetadataDate> + <XMP-xmp:Rating>4</XMP-xmp:Rating> + <XMP-xmpRights:WebStatement>legal url.de</XMP-xmpRights:WebStatement> + <XMP-xmpRights:UsageTerms>right usage terms</XMP-xmpRights:UsageTerms> + <XMP-iptcCore:CreatorAddress>Some Street</XMP-iptcCore:CreatorAddress> + <XMP-iptcCore:CreatorCity>Berlin</XMP-iptcCore:CreatorCity> + <XMP-iptcCore:CreatorRegion>Berlin</XMP-iptcCore:CreatorRegion> + <XMP-iptcCore:CreatorPostalCode>12163</XMP-iptcCore:CreatorPostalCode> + <XMP-iptcCore:CreatorCountry>Deutschland</XMP-iptcCore:CreatorCountry> + <XMP-iptcCore:CreatorWorkTelephone>030/123456</XMP-iptcCore:CreatorWorkTelephone> + <XMP-iptcCore:CreatorWorkEmail>test@mail.com</XMP-iptcCore:CreatorWorkEmail> + <XMP-iptcCore:CreatorWorkURL>www.website.de</XMP-iptcCore:CreatorWorkURL> + <XMP-iptcCore:AltTextAccessibility>nice alt text</XMP-iptcCore:AltTextAccessibility> + <XMP-iptcCore:ExtDescrAccessibility>extended description</XMP-iptcCore:ExtDescrAccessibility> + <XMP-kbrg:InitialEditCaptureTime>2021:01:24 03:28:28+01:00</XMP-kbrg:InitialEditCaptureTime> + <Composite:ImageSize>1599x1066</Composite:ImageSize> + <Composite:Megapixels>1.7</Composite:Megapixels> + <Composite:GPSAltitude>15000 m Above Sea Level</Composite:GPSAltitude> + <Composite:GPSLatitudeRef>North</Composite:GPSLatitudeRef> + <Composite:GPSLongitudeRef>East</Composite:GPSLongitudeRef> + <Composite:GPSPosition>52 deg 26' 35.09" N, 13 deg 34' 35.81" E</Composite:GPSPosition> +</rdf:Description> +</rdf:RDF> diff --git a/internal/meta/testdata/xmp/adobe/bridge-2.xmp b/internal/meta/testdata/xmp/adobe/bridge-2.xmp new file mode 100644 index 000000000..5aaf0f02e --- /dev/null +++ b/internal/meta/testdata/xmp/adobe/bridge-2.xmp @@ -0,0 +1,147 @@ +<?xpacket begin="" id="W5M0MpCehiHzreSzNTczkc9d"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="Adobe XMP Core 9.1-c002 165.59ab891, 2024/09/18-09:57:10 "> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:exif="http://ns.adobe.com/exif/1.0/" + xmlns:tiff="http://ns.adobe.com/tiff/1.0/" + xmlns:xmpMM="http://ns.adobe.com/xap/1.0/mm/" + xmlns:stEvt="http://ns.adobe.com/xap/1.0/sType/ResourceEvent#" + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:photoshop="http://ns.adobe.com/photoshop/1.0/" + xmlns:xmp="http://ns.adobe.com/xap/1.0/" + xmlns:xmpRights="http://ns.adobe.com/xap/1.0/rights/" + xmlns:Iptc4xmpCore="http://iptc.org/std/Iptc4xmpCore/1.0/xmlns/" + xmlns:kbrg="http://ns.adobe.com/bridge/1.0/"> + <exif:ExifVersion>0231</exif:ExifVersion> + <exif:PixelXDimension>1599</exif:PixelXDimension> + <exif:PixelYDimension>1066</exif:PixelYDimension> + <exif:ColorSpace>65535</exif:ColorSpace> + <exif:GPSLatitude>52,26.5849N</exif:GPSLatitude> + <exif:GPSProcessingMethod>MANUAL</exif:GPSProcessingMethod> + <exif:GPSLongitude>013,34.5968E</exif:GPSLongitude> + <exif:GPSAltitudeRef>0</exif:GPSAltitudeRef> + <exif:GPSAltitude>1500000/100</exif:GPSAltitude> + <exif:DateTimeOriginal>2021-01-24T08:28:28+01:00</exif:DateTimeOriginal> + <tiff:Orientation>1</tiff:Orientation> + <tiff:ImageWidth>1599</tiff:ImageWidth> + <tiff:ImageLength>1066</tiff:ImageLength> + <tiff:PhotometricInterpretation>2</tiff:PhotometricInterpretation> + <tiff:SamplesPerPixel>3</tiff:SamplesPerPixel> + <tiff:XResolution>1/1</tiff:XResolution> + <tiff:YResolution>1/1</tiff:YResolution> + <tiff:ResolutionUnit>1</tiff:ResolutionUnit> + <tiff:BitsPerSample> + <rdf:Seq> + <rdf:li>8</rdf:li> + <rdf:li>8</rdf:li> + <rdf:li>8</rdf:li> + </rdf:Seq> + </tiff:BitsPerSample> + <xmpMM:DocumentID>7386F4EF875E59E482D08597C0D25DB7</xmpMM:DocumentID> + <xmpMM:OriginalDocumentID>7386F4EF875E59E482D08597C0D25DB7</xmpMM:OriginalDocumentID> + <xmpMM:InstanceID>xmp.iid:5b51221e-0c75-412c-93da-f71cb4a8a0d7</xmpMM:InstanceID> + <xmpMM:History> + <rdf:Seq> + <rdf:li rdf:parseType="Resource"> + <stEvt:action>saved</stEvt:action> + <stEvt:instanceID>xmp.iid:113d1054-020b-4d10-bc66-38aff071f520</stEvt:instanceID> + <stEvt:when>2025-07-25T14:28:38+02:00</stEvt:when> + <stEvt:softwareAgent>Adobe Photoshop Camera Raw 17.4</stEvt:softwareAgent> + <stEvt:changed>/metadata</stEvt:changed> + </rdf:li> + <rdf:li rdf:parseType="Resource"> + <stEvt:action>saved</stEvt:action> + <stEvt:instanceID>xmp.iid:5b51221e-0c75-412c-93da-f71cb4a8a0d7</stEvt:instanceID> + <stEvt:when>2026-04-28T11:54:38+02:00</stEvt:when> + <stEvt:softwareAgent>Adobe Photoshop Camera Raw 17.4</stEvt:softwareAgent> + <stEvt:changed>/metadata</stEvt:changed> + </rdf:li> + </rdf:Seq> + </xmpMM:History> + <dc:format>image/jpeg</dc:format> + <dc:creator> + <rdf:Seq> + <rdf:li>Theresa Creator</rdf:li> + </rdf:Seq> + </dc:creator> + <dc:description> + <rdf:Alt> + <rdf:li xml:lang="x-default">Description from Theresa</rdf:li> + </rdf:Alt> + </dc:description> + <dc:subject> + <rdf:Bag> + <rdf:li>keyworda</rdf:li> + <rdf:li>keywordb</rdf:li> + <rdf:li>keywordc</rdf:li> + </rdf:Bag> + </dc:subject> + <dc:title> + <rdf:Alt> + <rdf:li xml:lang="x-default">Document Title Created with Bridge</rdf:li> + </rdf:Alt> + </dc:title> + <dc:rights> + <rdf:Alt> + <rdf:li xml:lang="x-default">copyright notice</rdf:li> + </rdf:Alt> + </dc:rights> + <photoshop:ColorMode>3</photoshop:ColorMode> + <photoshop:AuthorsPosition>Bridge Job Title</photoshop:AuthorsPosition> + <photoshop:Headline>Headline from Photoshop</photoshop:Headline> + <photoshop:DateCreated>2026-05-01T02:30:15</photoshop:DateCreated> + <xmp:Label>Review</xmp:Label> + <xmp:MetadataDate>2026-04-28T11:54:38+02:00</xmp:MetadataDate> + <xmp:Rating>4</xmp:Rating> + <xmpRights:WebStatement>legal url.de</xmpRights:WebStatement> + <xmpRights:UsageTerms> + <rdf:Alt> + <rdf:li xml:lang="x-default">right usage terms</rdf:li> + </rdf:Alt> + </xmpRights:UsageTerms> + <Iptc4xmpCore:CreatorContactInfo rdf:parseType="Resource"> + <Iptc4xmpCore:CiAdrExtadr>Some Street</Iptc4xmpCore:CiAdrExtadr> + <Iptc4xmpCore:CiAdrCity>Berlin</Iptc4xmpCore:CiAdrCity> + <Iptc4xmpCore:CiAdrRegion>Berlin</Iptc4xmpCore:CiAdrRegion> + <Iptc4xmpCore:CiAdrPcode>12163</Iptc4xmpCore:CiAdrPcode> + <Iptc4xmpCore:CiAdrCtry>Deutschland</Iptc4xmpCore:CiAdrCtry> + <Iptc4xmpCore:CiTelWork>030/123456</Iptc4xmpCore:CiTelWork> + <Iptc4xmpCore:CiEmailWork>test@mail.com</Iptc4xmpCore:CiEmailWork> + <Iptc4xmpCore:CiUrlWork>www.website.de</Iptc4xmpCore:CiUrlWork> + </Iptc4xmpCore:CreatorContactInfo> + <Iptc4xmpCore:AltTextAccessibility> + <rdf:Alt> + <rdf:li xml:lang="x-default">nice alt text</rdf:li> + </rdf:Alt> + </Iptc4xmpCore:AltTextAccessibility> + <Iptc4xmpCore:ExtDescrAccessibility> + <rdf:Alt> + <rdf:li xml:lang="x-default">extended description</rdf:li> + </rdf:Alt> + </Iptc4xmpCore:ExtDescrAccessibility> + <kbrg:InitialEditCaptureTime>2021-01-24T03:28:28+01:00</kbrg:InitialEditCaptureTime> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> + + + + + + + + + + + + + + + + + + + + + +<?xpacket end="w"?> \ No newline at end of file diff --git a/internal/meta/testdata/xmp/adobe/bridge.exiftool.txt b/internal/meta/testdata/xmp/adobe/bridge.exiftool.txt new file mode 100644 index 000000000..d586e16a4 --- /dev/null +++ b/internal/meta/testdata/xmp/adobe/bridge.exiftool.txt @@ -0,0 +1,130 @@ +<?xml version='1.0' encoding='UTF-8'?> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> + +<rdf:Description rdf:about='internal/meta/testdata/xmp/adobe/bridge.xmp' + xmlns:et='http://ns.exiftool.org/1.0/' et:toolkit='Image::ExifTool 13.25' + xmlns:ExifTool='http://ns.exiftool.org/ExifTool/1.0/' + xmlns:System='http://ns.exiftool.org/File/System/1.0/' + xmlns:File='http://ns.exiftool.org/File/1.0/' + xmlns:XMP-x='http://ns.exiftool.org/XMP/XMP-x/1.0/' + xmlns:XMP-xmp='http://ns.exiftool.org/XMP/XMP-xmp/1.0/' + xmlns:XMP-tiff='http://ns.exiftool.org/XMP/XMP-tiff/1.0/' + xmlns:XMP-exif='http://ns.exiftool.org/XMP/XMP-exif/1.0/' + xmlns:XMP-dc='http://ns.exiftool.org/XMP/XMP-dc/1.0/' + xmlns:XMP-aux='http://ns.exiftool.org/XMP/XMP-aux/1.0/' + xmlns:XMP-exifEX='http://ns.exiftool.org/XMP/XMP-exifEX/1.0/' + xmlns:XMP-photoshop='http://ns.exiftool.org/XMP/XMP-photoshop/1.0/' + xmlns:XMP-xmpMM='http://ns.exiftool.org/XMP/XMP-xmpMM/1.0/' + xmlns:XMP-crd='http://ns.exiftool.org/XMP/XMP-crd/1.0/' + xmlns:Composite='http://ns.exiftool.org/Composite/1.0/'> + <ExifTool:ExifToolVersion>13.25</ExifTool:ExifToolVersion> + <System:FileName>bridge.xmp</System:FileName> + <System:Directory>internal/meta/testdata/xmp/adobe</System:Directory> + <System:FileSize>8.1 kB</System:FileSize> + <System:FileModifyDate>2026:05:06 06:39:32+00:00</System:FileModifyDate> + <System:FileAccessDate>2026:05:06 06:42:01+00:00</System:FileAccessDate> + <System:FileInodeChangeDate>2026:05:06 06:42:06+00:00</System:FileInodeChangeDate> + <System:FilePermissions>-rw-r--r--</System:FilePermissions> + <File:FileType>XMP</File:FileType> + <File:FileTypeExtension>xmp</File:FileTypeExtension> + <File:MIMEType>application/rdf+xml</File:MIMEType> + <XMP-x:XMPToolkit>Adobe XMP Core 9.1-c002 165.59ab891, 2024/09/18-09:57:10 </XMP-x:XMPToolkit> + <XMP-xmp:Rating>0</XMP-xmp:Rating> + <XMP-xmp:ModifyDate>2026:03:22 16:32:42.55</XMP-xmp:ModifyDate> + <XMP-xmp:CreateDate>2026:03:22 16:32:42.55</XMP-xmp:CreateDate> + <XMP-xmp:MetadataDate>2026:04:28 12:02:29+02:00</XMP-xmp:MetadataDate> + <XMP-tiff:Make>Canon</XMP-tiff:Make> + <XMP-tiff:Model>Canon EOS M6</XMP-tiff:Model> + <XMP-tiff:Orientation>Horizontal (normal)</XMP-tiff:Orientation> + <XMP-tiff:ImageWidth>6000</XMP-tiff:ImageWidth> + <XMP-tiff:ImageHeight>4000</XMP-tiff:ImageHeight> + <XMP-tiff:PhotometricInterpretation>RGB</XMP-tiff:PhotometricInterpretation> + <XMP-tiff:SamplesPerPixel>3</XMP-tiff:SamplesPerPixel> + <XMP-tiff:BitsPerSample> + <rdf:Bag> + <rdf:li>16</rdf:li> + <rdf:li>16</rdf:li> + <rdf:li>16</rdf:li> + </rdf:Bag> + </XMP-tiff:BitsPerSample> + <XMP-exif:ExifVersion>0230</XMP-exif:ExifVersion> + <XMP-exif:ExposureTime>1/100</XMP-exif:ExposureTime> + <XMP-exif:ShutterSpeedValue>1/100</XMP-exif:ShutterSpeedValue> + <XMP-exif:FNumber>8.0</XMP-exif:FNumber> + <XMP-exif:ApertureValue>8.0</XMP-exif:ApertureValue> + <XMP-exif:ExposureProgram>Program AE</XMP-exif:ExposureProgram> + <XMP-exif:SensitivityType>2</XMP-exif:SensitivityType> + <XMP-exif:RecommendedExposureIndex>100</XMP-exif:RecommendedExposureIndex> + <XMP-exif:ExposureCompensation>0</XMP-exif:ExposureCompensation> + <XMP-exif:MaxApertureValue>6.3</XMP-exif:MaxApertureValue> + <XMP-exif:MeteringMode>Multi-segment</XMP-exif:MeteringMode> + <XMP-exif:FocalLength>45.0 mm</XMP-exif:FocalLength> + <XMP-exif:SensingMethod>One-chip color area</XMP-exif:SensingMethod> + <XMP-exif:FileSource>Digital Camera</XMP-exif:FileSource> + <XMP-exif:CustomRendered>Normal</XMP-exif:CustomRendered> + <XMP-exif:ExposureMode>Auto</XMP-exif:ExposureMode> + <XMP-exif:WhiteBalance>Auto</XMP-exif:WhiteBalance> + <XMP-exif:SceneCaptureType>Standard</XMP-exif:SceneCaptureType> + <XMP-exif:DigitalZoomRatio>1</XMP-exif:DigitalZoomRatio> + <XMP-exif:FocalPlaneXResolution>2688.72659301758</XMP-exif:FocalPlaneXResolution> + <XMP-exif:FocalPlaneYResolution>2688.72659301758</XMP-exif:FocalPlaneYResolution> + <XMP-exif:FocalPlaneResolutionUnit>cm</XMP-exif:FocalPlaneResolutionUnit> + <XMP-exif:DateTimeOriginal>2026:03:22 16:32:42.55</XMP-exif:DateTimeOriginal> + <XMP-exif:ISO>100</XMP-exif:ISO> + <XMP-exif:FlashFired>False</XMP-exif:FlashFired> + <XMP-exif:FlashReturn>No return detection</XMP-exif:FlashReturn> + <XMP-exif:FlashMode>Off</XMP-exif:FlashMode> + <XMP-exif:FlashFunction>False</XMP-exif:FlashFunction> + <XMP-exif:FlashRedEyeMode>False</XMP-exif:FlashRedEyeMode> + <XMP-exif:ExifImageWidth>6000</XMP-exif:ExifImageWidth> + <XMP-exif:ExifImageHeight>4000</XMP-exif:ExifImageHeight> + <XMP-exif:GPSLatitude>27 deg 20' 25.58" S</XMP-exif:GPSLatitude> + <XMP-exif:GPSProcessingMethod>MANUAL</XMP-exif:GPSProcessingMethod> + <XMP-exif:GPSLongitude>31 deg 53' 33.17" E</XMP-exif:GPSLongitude> + <XMP-exif:GPSAltitudeRef>Above Sea Level</XMP-exif:GPSAltitudeRef> + <XMP-exif:GPSAltitude>13300 m</XMP-exif:GPSAltitude> + <XMP-dc:Creator>John Doe</XMP-dc:Creator> + <XMP-dc:Rights>Attribution 4.0 International (CC BY 4.0)</XMP-dc:Rights> + <XMP-dc:Format>image/x-canon-cr2</XMP-dc:Format> + <XMP-aux:SerialNumber>453051001355</XMP-aux:SerialNumber> + <XMP-aux:LensInfo>15-45mm f/?</XMP-aux:LensInfo> + <XMP-aux:Lens>EF-M15-45mm f/3.5-6.3 IS STM</XMP-aux:Lens> + <XMP-aux:LensID>4153</XMP-aux:LensID> + <XMP-aux:LensSerialNumber>0000027443</XMP-aux:LensSerialNumber> + <XMP-aux:ImageNumber>0</XMP-aux:ImageNumber> + <XMP-aux:ApproximateFocusDistance>infinity</XMP-aux:ApproximateFocusDistance> + <XMP-aux:FlashCompensation>0</XMP-aux:FlashCompensation> + <XMP-aux:Firmware>1.00</XMP-aux:Firmware> + <XMP-exifEX:LensModel>EF-M15-45mm f/3.5-6.3 IS STM</XMP-exifEX:LensModel> + <XMP-photoshop:DateCreated>2026:03:22 16:32:42.55</XMP-photoshop:DateCreated> + <XMP-photoshop:ColorMode>RGB</XMP-photoshop:ColorMode> + <XMP-photoshop:ICCProfileName></XMP-photoshop:ICCProfileName> + <XMP-xmpMM:DocumentID>804D95FE1D9E0CAB7430688EB0347B77</XMP-xmpMM:DocumentID> + <XMP-xmpMM:OriginalDocumentID>804D95FE1D9E0CAB7430688EB0347B77</XMP-xmpMM:OriginalDocumentID> + <XMP-xmpMM:InstanceID>xmp.iid:327258bf-032d-4acd-9a2b-aa12611d3dfb</XMP-xmpMM:InstanceID> + <XMP-xmpMM:HistoryAction>saved</XMP-xmpMM:HistoryAction> + <XMP-xmpMM:HistoryInstanceID>xmp.iid:327258bf-032d-4acd-9a2b-aa12611d3dfb</XMP-xmpMM:HistoryInstanceID> + <XMP-xmpMM:HistoryWhen>2026:04:28 12:02:29+02:00</XMP-xmpMM:HistoryWhen> + <XMP-xmpMM:HistorySoftwareAgent>Adobe Photoshop Camera Raw 17.4</XMP-xmpMM:HistorySoftwareAgent> + <XMP-xmpMM:HistoryChanged>/metadata</XMP-xmpMM:HistoryChanged> + <XMP-crd:CameraProfile>Camera Auto</XMP-crd:CameraProfile> + <XMP-crd:LookName></XMP-crd:LookName> + <Composite:Aperture>8.0</Composite:Aperture> + <Composite:ImageSize>6000x4000</Composite:ImageSize> + <Composite:Megapixels>24.0</Composite:Megapixels> + <Composite:ScaleFactor35efl>1.6</Composite:ScaleFactor35efl> + <Composite:ShutterSpeed>1/100</Composite:ShutterSpeed> + <Composite:GPSAltitude>13300 m Above Sea Level</Composite:GPSAltitude> + <Composite:Flash>Off, Did not fire</Composite:Flash> + <Composite:GPSLatitudeRef>South</Composite:GPSLatitudeRef> + <Composite:GPSLongitudeRef>East</Composite:GPSLongitudeRef> + <Composite:CircleOfConfusion>0.019 mm</Composite:CircleOfConfusion> + <Composite:DOF>inf (13.59 m - inf)</Composite:DOF> + <Composite:FOV>27.9 deg</Composite:FOV> + <Composite:FocalLength35efl>45.0 mm (35 mm equivalent: 72.6 mm)</Composite:FocalLength35efl> + <Composite:GPSPosition>27 deg 20' 25.58" S, 31 deg 53' 33.17" E</Composite:GPSPosition> + <Composite:HyperfocalDistance>13.59 m</Composite:HyperfocalDistance> + <Composite:LightValue>12.6</Composite:LightValue> + <Composite:LensID>Canon EF-M 15-45mm f/3.5-6.3 IS STM</Composite:LensID> +</rdf:Description> +</rdf:RDF> diff --git a/internal/meta/testdata/xmp/adobe/bridge.xmp b/internal/meta/testdata/xmp/adobe/bridge.xmp new file mode 100644 index 000000000..dc3ddd89b --- /dev/null +++ b/internal/meta/testdata/xmp/adobe/bridge.xmp @@ -0,0 +1,139 @@ +<?xpacket begin="" id="W5M0MpCehiHzreSzNTczkc9d"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="Adobe XMP Core 9.1-c002 165.59ab891, 2024/09/18-09:57:10 "> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:xmp="http://ns.adobe.com/xap/1.0/" + xmlns:tiff="http://ns.adobe.com/tiff/1.0/" + xmlns:exif="http://ns.adobe.com/exif/1.0/" + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:aux="http://ns.adobe.com/exif/1.0/aux/" + xmlns:exifEX="http://cipa.jp/exif/1.0/" + xmlns:photoshop="http://ns.adobe.com/photoshop/1.0/" + xmlns:xmpMM="http://ns.adobe.com/xap/1.0/mm/" + xmlns:stEvt="http://ns.adobe.com/xap/1.0/sType/ResourceEvent#" + xmlns:crd="http://ns.adobe.com/camera-raw-defaults/1.0/"> + <xmp:Rating>0</xmp:Rating> + <xmp:ModifyDate>2026-03-22T16:32:42.55</xmp:ModifyDate> + <xmp:CreateDate>2026-03-22T16:32:42.55</xmp:CreateDate> + <xmp:MetadataDate>2026-04-28T12:02:29+02:00</xmp:MetadataDate> + <tiff:Make>Canon</tiff:Make> + <tiff:Model>Canon EOS M6</tiff:Model> + <tiff:Orientation>1</tiff:Orientation> + <tiff:ImageWidth>6000</tiff:ImageWidth> + <tiff:ImageLength>4000</tiff:ImageLength> + <tiff:PhotometricInterpretation>2</tiff:PhotometricInterpretation> + <tiff:SamplesPerPixel>3</tiff:SamplesPerPixel> + <tiff:BitsPerSample> + <rdf:Seq> + <rdf:li>16</rdf:li> + <rdf:li>16</rdf:li> + <rdf:li>16</rdf:li> + </rdf:Seq> + </tiff:BitsPerSample> + <exif:ExifVersion>0230</exif:ExifVersion> + <exif:ExposureTime>1/100</exif:ExposureTime> + <exif:ShutterSpeedValue>6643856/1000000</exif:ShutterSpeedValue> + <exif:FNumber>8/1</exif:FNumber> + <exif:ApertureValue>6/1</exif:ApertureValue> + <exif:ExposureProgram>2</exif:ExposureProgram> + <exif:SensitivityType>2</exif:SensitivityType> + <exif:RecommendedExposureIndex>100</exif:RecommendedExposureIndex> + <exif:ExposureBiasValue>0/3</exif:ExposureBiasValue> + <exif:MaxApertureValue>53125/10000</exif:MaxApertureValue> + <exif:MeteringMode>5</exif:MeteringMode> + <exif:FocalLength>45/1</exif:FocalLength> + <exif:SensingMethod>2</exif:SensingMethod> + <exif:FileSource>3</exif:FileSource> + <exif:CustomRendered>0</exif:CustomRendered> + <exif:ExposureMode>0</exif:ExposureMode> + <exif:WhiteBalance>0</exif:WhiteBalance> + <exif:SceneCaptureType>0</exif:SceneCaptureType> + <exif:DigitalZoomRatio>6000/6000</exif:DigitalZoomRatio> + <exif:FocalPlaneXResolution>88104193/32768</exif:FocalPlaneXResolution> + <exif:FocalPlaneYResolution>88104193/32768</exif:FocalPlaneYResolution> + <exif:FocalPlaneResolutionUnit>3</exif:FocalPlaneResolutionUnit> + <exif:DateTimeOriginal>2026-03-22T16:32:42.55</exif:DateTimeOriginal> + <exif:ISOSpeedRatings> + <rdf:Seq> + <rdf:li>100</rdf:li> + </rdf:Seq> + </exif:ISOSpeedRatings> + <exif:Flash rdf:parseType="Resource"> + <exif:Fired>False</exif:Fired> + <exif:Return>0</exif:Return> + <exif:Mode>2</exif:Mode> + <exif:Function>False</exif:Function> + <exif:RedEyeMode>False</exif:RedEyeMode> + </exif:Flash> + <exif:PixelXDimension>6000</exif:PixelXDimension> + <exif:PixelYDimension>4000</exif:PixelYDimension> + <exif:GPSLatitude>27,20.4263S</exif:GPSLatitude> + <exif:GPSProcessingMethod>MANUAL</exif:GPSProcessingMethod> + <exif:GPSLongitude>031,53.5529E</exif:GPSLongitude> + <exif:GPSAltitudeRef>0</exif:GPSAltitudeRef> + <exif:GPSAltitude>1330000/100</exif:GPSAltitude> + <dc:creator> + <rdf:Seq> + <rdf:li>John Doe</rdf:li> + </rdf:Seq> + </dc:creator> + <dc:rights> + <rdf:Alt> + <rdf:li xml:lang="x-default">Attribution 4.0 International (CC BY 4.0)</rdf:li> + </rdf:Alt> + </dc:rights> + <dc:format>image/x-canon-cr2</dc:format> + <aux:SerialNumber>453051001355</aux:SerialNumber> + <aux:LensInfo>15/1 45/1 0/0 0/0</aux:LensInfo> + <aux:Lens>EF-M15-45mm f/3.5-6.3 IS STM</aux:Lens> + <aux:LensID>4153</aux:LensID> + <aux:LensSerialNumber>0000027443</aux:LensSerialNumber> + <aux:ImageNumber>0</aux:ImageNumber> + <aux:ApproximateFocusDistance>4294967295/1</aux:ApproximateFocusDistance> + <aux:FlashCompensation>0/1</aux:FlashCompensation> + <aux:Firmware>1.00</aux:Firmware> + <exifEX:LensModel>EF-M15-45mm f/3.5-6.3 IS STM</exifEX:LensModel> + <photoshop:DateCreated>2026-03-22T16:32:42.55</photoshop:DateCreated> + <photoshop:ColorMode>3</photoshop:ColorMode> + <photoshop:ICCProfile/> + <xmpMM:DocumentID>804D95FE1D9E0CAB7430688EB0347B77</xmpMM:DocumentID> + <xmpMM:OriginalDocumentID>804D95FE1D9E0CAB7430688EB0347B77</xmpMM:OriginalDocumentID> + <xmpMM:InstanceID>xmp.iid:327258bf-032d-4acd-9a2b-aa12611d3dfb</xmpMM:InstanceID> + <xmpMM:History> + <rdf:Seq> + <rdf:li rdf:parseType="Resource"> + <stEvt:action>saved</stEvt:action> + <stEvt:instanceID>xmp.iid:327258bf-032d-4acd-9a2b-aa12611d3dfb</stEvt:instanceID> + <stEvt:when>2026-04-28T12:02:29+02:00</stEvt:when> + <stEvt:softwareAgent>Adobe Photoshop Camera Raw 17.4</stEvt:softwareAgent> + <stEvt:changed>/metadata</stEvt:changed> + </rdf:li> + </rdf:Seq> + </xmpMM:History> + <crd:CameraProfile>Camera Auto</crd:CameraProfile> + <crd:LookName/> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> + + + + + + + + + + + + + + + + + + + + + +<?xpacket end="w"?> \ No newline at end of file diff --git a/internal/meta/testdata/xmp/darktable/aurora.jpg.exiftool.txt b/internal/meta/testdata/xmp/darktable/aurora.jpg.exiftool.txt new file mode 100644 index 000000000..81c898fce --- /dev/null +++ b/internal/meta/testdata/xmp/darktable/aurora.jpg.exiftool.txt @@ -0,0 +1,118 @@ +<?xml version='1.0' encoding='UTF-8'?> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> + +<rdf:Description rdf:about='internal/meta/testdata/xmp/darktable/aurora.jpg.xmp' + xmlns:et='http://ns.exiftool.org/1.0/' et:toolkit='Image::ExifTool 13.25' + xmlns:ExifTool='http://ns.exiftool.org/ExifTool/1.0/' + xmlns:System='http://ns.exiftool.org/File/System/1.0/' + xmlns:File='http://ns.exiftool.org/File/1.0/' + xmlns:XMP-x='http://ns.exiftool.org/XMP/XMP-x/1.0/' + xmlns:XMP-exif='http://ns.exiftool.org/XMP/XMP-exif/1.0/' + xmlns:XMP-xmpMM='http://ns.exiftool.org/XMP/XMP-xmpMM/1.0/' + xmlns:XMP-xmp='http://ns.exiftool.org/XMP/XMP-xmp/1.0/' + xmlns:XMP-darktable='http://ns.exiftool.org/XMP/XMP-darktable/1.0/' + xmlns:XMP-acdsee='http://ns.exiftool.org/XMP/XMP-acdsee/1.0/' + xmlns:XMP-dc='http://ns.exiftool.org/XMP/XMP-dc/1.0/' + xmlns:XMP-lr='http://ns.exiftool.org/XMP/XMP-lr/1.0/' + xmlns:Composite='http://ns.exiftool.org/Composite/1.0/'> + <ExifTool:ExifToolVersion>13.25</ExifTool:ExifToolVersion> + <System:FileName>aurora.jpg.xmp</System:FileName> + <System:Directory>internal/meta/testdata/xmp/darktable</System:Directory> + <System:FileSize>4.3 kB</System:FileSize> + <System:FileModifyDate>2026:05:06 06:49:32+00:00</System:FileModifyDate> + <System:FileAccessDate>2026:05:06 06:50:54+00:00</System:FileAccessDate> + <System:FileInodeChangeDate>2026:05:06 06:53:16+00:00</System:FileInodeChangeDate> + <System:FilePermissions>-rw-r--r--</System:FilePermissions> + <File:FileType>XMP</File:FileType> + <File:FileTypeExtension>xmp</File:FileTypeExtension> + <File:MIMEType>application/rdf+xml</File:MIMEType> + <XMP-x:XMPToolkit>XMP Core 4.4.0-Exiv2</XMP-x:XMPToolkit> + <XMP-exif:DateTimeOriginal></XMP-exif:DateTimeOriginal> + <XMP-exif:GPSVersionID>2.2.0.0</XMP-exif:GPSVersionID> + <XMP-exif:GPSLongitude>179 deg 59' 32.81" W</XMP-exif:GPSLongitude> + <XMP-exif:GPSLatitude>87 deg 21' 17.52" N</XMP-exif:GPSLatitude> + <XMP-xmpMM:DerivedFrom>aurora.jpg</XMP-xmpMM:DerivedFrom> + <XMP-xmp:Rating>1</XMP-xmp:Rating> + <XMP-darktable:Import_timestamp>63913646604991295</XMP-darktable:Import_timestamp> + <XMP-darktable:Change_timestamp>-1</XMP-darktable:Change_timestamp> + <XMP-darktable:Export_timestamp>63913646961369095</XMP-darktable:Export_timestamp> + <XMP-darktable:Print_timestamp>-1</XMP-darktable:Print_timestamp> + <XMP-darktable:Xmp_version>5</XMP-darktable:Xmp_version> + <XMP-darktable:Raw_params>0</XMP-darktable:Raw_params> + <XMP-darktable:Auto_presets_applied>1</XMP-darktable:Auto_presets_applied> + <XMP-darktable:History_end>4</XMP-darktable:History_end> + <XMP-darktable:Iop_order_version>5</XMP-darktable:Iop_order_version> + <XMP-darktable:History_basic_hash>02d4cdbda625305c5e181669466f51d2</XMP-darktable:History_basic_hash> + <XMP-darktable:History_current_hash>02d4cdbda625305c5e181669466f51d2</XMP-darktable:History_current_hash> + <XMP-darktable:Masks_history></XMP-darktable:Masks_history> + <XMP-darktable:HistoryNum>0</XMP-darktable:HistoryNum> + <XMP-darktable:HistoryOperation>colorin</XMP-darktable:HistoryOperation> + <XMP-darktable:HistoryEnabled>1</XMP-darktable:HistoryEnabled> + <XMP-darktable:HistoryModversion>7</XMP-darktable:HistoryModversion> + <XMP-darktable:HistoryParamsgz48eJzjZBgFowABWAbaAaNgwAEAMNgADg> + darktable:multi_name=</XMP-darktable:HistoryParamsgz48eJzjZBgFowABWAbaAaNgwAEAMNgADg> + <XMP-darktable:HistoryMulti_name_hand_edited>0</XMP-darktable:HistoryMulti_name_hand_edited> + <XMP-darktable:HistoryMulti_priority>0</XMP-darktable:HistoryMulti_priority> + <XMP-darktable:HistoryBlendop_version>14</XMP-darktable:HistoryBlendop_version> + <XMP-darktable:HistoryNum>1</XMP-darktable:HistoryNum> + <XMP-darktable:HistoryOperation>colorout</XMP-darktable:HistoryOperation> + <XMP-darktable:HistoryEnabled>1</XMP-darktable:HistoryEnabled> + <XMP-darktable:HistoryModversion>5</XMP-darktable:HistoryModversion> + <XMP-darktable:HistoryParams>gz35eJxjZBgFo4CBAQAEEAAC</XMP-darktable:HistoryParams> + <XMP-darktable:HistoryMulti_name></XMP-darktable:HistoryMulti_name> + <XMP-darktable:HistoryMulti_name_hand_edited>0</XMP-darktable:HistoryMulti_name_hand_edited> + <XMP-darktable:HistoryMulti_priority>0</XMP-darktable:HistoryMulti_priority> + <XMP-darktable:HistoryBlendop_version>14</XMP-darktable:HistoryBlendop_version> + <XMP-darktable:HistoryNum>2</XMP-darktable:HistoryNum> + <XMP-darktable:HistoryOperation>gamma</XMP-darktable:HistoryOperation> + <XMP-darktable:HistoryEnabled>1</XMP-darktable:HistoryEnabled> + <XMP-darktable:HistoryModversion>1</XMP-darktable:HistoryModversion> + <XMP-darktable:HistoryParams>0000000000000000</XMP-darktable:HistoryParams> + <XMP-darktable:HistoryMulti_name></XMP-darktable:HistoryMulti_name> + <XMP-darktable:HistoryMulti_name_hand_edited>0</XMP-darktable:HistoryMulti_name_hand_edited> + <XMP-darktable:HistoryMulti_priority>0</XMP-darktable:HistoryMulti_priority> + <XMP-darktable:HistoryBlendop_version>14</XMP-darktable:HistoryBlendop_version> + <XMP-darktable:HistoryNum>3</XMP-darktable:HistoryNum> + <XMP-darktable:HistoryOperation>flip</XMP-darktable:HistoryOperation> + <XMP-darktable:HistoryEnabled>1</XMP-darktable:HistoryEnabled> + <XMP-darktable:HistoryModversion>2</XMP-darktable:HistoryModversion> + <XMP-darktable:HistoryParams>ffffffff</XMP-darktable:HistoryParams> + <XMP-darktable:HistoryMulti_name>_builtin_auto</XMP-darktable:HistoryMulti_name> + <XMP-darktable:HistoryMulti_name_hand_edited>0</XMP-darktable:HistoryMulti_name_hand_edited> + <XMP-darktable:HistoryMulti_priority>0</XMP-darktable:HistoryMulti_priority> + <XMP-darktable:HistoryBlendop_version>14</XMP-darktable:HistoryBlendop_version> + <XMP-acdsee:Notes>This is notes</XMP-acdsee:Notes> + <XMP-dc:Creator>PhotoPrism</XMP-dc:Creator> + <XMP-dc:Publisher>PhotoPrism</XMP-dc:Publisher> + <XMP-dc:Title>XMP Test - Aurora</XMP-dc:Title> + <XMP-dc:Description>Test fixture for darktable XMP sidecar</XMP-dc:Description> + <XMP-dc:Rights>CC-BY-SA 4.0</XMP-dc:Rights> + <XMP-dc:Subject> + <rdf:Bag> + <rdf:li>Aurora</rdf:li> + <rdf:li>Iceland</rdf:li> + <rdf:li>Nature</rdf:li> + <rdf:li>Places</rdf:li> + <rdf:li>Reykjavik</rdf:li> + <rdf:li>darktable</rdf:li> + <rdf:li>exported</rdf:li> + <rdf:li>format</rdf:li> + <rdf:li>jpg</rdf:li> + </rdf:Bag> + </XMP-dc:Subject> + <XMP-lr:HierarchicalSubject> + <rdf:Bag> + <rdf:li>Aurora</rdf:li> + <rdf:li>Iceland</rdf:li> + <rdf:li>Nature</rdf:li> + <rdf:li>Places</rdf:li> + <rdf:li>Reykjavik</rdf:li> + <rdf:li>darktable|exported</rdf:li> + <rdf:li>darktable|format|jpg</rdf:li> + </rdf:Bag> + </XMP-lr:HierarchicalSubject> + <Composite:GPSLatitudeRef>North</Composite:GPSLatitudeRef> + <Composite:GPSLongitudeRef>West</Composite:GPSLongitudeRef> + <Composite:GPSPosition>87 deg 21' 17.52" N, 179 deg 59' 32.81" W</Composite:GPSPosition> +</rdf:Description> +</rdf:RDF> diff --git a/internal/meta/testdata/xmp/darktable/aurora.jpg.xmp b/internal/meta/testdata/xmp/darktable/aurora.jpg.xmp new file mode 100644 index 000000000..bd5fd3719 --- /dev/null +++ b/internal/meta/testdata/xmp/darktable/aurora.jpg.xmp @@ -0,0 +1,132 @@ +<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="XMP Core 4.4.0-Exiv2"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:exif="http://ns.adobe.com/exif/1.0/" + xmlns:xmpMM="http://ns.adobe.com/xap/1.0/mm/" + xmlns:xmp="http://ns.adobe.com/xap/1.0/" + xmlns:darktable="http://darktable.sf.net/" + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:acdsee="http://ns.acdsee.com/iptc/1.0/" + xmlns:lr="http://ns.adobe.com/lightroom/1.0/" + exif:DateTimeOriginal="" + exif:GPSVersionID="2.2.0.0" + exif:GPSLongitude="179,59.546814W" + exif:GPSLatitude="87,21.291962N" + xmpMM:DerivedFrom="aurora.jpg" + xmp:Rating="1" + darktable:import_timestamp="63913646604991295" + darktable:change_timestamp="-1" + darktable:export_timestamp="63913646961369095" + darktable:print_timestamp="-1" + darktable:xmp_version="5" + darktable:raw_params="0" + darktable:auto_presets_applied="1" + darktable:history_end="4" + darktable:iop_order_version="5" + darktable:history_basic_hash="02d4cdbda625305c5e181669466f51d2" + darktable:history_current_hash="02d4cdbda625305c5e181669466f51d2" + acdsee:notes="This is notes"> + <darktable:masks_history> + <rdf:Seq/> + </darktable:masks_history> + <darktable:history> + <rdf:Seq> + <rdf:li + darktable:num="0" + darktable:operation="colorin" + darktable:enabled="1" + darktable:modversion="7" + darktable:params="gz48eJzjZBgFowABWAbaAaNgwAEAMNgADg==" + darktable:multi_name="" + darktable:multi_name_hand_edited="0" + darktable:multi_priority="0" + darktable:blendop_version="14" + darktable:blendop_params="gz11eJxjYIAACQYYOOHEgAZY0QWAgBGLGANDgz0Ej1Q+dcF/IADRAGpyHQU="/> + <rdf:li + darktable:num="1" + darktable:operation="colorout" + darktable:enabled="1" + darktable:modversion="5" + darktable:params="gz35eJxjZBgFo4CBAQAEEAAC" + darktable:multi_name="" + darktable:multi_name_hand_edited="0" + darktable:multi_priority="0" + darktable:blendop_version="14" + darktable:blendop_params="gz11eJxjYIAACQYYOOHEgAZY0QWAgBGLGANDgz0Ej1Q+dcF/IADRAGpyHQU="/> + <rdf:li + darktable:num="2" + darktable:operation="gamma" + darktable:enabled="1" + darktable:modversion="1" + darktable:params="0000000000000000" + darktable:multi_name="" + darktable:multi_name_hand_edited="0" + darktable:multi_priority="0" + darktable:blendop_version="14" + darktable:blendop_params="gz11eJxjYIAACQYYOOHEgAZY0QWAgBGLGANDgz0Ej1Q+dcF/IADRAGpyHQU="/> + <rdf:li + darktable:num="3" + darktable:operation="flip" + darktable:enabled="1" + darktable:modversion="2" + darktable:params="ffffffff" + darktable:multi_name="_builtin_auto" + darktable:multi_name_hand_edited="0" + darktable:multi_priority="0" + darktable:blendop_version="14" + darktable:blendop_params="gz11eJxjYIAACQYYOOHEgAZY0QWAgBGLGANDgz0Ej1Q+dcF/IADRAGpyHQU="/> + </rdf:Seq> + </darktable:history> + <dc:creator> + <rdf:Seq> + <rdf:li>PhotoPrism</rdf:li> + </rdf:Seq> + </dc:creator> + <dc:publisher> + <rdf:Bag> + <rdf:li>PhotoPrism</rdf:li> + </rdf:Bag> + </dc:publisher> + <dc:title> + <rdf:Alt> + <rdf:li xml:lang="x-default">XMP Test - Aurora</rdf:li> + </rdf:Alt> + </dc:title> + <dc:description> + <rdf:Alt> + <rdf:li xml:lang="x-default">Test fixture for darktable XMP sidecar</rdf:li> + </rdf:Alt> + </dc:description> + <dc:rights> + <rdf:Alt> + <rdf:li xml:lang="x-default">CC-BY-SA 4.0</rdf:li> + </rdf:Alt> + </dc:rights> + <dc:subject> + <rdf:Bag> + <rdf:li>Aurora</rdf:li> + <rdf:li>Iceland</rdf:li> + <rdf:li>Nature</rdf:li> + <rdf:li>Places</rdf:li> + <rdf:li>Reykjavik</rdf:li> + <rdf:li>darktable</rdf:li> + <rdf:li>exported</rdf:li> + <rdf:li>format</rdf:li> + <rdf:li>jpg</rdf:li> + </rdf:Bag> + </dc:subject> + <lr:hierarchicalSubject> + <rdf:Bag> + <rdf:li>Aurora</rdf:li> + <rdf:li>Iceland</rdf:li> + <rdf:li>Nature</rdf:li> + <rdf:li>Places</rdf:li> + <rdf:li>Reykjavik</rdf:li> + <rdf:li>darktable|exported</rdf:li> + <rdf:li>darktable|format|jpg</rdf:li> + </rdf:Bag> + </lr:hierarchicalSubject> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> diff --git a/internal/meta/testdata/xmp/digikam/aurora.jpg.exiftool.txt b/internal/meta/testdata/xmp/digikam/aurora.jpg.exiftool.txt new file mode 100644 index 000000000..16b78b91c --- /dev/null +++ b/internal/meta/testdata/xmp/digikam/aurora.jpg.exiftool.txt @@ -0,0 +1,155 @@ +<?xml version='1.0' encoding='UTF-8'?> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> + +<rdf:Description rdf:about='internal/meta/testdata/xmp/digikam/aurora.jpg.xmp' + xmlns:et='http://ns.exiftool.org/1.0/' et:toolkit='Image::ExifTool 13.25' + xmlns:ExifTool='http://ns.exiftool.org/ExifTool/1.0/' + xmlns:System='http://ns.exiftool.org/File/System/1.0/' + xmlns:File='http://ns.exiftool.org/File/1.0/' + xmlns:XMP-x='http://ns.exiftool.org/XMP/XMP-x/1.0/' + xmlns:XMP-xmpMM='http://ns.exiftool.org/XMP/XMP-xmpMM/1.0/' + xmlns:XMP-dc='http://ns.exiftool.org/XMP/XMP-dc/1.0/' + xmlns:XMP-photoshop='http://ns.exiftool.org/XMP/XMP-photoshop/1.0/' + xmlns:XMP-xmp='http://ns.exiftool.org/XMP/XMP-xmp/1.0/' + xmlns:XMP-exif='http://ns.exiftool.org/XMP/XMP-exif/1.0/' + xmlns:XMP-tiff='http://ns.exiftool.org/XMP/XMP-tiff/1.0/' + xmlns:XMP-digiKam='http://ns.exiftool.org/XMP/XMP-digiKam/1.0/' + xmlns:XMP-acdsee='http://ns.exiftool.org/XMP/XMP-acdsee/1.0/' + xmlns:XMP-microsoft='http://ns.exiftool.org/XMP/XMP-microsoft/1.0/' + xmlns:XMP-lr='http://ns.exiftool.org/XMP/XMP-lr/1.0/' + xmlns:XMP-mediapro='http://ns.exiftool.org/XMP/XMP-mediapro/1.0/' + xmlns:XMP-xmpRights='http://ns.exiftool.org/XMP/XMP-xmpRights/1.0/' + xmlns:Composite='http://ns.exiftool.org/Composite/1.0/'> + <ExifTool:ExifToolVersion>13.25</ExifTool:ExifToolVersion> + <ExifTool:Warning>[minor] Fixed incorrect URI for xmlns:MicrosoftPhoto</ExifTool:Warning> + <System:FileName>aurora.jpg.xmp</System:FileName> + <System:Directory>internal/meta/testdata/xmp/digikam</System:Directory> + <System:FileSize>5.5 kB</System:FileSize> + <System:FileModifyDate>2026:05:06 07:18:19+00:00</System:FileModifyDate> + <System:FileAccessDate>2026:05:06 07:18:22+00:00</System:FileAccessDate> + <System:FileInodeChangeDate>2026:05:06 07:18:25+00:00</System:FileInodeChangeDate> + <System:FilePermissions>-rw-r--r--</System:FilePermissions> + <File:FileType>XMP</File:FileType> + <File:FileTypeExtension>xmp</File:FileTypeExtension> + <File:MIMEType>application/rdf+xml</File:MIMEType> + <XMP-x:XMPToolkit>XMP Core 4.4.0-Exiv2</XMP-x:XMPToolkit> + <XMP-xmpMM:DocumentID>adobe:docid:photoshop:7d592d87-eb1e-1040-809a-e16c6b85b3fd</XMP-xmpMM:DocumentID> + <XMP-xmpMM:InstanceID>xmp.iid:de0fb44d-bdc8-4cc3-aa50-9aefe4992b34</XMP-xmpMM:InstanceID> + <XMP-xmpMM:OriginalDocumentID>254738CA43CD69C01101874D65B006B4</XMP-xmpMM:OriginalDocumentID> + <XMP-xmpMM:HistoryAction> + <rdf:Bag> + <rdf:li>saved</rdf:li> + <rdf:li>saved</rdf:li> + </rdf:Bag> + </XMP-xmpMM:HistoryAction> + <XMP-xmpMM:HistoryInstanceID> + <rdf:Bag> + <rdf:li>xmp.iid:380d6b1a-8ce6-4774-b1c0-f41dfa325e41</rdf:li> + <rdf:li>xmp.iid:de0fb44d-bdc8-4cc3-aa50-9aefe4992b34</rdf:li> + </rdf:Bag> + </XMP-xmpMM:HistoryInstanceID> + <XMP-xmpMM:HistoryWhen> + <rdf:Bag> + <rdf:li>2021:10:29 13:42+02:00</rdf:li> + <rdf:li>2021:10:29 13:42+02:00</rdf:li> + </rdf:Bag> + </XMP-xmpMM:HistoryWhen> + <XMP-xmpMM:HistorySoftwareAgent> + <rdf:Bag> + <rdf:li>Adobe Photoshop 22.3 (Macintosh)</rdf:li> + <rdf:li>Adobe Photoshop 22.3 (Macintosh)</rdf:li> + </rdf:Bag> + </XMP-xmpMM:HistorySoftwareAgent> + <XMP-xmpMM:HistoryChanged> + <rdf:Bag> + <rdf:li>/</rdf:li> + <rdf:li>/</rdf:li> + </rdf:Bag> + </XMP-xmpMM:HistoryChanged> + <XMP-dc:Format>image/jpeg</XMP-dc:Format> + <XMP-dc:Title>XMP Test - Aurora</XMP-dc:Title> + <XMP-dc:Subject> + <rdf:Bag> + <rdf:li>Nature</rdf:li> + <rdf:li>Places</rdf:li> + <rdf:li>Reykjavik</rdf:li> + <rdf:li>Iceland</rdf:li> + <rdf:li>Aurora</rdf:li> + </rdf:Bag> + </XMP-dc:Subject> + <XMP-dc:Rights>(C) 2026 PhotoPrism — Test fixture</XMP-dc:Rights> + <XMP-dc:Description>Test fixture for digiKam XMP sidecar </XMP-dc:Description> + <XMP-photoshop:ColorMode>RGB</XMP-photoshop:ColorMode> + <XMP-photoshop:ICCProfileName>sRGB IEC61966-2.1</XMP-photoshop:ICCProfileName> + <XMP-photoshop:Urgency>0 (reserved)</XMP-photoshop:Urgency> + <XMP-photoshop:DateCreated>2021:10:27 10:43:46</XMP-photoshop:DateCreated> + <XMP-photoshop:AuthorsPosition>PhotoPrism</XMP-photoshop:AuthorsPosition> + <XMP-photoshop:Credit>PhotoPrism</XMP-photoshop:Credit> + <XMP-xmp:CreateDate>2021:10:27 10:43:46</XMP-xmp:CreateDate> + <XMP-xmp:MetadataDate>2021:10:27 10:43:46</XMP-xmp:MetadataDate> + <XMP-xmp:Label>NoColor</XMP-xmp:Label> + <XMP-xmp:ModifyDate>2021:10:27 10:43:46</XMP-xmp:ModifyDate> + <XMP-exif:DateTimeOriginal>2021:10:27 10:43:46</XMP-exif:DateTimeOriginal> + <XMP-exif:ExifVersion>0231</XMP-exif:ExifVersion> + <XMP-exif:ColorSpace>sRGB</XMP-exif:ColorSpace> + <XMP-exif:ExifImageWidth>2560</XMP-exif:ExifImageWidth> + <XMP-exif:ExifImageHeight>868</XMP-exif:ExifImageHeight> + <XMP-exif:UserComment>Test fixture for digiKam XMP sidecar </XMP-exif:UserComment> + <XMP-tiff:DateTime>2021:10:27 10:43:46</XMP-tiff:DateTime> + <XMP-tiff:ImageWidth>4774</XMP-tiff:ImageWidth> + <XMP-tiff:ImageHeight>2889</XMP-tiff:ImageHeight> + <XMP-tiff:Orientation>Horizontal (normal)</XMP-tiff:Orientation> + <XMP-tiff:SamplesPerPixel>3</XMP-tiff:SamplesPerPixel> + <XMP-tiff:XResolution>72</XMP-tiff:XResolution> + <XMP-tiff:YResolution>72</XMP-tiff:YResolution> + <XMP-tiff:ResolutionUnit>inches</XMP-tiff:ResolutionUnit> + <XMP-tiff:Software>Adobe Photoshop 22.3 (Macintosh)</XMP-tiff:Software> + <XMP-tiff:ImageDescription>Test fixture for digiKam XMP sidecar </XMP-tiff:ImageDescription> + <XMP-tiff:Copyright>(C) 2026 PhotoPrism — Test fixture</XMP-tiff:Copyright> + <XMP-tiff:BitsPerSample>8 8 8</XMP-tiff:BitsPerSample> + <XMP-digiKam:ColorLabel>0</XMP-digiKam:ColorLabel> + <XMP-digiKam:TagsList> + <rdf:Bag> + <rdf:li>Nature</rdf:li> + <rdf:li>Places</rdf:li> + <rdf:li>Reykjavik</rdf:li> + <rdf:li>Iceland</rdf:li> + <rdf:li>Aurora</rdf:li> + </rdf:Bag> + </XMP-digiKam:TagsList> + <XMP-digiKam:CaptionsDateTimeStamps>2026-05-06T09:07:11</XMP-digiKam:CaptionsDateTimeStamps> + <XMP-acdsee:Caption>XMP Test - Aurora</XMP-acdsee:Caption> + <XMP-acdsee:Notes>Test fixture for digiKam XMP sidecar </XMP-acdsee:Notes> + <XMP-acdsee:Categories><Categories><Category Assigned="1">Nature</Category><Category Assigned="1">Places</Category><Category Assigned="1">Reykjavik</Category><Category Assigned="1">Iceland</Category><Category Assigned="1">Aurora</Category></Categories></XMP-acdsee:Categories> + <XMP-microsoft:LastKeywordXMP> + <rdf:Bag> + <rdf:li>Nature</rdf:li> + <rdf:li>Places</rdf:li> + <rdf:li>Reykjavik</rdf:li> + <rdf:li>Iceland</rdf:li> + <rdf:li>Aurora</rdf:li> + </rdf:Bag> + </XMP-microsoft:LastKeywordXMP> + <XMP-lr:HierarchicalSubject> + <rdf:Bag> + <rdf:li>Nature</rdf:li> + <rdf:li>Places</rdf:li> + <rdf:li>Reykjavik</rdf:li> + <rdf:li>Iceland</rdf:li> + <rdf:li>Aurora</rdf:li> + </rdf:Bag> + </XMP-lr:HierarchicalSubject> + <XMP-mediapro:CatalogSets> + <rdf:Bag> + <rdf:li>Nature</rdf:li> + <rdf:li>Places</rdf:li> + <rdf:li>Reykjavik</rdf:li> + <rdf:li>Iceland</rdf:li> + <rdf:li>Aurora</rdf:li> + </rdf:Bag> + </XMP-mediapro:CatalogSets> + <XMP-xmpRights:UsageTerms>CC-BY-SA 4.0</XMP-xmpRights:UsageTerms> + <Composite:ImageSize>4774x2889</Composite:ImageSize> + <Composite:Megapixels>13.8</Composite:Megapixels> +</rdf:Description> +</rdf:RDF> diff --git a/internal/meta/testdata/xmp/digikam/aurora.jpg.xmp b/internal/meta/testdata/xmp/digikam/aurora.jpg.xmp new file mode 100644 index 000000000..d1f1523b9 --- /dev/null +++ b/internal/meta/testdata/xmp/digikam/aurora.jpg.xmp @@ -0,0 +1,159 @@ +<?xpacket begin="" id="W5M0MpCehiHzreSzNTczkc9d"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="XMP Core 4.4.0-Exiv2"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:xmpMM="http://ns.adobe.com/xap/1.0/mm/" + xmlns:stEvt="http://ns.adobe.com/xap/1.0/sType/ResourceEvent#" + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:photoshop="http://ns.adobe.com/photoshop/1.0/" + xmlns:xmp="http://ns.adobe.com/xap/1.0/" + xmlns:exif="http://ns.adobe.com/exif/1.0/" + xmlns:tiff="http://ns.adobe.com/tiff/1.0/" + xmlns:digiKam="http://www.digikam.org/ns/1.0/" + xmlns:MicrosoftPhoto="http://ns.microsoft.com/photo/1.0/" + xmlns:lr="http://ns.adobe.com/lightroom/1.0/" + xmlns:mediapro="http://ns.iview-multimedia.com/mediapro/1.0/" + xmlns:acdsee="http://ns.acdsee.com/iptc/1.0/" + xmlns:xmpRights="http://ns.adobe.com/xap/1.0/rights/" + xmpMM:DocumentID="adobe:docid:photoshop:7d592d87-eb1e-1040-809a-e16c6b85b3fd" + xmpMM:InstanceID="xmp.iid:de0fb44d-bdc8-4cc3-aa50-9aefe4992b34" + xmpMM:OriginalDocumentID="254738CA43CD69C01101874D65B006B4" + dc:format="image/jpeg" + photoshop:ColorMode="3" + photoshop:ICCProfile="sRGB IEC61966-2.1" + photoshop:Urgency="0" + photoshop:DateCreated="2021-10-27T10:43:46" + photoshop:AuthorsPosition="PhotoPrism" + photoshop:Credit="PhotoPrism" + xmp:CreateDate="2021-10-27T10:43:46" + xmp:MetadataDate="2021-10-27T10:43:46" + xmp:Label="NoColor" + xmp:ModifyDate="2021-10-27T10:43:46" + exif:DateTimeOriginal="2021-10-27T10:43:46" + exif:ExifVersion="0231" + exif:ColorSpace="1" + exif:PixelXDimension="2560" + exif:PixelYDimension="868" + tiff:DateTime="2021-10-27T10:43:46" + tiff:ImageWidth="4774" + tiff:ImageLength="2889" + tiff:Orientation="1" + tiff:SamplesPerPixel="3" + tiff:XResolution="720000/10000" + tiff:YResolution="720000/10000" + tiff:ResolutionUnit="2" + tiff:Software="Adobe Photoshop 22.3 (Macintosh)" + digiKam:ColorLabel="0" + acdsee:caption="XMP Test - Aurora" + acdsee:notes="Test fixture for digiKam XMP sidecar " + acdsee:categories="<Categories><Category Assigned="1">Nature</Category><Category Assigned="1">Places</Category><Category Assigned="1">Reykjavik</Category><Category Assigned="1">Iceland</Category><Category Assigned="1">Aurora</Category></Categories>"> + <xmpMM:History> + <rdf:Seq> + <rdf:li + stEvt:action="saved" + stEvt:instanceID="xmp.iid:380d6b1a-8ce6-4774-b1c0-f41dfa325e41" + stEvt:when="2021-10-29T13:42+02:00" + stEvt:softwareAgent="Adobe Photoshop 22.3 (Macintosh)" + stEvt:changed="/"/> + <rdf:li + stEvt:action="saved" + stEvt:instanceID="xmp.iid:de0fb44d-bdc8-4cc3-aa50-9aefe4992b34" + stEvt:when="2021-10-29T13:42+02:00" + stEvt:softwareAgent="Adobe Photoshop 22.3 (Macintosh)" + stEvt:changed="/"/> + </rdf:Seq> + </xmpMM:History> + <dc:title> + <rdf:Alt> + <rdf:li xml:lang="x-default">XMP Test - Aurora</rdf:li> + </rdf:Alt> + </dc:title> + <dc:subject> + <rdf:Bag> + <rdf:li>Nature</rdf:li> + <rdf:li>Places</rdf:li> + <rdf:li>Reykjavik</rdf:li> + <rdf:li>Iceland</rdf:li> + <rdf:li>Aurora</rdf:li> + </rdf:Bag> + </dc:subject> + <dc:rights> + <rdf:Alt> + <rdf:li xml:lang="x-default">(C) 2026 PhotoPrism — Test fixture</rdf:li> + </rdf:Alt> + </dc:rights> + <dc:description> + <rdf:Alt> + <rdf:li xml:lang="x-default">Test fixture for digiKam XMP sidecar </rdf:li> + </rdf:Alt> + </dc:description> + <exif:UserComment> + <rdf:Alt> + <rdf:li xml:lang="x-default">Test fixture for digiKam XMP sidecar </rdf:li> + </rdf:Alt> + </exif:UserComment> + <tiff:ImageDescription> + <rdf:Alt> + <rdf:li xml:lang="x-default">Test fixture for digiKam XMP sidecar </rdf:li> + </rdf:Alt> + </tiff:ImageDescription> + <tiff:Copyright> + <rdf:Alt> + <rdf:li xml:lang="x-default">(C) 2026 PhotoPrism — Test fixture</rdf:li> + </rdf:Alt> + </tiff:Copyright> + <tiff:BitsPerSample> + <rdf:Seq> + <rdf:li>8 8 8</rdf:li> + </rdf:Seq> + </tiff:BitsPerSample> + <digiKam:TagsList> + <rdf:Seq> + <rdf:li>Nature</rdf:li> + <rdf:li>Places</rdf:li> + <rdf:li>Reykjavik</rdf:li> + <rdf:li>Iceland</rdf:li> + <rdf:li>Aurora</rdf:li> + </rdf:Seq> + </digiKam:TagsList> + <digiKam:CaptionsDateTimeStamps> + <rdf:Alt> + <rdf:li xml:lang="x-default">2026-05-06T09:07:11</rdf:li> + </rdf:Alt> + </digiKam:CaptionsDateTimeStamps> + <MicrosoftPhoto:LastKeywordXMP> + <rdf:Bag> + <rdf:li>Nature</rdf:li> + <rdf:li>Places</rdf:li> + <rdf:li>Reykjavik</rdf:li> + <rdf:li>Iceland</rdf:li> + <rdf:li>Aurora</rdf:li> + </rdf:Bag> + </MicrosoftPhoto:LastKeywordXMP> + <lr:hierarchicalSubject> + <rdf:Bag> + <rdf:li>Nature</rdf:li> + <rdf:li>Places</rdf:li> + <rdf:li>Reykjavik</rdf:li> + <rdf:li>Iceland</rdf:li> + <rdf:li>Aurora</rdf:li> + </rdf:Bag> + </lr:hierarchicalSubject> + <mediapro:CatalogSets> + <rdf:Bag> + <rdf:li>Nature</rdf:li> + <rdf:li>Places</rdf:li> + <rdf:li>Reykjavik</rdf:li> + <rdf:li>Iceland</rdf:li> + <rdf:li>Aurora</rdf:li> + </rdf:Bag> + </mediapro:CatalogSets> + <xmpRights:UsageTerms> + <rdf:Alt> + <rdf:li xml:lang="x-default">CC-BY-SA 4.0</rdf:li> + </rdf:Alt> + </xmpRights:UsageTerms> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> +<?xpacket end="w"?> \ No newline at end of file diff --git a/internal/meta/testdata/xmp/synthetic/alt-edge-cases.exiftool.txt b/internal/meta/testdata/xmp/synthetic/alt-edge-cases.exiftool.txt new file mode 100644 index 000000000..2926f8663 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/alt-edge-cases.exiftool.txt @@ -0,0 +1,32 @@ +<?xml version='1.0' encoding='UTF-8'?> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> + +<rdf:Description rdf:about='internal/meta/testdata/xmp/synthetic/alt-edge-cases.xmp' + xmlns:et='http://ns.exiftool.org/1.0/' et:toolkit='Image::ExifTool 13.25' + xmlns:ExifTool='http://ns.exiftool.org/ExifTool/1.0/' + xmlns:System='http://ns.exiftool.org/File/System/1.0/' + xmlns:File='http://ns.exiftool.org/File/1.0/' + xmlns:XMP-x='http://ns.exiftool.org/XMP/XMP-x/1.0/' + xmlns:XMP-dc='http://ns.exiftool.org/XMP/XMP-dc/1.0/' + xmlns:XMP-photoshop='http://ns.exiftool.org/XMP/XMP-photoshop/1.0/'> + <ExifTool:ExifToolVersion>13.25</ExifTool:ExifToolVersion> + <System:FileName>alt-edge-cases.xmp</System:FileName> + <System:Directory>internal/meta/testdata/xmp/synthetic</System:Directory> + <System:FileSize>991 bytes</System:FileSize> + <System:FileModifyDate>2026:05:06 07:32:31+00:00</System:FileModifyDate> + <System:FileAccessDate>2026:05:06 07:32:31+00:00</System:FileAccessDate> + <System:FileInodeChangeDate>2026:05:06 07:32:31+00:00</System:FileInodeChangeDate> + <System:FilePermissions>-rw-r--r--</System:FilePermissions> + <File:FileType>XMP</File:FileType> + <File:FileTypeExtension>xmp</File:FileTypeExtension> + <File:MIMEType>application/rdf+xml</File:MIMEType> + <XMP-x:XMPToolkit>PhotoPrism Synthetic Fixture</XMP-x:XMPToolkit> + <XMP-dc:Title-de>Sonnenuntergang</XMP-dc:Title-de> + <XMP-dc:Title-en>Sunset</XMP-dc:Title-en> + <XMP-dc:Description>No xml:lang attribute on this li</XMP-dc:Description> + <XMP-dc:Rights>First x-default rights</XMP-dc:Rights> + <XMP-dc:Rights>Second x-default rights (duplicate, should be ignored)</XMP-dc:Rights> + <XMP-dc:Rights-en>English rights</XMP-dc:Rights-en> + <XMP-photoshop:Headline>Photoshop Headline Fallback</XMP-photoshop:Headline> +</rdf:Description> +</rdf:RDF> diff --git a/internal/meta/testdata/xmp/synthetic/alt-edge-cases.xmp b/internal/meta/testdata/xmp/synthetic/alt-edge-cases.xmp new file mode 100644 index 000000000..ca6f5ea2c --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/alt-edge-cases.xmp @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Synthetic Fixture"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:photoshop="http://ns.adobe.com/photoshop/1.0/"> + <dc:title> + <rdf:Alt> + <rdf:li xml:lang="de">Sonnenuntergang</rdf:li> + <rdf:li xml:lang="en">Sunset</rdf:li> + </rdf:Alt> + </dc:title> + <dc:description> + <rdf:Alt> + <rdf:li>No xml:lang attribute on this li</rdf:li> + </rdf:Alt> + </dc:description> + <dc:rights> + <rdf:Alt> + <rdf:li xml:lang="x-default">First x-default rights</rdf:li> + <rdf:li xml:lang="x-default">Second x-default rights (duplicate, should be ignored)</rdf:li> + <rdf:li xml:lang="en">English rights</rdf:li> + </rdf:Alt> + </dc:rights> + <photoshop:Headline>Photoshop Headline Fallback</photoshop:Headline> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> diff --git a/internal/meta/testdata/xmp/synthetic/aux-only.exiftool.txt b/internal/meta/testdata/xmp/synthetic/aux-only.exiftool.txt new file mode 100644 index 000000000..18732f6de --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/aux-only.exiftool.txt @@ -0,0 +1,32 @@ +<?xml version='1.0' encoding='UTF-8'?> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> + +<rdf:Description rdf:about='internal/meta/testdata/xmp/synthetic/aux-only.xmp' + xmlns:et='http://ns.exiftool.org/1.0/' et:toolkit='Image::ExifTool 13.25' + xmlns:ExifTool='http://ns.exiftool.org/ExifTool/1.0/' + xmlns:System='http://ns.exiftool.org/File/System/1.0/' + xmlns:File='http://ns.exiftool.org/File/1.0/' + xmlns:XMP-x='http://ns.exiftool.org/XMP/XMP-x/1.0/' + xmlns:XMP-aux='http://ns.exiftool.org/XMP/XMP-aux/1.0/' + xmlns:Composite='http://ns.exiftool.org/Composite/1.0/'> + <ExifTool:ExifToolVersion>13.25</ExifTool:ExifToolVersion> + <System:FileName>aux-only.xmp</System:FileName> + <System:Directory>internal/meta/testdata/xmp/synthetic</System:Directory> + <System:FileSize>602 bytes</System:FileSize> + <System:FileModifyDate>2026:05:06 07:32:31+00:00</System:FileModifyDate> + <System:FileAccessDate>2026:05:06 07:32:31+00:00</System:FileAccessDate> + <System:FileInodeChangeDate>2026:05:06 07:32:31+00:00</System:FileInodeChangeDate> + <System:FilePermissions>-rw-r--r--</System:FilePermissions> + <File:FileType>XMP</File:FileType> + <File:FileTypeExtension>xmp</File:FileTypeExtension> + <File:MIMEType>application/rdf+xml</File:MIMEType> + <XMP-x:XMPToolkit>PhotoPrism Synthetic Fixture</XMP-x:XMPToolkit> + <XMP-aux:OwnerName>Synthetic Photographer</XMP-aux:OwnerName> + <XMP-aux:Lens>50.0 mm f/1.4</XMP-aux:Lens> + <XMP-aux:LensID>123</XMP-aux:LensID> + <XMP-aux:LensSerialNumber>LENS-SN-987654</XMP-aux:LensSerialNumber> + <XMP-aux:SerialNumber>BODY-SN-123456</XMP-aux:SerialNumber> + <XMP-aux:Firmware>Firmware 2.10</XMP-aux:Firmware> + <Composite:LensID>50.0mm f/1.4</Composite:LensID> +</rdf:Description> +</rdf:RDF> diff --git a/internal/meta/testdata/xmp/synthetic/aux-only.xmp b/internal/meta/testdata/xmp/synthetic/aux-only.xmp new file mode 100644 index 000000000..1dc032056 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/aux-only.xmp @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Synthetic Fixture"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:aux="http://ns.adobe.com/exif/1.0/aux/"> + <aux:OwnerName>Synthetic Photographer</aux:OwnerName> + <aux:Lens>50.0 mm f/1.4</aux:Lens> + <aux:LensID>123</aux:LensID> + <aux:LensSerialNumber>LENS-SN-987654</aux:LensSerialNumber> + <aux:SerialNumber>BODY-SN-123456</aux:SerialNumber> + <aux:Firmware>Firmware 2.10</aux:Firmware> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> diff --git a/internal/meta/testdata/xmp/synthetic/datecreated-priority.xmp b/internal/meta/testdata/xmp/synthetic/datecreated-priority.xmp new file mode 100644 index 000000000..e9dc7a864 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/datecreated-priority.xmp @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Synthetic Fixture"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:photoshop="http://ns.adobe.com/photoshop/1.0/" + xmlns:xmp="http://ns.adobe.com/xap/1.0/"> + <photoshop:DateCreated>2026-01-15T10:00:00</photoshop:DateCreated> + <xmp:CreateDate>2026-03-20T18:30:00</xmp:CreateDate> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> diff --git a/internal/meta/testdata/xmp/synthetic/exifex-camera-lens.exiftool.txt b/internal/meta/testdata/xmp/synthetic/exifex-camera-lens.exiftool.txt new file mode 100644 index 000000000..fc484f4b9 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/exifex-camera-lens.exiftool.txt @@ -0,0 +1,36 @@ +<?xml version='1.0' encoding='UTF-8'?> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> + +<rdf:Description rdf:about='internal/meta/testdata/xmp/synthetic/exifex-camera-lens.xmp' + xmlns:et='http://ns.exiftool.org/1.0/' et:toolkit='Image::ExifTool 13.25' + xmlns:ExifTool='http://ns.exiftool.org/ExifTool/1.0/' + xmlns:System='http://ns.exiftool.org/File/System/1.0/' + xmlns:File='http://ns.exiftool.org/File/1.0/' + xmlns:XMP-x='http://ns.exiftool.org/XMP/XMP-x/1.0/' + xmlns:XMP-tiff='http://ns.exiftool.org/XMP/XMP-tiff/1.0/' + xmlns:XMP-exifEX='http://ns.exiftool.org/XMP/XMP-exifEX/1.0/' + xmlns:Composite='http://ns.exiftool.org/Composite/1.0/'> + <ExifTool:ExifToolVersion>13.25</ExifTool:ExifToolVersion> + <System:FileName>exifex-camera-lens.xmp</System:FileName> + <System:Directory>internal/meta/testdata/xmp/synthetic</System:Directory> + <System:FileSize>871 bytes</System:FileSize> + <System:FileModifyDate>2026:05:06 07:32:31+00:00</System:FileModifyDate> + <System:FileAccessDate>2026:05:06 07:32:31+00:00</System:FileAccessDate> + <System:FileInodeChangeDate>2026:05:06 07:32:31+00:00</System:FileInodeChangeDate> + <System:FilePermissions>-rw-r--r--</System:FilePermissions> + <File:FileType>XMP</File:FileType> + <File:FileTypeExtension>xmp</File:FileTypeExtension> + <File:MIMEType>application/rdf+xml</File:MIMEType> + <XMP-x:XMPToolkit>PhotoPrism Synthetic Fixture</XMP-x:XMPToolkit> + <XMP-tiff:Make>SyntheticCam</XMP-tiff:Make> + <XMP-tiff:Model>SC-1 Mark II</XMP-tiff:Model> + <XMP-exifEX:LensMake>SyntheticLens Co.</XMP-exifEX:LensMake> + <XMP-exifEX:LensModel>SL 50mm f/1.4</XMP-exifEX:LensModel> + <XMP-exifEX:LensSerialNumber>SL-50-987654</XMP-exifEX:LensSerialNumber> + <XMP-exifEX:SerialNumber>SC1-BODY-123456</XMP-exifEX:SerialNumber> + <XMP-exifEX:PhotographicSensitivity>800</XMP-exifEX:PhotographicSensitivity> + <XMP-exifEX:SensitivityType>Recommended Exposure Index</XMP-exifEX:SensitivityType> + <XMP-exifEX:RecommendedExposureIndex>800</XMP-exifEX:RecommendedExposureIndex> + <Composite:LensID>SL 50mm f/1.4</Composite:LensID> +</rdf:Description> +</rdf:RDF> diff --git a/internal/meta/testdata/xmp/synthetic/exifex-camera-lens.xmp b/internal/meta/testdata/xmp/synthetic/exifex-camera-lens.xmp new file mode 100644 index 000000000..190bdcc53 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/exifex-camera-lens.xmp @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Synthetic Fixture"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:exifEX="http://cipa.jp/exif/1.0/" + xmlns:tiff="http://ns.adobe.com/tiff/1.0/"> + <tiff:Make>SyntheticCam</tiff:Make> + <tiff:Model>SC-1 Mark II</tiff:Model> + <exifEX:LensMake>SyntheticLens Co.</exifEX:LensMake> + <exifEX:LensModel>SL 50mm f/1.4</exifEX:LensModel> + <exifEX:LensSerialNumber>SL-50-987654</exifEX:LensSerialNumber> + <exifEX:BodySerialNumber>SC1-BODY-123456</exifEX:BodySerialNumber> + <exifEX:PhotographicSensitivity>800</exifEX:PhotographicSensitivity> + <exifEX:SensitivityType>2</exifEX:SensitivityType> + <exifEX:RecommendedExposureIndex>800</exifEX:RecommendedExposureIndex> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> diff --git a/internal/meta/testdata/xmp/synthetic/gpano-360.exiftool.txt b/internal/meta/testdata/xmp/synthetic/gpano-360.exiftool.txt new file mode 100644 index 000000000..f535917ce --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/gpano-360.exiftool.txt @@ -0,0 +1,32 @@ +<?xml version='1.0' encoding='UTF-8'?> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> + +<rdf:Description rdf:about='internal/meta/testdata/xmp/synthetic/gpano-360.xmp' + xmlns:et='http://ns.exiftool.org/1.0/' et:toolkit='Image::ExifTool 13.25' + xmlns:ExifTool='http://ns.exiftool.org/ExifTool/1.0/' + xmlns:System='http://ns.exiftool.org/File/System/1.0/' + xmlns:File='http://ns.exiftool.org/File/1.0/' + xmlns:XMP-x='http://ns.exiftool.org/XMP/XMP-x/1.0/' + xmlns:XMP-GPano='http://ns.exiftool.org/XMP/XMP-GPano/1.0/'> + <ExifTool:ExifToolVersion>13.25</ExifTool:ExifToolVersion> + <System:FileName>gpano-360.xmp</System:FileName> + <System:Directory>internal/meta/testdata/xmp/synthetic</System:Directory> + <System:FileSize>858 bytes</System:FileSize> + <System:FileModifyDate>2026:05:06 07:32:31+00:00</System:FileModifyDate> + <System:FileAccessDate>2026:05:06 07:32:31+00:00</System:FileAccessDate> + <System:FileInodeChangeDate>2026:05:06 07:32:31+00:00</System:FileInodeChangeDate> + <System:FilePermissions>-rw-r--r--</System:FilePermissions> + <File:FileType>XMP</File:FileType> + <File:FileTypeExtension>xmp</File:FileTypeExtension> + <File:MIMEType>application/rdf+xml</File:MIMEType> + <XMP-x:XMPToolkit>PhotoPrism Synthetic Fixture</XMP-x:XMPToolkit> + <XMP-GPano:ProjectionType>equirectangular</XMP-GPano:ProjectionType> + <XMP-GPano:UsePanoramaViewer>True</XMP-GPano:UsePanoramaViewer> + <XMP-GPano:CroppedAreaImageWidthPixels>4096</XMP-GPano:CroppedAreaImageWidthPixels> + <XMP-GPano:CroppedAreaImageHeightPixels>2048</XMP-GPano:CroppedAreaImageHeightPixels> + <XMP-GPano:FullPanoWidthPixels>4096</XMP-GPano:FullPanoWidthPixels> + <XMP-GPano:FullPanoHeightPixels>2048</XMP-GPano:FullPanoHeightPixels> + <XMP-GPano:CroppedAreaLeftPixels>0</XMP-GPano:CroppedAreaLeftPixels> + <XMP-GPano:CroppedAreaTopPixels>0</XMP-GPano:CroppedAreaTopPixels> +</rdf:Description> +</rdf:RDF> diff --git a/internal/meta/testdata/xmp/synthetic/gpano-360.xmp b/internal/meta/testdata/xmp/synthetic/gpano-360.xmp new file mode 100644 index 000000000..700f19262 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/gpano-360.xmp @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Synthetic Fixture"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:GPano="http://ns.google.com/photos/1.0/panorama/"> + <GPano:ProjectionType>equirectangular</GPano:ProjectionType> + <GPano:UsePanoramaViewer>True</GPano:UsePanoramaViewer> + <GPano:CroppedAreaImageWidthPixels>4096</GPano:CroppedAreaImageWidthPixels> + <GPano:CroppedAreaImageHeightPixels>2048</GPano:CroppedAreaImageHeightPixels> + <GPano:FullPanoWidthPixels>4096</GPano:FullPanoWidthPixels> + <GPano:FullPanoHeightPixels>2048</GPano:FullPanoHeightPixels> + <GPano:CroppedAreaLeftPixels>0</GPano:CroppedAreaLeftPixels> + <GPano:CroppedAreaTopPixels>0</GPano:CroppedAreaTopPixels> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> diff --git a/internal/meta/testdata/xmp/synthetic/gps-time-combined.exiftool.txt b/internal/meta/testdata/xmp/synthetic/gps-time-combined.exiftool.txt new file mode 100644 index 000000000..ed08fbfc0 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/gps-time-combined.exiftool.txt @@ -0,0 +1,35 @@ +<?xml version='1.0' encoding='UTF-8'?> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> + +<rdf:Description rdf:about='internal/meta/testdata/xmp/synthetic/gps-time-combined.xmp' + xmlns:et='http://ns.exiftool.org/1.0/' et:toolkit='Image::ExifTool 13.25' + xmlns:ExifTool='http://ns.exiftool.org/ExifTool/1.0/' + xmlns:System='http://ns.exiftool.org/File/System/1.0/' + xmlns:File='http://ns.exiftool.org/File/1.0/' + xmlns:XMP-x='http://ns.exiftool.org/XMP/XMP-x/1.0/' + xmlns:XMP-exif='http://ns.exiftool.org/XMP/XMP-exif/1.0/' + xmlns:Composite='http://ns.exiftool.org/Composite/1.0/'> + <ExifTool:ExifToolVersion>13.25</ExifTool:ExifToolVersion> + <System:FileName>gps-time-combined.xmp</System:FileName> + <System:Directory>internal/meta/testdata/xmp/synthetic</System:Directory> + <System:FileSize>624 bytes</System:FileSize> + <System:FileModifyDate>2026:05:06 07:32:30+00:00</System:FileModifyDate> + <System:FileAccessDate>2026:05:06 07:32:30+00:00</System:FileAccessDate> + <System:FileInodeChangeDate>2026:05:06 07:32:30+00:00</System:FileInodeChangeDate> + <System:FilePermissions>-rw-r--r--</System:FilePermissions> + <File:FileType>XMP</File:FileType> + <File:FileTypeExtension>xmp</File:FileTypeExtension> + <File:MIMEType>application/rdf+xml</File:MIMEType> + <XMP-x:XMPToolkit>PhotoPrism Synthetic Fixture</XMP-x:XMPToolkit> + <XMP-exif:GPSVersionID>2.2.0.0</XMP-exif:GPSVersionID> + <XMP-exif:GPSLatitude>52 deg 30' 27.40" N</XMP-exif:GPSLatitude> + <XMP-exif:GPSLongitude>13 deg 24' 34.07" E</XMP-exif:GPSLongitude> + <XMP-exif:GPSAltitudeRef>Above Sea Level</XMP-exif:GPSAltitudeRef> + <XMP-exif:GPSAltitude>34.5 m</XMP-exif:GPSAltitude> + <XMP-exif:GPSDateTime>2026:05:06 15:42:18Z</XMP-exif:GPSDateTime> + <Composite:GPSAltitude>34.5 m Above Sea Level</Composite:GPSAltitude> + <Composite:GPSLatitudeRef>North</Composite:GPSLatitudeRef> + <Composite:GPSLongitudeRef>East</Composite:GPSLongitudeRef> + <Composite:GPSPosition>52 deg 30' 27.40" N, 13 deg 24' 34.07" E</Composite:GPSPosition> +</rdf:Description> +</rdf:RDF> diff --git a/internal/meta/testdata/xmp/synthetic/gps-time-combined.xmp b/internal/meta/testdata/xmp/synthetic/gps-time-combined.xmp new file mode 100644 index 000000000..02ad71c79 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/gps-time-combined.xmp @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Synthetic Fixture"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:exif="http://ns.adobe.com/exif/1.0/"> + <exif:GPSVersionID>2.2.0.0</exif:GPSVersionID> + <exif:GPSLatitude>52,30.4567N</exif:GPSLatitude> + <exif:GPSLongitude>13,24.5678E</exif:GPSLongitude> + <exif:GPSAltitudeRef>0</exif:GPSAltitudeRef> + <exif:GPSAltitude>3450/100</exif:GPSAltitude> + <exif:GPSTimeStamp>2026-05-06T15:42:18Z</exif:GPSTimeStamp> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> diff --git a/internal/meta/testdata/xmp/synthetic/gps-time-split.exiftool.txt b/internal/meta/testdata/xmp/synthetic/gps-time-split.exiftool.txt new file mode 100644 index 000000000..01c3eebb2 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/gps-time-split.exiftool.txt @@ -0,0 +1,36 @@ +<?xml version='1.0' encoding='UTF-8'?> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> + +<rdf:Description rdf:about='internal/meta/testdata/xmp/synthetic/gps-time-split.xmp' + xmlns:et='http://ns.exiftool.org/1.0/' et:toolkit='Image::ExifTool 13.25' + xmlns:ExifTool='http://ns.exiftool.org/ExifTool/1.0/' + xmlns:System='http://ns.exiftool.org/File/System/1.0/' + xmlns:File='http://ns.exiftool.org/File/1.0/' + xmlns:XMP-x='http://ns.exiftool.org/XMP/XMP-x/1.0/' + xmlns:XMP-exif='http://ns.exiftool.org/XMP/XMP-exif/1.0/' + xmlns:Composite='http://ns.exiftool.org/Composite/1.0/'> + <ExifTool:ExifToolVersion>13.25</ExifTool:ExifToolVersion> + <System:FileName>gps-time-split.xmp</System:FileName> + <System:Directory>internal/meta/testdata/xmp/synthetic</System:Directory> + <System:FileSize>665 bytes</System:FileSize> + <System:FileModifyDate>2026:05:06 07:32:30+00:00</System:FileModifyDate> + <System:FileAccessDate>2026:05:06 07:32:30+00:00</System:FileAccessDate> + <System:FileInodeChangeDate>2026:05:06 07:32:30+00:00</System:FileInodeChangeDate> + <System:FilePermissions>-rw-r--r--</System:FilePermissions> + <File:FileType>XMP</File:FileType> + <File:FileTypeExtension>xmp</File:FileTypeExtension> + <File:MIMEType>application/rdf+xml</File:MIMEType> + <XMP-x:XMPToolkit>PhotoPrism Synthetic Fixture</XMP-x:XMPToolkit> + <XMP-exif:GPSVersionID>2.2.0.0</XMP-exif:GPSVersionID> + <XMP-exif:GPSLatitude>52 deg 30' 27.40" N</XMP-exif:GPSLatitude> + <XMP-exif:GPSLongitude>13 deg 24' 34.07" E</XMP-exif:GPSLongitude> + <XMP-exif:GPSAltitudeRef>Above Sea Level</XMP-exif:GPSAltitudeRef> + <XMP-exif:GPSAltitude>34.5 m</XMP-exif:GPSAltitude> + <XMP-exif:GPSDateStamp>2026:05:06</XMP-exif:GPSDateStamp> + <XMP-exif:GPSDateTime>15:42:18</XMP-exif:GPSDateTime> + <Composite:GPSAltitude>34.5 m Above Sea Level</Composite:GPSAltitude> + <Composite:GPSLatitudeRef>North</Composite:GPSLatitudeRef> + <Composite:GPSLongitudeRef>East</Composite:GPSLongitudeRef> + <Composite:GPSPosition>52 deg 30' 27.40" N, 13 deg 24' 34.07" E</Composite:GPSPosition> +</rdf:Description> +</rdf:RDF> diff --git a/internal/meta/testdata/xmp/synthetic/gps-time-split.xmp b/internal/meta/testdata/xmp/synthetic/gps-time-split.xmp new file mode 100644 index 000000000..d159b4bb5 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/gps-time-split.xmp @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Synthetic Fixture"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:exif="http://ns.adobe.com/exif/1.0/"> + <exif:GPSVersionID>2.2.0.0</exif:GPSVersionID> + <exif:GPSLatitude>52,30.4567N</exif:GPSLatitude> + <exif:GPSLongitude>13,24.5678E</exif:GPSLongitude> + <exif:GPSAltitudeRef>0</exif:GPSAltitudeRef> + <exif:GPSAltitude>3450/100</exif:GPSAltitude> + <exif:GPSDateStamp>2026:05:06</exif:GPSDateStamp> + <exif:GPSTimeStamp>15:42:18</exif:GPSTimeStamp> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> diff --git a/internal/meta/testdata/xmp/synthetic/multi-rdf-description.exiftool.txt b/internal/meta/testdata/xmp/synthetic/multi-rdf-description.exiftool.txt new file mode 100644 index 000000000..5c00d65e3 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/multi-rdf-description.exiftool.txt @@ -0,0 +1,43 @@ +<?xml version='1.0' encoding='UTF-8'?> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> + +<rdf:Description rdf:about='internal/meta/testdata/xmp/synthetic/multi-rdf-description.xmp' + xmlns:et='http://ns.exiftool.org/1.0/' et:toolkit='Image::ExifTool 13.25' + xmlns:ExifTool='http://ns.exiftool.org/ExifTool/1.0/' + xmlns:System='http://ns.exiftool.org/File/System/1.0/' + xmlns:File='http://ns.exiftool.org/File/1.0/' + xmlns:XMP-x='http://ns.exiftool.org/XMP/XMP-x/1.0/' + xmlns:XMP-dc='http://ns.exiftool.org/XMP/XMP-dc/1.0/' + xmlns:XMP-exif='http://ns.exiftool.org/XMP/XMP-exif/1.0/' + xmlns:XMP-tiff='http://ns.exiftool.org/XMP/XMP-tiff/1.0/' + xmlns:XMP-xmpMM='http://ns.exiftool.org/XMP/XMP-xmpMM/1.0/' + xmlns:Composite='http://ns.exiftool.org/Composite/1.0/'> + <ExifTool:ExifToolVersion>13.25</ExifTool:ExifToolVersion> + <System:FileName>multi-rdf-description.xmp</System:FileName> + <System:Directory>internal/meta/testdata/xmp/synthetic</System:Directory> + <System:FileSize>1383 bytes</System:FileSize> + <System:FileModifyDate>2026:05:06 07:32:31+00:00</System:FileModifyDate> + <System:FileAccessDate>2026:05:06 07:32:31+00:00</System:FileAccessDate> + <System:FileInodeChangeDate>2026:05:06 07:32:31+00:00</System:FileInodeChangeDate> + <System:FilePermissions>-rw-r--r--</System:FilePermissions> + <File:FileType>XMP</File:FileType> + <File:FileTypeExtension>xmp</File:FileTypeExtension> + <File:MIMEType>application/rdf+xml</File:MIMEType> + <XMP-x:XMPToolkit>PhotoPrism Synthetic Fixture</XMP-x:XMPToolkit> + <XMP-dc:Title>Multi-Description Fixture</XMP-dc:Title> + <XMP-dc:Creator>PhotoPrism</XMP-dc:Creator> + <XMP-exif:GPSLatitude>52 deg 30' 27.40" N</XMP-exif:GPSLatitude> + <XMP-exif:GPSLongitude>13 deg 24' 34.07" E</XMP-exif:GPSLongitude> + <XMP-exif:GPSAltitudeRef>Above Sea Level</XMP-exif:GPSAltitudeRef> + <XMP-exif:GPSAltitude>34.5 m</XMP-exif:GPSAltitude> + <XMP-tiff:Make>SyntheticCam</XMP-tiff:Make> + <XMP-tiff:Model>SC-1 Mark II</XMP-tiff:Model> + <XMP-xmpMM:DocumentID>xmp.did:11111111-2222-3333-4444-555555555555</XMP-xmpMM:DocumentID> + <XMP-xmpMM:InstanceID>xmp.iid:aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee</XMP-xmpMM:InstanceID> + <XMP-xmpMM:OriginalDocumentID>00000000-0000-0000-0000-000000000000</XMP-xmpMM:OriginalDocumentID> + <Composite:GPSAltitude>34.5 m Above Sea Level</Composite:GPSAltitude> + <Composite:GPSLatitudeRef>North</Composite:GPSLatitudeRef> + <Composite:GPSLongitudeRef>East</Composite:GPSLongitudeRef> + <Composite:GPSPosition>52 deg 30' 27.40" N, 13 deg 24' 34.07" E</Composite:GPSPosition> +</rdf:Description> +</rdf:RDF> diff --git a/internal/meta/testdata/xmp/synthetic/multi-rdf-description.xmp b/internal/meta/testdata/xmp/synthetic/multi-rdf-description.xmp new file mode 100644 index 000000000..2215756bd --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/multi-rdf-description.xmp @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Synthetic Fixture"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:dc="http://purl.org/dc/elements/1.1/"> + <dc:title> + <rdf:Alt> + <rdf:li xml:lang="x-default">Multi-Description Fixture</rdf:li> + </rdf:Alt> + </dc:title> + <dc:creator> + <rdf:Seq> + <rdf:li>PhotoPrism</rdf:li> + </rdf:Seq> + </dc:creator> + </rdf:Description> + <rdf:Description rdf:about="" + xmlns:exif="http://ns.adobe.com/exif/1.0/"> + <exif:GPSLatitude>52,30.4567N</exif:GPSLatitude> + <exif:GPSLongitude>13,24.5678E</exif:GPSLongitude> + <exif:GPSAltitudeRef>0</exif:GPSAltitudeRef> + <exif:GPSAltitude>3450/100</exif:GPSAltitude> + </rdf:Description> + <rdf:Description rdf:about="" + xmlns:tiff="http://ns.adobe.com/tiff/1.0/"> + <tiff:Make>SyntheticCam</tiff:Make> + <tiff:Model>SC-1 Mark II</tiff:Model> + </rdf:Description> + <rdf:Description rdf:about="" + xmlns:xmpMM="http://ns.adobe.com/xap/1.0/mm/"> + <xmpMM:DocumentID>xmp.did:11111111-2222-3333-4444-555555555555</xmpMM:DocumentID> + <xmpMM:InstanceID>xmp.iid:aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee</xmpMM:InstanceID> + <xmpMM:OriginalDocumentID>00000000-0000-0000-0000-000000000000</xmpMM:OriginalDocumentID> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> diff --git a/internal/meta/testdata/xmp/synthetic/notes-usercomment.exiftool.txt b/internal/meta/testdata/xmp/synthetic/notes-usercomment.exiftool.txt new file mode 100644 index 000000000..2351db316 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/notes-usercomment.exiftool.txt @@ -0,0 +1,27 @@ +<?xml version='1.0' encoding='UTF-8'?> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> + +<rdf:Description rdf:about='internal/meta/testdata/xmp/synthetic/notes-usercomment.xmp' + xmlns:et='http://ns.exiftool.org/1.0/' et:toolkit='Image::ExifTool 13.25' + xmlns:ExifTool='http://ns.exiftool.org/ExifTool/1.0/' + xmlns:System='http://ns.exiftool.org/File/System/1.0/' + xmlns:File='http://ns.exiftool.org/File/1.0/' + xmlns:XMP-x='http://ns.exiftool.org/XMP/XMP-x/1.0/' + xmlns:XMP-exif='http://ns.exiftool.org/XMP/XMP-exif/1.0/'> + <ExifTool:ExifToolVersion>13.25</ExifTool:ExifToolVersion> + <System:FileName>notes-usercomment.xmp</System:FileName> + <System:Directory>internal/meta/testdata/xmp/synthetic</System:Directory> + <System:FileSize>716 bytes</System:FileSize> + <System:FileModifyDate>2026:05:06 07:32:30+00:00</System:FileModifyDate> + <System:FileAccessDate>2026:05:06 07:32:30+00:00</System:FileAccessDate> + <System:FileInodeChangeDate>2026:05:06 07:32:30+00:00</System:FileInodeChangeDate> + <System:FilePermissions>-rw-r--r--</System:FilePermissions> + <File:FileType>XMP</File:FileType> + <File:FileTypeExtension>xmp</File:FileTypeExtension> + <File:MIMEType>application/rdf+xml</File:MIMEType> + <XMP-x:XMPToolkit>PhotoPrism Synthetic Fixture</XMP-x:XMPToolkit> + <XMP-exif:UserComment>Synthetic note for the Notes accessor — exif:UserComment as lang-alt</XMP-exif:UserComment> + <XMP-exif:UserComment-en>Synthetic note for the Notes accessor — exif:UserComment as lang-alt</XMP-exif:UserComment-en> + <XMP-exif:UserComment-de>Synthetische Notiz für den Notes-Accessor — exif:UserComment als lang-alt</XMP-exif:UserComment-de> +</rdf:Description> +</rdf:RDF> diff --git a/internal/meta/testdata/xmp/synthetic/notes-usercomment.xmp b/internal/meta/testdata/xmp/synthetic/notes-usercomment.xmp new file mode 100644 index 000000000..be7c183e5 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/notes-usercomment.xmp @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Synthetic Fixture"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:exif="http://ns.adobe.com/exif/1.0/"> + <exif:UserComment> + <rdf:Alt> + <rdf:li xml:lang="x-default">Synthetic note for the Notes accessor — exif:UserComment as lang-alt</rdf:li> + <rdf:li xml:lang="en">Synthetic note for the Notes accessor — exif:UserComment as lang-alt</rdf:li> + <rdf:li xml:lang="de">Synthetische Notiz für den Notes-Accessor — exif:UserComment als lang-alt</rdf:li> + </rdf:Alt> + </exif:UserComment> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> diff --git a/internal/meta/testdata/xmp/synthetic/software-only.exiftool.txt b/internal/meta/testdata/xmp/synthetic/software-only.exiftool.txt new file mode 100644 index 000000000..17535d348 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/software-only.exiftool.txt @@ -0,0 +1,25 @@ +<?xml version='1.0' encoding='UTF-8'?> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> + +<rdf:Description rdf:about='internal/meta/testdata/xmp/synthetic/software-only.xmp' + xmlns:et='http://ns.exiftool.org/1.0/' et:toolkit='Image::ExifTool 13.25' + xmlns:ExifTool='http://ns.exiftool.org/ExifTool/1.0/' + xmlns:System='http://ns.exiftool.org/File/System/1.0/' + xmlns:File='http://ns.exiftool.org/File/1.0/' + xmlns:XMP-x='http://ns.exiftool.org/XMP/XMP-x/1.0/' + xmlns:XMP-xmp='http://ns.exiftool.org/XMP/XMP-xmp/1.0/'> + <ExifTool:ExifToolVersion>13.25</ExifTool:ExifToolVersion> + <System:FileName>software-only.xmp</System:FileName> + <System:Directory>internal/meta/testdata/xmp/synthetic</System:Directory> + <System:FileSize>379 bytes</System:FileSize> + <System:FileModifyDate>2026:05:06 07:32:30+00:00</System:FileModifyDate> + <System:FileAccessDate>2026:05:06 07:32:30+00:00</System:FileAccessDate> + <System:FileInodeChangeDate>2026:05:06 07:32:30+00:00</System:FileInodeChangeDate> + <System:FilePermissions>-rw-r--r--</System:FilePermissions> + <File:FileType>XMP</File:FileType> + <File:FileTypeExtension>xmp</File:FileTypeExtension> + <File:MIMEType>application/rdf+xml</File:MIMEType> + <XMP-x:XMPToolkit>PhotoPrism Synthetic Fixture</XMP-x:XMPToolkit> + <XMP-xmp:CreatorTool>PhotoPrism Synthetic Fixture 1.0.0</XMP-xmp:CreatorTool> +</rdf:Description> +</rdf:RDF> diff --git a/internal/meta/testdata/xmp/synthetic/software-only.xmp b/internal/meta/testdata/xmp/synthetic/software-only.xmp new file mode 100644 index 000000000..c57aaebb8 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/software-only.xmp @@ -0,0 +1,9 @@ +<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Synthetic Fixture"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:xmp="http://ns.adobe.com/xap/1.0/"> + <xmp:CreatorTool>PhotoPrism Synthetic Fixture 1.0.0</xmp:CreatorTool> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> diff --git a/internal/meta/testdata/xmp/synthetic/subject-seq.exiftool.txt b/internal/meta/testdata/xmp/synthetic/subject-seq.exiftool.txt new file mode 100644 index 000000000..9b1bd6926 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/subject-seq.exiftool.txt @@ -0,0 +1,33 @@ +<?xml version='1.0' encoding='UTF-8'?> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> + +<rdf:Description rdf:about='internal/meta/testdata/xmp/synthetic/subject-seq.xmp' + xmlns:et='http://ns.exiftool.org/1.0/' et:toolkit='Image::ExifTool 13.25' + xmlns:ExifTool='http://ns.exiftool.org/ExifTool/1.0/' + xmlns:System='http://ns.exiftool.org/File/System/1.0/' + xmlns:File='http://ns.exiftool.org/File/1.0/' + xmlns:XMP-x='http://ns.exiftool.org/XMP/XMP-x/1.0/' + xmlns:XMP-dc='http://ns.exiftool.org/XMP/XMP-dc/1.0/'> + <ExifTool:ExifToolVersion>13.25</ExifTool:ExifToolVersion> + <System:FileName>subject-seq.xmp</System:FileName> + <System:Directory>internal/meta/testdata/xmp/synthetic</System:Directory> + <System:FileSize>518 bytes</System:FileSize> + <System:FileModifyDate>2026:05:06 07:32:30+00:00</System:FileModifyDate> + <System:FileAccessDate>2026:05:06 07:32:30+00:00</System:FileAccessDate> + <System:FileInodeChangeDate>2026:05:06 07:32:30+00:00</System:FileInodeChangeDate> + <System:FilePermissions>-rw-r--r--</System:FilePermissions> + <File:FileType>XMP</File:FileType> + <File:FileTypeExtension>xmp</File:FileTypeExtension> + <File:MIMEType>application/rdf+xml</File:MIMEType> + <XMP-x:XMPToolkit>PhotoPrism Synthetic Fixture</XMP-x:XMPToolkit> + <XMP-dc:Subject> + <rdf:Bag> + <rdf:li>Sequenced</rdf:li> + <rdf:li>Keywords</rdf:li> + <rdf:li>Should</rdf:li> + <rdf:li>Also</rdf:li> + <rdf:li>Parse</rdf:li> + </rdf:Bag> + </XMP-dc:Subject> +</rdf:Description> +</rdf:RDF> diff --git a/internal/meta/testdata/xmp/synthetic/subject-seq.xmp b/internal/meta/testdata/xmp/synthetic/subject-seq.xmp new file mode 100644 index 000000000..635b051c5 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/subject-seq.xmp @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Synthetic Fixture"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:dc="http://purl.org/dc/elements/1.1/"> + <dc:subject> + <rdf:Seq> + <rdf:li>Sequenced</rdf:li> + <rdf:li>Keywords</rdf:li> + <rdf:li>Should</rdf:li> + <rdf:li>Also</rdf:li> + <rdf:li>Parse</rdf:li> + </rdf:Seq> + </dc:subject> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> diff --git a/internal/meta/testdata/xmp/synthetic/tiff-fields.exiftool.txt b/internal/meta/testdata/xmp/synthetic/tiff-fields.exiftool.txt new file mode 100644 index 000000000..573f88df7 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/tiff-fields.exiftool.txt @@ -0,0 +1,27 @@ +<?xml version='1.0' encoding='UTF-8'?> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> + +<rdf:Description rdf:about='internal/meta/testdata/xmp/synthetic/tiff-fields.xmp' + xmlns:et='http://ns.exiftool.org/1.0/' et:toolkit='Image::ExifTool 13.50' + xmlns:ExifTool='http://ns.exiftool.org/ExifTool/1.0/' + xmlns:System='http://ns.exiftool.org/File/System/1.0/' + xmlns:File='http://ns.exiftool.org/File/1.0/' + xmlns:XMP-x='http://ns.exiftool.org/XMP/XMP-x/1.0/' + xmlns:XMP-tiff='http://ns.exiftool.org/XMP/XMP-tiff/1.0/'> + <ExifTool:ExifToolVersion>13.50</ExifTool:ExifToolVersion> + <System:FileName>tiff-fields.xmp</System:FileName> + <System:Directory>internal/meta/testdata/xmp/synthetic</System:Directory> + <System:FileSize>651 bytes</System:FileSize> + <System:FileModifyDate>2026:07:07 10:13:16+00:00</System:FileModifyDate> + <System:FileAccessDate>2026:07:07 10:13:16+00:00</System:FileAccessDate> + <System:FileInodeChangeDate>2026:07:07 10:13:16+00:00</System:FileInodeChangeDate> + <System:FilePermissions>-rw-r--r--</System:FilePermissions> + <File:FileType>XMP</File:FileType> + <File:FileTypeExtension>xmp</File:FileTypeExtension> + <File:MIMEType>application/rdf+xml</File:MIMEType> + <XMP-x:XMPToolkit>PhotoPrism Synthetic Fixture</XMP-x:XMPToolkit> + <XMP-tiff:Software>TiffSoftware 1.0</XMP-tiff:Software> + <XMP-tiff:ImageDescription>A tiff image description</XMP-tiff:ImageDescription> + <XMP-tiff:Copyright>Copyright 2026 Example Org</XMP-tiff:Copyright> +</rdf:Description> +</rdf:RDF> diff --git a/internal/meta/testdata/xmp/synthetic/tiff-fields.xmp b/internal/meta/testdata/xmp/synthetic/tiff-fields.xmp new file mode 100644 index 000000000..69ada0e9a --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/tiff-fields.xmp @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Synthetic Fixture"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:tiff="http://ns.adobe.com/tiff/1.0/"> + <tiff:Software>TiffSoftware 1.0</tiff:Software> + <tiff:ImageDescription> + <rdf:Alt> + <rdf:li xml:lang="x-default">A tiff image description</rdf:li> + </rdf:Alt> + </tiff:ImageDescription> + <tiff:Copyright> + <rdf:Alt> + <rdf:li xml:lang="x-default">Copyright 2026 Example Org</rdf:li> + </rdf:Alt> + </tiff:Copyright> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> diff --git a/internal/meta/testdata/xmp/synthetic/time-offsets-subsec.exiftool.txt b/internal/meta/testdata/xmp/synthetic/time-offsets-subsec.exiftool.txt new file mode 100644 index 000000000..4a121f807 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/time-offsets-subsec.exiftool.txt @@ -0,0 +1,33 @@ +<?xml version='1.0' encoding='UTF-8'?> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> + +<rdf:Description rdf:about='internal/meta/testdata/xmp/synthetic/time-offsets-subsec.xmp' + xmlns:et='http://ns.exiftool.org/1.0/' et:toolkit='Image::ExifTool 13.25' + xmlns:ExifTool='http://ns.exiftool.org/ExifTool/1.0/' + xmlns:System='http://ns.exiftool.org/File/System/1.0/' + xmlns:File='http://ns.exiftool.org/File/1.0/' + xmlns:XMP-x='http://ns.exiftool.org/XMP/XMP-x/1.0/' + xmlns:XMP-photoshop='http://ns.exiftool.org/XMP/XMP-photoshop/1.0/' + xmlns:XMP-exif='http://ns.exiftool.org/XMP/XMP-exif/1.0/' + xmlns:XMP-xmp='http://ns.exiftool.org/XMP/XMP-xmp/1.0/'> + <ExifTool:ExifToolVersion>13.25</ExifTool:ExifToolVersion> + <System:FileName>time-offsets-subsec.xmp</System:FileName> + <System:Directory>internal/meta/testdata/xmp/synthetic</System:Directory> + <System:FileSize>843 bytes</System:FileSize> + <System:FileModifyDate>2026:05:06 07:32:30+00:00</System:FileModifyDate> + <System:FileAccessDate>2026:05:06 07:32:30+00:00</System:FileAccessDate> + <System:FileInodeChangeDate>2026:05:06 07:32:30+00:00</System:FileInodeChangeDate> + <System:FilePermissions>-rw-r--r--</System:FilePermissions> + <File:FileType>XMP</File:FileType> + <File:FileTypeExtension>xmp</File:FileTypeExtension> + <File:MIMEType>application/rdf+xml</File:MIMEType> + <XMP-x:XMPToolkit>PhotoPrism Synthetic Fixture</XMP-x:XMPToolkit> + <XMP-photoshop:DateCreated>2026:05:06 15:42:18.123456</XMP-photoshop:DateCreated> + <XMP-exif:DateTimeOriginal>2026:05:06 15:42:18</XMP-exif:DateTimeOriginal> + <XMP-exif:SubSecTimeOriginal>123456</XMP-exif:SubSecTimeOriginal> + <XMP-exif:OffsetTimeOriginal>+02:00</XMP-exif:OffsetTimeOriginal> + <XMP-exif:OffsetTime>+02:00</XMP-exif:OffsetTime> + <XMP-exif:OffsetTimeDigitized>+02:00</XMP-exif:OffsetTimeDigitized> + <XMP-xmp:CreateDate>2026:05:06 15:42:18</XMP-xmp:CreateDate> +</rdf:Description> +</rdf:RDF> diff --git a/internal/meta/testdata/xmp/synthetic/time-offsets-subsec.xmp b/internal/meta/testdata/xmp/synthetic/time-offsets-subsec.xmp new file mode 100644 index 000000000..a00666d2f --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/time-offsets-subsec.xmp @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Synthetic Fixture"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:exif="http://ns.adobe.com/exif/1.0/" + xmlns:photoshop="http://ns.adobe.com/photoshop/1.0/" + xmlns:xmp="http://ns.adobe.com/xap/1.0/"> + <photoshop:DateCreated>2026-05-06T15:42:18.123456</photoshop:DateCreated> + <exif:DateTimeOriginal>2026-05-06T15:42:18</exif:DateTimeOriginal> + <xmp:CreateDate>2026-05-06T15:42:18</xmp:CreateDate> + <exif:SubSecTimeOriginal>123456</exif:SubSecTimeOriginal> + <exif:OffsetTimeOriginal>+02:00</exif:OffsetTimeOriginal> + <exif:OffsetTime>+02:00</exif:OffsetTime> + <exif:OffsetTimeDigitized>+02:00</exif:OffsetTimeDigitized> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> diff --git a/internal/meta/testdata/xmp/synthetic/xmpdm-creationdate.exiftool.txt b/internal/meta/testdata/xmp/synthetic/xmpdm-creationdate.exiftool.txt new file mode 100644 index 000000000..80c551987 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/xmpdm-creationdate.exiftool.txt @@ -0,0 +1,25 @@ +<?xml version='1.0' encoding='UTF-8'?> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> + +<rdf:Description rdf:about='internal/meta/testdata/xmp/synthetic/xmpdm-creationdate.xmp' + xmlns:et='http://ns.exiftool.org/1.0/' et:toolkit='Image::ExifTool 13.25' + xmlns:ExifTool='http://ns.exiftool.org/ExifTool/1.0/' + xmlns:System='http://ns.exiftool.org/File/System/1.0/' + xmlns:File='http://ns.exiftool.org/File/1.0/' + xmlns:XMP-x='http://ns.exiftool.org/XMP/XMP-x/1.0/' + xmlns:XMP-xmpDM='http://ns.exiftool.org/XMP/XMP-xmpDM/1.0/'> + <ExifTool:ExifToolVersion>13.25</ExifTool:ExifToolVersion> + <System:FileName>xmpdm-creationdate.xmp</System:FileName> + <System:Directory>internal/meta/testdata/xmp/synthetic</System:Directory> + <System:FileSize>391 bytes</System:FileSize> + <System:FileModifyDate>2026:05:06 07:32:30+00:00</System:FileModifyDate> + <System:FileAccessDate>2026:05:06 07:32:30+00:00</System:FileAccessDate> + <System:FileInodeChangeDate>2026:05:06 07:32:30+00:00</System:FileInodeChangeDate> + <System:FilePermissions>-rw-r--r--</System:FilePermissions> + <File:FileType>XMP</File:FileType> + <File:FileTypeExtension>xmp</File:FileTypeExtension> + <File:MIMEType>application/rdf+xml</File:MIMEType> + <XMP-x:XMPToolkit>PhotoPrism Synthetic Fixture</XMP-x:XMPToolkit> + <XMP-xmpDM:CreationDate>2026:05:06 15:42:18+02:00</XMP-xmpDM:CreationDate> +</rdf:Description> +</rdf:RDF> diff --git a/internal/meta/testdata/xmp/synthetic/xmpdm-creationdate.xmp b/internal/meta/testdata/xmp/synthetic/xmpdm-creationdate.xmp new file mode 100644 index 000000000..13c52a117 --- /dev/null +++ b/internal/meta/testdata/xmp/synthetic/xmpdm-creationdate.xmp @@ -0,0 +1,9 @@ +<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Synthetic Fixture"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:xmpDM="http://ns.adobe.com/xmp/1.0/DynamicMedia/"> + <xmpDM:CreationDate>2026-05-06T15:42:18+02:00</xmpDM:CreationDate> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> diff --git a/internal/meta/xmp.go b/internal/meta/xmp.go index c8947c974..ef1582173 100644 --- a/internal/meta/xmp.go +++ b/internal/meta/xmp.go @@ -4,10 +4,11 @@ import ( "fmt" "path/filepath" "runtime/debug" + "time" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" - "github.com/photoprism/photoprism/pkg/time/tz" + "github.com/photoprism/photoprism/pkg/media/projection" ) // XMP parses an XMP file and returns a Data struct. @@ -17,65 +18,195 @@ func XMP(fileName string) (data Data, err error) { return data, err } +// applyTimeOffset reinterprets t's wall-clock components as local time in the +// fixed zone described by an EXIF OffsetTime string ("+02:00", "-05:30"). +// Returns t unchanged if the offset cannot be parsed. +func applyTimeOffset(t time.Time, offset string) time.Time { + z, err := time.Parse("-07:00", offset) + if err != nil { + return t + } + + _, secs := z.Zone() + loc := time.FixedZone(offset, secs) + + return time.Date(t.Year(), t.Month(), t.Day(), t.Hour(), t.Minute(), t.Second(), t.Nanosecond(), loc) +} + // XMP parses an XMP file and returns a Data struct. func (data *Data) XMP(fileName string) (err error) { + logName := clean.Log(filepath.Base(fileName)) + defer func() { if e := recover(); e != nil { - err = fmt.Errorf("metadata: %s in %s (xmp panic)\nstack: %s", e, clean.Log(filepath.Base(fileName)), debug.Stack()) + err = fmt.Errorf("metadata: %s in %s (xmp panic)\nstack: %s", e, logName, debug.Stack()) } }() // Resolve file name e.g. in case it's a symlink. if fileName, err = fs.Resolve(fileName); err != nil { - return fmt.Errorf("metadata: %s %s (xmp)", err, clean.Log(filepath.Base(fileName))) + return fmt.Errorf("metadata: %s %s (xmp)", err, logName) } doc := XmpDocument{} if err = doc.Load(fileName); err != nil { - return fmt.Errorf("metadata: cannot read %s (xmp)", clean.Log(filepath.Base(fileName))) + return fmt.Errorf("metadata: cannot read %s (xmp)", logName) } - if doc.Title() != "" { - data.Title = doc.Title() + if v := doc.Title(); v != "" { + data.Title = v + } + if v := doc.Artist(); v != "" { + data.Artist = v + } + if v := doc.Description(); v != "" { + data.Caption = v + } + if v := doc.Copyright(); v != "" { + data.Copyright = v + } + if v := doc.License(); v != "" { + data.License = v + } + if v := doc.Software(); v != "" { + data.Software = v + } + if v := doc.DocumentID(); v != "" { + data.DocumentID = v + } + if v := doc.InstanceID(); v != "" { + data.InstanceID = v } - if doc.Artist() != "" { - data.Artist = doc.Artist() + // GPS Lat/Lng pass through NormalizeGPS for parity with the embedded + // path's clamp/normalize behavior. + if lat, lng := doc.Lat(), doc.Lng(); lat != 0 || lng != 0 { + data.Lat, data.Lng = NormalizeGPS(lat, lng) + } + if v := doc.Altitude(); v != 0 { + data.Altitude = v + } + if v := doc.TakenGps(); !v.IsZero() { + data.TakenGps = v.UTC() } - if doc.Description() != "" { - data.Caption = doc.Description() + if v := doc.CameraMake(); v != "" { + data.CameraMake = v + } + if v := doc.CameraModel(); v != "" { + data.CameraModel = v + } + if v := doc.LensMake(); v != "" { + data.LensMake = v + } + if v := doc.LensModel(); v != "" { + data.LensModel = v + } + if v := doc.CameraSerial(); v != "" { + data.CameraSerial = v + } + if v := doc.CameraOwner(); v != "" { + data.CameraOwner = v + } + if v := doc.Projection(); v != "" { + data.Projection = v + } + if v := doc.ColorProfile(); v != "" { + data.ColorProfile = v } - if doc.Copyright() != "" { - data.Copyright = doc.Copyright() + if v := doc.Aperture(); v != 0 { + data.Aperture = v + } + if v := doc.FNumber(); v != 0 { + data.FNumber = v + } + if v := doc.FocalLength(); v != 0 { + data.FocalLength = v + } + if v := doc.Iso(); v != 0 { + data.Iso = v + } + if v := doc.Exposure(); v != "" { + data.Exposure = v + } + if doc.Flash() { + // Mirror the embedded-EXIF flow: set the bool *and* add the + // "flash" keyword, so XMP-sidecar-only photos surface in the + // same searches as photos indexed via the EXIF path. + data.AddKeywords(KeywordFlash) + data.Flash = true + } + if v := doc.Notes(); v != "" { + data.Notes = v } - if doc.CameraMake() != "" { - data.CameraMake = doc.CameraMake() + if v := doc.TakenAt(data.TimeZone); !v.IsZero() { + // Keep the wall-clock value (carrying any FixedZone parsed from the + // XMP timestamp) on both fields so the shared resolver can normalize + // UTC and local time consistently — mirrors how the EXIF reflection + // loop fills TakenAt and TakenAtLocal from the same source tag. + data.TakenAt = v + data.TakenAtLocal = v + } + if v := doc.TakenNs(); v > 0 { + data.TakenNs = v + } + // CreatedAt only serves as a capture-time fallback for video/audio + // sidecars (xmpDM:CreationDate), where TakenAt has no source tag. When + // TakenAt is already set from photoshop:DateCreated, leaving CreatedAt + // empty stops the shared resolver from overwriting the higher-priority + // capture instant with the less-specific xmp:CreateDate. + if data.TakenAt.IsZero() { + if v := doc.CreatedAt(data.TimeZone); !v.IsZero() { + data.CreatedAt = v.UTC() + } + } + if v := doc.TimeOffset(); v != "" { + data.TimeOffset = v } - if doc.CameraModel() != "" { - data.CameraModel = doc.CameraModel() - } - - if doc.LensModel() != "" { - data.LensModel = doc.LensModel() - } - - if takenAt := doc.TakenAt(data.TimeZone); !takenAt.IsZero() { - data.TakenAt = takenAt.UTC() - if data.TimeZone == "" { - data.TimeZone = tz.UTC + // XMP capture-time tags carry no inline UTC offset, whereas the EXIF 2.31 + // OffsetTime* value lives in a separate tag. Attach it to TakenAt and + // TakenAtLocal so the shared resolver — which assumes TakenAtLocal knows + // its own zone — can derive the correct UTC instant. Skip when the parsed + // timestamp already carries an offset (non-UTC zone). + if data.TimeOffset != "" && !data.TakenAt.IsZero() { + if _, off := data.TakenAt.Zone(); off == 0 { + data.TakenAt = applyTimeOffset(data.TakenAt, data.TimeOffset) + data.TakenAtLocal = data.TakenAt } } - if len(doc.Keywords()) != 0 { - data.AddKeywords(doc.Keywords()) + // dc:subject populates the descriptive Subject field only, never the + // keyword list: dc:subject is Adobe's "Keywords" panel, but PhotoPrism's + // Keywords, Labels, and Subject fields serve distinct purposes. This + // matches the embedded/ExifTool path, where data.Subject comes from the + // dc:subject-backed Subject tag and data.Keywords from IPTC Keywords. + if v := doc.Subject(); v != "" { + data.Subject = SanitizeMeta(v) } data.Favorite = doc.Favorite() + // Auto-derive keywords from projection and caption text so XMP-only + // photos surface in the same searches as EXIF-indexed photos. Mirrors + // the EXIF and ExifTool JSON flows (exif.go's ProjectionType/ImageDescription + // keyword block, json_exiftool.go's panorama/caption keyword block). + // AutoAddKeywords also sets data.ImageType to ImageTypeHDR when the + // caption mentions "hdr". + if projection.Equirectangular.Equal(data.Projection) { + data.AddKeywords(KeywordPanorama) + } + if data.Caption != "" { + data.AutoAddKeywords(data.Caption) + } + + // Normalize capture time, local time, and time zone using the shared + // resolver so the XMP sidecar path produces the same entity state the + // ExifTool JSON path would for identical metadata. + data.ResolveTimeZone(logName) + return nil } diff --git a/internal/meta/xmp_bench_test.go b/internal/meta/xmp_bench_test.go new file mode 100644 index 000000000..b1570feea --- /dev/null +++ b/internal/meta/xmp_bench_test.go @@ -0,0 +1,45 @@ +package meta + +import ( + "testing" +) + +// BenchmarkXMPRichSidecar measures per-file parse time on a fully +// populated Adobe Bridge sidecar (descriptive metadata, GPS, full +// camera/lens/exposure cluster, IDs). The proposal's performance +// budget is ≤ 2× the previous hand-rolled reader; running this with +// `go test -bench .` documents the new reader's absolute time so the +// budget can be reasoned about without re-introducing the old code. +func BenchmarkXMPRichSidecar(b *testing.B) { + for i := 0; i < b.N; i++ { + var data Data + if err := data.XMP("testdata/xmp/adobe/bridge.xmp"); err != nil { + b.Fatal(err) + } + } +} + +// BenchmarkXMPMinimalSidecar measures the cheap path: a single-attribute +// fixture (F-Stop favorite). Sets a lower bound for how fast the loader +// + accessor pipeline can return when there is almost nothing to read. +func BenchmarkXMPMinimalSidecar(b *testing.B) { + for i := 0; i < b.N; i++ { + var data Data + if err := data.XMP("testdata/fstop-favorite.xmp"); err != nil { + b.Fatal(err) + } + } +} + +// BenchmarkXMPMultiDescription measures the worst-case shape: four +// sibling rdf:Description blocks each declaring a different namespace +// binding. Catches regressions where the XPath walk degrades when +// properties scatter across blocks. +func BenchmarkXMPMultiDescription(b *testing.B) { + for i := 0; i < b.N; i++ { + var data Data + if err := data.XMP("testdata/xmp/synthetic/multi-rdf-description.xmp"); err != nil { + b.Fatal(err) + } + } +} diff --git a/internal/meta/xmp_document.go b/internal/meta/xmp_document.go index 65c289558..85e61f3af 100644 --- a/internal/meta/xmp_document.go +++ b/internal/meta/xmp_document.go @@ -1,292 +1,785 @@ package meta import ( - "encoding/xml" + "errors" + "fmt" + "io" + "math" "os" + "strconv" "strings" "time" + "github.com/antchfx/xmlquery" + "github.com/antchfx/xpath" + + "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/txt" ) -// XmpDocument represents an XMP sidecar file. -type XmpDocument struct { - XMLName xml.Name `xml:"xmpmeta" json:"xmpmeta"` - Text string `xml:",chardata" json:"text,omitempty"` - X string `xml:"x,attr" json:"x,omitempty"` - Xmptk string `xml:"xmptk,attr" json:"xmptk,omitempty"` - RDF struct { - Text string `xml:",chardata" json:"text,omitempty"` - Rdf string `xml:"rdf,attr" json:"rdf,omitempty"` - Description struct { - Text string `xml:",chardata" json:"text,omitempty"` - About string `xml:"about,attr" json:"about,omitempty"` - Xmp string `xml:"xmp,attr" json:"xmp,omitempty"` - Aux string `xml:"aux,attr" json:"aux,omitempty"` - ExifEX string `xml:"exifEX,attr" json:"exifex,omitempty"` - Photoshop string `xml:"photoshop,attr" json:"photoshop,omitempty"` - XmpMM string `xml:"xmpMM,attr" json:"xmpmm,omitempty"` - Dc string `xml:"dc,attr" json:"dc,omitempty"` - Tiff string `xml:"tiff,attr" json:"tiff,omitempty"` - Exif string `xml:"exif,attr" json:"exif,omitempty"` - XmpRights string `xml:"xmpRights,attr" json:"xmprights,omitempty"` - Iptc4xmpCore string `xml:"Iptc4xmpCore,attr" json:"iptc4xmpcore,omitempty"` - Iptc4xmpExt string `xml:"Iptc4xmpExt,attr" json:"iptc4xmpext,omitempty"` - CreatorTool string `xml:"CreatorTool"` // ELE-L29 10.0.0.168(C431E2... - ModifyDate string `xml:"ModifyDate"` // 2020-01-01T17:28:23.89961... - CreateDate string `xml:"CreateDate"` // 2020-01-01T17:28:23 - MetadataDate string `xml:"MetadataDate"` // 2020-01-01T17:28:23.89961... - Rating string `xml:"Rating"` // 4 - FStopFavorite string `xml:"http://www.fstopapp.com/xmp/ favorite,attr"` // 1 - Lens string `xml:"Lens"` // HUAWEI P30 Rear Main Came... - LensModel string `xml:"LensModel"` // HUAWEI P30 Rear Main Came... - DateCreated string `xml:"DateCreated"` // 2020-01-01T17:28:25.72962... - ColorMode string `xml:"ColorMode"` // 3 - ICCProfile string `xml:"ICCProfile"` // sRGB IEC61966-2.1 - AuthorsPosition string `xml:"AuthorsPosition"` // Maintainer - DocumentID string `xml:"DocumentID"` // 2C678C1811D7095FD79CC822B... - InstanceID string `xml:"InstanceID"` // 2C678C1811D7095FD79CC822B... - Format string `xml:"format"` // image/jpeg - Title struct { - Text string `xml:",chardata" json:"text,omitempty"` - Alt struct { - Text string `xml:",chardata" json:"text,omitempty"` - Li struct { - Text string `xml:",chardata" json:"text,omitempty"` // Night Shift / Berlin / 20... - Lang string `xml:"lang,attr" json:"lang,omitempty"` - } `xml:"li" json:"li"` - } `xml:"Alt" json:"alt"` - } `xml:"title" json:"title"` - Creator struct { - Text string `xml:",chardata" json:"text,omitempty"` - Seq struct { - Text string `xml:",chardata" json:"text,omitempty"` - Li string `xml:"li"` // Michael Mayer - } `xml:"Seq" json:"seq"` - } `xml:"creator" json:"creator"` - Description struct { - Text string `xml:",chardata" json:"text,omitempty"` - Alt struct { - Text string `xml:",chardata" json:"text,omitempty"` - Li struct { - Text string `xml:",chardata" json:"text,omitempty"` // Example file for developm... - Lang string `xml:"lang,attr" json:"lang,omitempty"` - } `xml:"li" json:"li"` - } `xml:"Alt" json:"alt"` - } `xml:"description" json:"description"` - Subject struct { - Text string `xml:",chardata" json:"text,omitempty"` - Bag struct { - Text string `xml:",chardata" json:"text,omitempty"` - Li []string `xml:"li"` // desk, coffee, computer - } `xml:"Bag" json:"bag"` - Seq struct { - Text string `xml:",chardata" json:"text,omitempty"` - Li []string `xml:"li"` // desk, coffee, computer - } `xml:"Seq" json:"seq"` - } `xml:"subject" json:"subject"` - Rights struct { - Text string `xml:",chardata" json:"text,omitempty"` - Alt struct { - Text string `xml:",chardata" json:"text,omitempty"` - Li struct { - Text string `xml:",chardata" json:"text,omitempty"` // This is an (edited) legal... - Lang string `xml:"lang,attr" json:"lang,omitempty"` - } `xml:"li" json:"li"` - } `xml:"Alt" json:"alt"` - } `xml:"rights" json:"rights"` - ImageWidth string `xml:"ImageWidth"` // 3648 - ImageLength string `xml:"ImageLength"` // 2736 - BitsPerSample struct { - Text string `xml:",chardata" json:"text,omitempty"` - Seq struct { - Text string `xml:",chardata" json:"text,omitempty"` - Li []string `xml:"li"` // 8 - } `xml:"Seq" json:"seq"` - } `xml:"BitsPerSample" json:"bitspersample"` - PhotometricInterpretation string `xml:"PhotometricInterpretation"` // 2 - Orientation string `xml:"Orientation"` // 0 - SamplesPerPixel string `xml:"SamplesPerPixel"` // 3 - YCbCrPositioning string `xml:"YCbCrPositioning"` // 1 - XResolution string `xml:"XResolution"` // 72/1 - YResolution string `xml:"YResolution"` // 72/1 - ResolutionUnit string `xml:"ResolutionUnit"` // 2 - Make string `xml:"Make"` // HUAWEI - Model string `xml:"Model"` // ELE-L29 - ExifVersion string `xml:"ExifVersion"` // 0210 - FlashpixVersion string `xml:"FlashpixVersion"` // 0100 - ColorSpace string `xml:"ColorProfile"` // 1 - ComponentsConfiguration struct { - Text string `xml:",chardata" json:"text,omitempty"` - Seq struct { - Text string `xml:",chardata" json:"text,omitempty"` - Li []string `xml:"li"` // 1, 2, 3, 0 - } `xml:"Seq" json:"seq"` - } `xml:"ComponentsConfiguration" json:"componentsconfiguration"` - CompressedBitsPerPixel string `xml:"CompressedBitsPerPixel"` // 95/100 - PixelXDimension string `xml:"PixelXDimension"` // 3648 - PixelYDimension string `xml:"PixelYDimension"` // 2736 - DateTimeOriginal string `xml:"DateTimeOriginal"` // 2020-01-01T17:28:23 - ExposureTime string `xml:"ExposureTime"` // 20000000/1000000000 - FNumber string `xml:"FNumber"` // 180/100 - ExposureProgram string `xml:"ExposureProgram"` // 2 - ISOSpeedRatings struct { - Text string `xml:",chardata" json:"text,omitempty"` - Seq struct { - Text string `xml:",chardata" json:"text,omitempty"` - Li string `xml:"li"` // 200 - } `xml:"Seq" json:"seq"` - } `xml:"ISOSpeedRatings" json:"isospeedratings"` - ShutterSpeedValue string `xml:"ShutterSpeedValue"` // 298973/10000 - ApertureValue string `xml:"ApertureValue"` // 1695994/1000000 - BrightnessValue string `xml:"BrightnessValue"` // 0/1 - ExposureBiasValue string `xml:"ExposureBiasValue"` // 0/10 - MaxApertureValue string `xml:"MaxApertureValue"` // 169/100 - MeteringMode string `xml:"MeteringMode"` // 5 - LightSource string `xml:"LightSource"` // 1 - Flash struct { - Text string `xml:",chardata" json:"text,omitempty"` - ParseType string `xml:"parseType,attr" json:"parsetype,omitempty"` - Fired string `xml:"Fired"` // False - Return string `xml:"Return"` // 0 - Mode string `xml:"Mode"` // 0 - Function string `xml:"Function"` // False - RedEyeMode string `xml:"RedEyeMode"` // False - } `xml:"Flash" json:"flash"` - FocalLength string `xml:"FocalLength"` // 5580/1000 - SensingMethod string `xml:"SensingMethod"` // 2 - FileSource string `xml:"FileSource"` // 3 - SceneType string `xml:"SceneType"` // 1 - CustomRendered string `xml:"CustomRendered"` // 1 - ExposureMode string `xml:"ExposureMode"` // 0 - WhiteBalance string `xml:"WhiteBalance"` // 0 - DigitalZoomRatio string `xml:"DigitalZoomRatio"` // 100/100 - FocalLengthIn35mmFilm string `xml:"FocalLengthIn35mmFilm"` // 27 - SceneCaptureType string `xml:"SceneCaptureType"` // 0 - GainControl string `xml:"GainControl"` // 0 - Contrast string `xml:"Contrast"` // 0 - Saturation string `xml:"Saturation"` // 0 - Sharpness string `xml:"Sharpness"` // 0 - SubjectDistanceRange string `xml:"SubjectDistanceRange"` // 0 - SubSecTime string `xml:"SubSecTime"` // 899614 - SubSecTimeOriginal string `xml:"SubSecTimeOriginal"` // 899614 - SubSecTimeDigitized string `xml:"SubSecTimeDigitized"` // 899614 - GPSVersionID string `xml:"GPSVersionID"` // 2.2.0.0 - GPSLatitude string `xml:"GPSLatitude"` // 52,27.5814N - GPSLongitude string `xml:"GPSLongitude"` // 13,19.3099E - GPSAltitudeRef string `xml:"GPSAltitudeRef"` // 1 - GPSAltitude string `xml:"GPSAltitude"` // 0/100 - GPSTimeStamp string `xml:"GPSTimeStamp"` // 2020-01-01T16:28:22Z - Marked string `xml:"Marked"` // False - WebStatement string `xml:"WebStatement"` // http://docs.photoprism.or... - CreatorContactInfo struct { - Text string `xml:",chardata" json:"text,omitempty"` - ParseType string `xml:"parseType,attr" json:"parsetype,omitempty"` - CiAdrExtadr string `xml:"CiAdrExtadr"` // Zimmermannstr. 37 - CiAdrCity string `xml:"CiAdrCity"` // Berlin - CiAdrPcode string `xml:"CiAdrPcode"` // 12163 - CiAdrCtry string `xml:"CiAdrCtry"` // Germany - CiTelWork string `xml:"CiTelWork"` // +49123456789 - CiEmailWork string `xml:"CiEmailWork"` // hello@photoprism.org - CiUrlWork string `xml:"CiUrlWork"` // https://photoprism.org/ - } `xml:"CreatorContactInfo" json:"creatorcontactinfo"` - PersonInImage struct { - Text string `xml:",chardata" json:"text,omitempty"` - Bag struct { - Text string `xml:",chardata" json:"text,omitempty"` - Li string `xml:"li"` // Gopher - } `xml:"Bag" json:"bag"` - } `xml:"PersonInImage" json:"personinimage"` - } `xml:"Description" json:"description"` - } `xml:"RDF" json:"rdf"` +// xmpMaxFileSize caps XMP sidecar size to mitigate denial-of-service via +// pathologically large files. Real-world sidecars range from ~5 KB to +// ~200 KB; 1 MiB leaves generous headroom. +const xmpMaxFileSize = 1 * 1024 * 1024 + +// xmpMaxDepth caps element nesting to mitigate depth-bomb attacks. +// Natural XMP nests to ~10–12 levels; 64 is well above any legitimate use. +const xmpMaxDepth = 64 + +// ErrXmpFileTooLarge is returned when an XMP sidecar exceeds xmpMaxFileSize. +var ErrXmpFileTooLarge = errors.New("xmp: file size exceeds limit") + +// ErrXmpTooDeep is returned when an XMP document nests deeper than xmpMaxDepth. +var ErrXmpTooDeep = errors.New("xmp: element nesting exceeds limit") + +// xmpNamespaces binds canonical XMP namespace prefixes to their URIs. +// Adding a prefix here makes it available to every XPath expression +// compiled with mustCompile. +var xmpNamespaces = map[string]string{ + "xml": "http://www.w3.org/XML/1998/namespace", + "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#", + "x": "adobe:ns:meta/", + "xmp": "http://ns.adobe.com/xap/1.0/", + "xmpMM": "http://ns.adobe.com/xap/1.0/mm/", + "xmpRights": "http://ns.adobe.com/xap/1.0/rights/", + "xmpDM": "http://ns.adobe.com/xmp/1.0/DynamicMedia/", + "dc": "http://purl.org/dc/elements/1.1/", + "tiff": "http://ns.adobe.com/tiff/1.0/", + "exif": "http://ns.adobe.com/exif/1.0/", + "exifEX": "http://cipa.jp/exif/1.0/", + "aux": "http://ns.adobe.com/exif/1.0/aux/", + "photoshop": "http://ns.adobe.com/photoshop/1.0/", + "GPano": "http://ns.google.com/photos/1.0/panorama/", + "Iptc4xmpCore": "http://iptc.org/std/Iptc4xmpCore/1.0/xmlns/", + "Iptc4xmpExt": "http://iptc.org/std/Iptc4xmpExt/2008-02-29/", + "lr": "http://ns.adobe.com/lightroom/1.0/", + "fstop": "http://www.fstopapp.com/xmp/", } -// Load parses an XMP file and populates document values with its contents. -func (doc *XmpDocument) Load(filename string) error { - data, err := os.ReadFile(filename) //nolint:gosec // filename is provided by caller; reading sidecar files is expected +// chainXPath is an ordered list of pre-compiled XPath expressions +// evaluated left-to-right; the first non-empty match wins. +type chainXPath []*xpath.Expr +// firstNonEmpty returns the trimmed inner text of the first matching +// node; empty string when no link in the chain produces a value. +func (c chainXPath) firstNonEmpty(root *xmlquery.Node) string { + if root == nil { + return "" + } + for _, expr := range c { + if n := xmlquery.QuerySelector(root, expr); n != nil { + if s := strings.TrimSpace(n.InnerText()); s != "" { + return s + } + } + } + return "" +} + +// queryAll returns the trimmed text of every matching node in document +// order; empty matches are dropped. +func queryAll(root *xmlquery.Node, expr *xpath.Expr) []string { + if root == nil || expr == nil { + return nil + } + nodes := xmlquery.QuerySelectorAll(root, expr) + out := make([]string, 0, len(nodes)) + for _, n := range nodes { + if s := strings.TrimSpace(n.InnerText()); s != "" { + out = append(out, s) + } + } + return out +} + +// mustCompile compiles an XPath expression bound to xmpNamespaces and +// panics on a malformed expression. Intended for package-init wiring. +func mustCompile(expr string) *xpath.Expr { + compiled, err := xpath.CompileWithNS(expr, xmpNamespaces) + if err != nil { + panic(fmt.Sprintf("xmp: invalid XPath %q: %v", expr, err)) + } + return compiled +} + +// elemOrAttr matches the named element or the same property expressed +// as an attribute on rdf:Description (digiKam emits attributes, Adobe +// emits child elements; both are valid RDF/XML). +func elemOrAttr(qname string) *xpath.Expr { + return mustCompile(fmt.Sprintf("//%s | //rdf:Description/@%s", qname, qname)) +} + +// Pre-compiled query handles. Compile-once-at-init amortizes XPath +// parsing across every sidecar in an indexer run. +var ( + // xmpTitleChain: dc:title (Alt/x-default) → first li → bare text → photoshop:Headline. + xmpTitleChain = chainXPath{ + mustCompile("//dc:title/rdf:Alt/rdf:li[@xml:lang='x-default']"), + mustCompile("(//dc:title/rdf:Alt/rdf:li)[1]"), + mustCompile("//dc:title[not(rdf:Alt)]"), + mustCompile("//photoshop:Headline"), + } + + // xmpDescriptionChain: dc:description → tiff:ImageDescription, each with + // the lang-alt fallback. tiff:ImageDescription is the deprecated TIFF-schema + // equivalent still emitted by some writers. + xmpDescriptionChain = chainXPath{ + mustCompile("//dc:description/rdf:Alt/rdf:li[@xml:lang='x-default']"), + mustCompile("(//dc:description/rdf:Alt/rdf:li)[1]"), + mustCompile("//dc:description[not(rdf:Alt)]"), + mustCompile("//tiff:ImageDescription/rdf:Alt/rdf:li[@xml:lang='x-default']"), + mustCompile("(//tiff:ImageDescription/rdf:Alt/rdf:li)[1]"), + mustCompile("//tiff:ImageDescription[not(rdf:Alt)]"), + } + + // xmpRightsChain: dc:rights Alt-language → tiff:Copyright Alt-language → + // xmpRights:WebStatement. tiff:Copyright is the deprecated TIFF-schema + // copyright text; WebStatement is a URL, not free text, but the embedded + // path uses the same fallback. + xmpRightsChain = chainXPath{ + mustCompile("//dc:rights/rdf:Alt/rdf:li[@xml:lang='x-default']"), + mustCompile("(//dc:rights/rdf:Alt/rdf:li)[1]"), + mustCompile("//dc:rights[not(rdf:Alt)]"), + mustCompile("//tiff:Copyright/rdf:Alt/rdf:li[@xml:lang='x-default']"), + mustCompile("(//tiff:Copyright/rdf:Alt/rdf:li)[1]"), + mustCompile("//tiff:Copyright[not(rdf:Alt)]"), + mustCompile("//xmpRights:WebStatement"), + } + + // xmpLicenseChain: xmpRights:UsageTerms (lang-alt). + xmpLicenseChain = chainXPath{ + mustCompile("//xmpRights:UsageTerms/rdf:Alt/rdf:li[@xml:lang='x-default']"), + mustCompile("(//xmpRights:UsageTerms/rdf:Alt/rdf:li)[1]"), + mustCompile("//xmpRights:UsageTerms[not(rdf:Alt)]"), + } + + // xmpSoftwareChain: xmp:CreatorTool → tiff:Software (deprecated TIFF-schema + // equivalent still emitted by some writers). + xmpSoftwareChain = chainXPath{ + elemOrAttr("xmp:CreatorTool"), + elemOrAttr("tiff:Software"), + } + + // xmpDocumentIDChain: xmpMM:OriginalDocumentID (asset-stable) → + // xmpMM:DocumentID (per-derivative) → dc:identifier (legacy). + xmpDocumentIDChain = chainXPath{ + elemOrAttr("xmpMM:OriginalDocumentID"), + elemOrAttr("xmpMM:DocumentID"), + elemOrAttr("dc:identifier"), + } + + // xmpInstanceIDChain: xmpMM:InstanceID. + xmpInstanceIDChain = chainXPath{elemOrAttr("xmpMM:InstanceID")} + + // xmpArtistChain: first dc:creator/rdf:Seq entry. + xmpArtistChain = chainXPath{mustCompile("(//dc:creator/rdf:Seq/rdf:li)[1]")} + + // xmpCameraMakeChain: tiff:Make. + xmpCameraMakeChain = chainXPath{elemOrAttr("tiff:Make")} + + // xmpCameraModelChain: tiff:Model. No XMP fallback exists; aux + // and tiff UniqueCameraModel are not defined XMP properties. + xmpCameraModelChain = chainXPath{elemOrAttr("tiff:Model")} + + // xmpLensModelChain: exifEX:LensModel (modern) → aux:Lens → + // aux:LensID. aux is retained because Lightroom and Camera Raw + // still emit it. + xmpLensModelChain = chainXPath{ + elemOrAttr("exifEX:LensModel"), + elemOrAttr("aux:Lens"), + elemOrAttr("aux:LensID"), + } + + // xmpTakenAtChain: photoshop:DateCreated → exif:DateTimeOriginal → + // xmp:CreateDate. SubSecTimeOriginal is joined in TakenAt() when + // the parsed datetime carries no fractional component. + xmpTakenAtChain = chainXPath{ + elemOrAttr("photoshop:DateCreated"), + elemOrAttr("exif:DateTimeOriginal"), + elemOrAttr("xmp:CreateDate"), + } + + // xmpSubSecTimeChain: exif:SubSecTimeOriginal — fractional seconds + // of the capture time as a digit string. + xmpSubSecTimeChain = chainXPath{elemOrAttr("exif:SubSecTimeOriginal")} + + // xmpTimeOffsetChain: EXIF 2.31 cascade. + xmpTimeOffsetChain = chainXPath{ + elemOrAttr("exif:OffsetTimeOriginal"), + elemOrAttr("exif:OffsetTime"), + elemOrAttr("exif:OffsetTimeDigitized"), + } + + // xmpCreatedAtChain: xmp:CreateDate → xmpDM:CreationDate (video). + xmpCreatedAtChain = chainXPath{ + elemOrAttr("xmp:CreateDate"), + elemOrAttr("xmpDM:CreationDate"), + } + + // xmpCameraSerialChain: exifEX:BodySerialNumber (EXIF 0xA431, the property + // ExifTool and Adobe emit) → aux:SerialNumber (legacy Adobe). + xmpCameraSerialChain = chainXPath{ + elemOrAttr("exifEX:BodySerialNumber"), + elemOrAttr("aux:SerialNumber"), + } + + // xmpLensMakeChain: exifEX:LensMake. + xmpLensMakeChain = chainXPath{elemOrAttr("exifEX:LensMake")} + + // xmpCameraOwnerChain: aux:OwnerName. + xmpCameraOwnerChain = chainXPath{elemOrAttr("aux:OwnerName")} + + // xmpProjectionChain: GPano:ProjectionType. + xmpProjectionChain = chainXPath{elemOrAttr("GPano:ProjectionType")} + + // xmpColorProfileChain: photoshop:ICCProfile. + xmpColorProfileChain = chainXPath{elemOrAttr("photoshop:ICCProfile")} + + // xmpApertureChain: exif:ApertureValue (APEX). + xmpApertureChain = chainXPath{elemOrAttr("exif:ApertureValue")} + + // xmpFNumberChain: exif:FNumber. + xmpFNumberChain = chainXPath{elemOrAttr("exif:FNumber")} + + // xmpFocalLengthChain: exif:FocalLength → exif:FocalLengthIn35mmFilm. + xmpFocalLengthChain = chainXPath{ + elemOrAttr("exif:FocalLength"), + elemOrAttr("exif:FocalLengthIn35mmFilm"), + } + + // xmpIsoChain: exifEX:PhotographicSensitivity (modern) → + // exif:ISOSpeedRatings/rdf:Seq[1] (deprecated but widely emitted). + xmpIsoChain = chainXPath{ + elemOrAttr("exifEX:PhotographicSensitivity"), + mustCompile("(//exif:ISOSpeedRatings/rdf:Seq/rdf:li)[1]"), + mustCompile("//rdf:Description/@exif:ISOSpeedRatings"), + } + + // xmpExposureTimeChain: exif:ExposureTime as rational seconds. + xmpExposureTimeChain = chainXPath{elemOrAttr("exif:ExposureTime")} + + // xmpShutterSpeedChain: exif:ShutterSpeedValue (APEX-encoded); + // converted to seconds in Exposure() via t = 2^(-Tv). + xmpShutterSpeedChain = chainXPath{elemOrAttr("exif:ShutterSpeedValue")} + + // xmpFlashFiredChain: only the Fired sub-field; other Flash + // sub-fields are intentionally ignored because data.Flash is bool. + xmpFlashFiredChain = chainXPath{ + mustCompile("//exif:Flash/exif:Fired"), + mustCompile("//exif:Flash/@exif:Fired"), + mustCompile("//exif:Flash/rdf:Description/@exif:Fired"), + } + + // xmpNotesChain: exif:UserComment (lang-alt). + xmpNotesChain = chainXPath{ + mustCompile("//exif:UserComment/rdf:Alt/rdf:li[@xml:lang='x-default']"), + mustCompile("(//exif:UserComment/rdf:Alt/rdf:li)[1]"), + mustCompile("//exif:UserComment[not(rdf:Alt)]"), + } + + // xmpSubjectBag / xmpSubjectSeq: dc:subject containers. dc:subject is + // Adobe's "Keywords" panel, but PhotoPrism maps it to the descriptive + // Details.Subject field, not the keyword list. Adobe, Darktable and + // digiKam emit Bag; Apple Photos and the previous reader emit Seq. + xmpSubjectBag = mustCompile("//dc:subject/rdf:Bag/rdf:li") + xmpSubjectSeq = mustCompile("//dc:subject/rdf:Seq/rdf:li") + + // xmpPersonBag / xmpPersonSeq: Iptc4xmpExt:PersonInImage containers + // (names of people depicted) — a Subject cascade fallback. + xmpPersonBag = mustCompile("//Iptc4xmpExt:PersonInImage/rdf:Bag/rdf:li") + xmpPersonSeq = mustCompile("//Iptc4xmpExt:PersonInImage/rdf:Seq/rdf:li") + + // xmpHierarchicalBag / xmpHierarchicalSeq: lr:hierarchicalSubject + // containers (Lightroom "Nature|Animals" paths) — a Subject fallback. + xmpHierarchicalBag = mustCompile("//lr:hierarchicalSubject/rdf:Bag/rdf:li") + xmpHierarchicalSeq = mustCompile("//lr:hierarchicalSubject/rdf:Seq/rdf:li") + + // xmpFavoriteAttr: F-Stop favorite attribute on rdf:Description. + xmpFavoriteAttr = mustCompile("//rdf:Description/@fstop:favorite") + + // xmpGPSLatitudeChain reads exif:GPSLatitude; sign composition + // with GPSLatitudeRef happens in Lat(). + xmpGPSLatitudeChain = chainXPath{elemOrAttr("exif:GPSLatitude")} + xmpGPSLatitudeRefChain = chainXPath{elemOrAttr("exif:GPSLatitudeRef")} + + // xmpGPSLongitudeChain: analogous to latitude. + xmpGPSLongitudeChain = chainXPath{elemOrAttr("exif:GPSLongitude")} + xmpGPSLongitudeRefChain = chainXPath{elemOrAttr("exif:GPSLongitudeRef")} + + // xmpGPSAltitudeChain: rationals like "3450/100" parsed in Altitude(). + xmpGPSAltitudeChain = chainXPath{elemOrAttr("exif:GPSAltitude")} + xmpGPSAltitudeRefChain = chainXPath{elemOrAttr("exif:GPSAltitudeRef")} + + // xmpGPSTimeStampChain: combined ISO 8601 datetime (canonical XMP). + xmpGPSTimeStampChain = chainXPath{elemOrAttr("exif:GPSTimeStamp")} + + // xmpGPSDateStampChain: legacy split-form fallback for TakenGps. + xmpGPSDateStampChain = chainXPath{elemOrAttr("exif:GPSDateStamp")} +) + +// XmpDocument represents a parsed XMP sidecar; populate via Load. +type XmpDocument struct { + doc *xmlquery.Node +} + +// Load reads an XMP sidecar and enforces the size and depth security +// limits. XXE/DTD attacks are mitigated by encoding/xml defaults +// (xmp_security_test.go guards). io.LimitReader caps Parse defensively +// in case the file grows between Stat and Read. +func (doc *XmpDocument) Load(filename string) error { + info, err := os.Stat(filename) if err != nil { return err } + if info.Size() > xmpMaxFileSize { + return fmt.Errorf("%w: %s (%d bytes)", ErrXmpFileTooLarge, clean.Log(filename), info.Size()) + } - return xml.Unmarshal(data, doc) + f, err := os.Open(filename) //nolint:gosec // sidecar reading is the documented purpose + if err != nil { + return err + } + defer f.Close() + + parsed, err := xmlquery.Parse(io.LimitReader(f, xmpMaxFileSize)) + if err != nil { + return fmt.Errorf("xmp: %s: %w", clean.Log(filename), err) + } + + if d := maxDepth(parsed, 0); d > xmpMaxDepth { + return fmt.Errorf("%w: %s (got %d)", ErrXmpTooDeep, clean.Log(filename), d) + } + + doc.doc = parsed + return nil +} + +// maxDepth returns the deepest element-nesting level reachable from n. +// Non-element nodes (text, comment, attribute) do not inflate the count. +func maxDepth(n *xmlquery.Node, current int) int { + if n == nil { + return current + } + deepest := current + for c := n.FirstChild; c != nil; c = c.NextSibling { + if c.Type != xmlquery.ElementNode { + continue + } + if d := maxDepth(c, current+1); d > deepest { + deepest = d + } + } + return deepest } // Title returns the XMP document title. +// Priority: dc:title (Alt/x-default → first rdf:Alt entry → bare text) → photoshop:Headline. func (doc *XmpDocument) Title() string { - t := doc.RDF.Description.Title.Alt.Li.Text - t2 := doc.RDF.Description.Title.Text - if t != "" { - return SanitizeTitle(t) - } else if t2 != "" { - return SanitizeTitle(t2) - } - return "" + return SanitizeTitle(xmpTitleChain.firstNonEmpty(doc.doc)) } -// Artist returns the XMP document artist. -func (doc *XmpDocument) Artist() string { - return SanitizeString(doc.RDF.Description.Creator.Seq.Li) -} - -// Description returns the XMP document description. +// Description returns the caption / image description. +// Priority: dc:description (Alt/x-default → first rdf:Alt entry → bare text) → tiff:ImageDescription. func (doc *XmpDocument) Description() string { - d := doc.RDF.Description.Description.Alt.Li.Text - d2 := doc.RDF.Description.Description.Text - if d != "" { - return SanitizeCaption(d) - } else if d2 != "" { - return SanitizeTitle(d2) + return SanitizeCaption(xmpDescriptionChain.firstNonEmpty(doc.doc)) +} + +// Copyright returns the rights statement. +// Priority: dc:rights (Alt/x-default → first rdf:Alt entry → bare text) → tiff:Copyright → xmpRights:WebStatement. +// WebStatement is a URL approximation of the rights text but matches the embedded path's behavior. +func (doc *XmpDocument) Copyright() string { + return SanitizeString(xmpRightsChain.firstNonEmpty(doc.doc)) +} + +// Artist returns the first creator name. +// Priority: first entry of dc:creator/rdf:Seq. +func (doc *XmpDocument) Artist() string { + return SanitizeString(xmpArtistChain.firstNonEmpty(doc.doc)) +} + +// CameraMake returns the camera manufacturer. +// Priority: tiff:Make (single-link, namespace-bound). +func (doc *XmpDocument) CameraMake() string { + return SanitizeString(xmpCameraMakeChain.firstNonEmpty(doc.doc)) +} + +// CameraModel returns the camera model. +// Priority: tiff:Model (single-link; UniqueCameraModel is a DNG TIFF tag, +// not an XMP property). +func (doc *XmpDocument) CameraModel() string { + return SanitizeString(xmpCameraModelChain.firstNonEmpty(doc.doc)) +} + +// LensModel returns the lens model. +// Priority: exifEX:LensModel (modern EXIF 2.3) → aux:Lens → aux:LensID (legacy Adobe). +func (doc *XmpDocument) LensModel() string { + return SanitizeString(xmpLensModelChain.firstNonEmpty(doc.doc)) +} + +// TakenAt parses the capture timestamp. +// Priority: photoshop:DateCreated → exif:DateTimeOriginal → xmp:CreateDate. +// Composition: exif:SubSecTimeOriginal is joined when the primary date +// string lacks fractional seconds (never overrides an existing fraction). +// Diverges from the embedded path (DateTimeOriginal-first) because Adobe +// sidecars treat photoshop:DateCreated as authoritative; SrcXmp > SrcMeta +// at the entity layer resolves any cross-path disagreement. +func (doc *XmpDocument) TakenAt(timeZone string) time.Time { + s := SanitizeString(xmpTakenAtChain.firstNonEmpty(doc.doc)) + if s == "" { + return time.Time{} + } + t := txt.ParseTime(s, timeZone) + if t.IsZero() || t.Nanosecond() != 0 { + return t + } + if subSec := SanitizeString(xmpSubSecTimeChain.firstNonEmpty(doc.doc)); subSec != "" { + if ns := parseSubSec(subSec); ns > 0 { + t = t.Add(time.Duration(ns) * time.Nanosecond) + } + } + return t +} + +// TakenNs returns the nanosecond fraction of the capture timestamp. +// Priority: exif:SubSecTimeOriginal (single-link). Independent of TakenAt's +// join — callers that want only the sub-second component consume this. +func (doc *XmpDocument) TakenNs() int { + subSec := SanitizeString(xmpSubSecTimeChain.firstNonEmpty(doc.doc)) + if subSec == "" { + return 0 + } + return parseSubSec(subSec) +} + +// CreatedAt parses the file-creation timestamp (distinct from TakenAt: +// TakenAt = capture time, CreatedAt = first write of the digital file). +// Priority: xmp:CreateDate → xmpDM:CreationDate (Dynamic Media fallback). +func (doc *XmpDocument) CreatedAt(timeZone string) time.Time { + s := SanitizeString(xmpCreatedAtChain.firstNonEmpty(doc.doc)) + if s == "" { + return time.Time{} + } + return txt.ParseTime(s, timeZone) +} + +// TimeOffset returns the timezone offset string ("+02:00"). +// Priority: exif:OffsetTimeOriginal → exif:OffsetTime → exif:OffsetTimeDigitized (EXIF 2.31 cascade). +func (doc *XmpDocument) TimeOffset() string { + return SanitizeString(xmpTimeOffsetChain.firstNonEmpty(doc.doc)) +} + +// CameraSerial returns the camera body serial number. +// Priority: exifEX:BodySerialNumber (EXIF 0xA431) → +// aux:SerialNumber (legacy Adobe, still emitted by Lightroom). +func (doc *XmpDocument) CameraSerial() string { + return SanitizeString(xmpCameraSerialChain.firstNonEmpty(doc.doc)) +} + +// LensMake returns the lens manufacturer. +// Priority: exifEX:LensMake (single-link; aux:LensMake is not defined). +func (doc *XmpDocument) LensMake() string { + return SanitizeString(xmpLensMakeChain.firstNonEmpty(doc.doc)) +} + +// CameraOwner returns the camera-owner name. +// Priority: aux:OwnerName (single-link). +func (doc *XmpDocument) CameraOwner() string { + return SanitizeString(xmpCameraOwnerChain.firstNonEmpty(doc.doc)) +} + +// Projection returns the panoramic projection type. +// Priority: GPano:ProjectionType (single-link). Google Photo Sphere +// defines only "equirectangular"; other values pass through unchanged. +func (doc *XmpDocument) Projection() string { + return SanitizeString(xmpProjectionChain.firstNonEmpty(doc.doc)) +} + +// ColorProfile returns the embedded ICC profile description. +// Priority: photoshop:ICCProfile (single-link). +func (doc *XmpDocument) ColorProfile() string { + return SanitizeString(xmpColorProfileChain.firstNonEmpty(doc.doc)) +} + +// Aperture returns the APEX-encoded aperture value. +// Priority: exif:ApertureValue (single-link, parsed as rational "180/100" → 1.8). +func (doc *XmpDocument) Aperture() float32 { + return float32(rationalAccessor(xmpApertureChain, doc.doc)) +} + +// FNumber returns the f-number (focal length / entrance-pupil diameter, e.g. 1.8 for f/1.8). +// Priority: exif:FNumber (single-link, parsed as rational). +func (doc *XmpDocument) FNumber() float32 { + return float32(rationalAccessor(xmpFNumberChain, doc.doc)) +} + +// FocalLength returns the focal length in millimeters (rounded; the +// data field is int and sub-mm precision is discarded). +// Priority: exif:FocalLength (native) → exif:FocalLengthIn35mmFilm. +func (doc *XmpDocument) FocalLength() int { + return int(math.Round(rationalAccessor(xmpFocalLengthChain, doc.doc))) +} + +// Iso returns the ISO sensitivity. +// Priority: exifEX:PhotographicSensitivity (EXIF 2.3) → first +// exif:ISOSpeedRatings/rdf:Seq entry (deprecated but widely emitted). +func (doc *XmpDocument) Iso() int { + val := xmpIsoChain.firstNonEmpty(doc.doc) + if n, err := strconv.Atoi(val); err == nil && n > 0 { + return n + } + return 0 +} + +// Exposure returns the exposure time as "1/250", "0.5", "30" etc. +// Priority: exif:ExposureTime (rational seconds) → exif:ShutterSpeedValue +// (APEX-encoded, converted via t = 2^(-Tv)). +func (doc *XmpDocument) Exposure() string { + if val := xmpExposureTimeChain.firstNonEmpty(doc.doc); val != "" { + if secs, ok := parseRational(val); ok && secs > 0 { + return formatExposure(secs) + } + } + if val := xmpShutterSpeedChain.firstNonEmpty(doc.doc); val != "" { + if apex, ok := parseRational(val); ok { + return formatExposure(apexToSeconds(apex)) + } } return "" } -// Copyright returns the XMP document copyright info. -func (doc *XmpDocument) Copyright() string { - return SanitizeString(doc.RDF.Description.Rights.Alt.Li.Text) +// Flash reports whether the flash fired. +// Composition: only exif:Flash/Fired is read; other sub-fields +// (Function, Mode, Return, RedEyeMode) are ignored because data.Flash +// is a single boolean. +func (doc *XmpDocument) Flash() bool { + return txt.Bool(xmpFlashFiredChain.firstNonEmpty(doc.doc)) } -// CameraMake returns the XMP document camera make name. -func (doc *XmpDocument) CameraMake() string { - return SanitizeString(doc.RDF.Description.Make) +// Notes returns the user-comment text. +// Priority: exif:UserComment (lang-alt: x-default → first rdf:Alt entry → bare text). +func (doc *XmpDocument) Notes() string { + return SanitizeString(xmpNotesChain.firstNonEmpty(doc.doc)) } -// CameraModel returns the XMP document camera model name. -func (doc *XmpDocument) CameraModel() string { - return SanitizeString(doc.RDF.Description.Model) -} - -// LensModel returns the XMP document lens model name. -func (doc *XmpDocument) LensModel() string { - return SanitizeString(doc.RDF.Description.LensModel) -} - -// TakenAt returns the XMP document taken date. -func (doc *XmpDocument) TakenAt(timeZone string) time.Time { - taken := time.Time{} // Unknown - - s := SanitizeString(doc.RDF.Description.DateCreated) - - if s == "" { - return taken +// joinBagOrSeq joins an rdf:Bag container's entries (Adobe/Darktable/digiKam) +// or, when no Bag is present, the rdf:Seq entries (Apple, older writers) with +// ", ". Bag wins when both are present. +func (doc *XmpDocument) joinBagOrSeq(bag, seq *xpath.Expr) string { + if v := queryAll(doc.doc, bag); len(v) > 0 { + return strings.Join(v, ", ") } + return strings.Join(queryAll(doc.doc, seq), ", ") +} - if dateTime := txt.ParseTime(s, timeZone); !dateTime.IsZero() { - return dateTime +// Subject returns descriptive subject text for the Details.Subject field, +// matching the ExifTool Subject cascade so the XMP and embedded/ExifTool JSON +// paths fill meta.Data.Subject identically. Priority: dc:subject (Adobe's +// "Keywords" panel, present in virtually all tagged files) → +// Iptc4xmpExt:PersonInImage → lr:hierarchicalSubject. The first non-empty +// container wins, joined with ", "; entries keep their spaces. +// +// The PersonInImage and hierarchicalSubject fallbacks are interim sources for +// the free-text Subject field; advanced parsing will route them to dedicated +// meta.Data.Subjects (people) and meta.Data.Labels containers. +func (doc *XmpDocument) Subject() string { + if v := doc.joinBagOrSeq(xmpSubjectBag, xmpSubjectSeq); v != "" { + return v } - - return taken + if v := doc.joinBagOrSeq(xmpPersonBag, xmpPersonSeq); v != "" { + return v + } + return doc.joinBagOrSeq(xmpHierarchicalBag, xmpHierarchicalSeq) } -// Keywords returns the XMP document keywords. -func (doc *XmpDocument) Keywords() string { - s := doc.RDF.Description.Subject.Seq.Li - - return strings.Join(s, ", ") -} - -// Favorite returns a favorite status in the XMP document. +// Favorite reports the F-Stop custom-namespace favorite flag. +// Priority: rdf:Description/@fstop:favorite (single-link, "1" → true). func (doc *XmpDocument) Favorite() bool { - fstop := doc.RDF.Description.FStopFavorite - return fstop == "1" + if doc.doc == nil { + return false + } + if n := xmlquery.QuerySelector(doc.doc, xmpFavoriteAttr); n != nil { + return strings.TrimSpace(n.InnerText()) == "1" + } + return false +} + +// License returns the XMP license statement. +// Priority: xmpRights:UsageTerms (lang-alt: x-default → first rdf:Alt entry → bare text). +func (doc *XmpDocument) License() string { + return SanitizeString(xmpLicenseChain.firstNonEmpty(doc.doc)) +} + +// Software returns the application that wrote the file. +// Priority: xmp:CreatorTool → tiff:Software. +func (doc *XmpDocument) Software() string { + return SanitizeString(xmpSoftwareChain.firstNonEmpty(doc.doc)) +} + +// DocumentID returns the XMP document identifier (asset-stable across +// derivatives; "xmp.did:" / "xmp.iid:" prefixes are preserved and +// stripped downstream when matching across embedded/sidecar paths). +// Priority: xmpMM:OriginalDocumentID → xmpMM:DocumentID → dc:identifier. +func (doc *XmpDocument) DocumentID() string { + return SanitizeString(xmpDocumentIDChain.firstNonEmpty(doc.doc)) +} + +// InstanceID returns the XMP instance identifier (per-derivative). +// Priority: xmpMM:InstanceID (single-link; each saved derivative gets a fresh ID). +func (doc *XmpDocument) InstanceID() string { + return SanitizeString(xmpInstanceIDChain.firstNonEmpty(doc.doc)) +} + +// Lat returns the GPS latitude as a decimal float. +// Priority: exif:GPSLatitude (single-link). +// Composition: cardinal in the value (Adobe form "52,30.4567N") wins; +// otherwise exif:GPSLatitudeRef supplies the sign. See gpsCoord. +func (doc *XmpDocument) Lat() float64 { + return gpsCoord(xmpGPSLatitudeChain, xmpGPSLatitudeRefChain, doc.doc) +} + +// Lng returns the GPS longitude as a decimal float. +// Priority: exif:GPSLongitude (single-link); composition mirrors Lat +// with E/W cardinal handling. +func (doc *XmpDocument) Lng() float64 { + return gpsCoord(xmpGPSLongitudeChain, xmpGPSLongitudeRefChain, doc.doc) +} + +// gpsCoord composes a single GPS coordinate, applying the cardinal +// from refChain when the value lacks an N/S/E/W suffix. +func gpsCoord(valueChain, refChain chainXPath, root *xmlquery.Node) float64 { + val := valueChain.firstNonEmpty(root) + if val == "" { + return 0 + } + decimal := GpsToDecimal(val) + if decimal == 0 || GpsRefRegexp.MatchString(val) { + return decimal + } + if isNegativeRef(refChain.firstNonEmpty(root)) { + return -decimal + } + return decimal +} + +// Altitude returns the GPS altitude in meters. +// Priority: exif:GPSAltitude (parsed as rational, e.g. "3450/100" → 34.5). +// Composition: exif:GPSAltitudeRef = "1" inverts the sign. +func (doc *XmpDocument) Altitude() float64 { + val := xmpGPSAltitudeChain.firstNonEmpty(doc.doc) + if val == "" { + return 0 + } + alt, ok := parseRational(val) + if !ok { + return 0 + } + if xmpGPSAltitudeRefChain.firstNonEmpty(doc.doc) == "1" { + return -alt + } + return alt +} + +// TakenGps returns the GPS timestamp as a UTC time.Time. +// Priority: exif:GPSTimeStamp (canonical combined ISO 8601 datetime). +// Composition: legacy writers split date/time across exif:GPSDateStamp +// and exif:GPSTimeStamp; the two are joined when the canonical fails. +func (doc *XmpDocument) TakenGps() time.Time { + ts := xmpGPSTimeStampChain.firstNonEmpty(doc.doc) + if ts == "" { + return time.Time{} + } + if t := txt.ParseTime(ts, ""); !t.IsZero() { + return t + } + ds := xmpGPSDateStampChain.firstNonEmpty(doc.doc) + if ds == "" { + return time.Time{} + } + return txt.ParseTime(ds+" "+ts, "") +} + +// rationalAccessor reads a rational-valued chain and returns the +// decimal (0 when absent or unparseable). Shared by Aperture/FNumber/FocalLength. +func rationalAccessor(chain chainXPath, root *xmlquery.Node) float64 { + val := chain.firstNonEmpty(root) + if val == "" { + return 0 + } + if v, ok := parseRational(val); ok { + return v + } + return 0 +} + +// isNegativeRef returns true when ref starts with S or W (case-insensitive), +// matching the GPSLatitudeRef / GPSLongitudeRef sign convention. +func isNegativeRef(ref string) bool { + if ref == "" { + return false + } + r := ref[0] + return r == 'S' || r == 's' || r == 'W' || r == 'w' +} + +// parseSubSec converts an EXIF SubSecTime string ("899614") to +// nanoseconds (899,614,000). Inputs longer than 9 digits or +// non-numeric values yield 0. +func parseSubSec(s string) int { + s = strings.TrimSpace(s) + if s == "" || len(s) > 9 { + return 0 + } + n, err := strconv.Atoi(s) + if err != nil || n < 0 { + return 0 + } + for i := len(s); i < 9; i++ { + n *= 10 + } + return n +} + +// formatExposure renders a duration as "1/N" for sub-second values +// and as a decimal for one-second-or-longer durations. +func formatExposure(secs float64) string { + if secs <= 0 { + return "" + } + if secs >= 1 { + return strconv.FormatFloat(secs, 'f', -1, 64) + } + return fmt.Sprintf("1/%d", int(math.Round(1/secs))) +} + +// apexToSeconds converts an APEX shutter-speed value (Tv) to seconds +// via t = 2^(-Tv). Input is clamped to [-30, 30] to avoid ±Inf on +// pathological values; the range covers any realistic camera output. +func apexToSeconds(apex float64) float64 { + if apex < -30 { + apex = -30 + } else if apex > 30 { + apex = 30 + } + return math.Pow(2, -apex) +} + +// parseRational parses an XMP rational ("N/D") or plain float. +// The bool distinguishes "parsed as zero" from "could not parse". +func parseRational(s string) (float64, bool) { + s = strings.TrimSpace(s) + if s == "" { + return 0, false + } + if i := strings.IndexByte(s, '/'); i >= 0 { + num, err1 := strconv.ParseFloat(strings.TrimSpace(s[:i]), 64) + den, err2 := strconv.ParseFloat(strings.TrimSpace(s[i+1:]), 64) + if err1 != nil || err2 != nil || den == 0 { + return 0, false + } + return num / den, true + } + if f, err := strconv.ParseFloat(s, 64); err == nil { + return f, true + } + return 0, false } diff --git a/internal/meta/xmp_document_test.go b/internal/meta/xmp_document_test.go new file mode 100644 index 000000000..98c733e97 --- /dev/null +++ b/internal/meta/xmp_document_test.go @@ -0,0 +1,903 @@ +package meta + +import ( + "os" + "path/filepath" + "strings" + "testing" + + "github.com/antchfx/xmlquery" + + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/pkg/fs" +) + +// parseXMPString parses an in-memory XMP string and returns the root +// xmlquery node. Test helper that keeps focused unit tests free of +// temp-file plumbing. +func parseXMPString(t *testing.T, xmp string) *xmlquery.Node { + t.Helper() + n, err := xmlquery.Parse(strings.NewReader(xmp)) + if err != nil { + t.Fatalf("parseXMPString: %v", err) + } + return n +} + +// loadXmp loads an XMP fixture from path and returns the populated +// XmpDocument; t.Fatal on error. Used by accessor tests that exercise +// the full Load → parse → DOM pipeline. +func loadXmp(t *testing.T, path string) *XmpDocument { + t.Helper() + var doc XmpDocument + if err := doc.Load(path); err != nil { + t.Fatalf("load %s: %v", path, err) + } + return &doc +} + +// loadXmpString writes body to a temp file in t.TempDir(), loads it +// through Load, and returns the populated XmpDocument. Avoids +// inline-fixture boilerplate in tests that synthesize XMP on the fly. +func loadXmpString(t *testing.T, body string) *XmpDocument { + t.Helper() + tmp := filepath.Join(t.TempDir(), "synthetic.xmp") + if err := os.WriteFile(tmp, []byte(body), fs.ModeFile); err != nil { + t.Fatalf("write temp xmp: %v", err) + } + return loadXmp(t, tmp) +} + +func TestMaxDepth(t *testing.T) { + t.Run("Nil", func(t *testing.T) { + assert.Equal(t, 0, maxDepth(nil, 0)) + }) + t.Run("FlatRoot", func(t *testing.T) { + n := parseXMPString(t, `<?xml version="1.0"?><a/>`) + // xmlquery wraps the root in a document node; element <a/> is + // at depth 1 from the document. + assert.Equal(t, 1, maxDepth(n, 0)) + }) + t.Run("NestedFiveDeep", func(t *testing.T) { + n := parseXMPString(t, `<?xml version="1.0"?><a><b><c><d><e/></d></c></b></a>`) + assert.Equal(t, 5, maxDepth(n, 0)) + }) + t.Run("MixedSiblingsTakesDeepestBranch", func(t *testing.T) { + // Left branch: depth 2; right branch: depth 4. Reader must + // return the deeper of the two, not the first encountered. + n := parseXMPString(t, `<?xml version="1.0"?><a><b/><c><d><e><f/></e></d></c></a>`) + assert.Equal(t, 5, maxDepth(n, 0)) + }) + t.Run("IgnoresTextAndCommentNodes", func(t *testing.T) { + // Comments and text must not inflate the count. + n := parseXMPString(t, `<?xml version="1.0"?><a>some text<!-- comment --><b/></a>`) + assert.Equal(t, 2, maxDepth(n, 0)) + }) +} + +func TestMustCompile(t *testing.T) { + t.Run("ValidExpression", func(t *testing.T) { + expr := mustCompile("//dc:title") + assert.NotNil(t, expr) + }) + t.Run("PanicsOnGarbage", func(t *testing.T) { + assert.Panics(t, func() { + mustCompile("not [[ valid") + }) + }) + t.Run("PanicsOnUnknownPrefix", func(t *testing.T) { + assert.Panics(t, func() { + mustCompile("//bogus:Element") + }) + }) +} + +func TestChainXPath_FirstNonEmpty(t *testing.T) { + doc := parseXMPString(t, ` +<x:xmpmeta xmlns:x="adobe:ns:meta/"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:photoshop="http://ns.adobe.com/photoshop/1.0/"> + <dc:title> + <rdf:Alt> + <rdf:li xml:lang="x-default">From dc:title</rdf:li> + </rdf:Alt> + </dc:title> + <photoshop:Headline>From Headline</photoshop:Headline> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta>`) + + t.Run("FirstLinkWins", func(t *testing.T) { + // First link in chain matches and returns its value. + c := chainXPath{ + mustCompile("//dc:title/rdf:Alt/rdf:li[@xml:lang='x-default']"), + mustCompile("//photoshop:Headline"), + } + assert.Equal(t, "From dc:title", c.firstNonEmpty(doc)) + }) + t.Run("FallsThroughOnNoMatch", func(t *testing.T) { + // First link does not match, second link wins. + c := chainXPath{ + mustCompile("//dc:nonexistent"), + mustCompile("//photoshop:Headline"), + } + assert.Equal(t, "From Headline", c.firstNonEmpty(doc)) + }) + t.Run("ReturnsEmptyWhenNoLinkMatches", func(t *testing.T) { + c := chainXPath{ + mustCompile("//dc:nonexistent"), + mustCompile("//tiff:Make"), + } + assert.Equal(t, "", c.firstNonEmpty(doc)) + }) + t.Run("HandlesNilRoot", func(t *testing.T) { + c := chainXPath{mustCompile("//dc:title")} + assert.Equal(t, "", c.firstNonEmpty(nil)) + }) + t.Run("HandlesEmptyChain", func(t *testing.T) { + c := chainXPath{} + assert.Equal(t, "", c.firstNonEmpty(doc)) + }) +} + +func TestQueryAll(t *testing.T) { + doc := parseXMPString(t, ` +<x:xmpmeta xmlns:x="adobe:ns:meta/"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:dc="http://purl.org/dc/elements/1.1/"> + <dc:subject> + <rdf:Bag> + <rdf:li>One</rdf:li> + <rdf:li>Two</rdf:li> + <rdf:li> </rdf:li> + <rdf:li>Three</rdf:li> + </rdf:Bag> + </dc:subject> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta>`) + + t.Run("ReturnsAllMatches", func(t *testing.T) { + got := queryAll(doc, mustCompile("//dc:subject/rdf:Bag/rdf:li")) + assert.Equal(t, []string{"One", "Two", "Three"}, got) + }) + t.Run("DropsEmptyTrimmedMatches", func(t *testing.T) { + // The third <rdf:li> contains only whitespace and is dropped. + got := queryAll(doc, mustCompile("//dc:subject/rdf:Bag/rdf:li")) + assert.NotContains(t, got, "") + assert.Len(t, got, 3) + }) + t.Run("ReturnsNilForNilRoot", func(t *testing.T) { + assert.Nil(t, queryAll(nil, mustCompile("//dc:subject"))) + }) + t.Run("ReturnsNilForNilExpression", func(t *testing.T) { + assert.Nil(t, queryAll(doc, nil)) + }) + t.Run("EmptyMatchSetReturnsEmptySlice", func(t *testing.T) { + got := queryAll(doc, mustCompile("//dc:nonexistent")) + assert.Empty(t, got) + }) +} + +func TestXmpDocument_Load(t *testing.T) { + t.Run("MissingFile", func(t *testing.T) { + var doc XmpDocument + err := doc.Load("testdata/does-not-exist.xmp") + assert.Error(t, err) + }) + t.Run("MalformedXML", func(t *testing.T) { + // Write a malformed XMP to a temp file and assert Load surfaces + // the parse error rather than silently succeeding. + tmp := filepath.Join(t.TempDir(), "broken.xmp") + if err := writeFile(t, tmp, "<?xml version=\"1.0\"?><a><b></a>"); err != nil { + t.Fatal(err) + } + var doc XmpDocument + err := doc.Load(tmp) + assert.Error(t, err) + }) + t.Run("WellFormedSidecar", func(t *testing.T) { + doc := loadXmp(t, "testdata/photoshop.xmp") + assert.NotNil(t, doc.doc) + }) +} + +// writeFile writes content to path with mode fs.ModeFile. Returns the +// underlying error so tests can assert on it. +func writeFile(t *testing.T, path, content string) error { + t.Helper() + return os.WriteFile(path, []byte(content), fs.ModeFile) +} + +func TestXmpDocument_TitleAltLanguageFallback(t *testing.T) { + t.Run("PrefersXDefault", func(t *testing.T) { + doc := loadXmp(t, "testdata/photoshop.xmp") + assert.Equal(t, "Night Shift / Berlin / 2020", doc.Title()) + }) + t.Run("FallsBackToFirstLiWhenNoXDefault", func(t *testing.T) { + // alt-edge-cases.xmp has dc:title with only de + en (no x-default). + // The chain must take the first li (de = "Sonnenuntergang"). + doc := loadXmp(t, "testdata/xmp/synthetic/alt-edge-cases.xmp") + assert.Equal(t, "Sonnenuntergang", doc.Title()) + }) + t.Run("FallsBackToBareText", func(t *testing.T) { + // apple-test-2.xmp has <dc:title>Botanischer Garten</dc:title> + // without rdf:Alt; the chain falls through to the bare-text branch. + doc := loadXmp(t, "testdata/apple-test-2.xmp") + assert.Equal(t, "Botanischer Garten", doc.Title()) + }) + t.Run("FallsBackToPhotoshopHeadline", func(t *testing.T) { + // Synthetic case: no dc:title, only photoshop:Headline. The + // chain's last link must trigger. + doc := loadXmpString(t, `<?xml version="1.0"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:photoshop="http://ns.adobe.com/photoshop/1.0/"> + <photoshop:Headline>Headline-only Title</photoshop:Headline> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta>`) + assert.Equal(t, "Headline-only Title", doc.Title()) + }) +} + +func TestXmpDocument_SubjectBagAndSeq(t *testing.T) { + t.Run("BagForm", func(t *testing.T) { + // digikam fixture writes dc:subject as <rdf:Bag>, which the old + // reader silently dropped. Subject() must now read it. + doc := loadXmp(t, "testdata/xmp/digikam/aurora.jpg.xmp") + got := doc.Subject() + assert.Contains(t, got, "Nature") + assert.Contains(t, got, "Iceland") + assert.Contains(t, got, "Aurora") + }) + t.Run("SeqForm", func(t *testing.T) { + // Synthetic Seq fixture confirms the legacy form still works. + doc := loadXmp(t, "testdata/xmp/synthetic/subject-seq.xmp") + assert.Equal(t, "Sequenced, Keywords, Should, Also, Parse", doc.Subject()) + }) + t.Run("EmptyForMissingSubject", func(t *testing.T) { + doc := loadXmp(t, "testdata/fstop-favorite.xmp") + assert.Equal(t, "", doc.Subject()) + }) +} + +func TestXmpDocument_Subject(t *testing.T) { + t.Run("ReadsDcSubject", func(t *testing.T) { + // dc:subject is the primary Subject source and present in most tagged + // files. It feeds Details.Subject, not the keyword list. + doc := loadXmp(t, "testdata/xmp/darktable/aurora.jpg.xmp") + assert.Contains(t, doc.Subject(), "Aurora") + }) + t.Run("PersonInImageFallback", func(t *testing.T) { + // No dc:subject → Subject falls back to Iptc4xmpExt:PersonInImage. + doc := loadXmpString(t, `<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" xmlns:Iptc4xmpExt="http://iptc.org/std/Iptc4xmpExt/2008-02-29/"> + <Iptc4xmpExt:PersonInImage> + <rdf:Bag> + <rdf:li>Alice</rdf:li> + <rdf:li>Bob</rdf:li> + </rdf:Bag> + </Iptc4xmpExt:PersonInImage> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta>`) + assert.Equal(t, "Alice, Bob", doc.Subject()) + }) + t.Run("HierarchicalSubjectFallback", func(t *testing.T) { + // No dc:subject, no PersonInImage → lr:hierarchicalSubject. + doc := loadXmpString(t, `<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" xmlns:lr="http://ns.adobe.com/lightroom/1.0/"> + <lr:hierarchicalSubject> + <rdf:Bag> + <rdf:li>Nature|Animals</rdf:li> + <rdf:li>Places</rdf:li> + </rdf:Bag> + </lr:hierarchicalSubject> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta>`) + assert.Equal(t, "Nature|Animals, Places", doc.Subject()) + }) + t.Run("EmptyWhenNoSource", func(t *testing.T) { + doc := loadXmp(t, "testdata/fstop-favorite.xmp") + assert.Equal(t, "", doc.Subject()) + }) +} + +func TestXmpDocument_FavoriteAttribute(t *testing.T) { + t.Run("True", func(t *testing.T) { + doc := loadXmp(t, "testdata/fstop-favorite.xmp") + assert.True(t, doc.Favorite()) + }) + t.Run("FalseWhenAttributeAbsent", func(t *testing.T) { + doc := loadXmp(t, "testdata/photoshop.xmp") + assert.False(t, doc.Favorite()) + }) + t.Run("FalseWhenDocumentNotLoaded", func(t *testing.T) { + var doc XmpDocument + assert.False(t, doc.Favorite()) + }) +} + +func TestXmpDocument_MultiRdfDescription(t *testing.T) { + // multi-rdf-description.xmp splits properties across four sibling + // <rdf:Description> blocks. The XPath reader must walk them all. + doc := loadXmp(t, "testdata/xmp/synthetic/multi-rdf-description.xmp") + assert.Equal(t, "Multi-Description Fixture", doc.Title()) + assert.Equal(t, "PhotoPrism", doc.Artist()) + assert.Equal(t, "SyntheticCam", doc.CameraMake()) + assert.Equal(t, "SC-1 Mark II", doc.CameraModel()) + assert.Equal(t, "00000000-0000-0000-0000-000000000000", doc.DocumentID()) + assert.Equal(t, "xmp.iid:aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", doc.InstanceID()) +} + +func TestXmpDocument_License(t *testing.T) { + t.Run("DigikamFixture", func(t *testing.T) { + // digiKam writes xmpRights:UsageTerms as lang-alt with x-default. + doc := loadXmp(t, "testdata/xmp/digikam/aurora.jpg.xmp") + assert.Equal(t, "CC-BY-SA 4.0", doc.License()) + }) + t.Run("AdobeBridgeFixture", func(t *testing.T) { + doc := loadXmp(t, "testdata/xmp/adobe/bridge-2.xmp") + assert.NotEmpty(t, doc.License()) + }) + t.Run("EmptyWhenAbsent", func(t *testing.T) { + doc := loadXmp(t, "testdata/photoshop.xmp") + assert.Equal(t, "", doc.License()) + }) +} + +func TestXmpDocument_Software(t *testing.T) { + t.Run("SyntheticFixture", func(t *testing.T) { + // software-only.xmp carries only xmp:CreatorTool. + doc := loadXmp(t, "testdata/xmp/synthetic/software-only.xmp") + assert.Equal(t, "PhotoPrism Synthetic Fixture 1.0.0", doc.Software()) + }) + t.Run("FallsBackToTiffSoftware", func(t *testing.T) { + // tiff-fields.xmp carries only tiff:Software (no xmp:CreatorTool). + doc := loadXmp(t, "testdata/xmp/synthetic/tiff-fields.xmp") + assert.Equal(t, "TiffSoftware 1.0", doc.Software()) + }) + t.Run("EmptyWhenAbsent", func(t *testing.T) { + doc := loadXmp(t, "testdata/fstop-favorite.xmp") + assert.Equal(t, "", doc.Software()) + }) +} + +func TestXmpDocument_Description(t *testing.T) { + t.Run("FallsBackToTiffImageDescription", func(t *testing.T) { + // tiff-fields.xmp carries only tiff:ImageDescription (no dc:description). + doc := loadXmp(t, "testdata/xmp/synthetic/tiff-fields.xmp") + assert.Equal(t, "A tiff image description", doc.Description()) + }) + t.Run("EmptyWhenAbsent", func(t *testing.T) { + doc := loadXmp(t, "testdata/xmp/synthetic/software-only.xmp") + assert.Equal(t, "", doc.Description()) + }) +} + +func TestXmpDocument_Copyright(t *testing.T) { + t.Run("FallsBackToTiffCopyright", func(t *testing.T) { + // tiff-fields.xmp carries only tiff:Copyright (no dc:rights). + doc := loadXmp(t, "testdata/xmp/synthetic/tiff-fields.xmp") + assert.Equal(t, "Copyright 2026 Example Org", doc.Copyright()) + }) + t.Run("EmptyWhenAbsent", func(t *testing.T) { + doc := loadXmp(t, "testdata/xmp/synthetic/software-only.xmp") + assert.Equal(t, "", doc.Copyright()) + }) +} + +func TestXmpDocument_DocumentID(t *testing.T) { + t.Run("DigikamPrefersOriginalDocumentID", func(t *testing.T) { + // digiKam writes all three IDs; the chain must pick + // xmpMM:OriginalDocumentID — the asset-stable identifier. + doc := loadXmp(t, "testdata/xmp/digikam/aurora.jpg.xmp") + assert.Equal(t, "254738CA43CD69C01101874D65B006B4", doc.DocumentID()) + }) + t.Run("EmptyWhenAbsent", func(t *testing.T) { + doc := loadXmp(t, "testdata/fstop-favorite.xmp") + assert.Equal(t, "", doc.DocumentID()) + }) +} + +func TestXmpDocument_InstanceID(t *testing.T) { + t.Run("DigikamFixture", func(t *testing.T) { + doc := loadXmp(t, "testdata/xmp/digikam/aurora.jpg.xmp") + assert.Equal(t, "xmp.iid:de0fb44d-bdc8-4cc3-aa50-9aefe4992b34", doc.InstanceID()) + }) + t.Run("EmptyWhenAbsent", func(t *testing.T) { + doc := loadXmp(t, "testdata/fstop-favorite.xmp") + assert.Equal(t, "", doc.InstanceID()) + }) +} + +func TestXmpDocument_GPSCoordinates(t *testing.T) { + t.Run("AdobeTwoComponentForm", func(t *testing.T) { + // bridge-2 carries lat/lng/alt in 2-component form (Adobe XMP). + doc := loadXmp(t, "testdata/xmp/adobe/bridge-2.xmp") + assert.InEpsilon(t, 52.44308166666666, doc.Lat(), 1e-6) + assert.InEpsilon(t, 13.576613333333333, doc.Lng(), 1e-6) + // 1500000/100 = 15000 m above sea level. + assert.InEpsilon(t, 15000.0, doc.Altitude(), 1e-6) + }) + t.Run("SouthernHemisphereInValue", func(t *testing.T) { + // bridge.xmp Lat is "27,20.4263S" — sign comes from cardinal in + // the value string, not GPSLatitudeRef. + doc := loadXmp(t, "testdata/xmp/adobe/bridge.xmp") + assert.Less(t, doc.Lat(), 0.0) + assert.InEpsilon(t, -27.340438333333333, doc.Lat(), 1e-6) + }) + t.Run("DecimalWithSeparateRef", func(t *testing.T) { + // Synthetic case: pure-decimal value with sign supplied by the + // GPSLatitudeRef element. The accessor must apply the sign. + doc := loadXmpString(t, `<?xml version="1.0"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:exif="http://ns.adobe.com/exif/1.0/"> + <exif:GPSLatitude>47.6754</exif:GPSLatitude> + <exif:GPSLatitudeRef>S</exif:GPSLatitudeRef> + <exif:GPSLongitude>122.3127</exif:GPSLongitude> + <exif:GPSLongitudeRef>W</exif:GPSLongitudeRef> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta>`) + assert.Equal(t, -47.6754, doc.Lat()) + assert.Equal(t, -122.3127, doc.Lng()) + }) + t.Run("AltitudeBelowSeaLevel", func(t *testing.T) { + // GPSAltitudeRef="1" inverts the sign. + doc := loadXmpString(t, `<?xml version="1.0"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:exif="http://ns.adobe.com/exif/1.0/"> + <exif:GPSAltitude>10000/100</exif:GPSAltitude> + <exif:GPSAltitudeRef>1</exif:GPSAltitudeRef> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta>`) + assert.Equal(t, -100.0, doc.Altitude()) + }) + t.Run("ZeroWhenAbsent", func(t *testing.T) { + doc := loadXmp(t, "testdata/fstop-favorite.xmp") + assert.Equal(t, 0.0, doc.Lat()) + assert.Equal(t, 0.0, doc.Lng()) + assert.Equal(t, 0.0, doc.Altitude()) + }) +} + +func TestXmpDocument_TakenGps(t *testing.T) { + t.Run("CombinedISO8601Form", func(t *testing.T) { + // Canonical XMP: GPSTimeStamp is the full ISO 8601 datetime. + doc := loadXmp(t, "testdata/xmp/synthetic/gps-time-combined.xmp") + got := doc.TakenGps() + assert.False(t, got.IsZero()) + assert.Equal(t, 2026, got.Year()) + assert.Equal(t, 5, int(got.Month())) + assert.Equal(t, 6, got.Day()) + }) + t.Run("LegacySplitForm", func(t *testing.T) { + // Older writers split date and time across two elements. + doc := loadXmp(t, "testdata/xmp/synthetic/gps-time-split.xmp") + got := doc.TakenGps() + assert.False(t, got.IsZero(), "split-form GPSTimeStamp should still parse") + assert.Equal(t, 2026, got.Year()) + assert.Equal(t, 5, int(got.Month())) + assert.Equal(t, 6, got.Day()) + }) + t.Run("ZeroWhenAbsent", func(t *testing.T) { + // canon_eos_6d carries timestamps but no GPS time. + doc := loadXmp(t, "testdata/canon_eos_6d.xmp") + assert.True(t, doc.TakenGps().IsZero()) + }) +} + +func TestXmpDocument_CopyrightWebStatementFallback(t *testing.T) { + // When dc:rights is absent but xmpRights:WebStatement is present, + // the chain falls through to the URL. + doc := loadXmpString(t, `<?xml version="1.0"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:xmpRights="http://ns.adobe.com/xap/1.0/rights/"> + <xmpRights:WebStatement>https://example.org/license</xmpRights:WebStatement> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta>`) + assert.Equal(t, "https://example.org/license", doc.Copyright()) +} + +func TestParseRational(t *testing.T) { + t.Run("RationalWithDenominator", func(t *testing.T) { + v, ok := parseRational("3450/100") + assert.True(t, ok) + assert.Equal(t, 34.5, v) + }) + t.Run("PureFloat", func(t *testing.T) { + v, ok := parseRational("47.6754") + assert.True(t, ok) + assert.Equal(t, 47.6754, v) + }) + t.Run("ZeroNumerator", func(t *testing.T) { + v, ok := parseRational("0/100") + assert.True(t, ok) + assert.Equal(t, 0.0, v) + }) + t.Run("DivisionByZero", func(t *testing.T) { + _, ok := parseRational("1/0") + assert.False(t, ok) + }) + t.Run("Empty", func(t *testing.T) { + _, ok := parseRational("") + assert.False(t, ok) + }) + t.Run("Garbage", func(t *testing.T) { + _, ok := parseRational("abc/def") + assert.False(t, ok) + }) + t.Run("Whitespace", func(t *testing.T) { + v, ok := parseRational(" 100/4 ") + assert.True(t, ok) + assert.Equal(t, 25.0, v) + }) +} + +func TestIsNegativeRef(t *testing.T) { + assert.True(t, isNegativeRef("S")) + assert.True(t, isNegativeRef("s")) + assert.True(t, isNegativeRef("W")) + assert.True(t, isNegativeRef("w")) + assert.True(t, isNegativeRef("South"), "prefix-based check accepts 'South'") + assert.False(t, isNegativeRef("N")) + assert.False(t, isNegativeRef("E")) + assert.False(t, isNegativeRef("")) + assert.False(t, isNegativeRef(" ")) +} + +func TestParseSubSec(t *testing.T) { + t.Run("SixDigits", func(t *testing.T) { + // "899614" represents 0.899614 s = 899,614,000 ns. + assert.Equal(t, 899614000, parseSubSec("899614")) + }) + t.Run("NineDigits", func(t *testing.T) { + // Nanosecond-precision input is returned unchanged. + assert.Equal(t, 729626112, parseSubSec("729626112")) + }) + t.Run("ThreeDigits", func(t *testing.T) { + // "123" represents 0.123 s = 123,000,000 ns. + assert.Equal(t, 123000000, parseSubSec("123")) + }) + t.Run("Whitespace", func(t *testing.T) { + assert.Equal(t, 500000000, parseSubSec(" 5 ")) + }) + t.Run("Empty", func(t *testing.T) { + assert.Equal(t, 0, parseSubSec("")) + }) + t.Run("TooLongRejected", func(t *testing.T) { + // >9 digits would overflow nanosecond precision. + assert.Equal(t, 0, parseSubSec("1234567890")) + }) + t.Run("NonNumericRejected", func(t *testing.T) { + assert.Equal(t, 0, parseSubSec("abc")) + }) +} + +func TestFormatExposure(t *testing.T) { + t.Run("FractionalSeconds", func(t *testing.T) { + assert.Equal(t, "1/250", formatExposure(0.004)) + assert.Equal(t, "1/50", formatExposure(0.02)) + assert.Equal(t, "1/2", formatExposure(0.5)) + }) + t.Run("OneSecondAndAbove", func(t *testing.T) { + assert.Equal(t, "1", formatExposure(1.0)) + assert.Equal(t, "2.5", formatExposure(2.5)) + assert.Equal(t, "30", formatExposure(30)) + }) + t.Run("ZeroOrNegative", func(t *testing.T) { + assert.Equal(t, "", formatExposure(0)) + assert.Equal(t, "", formatExposure(-1)) + }) +} + +func TestApexToSeconds(t *testing.T) { + // EXIF spec: Tv = 0 → 1 s, Tv = 5 → 1/32 s. + assert.InDelta(t, 1.0, apexToSeconds(0), 1e-9) + assert.InDelta(t, 0.5, apexToSeconds(1), 1e-9) + assert.InDelta(t, 1.0/32.0, apexToSeconds(5), 1e-9) + // Negative APEX = exposures longer than 1 second. + assert.InDelta(t, 2.0, apexToSeconds(-1), 1e-9) +} + +func TestXmpDocument_CameraSerial(t *testing.T) { + t.Run("PrefersExifEXBodySerialNumber", func(t *testing.T) { + // Synthetic exifEX fixture writes exifEX:BodySerialNumber and no + // aux:SerialNumber. Modern property wins. + doc := loadXmp(t, "testdata/xmp/synthetic/exifex-camera-lens.xmp") + assert.Equal(t, "SC1-BODY-123456", doc.CameraSerial()) + }) + t.Run("ReadsRealExifToolBodySerialNumber", func(t *testing.T) { + // canon_eos_6d.xmp is an ExifTool-written sidecar carrying the + // standard exifEX:BodySerialNumber property. + doc := loadXmp(t, "testdata/canon_eos_6d.xmp") + assert.Equal(t, "033024001432", doc.CameraSerial()) + }) + t.Run("FallsBackToAuxSerialNumber", func(t *testing.T) { + // aux-only.xmp has aux:SerialNumber but no exifEX:BodySerialNumber. + doc := loadXmp(t, "testdata/xmp/synthetic/aux-only.xmp") + assert.Equal(t, "BODY-SN-123456", doc.CameraSerial()) + }) + t.Run("EmptyWhenAbsent", func(t *testing.T) { + doc := loadXmp(t, "testdata/fstop-favorite.xmp") + assert.Equal(t, "", doc.CameraSerial()) + }) +} + +func TestXmpDocument_LensMake(t *testing.T) { + t.Run("ExifEXFixture", func(t *testing.T) { + doc := loadXmp(t, "testdata/xmp/synthetic/exifex-camera-lens.xmp") + assert.Equal(t, "SyntheticLens Co.", doc.LensMake()) + }) + t.Run("IphoneSeven", func(t *testing.T) { + // iphone_7 fixture writes <exifEX:LensMake>Apple</exifEX:LensMake>. + doc := loadXmp(t, "testdata/iphone_7.xmp") + assert.Equal(t, "Apple", doc.LensMake()) + }) +} + +func TestXmpDocument_CameraOwner(t *testing.T) { + doc := loadXmp(t, "testdata/xmp/synthetic/aux-only.xmp") + assert.Equal(t, "Synthetic Photographer", doc.CameraOwner()) +} + +func TestXmpDocument_Projection(t *testing.T) { + t.Run("Equirectangular", func(t *testing.T) { + doc := loadXmp(t, "testdata/xmp/synthetic/gpano-360.xmp") + assert.Equal(t, "equirectangular", doc.Projection()) + }) + t.Run("EmptyWhenAbsent", func(t *testing.T) { + doc := loadXmp(t, "testdata/photoshop.xmp") + assert.Equal(t, "", doc.Projection()) + }) +} + +func TestXmpDocument_ColorProfile(t *testing.T) { + doc := loadXmp(t, "testdata/photoshop.xmp") + assert.Equal(t, "sRGB IEC61966-2.1", doc.ColorProfile()) +} + +func TestXmpDocument_Aperture(t *testing.T) { + t.Run("Photoshop", func(t *testing.T) { + // photoshop.xmp has <exif:ApertureValue>1695994/1000000</exif:ApertureValue>. + doc := loadXmp(t, "testdata/photoshop.xmp") + // 1695994/1000000 ≈ 1.696 + assert.InDelta(t, 1.696, doc.Aperture(), 0.01) + }) + t.Run("ZeroWhenAbsent", func(t *testing.T) { + doc := loadXmp(t, "testdata/fstop-favorite.xmp") + assert.Equal(t, float32(0), doc.Aperture()) + }) +} + +func TestXmpDocument_FNumber(t *testing.T) { + // photoshop.xmp has <exif:FNumber>180/100</exif:FNumber> = 1.8. + doc := loadXmp(t, "testdata/photoshop.xmp") + assert.InDelta(t, float32(1.8), doc.FNumber(), 0.01) +} + +func TestXmpDocument_FocalLength(t *testing.T) { + // photoshop.xmp has <exif:FocalLength>5580/1000</exif:FocalLength> ≈ 5.58 mm → 6. + doc := loadXmp(t, "testdata/photoshop.xmp") + assert.Equal(t, 6, doc.FocalLength()) +} + +func TestXmpDocument_Iso(t *testing.T) { + t.Run("FromISOSpeedRatingsSeq", func(t *testing.T) { + // photoshop.xmp has <exif:ISOSpeedRatings><rdf:Seq><rdf:li>200</rdf:li>... + doc := loadXmp(t, "testdata/photoshop.xmp") + assert.Equal(t, 200, doc.Iso()) + }) + t.Run("FromExifEXPhotographicSensitivity", func(t *testing.T) { + // Synthetic exifEX fixture exposes the modern element. + doc := loadXmp(t, "testdata/xmp/synthetic/exifex-camera-lens.xmp") + assert.Equal(t, 800, doc.Iso()) + }) +} + +func TestXmpDocument_Exposure(t *testing.T) { + t.Run("ExposureTimeRational", func(t *testing.T) { + // photoshop.xmp has 20000000/1000000000 = 1/50 s. + doc := loadXmp(t, "testdata/photoshop.xmp") + assert.Equal(t, "1/50", doc.Exposure()) + }) + t.Run("ShutterSpeedFallback", func(t *testing.T) { + // Synthetic case: only ShutterSpeedValue present. APEX 5 → 1/32 s. + doc := loadXmpString(t, `<?xml version="1.0"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:exif="http://ns.adobe.com/exif/1.0/"> + <exif:ShutterSpeedValue>5/1</exif:ShutterSpeedValue> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta>`) + assert.Equal(t, "1/32", doc.Exposure()) + }) +} + +func TestXmpDocument_Flash(t *testing.T) { + t.Run("FalseFromStruct", func(t *testing.T) { + // photoshop.xmp has <exif:Flash><exif:Fired>False</exif:Fired>... + doc := loadXmp(t, "testdata/photoshop.xmp") + assert.False(t, doc.Flash()) + }) + t.Run("TrueFromStruct", func(t *testing.T) { + doc := loadXmpString(t, `<?xml version="1.0"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:exif="http://ns.adobe.com/exif/1.0/"> + <exif:Flash rdf:parseType="Resource"> + <exif:Fired>True</exif:Fired> + <exif:Mode>1</exif:Mode> + </exif:Flash> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta>`) + assert.True(t, doc.Flash()) + }) + t.Run("FalseWhenAbsent", func(t *testing.T) { + doc := loadXmp(t, "testdata/fstop-favorite.xmp") + assert.False(t, doc.Flash()) + }) +} + +func TestXmpDocument_Notes(t *testing.T) { + t.Run("LangAlt", func(t *testing.T) { + doc := loadXmp(t, "testdata/xmp/synthetic/notes-usercomment.xmp") + assert.Contains(t, doc.Notes(), "Notes accessor") + }) + t.Run("EmptyWhenAbsent", func(t *testing.T) { + doc := loadXmp(t, "testdata/fstop-favorite.xmp") + assert.Equal(t, "", doc.Notes()) + }) +} + +func TestXmpDocument_TakenNs(t *testing.T) { + t.Run("FromSubSecTimeOriginal", func(t *testing.T) { + // photoshop.xmp has <exif:SubSecTimeOriginal>899614</exif:SubSecTimeOriginal>. + doc := loadXmp(t, "testdata/photoshop.xmp") + assert.Equal(t, 899614000, doc.TakenNs()) + }) + t.Run("ZeroWhenAbsent", func(t *testing.T) { + doc := loadXmp(t, "testdata/fstop-favorite.xmp") + assert.Equal(t, 0, doc.TakenNs()) + }) +} + +func TestXmpDocument_TakenAtChainAndSubSecJoin(t *testing.T) { + t.Run("PreservesFractionalFromDateString", func(t *testing.T) { + // photoshop.xmp's photoshop:DateCreated already has fractional + // seconds; the SubSec join must NOT override. + doc := loadXmp(t, "testdata/photoshop.xmp") + got := doc.TakenAt("") + assert.Equal(t, 729626112, got.Nanosecond()) + }) + t.Run("JoinsSubSecWhenDateLacksFraction", func(t *testing.T) { + // Synthetic case: DateCreated without fractional + SubSec. + doc := loadXmpString(t, `<?xml version="1.0"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:photoshop="http://ns.adobe.com/photoshop/1.0/" + xmlns:exif="http://ns.adobe.com/exif/1.0/"> + <photoshop:DateCreated>2020-01-01T17:28:23</photoshop:DateCreated> + <exif:SubSecTimeOriginal>123456</exif:SubSecTimeOriginal> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta>`) + got := doc.TakenAt("") + assert.Equal(t, 123456000, got.Nanosecond()) + }) + t.Run("FallsBackToDateTimeOriginal", func(t *testing.T) { + // No photoshop:DateCreated; the chain must move to + // exif:DateTimeOriginal. + doc := loadXmpString(t, `<?xml version="1.0"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:exif="http://ns.adobe.com/exif/1.0/"> + <exif:DateTimeOriginal>2019-08-15T10:00:00</exif:DateTimeOriginal> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta>`) + got := doc.TakenAt("") + assert.Equal(t, 2019, got.Year()) + assert.Equal(t, 8, int(got.Month())) + }) +} + +func TestXmpDocument_CreatedAt(t *testing.T) { + t.Run("FromXmpCreateDate", func(t *testing.T) { + // photoshop.xmp has <xmp:CreateDate>2020-01-01T17:28:23</xmp:CreateDate>. + doc := loadXmp(t, "testdata/photoshop.xmp") + got := doc.CreatedAt("") + assert.Equal(t, 2020, got.Year()) + }) + t.Run("FallsBackToXmpDMCreationDate", func(t *testing.T) { + // xmpDM:CreationDate is only used for video/audio sidecars. + doc := loadXmp(t, "testdata/xmp/synthetic/xmpdm-creationdate.xmp") + got := doc.CreatedAt("") + assert.Equal(t, 2026, got.Year()) + assert.Equal(t, 5, int(got.Month())) + assert.Equal(t, 6, got.Day()) + }) +} + +func TestXmpDocument_TimeOffset(t *testing.T) { + t.Run("OffsetTimeOriginal", func(t *testing.T) { + doc := loadXmp(t, "testdata/xmp/synthetic/time-offsets-subsec.xmp") + assert.Equal(t, "+02:00", doc.TimeOffset()) + }) + t.Run("EmptyWhenAbsent", func(t *testing.T) { + doc := loadXmp(t, "testdata/fstop-favorite.xmp") + assert.Equal(t, "", doc.TimeOffset()) + }) +} + +// TestXmpDocument_DarktableFixture covers the Darktable sidecar end to +// end — descriptive metadata, Bag-form keywords, and the 2-component +// Adobe GPS form that motivates the GpsToDecimal extension. The +// fixture also carries `<darktable:history>`, `lr:hierarchicalSubject`, +// and `xmp:Rating`, all of which are out of scope for the current +// reader; the test asserts they are silently ignored rather than +// surfacing as garbage on any in-scope field. +func TestXmpDocument_DarktableFixture(t *testing.T) { + doc := loadXmp(t, "testdata/xmp/darktable/aurora.jpg.xmp") + + t.Run("DescriptiveMetadata", func(t *testing.T) { + assert.Equal(t, "XMP Test - Aurora", doc.Title()) + assert.Equal(t, "Test fixture for darktable XMP sidecar", doc.Description()) + assert.Equal(t, "PhotoPrism", doc.Artist()) + assert.Equal(t, "CC-BY-SA 4.0", doc.Copyright()) + }) + t.Run("BagFormSubject", func(t *testing.T) { + // Darktable writes <dc:subject><rdf:Bag>. The old reader + // dropped this entirely (it only handled <rdf:Seq>); the new + // reader must produce a non-empty Subject list. + got := doc.Subject() + assert.Contains(t, got, "Aurora") + assert.Contains(t, got, "Iceland") + assert.Contains(t, got, "Nature") + }) + t.Run("TwoComponentGPSForm", func(t *testing.T) { + // The fixture carries lat="87,21.291962N" / lng="179,59.546814W" — + // the canonical regression case for the GpsToDecimal extension. + // 87° 21.291962'N → 87 + 21.291962/60 ≈ 87.3549. + assert.InDelta(t, 87.3549, doc.Lat(), 0.001) + // W cardinal inverts the sign for longitude. + assert.Less(t, doc.Lng(), 0.0) + assert.InDelta(t, -179.9924, doc.Lng(), 0.001) + }) + t.Run("OutOfScopeTagsIgnored", func(t *testing.T) { + // xmp:Rating is gap-analysis section 2 (rating/triage feature + // epic). The reader has no accessor for it, so no assertion is + // possible directly — we instead confirm that none of the + // in-scope accessors leak the rating value into their output. + assert.NotContains(t, doc.Title(), "1") + assert.NotContains(t, doc.Description(), "1") + // darktable:history blocks must not pollute Software either. + assert.Equal(t, "", doc.Software()) + }) +} diff --git a/internal/meta/xmp_migration_test.go b/internal/meta/xmp_migration_test.go new file mode 100644 index 000000000..948adbcaa --- /dev/null +++ b/internal/meta/xmp_migration_test.go @@ -0,0 +1,113 @@ +package meta + +import ( + "path/filepath" + "testing" + + "github.com/stretchr/testify/assert" +) + +// TestXMP_OverridesPreExistingMetaValues covers the meta-layer half of +// the SrcXmp > SrcMeta contract: every value the sidecar supplies +// overwrites the stale embedded-path value. Per-field SrcMeta → SrcXmp +// transitions are enforced by the entity setters that consume meta.Data. +func TestXMP_OverridesPreExistingMetaValues(t *testing.T) { + data := Data{ + Title: "Stale Embedded Title", + Caption: "Stale Embedded Caption", + Lat: 40.0, + Lng: -74.0, + Altitude: 99.9, + CameraMake: "WrongMake", + CameraModel: "WrongModel", + } + + // multi-rdf-description.xmp spreads ten fields across four sibling + // rdf:Description blocks. + if err := data.XMP("testdata/xmp/synthetic/multi-rdf-description.xmp"); err != nil { + t.Fatalf("data.XMP: %v", err) + } + + // Sidecar values must win. + assert.Equal(t, "Multi-Description Fixture", data.Title) + assert.Equal(t, "PhotoPrism", data.Artist) + assert.Equal(t, "SyntheticCam", data.CameraMake) + assert.Equal(t, "SC-1 Mark II", data.CameraModel) + assert.InDelta(t, 52.5076, data.Lat, 1e-3) + assert.InDelta(t, 13.4095, data.Lng, 1e-3) + assert.InDelta(t, 34.5, data.Altitude, 1e-3) + assert.Equal(t, "00000000-0000-0000-0000-000000000000", data.DocumentID) + assert.Equal(t, "xmp.iid:aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", data.InstanceID) + + // Caption was absent from the fixture; the reader only overwrites + // when it has a non-empty replacement, so the stale value stays. + assert.Equal(t, "Stale Embedded Caption", data.Caption) +} + +// TestXMP_FillsPreviouslyEmptyFields covers the partial-sidecar → +// full-sidecar migration: a DB written by the old reader had only the +// four ✅ preserved fields set; the new reader fills in License, GPS, +// xmpMM IDs and the rest of the high-priority fields on re-index. +func TestXMP_FillsPreviouslyEmptyFields(t *testing.T) { + data := Data{ + Title: "XMP Test - Aurora", + Caption: "Test fixture for digiKam XMP sidecar", + } + + if err := data.XMP("testdata/xmp/digikam/aurora.jpg.xmp"); err != nil { + t.Fatalf("data.XMP: %v", err) + } + + // Previously-set values must round-trip without corruption. + assert.Equal(t, "XMP Test - Aurora", data.Title) + assert.Equal(t, "Test fixture for digiKam XMP sidecar", data.Caption) + + // Previously-empty fields must now be populated by the new reader. + assert.Equal(t, "CC-BY-SA 4.0", data.License) + assert.Equal(t, "254738CA43CD69C01101874D65B006B4", data.DocumentID) + assert.Equal(t, "xmp.iid:de0fb44d-bdc8-4cc3-aa50-9aefe4992b34", data.InstanceID) + assert.Equal(t, "(C) 2026 PhotoPrism — Test fixture", data.Copyright) + assert.Equal(t, "sRGB IEC61966-2.1", data.ColorProfile) + assert.NotEmpty(t, data.Subject, "dc:subject Bag must populate Subject") + assert.Empty(t, data.Keywords, "dc:subject must not populate Keywords") +} + +// TestXMP_GpsCompositionEndToEnd asserts that a 2-component Adobe-form +// sidecar populates Lat/Lng/Altitude as floats while leaving the +// ExifTool-format GPSLatitude/GPSLongitude string fields untouched. +func TestXMP_GpsCompositionEndToEnd(t *testing.T) { + // Pre-populated ExifTool-format strings must survive the XMP path. + data := Data{ + GPSLatitude: `40 deg 25' 12.0" N`, + GPSLongitude: `74 deg 0' 21.6" W`, + } + + tmp := filepath.Join(t.TempDir(), "adobe-gps.xmp") + if err := writeFile(t, tmp, `<?xml version="1.0"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:exif="http://ns.adobe.com/exif/1.0/"> + <exif:GPSLatitude>52,30.4567N</exif:GPSLatitude> + <exif:GPSLongitude>13,24.5678E</exif:GPSLongitude> + <exif:GPSAltitude>3450/100</exif:GPSAltitude> + <exif:GPSAltitudeRef>0</exif:GPSAltitudeRef> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta>`); err != nil { + t.Fatal(err) + } + if err := data.XMP(tmp); err != nil { + t.Fatalf("data.XMP: %v", err) + } + + // Float fields populated from the XMP path. + assert.InDelta(t, 52.5076, data.Lat, 1e-3) + assert.InDelta(t, 13.4095, data.Lng, 1e-3) + assert.InDelta(t, 34.5, data.Altitude, 1e-3) + + // String fields keep the ExifTool DMS format — the XMP path + // populates Lat/Lng/Altitude floats only. + assert.Equal(t, `40 deg 25' 12.0" N`, data.GPSLatitude) + assert.Equal(t, `74 deg 0' 21.6" W`, data.GPSLongitude) +} diff --git a/internal/meta/xmp_security_test.go b/internal/meta/xmp_security_test.go new file mode 100644 index 000000000..7eed767e3 --- /dev/null +++ b/internal/meta/xmp_security_test.go @@ -0,0 +1,91 @@ +package meta + +import ( + "errors" + "path/filepath" + "strings" + "testing" + + "github.com/stretchr/testify/assert" +) + +// TestXmpSecurity_OversizeFileRejected covers the size-cap branch of +// Load: a 1 MiB + 1 byte file must error with ErrXmpFileTooLarge +// before any parsing happens. +func TestXmpSecurity_OversizeFileRejected(t *testing.T) { + tmp := filepath.Join(t.TempDir(), "oversize.xmp") + payload := strings.Repeat("A", xmpMaxFileSize+1) + if err := writeFile(t, tmp, payload); err != nil { + t.Fatal(err) + } + var doc XmpDocument + err := doc.Load(tmp) + assert.Error(t, err) + assert.True(t, errors.Is(err, ErrXmpFileTooLarge), "got %v, want ErrXmpFileTooLarge", err) +} + +// TestXmpSecurity_DepthBombRejected covers the depth-cap branch: +// nesting one level deeper than xmpMaxDepth errors with ErrXmpTooDeep; +// documents exactly at the limit are still accepted. +func TestXmpSecurity_DepthBombRejected(t *testing.T) { + t.Run("ExceedsLimit", func(t *testing.T) { + nesting := xmpMaxDepth + 1 + body := strings.Repeat("<a>", nesting) + strings.Repeat("</a>", nesting) + tmp := filepath.Join(t.TempDir(), "deep.xmp") + if err := writeFile(t, tmp, `<?xml version="1.0"?>`+body); err != nil { + t.Fatal(err) + } + var doc XmpDocument + err := doc.Load(tmp) + assert.Error(t, err) + assert.True(t, errors.Is(err, ErrXmpTooDeep), "got %v, want ErrXmpTooDeep", err) + }) + t.Run("AtLimitAllowed", func(t *testing.T) { + // xmpMaxDepth-1 elements puts the deepest one at xmpMaxDepth + // counting the document node — the highest accepted value. + nesting := xmpMaxDepth - 1 + body := strings.Repeat("<a>", nesting) + strings.Repeat("</a>", nesting) + tmp := filepath.Join(t.TempDir(), "at-limit.xmp") + if err := writeFile(t, tmp, `<?xml version="1.0"?>`+body); err != nil { + t.Fatal(err) + } + var doc XmpDocument + err := doc.Load(tmp) + assert.NoError(t, err) + }) +} + +// TestXmpSecurity_XXENotResolved guards against a future loader change +// that switches to a less-defensive parser. encoding/xml does not +// resolve external entities by default; this asserts &xxe; is never +// expanded to the contents of /etc/hostname or any other file. +func TestXmpSecurity_XXENotResolved(t *testing.T) { + tmp := filepath.Join(t.TempDir(), "xxe.xmp") + body := `<?xml version="1.0"?> +<!DOCTYPE foo [ <!ENTITY xxe SYSTEM "file:///etc/hostname"> ]> +<x:xmpmeta xmlns:x="adobe:ns:meta/"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:dc="http://purl.org/dc/elements/1.1/"> + <dc:title>&xxe;</dc:title> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta>` + if err := writeFile(t, tmp, body); err != nil { + t.Fatal(err) + } + var doc XmpDocument + if err := doc.Load(tmp); err != nil { + // encoding/xml errors on unresolved entity references in strict + // mode — acceptable, proves the entity was not fetched. + t.Logf("Load rejected XXE document with %v", err) + return + } + // If Load succeeded, the title must be empty or the literal "&xxe;"; + // anything resembling a hostname or path is a regression. + title := doc.Title() + assert.NotContains(t, title, "/etc/") + if title != "" && title != "&xxe;" { + t.Errorf("unexpected Title %q after XXE attempt — entity may have resolved", title) + } +} diff --git a/internal/meta/xmp_test.go b/internal/meta/xmp_test.go index c850cdb93..8a1ec3ba3 100644 --- a/internal/meta/xmp_test.go +++ b/internal/meta/xmp_test.go @@ -1,10 +1,14 @@ package meta import ( + "os" + "path/filepath" "testing" "time" "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/pkg/fs" ) func TestXMP(t *testing.T) { @@ -17,8 +21,18 @@ func TestXMP(t *testing.T) { assert.Equal(t, "Botanischer Garten", data.Title) assert.Equal(t, time.Date(2021, 3, 24, 13, 07, 29, 0, time.FixedZone("", +3600)).UTC(), data.TakenAt.UTC()) + // GPS resolves to Europe/Berlin; March 24 2021 is still CET (DST starts March 28), + // so wall-clock 13:07:29 +01:00 = 12:07:29 UTC. + assert.Equal(t, "Europe/Berlin", data.TimeZone) + assert.Equal(t, "2021-03-24 13:07:29", data.TakenAtLocal.Format("2006-01-02 15:04:05")) assert.Equal(t, "Tulpen am See", data.Caption) - assert.Equal(t, Keywords{"blume", "krokus", "schöne", "wiese"}, data.Keywords) + // dc:subject feeds the descriptive Subject field, not Keywords, and + // multi-word entries keep their spaces ("Schöne Wiese" stays intact). + assert.Equal(t, "Krokus, Blume, Schöne Wiese", data.Subject) + assert.Empty(t, data.Keywords) + // Apple GPS — pure-decimal value with separate *Ref. + assert.InDelta(t, 52.525082, data.Lat, 1e-4) + assert.InDelta(t, 13.369367, data.Lng, 1e-4) }) t.Run("Photoshop", func(t *testing.T) { data, err := XMP("testdata/photoshop.xmp") @@ -28,13 +42,27 @@ func TestXMP(t *testing.T) { } assert.Equal(t, "Night Shift / Berlin / 2020", data.Title) - assert.Equal(t, time.Date(2020, 1, 1, 17, 28, 25, 729626112, time.UTC), data.TakenAt) + // GPS resolves to Europe/Berlin. Wall-clock from photoshop:DateCreated is + // "2020-01-01T17:28:25.729626112" — the resolver re-parses it in Berlin + // (CET / +01:00) and re-joins the sub-second fraction from + // exif:SubSecTimeOriginal (899614 → 899614000ns), matching the EXIF flow + // where SubSecTimeOriginal is authoritative for the nanosecond component. + assert.Equal(t, time.Date(2020, 1, 1, 16, 28, 25, 899614000, time.UTC), data.TakenAt) + assert.Equal(t, "Europe/Berlin", data.TimeZone) + assert.Equal(t, "2020-01-01 17:28:25", data.TakenAtLocal.Format("2006-01-02 15:04:05")) assert.Equal(t, "Michael Mayer", data.Artist) assert.Equal(t, "Example file for development", data.Caption) assert.Equal(t, "This is an (edited) legal notice", data.Copyright) + // dc:subject feeds the descriptive Subject field only (matching the + // embedded/ExifTool path's data.Subject source), never Keywords. + assert.Equal(t, "desk, coffee, computer", data.Subject) + assert.Empty(t, data.Keywords) assert.Equal(t, "HUAWEI", data.CameraMake) assert.Equal(t, "ELE-L29", data.CameraModel) assert.Equal(t, "HUAWEI P30 Rear Main Camera", data.LensModel) + // Adobe 2-component GPS form (degrees + decimal-minutes + cardinal). + assert.InDelta(t, 52.459690, data.Lat, 1e-4) + assert.InDelta(t, 13.321832, data.Lng, 1e-4) }) t.Run("CanonEosSixD", func(t *testing.T) { data, err := XMP("testdata/canon_eos_6d.xmp") @@ -66,6 +94,9 @@ func TestXMP(t *testing.T) { assert.Equal(t, "iPhone 7", data.CameraModel) assert.Equal(t, "iPhone 7 back camera 3.99mm f/1.8", data.LensModel) assert.Equal(t, false, data.Favorite) + // iPhone 7 sidecar uses Adobe 2-component GPS form. + assert.InDelta(t, 34.797450, data.Lat, 1e-4) + assert.InDelta(t, 134.764633, data.Lng, 1e-4) }) t.Run("Fstop", func(t *testing.T) { data, err := XMP("testdata/fstop-favorite.xmp") @@ -83,8 +114,139 @@ func TestXMP(t *testing.T) { t.Fatal(err) } + // photoshop:DateCreated = "2022-09-03T17:48:26-07:00" → 00:48:26 UTC the + // next day. GPS resolves to America/Los_Angeles, so TakenAtLocal carries + // the Seattle-area wall-clock (17:48:26 on Sept 3). assert.Equal(t, time.Date(2022, 9, 4, 0, 48, 26, 0, time.UTC), data.TakenAt.UTC()) - assert.True(t, data.TakenAtLocal.IsZero()) - assert.Equal(t, "UTC", data.TimeZone) + assert.Equal(t, "America/Los_Angeles", data.TimeZone) + assert.Equal(t, "2022-09-03 17:48:26", data.TakenAtLocal.Format("2006-01-02 15:04:05")) + // Apple HEIC: pure-decimal GPS with W cardinal → negative Lng. + assert.InDelta(t, 47.675403, data.Lat, 1e-4) + assert.InDelta(t, -122.317392, data.Lng, 1e-4) + assert.InDelta(t, 63.63, data.Altitude, 0.01) + }) + t.Run("SyntheticTimeOffsetsSubsec", func(t *testing.T) { + // No GPS — resolver derives the time zone from exif:OffsetTimeOriginal + // ("+02:00") and applies exif:SubSecTimeOriginal (123456 → 123456000ns). + data, err := XMP("testdata/xmp/synthetic/time-offsets-subsec.xmp") + + if err != nil { + t.Fatal(err) + } + + assert.Equal(t, "+02:00", data.TimeOffset) + assert.Equal(t, "UTC+2", data.TimeZone) + // photoshop:DateCreated already carries an inline .123456 fraction; the + // resolver preserves it because TakenAt.Nanosecond() != 0 short-circuits + // the TakenNs re-application. + assert.Equal(t, 123456000, data.TakenAt.Nanosecond()) + // The +02:00 offset is applied to the offset-less capture timestamp, so + // the wall-clock 15:42:18 local resolves to 13:42:18 UTC. + assert.Equal(t, "2026-05-06 13:42:18", data.TakenAt.UTC().Format("2006-01-02 15:04:05")) + assert.Equal(t, "2026-05-06 15:42:18", data.TakenAtLocal.Format("2006-01-02 15:04:05")) + }) + t.Run("SyntheticDateCreatedPriority", func(t *testing.T) { + // photoshop:DateCreated (capture time) must win over a later, disagreeing + // xmp:CreateDate (file write). No GPS, so nothing re-derives TakenAt — a + // regression guard for CreatedAt clobbering the higher-priority capture + // instant in the shared resolver. + data, err := XMP("testdata/xmp/synthetic/datecreated-priority.xmp") + + if err != nil { + t.Fatal(err) + } + + assert.Equal(t, "2026-01-15 10:00:00", data.TakenAt.Format("2006-01-02 15:04:05")) + assert.Equal(t, "2026-01-15 10:00:00", data.TakenAtLocal.Format("2006-01-02 15:04:05")) + }) + t.Run("SyntheticGpsTimeCombined", func(t *testing.T) { + // GPS coordinates + combined GPS timestamp ("2026-05-06T15:42:18Z"), no + // other capture timestamp. Resolver falls back to GPS UTC time first, + // then promotes the IANA zone from coordinates. + data, err := XMP("testdata/xmp/synthetic/gps-time-combined.xmp") + + if err != nil { + t.Fatal(err) + } + + assert.Equal(t, "Europe/Berlin", data.TimeZone) + assert.Equal(t, time.Date(2026, 5, 6, 15, 42, 18, 0, time.UTC), data.TakenAt.UTC()) + // May 6 is CEST in Berlin (+02:00); 15:42:18 UTC → 17:42:18 wall-clock. + assert.Equal(t, "2026-05-06 17:42:18", data.TakenAtLocal.Format("2006-01-02 15:04:05")) + }) + t.Run("SyntheticGpsTimeSplit", func(t *testing.T) { + // Same payload as Combined but expressed as split GPSDateStamp/GPSTimeStamp. + // Doc reader must reassemble them and the resolver must produce identical + // entity state to the combined case. + data, err := XMP("testdata/xmp/synthetic/gps-time-split.xmp") + + if err != nil { + t.Fatal(err) + } + + assert.Equal(t, "Europe/Berlin", data.TimeZone) + assert.Equal(t, time.Date(2026, 5, 6, 15, 42, 18, 0, time.UTC), data.TakenAt.UTC()) + assert.Equal(t, "2026-05-06 17:42:18", data.TakenAtLocal.Format("2006-01-02 15:04:05")) + }) + t.Run("SyntheticPanoramaKeyword", func(t *testing.T) { + // GPano:ProjectionType=equirectangular must auto-add the "panorama" + // keyword for parity with the EXIF/ExifTool paths + // (exif.go:327, json_exiftool.go:282-284). + data, err := XMP("testdata/xmp/synthetic/gpano-360.xmp") + + if err != nil { + t.Fatal(err) + } + + assert.Equal(t, "equirectangular", data.Projection) + assert.Contains(t, data.Keywords.String(), "panorama") + }) + t.Run("SyntheticAutoKeywordsFromCaption", func(t *testing.T) { + // dc:description containing "HDR" must trigger AutoAddKeywords — + // the "hdr" keyword is added and data.ImageType is set to + // ImageTypeHDR for parity with json_exiftool.go:287. + body := `<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" xmlns:dc="http://purl.org/dc/elements/1.1/"> + <dc:description><rdf:Alt><rdf:li xml:lang="x-default">HDR sunset</rdf:li></rdf:Alt></dc:description> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta>` + tmp := filepath.Join(t.TempDir(), "caption-hdr.xmp") + if err := os.WriteFile(tmp, []byte(body), fs.ModeFile); err != nil { + t.Fatal(err) + } + + data, err := XMP(tmp) + if err != nil { + t.Fatal(err) + } + + assert.Equal(t, "HDR sunset", data.Caption) + assert.Contains(t, data.Keywords.String(), "hdr") + assert.Equal(t, ImageTypeHDR, data.ImageType) + }) +} + +func TestApplyTimeOffset(t *testing.T) { + base := time.Date(2026, 5, 6, 15, 42, 18, 123456000, time.UTC) + + t.Run("PositiveOffset", func(t *testing.T) { + got := applyTimeOffset(base, "+02:00") + assert.Equal(t, "2026-05-06 15:42:18", got.Format("2006-01-02 15:04:05")) + assert.Equal(t, "2026-05-06 13:42:18", got.UTC().Format("2006-01-02 15:04:05")) + assert.Equal(t, 123456000, got.Nanosecond()) + }) + + t.Run("NegativeOffset", func(t *testing.T) { + got := applyTimeOffset(base, "-05:30") + assert.Equal(t, "2026-05-06 15:42:18", got.Format("2006-01-02 15:04:05")) + assert.Equal(t, "2026-05-06 21:12:18", got.UTC().Format("2006-01-02 15:04:05")) + }) + + t.Run("InvalidOffsetReturnsInput", func(t *testing.T) { + got := applyTimeOffset(base, "not-an-offset") + assert.Equal(t, base, got) }) } diff --git a/internal/mutex/mutex.go b/internal/mutex/mutex.go index 0e8fe9143..0acb03c9a 100644 --- a/internal/mutex/mutex.go +++ b/internal/mutex/mutex.go @@ -1,7 +1,7 @@ /* Package mutex provides concurrency control for index workers and database operations. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/photoprism/AGENTS.md b/internal/photoprism/AGENTS.md new file mode 100644 index 000000000..1fd5d64dc --- /dev/null +++ b/internal/photoprism/AGENTS.md @@ -0,0 +1,25 @@ +# PhotoPrism Core Import & Index Guidelines + +**Last Updated:** April 9, 2026 + +## Import & Index Behavior + +- `ImportWorker` may skip a file when an identical file already exists. Use unique copies or assert DB rows only after ensuring the destination is not a duplicate. +- Keep `SamplesPath()`, `ImportPath()`, and `OriginalsPath()` consistent when testing related files so `RelatedFiles` and `AllowExt` behave correctly. +- `IndexOptions*` helpers now require a `*config.Config`; pass the active config, or `config.NewMinimalTestConfig(t.TempDir())` in unit tests, so face, label, and NSFW scheduling matches the current run. +- Vision scheduling is controlled by `VisionSchedule`, `VisionFilter`, and the `Run` property in `vision.yml`. Use helpers such as `vision.FilterModels` and `entity.Photo.ShouldGenerateLabels` or `ShouldGenerateCaption` before loading media. +- Folder albums use path-first lookup and update via `album_path` to avoid slug collisions for emoji child paths; re-indexing may repair stale collision titles while preserving user-custom titles. +- Reuse `entity.FindLabels(...)`, `entity.FindLabelIDs(...)`, and `entity.LabelSlugs(...)` for label lookup so homophone-aware exact-name matching stays aligned across entity and search packages. + +## File I/O Overwrite Policy + +- Default to safety: callers must not overwrite non-empty destination files unless they opt in with `force=true`. +- Replacing an empty destination file is allowed without `force=true`. +- Open overwriting destinations with `O_WRONLY|O_CREATE|O_TRUNC` so stale trailing bytes cannot survive; use `O_EXCL` when the caller must detect collisions. +- App-level overwrite helpers live in `internal/photoprism/mediafile.go`; reusable helpers live in `pkg/fs/copy.go` and `pkg/fs/move.go`. +- Set `force=true` only for explicit replace flows or admin tools with confirmed overwrite, not for import or index flows that touch Originals. + +## Tests + +- In `internal/photoprism` tests, rely on `photoprism.Config()` for runtime-accurate behavior; only build a new config if you replace it with `photoprism.SetConfig`. + diff --git a/internal/photoprism/README.md b/internal/photoprism/README.md index e276b16e1..127ef7155 100644 --- a/internal/photoprism/README.md +++ b/internal/photoprism/README.md @@ -1,6 +1,6 @@ ## PhotoPrism — Core Package -**Last Updated:** March 3, 2026 +**Last Updated:** May 21, 2026 ### Overview @@ -42,6 +42,7 @@ - Import: run via `ImportWorker` with `ImportOptions`; stacked handling is driven by metadata and document IDs. - Converters: use `Convert.ToImage` / `Convert.ToVideo` / `Convert.ToJson`; options come from `config.Config`. - Vision: thumbnails for vision models are selected in `mediafile_vision.go`; ensure models exist in `internal/ai/vision`. +- NSFW: `index_mediafile.go` flags new photos as `PhotoPrivate` when the labels-path NSFW shortcut (LLM with `DETECT_NSFW=true && EXPERIMENTAL=true`) hits or, as a fallback, when `m.DetectNSFW()` returns true and `PHOTOPRISM_DETECT_NSFW=true`. Both promotions short-circuit when `DetectNSFW()` is false. Full call-graph + flag matrix in [`internal/ai/nsfw/README.md`](../ai/nsfw/README.md). - Tests: targeted runs keep iteration fast, e.g. - `go test ./internal/photoprism -run TestMediaFile_ -count=1` - `go test ./internal/photoprism/index_mediafile_test.go -run TestIndexMediaFile` diff --git a/internal/photoprism/backup/albums.go b/internal/photoprism/backup/albums.go index e1c554b6d..90f83d0fa 100644 --- a/internal/photoprism/backup/albums.go +++ b/internal/photoprism/backup/albums.go @@ -1,15 +1,18 @@ package backup import ( + "fmt" "path/filepath" "regexp" "time" "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/entity/query" + "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/internal/photoprism/get" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/log/status" ) // Albums creates a YAML file backup of all albums. @@ -25,8 +28,10 @@ func Albums(backupPath string, force bool) (count int, err error) { return count, queryErr } + c := get.Config() + if !fs.PathExists(backupPath) { - backupPath = get.Config().BackupAlbumsPath() + backupPath = c.BackupAlbumsPath() } log.Debugf("backup: album backups will be stored in %s", clean.Log(backupPath)) @@ -54,6 +59,13 @@ func Albums(backupPath string, force bool) (count int, err error) { latest = changed } + // Stop writing new backups if storage is over quota or critically low on free disk space. + // The disk-free cache rate-limits this to one actual probe per CacheTTL. + if c.InsufficientStorage() { + err = status.ErrInsufficientStorage + break + } + // Write album metadata to YAML backup file. if saveErr := a.SaveBackupYaml(backupPath); saveErr != nil { err = saveErr @@ -75,6 +87,14 @@ func RestoreAlbums(backupPath string, force bool) (count int, result error) { backupAlbumsMutex.Lock() defer backupAlbumsMutex.Unlock() + // Recover from panics so a corrupt backup file cannot abort server startup. + defer func() { + if r := recover(); r != nil { + event.LogPanic(r) + result = fmt.Errorf("recovered from panic while restoring album backups") + } + }() + c := get.Config() if !c.BackupAlbums() && !force { diff --git a/internal/photoprism/backup/backup.go b/internal/photoprism/backup/backup.go index 386d57f5b..27ec86f86 100644 --- a/internal/photoprism/backup/backup.go +++ b/internal/photoprism/backup/backup.go @@ -1,7 +1,7 @@ /* Package backup provides backup and restore functions for databases and albums. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/photoprism/backup/backup_test.go b/internal/photoprism/backup/backup_test.go index add21221f..052054a8c 100644 --- a/internal/photoprism/backup/backup_test.go +++ b/internal/photoprism/backup/backup_test.go @@ -13,7 +13,12 @@ import ( "github.com/photoprism/photoprism/pkg/fs" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) int { log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) event.AuditLog = log @@ -22,18 +27,17 @@ func TestMain(m *testing.M) { fs.PurgeTestDbFiles(".", false) c := config.TestConfig() + defer c.CleanupTestFolder() + defer func() { + if err := c.CloseDb(); err != nil { + log.Warnf("close db: %v", err) + } + // Remove temporary SQLite files after running the tests. + fs.PurgeTestDbFiles(".", false) + }() get.SetConfig(c) photoprism.SetConfig(c) - code := m.Run() - - // Remove temporary SQLite files after running the tests. - if err := c.CloseDb(); err != nil { - log.Warnf("close db: %v", err) - } - - fs.PurgeTestDbFiles(".", false) - - os.Exit(code) + return m.Run() } diff --git a/internal/photoprism/backup/database.go b/internal/photoprism/backup/database.go index a463d9db4..e4270024b 100644 --- a/internal/photoprism/backup/database.go +++ b/internal/photoprism/backup/database.go @@ -15,11 +15,12 @@ import ( "github.com/dustin/go-humanize/english" - "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/photoprism/get" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/dsn" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/log/status" ) // Database creates a database backup dump with the specified file and path name. @@ -34,6 +35,11 @@ func Database(backupPath, fileName string, toStdOut, force bool, retain int) (er // Get configuration. c := get.Config() + // Storage-gate the on-disk path only: when toStdOut is true the dump + // streams to stdout and does not consume the local storage volume, so an + // operator can still offload a backup over ssh or similar when the disk + // is full. Path validation and the InsufficientStorage check therefore + // run inside this branch only. if !toStdOut { if backupPath == "" { backupPath = c.BackupDatabasePath() @@ -62,6 +68,11 @@ func Database(backupPath, fileName string, toStdOut, force bool, retain int) (er backupAction = "replacing" } + // Refuse to write a new database dump if storage is over quota or critically low on free disk space. + if c.InsufficientStorage() { + return status.ErrInsufficientStorage + } + // Create backup path if not exists. if dir := filepath.Dir(fileName); dir != "." { if err = fs.MkdirAll(dir); err != nil { @@ -73,7 +84,7 @@ func Database(backupPath, fileName string, toStdOut, force bool, retain int) (er var cmd *exec.Cmd switch c.DatabaseDriver() { - case config.MySQL, config.MariaDB: + case dsn.DriverMySQL, dsn.DriverMariaDB: // Connect via Unix Domain Socket? if socketName := c.DatabaseServer(); strings.HasPrefix(socketName, "/") { cmd = exec.Command( // #nosec G204 database connection parameters from trusted config @@ -112,7 +123,7 @@ func Database(backupPath, fileName string, toStdOut, force bool, retain int) (er c.DatabaseName(), ) } - case config.SQLite3: + case dsn.DriverSQLite3: if !fs.FileExistsNotEmpty(c.DatabaseFile()) { return fmt.Errorf("sqlite database file %s not found", clean.LogQuote(c.DatabaseFile())) } @@ -254,7 +265,7 @@ func RestoreDatabase(backupPath, fileName string, fromStdIn, force bool) (err er var cmd *exec.Cmd switch c.DatabaseDriver() { - case config.MySQL, config.MariaDB: + case dsn.DriverMySQL, dsn.DriverMariaDB: // Connect via Unix Domain Socket? if socketName := c.DatabaseServer(); strings.HasPrefix(socketName, "/") { cmd = exec.Command( // #nosec G204 database connection parameters from config @@ -296,7 +307,7 @@ func RestoreDatabase(backupPath, fileName string, fromStdIn, force bool) (err er c.DatabaseName(), ) } - case config.SQLite3: + case dsn.DriverSQLite3: log.Infoln("restore: dropping existing sqlite database tables") tables.Drop(c.Db()) cmd = exec.Command( // #nosec G204 sqlite restore uses configured binary and db path diff --git a/internal/photoprism/backup/storage_test.go b/internal/photoprism/backup/storage_test.go new file mode 100644 index 000000000..a55719664 --- /dev/null +++ b/internal/photoprism/backup/storage_test.go @@ -0,0 +1,66 @@ +package backup + +import ( + "errors" + "os" + "path/filepath" + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/internal/photoprism/get" + "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/fs/disk" + "github.com/photoprism/photoprism/pkg/log/status" +) + +func TestAlbums_InsufficientStorage(t *testing.T) { + backupPath, err := filepath.Abs("./testdata/albums-insufficient") + require.NoError(t, err) + require.NoError(t, os.MkdirAll(backupPath, fs.ModeDir)) + t.Cleanup(func() { _ = os.RemoveAll(backupPath) }) + + conf := get.Config() + disk.FlushFree() + t.Cleanup(disk.FlushFree) + disk.SetFree(conf.StoragePath(), 1*disk.MB, 1000*disk.MB) + + count, err := Albums(backupPath, true) + + assert.True(t, errors.Is(err, status.ErrInsufficientStorage), "expected status.ErrInsufficientStorage, got %v", err) + // The loop aborts before writing the first YAML. + assert.Equal(t, 0, count) +} + +func TestDatabase_InsufficientStorage(t *testing.T) { + backupPath, err := filepath.Abs("./testdata/sqlite-insufficient") + require.NoError(t, err) + require.NoError(t, os.MkdirAll(backupPath, fs.ModeDir)) + t.Cleanup(func() { _ = os.RemoveAll(backupPath) }) + + conf := get.Config() + disk.FlushFree() + t.Cleanup(disk.FlushFree) + disk.SetFree(conf.StoragePath(), 1*disk.MB, 1000*disk.MB) + + err = Database(backupPath, "", false, true, 2) + + assert.True(t, errors.Is(err, status.ErrInsufficientStorage), "expected status.ErrInsufficientStorage, got %v", err) +} + +func TestDatabase_StdoutBypassesStorageGate(t *testing.T) { + conf := get.Config() + disk.FlushFree() + t.Cleanup(disk.FlushFree) + disk.SetFree(conf.StoragePath(), 1*disk.MB, 1000*disk.MB) + + // Stdout dumps must not be blocked by the storage gate so an operator can + // still offload a backup (for example over ssh) when the local volume is + // full. The actual mariadb-dump invocation will fail in this minimal + // fixture, but the error must not be status.ErrInsufficientStorage. + err := Database("", "-", true, true, 0) + + assert.False(t, errors.Is(err, status.ErrInsufficientStorage), + "stdout backups must bypass the storage gate, got %v", err) +} diff --git a/internal/photoprism/batch/apply_labels.go b/internal/photoprism/batch/apply_labels.go index 73fe0ec17..49f4e3bb3 100644 --- a/internal/photoprism/batch/apply_labels.go +++ b/internal/photoprism/batch/apply_labels.go @@ -86,10 +86,11 @@ func ApplyLabels(photo *entity.Photo, labels Items) (errs []error) { } if labelEntity == nil && it.Title != "" { - // Create or find by title. - if labelEntity, err = entity.FindLabel(it.Title, true); err != nil || labelEntity == nil { - labelEntity = entity.FirstOrCreateLabel(entity.NewLabel(it.Title, 0)) - } + // Resolve via FirstOrCreateLabel rather than FindLabel: the + // former routes through findLabelByExactName, which is + // homophone-safe (a query for `吻` does not collapse onto + // the existing `问` with the same pinyin slug `wen`). + labelEntity = entity.FirstOrCreateLabel(entity.NewLabel(it.Title, 0)) } if labelEntity == nil { diff --git a/internal/photoprism/batch/batch.go b/internal/photoprism/batch/batch.go index 42910f8de..a91b191af 100644 --- a/internal/photoprism/batch/batch.go +++ b/internal/photoprism/batch/batch.go @@ -4,7 +4,7 @@ the PhotosForm schema, helper types for expressing add/remove actions, and the validation / persistence helpers (ApplyAlbums, ApplyLabels, SavePhotos, etc.) that the API layer uses to safely mutate selections of photos at once. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -17,7 +17,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/photoprism/batch/batch_test.go b/internal/photoprism/batch/batch_test.go index 6d39387b9..183bda5d6 100644 --- a/internal/photoprism/batch/batch_test.go +++ b/internal/photoprism/batch/batch_test.go @@ -8,13 +8,19 @@ import ( "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/event" + "github.com/photoprism/photoprism/internal/mutex" "github.com/photoprism/photoprism/internal/photoprism" "github.com/photoprism/photoprism/internal/photoprism/get" "github.com/photoprism/photoprism/pkg/fs" ) -// TestMain configures shared state for the batch action tests. +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +// runTestMain configures shared state for the batch action tests. +func runTestMain(m *testing.M) (code int) { log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) event.AuditLog = log @@ -23,18 +29,18 @@ func TestMain(m *testing.M) { fs.PurgeTestDbFiles(".", false) c := config.TestConfig() + defer c.CleanupTestFolder() + defer func() { + // Prevent UpdateCountsAsync from causing the test suite to fail due to the database closing before the goroutine has finished. + mutex.Index.Lock() + if err := c.CloseDb(); err != nil { + log.Warnf("close db: %v", err) + } + // Remove temporary SQLite files after running the tests. + fs.PurgeTestDbFiles(".", false) + }() get.SetConfig(c) photoprism.SetConfig(c) - - code := m.Run() - - // Remove temporary SQLite files after running the tests. - if err := c.CloseDb(); err != nil { - log.Warnf("close db: %v", err) - } - - fs.PurgeTestDbFiles(".", false) - - os.Exit(code) + return m.Run() } diff --git a/internal/photoprism/batch/save_resolve.go b/internal/photoprism/batch/save_resolve.go index fde5b48c2..2dd8d147f 100644 --- a/internal/photoprism/batch/save_resolve.go +++ b/internal/photoprism/batch/save_resolve.go @@ -75,19 +75,15 @@ func ensureAlbumUID(title string) string { return album.AlbumUID } -// ensureLabelUID resolves or creates a label for the given title and returns its UID, -// restoring deleted labels when necessary. +// ensureLabelUID resolves or creates a label for the given title and returns +// its UID, restoring deleted labels when necessary. Routes through +// FirstOrCreateLabel (homophone-safe) so distinct names sharing a slug stay distinct. func ensureLabelUID(title string) string { if title == "" { return "" } - label, err := entity.FindLabel(title, true) - - if err != nil || label == nil || !label.HasUID() { - label = entity.FirstOrCreateLabel(entity.NewLabel(title, 0)) - err = nil - } + label := entity.FirstOrCreateLabel(entity.NewLabel(title, 0)) if label == nil || !label.HasUID() { log.Errorf("batch: failed to resolve label %s", clean.Log(title)) diff --git a/internal/photoprism/batch/save_resolve_test.go b/internal/photoprism/batch/save_resolve_test.go index a7c9a8223..18d69bdd8 100644 --- a/internal/photoprism/batch/save_resolve_test.go +++ b/internal/photoprism/batch/save_resolve_test.go @@ -87,3 +87,32 @@ func TestEnsureLabelUIDCreatesAndReuses(t *testing.T) { } }) } + +// Regression pin for the user-reported batch-edit homophone bug: +// when only `问` exists (slug `wen`) and the user adds `吻` (same pinyin +// slug `wen`), the batch resolver must create a NEW `吻` label instead +// of collapsing onto the existing `问`. The pre-fix code routed through +// FindLabel, whose slug fallback returned `问` and silently dropped the +// user's typed label. +func TestEnsureLabelUIDDoesNotCollapseHomophones(t *testing.T) { + first := entity.FirstOrCreateLabel(entity.NewLabel("问", 0)) + require.NotNil(t, first) + require.True(t, first.HasUID()) + + t.Cleanup(func() { + entity.FlushLabelCache() + _ = entity.Db().Unscoped().Delete(first).Error + }) + + uid := ensureLabelUID("吻") + require.True(t, rnd.IsUID(uid, entity.LabelUID)) + assert.NotEqual(t, first.LabelUID, uid) + + var resolved entity.Label + require.NoError(t, entity.Db().Where("label_uid = ?", uid).First(&resolved).Error) + assert.Equal(t, "吻", resolved.LabelName) + + t.Cleanup(func() { + _ = entity.Db().Unscoped().Delete(&resolved).Error + }) +} diff --git a/internal/photoprism/colors.go b/internal/photoprism/colors.go index 74afcaa37..a456a9758 100644 --- a/internal/photoprism/colors.go +++ b/internal/photoprism/colors.go @@ -45,6 +45,8 @@ func (m *MediaFile) Colors(thumbPath string) (perception colors.ColorPerception, colorCount := make(map[colors.Color]uint16) var mainColorCount uint16 + perception.Colors = make(colors.Colors, 0, width*height) + perception.Luminance = make(colors.LightMap, 0, width*height) for y := 0; y < height; y++ { for x := 0; x < width; x++ { diff --git a/internal/photoprism/colors_test.go b/internal/photoprism/colors_test.go index 4fe528bd3..eefc00296 100644 --- a/internal/photoprism/colors_test.go +++ b/internal/photoprism/colors_test.go @@ -26,44 +26,44 @@ func TestMediaFile_Colors_Testdata(t *testing.T) { */ expected := map[string]colors.ColorPerception{ "elephant_mono.jpg": { - Colors: colors.Colors{0x1, 0x1, 0x0, 0x0, 0x1, 0x0, 0x0, 0x0, 0x0}, + Colors: colors.Colors{0x0, 0x1, 0x0, 0x0, 0x1, 0x1, 0x0, 0x1, 0x1}, MainColor: 0, - Luminance: colors.LightMap{0xa, 0x9, 0x0, 0x0, 0x6, 0x0, 0x0, 0x0, 0x0}, + Luminance: colors.LightMap{0x1, 0x8, 0x2, 0x0, 0x7, 0x4, 0x0, 0x2, 0x2}, Chroma: 0, }, "sharks_blue.jpg": { - Colors: colors.Colors{0x6, 0x6, 0x6, 0x6, 0x6, 0x6, 0x5, 0x5, 0x6}, + Colors: colors.Colors{0x6, 0x6, 0x6, 0x6, 0x6, 0x6, 0x5, 0x5, 0x5}, MainColor: 6, - Luminance: colors.LightMap{0x9, 0x7, 0x5, 0x4, 0x3, 0x4, 0x3, 0x3, 0x3}, - Chroma: 89, + Luminance: colors.LightMap{0x9, 0x8, 0x8, 0x4, 0x4, 0x4, 0x3, 0x3, 0x3}, + Chroma: 84, }, "cat_black.jpg": { - Colors: colors.Colors{0x1, 0x2, 0x2, 0x2, 0x1, 0x2, 0x1, 0x3, 0x1}, - MainColor: 2, - Luminance: colors.LightMap{0x8, 0xc, 0x9, 0x4, 0x2, 0x7, 0xd, 0xd, 0x3}, - Chroma: 9, + Colors: colors.Colors{0x2, 0x1, 0x2, 0x1, 0x1, 0x1, 0x1, 0x1, 0x1}, + MainColor: 1, + Luminance: colors.LightMap{0x8, 0x9, 0x8, 0x9, 0x5, 0x4, 0xd, 0xd, 0xa}, + Chroma: 8, }, "cat_brown.jpg": { - Colors: colors.Colors{0x9, 0x3, 0x2, 0x1, 0x1, 0x2, 0x0, 0x6, 0x1}, - MainColor: 3, - Luminance: colors.LightMap{0x4, 0x5, 0xb, 0x4, 0x7, 0x3, 0x2, 0x5, 0x7}, - Chroma: 13, + Colors: colors.Colors{0x2, 0x2, 0x1, 0x2, 0x1, 0x2, 0x2, 0x2, 0x1}, + MainColor: 2, + Luminance: colors.LightMap{0x4, 0xb, 0x8, 0x6, 0xd, 0x9, 0x3, 0x6, 0x8}, + Chroma: 11, }, "cat_yellow_grey.jpg": { - Colors: colors.Colors{0x1, 0x2, 0x2, 0x9, 0x0, 0x3, 0xb, 0x0, 0x3}, - MainColor: 3, - Luminance: colors.LightMap{0x9, 0x5, 0xb, 0x6, 0x1, 0x6, 0xa, 0x1, 0x8}, - Chroma: 20, + Colors: colors.Colors{0x1, 0x2, 0x1, 0x9, 0x1, 0x9, 0x9, 0x1, 0x9}, + MainColor: 9, + Luminance: colors.LightMap{0x6, 0x7, 0x9, 0x7, 0x9, 0xa, 0x8, 0x8, 0x9}, + Chroma: 17, }, "Screenshot 2019-05-21 at 10.45.52.png": { - Colors: colors.Colors{4, 4, 4, 4, 4, 4, 4, 4, 4}, + Colors: colors.Colors{1, 1, 1, 4, 4, 4, 4, 4, 4}, MainColor: 4, - Luminance: colors.LightMap{14, 14, 14, 15, 15, 15, 15, 15, 15}, + Luminance: colors.LightMap{12, 12, 12, 15, 15, 15, 15, 15, 15}, Chroma: 1, }, } - if err := fastwalk.Walk(conf.ExamplesPath(), func(filename string, info os.FileMode) error { + if err := fastwalk.Walk(conf.SamplesPath(), func(filename string, info os.FileMode) error { if info.IsDir() || strings.HasPrefix(filepath.Base(filename), ".") { return nil } @@ -106,41 +106,41 @@ func TestMediaFile_Colors(t *testing.T) { c := config.TestConfig() t.Run("CatBrownJpg", func(t *testing.T) { - if mediaFile, err := NewMediaFile(c.ExamplesPath() + "/cat_brown.jpg"); err == nil { + if mediaFile, err := NewMediaFile(c.SamplesPath() + "/cat_brown.jpg"); err == nil { file, fileErr := mediaFile.Colors(c.ThumbCachePath()) t.Log(file, fileErr) assert.Nil(t, fileErr) - assert.Equal(t, 13, file.Chroma.Int()) - assert.Equal(t, "D", file.Chroma.Hex()) + assert.Equal(t, 11, file.Chroma.Int()) + assert.Equal(t, "B", file.Chroma.Hex()) assert.IsType(t, colors.Colors{}, file.Colors) - assert.Equal(t, "gold", file.MainColor.Name()) - assert.Equal(t, colors.Colors{0x9, 0x3, 0x2, 0x1, 0x1, 0x2, 0x0, 0x6, 0x1}, file.Colors) - assert.Equal(t, colors.LightMap{0x4, 0x5, 0xb, 0x4, 0x7, 0x3, 0x2, 0x5, 0x7}, file.Luminance) + assert.Equal(t, "brown", file.MainColor.Name()) + assert.Equal(t, colors.Colors{0x2, 0x2, 0x1, 0x2, 0x1, 0x2, 0x2, 0x2, 0x1}, file.Colors) + assert.Equal(t, colors.LightMap{0x4, 0xb, 0x8, 0x6, 0xd, 0x9, 0x3, 0x6, 0x8}, file.Luminance) } else { t.Error(err) } }) t.Run("FernRegular", func(t *testing.T) { - if mediaFile, err := NewMediaFile(c.ExamplesPath() + "/fern_green.jpg"); err == nil { + if mediaFile, err := NewMediaFile(c.SamplesPath() + "/fern_green.jpg"); err == nil { file, fileErr := mediaFile.Colors(c.ThumbCachePath()) t.Log(file, fileErr) assert.Nil(t, fileErr) - assert.Equal(t, 51, file.Chroma.Int()) - assert.Equal(t, "33", file.Chroma.Hex()) + assert.Equal(t, 60, file.Chroma.Int()) + assert.Equal(t, "3C", file.Chroma.Hex()) assert.IsType(t, colors.Colors{}, file.Colors) assert.Equal(t, "lime", file.MainColor.Name()) - assert.Equal(t, colors.Colors{0xa, 0x9, 0xa, 0x9, 0xa, 0xa, 0x9, 0x9, 0x9}, file.Colors) - assert.Equal(t, colors.LightMap{0xb, 0x4, 0xa, 0x6, 0x9, 0x8, 0x2, 0x3, 0x4}, file.Luminance) + assert.Equal(t, colors.Colors{0xa, 0xa, 0xa, 0xa, 0xa, 0xa, 0x9, 0x9, 0x9}, file.Colors) + assert.Equal(t, colors.LightMap{0x9, 0x9, 0x9, 0xa, 0x9, 0xa, 0x5, 0x6, 0x6}, file.Luminance) } else { t.Error(err) } }) t.Run("FernLarge", func(t *testing.T) { - if mediaFile, err := NewMediaFile(c.ExamplesPath() + "/fern_green.jpg"); err == nil { + if mediaFile, err := NewMediaFile(c.SamplesPath() + "/fern_green.jpg"); err == nil { thumbLarge := thumb.SizeColors thumbLarge.Height = 16 thumbLarge.Width = 16 @@ -160,46 +160,45 @@ func TestMediaFile_Colors(t *testing.T) { assert.IsType(t, colors.Colors{}, file.Colors) assert.Equal(t, "lime", file.MainColor.Name()) assert.Equal(t, colors.Colors{9, 10, 10, 10, 10, 10, 10, 10, 10}, file.Colors) - assert.Equal(t, colors.LightMap{5, 9, 9, 9, 9, 10, 10, 9, 11}, file.Luminance) + assert.Equal(t, colors.LightMap{6, 9, 9, 9, 9, 10, 10, 9, 11}, file.Luminance) } else { t.Error(err) } }) t.Run("ImgNum4120Jpg", func(t *testing.T) { - if mediaFile, err := NewMediaFile(c.ExamplesPath() + "/IMG_4120.JPG"); err == nil { + if mediaFile, err := NewMediaFile(c.SamplesPath() + "/IMG_4120.JPG"); err == nil { file, fileErr := mediaFile.Colors(c.ThumbCachePath()) t.Log(file, fileErr) assert.Nil(t, fileErr) - assert.Equal(t, 7, file.Chroma.Int()) - assert.Equal(t, "7", file.Chroma.Hex()) + assert.Equal(t, 9, file.Chroma.Int()) + assert.Equal(t, "9", file.Chroma.Hex()) assert.IsType(t, colors.Colors{}, file.Colors) assert.Equal(t, "blue", file.MainColor.Name()) - assert.Equal(t, colors.Colors{0x1, 0x6, 0x6, 0x1, 0x1, 0x9, 0x1, 0x0, 0x0}, file.Colors) + assert.Equal(t, colors.Colors{0x6, 0x6, 0x6, 0x1, 0x6, 0x9, 0x1, 0x1, 0x1}, file.Colors) } else { t.Error(err) } }) t.Run("LeavesGoldJpg", func(t *testing.T) { - if mediaFile, err := NewMediaFile(c.ExamplesPath() + "/leaves_gold.jpg"); err == nil { + if mediaFile, err := NewMediaFile(c.SamplesPath() + "/leaves_gold.jpg"); err == nil { file, fileErr := mediaFile.Colors(c.ThumbCachePath()) t.Log(file, fileErr) assert.Nil(t, fileErr) - assert.Equal(t, 16, file.Chroma.Int()) - assert.Equal(t, "10", file.Chroma.Hex()) + assert.Equal(t, 17, file.Chroma.Int()) + assert.Equal(t, "11", file.Chroma.Hex()) assert.IsType(t, colors.Colors{}, file.Colors) - assert.Equal(t, "gold", file.MainColor.Name()) - - assert.Equal(t, colors.Colors{0x0, 0x0, 0x2, 0x3, 0x3, 0x0, 0x2, 0x3, 0x0}, file.Colors) + assert.Equal(t, "brown", file.MainColor.Name()) + assert.Equal(t, colors.Colors{0x1, 0x2, 0x2, 0x2, 0x2, 0x2, 0x2, 0x2, 0x1}, file.Colors) } else { t.Error(err) } }) t.Run("RandomDocx", func(t *testing.T) { - file, err := NewMediaFile(c.ExamplesPath() + "/Random.docx") + file, err := NewMediaFile(c.SamplesPath() + "/Random.docx") require.NoError(t, err) p, colorErr := file.Colors(c.ThumbCachePath()) @@ -207,7 +206,7 @@ func TestMediaFile_Colors(t *testing.T) { t.Log(p) }) t.Run("AnimatedEarthThm", func(t *testing.T) { - file, err := NewMediaFile(c.ExamplesPath() + "/animated-earth.thm") + file, err := NewMediaFile(c.SamplesPath() + "/animated-earth.thm") if err != nil { assert.Error(t, err) return diff --git a/internal/photoprism/convert.go b/internal/photoprism/convert.go index 0d456875a..62a4890b4 100644 --- a/internal/photoprism/convert.go +++ b/internal/photoprism/convert.go @@ -10,10 +10,16 @@ import ( "github.com/karrick/godirwalk" "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/event" + "github.com/photoprism/photoprism/internal/ffmpeg" "github.com/photoprism/photoprism/internal/mutex" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/fs/disk" + "github.com/photoprism/photoprism/pkg/i18n" "github.com/photoprism/photoprism/pkg/list" + "github.com/photoprism/photoprism/pkg/log/status" + "github.com/photoprism/photoprism/pkg/media/video" ) // Convert represents a file format conversion worker. @@ -24,6 +30,7 @@ type Convert struct { darktableExclude fs.ExtList rawTherapeeExclude fs.ExtList imageMagickExclude fs.ExtList + ffmpegExclude video.Formats } // NewConvert returns a new file format conversion worker. @@ -34,11 +41,54 @@ func NewConvert(conf *config.Config) *Convert { darktableExclude: fs.NewExtList(conf.DarktableExclude()), rawTherapeeExclude: fs.NewExtList(conf.RawTherapeeExclude()), imageMagickExclude: fs.NewExtList(conf.ImageMagickExclude()), + ffmpegExclude: ffmpeg.Exclude(), } return c } +// FFmpegAllowed reports whether the media file's codec and container are both +// absent from the FFmpegExclude list and the file may therefore be handed to +// FFmpeg. The codec is taken from both the metadata and the built-in video +// probe so either detector can match. A file with unknown codec and unknown +// container passes through. +func (w *Convert) FFmpegAllowed(f *MediaFile) bool { + if f == nil || len(w.ffmpegExclude) == 0 { + return true + } + + return !w.ffmpegExclude.Contains(f.MetaData().Codec, f.VideoInfo().VideoCodec, f.FileType().String()) +} + +// Cancel stops the current conversion operation. +func (w *Convert) Cancel() { + mutex.IndexWorker.Cancel() +} + +// insufficientStorage reports whether the converter must abort due to quota or low free disk space. +func (w *Convert) insufficientStorage() bool { + if !w.conf.InsufficientStorage() { + return false + } + + log.Errorf("convert: aborting due to insufficient storage") + event.ErrorMsg(i18n.ErrInsufficientStorage) + return true +} + +// cancelInsufficientStorage logs the insufficient-storage cause once and cancels the run so the +// directory walk stops, instead of failing every remaining file when the disk filled mid-convert. +// It is called from worker goroutines when a conversion leaf reports status.ErrInsufficientStorage. +func (w *Convert) cancelInsufficientStorage() { + if mutex.IndexWorker.Canceled() { + return + } + + log.Errorf("convert: aborting due to insufficient storage") + event.ErrorMsg(i18n.ErrInsufficientStorage) + w.Cancel() +} + // Start converts all files in the specified directory based on the current configuration. func (w *Convert) Start(dir string, ext []string, force bool) (err error) { defer func() { @@ -48,6 +98,13 @@ func (w *Convert) Start(dir string, ext []string, force bool) (err error) { } }() + // Reset the cached disk usage so a freshly freed disk is detected immediately. + disk.FlushFree() + + if w.insufficientStorage() { + return status.ErrInsufficientStorage + } + if err = mutex.IndexWorker.Start(); err != nil { return err } @@ -90,7 +147,13 @@ func (w *Convert) Start(dir string, ext []string, force bool) (err error) { }() if mutex.IndexWorker.Canceled() { - return errors.New("canceled") + return status.ErrCanceled + } + + // Stop the walk if storage drops below the threshold mid-convert. + if w.insufficientStorage() { + w.Cancel() + return status.ErrInsufficientStorage } isDir, _ := info.IsDirOrSymlinkToDir() @@ -129,5 +192,12 @@ func (w *Convert) Start(dir string, ext []string, force bool) (err error) { close(jobs) wg.Wait() + logWalkResult("convert", err) + + // A user-initiated Ctrl+C is expected; do not surface it as a CLI error. + if errors.Is(err, status.ErrCanceled) { + return nil + } + return err } diff --git a/internal/photoprism/convert_command.go b/internal/photoprism/convert_command.go index df07523e6..186cb53c9 100644 --- a/internal/photoprism/convert_command.go +++ b/internal/photoprism/convert_command.go @@ -2,6 +2,7 @@ package photoprism import ( "os/exec" + "strings" "github.com/photoprism/photoprism/pkg/media" ) @@ -9,8 +10,10 @@ import ( // ConvertCmd represents a command to be executed for converting a MediaFile. // including any options to be used for this. type ConvertCmd struct { - Cmd *exec.Cmd - Orientation media.Orientation + Cmd *exec.Cmd + Orientation media.Orientation + VerifyImage bool + RejectStderr []string } // String returns the conversion command as string e.g. for logging. @@ -33,6 +36,35 @@ func (c *ConvertCmd) ResetOrientation() *ConvertCmd { return c.WithOrientation(media.ResetOrientation) } +// WithImageVerification marks the command's output for a decode check before acceptance, +// so corrupt embedded previews are rejected and the loop tries the next command. +func (c *ConvertCmd) WithImageVerification() *ConvertCmd { + c.VerifyImage = true + return c +} + +// WithStderrRejection rejects the command's output when its stderr contains any of the given +// substrings, even on a zero exit code, so the loop tries the next converter. +func (c *ConvertCmd) WithStderrRejection(patterns ...string) *ConvertCmd { + c.RejectStderr = append(c.RejectStderr, patterns...) + return c +} + +// StderrRejected reports whether the given stderr output matches a rejection pattern. +func (c *ConvertCmd) StderrRejected(stderr string) bool { + if stderr == "" { + return false + } + + for _, pattern := range c.RejectStderr { + if pattern != "" && strings.Contains(stderr, pattern) { + return true + } + } + + return false +} + // NewConvertCmd returns a new file converter command with default options. func NewConvertCmd(cmd *exec.Cmd) *ConvertCmd { if cmd == nil { diff --git a/internal/photoprism/convert_command_test.go b/internal/photoprism/convert_command_test.go index fa0437bd0..b6077269e 100644 --- a/internal/photoprism/convert_command_test.go +++ b/internal/photoprism/convert_command_test.go @@ -32,6 +32,39 @@ func TestNewConvertCmd(t *testing.T) { assert.Equal(t, "/usr/bin/sips -Z 123 -s format jpeg --out file.jpeg file.heic", result.String()) assert.Equal(t, media.ResetOrientation, result.Orientation) }) + t.Run("WithImageVerification", func(t *testing.T) { + result := NewConvertCmd( + exec.Command("exiftool", "-q", "-q", "-b", "-PreviewImage", "file.cr3"), + ) + assert.False(t, result.VerifyImage) + assert.Same(t, result, result.WithImageVerification()) + assert.True(t, result.VerifyImage) + }) + t.Run("WithStderrRejection", func(t *testing.T) { + result := NewConvertCmd( + exec.Command("rawtherapee-cli", "-o", "file.jpg", "-c", "file.cr3"), + ) + assert.Empty(t, result.RejectStderr) + assert.Same(t, result, result.WithStderrRejection("first error", "second error")) + assert.Equal(t, []string{"first error", "second error"}, result.RejectStderr) + }) +} + +func TestConvertCmd_StderrRejected(t *testing.T) { + cmd := NewConvertCmd(exec.Command("rawtherapee-cli", "-c", "file.cr3")).WithStderrRejection("Cannot use camera white balance") + t.Run("Match", func(t *testing.T) { + assert.True(t, cmd.StderrRejected("Processing...\nCannot use camera white balance.\n")) + }) + t.Run("NoMatch", func(t *testing.T) { + assert.False(t, cmd.StderrRejected("Warning: sidecar file requested but not found for: file.cr3")) + }) + t.Run("EmptyStderr", func(t *testing.T) { + assert.False(t, cmd.StderrRejected("")) + }) + t.Run("NoPatterns", func(t *testing.T) { + plain := NewConvertCmd(exec.Command("darktable-cli", "file.cr3", "file.jpg")) + assert.False(t, plain.StderrRejected("Cannot use camera white balance.")) + }) } func TestNewConvertCmds(t *testing.T) { diff --git a/internal/photoprism/convert_fix_test.go b/internal/photoprism/convert_fix_test.go index 2d84916a4..59a0980c5 100644 --- a/internal/photoprism/convert_fix_test.go +++ b/internal/photoprism/convert_fix_test.go @@ -22,7 +22,7 @@ func TestConvert_FixJpeg(t *testing.T) { convert := NewConvert(cnf) t.Run("ElephantsJpg", func(t *testing.T) { - fileName := filepath.Join(cnf.ExamplesPath(), "elephants.jpg") + fileName := filepath.Join(cnf.SamplesPath(), "elephants.jpg") outputName := filepath.Join(cnf.MediaFileCachePath("b10447b54c3330eb13566735322e971cc1dcbc41"), "b10447b54c3330eb13566735322e971cc1dcbc41.jpg") diff --git a/internal/photoprism/convert_image.go b/internal/photoprism/convert_image.go index dd5c521bb..2f25f753f 100644 --- a/internal/photoprism/convert_image.go +++ b/internal/photoprism/convert_image.go @@ -15,7 +15,9 @@ import ( "github.com/photoprism/photoprism/internal/thumb" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/fs/disk" "github.com/photoprism/photoprism/pkg/http/header" + "github.com/photoprism/photoprism/pkg/log/status" "github.com/photoprism/photoprism/pkg/media" ) @@ -69,8 +71,11 @@ func (w *Convert) ToImage(f *MediaFile, force bool) (result *MediaFile, err erro } } + // Refuse to write a new file if storage is read-only or insufficient. if !w.conf.SidecarWritable() { return nil, fmt.Errorf("convert: disabled in read-only mode (%s)", clean.Log(f.RootRelName())) + } else if w.conf.InsufficientStorage() { + return nil, status.ErrInsufficientStorage } fileName := f.RelName(w.conf.OriginalsPath()) @@ -87,8 +92,10 @@ func (w *Convert) ToImage(f *MediaFile, force bool) (result *MediaFile, err erro start := time.Now() - // PNG, GIF, BMP, TIFF, and WebP can be handled natively. - if f.IsImageOther() { + // PNG, GIF, BMP, TIFF, HEIC/HEIF, AVIF, and WebP are handled natively. JPEG XL only when + // "djxl" is unavailable: some libvips builds report JPEG XL support but mis-render files + // without erroring, so the reference "djxl" decoder is preferred when present. + if f.IsImageOther() || (f.IsJpegXL() && thumb.JpegXLSupported() && w.conf.JpegXLEnabled() && w.conf.JpegXLDecoderBin() == "") { log.Infof("convert: converting %s to %s (%s)", clean.Log(filepath.Base(fileName)), clean.Log(filepath.Base(imageName)), f.FileType()) // Create PNG or JPEG image from source file. @@ -105,10 +112,12 @@ func (w *Convert) ToImage(f *MediaFile, force bool) (result *MediaFile, err erro if err == nil { log.Infof("convert: %s created in %s (%s)", clean.Log(filepath.Base(imageName)), time.Since(start), f.FileType()) return NewMediaFile(imageName) - } else if !f.IsTiff() && !f.IsWebp() { + } else if !f.IsTiff() && !f.IsWebp() && !f.IsHeic() && !f.IsAvif() && !f.IsJpegXL() { // See https://github.com/photoprism/photoprism/issues/1612 - // for TIFF file format compatibility. - return nil, err + // for TIFF file format compatibility. HEIC/HEIF, AVIF, and JPEG XL keep + // the external conversion fallback until we can rely on native libvips + // support in every supported runtime. + return nil, disk.AsInsufficientStorage(err) } } @@ -173,24 +182,45 @@ func (w *Convert) ToImage(f *MediaFile, force bool) (result *MediaFile, err erro log.Debugf("convert: %s (%s)", clean.Error(err), filepath.Base(cmd.Path)) continue } else if fs.FileExistsNotEmpty(imageName) { - log.Infof("convert: %s created in %s (%s)", clean.Log(filepath.Base(imageName)), time.Since(start), filepath.Base(cmd.Path)) - fileOrientation = c.Orientation - break + // The command wrote the target file directly (e.g. Darktable, RawTherapee). } else if res := out.Bytes(); len(res) < 512 || !mimetype.Detect(res).Is(expectedMime) { continue } else if err = os.WriteFile(imageName, res, fs.ModeFile); err != nil { log.Tracef("convert: %s (%s)", err, filepath.Base(cmd.Path)) continue - } else { - log.Infof("convert: %s created in %s (%s)", clean.Log(filepath.Base(imageName)), time.Since(start), filepath.Base(cmd.Path)) - fileOrientation = c.Orientation - break } + + // Reject output flagged untrustworthy by its stderr (e.g. a RawTherapee render of an + // unsupported sensor) so the loop falls back to the next converter. + if c.StderrRejected(stderr.String()) { + log.Debugf("convert: discarding %s from %s (untrustworthy output)", clean.Log(filepath.Base(imageName)), filepath.Base(cmd.Path)) + if removeErr := os.Remove(imageName); removeErr != nil && !os.IsNotExist(removeErr) { + log.Tracef("convert: %s (%s)", removeErr, filepath.Base(cmd.Path)) + } + continue + } + + // Reject undecodable output (e.g. a truncated/bogus embedded RAW preview that passed + // the MIME sniff) so the loop tries the next converter instead of indexing a file + // whose thumbnails will fail. + if c.VerifyImage { + if err = thumb.Verify(imageName); err != nil { + log.Debugf("convert: discarding undecodable %s from %s (%s)", clean.Log(filepath.Base(imageName)), filepath.Base(cmd.Path), clean.Error(err)) + if removeErr := os.Remove(imageName); removeErr != nil && !os.IsNotExist(removeErr) { + log.Tracef("convert: %s (%s)", removeErr, filepath.Base(cmd.Path)) + } + continue + } + } + + log.Infof("convert: %s created in %s (%s)", clean.Log(filepath.Base(imageName)), time.Since(start), filepath.Base(cmd.Path)) + fileOrientation = c.Orientation + break } // Ok? if err != nil { - return nil, err + return nil, disk.AsInsufficientStorage(err) } // Create a MediaFile instance from the generated file. diff --git a/internal/photoprism/convert_image_jpeg.go b/internal/photoprism/convert_image_jpeg.go index 84684275f..77a213039 100644 --- a/internal/photoprism/convert_image_jpeg.go +++ b/internal/photoprism/convert_image_jpeg.go @@ -8,6 +8,7 @@ import ( "github.com/photoprism/photoprism/internal/ffmpeg" "github.com/photoprism/photoprism/internal/ffmpeg/encode" + "github.com/photoprism/photoprism/internal/raw" ) // JpegConvertCmds returns the supported commands for converting a MediaFile to JPEG, sorted by priority. @@ -21,10 +22,11 @@ func (w *Convert) JpegConvertCmds(f *MediaFile, jpegName string, xmpName string) // Add suitable conversion commands depending on the file type, codec, runtime environment, and configuration. fileExt := f.Extension() maxSize := strconv.Itoa(w.conf.JpegSize()) + rawEnabled := w.conf.RawEnabled() // On a Mac, use the Apple Scriptable image processing system to convert images to JPEG, // see https://ss64.com/osx/sips.html. - if (f.IsRaw() || f.IsHeif()) && w.conf.SipsEnabled() && w.sipsExclude.Allow(fileExt) { + if (f.IsRaw() && rawEnabled || f.IsHeif()) && w.conf.SipsEnabled() && w.sipsExclude.Allow(fileExt) { result = append(result, NewConvertCmd( // #nosec G204 -- arguments are built from validated config and file paths. exec.Command(w.conf.SipsBin(), "-Z", maxSize, "-s", "format", "jpeg", "--out", jpegName, f.FileName())), @@ -32,7 +34,7 @@ func (w *Convert) JpegConvertCmds(f *MediaFile, jpegName string, xmpName string) } // Use FFmpeg to extract video stills from videos, e.g. to use them as cover images. - if f.IsAnimated() && !f.IsWebp() && w.conf.FFmpegEnabled() { + if f.IsAnimated() && !f.IsWebp() && w.conf.FFmpegEnabled() && w.FFmpegAllowed(f) { result = append(result, NewConvertCmd( ffmpeg.ExtractJpegImageCmd(f.FileName(), jpegName, encode.NewPreviewImageOptions(w.conf.FFmpegBin(), f.Duration()))), ) @@ -47,68 +49,55 @@ func (w *Convert) JpegConvertCmds(f *MediaFile, jpegName string, xmpName string) ) } - // Convert RAW files to JPEG with Darktable and/or RawTherapee. - if f.IsRaw() && w.conf.RawEnabled() { - if w.conf.DarktableEnabled() && w.darktableExclude.Allow(fileExt) { - var args []string - - // Set RAW, XMP, and JPEG filenames. - if xmpName != "" { - args = []string{f.FileName(), xmpName, jpegName} - } else { - args = []string{f.FileName(), jpegName} + // Convert RAW files to JPEG: Darktable/RawTherapee render when RAW conversion is enabled, while + // ExifTool preview extraction also runs when rendering is disabled, so existing previews stay usable. + if f.IsRaw() { + if rawEnabled { + if w.conf.DarktableEnabled() && w.darktableExclude.Allow(fileExt) { + cmd, mutex := raw.DarktableCmd(raw.DarktableOptions{ + Bin: w.conf.DarktableBin(), + RawName: f.FileName(), + XmpName: xmpName, + JpegName: jpegName, + MaxSize: w.conf.JpegSize(), + Presets: w.conf.RawPresets(), + ConfigDir: conf.DarktableConfigPath(), + CacheDir: conf.DarktableCachePath(), + }) + useMutex = mutex + result = append(result, NewConvertCmd(cmd)) } - // Set RAW to JPEG conversion options. - if w.conf.RawPresets() { - useMutex = true // can run one instance only with presets enabled - args = append(args, "--width", maxSize, "--height", maxSize, "--hq", "true", "--upscale", "false") - } else { - useMutex = false // --apply-custom-presets=false disables locking - args = append(args, "--apply-custom-presets", "false", "--width", maxSize, "--height", maxSize, "--hq", "true", "--upscale", "false") + // Render the RAW with RawTherapee when Darktable is unavailable or fails. For formats in the + // discard set (e.g. CR3) the output is rejected on an untrustworthy decode (raw.DecoderErrors) + // so the embedded preview wins; other RAW formats (e.g. .raw/.kdc) keep the render because + // RawTherapee may be their only working decoder. + if w.conf.RawTherapeeEnabled() && w.rawTherapeeExclude.Allow(fileExt) { + profile := filepath.Join(conf.AssetsPath(), "profiles", "raw.pp3") + + rtCmd := NewConvertCmd( + raw.TherapeeCmd(w.conf.RawTherapeeBin(), f.FileName(), jpegName, profile, int(w.conf.JpegQuality())), + ) + + if raw.DiscardRenderOnWarning(fileExt) { + rtCmd = rtCmd.WithStderrRejection(raw.DecoderErrors...) + } + + result = append(result, rtCmd) } - - // Set library, config, and cache location. - args = append(args, "--core", "--library", ":memory:") - - if dir := conf.DarktableConfigPath(); dir != "" { - args = append(args, "--configdir", dir) - } - - if dir := conf.DarktableCachePath(); dir != "" { - args = append(args, "--cachedir", dir) - } - - result = append(result, NewConvertCmd( - // #nosec G204 -- arguments are built from validated config and file paths. - exec.Command(w.conf.DarktableBin(), args...)), - ) } - if w.conf.RawTherapeeEnabled() && w.rawTherapeeExclude.Allow(fileExt) { - jpegQuality := fmt.Sprintf("-j%d", w.conf.JpegQuality()) - profile := filepath.Join(conf.AssetsPath(), "profiles", "raw.pp3") - - args := []string{"-o", jpegName, "-p", profile, "-s", "-d", jpegQuality, "-js3", "-b8", "-c", f.FileName()} - - result = append(result, NewConvertCmd( - // #nosec G204 -- arguments are built from validated config and file paths. - exec.Command(w.conf.RawTherapeeBin(), args...)), - ) + // Extract the embedded camera preview (largest first): the fallback after the RAW developers, + // and the only option when RAW rendering is disabled. Colors stay correct for sensors they + // cannot identify (recent Canon CR3 bodies otherwise come out magenta). Skipped if unusable. + if w.conf.ExifToolEnabled() && raw.PreviewExtAllowed(fileExt) { + result = append(result, NewConvertCmd(raw.ExifToolJpgFromRawCmd(w.conf.ExifToolBin(), f.FileName())).WithImageVerification()) + result = append(result, NewConvertCmd(raw.ExifToolPreviewImageCmd(w.conf.ExifToolBin(), f.FileName())).WithImageVerification()) } } - // Use ExifTool to extract JPEG thumbnails from Digital Negative (DNG) files. - if f.IsDng() && w.conf.ExifToolEnabled() { - // Example: exiftool -b -PreviewImage -w IMG_4691.DNG.jpg IMG_4691.DNG - result = append(result, NewConvertCmd( - // #nosec G204 -- arguments are built from validated config and file paths. - exec.Command(w.conf.ExifToolBin(), "-q", "-q", "-b", "-PreviewImage", f.FileName())), - ) - } - - // Use "djxl" to convert JPEG XL images if installed and enabled. - if f.IsJpegXL() && w.conf.JpegXLEnabled() { + // Use "djxl" to convert JPEG XL images as a fallback when libvips lacks native support. + if f.IsJpegXL() && w.conf.JpegXLEnabled() && w.conf.JpegXLDecoderBin() != "" { result = append(result, NewConvertCmd( // #nosec G204 -- arguments are built from validated config and file paths. exec.Command(w.conf.JpegXLDecoderBin(), f.FileName(), jpegName)), @@ -142,8 +131,20 @@ func (w *Convert) JpegConvertCmds(f *MediaFile, jpegName string, xmpName string) } } + // Use ExifTool to extract embedded Photoshop thumbnails as a lightweight fallback + // when full rasterization of TIFF/PSD previews is unavailable or fails. + if (f.IsTiff() || f.IsPsd()) && w.conf.ExifToolEnabled() { + result = append(result, NewConvertCmd( + // #nosec G204 -- arguments are built from validated config and file paths. + exec.Command(w.conf.ExifToolBin(), "-q", "-q", "-b", "-PhotoshopThumbnail", f.FileName())).WithImageVerification(), + ) + } + // No suitable converter found? if len(result) == 0 { + if f.IsAnimated() && w.conf.FFmpegEnabled() && !w.FFmpegAllowed(f) { + return result, useMutex, fmt.Errorf("format %s is on the FFmpeg exclude list", w.ffmpegExclude.Match(f.MetaData().Codec, f.VideoInfo().VideoCodec, f.FileType().String())) + } return result, useMutex, fmt.Errorf("file type %s not supported", f.FileType()) } diff --git a/internal/photoprism/convert_image_png.go b/internal/photoprism/convert_image_png.go index d8c5512b8..c61b575be 100644 --- a/internal/photoprism/convert_image_png.go +++ b/internal/photoprism/convert_image_png.go @@ -21,9 +21,15 @@ func (w *Convert) PngConvertCmds(f *MediaFile, pngName string) (result ConvertCm fileExt := f.Extension() maxSize := strconv.Itoa(w.conf.PngSize()) + // Unlike JpegConvertCmds, this builder does not have a Darktable/RawTherapee renderer or an embedded preview + // fallback for converting RAW images to PNG — see internal/raw/README.md for more information. + if f.IsRaw() && w.conf.RawEnabled() { + log.Debugf("convert: PNG is not a supported target format for %s files", f.FileType().ToUpper()) + } + // On a Mac, use the Apple Scriptable image processing system to convert images to PNG, // see https://ss64.com/osx/sips.html. - if (f.IsRaw() || f.IsHeif()) && w.conf.SipsEnabled() && w.sipsExclude.Allow(fileExt) { + if f.IsHeif() && w.conf.SipsEnabled() && w.sipsExclude.Allow(fileExt) { result = append(result, NewConvertCmd( // #nosec G204 -- arguments are built from validated config and file paths. exec.Command(w.conf.SipsBin(), "-Z", maxSize, "-s", "format", "png", "--out", pngName, f.FileName())), @@ -31,7 +37,7 @@ func (w *Convert) PngConvertCmds(f *MediaFile, pngName string) (result ConvertCm } // Use FFmpeg to extract video stills from videos, e.g. to use them as cover images. - if f.IsAnimated() && !f.IsWebp() && w.conf.FFmpegEnabled() { + if f.IsAnimated() && !f.IsWebp() && w.conf.FFmpegEnabled() && w.FFmpegAllowed(f) { // Use "ffmpeg" to extract a PNG still image from the video. result = append(result, NewConvertCmd( ffmpeg.ExtractPngImageCmd(f.FileName(), pngName, encode.NewPreviewImageOptions(w.conf.FFmpegBin(), f.Duration()))), @@ -47,8 +53,8 @@ func (w *Convert) PngConvertCmds(f *MediaFile, pngName string) (result ConvertCm ) } - // Use "djxl" to convert JPEG XL images if installed and enabled. - if f.IsJpegXL() && w.conf.JpegXLEnabled() { + // Use "djxl" to convert JPEG XL images as a fallback when libvips lacks native support. + if f.IsJpegXL() && w.conf.JpegXLEnabled() && w.conf.JpegXLDecoderBin() != "" { result = append(result, NewConvertCmd( // #nosec G204 -- arguments are built from validated config and file paths. exec.Command(w.conf.JpegXLDecoderBin(), f.FileName(), pngName)), @@ -91,6 +97,9 @@ func (w *Convert) PngConvertCmds(f *MediaFile, pngName string) (result ConvertCm // No suitable converter found? if len(result) == 0 { + if f.IsAnimated() && w.conf.FFmpegEnabled() && !w.FFmpegAllowed(f) { + return result, useMutex, fmt.Errorf("format %s is on the FFmpeg exclude list", w.ffmpegExclude.Match(f.MetaData().Codec, f.VideoInfo().VideoCodec, f.FileType().String())) + } return result, useMutex, fmt.Errorf("file type %s not supported", f.FileType()) } diff --git a/internal/photoprism/convert_image_test.go b/internal/photoprism/convert_image_test.go index 08b51a872..a663267d4 100644 --- a/internal/photoprism/convert_image_test.go +++ b/internal/photoprism/convert_image_test.go @@ -9,6 +9,8 @@ import ( "github.com/stretchr/testify/assert" "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/raw" + "github.com/photoprism/photoprism/internal/thumb" "github.com/photoprism/photoprism/pkg/fs" ) @@ -21,10 +23,11 @@ func TestConvert_ToImage(t *testing.T) { initErr := cnf.InitializeTestData() assert.NoError(t, initErr) convert := NewConvert(cnf) + samplesPath := cnf.SamplesPath() t.Run("Video", func(t *testing.T) { - fileName := filepath.Join(cnf.ExamplesPath(), "gopher-video.mp4") - outputName := filepath.Join(cnf.SidecarPath(), cnf.ExamplesPath(), "gopher-video.mp4.jpg") + fileName := filepath.Join(cnf.SamplesPath(), "gopher-video.mp4") + outputName := filepath.Join(cnf.SidecarPath(), cnf.SamplesPath(), "gopher-video.mp4.jpg") _ = os.Remove(outputName) @@ -49,6 +52,38 @@ func TestConvert_ToImage(t *testing.T) { _ = os.Remove(outputName) }) + t.Run("JpegXL", func(t *testing.T) { + if cnf.JpegXLDecoderBin() == "" { + t.Skip("djxl must be available for the JPEG XL conversion path") + } + + fileName := filepath.Join(cnf.SamplesPath(), "dice.jxl") + outputName := filepath.Join(cnf.SidecarPath(), cnf.SamplesPath(), "dice.jxl.jpg") + + _ = os.Remove(outputName) + + mf, err := NewMediaFile(fileName) + + if err != nil { + t.Fatal(err) + } + + assert.True(t, mf.IsJpegXL()) + + img, err := convert.ToImage(mf, false) + + if err != nil { + t.Fatal(err) + } + + // With djxl available the native libvips path is skipped (some builds + // mis-render JPEG XL); the djxl-produced preview must be decodable. + assert.Equal(t, outputName, img.FileName()) + assert.True(t, img.IsPreviewImage()) + assert.NoError(t, thumb.Verify(img.FileName())) + + _ = os.Remove(outputName) + }) t.Run("Raw", func(t *testing.T) { jpegFilename := filepath.Join(cnf.ImportPath(), "fern_green.jpg") @@ -171,6 +206,80 @@ func TestConvert_ToImage(t *testing.T) { _ = imageFile.Remove() }) + t.Run("JpegXL", func(t *testing.T) { + if !cnf.JpegXLEnabled() { + t.Skip("JPEG XL support requires libvips or djxl") + } + + jxlFile := filepath.Join(samplesPath, "dice.jxl") + + mediaFile, err := NewMediaFile(jxlFile) + if err != nil { + t.Fatal(err) + } + + imageFile, err := convert.ToImage(mediaFile, false) + if err != nil { + t.Fatal(err) + } + + assert.True(t, fs.FileExists(imageFile.FileName())) + assert.Equal(t, fs.ImageJpeg, imageFile.FileType()) + assert.Greater(t, imageFile.Width(), 0) + assert.Greater(t, imageFile.Height(), 0) + + _ = imageFile.Remove() + }) + t.Run("Layered16BitTiff", func(t *testing.T) { + tiffFile := filepath.Join(samplesPath, "layered-16bit-small.tif") + + mediaFile, err := NewMediaFile(tiffFile) + if err != nil { + t.Fatal(err) + } + + imageFile, err := convert.ToImage(mediaFile, false) + if err != nil { + t.Fatal(err) + } + + assert.True(t, fs.FileExists(imageFile.FileName())) + assert.Equal(t, fs.ImageJpeg, imageFile.FileType()) + assert.Greater(t, imageFile.Width(), 0) + assert.Greater(t, imageFile.Height(), 0) + + _ = imageFile.Remove() + }) + t.Run("PsdWithoutImageMagick", func(t *testing.T) { + if !cnf.ExifToolEnabled() { + t.Skip("ExifTool must be available for PSD preview fallback") + } + + psdFile := filepath.Join(samplesPath, "photoshop-standard-small.psd") + cnf.Options().DisableImageMagick = true + t.Cleanup(func() { + cnf.Options().DisableImageMagick = false + }) + + mediaFile, err := NewMediaFile(psdFile) + if err != nil { + t.Fatal(err) + } + + imageFile, err := convert.ToImage(mediaFile, false) + if err != nil { + t.Fatal(err) + } + + assert.True(t, fs.FileExists(imageFile.FileName())) + assert.Equal(t, fs.ImageJpeg, imageFile.FileType()) + assert.Greater(t, imageFile.Width(), 0) + assert.Greater(t, imageFile.Height(), 0) + assert.Less(t, imageFile.Width(), mediaFile.Width()) + assert.Less(t, imageFile.Height(), mediaFile.Height()) + + _ = imageFile.Remove() + }) t.Run("DoNotConvertThumb", func(t *testing.T) { thumbFile := fs.Abs("./testdata/animated-earth.thm") @@ -192,6 +301,303 @@ func TestConvert_ToImage(t *testing.T) { }) } +func TestConvert_JpegConvertCmds(t *testing.T) { + cnf := config.TestConfig() + + if !cnf.ExifToolEnabled() { + t.Skip("ExifTool must be available for PSD preview fallback") + } + + cnf.Options().DisableImageMagick = true + t.Cleanup(func() { + cnf.Options().DisableImageMagick = false + }) + + convert := NewConvert(cnf) + psdFile := filepath.Join(cnf.SamplesPath(), "photoshop-standard-small.psd") + jpegFile := filepath.Join(cnf.SamplesPath(), "photoshop-standard-small.jpg") + + mediaFile, err := NewMediaFile(psdFile) + if err != nil { + t.Fatal(err) + } + + cmds, useMutex, err := convert.JpegConvertCmds(mediaFile, jpegFile, "") + if err != nil { + t.Fatal(err) + } + + assert.False(t, useMutex) + assert.NotEmpty(t, cmds) + + found := false + for _, cmd := range cmds { + if strings.Contains(cmd.String(), "-PhotoshopThumbnail") { + found = true + break + } + } + + assert.True(t, found) +} + +// TestConvert_JpegConvertCmds_RawEmbeddedPreview verifies that RAW inputs emit +// ExifTool embedded-preview extraction commands (largest-first) ordered after the +// RAW developers (Darktable and RawTherapee), so an unsupported camera falls back +// to the camera-rendered JPEG instead of a wrong-color demosaic. +func TestConvert_JpegConvertCmds_RawEmbeddedPreview(t *testing.T) { + cnf := config.TestConfig() + + if !cnf.ExifToolEnabled() { + t.Skip("ExifTool must be available for the RAW embedded-preview fallback") + } + + convert := NewConvert(cnf) + rawFile := filepath.Join(cnf.SamplesPath(), "canon_eos_6d.dng") + jpegFile := filepath.Join(cnf.SamplesPath(), "canon_eos_6d.dng.jpg") + + mediaFile, err := NewMediaFile(rawFile) + if err != nil { + t.Fatal(err) + } + + cmds, _, err := convert.JpegConvertCmds(mediaFile, jpegFile, "") + if err != nil { + t.Fatal(err) + } + + assert.NotEmpty(t, cmds) + + // Record the position of each command in the priority-ordered list. + jpgFromRaw, previewImage, rawTherapee := -1, -1, -1 + var rawTherapeeCmd *ConvertCmd + for i, cmd := range cmds { + s := cmd.String() + switch { + case jpgFromRaw < 0 && strings.Contains(s, "-JpgFromRaw"): + jpgFromRaw = i + case previewImage < 0 && strings.Contains(s, "-PreviewImage"): + previewImage = i + case rawTherapee < 0 && strings.Contains(s, filepath.Base(cnf.RawTherapeeBin())): + rawTherapee = i + rawTherapeeCmd = cmd + } + } + + assert.GreaterOrEqual(t, jpgFromRaw, 0, "expected a -JpgFromRaw extraction command") + assert.GreaterOrEqual(t, previewImage, 0, "expected a -PreviewImage extraction command") + assert.Less(t, jpgFromRaw, previewImage, "JpgFromRaw must be tried before PreviewImage") + if cnf.RawTherapeeEnabled() { + assert.GreaterOrEqual(t, rawTherapee, 0, "expected a RawTherapee command") + assert.Less(t, rawTherapee, jpgFromRaw, "RawTherapee must be tried before the embedded preview") + assert.Empty(t, rawTherapeeCmd.RejectStderr, "a non-gated RAW format (.dng) must keep its render, so no stderr rejection is attached") + } +} + +// TestConvert_JpegConvertCmds_DiscardRenderGate verifies that the RawTherapee stderr rejection is +// attached only for formats in the discard set (raw.DiscardRenderOnWarning, e.g. CR3), so a magenta +// CR3 falls back to its embedded preview, while formats RawTherapee alone can decode (e.g. .raw/.kdc) +// keep their render. +func TestConvert_JpegConvertCmds_DiscardRenderGate(t *testing.T) { + cnf := config.TestConfig() + + if !cnf.RawTherapeeEnabled() { + t.Skip("RawTherapee must be available for the discard-render gate") + } + + convert := NewConvert(cnf) + dir := t.TempDir() + + cases := []struct { + name, ext string + gated bool + }{ + {"Cr3", ".cr3", true}, + {"Raw", ".raw", false}, + {"Kdc", ".kdc", false}, + {"Cr2", ".cr2", false}, + } + + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + rawFile := filepath.Join(dir, "sample"+tc.ext) + if err := os.WriteFile(rawFile, []byte("raw"), fs.ModeFile); err != nil { + t.Fatal(err) + } + + mediaFile, err := NewMediaFile(rawFile) + if err != nil { + t.Fatal(err) + } + assert.True(t, mediaFile.IsRaw(), "%s must be recognized as RAW", tc.ext) + + cmds, _, err := convert.JpegConvertCmds(mediaFile, rawFile+".jpg", "") + if err != nil { + t.Fatal(err) + } + + var rtCmd *ConvertCmd + for _, cmd := range cmds { + if filepath.Base(cmd.Cmd.Path) == filepath.Base(cnf.RawTherapeeBin()) { + rtCmd = cmd + break + } + } + + if rtCmd == nil { + t.Fatalf("expected a RawTherapee command for %s", tc.ext) + } + + if tc.gated { + assert.Contains(t, rtCmd.RejectStderr, raw.WhiteBalanceError, "%s is gated, so its render must be rejected on a decode warning", tc.ext) + } else { + assert.Empty(t, rtCmd.RejectStderr, "%s is not gated, so its render must be kept", tc.ext) + } + }) + } +} + +// TestConvert_JpegConvertCmds_RawDisabled verifies that with RAW conversion disabled (--disable-raw) +// PhotoPrism only extracts an existing embedded preview and never renders the RAW with Darktable or +// RawTherapee. +func TestConvert_JpegConvertCmds_RawDisabled(t *testing.T) { + cnf := config.TestConfig() + + if !cnf.ExifToolEnabled() { + t.Skip("ExifTool must be available for the RAW embedded-preview fallback") + } + + origRaw := cnf.Options().DisableRaw + cnf.Options().DisableRaw = true + t.Cleanup(func() { + cnf.Options().DisableRaw = origRaw + }) + + convert := NewConvert(cnf) + rawFile := filepath.Join(cnf.SamplesPath(), "canon_eos_6d.dng") + jpegFile := filepath.Join(cnf.SamplesPath(), "canon_eos_6d.dng.jpg") + + mediaFile, err := NewMediaFile(rawFile) + if err != nil { + t.Fatal(err) + } + + cmds, _, err := convert.JpegConvertCmds(mediaFile, jpegFile, "") + if err != nil { + t.Fatal(err) + } + + assert.NotEmpty(t, cmds) + + previewImage := false + for _, cmd := range cmds { + base := filepath.Base(cmd.Cmd.Path) + assert.NotEqual(t, "darktable-cli", base, "Darktable must not run when RAW conversion is disabled") + assert.NotEqual(t, "rawtherapee-cli", base, "RawTherapee must not run when RAW conversion is disabled") + if strings.Contains(cmd.String(), "-PreviewImage") { + previewImage = true + } + } + + assert.True(t, previewImage, "embedded preview must still be extracted when RAW conversion is disabled") +} + +// TestConvert_JpegConvertCmds_HeifFallback verifies that the documented external +// fallback command is emitted for HEIC and AVIF inputs when libheif tooling +// (heif-dec / heif-convert) is available — see issue #5509. +func TestConvert_JpegConvertCmds_HeifFallback(t *testing.T) { + cnf := config.TestConfig() + + if !cnf.HeifConvertEnabled() { + t.Skip("heif-dec/heif-convert must be available for the HEIF fallback path") + } + + convert := NewConvert(cnf) + heifBin := filepath.Base(cnf.HeifConvertBin()) + + cases := []struct { + name, src, dst string + }{ + {"Heic", "iphone_15_pro.heic", "iphone_15_pro.heic.jpg"}, + {"Avif", "fox.profile0.8bpc.yuv420.avif", "fox.profile0.8bpc.yuv420.avif.jpg"}, + } + + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + srcFile := filepath.Join(cnf.SamplesPath(), tc.src) + dstFile := filepath.Join(cnf.SidecarPath(), cnf.SamplesPath(), tc.dst) + + mediaFile, err := NewMediaFile(srcFile) + if err != nil { + t.Fatal(err) + } + + cmds, useMutex, err := convert.JpegConvertCmds(mediaFile, dstFile, "") + if err != nil { + t.Fatal(err) + } + + assert.False(t, useMutex) + assert.NotEmpty(t, cmds) + + found := false + for _, cmd := range cmds { + s := cmd.String() + if strings.Contains(s, heifBin) && strings.Contains(s, srcFile) && strings.Contains(s, dstFile) { + found = true + break + } + } + + assert.True(t, found, "expected a %s fallback command for %s", heifBin, tc.src) + }) + } +} + +// TestConvert_JpegConvertCmds_JpegXLFallback verifies that the external "djxl" +// fallback command is emitted for JPEG XL inputs when the decoder is available, +// so runtimes whose libvips lacks JPEG XL support can still convert these files. +func TestConvert_JpegConvertCmds_JpegXLFallback(t *testing.T) { + cnf := config.TestConfig() + convert := NewConvert(cnf) + + if cnf.JpegXLDecoderBin() == "" { + t.Skip("djxl must be available for the JPEG XL fallback path") + } + + srcFile := filepath.Join(cnf.SamplesPath(), "dice.jxl") + dstFile := filepath.Join(t.TempDir(), "dice.jxl.jpg") + + mediaFile, err := NewMediaFile(srcFile) + if err != nil { + t.Fatal(err) + } + + if !mediaFile.IsJpegXL() { + t.Fatalf("%s not recognized as JPEG XL", srcFile) + } + + cmds, useMutex, err := convert.JpegConvertCmds(mediaFile, dstFile, "") + if err != nil { + t.Fatal(err) + } + + assert.False(t, useMutex) + assert.NotEmpty(t, cmds) + + djxlBin := filepath.Base(cnf.JpegXLDecoderBin()) + found := false + for _, cmd := range cmds { + s := cmd.String() + if strings.Contains(s, djxlBin) && strings.Contains(s, srcFile) && strings.Contains(s, dstFile) { + found = true + break + } + } + + assert.True(t, found, "expected a djxl fallback command for %s", srcFile) +} + func TestConvert_PngConvertCmds(t *testing.T) { cnf := config.TestConfig() convert := NewConvert(cnf) @@ -221,4 +627,16 @@ func TestConvert_PngConvertCmds(t *testing.T) { t.Logf("commands: %#v", cmds) }) + t.Run("Raw", func(t *testing.T) { + // RAW is converted to JPEG, not PNG: no converter command is emitted and the call reports + // the format as unsupported (see internal/raw/README.md). + mediaFile, err := NewMediaFile(filepath.Join(cnf.SamplesPath(), "canon_eos_6d.dng")) + if err != nil { + t.Fatal(err) + } + + cmds, _, err := convert.PngConvertCmds(mediaFile, filepath.Join(t.TempDir(), "canon_eos_6d.png")) + assert.Error(t, err) + assert.Empty(t, cmds) + }) } diff --git a/internal/photoprism/convert_sidecar_json_test.go b/internal/photoprism/convert_sidecar_json_test.go index 231764d83..aff262951 100644 --- a/internal/photoprism/convert_sidecar_json_test.go +++ b/internal/photoprism/convert_sidecar_json_test.go @@ -16,7 +16,7 @@ func TestConvert_ToJson(t *testing.T) { convert := NewConvert(c) t.Run("GopherVideoMp4", func(t *testing.T) { - fileName := filepath.Join(c.ExamplesPath(), "gopher-video.mp4") + fileName := filepath.Join(c.SamplesPath(), "gopher-video.mp4") assert.Truef(t, fs.FileExists(fileName), "input file does not exist: %s", fileName) @@ -41,7 +41,7 @@ func TestConvert_ToJson(t *testing.T) { _ = os.Remove(jsonName) }) t.Run("ImgNum4120Jpg", func(t *testing.T) { - fileName := filepath.Join(c.ExamplesPath(), "IMG_4120.JPG") + fileName := filepath.Join(c.SamplesPath(), "IMG_4120.JPG") assert.Truef(t, fs.FileExists(fileName), "input file does not exist: %s", fileName) mf, err := NewMediaFile(fileName) @@ -65,7 +65,7 @@ func TestConvert_ToJson(t *testing.T) { _ = os.Remove(jsonName) }) t.Run("IphoneSevenHeic", func(t *testing.T) { - fileName := c.ExamplesPath() + "/iphone_7.heic" + fileName := c.SamplesPath() + "/iphone_7.heic" assert.True(t, fs.FileExists(fileName)) @@ -90,7 +90,7 @@ func TestConvert_ToJson(t *testing.T) { _ = os.Remove(jsonName) }) t.Run("IphoneFifteenProHeic", func(t *testing.T) { - fileName := c.ExamplesPath() + "/iphone_15_pro.heic" + fileName := c.SamplesPath() + "/iphone_15_pro.heic" assert.True(t, fs.FileExists(fileName)) diff --git a/internal/photoprism/convert_storage_test.go b/internal/photoprism/convert_storage_test.go new file mode 100644 index 000000000..1b77b04b6 --- /dev/null +++ b/internal/photoprism/convert_storage_test.go @@ -0,0 +1,103 @@ +package photoprism + +import ( + "errors" + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/mutex" + "github.com/photoprism/photoprism/pkg/fs/disk" + "github.com/photoprism/photoprism/pkg/log/status" +) + +func TestConvert_InsufficientStorage(t *testing.T) { + cfg := config.NewMinimalTestConfig(t.TempDir()) + convert := NewConvert(cfg) + require.NotNil(t, convert) + + // Reset the storage-check latch, which an earlier test may have tripped by probing a + // temp path that duf cannot resolve to a mount point. + config.DisableStorageCheck.Store(false) + + t.Run("Healthy", func(t *testing.T) { + disk.FlushFree() + t.Cleanup(disk.FlushFree) + disk.SetFree(cfg.StoragePath(), 999*disk.MB, 1000*disk.MB) + cfg.Options().FilesQuota = 0 + + assert.False(t, convert.insufficientStorage()) + }) + t.Run("StorageLow", func(t *testing.T) { + disk.FlushFree() + t.Cleanup(disk.FlushFree) + disk.SetFree(cfg.StoragePath(), 1*disk.MB, 1000*disk.MB) + cfg.Options().FilesQuota = 0 + + assert.True(t, convert.insufficientStorage()) + }) +} + +func TestConvert_cancelInsufficientStorage(t *testing.T) { + cfg := config.NewMinimalTestConfig(t.TempDir()) + convert := NewConvert(cfg) + require.NotNil(t, convert) + + t.Run("CancelsRunningWorker", func(t *testing.T) { + require.NoError(t, mutex.IndexWorker.Start()) + defer mutex.IndexWorker.Stop() + require.False(t, mutex.IndexWorker.Canceled()) + + convert.cancelInsufficientStorage() + assert.True(t, mutex.IndexWorker.Canceled()) + }) + t.Run("IdempotentWhenAlreadyCanceled", func(t *testing.T) { + require.NoError(t, mutex.IndexWorker.Start()) + defer mutex.IndexWorker.Stop() + mutex.IndexWorker.Cancel() + require.True(t, mutex.IndexWorker.Canceled()) + + convert.cancelInsufficientStorage() + assert.True(t, mutex.IndexWorker.Canceled()) + }) +} + +func TestConvert_ToImage_InsufficientStorage(t *testing.T) { + cfg := config.TestConfig() + convert := NewConvert(cfg) + + // Use a RAW source so ToImage actually attempts a write + // (preview images and missing files short-circuit before the storage gate). + mf, err := NewMediaFile(cfg.SamplesPath() + "/canon_eos_6d.dng") + require.NoError(t, err) + + disk.FlushFree() + t.Cleanup(disk.FlushFree) + disk.SetFree(cfg.StoragePath(), 1*disk.MB, 1000*disk.MB) + config.DisableStorageCheck.Store(false) + + _, err = convert.ToImage(mf, false) + + assert.Error(t, err) + assert.True(t, errors.Is(err, status.ErrInsufficientStorage), "expected status.ErrInsufficientStorage, got %v", err) +} + +func TestConvert_ToAvc_InsufficientStorage(t *testing.T) { + cfg := config.TestConfig() + convert := NewConvert(cfg) + + mf, err := NewMediaFile(cfg.SamplesPath() + "/gopher-video.mp4") + require.NoError(t, err) + + disk.FlushFree() + t.Cleanup(disk.FlushFree) + disk.SetFree(cfg.StoragePath(), 1*disk.MB, 1000*disk.MB) + config.DisableStorageCheck.Store(false) + + _, err = convert.ToAvc(mf, cfg.FFmpegEncoder(), false, false) + + assert.Error(t, err) + assert.True(t, errors.Is(err, status.ErrInsufficientStorage), "expected status.ErrInsufficientStorage, got %v", err) +} diff --git a/internal/photoprism/convert_test.go b/internal/photoprism/convert_test.go index b22718a73..95acdba0a 100644 --- a/internal/photoprism/convert_test.go +++ b/internal/photoprism/convert_test.go @@ -8,7 +8,10 @@ import ( "github.com/stretchr/testify/assert" "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/ffmpeg" + "github.com/photoprism/photoprism/internal/meta" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/media/video" ) func TestNewConvert(t *testing.T) { @@ -69,3 +72,66 @@ func TestConvert_Start(t *testing.T) { assert.NotEqual(t, oldHash, newHash, "Fingerprint of old and new JPEG file must not be the same") } + +// fakeMediaFile returns a MediaFile with no backing file but a pinned codec +// and filename, so MediaFile.Ok() reports false and MetaData()/FileType() +// return the pinned values without invoking ExifTool or stat'ing the disk. +func fakeMediaFile(codec, fileName string) *MediaFile { + return &MediaFile{ + fileName: fileName, + metaData: meta.Data{Codec: codec}, + } +} + +func TestConvert_FFmpegAllowed(t *testing.T) { + cnf := config.TestConfig() + convert := NewConvert(cnf) + + // NewConvert captures the current ffmpeg.Exclude(). Pin the field directly + // so the test stays deterministic regardless of what the global is set to. + convert.ffmpegExclude = video.NewFormats("magicyuv, avi") + + t.Run("NilFile", func(t *testing.T) { + assert.True(t, convert.FFmpegAllowed(nil)) + }) + t.Run("EmptyCodecAndType", func(t *testing.T) { + assert.True(t, convert.FFmpegAllowed(fakeMediaFile("", ""))) + }) + t.Run("AllowedCodec", func(t *testing.T) { + assert.True(t, convert.FFmpegAllowed(fakeMediaFile("avc1", "/tmp/clip.mp4"))) + }) + t.Run("ExcludedCodec", func(t *testing.T) { + assert.False(t, convert.FFmpegAllowed(fakeMediaFile("magicyuv", "/tmp/clip.mp4"))) + }) + t.Run("ExcludedCodecMixedCase", func(t *testing.T) { + assert.False(t, convert.FFmpegAllowed(fakeMediaFile("MagicYUV", "/tmp/clip.mp4"))) + }) + t.Run("ExcludedContainerOnly", func(t *testing.T) { + // Codec is unknown, but the container extension is on the list. + assert.False(t, convert.FFmpegAllowed(fakeMediaFile("", "/tmp/clip.avi"))) + }) + t.Run("AllowedContainer", func(t *testing.T) { + assert.True(t, convert.FFmpegAllowed(fakeMediaFile("", "/tmp/clip.mp4"))) + }) + t.Run("ExcludedByVideoInfo", func(t *testing.T) { + // The metadata codec is unknown, but the built-in video probe identifies it. + mf := &MediaFile{fileName: "/tmp/clip.mov", videoInfo: video.Info{VideoCodec: video.CodecMagicYUV}} + assert.False(t, convert.FFmpegAllowed(mf)) + }) + t.Run("EmptyExcludeList", func(t *testing.T) { + convert.ffmpegExclude = video.NewFormats("") + assert.True(t, convert.FFmpegAllowed(fakeMediaFile("magicyuv", "/tmp/clip.avi"))) + }) +} + +func TestNewConvert_CapturesFFmpegExclude(t *testing.T) { + // Snapshot and restore the package state so other tests aren't affected. + saved := ffmpeg.Exclude() + t.Cleanup(func() { ffmpeg.SetExclude(saved) }) + + ffmpeg.SetExclude(video.NewFormats("magicyuv")) + + convert := NewConvert(config.TestConfig()) + assert.False(t, convert.FFmpegAllowed(fakeMediaFile("magicyuv", "/tmp/clip.mp4"))) + assert.True(t, convert.FFmpegAllowed(fakeMediaFile("avc1", "/tmp/clip.mp4"))) +} diff --git a/internal/photoprism/convert_video_avc.go b/internal/photoprism/convert_video_avc.go index 40aa159d9..1377bd845 100644 --- a/internal/photoprism/convert_video_avc.go +++ b/internal/photoprism/convert_video_avc.go @@ -15,6 +15,8 @@ import ( "github.com/photoprism/photoprism/internal/ffmpeg/encode" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/fs/disk" + "github.com/photoprism/photoprism/pkg/log/status" ) // ToAvc converts a single video file to MPEG-4 AVC. @@ -34,6 +36,13 @@ func (w *Convert) ToAvc(f *MediaFile, encoder encode.Encoder, noMutex, force boo return nil, fmt.Errorf("convert: %s is empty", logFileName) } + // Skip files whose codec or container is on the FFmpeg exclude list. + if !w.FFmpegAllowed(f) { + format := clean.Log(w.ffmpegExclude.Match(f.MetaData().Codec, f.VideoInfo().VideoCodec, f.FileType().String())) + log.Warnf("convert: skipping %s because format %s is on the FFmpeg exclude list", logFileName, format) + return nil, fmt.Errorf("convert: format %s is excluded from FFmpeg processing", format) + } + // AVC video filename. var avcName string @@ -42,7 +51,7 @@ func (w *Convert) ToAvc(f *MediaFile, encoder encode.Encoder, noMutex, force boo avcName = fs.VideoMp4.FindFirst(f.FileName(), []string{w.conf.SidecarPath(), fs.PPHiddenPathname}, w.conf.OriginalsPath(), false) } else { // Convert MPEG-2 Transport Stream (M2TS) files to MPEG4 containers. - if f.IsM2TS() && w.conf.SidecarWritable() { + if f.IsM2TS() && w.conf.SidecarWritable() && !w.conf.InsufficientStorage() { if mp4Name, mp4Err := fs.FileName(f.FileName(), w.conf.SidecarPath(), w.conf.OriginalsPath(), fs.ExtMp4); mp4Err != nil { return nil, fmt.Errorf("convert: %s in %s (remux)", mp4Err, clean.Log(f.RootRelName())) } else if mp4Err = ffmpeg.RemuxFile(f.FileName(), mp4Name, encode.NewRemuxOptions(conf.FFmpegBin(), fs.VideoMp4, false)); mp4Err != nil { @@ -75,6 +84,8 @@ func (w *Convert) ToAvc(f *MediaFile, encoder encode.Encoder, noMutex, force boo // Check if the sidecar path is writable, otherwise no new AVC file can be created. if !w.conf.SidecarWritable() { return nil, fmt.Errorf("convert: cannot transcode %s because the sidecar path is not writable", logFileName) + } else if w.conf.InsufficientStorage() { + return nil, status.ErrInsufficientStorage } // Get relative filename for logging. @@ -158,10 +169,14 @@ func (w *Convert) ToAvc(f *MediaFile, encoder encode.Encoder, noMutex, force boo return nil, fmt.Errorf("convert: failed to remove %s (%s)", clean.Log(RootRelName(avcName)), err) } - // Try again using software encoder. - if encoder != encode.SoftwareAvc { + switch { + case disk.IsNoSpace(err): + // Do not retry on a full disk; surface the cause so the worker can abort the run. + return nil, disk.AsInsufficientStorage(err) + case encoder != encode.SoftwareAvc: + // Try again using software encoder. return w.ToAvc(f, encode.SoftwareAvc, true, false) - } else { + default: return nil, err } } diff --git a/internal/photoprism/convert_video_avc_test.go b/internal/photoprism/convert_video_avc_test.go index 2e597c496..bd37abca5 100644 --- a/internal/photoprism/convert_video_avc_test.go +++ b/internal/photoprism/convert_video_avc_test.go @@ -17,8 +17,8 @@ func TestConvert_ToAvc(t *testing.T) { conf := config.TestConfig() convert := NewConvert(conf) - fileName := filepath.Join(conf.ExamplesPath(), "gopher-video.mp4") - outputName := filepath.Join(conf.SidecarPath(), conf.ExamplesPath(), "gopher-video.mp4.avc") + fileName := filepath.Join(conf.SamplesPath(), "gopher-video.mp4") + outputName := filepath.Join(conf.SidecarPath(), conf.SamplesPath(), "gopher-video.mp4.avc") _ = os.Remove(outputName) @@ -47,8 +47,8 @@ func TestConvert_ToAvc(t *testing.T) { conf := config.TestConfig() convert := NewConvert(conf) - fileName := filepath.Join(conf.ExamplesPath(), "cat_black.jpg") - outputName := filepath.Join(conf.SidecarPath(), conf.ExamplesPath(), "cat_black.jpg.avc") + fileName := filepath.Join(conf.SamplesPath(), "cat_black.jpg") + outputName := filepath.Join(conf.SidecarPath(), conf.SamplesPath(), "cat_black.jpg.avc") _ = os.Remove(outputName) @@ -71,7 +71,7 @@ func TestConvert_AvcBitrate(t *testing.T) { convert := NewConvert(conf) t.Run("Low", func(t *testing.T) { - fileName := filepath.Join(conf.ExamplesPath(), "gopher-video.mp4") + fileName := filepath.Join(conf.SamplesPath(), "gopher-video.mp4") assert.Truef(t, fs.FileExists(fileName), "input file does not exist: %s", fileName) @@ -84,7 +84,7 @@ func TestConvert_AvcBitrate(t *testing.T) { assert.Equal(t, "1M", convert.AvcBitrate(mf)) }) t.Run("Medium", func(t *testing.T) { - fileName := filepath.Join(conf.ExamplesPath(), "gopher-video.mp4") + fileName := filepath.Join(conf.SamplesPath(), "gopher-video.mp4") assert.Truef(t, fs.FileExists(fileName), "input file does not exist: %s", fileName) @@ -100,7 +100,7 @@ func TestConvert_AvcBitrate(t *testing.T) { assert.Equal(t, "16M", convert.AvcBitrate(mf)) }) t.Run("High", func(t *testing.T) { - fileName := filepath.Join(conf.ExamplesPath(), "gopher-video.mp4") + fileName := filepath.Join(conf.SamplesPath(), "gopher-video.mp4") assert.Truef(t, fs.FileExists(fileName), "input file does not exist: %s", fileName) @@ -116,7 +116,7 @@ func TestConvert_AvcBitrate(t *testing.T) { assert.Equal(t, "25M", convert.AvcBitrate(mf)) }) t.Run("VeryHigh", func(t *testing.T) { - fileName := filepath.Join(conf.ExamplesPath(), "gopher-video.mp4") + fileName := filepath.Join(conf.SamplesPath(), "gopher-video.mp4") assert.Truef(t, fs.FileExists(fileName), "input file does not exist: %s", fileName) @@ -138,7 +138,7 @@ func TestConvert_TranscodeToAvcCmd(t *testing.T) { convert := NewConvert(conf) t.Run("MP4", func(t *testing.T) { - fileName := filepath.Join(conf.ExamplesPath(), "gopher-video.mp4") + fileName := filepath.Join(conf.SamplesPath(), "gopher-video.mp4") mf, err := NewMediaFile(fileName) if err != nil { @@ -155,7 +155,7 @@ func TestConvert_TranscodeToAvcCmd(t *testing.T) { assert.Contains(t, r.Args, "mp4") }) t.Run("Jpeg", func(t *testing.T) { - fileName := filepath.Join(conf.ExamplesPath(), "cat_black.jpg") + fileName := filepath.Join(conf.SamplesPath(), "cat_black.jpg") mf, err := NewMediaFile(fileName) if err != nil { diff --git a/internal/photoprism/convert_worker.go b/internal/photoprism/convert_worker.go index d5628bf99..a53ba0ab1 100644 --- a/internal/photoprism/convert_worker.go +++ b/internal/photoprism/convert_worker.go @@ -1,9 +1,12 @@ package photoprism import ( + "errors" "strings" + "github.com/photoprism/photoprism/internal/mutex" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/log/status" ) // ConvertJob represents a single media conversion task. @@ -15,9 +18,17 @@ type ConvertJob struct { // ConvertWorker processes ConvertJob messages serially on a worker goroutine. func ConvertWorker(jobs <-chan ConvertJob) { - convertErr := func(err error, job ConvertJob) { + // handleErr logs a conversion failure, or stops the run if the disk filled mid-convert. + // It returns true when the caller should skip the remaining steps for the current file. + handleErr := func(err error, job ConvertJob) bool { + if errors.Is(err, status.ErrInsufficientStorage) { + job.convert.cancelInsufficientStorage() + return true + } + fileName := job.file.RelName(job.convert.conf.OriginalsPath()) log.Errorf("convert: %s for %s", strings.TrimSpace(err.Error()), clean.Log(fileName)) + return false } for job := range jobs { @@ -26,6 +37,11 @@ func ConvertWorker(jobs <-chan ConvertJob) { continue } + // Drain remaining queued jobs without processing once the run was canceled. + if mutex.IndexWorker.Canceled() { + continue + } + // f is the media file to be converted. f := job.file @@ -36,7 +52,9 @@ func ConvertWorker(jobs <-chan ConvertJob) { // Create cover image. if _, err := job.convert.ToImage(f, job.force); err != nil { - convertErr(err, job) + if handleErr(err, job) { + continue + } } // Check if the file has a playable format or has already been transcoded. @@ -47,12 +65,12 @@ func ConvertWorker(jobs <-chan ConvertJob) { // Transcode to MP4 AVC. if _, err := job.convert.ToAvc(f, job.convert.conf.FFmpegEncoder(), false, false); err != nil { - convertErr(err, job) + handleErr(err, job) } default: // Create preview image. if _, err := job.convert.ToImage(f, job.force); err != nil { - convertErr(err, job) + handleErr(err, job) } } } diff --git a/internal/photoprism/dl/dl.go b/internal/photoprism/dl/dl.go index bb438acfc..b0b942ae1 100644 --- a/internal/photoprism/dl/dl.go +++ b/internal/photoprism/dl/dl.go @@ -27,7 +27,7 @@ downloading. Secrets are not logged; header values are redacted in traces. The package exposes convenience constructors around yt-dlp invocation as well as small utilities for safer logging and remux metadata preparation. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -40,7 +40,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> This code is copied and modified in part from: diff --git a/internal/photoprism/dl/info.go b/internal/photoprism/dl/info.go index f30d9ac7c..e64b93bb4 100644 --- a/internal/photoprism/dl/info.go +++ b/internal/photoprism/dl/info.go @@ -306,16 +306,8 @@ func infoFromURL( } } - // as we ignore errors for playlists some entries might show up as null - // - // note: instead of doing full recursion, we assume entries in - // playlists and channels are at most 2 levels deep, and we just - // collect entries from both levels. - // - // the following cases have not been tested: - // - // - entries that are more than 2 levels deep (will be missed) - // - the ability to restrict entries to a single level (we include both levels) + // Flatten up to two levels of playlist/channel nesting; deeper entries + // are not collected and per-level filtering is not supported. if options.Type == TypePlaylist || options.Type == TypeChannel { var filteredEntries []Info for _, e := range info.Entries { diff --git a/internal/photoprism/errors.go b/internal/photoprism/errors.go new file mode 100644 index 000000000..5e59e9e6a --- /dev/null +++ b/internal/photoprism/errors.go @@ -0,0 +1,33 @@ +package photoprism + +import ( + "errors" + "fmt" + + "github.com/sirupsen/logrus" + + "github.com/photoprism/photoprism/pkg/log/status" +) + +// walkResultLog returns the level, message, and emit flag for a directory-walk result. +// status.ErrCanceled surfaces at info level (user-initiated stop); status.ErrInsufficientStorage is +// suppressed because the storage-check helper already logged the actionable cause. +func walkResultLog(prefix string, err error) (level logrus.Level, message string, emit bool) { + switch { + case err == nil: + return 0, "", false + case errors.Is(err, status.ErrCanceled): + return logrus.InfoLevel, fmt.Sprintf("%s: %s", prefix, status.Canceled), true + case errors.Is(err, status.ErrInsufficientStorage): + return 0, "", false + default: + return logrus.ErrorLevel, fmt.Sprintf("%s: %s", prefix, err.Error()), true + } +} + +// logWalkResult emits a log line for a directory-walk result via walkResultLog. +func logWalkResult(prefix string, err error) { + if level, msg, emit := walkResultLog(prefix, err); emit { + log.Log(level, msg) + } +} diff --git a/internal/photoprism/errors_test.go b/internal/photoprism/errors_test.go new file mode 100644 index 000000000..08b9b0c09 --- /dev/null +++ b/internal/photoprism/errors_test.go @@ -0,0 +1,47 @@ +package photoprism + +import ( + "errors" + "fmt" + "testing" + + "github.com/sirupsen/logrus" + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/pkg/log/status" +) + +func TestWalkResultLog(t *testing.T) { + t.Run("NilError", func(t *testing.T) { + level, msg, emit := walkResultLog("index", nil) + assert.False(t, emit) + assert.Equal(t, logrus.Level(0), level) + assert.Empty(t, msg) + }) + t.Run("Canceled", func(t *testing.T) { + level, msg, emit := walkResultLog("index", status.ErrCanceled) + assert.True(t, emit) + assert.Equal(t, logrus.InfoLevel, level) + assert.Equal(t, "index: canceled", msg) + }) + t.Run("WrappedCanceled", func(t *testing.T) { + level, _, emit := walkResultLog("index", fmt.Errorf("worker: %w", status.ErrCanceled)) + assert.True(t, emit) + assert.Equal(t, logrus.InfoLevel, level) + }) + t.Run("InsufficientStorage", func(t *testing.T) { + // Suppressed because the storage helper already emitted the actionable line. + _, _, emit := walkResultLog("import", status.ErrInsufficientStorage) + assert.False(t, emit) + }) + t.Run("WrappedInsufficientStorage", func(t *testing.T) { + _, _, emit := walkResultLog("import", fmt.Errorf("walk: %w", status.ErrInsufficientStorage)) + assert.False(t, emit) + }) + t.Run("UnknownError", func(t *testing.T) { + level, msg, emit := walkResultLog("import", errors.New("disk vanished")) + assert.True(t, emit) + assert.Equal(t, logrus.ErrorLevel, level) + assert.Equal(t, "import: disk vanished", msg) + }) +} diff --git a/internal/photoprism/faces_cluster.go b/internal/photoprism/faces_cluster.go index 7c68c65ae..34b15810c 100644 --- a/internal/photoprism/faces_cluster.go +++ b/internal/photoprism/faces_cluster.go @@ -2,6 +2,7 @@ package photoprism import ( "fmt" + "time" "github.com/dustin/go-humanize/english" @@ -40,7 +41,9 @@ func (w *Faces) Cluster(opt FacesOptions) (added entity.Faces, err error) { var c alg.HardClusterer // See https://dl.photoprism.app/research/ for research on face clustering algorithms. - if c, err = alg.DBSCAN(face.ClusterCore, face.ClusterDist, w.conf.IndexWorkers(), alg.EuclideanDist); err != nil { + if c, err = alg.DBSCANWithProgress(face.ClusterCore, face.ClusterDist, w.conf.IndexWorkers(), alg.EuclideanDist, 15*time.Minute, func(done, total int) { + log.Infof("cluster: processing %d of %d", done, total) + }); err != nil { return added, err } else if err = c.Learn(embeddings.Float64()); err != nil { return added, err @@ -70,7 +73,14 @@ func (w *Faces) Cluster(opt FacesOptions) (added entity.Faces, err error) { results[n-1] = append(results[n-1], embeddings[i]) } - for _, cluster := range results { + start := time.Now() + resultLen := len(results) + + for i, cluster := range results { + if time.Since(start) > time.Duration(time.Minute*15) { + log.Infof("cluster: added %d of %d faces", i, resultLen) + start = time.Now() + } if f := entity.NewFace("", entity.SrcAuto, cluster); f == nil { log.Errorf("faces: face must not be nil - you may have found a bug") } else if f.SkipMatching() { diff --git a/internal/photoprism/faces_match.go b/internal/photoprism/faces_match.go index ba5b1beb3..822355e19 100644 --- a/internal/photoprism/faces_match.go +++ b/internal/photoprism/faces_match.go @@ -243,6 +243,7 @@ func (w *Faces) MatchFaces(faces entity.Faces, force bool, matchedBefore *time.T totalProcessed := 0 offset := 0 + start := time.Now() for { var markers entity.Markers @@ -376,7 +377,12 @@ func (w *Faces) MatchFaces(faces entity.Faces, force bool, matchedBefore *time.T break } - log.Debugf("faces: matched %s", english.Plural(totalProcessed, "marker", "markers")) + if time.Since(start) > time.Duration(time.Minute*15) { + log.Infof("faces: matched %s", english.Plural(totalProcessed, "marker", "markers")) + start = time.Now() + } else { + log.Debugf("faces: matched %s", english.Plural(totalProcessed, "marker", "markers")) + } if totalProcessed >= maxMarkers { break diff --git a/internal/photoprism/faces_optimize.go b/internal/photoprism/faces_optimize.go index 36a0da679..57066a34e 100644 --- a/internal/photoprism/faces_optimize.go +++ b/internal/photoprism/faces_optimize.go @@ -5,6 +5,8 @@ import ( "fmt" "strings" + "github.com/dustin/go-humanize/english" + "github.com/photoprism/photoprism/internal/ai/face" "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/entity/query" @@ -63,7 +65,14 @@ func (w *Faces) OptimizeFor(subjUID string) (result FacesOptimizeResult, err err "subject %s, iteration %d, cluster %d, count %d, ids %s", }, subject, i, j, len(merge), clusterIDs) - log.Debugf("faces: retained manual clusters after merge: kept %d candidate cluster(s) [%s] for subject %s (merge) itr %d cluster %d", len(merge), clusterIDs, subject, i, j) + log.Debugf( + "faces: retained manual clusters after merge: kept %s [%s] for subject %s (merge) itr %d cluster %d", + english.Plural(len(merge), "candidate cluster", "candidate clusters"), + clusterIDs, + subject, + i, + j, + ) } else { log.Errorf("%s (merge) itr %d cluster %d count %d", mergeErr, i, j, len(merge)) } diff --git a/internal/photoprism/faces_reset_test.go b/internal/photoprism/faces_reset_test.go index 88a8fc3c8..8b0e57c40 100644 --- a/internal/photoprism/faces_reset_test.go +++ b/internal/photoprism/faces_reset_test.go @@ -30,7 +30,7 @@ func TestFaces_ResetAndReindex_InvalidEngine(t *testing.T) { require.Error(t, err) } -func TestFaces_ResetAndReindex_Pigo(t *testing.T) { +func TestFaces_ResetAndReindex_Auto(t *testing.T) { defer func(prev func(*Index, IndexOptions) (fs.Done, int, error)) { runFacesReindex = prev }(runFacesReindex) @@ -44,11 +44,12 @@ func TestFaces_ResetAndReindex_Pigo(t *testing.T) { } c := config.TestConfig() + c.Options().ModelsPath = t.TempDir() m := NewFaces(c) - err := m.ResetAndReindex(face.EnginePigo, nil) + err := m.ResetAndReindex(face.EngineAuto, nil) require.NoError(t, err) require.True(t, called) require.True(t, received.FacesOnly) - require.Equal(t, face.EnginePigo, c.FaceEngine()) + require.Equal(t, face.EngineNone, c.FaceEngine()) } diff --git a/internal/photoprism/filename.go b/internal/photoprism/filename.go index b5020a49d..76a2922c6 100644 --- a/internal/photoprism/filename.go +++ b/internal/photoprism/filename.go @@ -17,8 +17,8 @@ func FileName(fileRoot, fileName string) string { return path.Join(Config().SidecarPath(), fileName) case entity.RootImport: return path.Join(Config().ImportPath(), fileName) - case entity.RootExamples: - return path.Join(Config().ExamplesPath(), fileName) + case entity.RootSamples: + return path.Join(Config().SamplesPath(), fileName) default: return path.Join(Config().OriginalsPath(), fileName) } @@ -63,8 +63,8 @@ func RootPath(fileName string) string { return Config().SidecarPath() case entity.RootImport: return Config().ImportPath() - case entity.RootExamples: - return Config().ExamplesPath() + case entity.RootSamples: + return Config().SamplesPath() default: return Config().OriginalsPath() } @@ -90,10 +90,10 @@ func Root(fileName string) string { return entity.RootSidecar } - examplesPath := Config().ExamplesPath() + samplesPath := Config().SamplesPath() - if examplesPath != "" && strings.HasPrefix(fileName, examplesPath) { - return entity.RootExamples + if samplesPath != "" && strings.HasPrefix(fileName, samplesPath) { + return entity.RootSamples } return entity.RootUnknown diff --git a/internal/photoprism/filename_test.go b/internal/photoprism/filename_test.go index 53c7c787a..ddba17ed8 100644 --- a/internal/photoprism/filename_test.go +++ b/internal/photoprism/filename_test.go @@ -18,9 +18,8 @@ func TestFileName(t *testing.T) { assert.Equal(t, c.ImportPath()+"/test.jpg", FileName("import", "test.jpg")) }) t.Run("Examples", func(t *testing.T) { - assert.Equal(t, c.ExamplesPath()+"/test.jpg", FileName("examples", "test.jpg")) + assert.Equal(t, c.SamplesPath()+"/test.jpg", FileName(entity.RootSamples, "test.jpg")) }) - } func TestCacheName(t *testing.T) { diff --git a/internal/photoprism/get/get.go b/internal/photoprism/get/get.go index da158e4e0..e8bdb7c76 100644 --- a/internal/photoprism/get/get.go +++ b/internal/photoprism/get/get.go @@ -1,7 +1,7 @@ /* Package get provides a registry for common services. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/photoprism/get/get_test.go b/internal/photoprism/get/get_test.go index 05b05f453..3856c70d7 100644 --- a/internal/photoprism/get/get_test.go +++ b/internal/photoprism/get/get_test.go @@ -8,27 +8,29 @@ import ( "github.com/photoprism/photoprism/pkg/fs" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) (code int) { tempDir, err := os.MkdirTemp("", "internal-photoprism-get") if err != nil { panic(err) } + defer os.RemoveAll(tempDir) + c := config.NewMinimalTestConfigWithDb("test", tempDir) + defer c.CleanupTestFolder() + defer func() { + if err := c.CloseDb(); err != nil { + log.Warnf("close db: %v", err) + } + // Remove temporary SQLite files after running the tests. + fs.PurgeTestDbFiles(".", false) + }() SetConfig(c) - code := m.Run() - - if err = c.CloseDb(); err != nil { - log.Warnf("close db: %v", err) - } - - if err = os.RemoveAll(tempDir); err != nil { - log.Errorf("remove temp dir: %v", err) - } - - // Remove temporary SQLite files after running the tests. - fs.PurgeTestDbFiles(".", false) - - os.Exit(code) + return m.Run() } diff --git a/internal/photoprism/get/oidc.go b/internal/photoprism/get/oidc.go index 4fe4174e8..827aff807 100644 --- a/internal/photoprism/get/oidc.go +++ b/internal/photoprism/get/oidc.go @@ -6,22 +6,48 @@ import ( "github.com/photoprism/photoprism/internal/auth/oidc" ) -var onceOidc sync.Once +var ( + oidcMutex sync.Mutex + newOIDCClient = oidc.NewClient +) -func initOidc() { - services.OIDC, _ = oidc.NewClient( +// initOIDC initializes and caches the OIDC client if discovery succeeds. +func initOIDC() *oidc.Client { + client, err := newOIDCClient( Config().OIDCUri(), Config().OIDCClient(), Config().OIDCSecret(), Config().OIDCScopes(), + Config().OIDCPrompt(), Config().SiteUrl(), false, ) + + if err != nil { + return nil + } + + services.OIDC = client + + return client +} + +// resetOIDC clears the cached OIDC client so the next lookup retries initialization. +func resetOIDC() { + oidcMutex.Lock() + defer oidcMutex.Unlock() + + services.OIDC = nil } // OIDC returns the singleton OIDC client instance. func OIDC() *oidc.Client { - onceOidc.Do(initOidc) + oidcMutex.Lock() + defer oidcMutex.Unlock() - return services.OIDC + if services.OIDC != nil { + return services.OIDC + } + + return initOIDC() } diff --git a/internal/photoprism/get/services.go b/internal/photoprism/get/services.go index d545fe990..422c59ef4 100644 --- a/internal/photoprism/get/services.go +++ b/internal/photoprism/get/services.go @@ -1,27 +1,3 @@ -/* -Package get provides a registry for common application services. - -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. - - This program is free software: you can redistribute it and/or modify - it under Version 3 of the GNU Affero General Public License (the "AGPL"): - <https://docs.photoprism.app/license/agpl> - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - The AGPL is supplemented by our Trademark and Brand Guidelines, - which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> - -Feel free to send an email to hello@photoprism.app if you have questions, -want to support our work, or just want to say hello. - -Additional information can be found in our Developer Guide: -<https://docs.photoprism.app/developer-guide/> -*/ package get import ( @@ -68,6 +44,7 @@ func SetConfig(c *config.Config) { } resetJWT() + resetOIDC() conf = c diff --git a/internal/photoprism/get/services_test.go b/internal/photoprism/get/services_test.go index 4b1b30b7b..a1f8585ff 100644 --- a/internal/photoprism/get/services_test.go +++ b/internal/photoprism/get/services_test.go @@ -1,6 +1,8 @@ package get import ( + "errors" + "net/url" "testing" gc "github.com/patrickmn/go-cache" @@ -8,6 +10,7 @@ import ( "github.com/photoprism/photoprism/internal/auth/oidc" "github.com/photoprism/photoprism/internal/auth/session" + "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/entity/query" "github.com/photoprism/photoprism/internal/photoprism" ) @@ -65,5 +68,55 @@ func TestSession(t *testing.T) { } func TestOIDC(t *testing.T) { - assert.IsType(t, &oidc.Client{}, OIDC()) + origConf := Config() + origFactory := newOIDCClient + + t.Cleanup(func() { + newOIDCClient = origFactory + SetConfig(origConf) + }) + + t.Run("CachesSuccess", func(t *testing.T) { + tempConf := config.NewMinimalTestConfig(t.TempDir()) + SetConfig(tempConf) + + calls := 0 + expected := &oidc.Client{} + + newOIDCClient = func(_ *url.URL, _ string, _ string, _ string, _ string, _ string, _ bool) (*oidc.Client, error) { + calls++ + return expected, nil + } + + client := OIDC() + assert.Same(t, expected, client) + assert.Equal(t, 1, calls) + assert.Same(t, expected, OIDC()) + assert.Equal(t, 1, calls) + }) + t.Run("RetriesAfterFailure", func(t *testing.T) { + tempConf := config.NewMinimalTestConfig(t.TempDir()) + SetConfig(tempConf) + + calls := 0 + expected := &oidc.Client{} + + newOIDCClient = func(_ *url.URL, _ string, _ string, _ string, _ string, _ string, _ bool) (*oidc.Client, error) { + calls++ + if calls == 1 { + return nil, errors.New("service discovery failed") + } + + return expected, nil + } + + assert.Nil(t, OIDC()) + assert.Equal(t, 1, calls) + + client := OIDC() + assert.Same(t, expected, client) + assert.Equal(t, 2, calls) + assert.Same(t, expected, OIDC()) + assert.Equal(t, 2, calls) + }) } diff --git a/internal/photoprism/import.go b/internal/photoprism/import.go index b26ed37b6..c1a9b018c 100644 --- a/internal/photoprism/import.go +++ b/internal/photoprism/import.go @@ -18,6 +18,9 @@ import ( "github.com/photoprism/photoprism/internal/mutex" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/fs/disk" + "github.com/photoprism/photoprism/pkg/i18n" + "github.com/photoprism/photoprism/pkg/log/status" "github.com/photoprism/photoprism/pkg/media" ) @@ -51,6 +54,17 @@ func (imp *Import) thumbPath() string { return imp.conf.ThumbCachePath() } +// insufficientStorage reports whether the import must abort due to quota or low free disk space. +func (imp *Import) insufficientStorage() bool { + if !imp.conf.InsufficientStorage() { + return false + } + + log.Errorf("import: aborting due to insufficient storage") + event.ErrorMsg(i18n.ErrInsufficientStorage) + return true +} + // Start imports media files from a directory and converts/indexes them as needed. func (imp *Import) Start(opt ImportOptions) fs.Done { defer func() { @@ -75,6 +89,13 @@ func (imp *Import) Start(opt ImportOptions) fs.Done { return done } + // Reset the cached disk usage so a freshly freed disk is detected immediately. + disk.FlushFree() + + if imp.insufficientStorage() { + return done + } + // Make sure to run import only once, unless otherwise requested. if !opt.NonBlocking { if err := mutex.IndexWorker.Start(); err != nil { @@ -128,7 +149,13 @@ func (imp *Import) Start(opt ImportOptions) fs.Done { }() if mutex.IndexWorker.Canceled() { - return errors.New("canceled") + return status.ErrCanceled + } + + // Stop the walk if storage drops below the threshold mid-import. + if imp.insufficientStorage() { + imp.Cancel() + return status.ErrInsufficientStorage } isDir, _ := info.IsDirOrSymlinkToDir() @@ -266,9 +293,7 @@ func (imp *Import) Start(opt ImportOptions) fs.Done { } } - if err != nil { - log.Error(err.Error()) - } + logWalkResult("import", err) if filesImported > 0 { // Run face recognition if enabled. diff --git a/internal/photoprism/import_storage_test.go b/internal/photoprism/import_storage_test.go new file mode 100644 index 000000000..2e14e075b --- /dev/null +++ b/internal/photoprism/import_storage_test.go @@ -0,0 +1,43 @@ +package photoprism + +import ( + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/pkg/fs/disk" +) + +func TestImport_InsufficientStorage(t *testing.T) { + cfg := config.NewMinimalTestConfig(t.TempDir()) + convert := NewConvert(cfg) + ind := NewIndex(cfg, convert, NewFiles(), NewPhotos()) + require.NotNil(t, ind) + imp := NewImport(cfg, ind, convert) + require.NotNil(t, imp) + + // Reset the storage-check latch, which an earlier test may have tripped by probing a + // temp path that duf cannot resolve to a mount point. + config.DisableStorageCheck.Store(false) + + // Seed the disk cache so the verdict is deterministic on any host filesystem. + t.Run("Healthy", func(t *testing.T) { + disk.FlushFree() + t.Cleanup(disk.FlushFree) + disk.SetFree(cfg.StoragePath(), 999*disk.MB, 1000*disk.MB) + cfg.Options().FilesQuota = 0 + + assert.False(t, imp.insufficientStorage()) + }) + + t.Run("StorageLow", func(t *testing.T) { + disk.FlushFree() + t.Cleanup(disk.FlushFree) + disk.SetFree(cfg.StoragePath(), 1*disk.MB, 1000*disk.MB) + cfg.Options().FilesQuota = 0 + + assert.True(t, imp.insufficientStorage()) + }) +} diff --git a/internal/photoprism/import_worker_test.go b/internal/photoprism/import_worker_test.go index 27c58e57c..600233e54 100644 --- a/internal/photoprism/import_worker_test.go +++ b/internal/photoprism/import_worker_test.go @@ -20,17 +20,17 @@ func TestImportWorker_OriginalFileNames(t *testing.T) { ind := NewIndex(cfg, convert, NewFiles(), NewPhotos()) imp := &Import{cfg, ind, convert, cfg.ImportAllow()} - mediaFileName := cfg.ExamplesPath() + "/beach_sand.jpg" + mediaFileName := cfg.SamplesPath() + "/beach_sand.jpg" mediaFile, err := NewMediaFile(mediaFileName) if err != nil { t.Fatal(err) } - mediaFileName2 := cfg.ExamplesPath() + "/beach_wood.jpg" + mediaFileName2 := cfg.SamplesPath() + "/beach_wood.jpg" mediaFile2, err2 := NewMediaFile(mediaFileName2) if err2 != nil { t.Fatal(err2) } - mediaFileName3 := cfg.ExamplesPath() + "/beach_colorfilter.jpg" + mediaFileName3 := cfg.SamplesPath() + "/beach_colorfilter.jpg" mediaFile3, err3 := NewMediaFile(mediaFileName3) if err3 != nil { t.Fatal(err3) diff --git a/internal/photoprism/index.go b/internal/photoprism/index.go index d4a859110..7f89c8864 100644 --- a/internal/photoprism/index.go +++ b/internal/photoprism/index.go @@ -17,7 +17,9 @@ import ( "github.com/photoprism/photoprism/internal/mutex" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/fs/disk" "github.com/photoprism/photoprism/pkg/i18n" + "github.com/photoprism/photoprism/pkg/log/status" "github.com/photoprism/photoprism/pkg/media" ) @@ -62,6 +64,33 @@ func (ind *Index) Cancel() { mutex.IndexWorker.Cancel() } +// storageLow reports whether the storage path is too full to start or continue an index run. +func (ind *Index) storageLow() bool { + _, low, err := ind.conf.StorageLow() + + if err != nil || !low { + return false + } + + // Do not leak server internals like the size of the storage volume. + log.Errorf("index: available storage is below the minimum threshold") + event.ErrorMsg(i18n.ErrInsufficientStorage) + return true +} + +// abortInsufficientStorage logs the insufficient-storage cause once and cancels the run so the +// directory walk stops, instead of failing every remaining file with a generic preview error. +// It is called from worker goroutines when a write leaf reports status.ErrInsufficientStorage. +func (ind *Index) abortInsufficientStorage() { + if mutex.IndexWorker.Canceled() { + return + } + + log.Errorf("index: available storage is below the minimum threshold") + event.ErrorMsg(i18n.ErrInsufficientStorage) + ind.Cancel() +} + // Start indexes media files in the originals folder according to the provided options. // It streams work to worker goroutines, updates duplicate caches, and returns both // the set of processed paths and the number of files that were changed. @@ -90,6 +119,13 @@ func (ind *Index) Start(o IndexOptions) (found fs.Done, updated int) { return found, updated } + // Reset the cached disk usage so a freshly freed disk is detected immediately. + disk.FlushFree() + + if ind.storageLow() { + return found, updated + } + if err := mutex.IndexWorker.Start(); err != nil { event.Warn(fmt.Sprintf("index: %s", err.Error())) return found, updated @@ -146,7 +182,13 @@ func (ind *Index) Start(o IndexOptions) (found fs.Done, updated int) { }() if mutex.IndexWorker.Canceled() { - return errors.New("canceled") + return status.ErrCanceled + } + + // Stop the walk if storage drops below the threshold mid-scan. + if ind.storageLow() { + ind.Cancel() + return status.ErrInsufficientStorage } isDir, _ := info.IsDirOrSymlinkToDir() @@ -294,9 +336,7 @@ func (ind *Index) Start(o IndexOptions) (found fs.Done, updated int) { close(jobs) wg.Wait() - if err != nil { - log.Error(err.Error()) - } + logWalkResult("index", err) if o.Rescan && !o.FacesOnly { if reconciled, reconcileErr := entity.ReconcileOriginalsFolderAlbums(o.Path); reconcileErr != nil { diff --git a/internal/photoprism/index_filehash.go b/internal/photoprism/index_filehash.go new file mode 100644 index 000000000..d18afecf8 --- /dev/null +++ b/internal/photoprism/index_filehash.go @@ -0,0 +1,40 @@ +package photoprism + +import "sync" + +// fileHashLock serializes indexing of files that share the same content hash. +type fileHashLock struct { + sync.Mutex + refs int // Number of workers holding or awaiting this lock; the entry is removed when it reaches zero. +} + +// fileHashLocksMutex guards fileHashLocks. +var fileHashLocksMutex sync.Mutex + +// fileHashLocks tracks the per-hash locks currently held or awaited by indexing workers. +var fileHashLocks = make(map[string]*fileHashLock) + +// lockFileHash acquires the indexing lock for the given file hash and returns the function that releases it. +// Entries are reference counted and removed on release, so the map only holds in-flight hashes. +func lockFileHash(fileHash string) (unlock func()) { + fileHashLocksMutex.Lock() + l, found := fileHashLocks[fileHash] + if !found { + l = &fileHashLock{} + fileHashLocks[fileHash] = l + } + l.refs++ + fileHashLocksMutex.Unlock() + + l.Lock() + + return func() { + l.Unlock() + fileHashLocksMutex.Lock() + l.refs-- + if l.refs == 0 { + delete(fileHashLocks, fileHash) + } + fileHashLocksMutex.Unlock() + } +} diff --git a/internal/photoprism/index_filehash_test.go b/internal/photoprism/index_filehash_test.go new file mode 100644 index 000000000..35838c659 --- /dev/null +++ b/internal/photoprism/index_filehash_test.go @@ -0,0 +1,62 @@ +package photoprism + +import ( + "sync" + "sync/atomic" + "testing" + + "github.com/stretchr/testify/assert" +) + +// TestLockFileHash verifies that lockFileHash serializes concurrent holders of +// the same hash and removes map entries once the last holder releases. +func TestLockFileHash(t *testing.T) { + t.Run("Success", func(t *testing.T) { + unlock := lockFileHash("abc123") + assert.Len(t, fileHashLocks, 1) + unlock() + assert.Len(t, fileHashLocks, 0) + }) + // Callers skip the lock for empty hashes; this is a defensive contract check. + t.Run("EmptyHash", func(t *testing.T) { + unlock := lockFileHash("") + assert.Len(t, fileHashLocks, 1) + unlock() + assert.Len(t, fileHashLocks, 0) + }) + t.Run("DistinctKeysDoNotBlock", func(t *testing.T) { + unlockFirst := lockFileHash("hash-one") + unlockSecond := lockFileHash("hash-two") + assert.Len(t, fileHashLocks, 2) + unlockSecond() + unlockFirst() + assert.Len(t, fileHashLocks, 0) + }) + t.Run("Contention", func(t *testing.T) { + const workers = 8 + var wg sync.WaitGroup + var inCriticalSection int32 + var entered int32 + + for range workers { + wg.Add(1) + go func() { + defer wg.Done() + unlock := lockFileHash("contended") + defer unlock() + + if !atomic.CompareAndSwapInt32(&inCriticalSection, 0, 1) { + t.Error("two goroutines entered the critical section for the same hash") + } + + atomic.AddInt32(&entered, 1) + atomic.StoreInt32(&inCriticalSection, 0) + }() + } + + wg.Wait() + + assert.Equal(t, int32(workers), entered) + assert.Len(t, fileHashLocks, 0) + }) +} diff --git a/internal/photoprism/index_main.go b/internal/photoprism/index_main.go index f0d07fc23..3fc33304e 100644 --- a/internal/photoprism/index_main.go +++ b/internal/photoprism/index_main.go @@ -1,10 +1,12 @@ package photoprism import ( + "errors" "fmt" "github.com/photoprism/photoprism/internal/entity/query" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/log/status" ) // IndexMain indexes the main file from a group of related files and returns the result. @@ -43,6 +45,14 @@ func IndexMain(related *RelatedFiles, ind *Index, o IndexOptions) (result IndexR // Create JPEG sidecar for media files in other formats so that thumbnails can be created. if o.Convert && f.IsMedia() && !f.HasPreviewImage() { if img, imgErr := ind.convert.ToImage(f, false); imgErr != nil { + // Stop the run instead of masking a full disk as a generic preview error. + if errors.Is(imgErr, status.ErrInsufficientStorage) { + ind.abortInsufficientStorage() + result.Err = imgErr + result.Status = IndexFailed + return result + } + result.Err = fmt.Errorf("index: could not create preview image for %s", clean.Log(f.RootRelName())) log.Error(result.Err) result.Status = IndexFailed @@ -57,6 +67,14 @@ func IndexMain(related *RelatedFiles, ind *Index, o IndexOptions) (result IndexR log.Debugf("index: created %s", clean.Log(img.BaseName())) if imgErr = img.GenerateThumbnails(ind.thumbPath(), false); imgErr != nil { + // Stop the run instead of masking a full disk as a generic thumbnail error. + if errors.Is(imgErr, status.ErrInsufficientStorage) { + ind.abortInsufficientStorage() + result.Err = imgErr + result.Status = IndexFailed + return result + } + result.Err = fmt.Errorf("index: failed to generate thumbnails for %s (%s)", clean.Log(f.RootRelName()), imgErr.Error()) result.Status = IndexFailed return result diff --git a/internal/photoprism/index_mediafile.go b/internal/photoprism/index_mediafile.go index a703f44da..895002ebb 100644 --- a/internal/photoprism/index_mediafile.go +++ b/internal/photoprism/index_mediafile.go @@ -98,6 +98,14 @@ func (ind *Index) UserMediaFile(m *MediaFile, o IndexOptions, originalName, phot // Try to find existing file by hash. Skip this for sidecar files, and files outside the originals folder. if !fileExists && !m.IsSidecar() && m.Root() == entity.RootOriginals { fileHash = m.Hash() + + // Hold a per-hash lock until indexing is complete, so concurrent workers + // cannot miss the lookup below and index byte-identical files twice. + if fileHash != "" { + unlock := lockFileHash(fileHash) + defer unlock() + } + fileQuery = entity.UnscopedDb().First(&file, "file_hash = ?", fileHash) indFileName := "" @@ -304,7 +312,9 @@ func (ind *Index) UserMediaFile(m *MediaFile, o IndexOptions, originalName, phot // Update photo path and name based on the main filename. if !fileStacked && (file.FilePrimary || photo.PhotoName == "") { - photo.PhotoPath = filePath + // Clip to the shared path byte budget so photo_path stays byte-exact + // with album_path for folder-album matching. + photo.PhotoPath = entity.ClipPath(filePath) if !o.Stack || !stripSequence || photo.PhotoStack == entity.IsUnstacked { photo.PhotoName = fullBase @@ -391,7 +401,7 @@ func (ind *Index) UserMediaFile(m *MediaFile, o IndexOptions, originalName, phot // Update color information, if available. if color, colorErr := m.Colors(Config().ThumbCachePath()); colorErr != nil { log.Debugf("%s while detecting colors", colorErr.Error()) - file.FileError = clip.Chars(colorErr.Error(), txt.ClipError) + file.FileError = clip.Bytes(colorErr.Error(), txt.ClipError) file.FilePrimary = false } else { file.FileMainColor = color.MainColor.Name() @@ -449,13 +459,6 @@ func (ind *Index) UserMediaFile(m *MediaFile, o IndexOptions, originalName, phot photo.SetMediaType(media.Live, entity.SrcFile) } - if file.OriginalName == "" && filepath.Base(file.FileName) != data.FileName { - file.OriginalName = data.FileName - if photo.OriginalName == "" { - photo.OriginalName = fs.StripKnownExt(data.FileName) - } - } - if data.HasInstanceID() { log.Infof("index: %s has instance_id %s", logName, clean.Log(data.InstanceID)) @@ -481,6 +484,16 @@ func (ind *Index) UserMediaFile(m *MediaFile, o IndexOptions, originalName, phot photo.SetCaption(data.Caption, entity.SrcXmp) photo.SetTakenAt(data.TakenAt, data.TakenAtLocal, data.TimeZone, entity.SrcXmp) photo.SetCoordinates(data.Lat, data.Lng, data.Altitude, entity.SrcXmp) + photo.SetCameraSerial(data.CameraSerial) + + // Resolve the S2 cell when XMP provides GPS coordinates so subsequent + // re-indexes find the cell in the local DB and do not trigger a live + // geocoding request. + if data.Lat != 0 || data.Lng != 0 { + var locLabels classify.Labels + locKeywords, locLabels = photo.UpdateLocation() + labels = append(labels, locLabels...) + } // Update metadata details. details.SetKeywords(data.Keywords.String(), entity.SrcXmp) @@ -491,13 +504,60 @@ func (ind *Index) UserMediaFile(m *MediaFile, o IndexOptions, originalName, phot details.SetLicense(data.License, entity.SrcXmp) details.SetSoftware(data.Software, entity.SrcXmp) + // Adopt the XMP DocumentID as the photo UUID. SrcXmp wins + // over an auto-generated UUID assigned in the SrcMeta branch. + // Real-world XMP DocumentIDs are often non-canonical (no dashes, + // `adobe:docid:` or `xmp.did:` prefixes), so the strict UUID + // check from data.HasDocumentID() is too narrow here. + if data.DocumentID != "" { + log.Infof("index: %s has document_id %s", logName, clean.Log(data.DocumentID)) + photo.UUID = data.DocumentID + } + + // Update camera, lens, and exposure from the sidecar. + photo.SetCamera(entity.FirstOrCreateCamera(entity.NewCamera(data.CameraMake, data.CameraModel)), entity.SrcXmp) + photo.SetLens(entity.FirstOrCreateLens(entity.NewLens(data.LensMake, data.LensModel)), entity.SrcXmp) + photo.SetExposure(data.FocalLength, data.FNumber, data.Iso, data.Exposure, entity.SrcXmp) + + // Mirror file-level identity metadata to the primary file so the + // UI surfaces it (per-file fields render the primary JPEG/HEIC). + // ColorProfile and Projection are not mirrored — they describe + // physical container properties, not user-supplied metadata. + // Only the changed columns are written: a full Save() would also + // re-resolve the primary flag and regenerate the search index, + // which neither InstanceID nor Software affects, and would issue + // those writes on every re-index pass even when nothing changed. + if primary, primaryErr := photo.PrimaryFile(); primaryErr == nil && primary != nil { + prevInstanceID, prevSoftware := primary.InstanceID, primary.FileSoftware + + if data.InstanceID != "" { + primary.InstanceID = data.InstanceID + } + primary.SetSoftware(data.Software) + + values := entity.Values{} + if primary.InstanceID != prevInstanceID { + log.Infof("index: %s has instance_id %s", logName, clean.Log(primary.InstanceID)) + values["instance_id"] = primary.InstanceID + } + if primary.FileSoftware != prevSoftware { + values["file_software"] = primary.FileSoftware + } + if len(values) > 0 { + values["updated_at"] = entity.Now() + if saveErr := primary.Updates(values); saveErr != nil { + log.Warnf("index: %s could not save primary file metadata (%s)", logName, saveErr) + } + } + } + // Update externally marked as favorite. if data.Favorite { _ = photo.SetFavorite(data.Favorite) } } else { log.Warn(dataErr.Error()) - file.FileError = clip.Chars(dataErr.Error(), txt.ClipError) + file.FileError = clip.Bytes(dataErr.Error(), txt.ClipError) } case m.IsRaw(), m.IsImage(): if data := m.MetaData(); data.Error == nil { @@ -529,13 +589,6 @@ func (ind *Index) UserMediaFile(m *MediaFile, o IndexOptions, originalName, phot file.InstanceID = data.InstanceID } - if file.OriginalName == "" && filepath.Base(file.FileName) != data.FileName { - file.OriginalName = data.FileName - if photo.OriginalName == "" { - photo.OriginalName = fs.StripKnownExt(data.FileName) - } - } - file.FileCodec = data.Codec file.FileWidth = m.Width() file.FileHeight = m.Height() @@ -625,13 +678,6 @@ func (ind *Index) UserMediaFile(m *MediaFile, o IndexOptions, originalName, phot file.InstanceID = data.InstanceID } - if file.OriginalName == "" && filepath.Base(file.FileName) != data.FileName { - file.OriginalName = data.FileName - if photo.OriginalName == "" { - photo.OriginalName = fs.StripKnownExt(data.FileName) - } - } - file.FileCodec = data.Codec file.FileWidth = m.Width() file.FileHeight = m.Height() @@ -679,13 +725,6 @@ func (ind *Index) UserMediaFile(m *MediaFile, o IndexOptions, originalName, phot file.InstanceID = data.InstanceID } - if file.OriginalName == "" && filepath.Base(file.FileName) != data.FileName { - file.OriginalName = data.FileName - if photo.OriginalName == "" { - photo.OriginalName = fs.StripKnownExt(data.FileName) - } - } - file.FileCodec = data.Codec file.FileWidth = m.Width() file.FileHeight = m.Height() @@ -733,13 +772,6 @@ func (ind *Index) UserMediaFile(m *MediaFile, o IndexOptions, originalName, phot file.InstanceID = data.InstanceID } - if file.OriginalName == "" && filepath.Base(file.FileName) != data.FileName { - file.OriginalName = data.FileName - if photo.OriginalName == "" { - photo.OriginalName = fs.StripKnownExt(data.FileName) - } - } - file.FileCodec = data.Codec file.FileWidth = m.Width() file.FileHeight = m.Height() @@ -952,7 +984,7 @@ func (ind *Index) UserMediaFile(m *MediaFile, o IndexOptions, originalName, phot }) } - event.EntitiesCreated("photos", []entity.Photo{photo}) + event.EntitiesCreated("photos", []string{photo.PhotoUID}) } photo.AddLabels(labels) diff --git a/internal/photoprism/index_mediafile_test.go b/internal/photoprism/index_mediafile_test.go index 023366aa0..68b165e05 100644 --- a/internal/photoprism/index_mediafile_test.go +++ b/internal/photoprism/index_mediafile_test.go @@ -1,12 +1,17 @@ package photoprism import ( + "fmt" + "path/filepath" + "sync" "testing" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/pkg/fs" ) func TestIndex_MediaFile(t *testing.T) { @@ -59,7 +64,7 @@ func TestIndex_MediaFile(t *testing.T) { ind := NewIndex(cfg, convert, NewFiles(), NewPhotos()) indexOpt := IndexOptionsAll(cfg) - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/blue-go-video.mp4") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/blue-go-video.mp4") if err != nil { t.Fatal(err) } @@ -86,6 +91,109 @@ func TestIndex_MediaFile(t *testing.T) { }) } +// TestIndex_UserMediaFile_ParallelDuplicates verifies that byte-identical files indexed +// concurrently by multiple workers result in exactly one photo and N-1 duplicate records. +func TestIndex_UserMediaFile_ParallelDuplicates(t *testing.T) { + if testing.Short() { + t.Skip("skipping test in short mode.") + } + + // The package-wide PHOTOPRISM_TEST_DSN points all test configs at one shared + // SQLite file, so the database must be isolated for reliable row counts. + t.Setenv("PHOTOPRISM_TEST_DSN", filepath.Join(t.TempDir(), "index-dup-race.db")) + + cfg := config.NewMinimalTestConfigWithDb("index-dup-race", filepath.Join(t.TempDir(), "storage")) + + // MediaFile.Root() resolves paths against the package-level config, so it + // must point to the test config for files to be detected as originals. + oldCfg := Config() + SetConfig(cfg) + + t.Cleanup(func() { + SetConfig(oldCfg) + oldCfg.RegisterDb() + }) + + testFile, err := NewMediaFile("testdata/flash.jpg") + + if err != nil { + t.Fatal(err) + } + + const numCopies = 3 + + copyNames := make([]string, numCopies) + + for i := range copyNames { + copyNames[i] = filepath.Join(cfg.OriginalsPath(), fmt.Sprintf("folder%d", i), "flash.jpg") + + if copyErr := testFile.Copy(copyNames[i], false); copyErr != nil { + t.Fatal(copyErr) + } + } + + ind := NewIndex(cfg, NewConvert(cfg), NewFiles(), NewPhotos()) + indexOpt := IndexOptionsSingle(cfg) + + // The test database is seeded with entity fixtures, so all row counts are compared as deltas. + var basePhotos, baseFiles, baseDuplicates int + + assert.NoError(t, entity.UnscopedDb().Model(&entity.Photo{}).Count(&basePhotos).Error) + assert.NoError(t, entity.UnscopedDb().Model(&entity.File{}).Count(&baseFiles).Error) + assert.NoError(t, entity.UnscopedDb().Model(&entity.Duplicate{}).Count(&baseDuplicates).Error) + + mediaFiles := make([]*MediaFile, numCopies) + + for i, name := range copyNames { + if mediaFiles[i], err = NewMediaFile(name); err != nil { + t.Fatal(err) + } + } + + results := make([]IndexResult, numCopies) + start := make(chan struct{}) + + var wg sync.WaitGroup + + for i := range mediaFiles { + wg.Add(1) + go func(i int) { + defer wg.Done() + <-start + results[i] = ind.UserMediaFile(mediaFiles[i], indexOpt, "", "", entity.OwnerUnknown) + }(i) + } + + close(start) + wg.Wait() + + added, duplicates := 0, 0 + + for _, result := range results { + switch result.Status { + case IndexAdded: + added++ + case IndexDuplicate: + duplicates++ + default: + t.Fatalf("unexpected index result %s (%v)", result.Status, result.Err) + } + } + + assert.Equal(t, 1, added) + assert.Equal(t, numCopies-1, duplicates) + + var photoCount, fileCount, duplicateCount int + + assert.NoError(t, entity.UnscopedDb().Model(&entity.Photo{}).Count(&photoCount).Error) + assert.NoError(t, entity.UnscopedDb().Model(&entity.File{}).Count(&fileCount).Error) + assert.NoError(t, entity.UnscopedDb().Model(&entity.Duplicate{}).Count(&duplicateCount).Error) + + assert.Equal(t, basePhotos+1, photoCount) + assert.Equal(t, baseFiles+1, fileCount) + assert.Equal(t, baseDuplicates+numCopies-1, duplicateCount) +} + func TestIndexResult_Archived(t *testing.T) { t.Run("True", func(t *testing.T) { r := &IndexResult{IndexArchived, nil, 5, "", 5, ""} @@ -107,3 +215,75 @@ func TestIndexResult_Skipped(t *testing.T) { assert.False(t, r.Skipped()) }) } + +// TestIndex_IndexedFileOriginalName verifies that files placed directly in +// originals/ and indexed (never imported) are not assigned an OriginalName, +// so the displayed card name keeps following the current file name after a +// rename and re-index. +func TestIndex_IndexedFileOriginalName(t *testing.T) { + if testing.Short() { + t.Skip("skipping test in short mode.") + } + + // The package-wide PHOTOPRISM_TEST_DSN points all test configs at one + // shared SQLite file; the database and storage must be isolated so the + // flash.jpg content does not collide by hash with a row another test + // indexed with an explicit original name. + t.Setenv("PHOTOPRISM_TEST_DSN", filepath.Join(t.TempDir(), "index-original-name.db")) + + cfg := config.NewMinimalTestConfigWithDb("index-original-name", filepath.Join(t.TempDir(), "storage")) + + // MediaFile.Root() and the ExifTool cache resolve against the package-level + // config, so it must point to the test config for this run. + oldCfg := Config() + SetConfig(cfg) + + t.Cleanup(func() { + SetConfig(oldCfg) + oldCfg.RegisterDb() + }) + + convert := NewConvert(cfg) + ind := NewIndex(cfg, convert, NewFiles(), NewPhotos()) + opt := IndexOptionsSingle(cfg) + + srcFile, err := NewMediaFile("testdata/flash.jpg") + require.NoError(t, err) + + first := filepath.Join(cfg.OriginalsPath(), "indexed-original-name", "indexed-photo.jpg") + require.NoError(t, srcFile.Copy(first, false)) + + mf1, err := NewMediaFile(first) + require.NoError(t, err) + hash := mf1.Hash() + + // The ExifTool JSON cache is keyed by content hash and records the current + // file name; index_main.go creates it before indexing the media file. + require.NoError(t, mf1.CreateExifToolJson(convert)) + + // Plain index: callers pass an empty originalName for indexed files. + res1 := ind.MediaFile(mf1, opt, "", "") + require.True(t, res1.Success()) + + var file1 entity.File + require.NoError(t, entity.UnscopedDb().First(&file1, "file_hash = ?", hash).Error) + assert.Empty(t, file1.OriginalName, "freshly indexed file must not carry an OriginalName") + + // Rename the file in originals/. The content (and therefore the hash and + // the cached ExifTool JSON, which still records the old name) is unchanged, + // which is what previously leaked a stale name into OriginalName. + renamed := filepath.Join(cfg.OriginalsPath(), "indexed-original-name", "renamed-photo.jpg") + require.NoError(t, fs.Move(first, renamed, false)) + + mf2, err := NewMediaFile(renamed) + require.NoError(t, err) + require.NoError(t, mf2.CreateExifToolJson(convert)) + + res2 := ind.MediaFile(mf2, opt, "", "") + require.True(t, res2.Success()) + + var file2 entity.File + require.NoError(t, entity.UnscopedDb().First(&file2, "file_hash = ?", hash).Error) + assert.Equal(t, "indexed-original-name/renamed-photo.jpg", file2.FileName) + assert.Empty(t, file2.OriginalName, "re-indexed renamed file must not pick up a stale OriginalName") +} diff --git a/internal/photoprism/index_related.go b/internal/photoprism/index_related.go index ba15ed3f9..0cc8dc6df 100644 --- a/internal/photoprism/index_related.go +++ b/internal/photoprism/index_related.go @@ -1,12 +1,14 @@ package photoprism import ( + "errors" "fmt" "github.com/dustin/go-humanize/english" "github.com/photoprism/photoprism/internal/entity/query" "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/log/status" ) // IndexRelated indexes a group of related files and returns the result. @@ -74,6 +76,14 @@ func IndexRelated(related RelatedFiles, ind *Index, o IndexOptions) (result Inde if o.Convert && f.IsMedia() && !f.HasPreviewImage() { // Try to create a preview image; if this fails, log and continue without failing the whole group. if img, imgErr := ind.convert.ToImage(f, false); imgErr != nil { + // Stop the run instead of masking a full disk as a generic preview error. + if errors.Is(imgErr, status.ErrInsufficientStorage) { + ind.abortInsufficientStorage() + result.Err = imgErr + result.Status = IndexFailed + return result + } + log.Warnf("index: could not create preview image for %s (%s)", clean.Log(f.RootRelName()), imgErr) // Continue indexing other related files without changing the overall success status. continue @@ -84,6 +94,14 @@ func IndexRelated(related RelatedFiles, ind *Index, o IndexOptions) (result Inde // Skip with warning if thumbs could not be created. if thumbsErr := img.GenerateThumbnails(ind.thumbPath(), false); thumbsErr != nil { + // Stop the run instead of masking a full disk as a generic thumbnail error. + if errors.Is(thumbsErr, status.ErrInsufficientStorage) { + ind.abortInsufficientStorage() + result.Err = thumbsErr + result.Status = IndexFailed + return result + } + log.Warnf("index: failed to generate thumbnails for %s (%s)", clean.Log(f.RootRelName()), thumbsErr.Error()) // Continue indexing; preview image exists and other related files may still succeed. continue diff --git a/internal/photoprism/index_related_test.go b/internal/photoprism/index_related_test.go index e8d8fb4e7..b8b58df9b 100644 --- a/internal/photoprism/index_related_test.go +++ b/internal/photoprism/index_related_test.go @@ -1,13 +1,16 @@ package photoprism import ( + "os" "path/filepath" "testing" "github.com/stretchr/testify/assert" "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/entity/query" + "github.com/photoprism/photoprism/pkg/fs" "github.com/photoprism/photoprism/pkg/rnd" ) @@ -130,12 +133,426 @@ func TestIndexRelated(t *testing.T) { } else { assert.Equal(t, "Botanischer Garten", photo.PhotoTitle) assert.Equal(t, "Tulpen am See", photo.PhotoCaption) - assert.Contains(t, photo.Details.Keywords, "krokus") - assert.Contains(t, photo.Details.Keywords, "blume") - assert.Contains(t, photo.Details.Keywords, "schöne") - assert.Contains(t, photo.Details.Keywords, "wiese") + // dc:subject feeds the descriptive Subject field (entries keep + // their spaces), not the Keywords field. Filename/location keywords + // still populate Keywords, but the dc:subject values must not. + assert.Equal(t, "Krokus, Blume, Schöne Wiese", photo.Details.Subject) + assert.NotContains(t, photo.Details.Keywords, "krokus") + assert.NotContains(t, photo.Details.Keywords, "blume") + assert.NotContains(t, photo.Details.Keywords, "schöne") + assert.NotContains(t, photo.Details.Keywords, "wiese") assert.Equal(t, "2021-03-24 12:07:29 +0000 UTC", photo.TakenAt.String()) assert.Equal(t, "xmp", photo.TakenSrc) } }) + t.Run("XmpCameraLensExposureMapping", func(t *testing.T) { + // Verifies that camera, lens, and exposure values from an XMP sidecar + // reach entity.Photo via the IsXMP indexer branch. + cfg := newIndexRelatedTestConfig(t, "index-related-xmp-camera") + + baseFile, err := NewMediaFile("testdata/apple-test-2.jpg") + if err != nil { + t.Fatal(err) + } + + testToken := rnd.Base36(8) + testPath := filepath.Join(cfg.OriginalsPath(), testToken) + baseName := "xmp-camera-mapping" + + jpegDest := filepath.Join(testPath, baseName+".jpg") + if copyErr := baseFile.Copy(jpegDest, false); copyErr != nil { + t.Fatalf("copying test file failed: %s", copyErr) + } + + xmpContent := `<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Test"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:tiff="http://ns.adobe.com/tiff/1.0/" + xmlns:exif="http://ns.adobe.com/exif/1.0/" + xmlns:exifEX="http://cipa.jp/exif/1.0/" + xmlns:aux="http://ns.adobe.com/exif/1.0/aux/"> + <tiff:Make>SyntheticCam</tiff:Make> + <tiff:Model>SC-1 Mark II</tiff:Model> + <exifEX:LensMake>SyntheticLens Co.</exifEX:LensMake> + <exifEX:LensModel>SL 50mm f/1.4</exifEX:LensModel> + <aux:SerialNumber>BODY-XMP-9001</aux:SerialNumber> + <exif:ISOSpeedRatings> + <rdf:Seq><rdf:li>800</rdf:li></rdf:Seq> + </exif:ISOSpeedRatings> + <exif:FNumber>14/10</exif:FNumber> + <exif:FocalLength>50/1</exif:FocalLength> + <exif:ExposureTime>1/250</exif:ExposureTime> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> +` + xmpDest := filepath.Join(testPath, baseName+".xmp") + if writeErr := os.WriteFile(xmpDest, []byte(xmpContent), fs.ModeFile); writeErr != nil { + t.Fatalf("writing xmp sidecar failed: %s", writeErr) + } + + mainFile, err := NewMediaFile(jpegDest) + if err != nil { + t.Fatal(err) + } + + related, err := mainFile.RelatedFiles(true) + if err != nil { + t.Fatal(err) + } + + convert := NewConvert(cfg) + ind := NewIndex(cfg, convert, NewFiles(), NewPhotos()) + opt := IndexOptionsAll(cfg) + + result := IndexRelated(related, ind, opt) + + assert.False(t, result.Failed()) + assert.True(t, result.Success()) + + photo, err := query.PhotoByUID(result.PhotoUID) + if err != nil { + t.Fatal(err) + } + + // Camera from XMP wiring (IsXMP branch). Re-resolve by Make/Model + // from the cache and assert the photo references the same row. + expectedCamera := entity.FirstOrCreateCamera(entity.NewCamera("SyntheticCam", "SC-1 Mark II")) + if assert.NotNil(t, expectedCamera) { + assert.Equal(t, expectedCamera.ID, photo.CameraID) + assert.NotEqual(t, entity.UnknownCamera.ID, photo.CameraID) + } + assert.Equal(t, entity.SrcXmp, photo.CameraSrc) + + // Lens from XMP wiring. + expectedLens := entity.FirstOrCreateLens(entity.NewLens("SyntheticLens Co.", "SL 50mm f/1.4")) + if assert.NotNil(t, expectedLens) { + assert.Equal(t, expectedLens.ID, photo.LensID) + assert.NotEqual(t, entity.UnknownLens.ID, photo.LensID) + } + + // Exposure values from XMP wiring. + assert.Equal(t, 800, photo.PhotoIso) + assert.InDelta(t, 1.4, float64(photo.PhotoFNumber), 0.001) + assert.Equal(t, 50, photo.PhotoFocalLength) + assert.Equal(t, "1/250", photo.PhotoExposure) + + // Camera serial from XMP wiring. + assert.Equal(t, "BODY-XMP-9001", photo.CameraSerial) + }) + t.Run("XmpMirrorsIdentityToPrimaryFile", func(t *testing.T) { + // InstanceID and Software from an XMP sidecar must reach the primary + // JPEG file row (per-file UI fields render the primary) — the IsXMP + // branch writes only the changed columns instead of a full File.Save(). + cfg := newIndexRelatedTestConfig(t, "index-related-xmp-primary-mirror") + + baseFile, err := NewMediaFile("testdata/apple-test-2.jpg") + if err != nil { + t.Fatal(err) + } + + testToken := rnd.Base36(8) + testPath := filepath.Join(cfg.OriginalsPath(), testToken) + baseName := "xmp-primary-mirror" + + jpegDest := filepath.Join(testPath, baseName+".jpg") + if copyErr := baseFile.Copy(jpegDest, false); copyErr != nil { + t.Fatalf("copying test file failed: %s", copyErr) + } + + xmpContent := `<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Test"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:xmp="http://ns.adobe.com/xap/1.0/" + xmlns:xmpMM="http://ns.adobe.com/xap/1.0/mm/"> + <xmp:CreatorTool>SyntheticEditor 3.2</xmp:CreatorTool> + <xmpMM:InstanceID>xmp.iid:INSTANCE-XMP-7777</xmpMM:InstanceID> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> +` + xmpDest := filepath.Join(testPath, baseName+".xmp") + if writeErr := os.WriteFile(xmpDest, []byte(xmpContent), fs.ModeFile); writeErr != nil { + t.Fatalf("writing xmp sidecar failed: %s", writeErr) + } + + mainFile, err := NewMediaFile(jpegDest) + if err != nil { + t.Fatal(err) + } + + related, err := mainFile.RelatedFiles(true) + if err != nil { + t.Fatal(err) + } + + convert := NewConvert(cfg) + ind := NewIndex(cfg, convert, NewFiles(), NewPhotos()) + opt := IndexOptionsAll(cfg) + + result := IndexRelated(related, ind, opt) + assert.False(t, result.Failed()) + assert.True(t, result.Success()) + + primary, primaryErr := entity.PrimaryFile(result.PhotoUID) + if primaryErr != nil { + t.Fatal(primaryErr) + } + assert.Equal(t, "xmp.iid:INSTANCE-XMP-7777", primary.InstanceID) + assert.Equal(t, "SyntheticEditor 3.2", primary.FileSoftware) + }) + t.Run("XmpSidecarTimezoneFromGps", func(t *testing.T) { + // Apple sidecar timestamp "2021-03-24T13:07:29+01:00" with Berlin GPS + // (52.525, 13.369) must reach the entity as Europe/Berlin time zone + // with the wall-clock preserved on TakenAtLocal — proves the shared + // ResolveTimeZone helper runs on the IsXMP indexer branch. + cfg := newIndexRelatedTestConfig(t, "index-related-xmp-tz-gps") + + baseFile, err := NewMediaFile("testdata/apple-test-2.jpg") + if err != nil { + t.Fatal(err) + } + + testRelated, err := baseFile.RelatedFiles(true) + if err != nil { + t.Fatal(err) + } + + testToken := rnd.Base36(8) + testPath := filepath.Join(cfg.OriginalsPath(), testToken) + + for _, f := range testRelated.Files { + dest := filepath.Join(testPath, f.BaseName()) + if copyErr := f.Copy(dest, false); copyErr != nil { + t.Fatalf("copying test file failed: %s", copyErr) + } + } + + mainFile, err := NewMediaFile(filepath.Join(testPath, "apple-test-2.jpg")) + if err != nil { + t.Fatal(err) + } + + related, err := mainFile.RelatedFiles(true) + if err != nil { + t.Fatal(err) + } + + convert := NewConvert(cfg) + ind := NewIndex(cfg, convert, NewFiles(), NewPhotos()) + opt := IndexOptionsAll(cfg) + + result := IndexRelated(related, ind, opt) + assert.True(t, result.Success()) + + photo, err := query.PhotoByUID(result.PhotoUID) + if err != nil { + t.Fatal(err) + } + + assert.Equal(t, "Europe/Berlin", photo.TimeZone) + assert.Equal(t, "2021-03-24 12:07:29 +0000 UTC", photo.TakenAt.String()) + assert.Equal(t, "2021-03-24 13:07:29", photo.TakenAtLocal.Format("2006-01-02 15:04:05")) + assert.Equal(t, entity.SrcXmp, photo.TakenSrc) + }) + t.Run("XmpSidecarNoGpsNoOffset", func(t *testing.T) { + // Sidecar without GPS coordinates and without OffsetTime* — the + // resolver leaves data.TimeZone empty, and the entity layer's + // SetTakenAt maps the empty value to "Local" (its default for a + // timestamp with no derivable zone). The wall-clock is preserved + // verbatim on TakenAtLocal. + cfg := newIndexRelatedTestConfig(t, "index-related-xmp-tz-utc") + + baseFile, err := NewMediaFile("testdata/apple-test-2.jpg") + if err != nil { + t.Fatal(err) + } + + testToken := rnd.Base36(8) + testPath := filepath.Join(cfg.OriginalsPath(), testToken) + baseName := "xmp-tz-utc" + + jpegDest := filepath.Join(testPath, baseName+".jpg") + if copyErr := baseFile.Copy(jpegDest, false); copyErr != nil { + t.Fatalf("copying test file failed: %s", copyErr) + } + + xmpContent := `<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Test"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:photoshop="http://ns.adobe.com/photoshop/1.0/"> + <photoshop:DateCreated>2024-06-15T12:00:00</photoshop:DateCreated> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> +` + xmpDest := filepath.Join(testPath, baseName+".xmp") + if writeErr := os.WriteFile(xmpDest, []byte(xmpContent), fs.ModeFile); writeErr != nil { + t.Fatalf("writing xmp sidecar failed: %s", writeErr) + } + + mainFile, err := NewMediaFile(jpegDest) + if err != nil { + t.Fatal(err) + } + + related, err := mainFile.RelatedFiles(true) + if err != nil { + t.Fatal(err) + } + + convert := NewConvert(cfg) + ind := NewIndex(cfg, convert, NewFiles(), NewPhotos()) + opt := IndexOptionsAll(cfg) + + result := IndexRelated(related, ind, opt) + assert.True(t, result.Success()) + + photo, err := query.PhotoByUID(result.PhotoUID) + if err != nil { + t.Fatal(err) + } + + assert.Equal(t, "Local", photo.TimeZone) + assert.Equal(t, "2024-06-15 12:00:00 +0000 UTC", photo.TakenAt.String()) + assert.Equal(t, "2024-06-15 12:00:00", photo.TakenAtLocal.Format("2006-01-02 15:04:05")) + }) + t.Run("XmpSidecarGpsOverridesEmbedded", func(t *testing.T) { + // digikam.jpg carries embedded EXIF GPS in Berlin (52.46, 13.33). + // The synthesized XMP sidecar declares Tokyo coordinates so the + // override is unambiguous: photo.PhotoLat/PhotoLng must match the + // sidecar and photo.PlaceSrc must be tagged SrcXmp because + // SrcPriority[SrcXmp]=32 > SrcPriority[SrcMeta]=16. + cfg := newIndexRelatedTestConfig(t, "index-related-xmp-gps-override") + + baseFile, err := NewMediaFile("testdata/digikam.jpg") + if err != nil { + t.Fatal(err) + } + + testToken := rnd.Base36(8) + testPath := filepath.Join(cfg.OriginalsPath(), testToken) + baseName := "xmp-gps-override" + + jpegDest := filepath.Join(testPath, baseName+".jpg") + if copyErr := baseFile.Copy(jpegDest, false); copyErr != nil { + t.Fatalf("copying test file failed: %s", copyErr) + } + + xmpContent := `<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="PhotoPrism Test"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about="" + xmlns:exif="http://ns.adobe.com/exif/1.0/"> + <exif:GPSLatitude>35.6586</exif:GPSLatitude> + <exif:GPSLatitudeRef>N</exif:GPSLatitudeRef> + <exif:GPSLongitude>139.7454</exif:GPSLongitude> + <exif:GPSLongitudeRef>E</exif:GPSLongitudeRef> + </rdf:Description> + </rdf:RDF> +</x:xmpmeta> +` + xmpDest := filepath.Join(testPath, baseName+".xmp") + if writeErr := os.WriteFile(xmpDest, []byte(xmpContent), fs.ModeFile); writeErr != nil { + t.Fatalf("writing xmp sidecar failed: %s", writeErr) + } + + mainFile, err := NewMediaFile(jpegDest) + if err != nil { + t.Fatal(err) + } + + related, err := mainFile.RelatedFiles(true) + if err != nil { + t.Fatal(err) + } + + convert := NewConvert(cfg) + ind := NewIndex(cfg, convert, NewFiles(), NewPhotos()) + opt := IndexOptionsAll(cfg) + + result := IndexRelated(related, ind, opt) + assert.True(t, result.Success()) + + photo, err := query.PhotoByUID(result.PhotoUID) + if err != nil { + t.Fatal(err) + } + + // Sidecar GPS (Tokyo) overrides embedded EXIF GPS (Berlin). + assert.InDelta(t, 35.6586, photo.PhotoLat, 1e-3) + assert.InDelta(t, 139.7454, photo.PhotoLng, 1e-3) + assert.Equal(t, entity.SrcXmp, photo.PlaceSrc) + }) + t.Run("XmpSidecarMalformedFileMarkedAndJpegIndexed", func(t *testing.T) { + // A malformed XMP sidecar must not block JPEG indexing. The IsXMP + // branch logs a warning, sets FileError on the XMP file row, and + // the indexer proceeds with the remaining related files. + cfg := newIndexRelatedTestConfig(t, "index-related-xmp-malformed") + + baseFile, err := NewMediaFile("testdata/apple-test-2.jpg") + if err != nil { + t.Fatal(err) + } + + testToken := rnd.Base36(8) + testPath := filepath.Join(cfg.OriginalsPath(), testToken) + baseName := "xmp-malformed" + + jpegDest := filepath.Join(testPath, baseName+".jpg") + if copyErr := baseFile.Copy(jpegDest, false); copyErr != nil { + t.Fatalf("copying test file failed: %s", copyErr) + } + + // Truncated XML — opening tag never closed. + malformedXmp := `<?xml version="1.0" encoding="UTF-8"?> +<x:xmpmeta xmlns:x="adobe:ns:meta/"> + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <rdf:Description rdf:about=""> + <broken> +` + xmpDest := filepath.Join(testPath, baseName+".xmp") + if writeErr := os.WriteFile(xmpDest, []byte(malformedXmp), fs.ModeFile); writeErr != nil { + t.Fatalf("writing xmp sidecar failed: %s", writeErr) + } + + mainFile, err := NewMediaFile(jpegDest) + if err != nil { + t.Fatal(err) + } + + related, err := mainFile.RelatedFiles(true) + if err != nil { + t.Fatal(err) + } + + convert := NewConvert(cfg) + ind := NewIndex(cfg, convert, NewFiles(), NewPhotos()) + opt := IndexOptionsAll(cfg) + + result := IndexRelated(related, ind, opt) + + // JPEG indexing must succeed even though the sidecar is broken. + assert.True(t, result.Success()) + photo, err := query.PhotoByUID(result.PhotoUID) + if err != nil { + t.Fatal(err) + } + + // Locate the XMP file row and assert FileError is populated. + var xmpFile *entity.File + for _, f := range photo.AllFiles() { + if filepath.Ext(f.FileName) == ".xmp" { + file := f + xmpFile = &file + break + } + } + if assert.NotNil(t, xmpFile, "malformed XMP file row must exist") { + assert.NotEmpty(t, xmpFile.FileError, "FileError must record the parse failure") + } + }) } diff --git a/internal/photoprism/index_storage_test.go b/internal/photoprism/index_storage_test.go new file mode 100644 index 000000000..493def529 --- /dev/null +++ b/internal/photoprism/index_storage_test.go @@ -0,0 +1,64 @@ +package photoprism + +import ( + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/mutex" + "github.com/photoprism/photoprism/pkg/fs/disk" +) + +func TestIndex_StorageLow(t *testing.T) { + cfg := config.NewMinimalTestConfig(t.TempDir()) + ind := NewIndex(cfg, NewConvert(cfg), NewFiles(), NewPhotos()) + require.NotNil(t, ind) + + // Reset the storage-check latch, which an earlier test may have tripped by probing a + // temp path that duf cannot resolve to a mount point. + config.DisableStorageCheck.Store(false) + + // Seeding the cache keeps the verdict independent of the host filesystem and of + // duf's ability to resolve the temp directory to a mount point. + t.Run("Healthy", func(t *testing.T) { + disk.FlushFree() + t.Cleanup(disk.FlushFree) + disk.SetFree(cfg.StoragePath(), 999*disk.MB, 1000*disk.MB) + + assert.False(t, ind.storageLow()) + }) + + t.Run("Low", func(t *testing.T) { + disk.FlushFree() + t.Cleanup(disk.FlushFree) + disk.SetFree(cfg.StoragePath(), 1*disk.MB, 1000*disk.MB) + + assert.True(t, ind.storageLow()) + }) +} + +func TestIndex_abortInsufficientStorage(t *testing.T) { + cfg := config.NewMinimalTestConfig(t.TempDir()) + ind := NewIndex(cfg, NewConvert(cfg), NewFiles(), NewPhotos()) + require.NotNil(t, ind) + + t.Run("CancelsRunningWorker", func(t *testing.T) { + require.NoError(t, mutex.IndexWorker.Start()) + defer mutex.IndexWorker.Stop() + require.False(t, mutex.IndexWorker.Canceled()) + + ind.abortInsufficientStorage() + assert.True(t, mutex.IndexWorker.Canceled()) + }) + t.Run("IdempotentWhenAlreadyCanceled", func(t *testing.T) { + require.NoError(t, mutex.IndexWorker.Start()) + defer mutex.IndexWorker.Stop() + mutex.IndexWorker.Cancel() + require.True(t, mutex.IndexWorker.Canceled()) + + ind.abortInsufficientStorage() + assert.True(t, mutex.IndexWorker.Canceled()) + }) +} diff --git a/internal/photoprism/location_test.go b/internal/photoprism/location_test.go index eb01f06fe..e24dc93d7 100644 --- a/internal/photoprism/location_test.go +++ b/internal/photoprism/location_test.go @@ -14,7 +14,7 @@ func TestMediaFile_Location(t *testing.T) { c := config.TestConfig() t.Run("IphoneSevenHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) @@ -52,7 +52,7 @@ func TestMediaFile_Location(t *testing.T) { assert.Equal(t, "兵庫県", location2.State()) }) t.Run("IphoneFifteenProHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_15_pro.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_15_pro.heic") if err != nil { t.Fatal(err) @@ -89,7 +89,7 @@ func TestMediaFile_Location(t *testing.T) { assert.Equal(t, "Berlin", location2.State()) }) t.Run("IphoneXrJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_xr.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_xr.jpg") if err != nil { t.Fatal(err) @@ -125,7 +125,7 @@ func TestMediaFile_Location(t *testing.T) { assert.Equal(t, "岐阜県", location2.State()) }) t.Run("CatBrownJpg", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/cat_brown.jpg") + f, err := NewMediaFile(c.SamplesPath() + "/cat_brown.jpg") if err != nil { t.Fatal(err) @@ -147,7 +147,7 @@ func TestMediaFile_Location(t *testing.T) { assert.True(t, strings.HasPrefix(loc.ID, s2.TokenPrefix+"4799e4a5")) }) t.Run("DogOrangeJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/dog_orange.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/dog_orange.jpg") if err != nil { t.Fatal(err) @@ -160,7 +160,7 @@ func TestMediaFile_Location(t *testing.T) { } }) t.Run("RandomDocx", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/Random.docx") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/Random.docx") if err != nil { t.Fatal(err) diff --git a/internal/photoprism/mediafile.go b/internal/photoprism/mediafile.go index 3248c2b5a..5d1c43113 100644 --- a/internal/photoprism/mediafile.go +++ b/internal/photoprism/mediafile.go @@ -20,7 +20,6 @@ import ( "time" _ "golang.org/x/image/bmp" // register BMP decoder - _ "golang.org/x/image/tiff" // register TIFF decoder _ "golang.org/x/image/webp" // register WebP decoder "github.com/djherbis/times" @@ -357,8 +356,8 @@ func (m *MediaFile) PathNameInfo(stripSequence bool) (fileRoot, fileBase, relati rootPath = Config().SidecarPath() case entity.RootImport: rootPath = Config().ImportPath() - case entity.RootExamples: - rootPath = Config().ExamplesPath() + case entity.RootSamples: + rootPath = Config().SamplesPath() case entity.RootOriginals: rootPath = Config().OriginalsPath() default: @@ -446,8 +445,8 @@ func (m *MediaFile) RootPath() string { return Config().SidecarPath() case entity.RootImport: return Config().ImportPath() - case entity.RootExamples: - return Config().ExamplesPath() + case entity.RootSamples: + return Config().SamplesPath() default: return Config().OriginalsPath() } @@ -507,7 +506,7 @@ func (m *MediaFile) EditedName() string { } // Root identifies which configured root the media file resides in (originals, -// import, sidecar, examples). The result is cached so repeated calls are cheap. +// import, sidecar, samples). The result is cached so repeated calls are cheap. func (m *MediaFile) Root() string { if m.fileRoot != entity.RootUnknown { return m.fileRoot @@ -532,10 +531,10 @@ func (m *MediaFile) Root() string { return m.fileRoot } - examplesPath := Config().ExamplesPath() + samplesPath := Config().SamplesPath() - if examplesPath != "" && strings.HasPrefix(m.FileName(), examplesPath) { - m.fileRoot = entity.RootExamples + if samplesPath != "" && strings.HasPrefix(m.FileName(), samplesPath) { + m.fileRoot = entity.RootSamples return m.fileRoot } @@ -887,6 +886,16 @@ func (m *MediaFile) IsTiff() bool { return m.HasMimeType(header.ContentTypeTiff) } +// IsPsd checks if the file is an Adobe Photoshop image with a supported file type extension. +func (m *MediaFile) IsPsd() bool { + if fs.FileType(m.fileName) != fs.ImagePsd { + return false + } + + // Check the mime type after other tests have passed to improve performance. + return m.HasMimeType(header.ContentTypePsd) || m.HasMimeType(header.ContentTypePsdAlt) +} + // IsDng checks if the file is a Adobe Digital Negative (DNG) image with a supported file type extension. func (m *MediaFile) IsDng() bool { if fs.FileType(m.fileName) != fs.ImageDng { @@ -1029,6 +1038,8 @@ func (m *MediaFile) CheckType() error { valid = mimeType == header.ContentTypeGif case fs.ImageTiff: valid = mimeType == header.ContentTypeTiff + case fs.ImagePsd: + valid = mimeType == header.ContentTypePsd || mimeType == header.ContentTypePsdAlt case fs.ImageHeic, fs.ImageHeif: valid = mimeType == header.ContentTypeHeic || mimeType == header.ContentTypeHeicS default: @@ -1166,10 +1177,10 @@ func (m *MediaFile) SkipTranscoding() bool { return !m.NeedsTranscoding() } -// IsImageOther returns true if this is a PNG, GIF, BMP, TIFF, or WebP file. +// IsImageOther returns true if this is a PNG, GIF, BMP, TIFF, HEIC/HEIF, AVIF, or WebP file. func (m *MediaFile) IsImageOther() bool { switch { - case m.IsPng(), m.IsGif(), m.IsTiff(), m.IsBmp(), m.IsWebp(): + case m.IsPng(), m.IsGif(), m.IsTiff(), m.IsBmp(), m.IsHeic(), m.IsAvif(), m.IsWebp(): return true default: return false @@ -1220,7 +1231,7 @@ func (m *MediaFile) IsLive(videoDuration time.Duration) bool { // ExifSupported returns true if parsing exif metadata is supported for the media file type. func (m *MediaFile) ExifSupported() bool { - return m.IsJpeg() || m.IsRaw() || m.IsHeif() || m.IsPng() || m.IsTiff() + return m.IsJpeg() || m.IsRaw() || m.IsHeif() || m.IsPng() || m.IsTiff() || m.IsPsd() } // IsMedia returns true if this is a media file (photo or video, not sidecar or other). @@ -1303,21 +1314,29 @@ func (m *MediaFile) decodeDimensions() error { if m.IsImageNative() { cfg, err := m.DecodeConfig() - if err != nil { - return err + if err == nil { + orientation := m.Orientation() + + if orientation > 4 && orientation <= 8 { + m.width = cfg.Height + m.height = cfg.Width + } else { + m.width = cfg.Width + m.height = cfg.Height + } + + return nil } - orientation := m.Orientation() - - if orientation > 4 && orientation <= 8 { - m.width = cfg.Height - m.height = cfg.Width - } else { - m.width = cfg.Width - m.height = cfg.Height + // Fall back to metadata when native decoders cannot read layered TIFFs + // or other partially supported formats even though dimensions are present. + if data := m.MetaData(); data.Error == nil && data.ActualWidth() > 0 && data.ActualHeight() > 0 { + m.width = data.ActualWidth() + m.height = data.ActualHeight() + return nil } - return nil + return err } // Extract the width and height from metadata for other formats. diff --git a/internal/photoprism/mediafile_heic_test.go b/internal/photoprism/mediafile_heic_test.go index 75b46262a..2573c3ff7 100644 --- a/internal/photoprism/mediafile_heic_test.go +++ b/internal/photoprism/mediafile_heic_test.go @@ -19,7 +19,16 @@ func TestMediaFile_Heic(t *testing.T) { c := config.TestConfig() t.Run("IphoneSevenHeic", func(t *testing.T) { - img, err := NewMediaFile(filepath.Join(conf.ExamplesPath(), "iphone_7.heic")) + prevDisableHeifConvert := conf.Options().DisableHeifConvert + prevDisableImageMagick := conf.Options().DisableImageMagick + conf.Options().DisableHeifConvert = true + conf.Options().DisableImageMagick = true + t.Cleanup(func() { + conf.Options().DisableHeifConvert = prevDisableHeifConvert + conf.Options().DisableImageMagick = prevDisableImageMagick + }) + + img, err := NewMediaFile(filepath.Join(conf.SamplesPath(), "iphone_7.heic")) if err != nil { t.Fatal(err) @@ -56,8 +65,10 @@ func TestMediaFile_Heic(t *testing.T) { assert.Equal(t, "", jpegInfo.DocumentID) assert.Equal(t, "2018-09-10 03:16:13.023 +0000 UTC", jpegInfo.TakenAt.String()) assert.Equal(t, "2018-09-10 12:16:13.023 +0000 UTC", jpegInfo.TakenAtLocal.String()) - // KNOWN ISSUE: Orientation 6 would be correct instead (or the image should already be rotated), - // see https://github.com/strukturag/libheif/issues/227#issuecomment-1532842570 + // The native libvips/libheif path does not apply EXIF orientation for HEIF files + // because the HEIF spec treats it as informational only (see strukturag/libheif#227). + // This iPhone 7 file lacks an irot box and carries EXIF orientation 6, which is + // technically non-conformant. The output retains the raw sensor dimensions. assert.Equal(t, 1, jpegInfo.Orientation) assert.Equal(t, "iPhone 7", jpegInfo.CameraModel) assert.Equal(t, "Apple", jpegInfo.CameraMake) @@ -77,12 +88,21 @@ func TestMediaFile_Heic(t *testing.T) { assert.Equal(t, false, jpegInfo.Flash) assert.Equal(t, "", jpegInfo.Caption) - if err = os.Remove(filepath.Join(conf.SidecarPath(), conf.ExamplesPath(), "iphone_7.heic.jpg")); err != nil { + if err = os.Remove(filepath.Join(conf.SidecarPath(), conf.SamplesPath(), "iphone_7.heic.jpg")); err != nil { t.Error(err) } }) t.Run("IphoneFifteenProHeic", func(t *testing.T) { - img, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "iphone_15_pro.heic")) + prevDisableHeifConvert := c.Options().DisableHeifConvert + prevDisableImageMagick := c.Options().DisableImageMagick + c.Options().DisableHeifConvert = true + c.Options().DisableImageMagick = true + t.Cleanup(func() { + c.Options().DisableHeifConvert = prevDisableHeifConvert + c.Options().DisableImageMagick = prevDisableImageMagick + }) + + img, err := NewMediaFile(filepath.Join(c.SamplesPath(), "iphone_15_pro.heic")) if err != nil { t.Fatal(err) @@ -136,7 +156,41 @@ func TestMediaFile_Heic(t *testing.T) { assert.Equal(t, false, jpegInfo.Flash) assert.Equal(t, "", jpegInfo.Caption) - if err = os.Remove(filepath.Join(c.SidecarPath(), c.ExamplesPath(), "iphone_15_pro.heic.jpg")); err != nil { + if err = os.Remove(filepath.Join(c.SidecarPath(), c.SamplesPath(), "iphone_15_pro.heic.jpg")); err != nil { + t.Error(err) + } + }) + t.Run("FoxProfileAvif", func(t *testing.T) { + prevDisableHeifConvert := c.Options().DisableHeifConvert + prevDisableImageMagick := c.Options().DisableImageMagick + c.Options().DisableHeifConvert = true + c.Options().DisableImageMagick = true + t.Cleanup(func() { + c.Options().DisableHeifConvert = prevDisableHeifConvert + c.Options().DisableImageMagick = prevDisableImageMagick + }) + + img, err := NewMediaFile(filepath.Join(c.SamplesPath(), "fox.profile0.8bpc.yuv420.avif")) + + if err != nil { + t.Fatal(err) + } + + convert := NewConvert(c) + + jpeg, err := convert.ToImage(img, true) + + if err != nil { + t.Fatal(err) + } + + assert.NotNil(t, jpeg) + assert.True(t, jpeg.IsJpeg()) + assert.True(t, jpeg.Exists()) + assert.Greater(t, jpeg.Width(), 0) + assert.Greater(t, jpeg.Height(), 0) + + if err = os.Remove(filepath.Join(c.SidecarPath(), c.SamplesPath(), "fox.profile0.8bpc.yuv420.avif.jpg")); err != nil { t.Error(err) } }) diff --git a/internal/photoprism/mediafile_meta.go b/internal/photoprism/mediafile_meta.go index 10fce06f4..6e140b8e4 100644 --- a/internal/photoprism/mediafile_meta.go +++ b/internal/photoprism/mediafile_meta.go @@ -89,7 +89,7 @@ func (m *MediaFile) ReadExifToolJson() error { // MetaData returns cached EXIF/sidecar metadata. On first access it probes the // underlying file, merges JSON sidecars (including ExifTool exports) and -// normalises the time zone field. +// normalizes the time zone field. func (m *MediaFile) MetaData() (result meta.Data) { if !m.Ok() || !m.IsMedia() { // Not a main media file. diff --git a/internal/photoprism/mediafile_meta_test.go b/internal/photoprism/mediafile_meta_test.go index e6d1ec63e..aad7c4577 100644 --- a/internal/photoprism/mediafile_meta_test.go +++ b/internal/photoprism/mediafile_meta_test.go @@ -23,7 +23,7 @@ func TestMediaFile_HasSidecarJson(t *testing.T) { c := config.TestConfig() t.Run("False", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/beach_wood.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/beach_wood.jpg") if err != nil { t.Fatal(err) @@ -32,7 +32,7 @@ func TestMediaFile_HasSidecarJson(t *testing.T) { assert.False(t, mediaFile.HasSidecarJson()) }) t.Run("True", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/blue-go-video.mp4") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/blue-go-video.mp4") if err != nil { t.Fatal(err) @@ -41,7 +41,7 @@ func TestMediaFile_HasSidecarJson(t *testing.T) { assert.True(t, mediaFile.HasSidecarJson()) }) t.Run("True", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/blue-go-video.mp4.json") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/blue-go-video.mp4.json") if err != nil { t.Fatal(err) @@ -55,7 +55,7 @@ func TestMediaFile_SidecarJsonName(t *testing.T) { c := config.TestConfig() t.Run("False", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/beach_sand.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/beach_sand.jpg") if err != nil { t.Fatal(err) @@ -64,7 +64,7 @@ func TestMediaFile_SidecarJsonName(t *testing.T) { assert.Equal(t, "", mediaFile.SidecarJsonName()) }) t.Run("True", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/blue-go-video.mp4") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/blue-go-video.mp4") if err != nil { t.Fatal(err) @@ -79,7 +79,7 @@ func TestMediaFile_NeedsExifToolJson(t *testing.T) { t.Run("False", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/beach_sand.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/beach_sand.jpg") if err != nil { t.Fatal(err) @@ -88,7 +88,7 @@ func TestMediaFile_NeedsExifToolJson(t *testing.T) { assert.True(t, mediaFile.NeedsExifToolJson()) }) t.Run("True", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/blue-go-video.mp4") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/blue-go-video.mp4") if err != nil { t.Fatal(err) @@ -97,7 +97,7 @@ func TestMediaFile_NeedsExifToolJson(t *testing.T) { assert.True(t, mediaFile.NeedsExifToolJson()) }) t.Run("True", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/blue-go-video.mp4.json") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/blue-go-video.mp4.json") if err != nil { t.Fatal(err) @@ -111,7 +111,7 @@ func TestMediaFile_CreateExifToolJson(t *testing.T) { c := config.TestConfig() t.Run("BearM2ts", func(t *testing.T) { - mediaFile, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "bear.m2ts")) + mediaFile, err := NewMediaFile(filepath.Join(c.SamplesPath(), "bear.m2ts")) if err != nil { t.Fatal(err) @@ -169,7 +169,7 @@ func TestMediaFile_CreateExifToolJson(t *testing.T) { } }) t.Run("M2tsMp4", func(t *testing.T) { - mediaFile, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "m2ts.mp4")) + mediaFile, err := NewMediaFile(filepath.Join(c.SamplesPath(), "m2ts.mp4")) if err != nil { t.Fatal(err) @@ -219,7 +219,7 @@ func TestMediaFile_CreateExifToolJson(t *testing.T) { } }) t.Run("GopherVideoMp4", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/gopher-video.mp4") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/gopher-video.mp4") if err != nil { t.Fatal(err) @@ -270,7 +270,7 @@ func TestMediaFile_Exif_Jpeg(t *testing.T) { c := config.TestConfig() t.Run("ElephantsJpg", func(t *testing.T) { - img, err := NewMediaFile(c.ExamplesPath() + "/elephants.jpg") + img, err := NewMediaFile(c.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) @@ -308,7 +308,7 @@ func TestMediaFile_Exif_Jpeg(t *testing.T) { t.Logf("Local: %s", data.TakenAtLocal.String()) }) t.Run("FernGreenJpg", func(t *testing.T) { - img, err := NewMediaFile(c.ExamplesPath() + "/fern_green.jpg") + img, err := NewMediaFile(c.SamplesPath() + "/fern_green.jpg") if err != nil { t.Fatal(err) @@ -343,7 +343,7 @@ func TestMediaFile_Exif_Jpeg(t *testing.T) { t.Logf("Local: %s", info.TakenAtLocal.String()) }) t.Run("BlueGoVideoMp4", func(t *testing.T) { - img, err := NewMediaFile(c.ExamplesPath() + "/blue-go-video.mp4") + img, err := NewMediaFile(c.SamplesPath() + "/blue-go-video.mp4") if err != nil { t.Fatal(err) @@ -431,7 +431,7 @@ func TestMediaFile_Exif_Jpeg(t *testing.T) { func TestMediaFile_Exif_Dng(t *testing.T) { c := config.TestConfig() - img, err := NewMediaFile(c.ExamplesPath() + "/canon_eos_6d.dng") + img, err := NewMediaFile(c.SamplesPath() + "/canon_eos_6d.dng") assert.Nil(t, err) @@ -475,7 +475,7 @@ func TestMediaFile_VideoInfo(t *testing.T) { c := config.TestConfig() t.Run( "samsung-motion-photo.jpg", func(t *testing.T) { - fileName := filepath.Join(c.ExamplesPath(), "samsung-motion-photo.jpg") + fileName := filepath.Join(c.SamplesPath(), "samsung-motion-photo.jpg") mf, err := NewMediaFile(fileName) if err != nil { @@ -498,7 +498,7 @@ func TestMediaFile_VideoInfo(t *testing.T) { t.Run( "beach_sand.jpg", func(t *testing.T) { - fileName := filepath.Join(conf.ExamplesPath(), "beach_sand.jpg") + fileName := filepath.Join(conf.SamplesPath(), "beach_sand.jpg") mf, err := NewMediaFile(fileName) if err != nil { diff --git a/internal/photoprism/mediafile_related_test.go b/internal/photoprism/mediafile_related_test.go index df4d2edb3..0a916fe14 100644 --- a/internal/photoprism/mediafile_related_test.go +++ b/internal/photoprism/mediafile_related_test.go @@ -12,7 +12,7 @@ func TestMediaFile_RelatedFiles(t *testing.T) { c := config.TestConfig() t.Run("ExampleTif", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/example.tif") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/example.tif") if err != nil { t.Fatal(err) @@ -42,7 +42,7 @@ func TestMediaFile_RelatedFiles(t *testing.T) { t.Fatalf("extension should be longer: %s", extension) } - relativePath := result.RelPath(c.ExamplesPath()) + relativePath := result.RelPath(c.SamplesPath()) if len(relativePath) > 0 { t.Fatalf("relative path should be empty: %s", relativePath) @@ -50,13 +50,13 @@ func TestMediaFile_RelatedFiles(t *testing.T) { } }) t.Run("CanonEosSixDDng", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/canon_eos_6d.dng") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/canon_eos_6d.dng") if err != nil { t.Fatal(err) } - expectedBaseFilename := c.ExamplesPath() + "/canon_eos_6d" + expectedBaseFilename := c.SamplesPath() + "/canon_eos_6d" related, err := mediaFile.RelatedFiles(true) @@ -80,13 +80,13 @@ func TestMediaFile_RelatedFiles(t *testing.T) { } }) t.Run("IphoneSevenHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) } - expectedBaseFilename := c.ExamplesPath() + "/iphone_7" + expectedBaseFilename := c.SamplesPath() + "/iphone_7" related, err := mediaFile.RelatedFiles(true) @@ -104,20 +104,20 @@ func TestMediaFile_RelatedFiles(t *testing.T) { baseFilename := filename[0 : len(filename)-len(extension)] if result.IsJpeg() { - assert.Contains(t, expectedBaseFilename, "examples/iphone_7") + assert.Contains(t, expectedBaseFilename, "samples/iphone_7") } else { assert.Equal(t, expectedBaseFilename, baseFilename) } } }) t.Run("IphoneFifteenProHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_15_pro.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_15_pro.heic") if err != nil { t.Fatal(err) } - expectedBaseFilename := c.ExamplesPath() + "/iphone_15_pro" + expectedBaseFilename := c.SamplesPath() + "/iphone_15_pro" related, err := mediaFile.RelatedFiles(true) @@ -135,7 +135,7 @@ func TestMediaFile_RelatedFiles(t *testing.T) { baseFilename := filename[0 : len(filename)-len(extension)] if result.IsJpeg() { - assert.Contains(t, expectedBaseFilename, "examples/iphone_15_pro") + assert.Contains(t, expectedBaseFilename, "samples/iphone_15_pro") } else { assert.Equal(t, expectedBaseFilename, baseFilename) } @@ -225,7 +225,7 @@ func TestMediaFile_RelatedFiles(t *testing.T) { assert.Equal(t, "2015-02-04.jpg(1).json", related.Files[3].BaseName()) }) t.Run("Ordering", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/IMG_4120.JPG") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/IMG_4120.JPG") if err != nil { t.Fatal(err) @@ -239,8 +239,8 @@ func TestMediaFile_RelatedFiles(t *testing.T) { assert.Len(t, related.Files, 5) - assert.Equal(t, c.ExamplesPath()+"/IMG_4120.AAE", related.Files[0].FileName()) - assert.Equal(t, c.ExamplesPath()+"/IMG_4120.JPG", related.Files[1].FileName()) + assert.Equal(t, c.SamplesPath()+"/IMG_4120.AAE", related.Files[0].FileName()) + assert.Equal(t, c.SamplesPath()+"/IMG_4120.JPG", related.Files[1].FileName()) for _, result := range related.Files { filename := result.FileName() diff --git a/internal/photoprism/mediafile_test.go b/internal/photoprism/mediafile_test.go index 51ab890f0..fd1d17854 100644 --- a/internal/photoprism/mediafile_test.go +++ b/internal/photoprism/mediafile_test.go @@ -17,6 +17,8 @@ import ( "github.com/photoprism/photoprism/pkg/media" ) +var testSamplesPath = fs.Abs("../../assets/samples") + func TestMediaFileOk(t *testing.T) { c := config.TestConfig() cases := []struct { @@ -25,8 +27,8 @@ func TestMediaFileOk(t *testing.T) { expectErr bool wantOk bool }{ - {name: "existing file", path: c.ExamplesPath() + "/cat_black.jpg", wantOk: true}, - {name: "missing file", path: c.ExamplesPath() + "/xxz.jpg", expectErr: true, wantOk: false}, + {name: "existing file", path: c.SamplesPath() + "/cat_black.jpg", wantOk: true}, + {name: "missing file", path: c.SamplesPath() + "/xxz.jpg", expectErr: true, wantOk: false}, } for _, tc := range cases { @@ -52,8 +54,8 @@ func TestMediaFileEmpty(t *testing.T) { expectErr bool wantEmpty bool }{ - {name: "existing file", path: c.ExamplesPath() + "/cat_black.jpg", wantEmpty: false}, - {name: "missing file", path: c.ExamplesPath() + "/xxz.jpg", expectErr: true, wantEmpty: true}, + {name: "existing file", path: c.SamplesPath() + "/cat_black.jpg", wantEmpty: false}, + {name: "missing file", path: c.SamplesPath() + "/xxz.jpg", expectErr: true, wantEmpty: true}, } for _, tc := range cases { @@ -74,7 +76,7 @@ func TestMediaFileEmpty(t *testing.T) { func TestMediaFile_DateCreated(t *testing.T) { c := config.TestConfig() t.Run("TelegramNum2020Num01Num30Num09Num57EighteenJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") if err != nil { t.Fatal(err) } @@ -82,7 +84,7 @@ func TestMediaFile_DateCreated(t *testing.T) { assert.Equal(t, "2020-01-30 09:57:18 +0000 UTC", date.String()) }) t.Run("ScreenshotNum2019Num05Num21AtTenNum45Num52Png", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/Screenshot 2019-05-21 at 10.45.52.png") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/Screenshot 2019-05-21 at 10.45.52.png") if err != nil { t.Fatal(err) } @@ -90,7 +92,7 @@ func TestMediaFile_DateCreated(t *testing.T) { assert.Equal(t, "2019-05-21 10:45:52 +0000 UTC", date.String()) }) t.Run("IphoneSevenHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) } @@ -98,7 +100,7 @@ func TestMediaFile_DateCreated(t *testing.T) { assert.Equal(t, "2018-09-10 03:16:13 +0000 UTC", date.String()) }) t.Run("IphoneFifteenProHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_15_pro.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_15_pro.heic") if err != nil { t.Fatal(err) } @@ -107,7 +109,7 @@ func TestMediaFile_DateCreated(t *testing.T) { assert.Equal(t, "2023-10-31 10:44:43 +0000 UTC", mediaFile.DateCreated().String()) }) t.Run("CanonEosSixDDng", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/canon_eos_6d.dng") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/canon_eos_6d.dng") if err != nil { t.Fatal(err) } @@ -115,7 +117,7 @@ func TestMediaFile_DateCreated(t *testing.T) { assert.Equal(t, "2019-06-06 07:29:51 +0000 UTC", date.String()) }) t.Run("ElephantsJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/elephants.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) } @@ -123,7 +125,7 @@ func TestMediaFile_DateCreated(t *testing.T) { assert.Equal(t, "2013-11-26 13:53:55 +0000 UTC", date.String()) }) t.Run("DogCreatedNum1919Jpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/dog_created_1919.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/dog_created_1919.jpg") if err != nil { t.Fatal(err) } @@ -157,7 +159,7 @@ func TestMediaFile_TakenAt(t *testing.T) { assert.Equal(t, entity.SrcName, src) }) t.Run("TelegramNum2020Num01Num30Num09Num57EighteenJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") if err != nil { t.Fatal(err) } @@ -168,7 +170,7 @@ func TestMediaFile_TakenAt(t *testing.T) { assert.Equal(t, entity.SrcName, src) }) t.Run("ScreenshotNum2019Num05Num21AtTenNum45Num52Png", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/Screenshot 2019-05-21 at 10.45.52.png") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/Screenshot 2019-05-21 at 10.45.52.png") if err != nil { t.Fatal(err) } @@ -179,7 +181,7 @@ func TestMediaFile_TakenAt(t *testing.T) { assert.Equal(t, entity.SrcName, src) }) t.Run("IphoneSevenHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) } @@ -190,7 +192,7 @@ func TestMediaFile_TakenAt(t *testing.T) { assert.Equal(t, entity.SrcMeta, src) }) t.Run("CanonEosSixDDng", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/canon_eos_6d.dng") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/canon_eos_6d.dng") if err != nil { t.Fatal(err) } @@ -201,7 +203,7 @@ func TestMediaFile_TakenAt(t *testing.T) { assert.Equal(t, entity.SrcMeta, src) }) t.Run("ElephantsJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/elephants.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) } @@ -212,7 +214,7 @@ func TestMediaFile_TakenAt(t *testing.T) { assert.Equal(t, entity.SrcMeta, src) }) t.Run("DogCreatedNum1919Jpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/dog_created_1919.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/dog_created_1919.jpg") if err != nil { t.Fatal(err) } @@ -228,14 +230,14 @@ func TestMediaFile_HasTimeAndPlace(t *testing.T) { c := config.TestConfig() t.Run("BeachWoodJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/beach_wood.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/beach_wood.jpg") if err != nil { t.Fatal(err) } assert.True(t, mediaFile.HasTimeAndPlace()) }) t.Run("PeacockBlueJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/peacock_blue.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/peacock_blue.jpg") if err != nil { t.Fatal(err) } @@ -247,14 +249,14 @@ func TestMediaFile_CameraModel(t *testing.T) { c := config.TestConfig() t.Run("BeachWoodJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/beach_wood.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/beach_wood.jpg") if err != nil { t.Fatal(err) } assert.Equal(t, "iPhone SE", mediaFile.CameraModel()) }) t.Run("IphoneSevenHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) } @@ -266,14 +268,14 @@ func TestMediaFile_CameraMake(t *testing.T) { c := config.TestConfig() t.Run("BeachWoodJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/beach_wood.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/beach_wood.jpg") if err != nil { t.Fatal(err) } assert.Equal(t, "Apple", mediaFile.CameraMake()) }) t.Run("PeacockBlueJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/peacock_blue.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/peacock_blue.jpg") if err != nil { t.Fatal(err) } @@ -285,14 +287,14 @@ func TestMediaFile_LensModel(t *testing.T) { c := config.TestConfig() t.Run("BeachWoodJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/beach_wood.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/beach_wood.jpg") if err != nil { t.Fatal(err) } assert.Equal(t, "iPhone SE back camera 4.15mm f/2.2", mediaFile.LensModel()) }) t.Run("CanonEosSixDDng", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/canon_eos_6d.dng") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/canon_eos_6d.dng") if err != nil { t.Fatal(err) } @@ -304,14 +306,14 @@ func TestMediaFile_LensModel(t *testing.T) { func TestMediaFile_LensMake(t *testing.T) { c := config.TestConfig() t.Run("CatBrownJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/cat_brown.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/cat_brown.jpg") if err != nil { t.Fatal(err) } assert.Equal(t, "Apple", mediaFile.LensMake()) }) t.Run("ElephantsJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/elephants.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) } @@ -322,14 +324,14 @@ func TestMediaFile_LensMake(t *testing.T) { func TestMediaFile_FocalLength(t *testing.T) { c := config.TestConfig() t.Run("CatBrownJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/cat_brown.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/cat_brown.jpg") if err != nil { t.Fatal(err) } assert.Equal(t, 29, mediaFile.FocalLength()) }) t.Run("ElephantsJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/elephants.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) } @@ -340,14 +342,14 @@ func TestMediaFile_FocalLength(t *testing.T) { func TestMediaFile_FNumber(t *testing.T) { c := config.TestConfig() t.Run("CatBrownJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/cat_brown.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/cat_brown.jpg") if err != nil { t.Fatal(err) } assert.Equal(t, float32(2.2), mediaFile.FNumber()) }) t.Run("ElephantsJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/elephants.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) } @@ -358,14 +360,14 @@ func TestMediaFile_FNumber(t *testing.T) { func TestMediaFile_Iso(t *testing.T) { c := config.TestConfig() t.Run("CatBrownJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/cat_brown.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/cat_brown.jpg") if err != nil { t.Fatal(err) } assert.Equal(t, 32, mediaFile.Iso()) }) t.Run("ElephantsJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/elephants.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) } @@ -376,7 +378,7 @@ func TestMediaFile_Iso(t *testing.T) { func TestMediaFile_Exposure(t *testing.T) { c := config.TestConfig() t.Run("CatBrownJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/cat_brown.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/cat_brown.jpg") if err != nil { t.Fatal(err) @@ -385,7 +387,7 @@ func TestMediaFile_Exposure(t *testing.T) { assert.Equal(t, "1/50", mediaFile.Exposure()) }) t.Run("ElephantsJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/elephants.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) @@ -398,7 +400,7 @@ func TestMediaFile_Exposure(t *testing.T) { func TestMediaFileCanonicalName(t *testing.T) { c := config.TestConfig() - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/beach_wood.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/beach_wood.jpg") if err != nil { t.Fatal(err) @@ -413,7 +415,7 @@ func TestMediaFileCanonicalName(t *testing.T) { func TestMediaFileCanonicalNameFromFile(t *testing.T) { c := config.TestConfig() t.Run("BeachWoodJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/beach_wood.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/beach_wood.jpg") if err != nil { t.Fatal(err) @@ -422,7 +424,7 @@ func TestMediaFileCanonicalNameFromFile(t *testing.T) { assert.Equal(t, "beach_wood", mediaFile.CanonicalNameFromFile()) }) t.Run("AirportGrey", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/airport_grey") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/airport_grey") if err != nil { t.Fatal(err) @@ -435,24 +437,24 @@ func TestMediaFileCanonicalNameFromFile(t *testing.T) { func TestMediaFile_CanonicalNameFromFileWithDirectory(t *testing.T) { c := config.TestConfig() - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/beach_wood.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/beach_wood.jpg") if err != nil { t.Fatal(err) } - assert.Equal(t, c.ExamplesPath()+"/beach_wood", mediaFile.CanonicalNameFromFileWithDirectory()) + assert.Equal(t, c.SamplesPath()+"/beach_wood", mediaFile.CanonicalNameFromFileWithDirectory()) } func TestMediaFile_EditedFilename(t *testing.T) { c := config.TestConfig() t.Run("ImgNum4120Jpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/IMG_4120.JPG") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/IMG_4120.JPG") if err != nil { t.Fatal(err) } - assert.Equal(t, c.ExamplesPath()+"/IMG_E4120.JPG", mediaFile.EditedName()) + assert.Equal(t, c.SamplesPath()+"/IMG_E4120.JPG", mediaFile.EditedName()) }) t.Run("FernGreenJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/fern_green.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/fern_green.jpg") if err != nil { t.Fatal(err) } @@ -463,7 +465,7 @@ func TestMediaFile_EditedFilename(t *testing.T) { func TestMediaFile_SetFilename(t *testing.T) { c := config.TestConfig() - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/turtle_brown_blue.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/turtle_brown_blue.jpg") if err != nil { t.Fatal(err) } @@ -476,13 +478,13 @@ func TestMediaFile_SetFilename(t *testing.T) { func TestMediaFile_RootRelName(t *testing.T) { c := config.TestConfig() - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/tree_white.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/tree_white.jpg") if err != nil { t.Fatal(err) } - t.Run("ExamplesPath", func(t *testing.T) { + t.Run("SamplesPath", func(t *testing.T) { filename := mediaFile.RootRelName() assert.Equal(t, "tree_white.jpg", filename) }) @@ -491,30 +493,30 @@ func TestMediaFile_RootRelName(t *testing.T) { func TestMediaFile_RootRelPath(t *testing.T) { c := config.TestConfig() - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/tree_white.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/tree_white.jpg") mediaFile.fileRoot = entity.RootImport if err != nil { t.Fatal(err) } - t.Run("ExamplesPath", func(t *testing.T) { + t.Run("SamplesPath", func(t *testing.T) { path := mediaFile.RootRelPath() - assert.Equal(t, c.ExamplesPath(), path) + assert.Equal(t, c.SamplesPath(), path) }) } func TestMediaFile_RootPath(t *testing.T) { c := config.TestConfig() - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/tree_white.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/tree_white.jpg") if err != nil { t.Fatal(err) } mediaFile.fileRoot = entity.RootImport - t.Run("ExamplesPath", func(t *testing.T) { + t.Run("SamplesPath", func(t *testing.T) { path := mediaFile.RootPath() assert.Contains(t, path, "import") }) @@ -523,7 +525,7 @@ func TestMediaFile_RootPath(t *testing.T) { func TestMediaFile_RelName(t *testing.T) { c := config.TestConfig() - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/tree_white.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/tree_white.jpg") if err != nil { t.Fatal(err) @@ -531,18 +533,18 @@ func TestMediaFile_RelName(t *testing.T) { t.Run("DirectoryWithEndSlash", func(t *testing.T) { filename := mediaFile.RelName(c.AssetsPath()) - assert.Equal(t, "examples/tree_white.jpg", filename) + assert.Equal(t, "samples/tree_white.jpg", filename) }) t.Run("DirectoryWithoutEndSlash", func(t *testing.T) { filename := mediaFile.RelName(c.AssetsPath()) - assert.Equal(t, "examples/tree_white.jpg", filename) + assert.Equal(t, "samples/tree_white.jpg", filename) }) t.Run("DirectoryNotPartOfFilename", func(t *testing.T) { filename := mediaFile.RelName("xxx/") - assert.Equal(t, c.ExamplesPath()+"/tree_white.jpg", filename) + assert.Equal(t, c.SamplesPath()+"/tree_white.jpg", filename) }) t.Run("DirectoryEqualsExamplePath", func(t *testing.T) { - filename := mediaFile.RelName(c.ExamplesPath()) + filename := mediaFile.RelName(c.SamplesPath()) assert.Equal(t, "tree_white.jpg", filename) }) } @@ -550,7 +552,7 @@ func TestMediaFile_RelName(t *testing.T) { func TestMediaFile_RelativePath(t *testing.T) { c := config.TestConfig() - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/tree_white.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/tree_white.jpg") if err != nil { t.Fatal(err) @@ -558,37 +560,37 @@ func TestMediaFile_RelativePath(t *testing.T) { t.Run("DirectoryWithEndSlash", func(t *testing.T) { path := mediaFile.RelPath(c.AssetsPath() + "/") - assert.Equal(t, "examples", path) + assert.Equal(t, "samples", path) }) t.Run("DirectoryWithoutEndSlash", func(t *testing.T) { path := mediaFile.RelPath(c.AssetsPath()) - assert.Equal(t, "examples", path) + assert.Equal(t, "samples", path) }) t.Run("DirectoryEqualsFilepath", func(t *testing.T) { - path := mediaFile.RelPath(c.ExamplesPath()) + path := mediaFile.RelPath(c.SamplesPath()) assert.Equal(t, "", path) }) t.Run("DirectoryDoesNotMatchFilepath", func(t *testing.T) { path := mediaFile.RelPath("xxx") - assert.Equal(t, c.ExamplesPath(), path) + assert.Equal(t, c.SamplesPath(), path) }) - mediaFile, err = NewMediaFile(c.ExamplesPath() + "/.photoprism/example.jpg") + mediaFile, err = NewMediaFile(c.SamplesPath() + "/.photoprism/example.jpg") if err != nil { t.Fatal(err) } t.Run("Hidden", func(t *testing.T) { - path := mediaFile.RelPath(c.ExamplesPath()) + path := mediaFile.RelPath(c.SamplesPath()) assert.Equal(t, "", path) }) t.Run("HiddenEmpty", func(t *testing.T) { path := mediaFile.RelPath("") - assert.Equal(t, c.ExamplesPath(), path) + assert.Equal(t, c.SamplesPath(), path) }) t.Run("HiddenRoot", func(t *testing.T) { - path := mediaFile.RelPath(filepath.Join(c.ExamplesPath(), fs.PPHiddenPathname)) + path := mediaFile.RelPath(filepath.Join(c.SamplesPath(), fs.PPHiddenPathname)) assert.Equal(t, "", path) }) } @@ -596,21 +598,21 @@ func TestMediaFile_RelativePath(t *testing.T) { func TestMediaFile_RelativeBasename(t *testing.T) { c := config.TestConfig() - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/tree_white.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/tree_white.jpg") if err != nil { t.Fatal(err) } t.Run("DirectoryWithEndSlash", func(t *testing.T) { basename := mediaFile.RelPrefix(c.AssetsPath()+"/", true) - assert.Equal(t, "examples/tree_white", basename) + assert.Equal(t, "samples/tree_white", basename) }) t.Run("DirectoryWithoutEndSlash", func(t *testing.T) { basename := mediaFile.RelPrefix(c.AssetsPath(), true) - assert.Equal(t, "examples/tree_white", basename) + assert.Equal(t, "samples/tree_white", basename) }) t.Run("DirectoryEqualsExamplePath", func(t *testing.T) { - basename := mediaFile.RelPrefix(c.ExamplesPath(), true) + basename := mediaFile.RelPrefix(c.SamplesPath(), true) assert.Equal(t, "tree_white", basename) }) @@ -619,41 +621,41 @@ func TestMediaFile_RelativeBasename(t *testing.T) { func TestMediaFile_Directory(t *testing.T) { c := config.TestConfig() t.Run("LimesJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/limes.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/limes.jpg") if err != nil { t.Fatal(err) } - assert.Equal(t, c.ExamplesPath(), mediaFile.Dir()) + assert.Equal(t, c.SamplesPath(), mediaFile.Dir()) }) } func TestMediaFile_AbsPrefix(t *testing.T) { c := config.TestConfig() t.Run("LimesJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/limes.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/limes.jpg") if err != nil { t.Fatal(err) } - expected := c.ExamplesPath() + "/limes" + expected := c.SamplesPath() + "/limes" assert.Equal(t, expected, mediaFile.AbsPrefix(true)) }) t.Run("ImgNum4120CopyJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/IMG_4120 copy.JPG") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/IMG_4120 copy.JPG") if err != nil { t.Fatal(err) } - expected := c.ExamplesPath() + "/IMG_4120" + expected := c.SamplesPath() + "/IMG_4120" assert.Equal(t, expected, mediaFile.AbsPrefix(true)) }) t.Run("ImgNum4120OneJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/IMG_4120 (1).JPG") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/IMG_4120 (1).JPG") if err != nil { t.Fatal(err) } - expected := c.ExamplesPath() + "/IMG_4120" + expected := c.SamplesPath() + "/IMG_4120" assert.Equal(t, expected, mediaFile.AbsPrefix(true)) }) } @@ -661,21 +663,21 @@ func TestMediaFile_AbsPrefix(t *testing.T) { func TestMediaFile_BasePrefix(t *testing.T) { c := config.TestConfig() t.Run("LimesJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/limes.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/limes.jpg") if err != nil { t.Fatal(err) } assert.Equal(t, "limes", mediaFile.BasePrefix(true)) }) t.Run("ImgNum4120CopyJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/IMG_4120 copy.JPG") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/IMG_4120 copy.JPG") if err != nil { t.Fatal(err) } assert.Equal(t, "IMG_4120", mediaFile.BasePrefix(true)) }) t.Run("ImgNum4120OneJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/IMG_4120 (1).JPG") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/IMG_4120 (1).JPG") if err != nil { t.Fatal(err) } @@ -686,14 +688,14 @@ func TestMediaFile_BasePrefix(t *testing.T) { func TestMediaFile_MimeType(t *testing.T) { c := config.TestConfig() t.Run("ElephantsJpg", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/elephants.jpg") + f, err := NewMediaFile(c.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) } assert.Equal(t, "image/jpeg", f.MimeType()) }) t.Run("CanonEosSixDDng", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/canon_eos_6d.dng") + f, err := NewMediaFile(c.SamplesPath() + "/canon_eos_6d.dng") if err != nil { t.Fatal(err) } @@ -703,7 +705,7 @@ func TestMediaFile_MimeType(t *testing.T) { assert.True(t, f.IsRaw()) }) t.Run("IphoneSevenXmp", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.xmp") + f, err := NewMediaFile(c.SamplesPath() + "/iphone_7.xmp") if err != nil { t.Fatal(err) @@ -715,14 +717,14 @@ func TestMediaFile_MimeType(t *testing.T) { assert.True(t, f.HasMimeType("text/plain")) }) t.Run("IphoneSevenJson", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.json") + f, err := NewMediaFile(c.SamplesPath() + "/iphone_7.json") if err != nil { t.Fatal(err) } assert.True(t, fs.SameType(header.ContentTypeJson, f.MimeType())) }) t.Run("FoxProfile0EightBpcYuv420Avif", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/fox.profile0.8bpc.yuv420.avif") + f, err := NewMediaFile(c.SamplesPath() + "/fox.profile0.8bpc.yuv420.avif") if err != nil { t.Fatal(err) } @@ -730,7 +732,7 @@ func TestMediaFile_MimeType(t *testing.T) { assert.True(t, f.IsAvif()) }) t.Run("IphoneSevenHeic", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.heic") + f, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) } @@ -740,7 +742,7 @@ func TestMediaFile_MimeType(t *testing.T) { assert.False(t, f.IsVideo()) }) t.Run("ImgNum4120Aae", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/IMG_4120.AAE") + f, err := NewMediaFile(c.SamplesPath() + "/IMG_4120.AAE") if err != nil { t.Fatal(err) } @@ -752,7 +754,7 @@ func TestMediaFile_MimeType(t *testing.T) { assert.False(t, f.IsMov()) }) t.Run("EarthMov", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "earth.mov")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "earth.mov")); err != nil { t.Fatal(err) } else { assert.Equal(t, "video/quicktime", f.MimeType()) @@ -762,7 +764,7 @@ func TestMediaFile_MimeType(t *testing.T) { } }) t.Run("BlueGoVideoMp4", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "blue-go-video.mp4")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "blue-go-video.mp4")); err != nil { t.Fatal(err) } else { assert.Equal(t, "video/mp4", f.MimeType()) @@ -772,7 +774,7 @@ func TestMediaFile_MimeType(t *testing.T) { } }) t.Run("BearM2ts", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "bear.m2ts")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "bear.m2ts")); err != nil { t.Fatal(err) } else { assert.True(t, f.IsM2TS()) @@ -782,7 +784,7 @@ func TestMediaFile_MimeType(t *testing.T) { } }) t.Run("M2tsMp4", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "m2ts.mp4")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "m2ts.mp4")); err != nil { t.Fatal(err) } else { assert.False(t, f.IsM2TS()) @@ -792,7 +794,7 @@ func TestMediaFile_MimeType(t *testing.T) { } }) t.Run("EarthAvi", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "earth.avi")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "earth.avi")); err != nil { t.Fatal(err) } else { assert.Equal(t, "video/x-msvideo", f.MimeType()) @@ -812,12 +814,20 @@ func TestMediaFile_MimeType(t *testing.T) { assert.Equal(t, "image/x-icon", f.MimeType()) } }) + t.Run("PhotoshopStandardSmallPsd", func(t *testing.T) { + if f, err := NewMediaFile(filepath.Join(testSamplesPath, "photoshop-standard-small.psd")); err != nil { + t.Fatal(err) + } else { + assert.Equal(t, header.ContentTypePsd, f.MimeType()) + assert.True(t, f.IsPsd()) + } + }) } func TestMediaFile_Exists(t *testing.T) { c := config.TestConfig() - exists, err := NewMediaFile(c.ExamplesPath() + "/cat_black.jpg") + exists, err := NewMediaFile(c.SamplesPath() + "/cat_black.jpg") if err != nil { t.Fatal(err) @@ -828,7 +838,7 @@ func TestMediaFile_Exists(t *testing.T) { assert.True(t, exists.Ok()) assert.False(t, exists.Empty()) - missing, err := NewMediaFile(c.ExamplesPath() + "/xxz.jpg") + missing, err := NewMediaFile(c.SamplesPath() + "/xxz.jpg") assert.NotNil(t, missing) assert.Error(t, err) @@ -840,7 +850,7 @@ func TestMediaFile_Exists(t *testing.T) { func TestMediaFile_SetModTime(t *testing.T) { c := config.TestConfig() - f1, err := NewMediaFile(c.ExamplesPath() + "/cat_black.jpg") + f1, err := NewMediaFile(c.SamplesPath() + "/cat_black.jpg") if err != nil { t.Fatal(err) @@ -855,7 +865,7 @@ func TestMediaFile_SetModTime(t *testing.T) { assert.False(t, f1.ModTime().After(time.Unix(946684861, 0))) - f2, err2 := NewMediaFile(c.ExamplesPath() + "/cat_black.jpg") + f2, err2 := NewMediaFile(c.SamplesPath() + "/cat_black.jpg") if err2 != nil { t.Fatal(err2) @@ -883,7 +893,7 @@ func TestMediaFile_Move(t *testing.T) { defer os.RemoveAll(tmpPath) - f, err := NewMediaFile(c.ExamplesPath() + "/table_white.jpg") + f, err := NewMediaFile(c.SamplesPath() + "/table_white.jpg") if err != nil { t.Fatal(err) @@ -920,7 +930,7 @@ func TestMediaFile_Copy(t *testing.T) { defer os.RemoveAll(tmpPath) - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/table_white.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/table_white.jpg") if err != nil { t.Fatal(err) @@ -937,28 +947,28 @@ func TestMediaFile_Copy(t *testing.T) { func TestMediaFile_Extension(t *testing.T) { c := config.TestConfig() t.Run("IphoneSevenJson", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.json") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.json") if err != nil { t.Fatal(err) } assert.Equal(t, ".json", mediaFile.Extension()) }) t.Run("IphoneSevenHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) } assert.Equal(t, ".heic", mediaFile.Extension()) }) t.Run("CanonEosSixDDng", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/canon_eos_6d.dng") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/canon_eos_6d.dng") if err != nil { t.Fatal(err) } assert.Equal(t, ".dng", mediaFile.Extension()) }) t.Run("ElephantsJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/elephants.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) } @@ -969,28 +979,28 @@ func TestMediaFile_Extension(t *testing.T) { func TestMediaFile_IsJpeg(t *testing.T) { c := config.TestConfig() t.Run("IphoneSevenJson", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.json") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.json") if err != nil { t.Fatal(err) } assert.False(t, mediaFile.IsJpeg()) }) t.Run("IphoneSevenHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) } assert.False(t, mediaFile.IsJpeg()) }) t.Run("CanonEosSixDDng", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/canon_eos_6d.dng") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/canon_eos_6d.dng") if err != nil { t.Fatal(err) } assert.False(t, mediaFile.IsJpeg()) }) t.Run("ElephantsJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/elephants.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) } @@ -1001,28 +1011,28 @@ func TestMediaFile_IsJpeg(t *testing.T) { func TestMediaFile_HasType(t *testing.T) { c := config.TestConfig() t.Run("IphoneSevenHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) } assert.False(t, mediaFile.HasFileType("jpg")) }) t.Run("FoxProfile0EightBpcYuv420Avif", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/fox.profile0.8bpc.yuv420.avif") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/fox.profile0.8bpc.yuv420.avif") if err != nil { t.Fatal(err) } assert.True(t, mediaFile.HasFileType("avif")) }) t.Run("IphoneSevenHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) } assert.True(t, mediaFile.HasFileType("heic")) }) t.Run("IphoneSevenXmp", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.xmp") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.xmp") if err != nil { t.Fatal(err) } @@ -1033,28 +1043,28 @@ func TestMediaFile_HasType(t *testing.T) { func TestMediaFile_IsHeic(t *testing.T) { c := config.TestConfig() t.Run("IphoneSevenJson", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.json") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.json") if err != nil { t.Fatal(err) } assert.False(t, mediaFile.IsHeic()) }) t.Run("IphoneSevenHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) } assert.True(t, mediaFile.IsHeic()) }) t.Run("CanonEosSixDDng", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/canon_eos_6d.dng") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/canon_eos_6d.dng") if err != nil { t.Fatal(err) } assert.False(t, mediaFile.IsHeic()) }) t.Run("ElephantsJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/elephants.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) } @@ -1065,21 +1075,21 @@ func TestMediaFile_IsHeic(t *testing.T) { func TestMediaFile_IsRaw(t *testing.T) { c := config.TestConfig() t.Run("IphoneSevenJson", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.json") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.json") if err != nil { t.Fatal(err) } assert.False(t, mediaFile.IsRaw()) }) t.Run("IphoneSevenHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) } assert.False(t, mediaFile.IsRaw()) }) t.Run("CanonEosSixDDng", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/canon_eos_6d.dng") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/canon_eos_6d.dng") if err != nil { t.Fatal(err) } @@ -1087,7 +1097,7 @@ func TestMediaFile_IsRaw(t *testing.T) { assert.True(t, mediaFile.IsRaw()) }) t.Run("ElephantsJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/elephants.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) } @@ -1098,14 +1108,14 @@ func TestMediaFile_IsRaw(t *testing.T) { func TestMediaFile_IsPng(t *testing.T) { c := config.TestConfig() t.Run("IphoneSevenJson", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.json") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.json") if err != nil { t.Fatal(err) } assert.False(t, mediaFile.IsPng()) }) t.Run("TweethogPng", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/tweethog.png") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/tweethog.png") if err != nil { t.Fatal(err) @@ -1120,7 +1130,7 @@ func TestMediaFile_IsPng(t *testing.T) { func TestMediaFile_IsTiff(t *testing.T) { c := config.TestConfig() t.Run("IphoneSevenJson", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.json") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.json") if err != nil { t.Fatal(err) } @@ -1129,7 +1139,7 @@ func TestMediaFile_IsTiff(t *testing.T) { assert.False(t, mediaFile.IsTiff()) }) t.Run("PurpleTiff", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/purple.tiff") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/purple.tiff") if err != nil { t.Fatal(err) } @@ -1138,7 +1148,7 @@ func TestMediaFile_IsTiff(t *testing.T) { assert.True(t, mediaFile.IsTiff()) }) t.Run("ExampleTiff", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/example.tif") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/example.tif") if err != nil { t.Fatal(err) } @@ -1148,24 +1158,63 @@ func TestMediaFile_IsTiff(t *testing.T) { }) } +func TestMediaFile_IsPsd(t *testing.T) { + t.Run("PhotoshopStandardSmallPsd", func(t *testing.T) { + mediaFile, err := NewMediaFile(filepath.Join(testSamplesPath, "photoshop-standard-small.psd")) + if err != nil { + t.Fatal(err) + } + assert.Equal(t, fs.ImagePsd, mediaFile.FileType()) + assert.Equal(t, header.ContentTypePsd, mediaFile.MimeType()) + assert.True(t, mediaFile.IsPsd()) + assert.True(t, mediaFile.ExifSupported()) + assert.False(t, mediaFile.IsImageOther()) + }) +} + func TestMediaFile_IsImageOther(t *testing.T) { c := config.TestConfig() t.Run("IphoneSevenJson", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.json") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.json") if err != nil { t.Fatal(err) } assert.False(t, mediaFile.IsImageOther()) }) + t.Run("IphoneSevenHeic", func(t *testing.T) { + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") + if err != nil { + t.Fatal(err) + } + assert.True(t, mediaFile.IsImageOther()) + assert.True(t, mediaFile.IsImageNative()) + }) + t.Run("FoxProfileAvif", func(t *testing.T) { + mediaFile, err := NewMediaFile(c.SamplesPath() + "/fox.profile0.8bpc.yuv420.avif") + if err != nil { + t.Fatal(err) + } + assert.True(t, mediaFile.IsImageOther()) + assert.True(t, mediaFile.IsImageNative()) + }) t.Run("PurpleTiff", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/purple.tiff") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/purple.tiff") if err != nil { t.Fatal(err) } assert.True(t, mediaFile.IsImageOther()) }) + t.Run("PhotoshopStandardSmallPsd", func(t *testing.T) { + mediaFile, err := NewMediaFile(filepath.Join(testSamplesPath, "photoshop-standard-small.psd")) + if err != nil { + t.Fatal(err) + } + assert.True(t, mediaFile.IsPsd()) + assert.False(t, mediaFile.IsImageOther()) + assert.False(t, mediaFile.IsImageNative()) + }) t.Run("TweethogPng", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/tweethog.png") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/tweethog.png") if err != nil { t.Fatal(err) } @@ -1181,7 +1230,7 @@ func TestMediaFile_IsImageOther(t *testing.T) { assert.True(t, mediaFile.SkipTranscoding()) }) t.Run("YellowRoseSmallBmp", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/yellow_rose-small.bmp") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/yellow_rose-small.bmp") if err != nil { t.Fatal(err) } @@ -1198,7 +1247,7 @@ func TestMediaFile_IsImageOther(t *testing.T) { assert.True(t, mediaFile.SkipTranscoding()) }) t.Run("PreloaderGif", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/preloader.gif") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/preloader.gif") if err != nil { t.Fatal(err) } @@ -1252,6 +1301,13 @@ func TestMediaFile_CheckType(t *testing.T) { assert.NoError(t, f.CheckType()) } }) + t.Run("PSD", func(t *testing.T) { + if f, err := NewMediaFile(filepath.Join(testSamplesPath, "photoshop-standard-small.psd")); err != nil { + t.Fatal(err) + } else { + assert.NoError(t, f.CheckType()) + } + }) t.Run("WebP", func(t *testing.T) { if f, err := NewMediaFile("testdata/windows95.webp"); err != nil { t.Fatal(err) @@ -1260,21 +1316,21 @@ func TestMediaFile_CheckType(t *testing.T) { } }) t.Run("HEIC", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "iphone_7.heic")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "iphone_7.heic")); err != nil { t.Fatal(err) } else { assert.NoError(t, f.CheckType()) } }) t.Run("DNG", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "canon_eos_6d.dng")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "canon_eos_6d.dng")); err != nil { t.Fatal(err) } else { assert.NoError(t, f.CheckType()) } }) t.Run("MP4", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "christmas.mp4")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "christmas.mp4")); err != nil { t.Fatal(err) } else { assert.NoError(t, f.CheckType()) @@ -1288,14 +1344,14 @@ func TestMediaFile_CheckType(t *testing.T) { } }) t.Run("JSON", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "iphone_7.json")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "iphone_7.json")); err != nil { t.Fatal(err) } else { assert.NoError(t, f.CheckType()) } }) t.Run("Zip", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "example.zip")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "example.zip")); err != nil { t.Fatal(err) } else { assert.NoError(t, f.CheckType()) @@ -1315,24 +1371,24 @@ func TestMediaFile_CheckType(t *testing.T) { func TestMediaFile_IsSidecar(t *testing.T) { cfg := config.TestConfig() t.Run("ExampleZip", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/example.zip") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/example.zip") assert.Nil(t, err) assert.True(t, mediaFile.IsArchive()) }) t.Run("IphoneSevenXmp", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/iphone_7.xmp") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/iphone_7.xmp") assert.Nil(t, err) assert.True(t, mediaFile.IsSidecar()) }) t.Run("ImgNum4120Aae", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/IMG_4120.AAE") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/IMG_4120.AAE") if err != nil { t.Fatal(err) } assert.True(t, mediaFile.IsSidecar()) }) t.Run("TestXml", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/test.xml") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/test.xml") if err != nil { t.Fatal(err) @@ -1340,7 +1396,7 @@ func TestMediaFile_IsSidecar(t *testing.T) { assert.True(t, mediaFile.IsSidecar()) }) t.Run("TestTxt", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/test.txt") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/test.txt") if err != nil { t.Fatal(err) @@ -1348,7 +1404,7 @@ func TestMediaFile_IsSidecar(t *testing.T) { assert.True(t, mediaFile.IsSidecar()) }) t.Run("TestYml", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/test.yml") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/test.yml") if err != nil { t.Fatal(err) @@ -1356,7 +1412,7 @@ func TestMediaFile_IsSidecar(t *testing.T) { assert.True(t, mediaFile.IsSidecar()) }) t.Run("TestMd", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/test.md") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/test.md") if err != nil { t.Fatal(err) @@ -1364,7 +1420,7 @@ func TestMediaFile_IsSidecar(t *testing.T) { assert.True(t, mediaFile.IsSidecar()) }) t.Run("CanonEosSixDDng", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/canon_eos_6d.dng") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/canon_eos_6d.dng") if err != nil { t.Fatal(err) @@ -1376,24 +1432,24 @@ func TestMediaFile_IsSidecar(t *testing.T) { func TestMediaFile_IsArchive(t *testing.T) { cfg := config.TestConfig() t.Run("ExampleZip", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/example.zip") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/example.zip") assert.Nil(t, err) assert.True(t, mediaFile.IsArchive()) }) t.Run("IphoneSevenXmp", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/iphone_7.xmp") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/iphone_7.xmp") assert.Nil(t, err) assert.False(t, mediaFile.IsArchive()) }) t.Run("ImgNum4120Aae", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/IMG_4120.AAE") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/IMG_4120.AAE") if err != nil { t.Fatal(err) } assert.False(t, mediaFile.IsArchive()) }) t.Run("TestXml", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/test.xml") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/test.xml") if err != nil { t.Fatal(err) @@ -1401,7 +1457,7 @@ func TestMediaFile_IsArchive(t *testing.T) { assert.False(t, mediaFile.IsArchive()) }) t.Run("TestTxt", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/test.txt") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/test.txt") if err != nil { t.Fatal(err) @@ -1409,7 +1465,7 @@ func TestMediaFile_IsArchive(t *testing.T) { assert.False(t, mediaFile.IsArchive()) }) t.Run("TestYml", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/test.yml") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/test.yml") if err != nil { t.Fatal(err) @@ -1417,7 +1473,7 @@ func TestMediaFile_IsArchive(t *testing.T) { assert.False(t, mediaFile.IsArchive()) }) t.Run("TestMd", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/test.md") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/test.md") if err != nil { t.Fatal(err) @@ -1425,7 +1481,7 @@ func TestMediaFile_IsArchive(t *testing.T) { assert.False(t, mediaFile.IsArchive()) }) t.Run("CanonEosSixDDng", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/canon_eos_6d.dng") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/canon_eos_6d.dng") if err != nil { t.Fatal(err) @@ -1436,7 +1492,7 @@ func TestMediaFile_IsArchive(t *testing.T) { func TestMediaFile_IsImage(t *testing.T) { c := config.TestConfig() t.Run("IphoneSevenJson", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.json") + f, err := NewMediaFile(c.SamplesPath() + "/iphone_7.json") if err != nil { t.Fatal(err) } @@ -1445,14 +1501,14 @@ func TestMediaFile_IsImage(t *testing.T) { assert.True(t, f.IsSidecar()) }) t.Run("IphoneSevenXmp", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.xmp") + f, err := NewMediaFile(c.SamplesPath() + "/iphone_7.xmp") assert.Nil(t, err) assert.False(t, f.IsImage()) assert.False(t, f.IsRaw()) assert.True(t, f.IsSidecar()) }) t.Run("IphoneSevenHeic", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.heic") + f, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) } @@ -1461,7 +1517,7 @@ func TestMediaFile_IsImage(t *testing.T) { assert.False(t, f.IsSidecar()) }) t.Run("CanonEosSixDDng", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/canon_eos_6d.dng") + f, err := NewMediaFile(c.SamplesPath() + "/canon_eos_6d.dng") if err != nil { t.Fatal(err) } @@ -1470,7 +1526,7 @@ func TestMediaFile_IsImage(t *testing.T) { assert.False(t, f.IsSidecar()) }) t.Run("ElephantsJpg", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/elephants.jpg") + f, err := NewMediaFile(c.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) } @@ -1483,7 +1539,7 @@ func TestMediaFile_IsImage(t *testing.T) { func TestMediaFile_IsVideo(t *testing.T) { c := config.TestConfig() t.Run("ChristmasMp4", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "christmas.mp4")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "christmas.mp4")); err != nil { t.Fatal(err) } else { assert.False(t, f.IsRaw()) @@ -1494,7 +1550,7 @@ func TestMediaFile_IsVideo(t *testing.T) { } }) t.Run("CanonEosSixDDng", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "canon_eos_6d.dng")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "canon_eos_6d.dng")); err != nil { t.Fatal(err) } else { assert.True(t, f.IsRaw()) @@ -1505,7 +1561,7 @@ func TestMediaFile_IsVideo(t *testing.T) { } }) t.Run("IphoneSevenJson", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "iphone_7.json")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "iphone_7.json")); err != nil { t.Fatal(err) } else { assert.False(t, f.IsRaw()) @@ -1533,7 +1589,7 @@ func TestMediaFile_IsLive(t *testing.T) { } }) t.Run("ChristmasMp4", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "christmas.mp4")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "christmas.mp4")); err != nil { t.Fatal(err) } else { assert.False(t, f.IsLive(time.Second*3)) @@ -1545,7 +1601,7 @@ func TestMediaFile_IsLive(t *testing.T) { } }) t.Run("CanonEosSixDDng", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "canon_eos_6d.dng")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "canon_eos_6d.dng")); err != nil { t.Fatal(err) } else { assert.False(t, f.IsLive(time.Second*3)) @@ -1557,7 +1613,7 @@ func TestMediaFile_IsLive(t *testing.T) { } }) t.Run("IphoneSevenJson", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "iphone_7.json")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "iphone_7.json")); err != nil { t.Fatal(err) } else { assert.False(t, f.IsLive(time.Second*3)) @@ -1611,7 +1667,7 @@ func TestMediaFile_IsAnimated(t *testing.T) { } }) t.Run("ExampleGif", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "example.gif")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "example.gif")); err != nil { t.Fatal(err) } else { assert.True(t, f.IsImage()) @@ -1624,7 +1680,7 @@ func TestMediaFile_IsAnimated(t *testing.T) { } }) t.Run("PythagorasGif", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "pythagoras.gif")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "pythagoras.gif")); err != nil { t.Fatal(err) } else { assert.True(t, f.IsImage()) @@ -1637,7 +1693,7 @@ func TestMediaFile_IsAnimated(t *testing.T) { } }) t.Run("ChristmasMp4", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "christmas.mp4")); err != nil { + if f, err := NewMediaFile(filepath.Join(c.SamplesPath(), "christmas.mp4")); err != nil { t.Fatal(err) } else { assert.False(t, f.IsImage()) @@ -1655,7 +1711,7 @@ func TestMediaFile_HasPreviewImage(t *testing.T) { t.Run("RandomDocx", func(t *testing.T) { cfg := config.TestConfig() - f, err := NewMediaFile(cfg.ExamplesPath() + "/Random.docx") + f, err := NewMediaFile(cfg.SamplesPath() + "/Random.docx") if err != nil { t.Fatal(err) @@ -1666,7 +1722,7 @@ func TestMediaFile_HasPreviewImage(t *testing.T) { t.Run("FerriswheelColorfulJpg", func(t *testing.T) { cfg := config.TestConfig() - f, err := NewMediaFile(cfg.ExamplesPath() + "/ferriswheel_colorful.jpg") + f, err := NewMediaFile(cfg.SamplesPath() + "/ferriswheel_colorful.jpg") if err != nil { t.Fatal(err) @@ -1677,7 +1733,7 @@ func TestMediaFile_HasPreviewImage(t *testing.T) { t.Run("RandomDocxWithJpg", func(t *testing.T) { cfg := config.TestConfig() - f, err := NewMediaFile(cfg.ExamplesPath() + "/Random.docx") + f, err := NewMediaFile(cfg.SamplesPath() + "/Random.docx") f.hasPreviewImage = true if err != nil { t.Fatal(err) @@ -1691,7 +1747,7 @@ func TestMediaFile_PreviewImage(t *testing.T) { t.Run("RandomDocx", func(t *testing.T) { cfg := config.TestConfig() - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/Random.docx") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/Random.docx") if err != nil { t.Fatal(err) @@ -1712,7 +1768,7 @@ func TestMediaFile_PreviewImage(t *testing.T) { t.Run("FerriswheelColorfulJpg", func(t *testing.T) { cfg := config.TestConfig() - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/ferriswheel_colorful.jpg") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/ferriswheel_colorful.jpg") if err != nil { t.Fatal(err) @@ -1729,7 +1785,7 @@ func TestMediaFile_PreviewImage(t *testing.T) { t.Run("IphoneSevenJson", func(t *testing.T) { cfg := config.TestConfig() - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/test.md") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/test.md") if err != nil { t.Fatal(err) @@ -1753,7 +1809,7 @@ func TestMediaFile_decodeDimension(t *testing.T) { t.Run("RandomDocx", func(t *testing.T) { cfg := config.TestConfig() - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/Random.docx") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/Random.docx") if err != nil { t.Fatal(err) @@ -1766,7 +1822,7 @@ func TestMediaFile_decodeDimension(t *testing.T) { t.Run("ClockPurpleJpg", func(t *testing.T) { cfg := config.TestConfig() - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/clock_purple.jpg") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/clock_purple.jpg") if err != nil { t.Fatal(err) @@ -1779,7 +1835,7 @@ func TestMediaFile_decodeDimension(t *testing.T) { t.Run("IphoneSevenHeic", func(t *testing.T) { cfg := config.TestConfig() - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/iphone_7.heic") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) @@ -1792,7 +1848,7 @@ func TestMediaFile_decodeDimension(t *testing.T) { t.Run("ExamplePng", func(t *testing.T) { cfg := config.TestConfig() - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/example.png") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/example.png") if err != nil { t.Fatal(err) @@ -1808,7 +1864,7 @@ func TestMediaFile_decodeDimension(t *testing.T) { t.Run("ExampleGif", func(t *testing.T) { cfg := config.TestConfig() - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/example.gif") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/example.gif") if err != nil { t.Fatal(err) @@ -1824,7 +1880,7 @@ func TestMediaFile_decodeDimension(t *testing.T) { t.Run("BlueGoVideoMp4", func(t *testing.T) { cfg := config.TestConfig() - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/blue-go-video.mp4") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/blue-go-video.mp4") if err != nil { t.Fatal(err) @@ -1840,7 +1896,7 @@ func TestMediaFile_decodeDimension(t *testing.T) { t.Run("BlueGoVideoMp4WithOrientationGreaterThanFourAndLessThanEight", func(t *testing.T) { cfg := config.TestConfig() - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/blue-go-video.mp4") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/blue-go-video.mp4") mediaFile.metaData.Orientation = 5 if err != nil { t.Fatal(err) @@ -1853,13 +1909,27 @@ func TestMediaFile_decodeDimension(t *testing.T) { assert.Equal(t, 1080, mediaFile.Width()) assert.Equal(t, 1920, mediaFile.Height()) }) + t.Run("Layered16BitTiffFallsBackToMetadata", func(t *testing.T) { + mediaFile, err := NewMediaFile(filepath.Join(testSamplesPath, "layered-16bit-small.tif")) + + if err != nil { + t.Fatal(err) + } + + if err = mediaFile.decodeDimensions(); err != nil { + t.Fatal(err) + } + + assert.Positive(t, mediaFile.Width()) + assert.Positive(t, mediaFile.Height()) + }) } func TestMediaFile_Width(t *testing.T) { t.Run("RandomDocx", func(t *testing.T) { cfg := config.TestConfig() - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/Random.docx") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/Random.docx") if err != nil { t.Fatal(err) } @@ -1869,7 +1939,7 @@ func TestMediaFile_Width(t *testing.T) { t.Run("ElephantMonoJpg", func(t *testing.T) { cfg := config.TestConfig() - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/elephant_mono.jpg") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/elephant_mono.jpg") if err != nil { t.Fatal(err) } @@ -1882,7 +1952,7 @@ func TestMediaFile_Height(t *testing.T) { t.Run("RandomDocx", func(t *testing.T) { conf := config.TestConfig() - mediaFile, err := NewMediaFile(conf.ExamplesPath() + "/Random.docx") + mediaFile, err := NewMediaFile(conf.SamplesPath() + "/Random.docx") if err != nil { t.Fatal(err) @@ -1894,7 +1964,7 @@ func TestMediaFile_Height(t *testing.T) { t.Run("ElephantsJpg", func(t *testing.T) { conf := config.TestConfig() - mediaFile, err := NewMediaFile(conf.ExamplesPath() + "/elephants.jpg") + mediaFile, err := NewMediaFile(conf.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) @@ -1909,7 +1979,7 @@ func TestMediaFile_Megapixels(t *testing.T) { conf := config.TestConfig() t.Run("RandomDocx", func(t *testing.T) { - if f, err := NewMediaFile(conf.ExamplesPath() + "/Random.docx"); err != nil { + if f, err := NewMediaFile(conf.SamplesPath() + "/Random.docx"); err != nil { t.Fatal(err) } else { assert.Equal(t, 0, f.Megapixels()) @@ -1918,7 +1988,7 @@ func TestMediaFile_Megapixels(t *testing.T) { } }) t.Run("ElephantMonoJpg", func(t *testing.T) { - if f, err := NewMediaFile(conf.ExamplesPath() + "/elephant_mono.jpg"); err != nil { + if f, err := NewMediaFile(conf.SamplesPath() + "/elephant_mono.jpg"); err != nil { t.Fatal(err) } else { assert.Equal(t, 0, f.Megapixels()) @@ -1927,7 +1997,7 @@ func TestMediaFile_Megapixels(t *testing.T) { } }) t.Run("TelegramNum2020Num01Num30Num09Num57EighteenJpg", func(t *testing.T) { - if f, err := NewMediaFile(conf.ExamplesPath() + "/telegram_2020-01-30_09-57-18.jpg"); err != nil { + if f, err := NewMediaFile(conf.SamplesPath() + "/telegram_2020-01-30_09-57-18.jpg"); err != nil { t.Fatal(err) } else { assert.Equal(t, 1, f.Megapixels()) @@ -1936,7 +2006,7 @@ func TestMediaFile_Megapixels(t *testing.T) { } }) t.Run("Num6720PxWhiteJpg", func(t *testing.T) { - if f, err := NewMediaFile(conf.ExamplesPath() + "/6720px_white.jpg"); err != nil { + if f, err := NewMediaFile(conf.SamplesPath() + "/6720px_white.jpg"); err != nil { t.Fatal(err) } else { assert.Equal(t, 30, f.Megapixels()) @@ -1945,7 +2015,7 @@ func TestMediaFile_Megapixels(t *testing.T) { } }) t.Run("CanonEosSixDDng", func(t *testing.T) { - if f, err := NewMediaFile(conf.ExamplesPath() + "/canon_eos_6d.dng"); err != nil { + if f, err := NewMediaFile(conf.SamplesPath() + "/canon_eos_6d.dng"); err != nil { t.Fatal(err) } else { assert.Equal(t, 0, f.Megapixels()) @@ -1954,7 +2024,7 @@ func TestMediaFile_Megapixels(t *testing.T) { } }) t.Run("ExampleBmp", func(t *testing.T) { - if f, err := NewMediaFile(conf.ExamplesPath() + "/example.bmp"); err != nil { + if f, err := NewMediaFile(conf.SamplesPath() + "/example.bmp"); err != nil { t.Fatal(err) } else { assert.Equal(t, 0, f.Megapixels()) @@ -2039,7 +2109,7 @@ func TestMediaFile_ExceedsBytes(t *testing.T) { } }) t.Run("TelegramNum2020Num01Num30Num09Num57EighteenJpg", func(t *testing.T) { - if f, err := NewMediaFile(conf.ExamplesPath() + "/telegram_2020-01-30_09-57-18.jpg"); err != nil { + if f, err := NewMediaFile(conf.SamplesPath() + "/telegram_2020-01-30_09-57-18.jpg"); err != nil { t.Fatal(err) } else { actual, err := f.ExceedsBytes(-1) @@ -2050,7 +2120,7 @@ func TestMediaFile_ExceedsBytes(t *testing.T) { } }) t.Run("Num6720PxWhiteJpg", func(t *testing.T) { - if f, err := NewMediaFile(conf.ExamplesPath() + "/6720px_white.jpg"); err != nil { + if f, err := NewMediaFile(conf.SamplesPath() + "/6720px_white.jpg"); err != nil { t.Fatal(err) } else { actual, err := f.ExceedsBytes(0) @@ -2061,7 +2131,7 @@ func TestMediaFile_ExceedsBytes(t *testing.T) { } }) t.Run("CanonEosSixDDng", func(t *testing.T) { - if f, err := NewMediaFile(conf.ExamplesPath() + "/canon_eos_6d.dng"); err != nil { + if f, err := NewMediaFile(conf.SamplesPath() + "/canon_eos_6d.dng"); err != nil { t.Fatal(err) } else { actual, err := f.ExceedsBytes(10485760) @@ -2072,7 +2142,7 @@ func TestMediaFile_ExceedsBytes(t *testing.T) { } }) t.Run("ExampleBmp", func(t *testing.T) { - if f, err := NewMediaFile(conf.ExamplesPath() + "/example.bmp"); err != nil { + if f, err := NewMediaFile(conf.SamplesPath() + "/example.bmp"); err != nil { t.Fatal(err) } else { actual, err := f.ExceedsBytes(10485760) @@ -2085,7 +2155,7 @@ func TestMediaFile_ExceedsBytes(t *testing.T) { } func TestMediaFile_DecodeConfig(t *testing.T) { t.Run("Num6720PxWhiteJpg", func(t *testing.T) { - f, err := NewMediaFile(conf.ExamplesPath() + "/6720px_white.jpg") + f, err := NewMediaFile(conf.SamplesPath() + "/6720px_white.jpg") if err != nil { t.Fatal(err) @@ -2125,7 +2195,7 @@ func TestMediaFile_ExceedsResolution(t *testing.T) { } }) t.Run("TelegramNum2020Num01Num30Num09Num57EighteenJpg", func(t *testing.T) { - if f, err := NewMediaFile(conf.ExamplesPath() + "/telegram_2020-01-30_09-57-18.jpg"); err != nil { + if f, err := NewMediaFile(conf.SamplesPath() + "/telegram_2020-01-30_09-57-18.jpg"); err != nil { t.Fatal(err) } else { actual, err := f.ExceedsResolution(3) @@ -2134,7 +2204,7 @@ func TestMediaFile_ExceedsResolution(t *testing.T) { } }) t.Run("Num6720PxWhiteJpg", func(t *testing.T) { - f, err := NewMediaFile(conf.ExamplesPath() + "/6720px_white.jpg") + f, err := NewMediaFile(conf.SamplesPath() + "/6720px_white.jpg") if err != nil { t.Fatal(err) @@ -2156,7 +2226,7 @@ func TestMediaFile_ExceedsResolution(t *testing.T) { assert.Equal(t, 30, actual33) }) t.Run("CanonEosSixDDng", func(t *testing.T) { - if f, err := NewMediaFile(conf.ExamplesPath() + "/canon_eos_6d.dng"); err != nil { + if f, err := NewMediaFile(conf.SamplesPath() + "/canon_eos_6d.dng"); err != nil { t.Fatal(err) } else { actual, err := f.ExceedsResolution(3) @@ -2165,7 +2235,7 @@ func TestMediaFile_ExceedsResolution(t *testing.T) { } }) t.Run("ExampleBmp", func(t *testing.T) { - if f, err := NewMediaFile(conf.ExamplesPath() + "/example.bmp"); err != nil { + if f, err := NewMediaFile(conf.SamplesPath() + "/example.bmp"); err != nil { t.Fatal(err) } else { actual, err := f.ExceedsResolution(3) @@ -2179,7 +2249,7 @@ func TestMediaFile_AspectRatio(t *testing.T) { c := config.TestConfig() t.Run("IphoneSevenHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) @@ -2190,7 +2260,7 @@ func TestMediaFile_AspectRatio(t *testing.T) { assert.False(t, mediaFile.Square()) }) t.Run("FernGreenJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/fern_green.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/fern_green.jpg") if err != nil { t.Fatal(err) @@ -2201,7 +2271,7 @@ func TestMediaFile_AspectRatio(t *testing.T) { assert.True(t, mediaFile.Square()) }) t.Run("ElephantsJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/elephants.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) @@ -2216,7 +2286,7 @@ func TestMediaFile_AspectRatio(t *testing.T) { func TestMediaFile_Orientation(t *testing.T) { c := config.TestConfig() t.Run("IphoneSevenHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) @@ -2227,7 +2297,7 @@ func TestMediaFile_Orientation(t *testing.T) { assert.Equal(t, 6, orientation) }) t.Run("IphoneFifteenProHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_15_pro.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_15_pro.heic") if err != nil { t.Fatal(err) @@ -2238,7 +2308,7 @@ func TestMediaFile_Orientation(t *testing.T) { assert.Equal(t, 6, orientation) }) t.Run("TurtleBrownBlueJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/turtle_brown_blue.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/turtle_brown_blue.jpg") if err != nil { t.Fatal(err) @@ -2251,7 +2321,7 @@ func TestMediaFile_Orientation(t *testing.T) { func TestMediaFile_FileType(t *testing.T) { t.Run("InvalidExtension", func(t *testing.T) { - m, err := NewMediaFile(filepath.Join(conf.ExamplesPath(), "this-is-a-jpeg.png")) + m, err := NewMediaFile(filepath.Join(conf.SamplesPath(), "this-is-a-jpeg.png")) if err != nil { t.Fatal(err) @@ -2291,7 +2361,7 @@ func TestMediaFile_Stat(t *testing.T) { t.Run("IphoneSevenHeic", func(t *testing.T) { c := config.TestConfig() - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) @@ -2312,7 +2382,7 @@ func TestMediaFile_FileSize(t *testing.T) { t.Run("IphoneSevenHeic", func(t *testing.T) { c := config.TestConfig() - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/iphone_7.heic") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) @@ -2327,35 +2397,35 @@ func TestMediaFile_JsonName(t *testing.T) { t.Run("BlueGoVideoMp4", func(t *testing.T) { c := config.TestConfig() - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/blue-go-video.mp4") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/blue-go-video.mp4") if err != nil { t.Fatal(err) } name := mediaFile.SidecarJsonName() - assert.True(t, strings.HasSuffix(name, "/assets/examples/blue-go-video.mp4.json")) + assert.True(t, strings.HasSuffix(name, "/assets/samples/blue-go-video.mp4.json")) }) } func TestMediaFile_PathNameInfo(t *testing.T) { c := config.TestConfig() t.Run("BlueGoVideoMp4", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/blue-go-video.mp4") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/blue-go-video.mp4") if err != nil { t.Fatal(err) } root, base, path, name := mediaFile.PathNameInfo(true) - assert.Equal(t, "examples", root) + assert.Equal(t, "samples", root) assert.Equal(t, "blue-go-video", base) assert.Equal(t, "", path) assert.Equal(t, "blue-go-video.mp4", name) }) t.Run("BeachSandSidecar", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/beach_sand.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/beach_sand.jpg") if err != nil { t.Fatal(err) @@ -2375,7 +2445,7 @@ func TestMediaFile_PathNameInfo(t *testing.T) { t.Log(Config().SidecarPath()) t.Log(Config().ImportPath()) - mediaFile, err := NewMediaFile(filepath.Join(c.ExamplesPath(), "beach_sand.jpg")) + mediaFile, err := NewMediaFile(filepath.Join(c.SamplesPath(), "beach_sand.jpg")) if err != nil { t.Fatal(err) @@ -2393,7 +2463,7 @@ func TestMediaFile_PathNameInfo(t *testing.T) { mediaFile.SetFileName(initialName) }) t.Run("BeachSandUnknownRoot", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/beach_sand.jpg") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/beach_sand.jpg") if err != nil { t.Fatal(err) @@ -2414,27 +2484,27 @@ func TestMediaFile_PathNameInfo(t *testing.T) { func TestMediaFile_SubDirectory(t *testing.T) { c := config.TestConfig() t.Run("BlueGoVideoMp4", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/blue-go-video.mp4") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/blue-go-video.mp4") if err != nil { t.Fatal(err) } subdir := mediaFile.SubDir("xxx") - assert.True(t, strings.HasSuffix(subdir, "/assets/examples/xxx")) + assert.True(t, strings.HasSuffix(subdir, "/assets/samples/xxx")) }) } func TestMediaFile_HasSameName(t *testing.T) { c := config.TestConfig() t.Run("False", func(t *testing.T) { - mediaFile, err := NewMediaFile(c.ExamplesPath() + "/blue-go-video.mp4") + mediaFile, err := NewMediaFile(c.SamplesPath() + "/blue-go-video.mp4") if err != nil { t.Fatal(err) } - mediaFile2, err := NewMediaFile(c.ExamplesPath() + "/beach_sand.jpg") + mediaFile2, err := NewMediaFile(c.SamplesPath() + "/beach_sand.jpg") if err != nil { t.Fatal(err) @@ -2450,7 +2520,7 @@ func TestMediaFile_IsJson(t *testing.T) { t.Run("False", func(t *testing.T) { conf := config.TestConfig() - mediaFile, err := NewMediaFile(conf.ExamplesPath() + "/blue-go-video.mp4") + mediaFile, err := NewMediaFile(conf.SamplesPath() + "/blue-go-video.mp4") if err != nil { t.Fatal(err) @@ -2461,7 +2531,7 @@ func TestMediaFile_IsJson(t *testing.T) { t.Run("True", func(t *testing.T) { conf := config.TestConfig() - mediaFile, err := NewMediaFile(conf.ExamplesPath() + "/blue-go-video.json") + mediaFile, err := NewMediaFile(conf.SamplesPath() + "/blue-go-video.json") if err != nil { t.Fatal(err) @@ -2474,7 +2544,7 @@ func TestMediaFile_IsJson(t *testing.T) { func TestMediaFile_NeedsTranscoding(t *testing.T) { c := config.TestConfig() t.Run("Json", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/blue-go-video.json") + f, err := NewMediaFile(c.SamplesPath() + "/blue-go-video.json") if err != nil { t.Fatal(err) @@ -2483,7 +2553,7 @@ func TestMediaFile_NeedsTranscoding(t *testing.T) { assert.False(t, f.NeedsTranscoding()) }) t.Run("Mp4", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/blue-go-video.mp4") + f, err := NewMediaFile(c.SamplesPath() + "/blue-go-video.mp4") if err != nil { t.Fatal(err) @@ -2492,7 +2562,7 @@ func TestMediaFile_NeedsTranscoding(t *testing.T) { assert.False(t, f.NeedsTranscoding()) }) t.Run("Mov", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/earth.mov") + f, err := NewMediaFile(c.SamplesPath() + "/earth.mov") if err != nil { t.Fatal(err) @@ -2501,7 +2571,7 @@ func TestMediaFile_NeedsTranscoding(t *testing.T) { assert.True(t, f.NeedsTranscoding()) }) t.Run("Gif", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/pythagoras.gif") + f, err := NewMediaFile(c.SamplesPath() + "/pythagoras.gif") if err != nil { t.Fatal(err) @@ -2514,7 +2584,7 @@ func TestMediaFile_NeedsTranscoding(t *testing.T) { func TestMediaFile_SkipTranscoding(t *testing.T) { c := config.TestConfig() t.Run("Json", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/blue-go-video.json") + f, err := NewMediaFile(c.SamplesPath() + "/blue-go-video.json") if err != nil { t.Fatal(err) @@ -2523,7 +2593,7 @@ func TestMediaFile_SkipTranscoding(t *testing.T) { assert.True(t, f.SkipTranscoding()) }) t.Run("Mp4", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/blue-go-video.mp4") + f, err := NewMediaFile(c.SamplesPath() + "/blue-go-video.mp4") if err != nil { t.Fatal(err) @@ -2532,7 +2602,7 @@ func TestMediaFile_SkipTranscoding(t *testing.T) { assert.True(t, f.SkipTranscoding()) }) t.Run("Mov", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/earth.mov") + f, err := NewMediaFile(c.SamplesPath() + "/earth.mov") if err != nil { t.Fatal(err) @@ -2541,7 +2611,7 @@ func TestMediaFile_SkipTranscoding(t *testing.T) { assert.False(t, f.SkipTranscoding()) }) t.Run("Gif", func(t *testing.T) { - f, err := NewMediaFile(c.ExamplesPath() + "/pythagoras.gif") + f, err := NewMediaFile(c.SamplesPath() + "/pythagoras.gif") if err != nil { t.Fatal(err) @@ -2555,7 +2625,7 @@ func TestMediaFile_RenameSidecarFiles(t *testing.T) { t.Run("Success", func(t *testing.T) { c := config.TestConfig() - jpegExample := filepath.Join(c.ExamplesPath(), "/limes.jpg") + jpegExample := filepath.Join(c.SamplesPath(), "/limes.jpg") jpegPath := filepath.Join(c.OriginalsPath(), "2020", "12") jpegName := filepath.Join(jpegPath, "foobar.jpg") @@ -2605,7 +2675,7 @@ func TestMediaFile_RemoveSidecarFiles(t *testing.T) { t.Run("Success", func(t *testing.T) { c := config.TestConfig() - jpegExample := filepath.Join(c.ExamplesPath(), "/limes.jpg") + jpegExample := filepath.Join(c.SamplesPath(), "/limes.jpg") jpegPath := filepath.Join(c.OriginalsPath(), "2020", "12") jpegName := filepath.Join(jpegPath, "foobar.jpg") @@ -2639,49 +2709,49 @@ func TestMediaFile_RemoveSidecarFiles(t *testing.T) { func TestMediaFile_ColorProfile(t *testing.T) { t.Run("IphoneSevenJson", func(t *testing.T) { - mediaFile, err := NewMediaFile(conf.ExamplesPath() + "/iphone_7.json") + mediaFile, err := NewMediaFile(conf.SamplesPath() + "/iphone_7.json") if err != nil { t.Fatal(err) } assert.Equal(t, "", mediaFile.ColorProfile()) }) t.Run("IphoneSevenXmp", func(t *testing.T) { - mediaFile, err := NewMediaFile(conf.ExamplesPath() + "/iphone_7.xmp") + mediaFile, err := NewMediaFile(conf.SamplesPath() + "/iphone_7.xmp") if err != nil { t.Fatal(err) } assert.Equal(t, "", mediaFile.ColorProfile()) }) t.Run("IphoneSevenHeic", func(t *testing.T) { - mediaFile, err := NewMediaFile(conf.ExamplesPath() + "/iphone_7.heic") + mediaFile, err := NewMediaFile(conf.SamplesPath() + "/iphone_7.heic") if err != nil { t.Fatal(err) } assert.Equal(t, "", mediaFile.ColorProfile()) }) t.Run("CanonEosSixDDng", func(t *testing.T) { - mediaFile, err := NewMediaFile(conf.ExamplesPath() + "/canon_eos_6d.dng") + mediaFile, err := NewMediaFile(conf.SamplesPath() + "/canon_eos_6d.dng") if err != nil { t.Fatal(err) } assert.Equal(t, "", mediaFile.ColorProfile()) }) t.Run("ElephantsJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(conf.ExamplesPath() + "/elephants.jpg") + mediaFile, err := NewMediaFile(conf.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) } assert.Equal(t, "Adobe RGB (1998)", mediaFile.ColorProfile()) }) t.Run("BeachWoodJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(conf.ExamplesPath() + "/beach_wood.jpg") + mediaFile, err := NewMediaFile(conf.SamplesPath() + "/beach_wood.jpg") if err != nil { t.Fatal(err) } assert.Equal(t, "", mediaFile.ColorProfile()) }) t.Run("PeacockBlueJpg", func(t *testing.T) { - mediaFile, err := NewMediaFile(conf.ExamplesPath() + "/peacock_blue.jpg") + mediaFile, err := NewMediaFile(conf.SamplesPath() + "/peacock_blue.jpg") if err != nil { t.Fatal(err) } @@ -2691,7 +2761,7 @@ func TestMediaFile_ColorProfile(t *testing.T) { func TestMediaFile_Duration(t *testing.T) { t.Run("EarthMov", func(t *testing.T) { - if f, err := NewMediaFile(filepath.Join(conf.ExamplesPath(), "blue-go-video.mp4")); err != nil { + if f, err := NewMediaFile(filepath.Join(conf.SamplesPath(), "blue-go-video.mp4")); err != nil { t.Fatal(err) } else { assert.Equal(t, "2.42s", f.Duration().String()) diff --git a/internal/photoprism/mediafile_thumbs.go b/internal/photoprism/mediafile_thumbs.go index 903f1f452..c05520662 100644 --- a/internal/photoprism/mediafile_thumbs.go +++ b/internal/photoprism/mediafile_thumbs.go @@ -10,13 +10,13 @@ import ( "strings" "time" - "github.com/disintegration/imaging" "github.com/dustin/go-humanize/english" "github.com/photoprism/photoprism/internal/thumb" "github.com/photoprism/photoprism/pkg/capture" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/fs/disk" ) // Bounds returns the media dimensions as image.Rectangle. @@ -58,7 +58,9 @@ func (m *MediaFile) Resample(path string, sizeName thumb.Name) (img image.Image, return nil, err } - return imaging.Open(thumbName) + img, _, err = fs.DecodeImageFile(thumbName) + + return img, err } // SkipThumbnailSize tests if the thumbnail size can be skipped, @@ -78,6 +80,12 @@ func (m *MediaFile) GenerateThumbnails(thumbPath string, force bool) (err error) count := 0 start := time.Now() + // Surface a disk-full write failure as the shared insufficient-storage sentinel, + // so the indexer and thumbs worker can abort the run instead of failing every file. + defer func() { + err = disk.AsInsufficientStorage(err) + }() + defer func() { switch count { case 0: diff --git a/internal/photoprism/mediafile_thumbs_test.go b/internal/photoprism/mediafile_thumbs_test.go index e3725c334..4b3a34ffa 100644 --- a/internal/photoprism/mediafile_thumbs_test.go +++ b/internal/photoprism/mediafile_thumbs_test.go @@ -9,6 +9,7 @@ import ( "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/thumb" + "github.com/photoprism/photoprism/pkg/fs" ) func TestMediaFile_Thumbnail(t *testing.T) { @@ -23,7 +24,7 @@ func TestMediaFile_Thumbnail(t *testing.T) { defer os.RemoveAll(thumbsPath) t.Run("ElephantsJpg", func(t *testing.T) { - image, err := NewMediaFile(conf.ExamplesPath() + "/elephants.jpg") + image, err := NewMediaFile(conf.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) @@ -37,8 +38,54 @@ func TestMediaFile_Thumbnail(t *testing.T) { assert.FileExists(t, thumbnail) }) + t.Run("Layered16BitTiff", func(t *testing.T) { + image, err := NewMediaFile(testSamplesPath + "/layered-16bit-small.tif") + + if err != nil { + t.Fatal(err) + } + + thumbnail, err := image.Thumbnail(thumbsPath, thumb.Fit720) + + if err != nil { + t.Fatal(err) + } + + assert.FileExists(t, thumbnail) + + img, _, err := fs.DecodeImageFile(thumbnail) + if err != nil { + t.Fatal(err) + } + + assert.Equal(t, 236, img.Bounds().Dx()) + assert.Equal(t, 158, img.Bounds().Dy()) + }) + t.Run("RotateSixTiff", func(t *testing.T) { + image, err := NewMediaFile("testdata/rotate/6.tiff") + + if err != nil { + t.Fatal(err) + } + + thumbnail, err := image.Thumbnail(thumbsPath, thumb.Fit720) + + if err != nil { + t.Fatal(err) + } + + assert.FileExists(t, thumbnail) + + img, _, err := fs.DecodeImageFile(thumbnail) + if err != nil { + t.Fatal(err) + } + + assert.Equal(t, 43, img.Bounds().Dx()) + assert.Equal(t, 65, img.Bounds().Dy()) + }) t.Run("InvalidImageFormat", func(t *testing.T) { - image, err := NewMediaFile(conf.ExamplesPath() + "/canon_eos_6d.xmp") + image, err := NewMediaFile(conf.SamplesPath() + "/canon_eos_6d.xmp") if err != nil { t.Fatal(err) @@ -46,12 +93,12 @@ func TestMediaFile_Thumbnail(t *testing.T) { thumbnail, err := image.Thumbnail(thumbsPath, "tile_500") - assert.EqualError(t, err, "media: failed to create thumbnail for canon_eos_6d.xmp (image: unknown format)") + assert.EqualError(t, err, "media: failed to create thumbnail for canon_eos_6d.xmp (unsupported image format)") t.Log(thumbnail) }) t.Run("InvalidThumbnailType", func(t *testing.T) { - image, err := NewMediaFile(conf.ExamplesPath() + "/elephants.jpg") + image, err := NewMediaFile(conf.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) @@ -79,7 +126,7 @@ func TestMediaFile_Resample(t *testing.T) { }(thumbsPath) t.Run("ElephantsJpg", func(t *testing.T) { - image, err := NewMediaFile(conf.ExamplesPath() + "/elephants.jpg") + image, err := NewMediaFile(conf.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) @@ -95,7 +142,7 @@ func TestMediaFile_Resample(t *testing.T) { }) t.Run("InvalidType", func(t *testing.T) { - image, err := NewMediaFile(conf.ExamplesPath() + "/elephants.jpg") + image, err := NewMediaFile(conf.SamplesPath() + "/elephants.jpg") if err != nil { t.Fatal(err) @@ -115,7 +162,7 @@ func TestMediaFile_Resample(t *testing.T) { func TestMediaFile_SkipThumbnailSize(t *testing.T) { t.Run("ElephantsJpg", func(t *testing.T) { - m, err := NewMediaFile(filepath.Join(conf.ExamplesPath(), "elephants.jpg")) + m, err := NewMediaFile(filepath.Join(conf.SamplesPath(), "elephants.jpg")) if err != nil { t.Fatal(err) @@ -151,7 +198,7 @@ func TestMediaFile_GenerateThumbnails(t *testing.T) { } t.Run("ElephantsJpg", func(t *testing.T) { - m, err := NewMediaFile(filepath.Join(conf.ExamplesPath(), "elephants.jpg")) + m, err := NewMediaFile(filepath.Join(conf.SamplesPath(), "elephants.jpg")) if err != nil { t.Fatal(err) diff --git a/internal/photoprism/photoprism.go b/internal/photoprism/photoprism.go index d20e104ae..fb38ed32d 100644 --- a/internal/photoprism/photoprism.go +++ b/internal/photoprism/photoprism.go @@ -1,7 +1,7 @@ /* Package photoprism provides the core functionality of PhotoPrism®. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/photoprism/photoprism_test.go b/internal/photoprism/photoprism_test.go index 2f6ea04e6..d4c9be277 100644 --- a/internal/photoprism/photoprism_test.go +++ b/internal/photoprism/photoprism_test.go @@ -2,7 +2,6 @@ package photoprism import ( "os" - "path/filepath" "testing" "github.com/sirupsen/logrus" @@ -11,51 +10,26 @@ import ( "github.com/photoprism/photoprism/pkg/fs" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { - os.Exit(runMain(m)) + os.Exit(runTestMain(m)) } -// runMain initializes package-level test state and returns the test exit code. -func runMain(m *testing.M) int { +func runTestMain(m *testing.M) int { log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) - // Isolate package fixtures per process so parallel package test runs do not - // race on shared storage/testdata directories. - testRoot, err := os.MkdirTemp("", "photoprism-test-*") - if err != nil { - log.Errorf("create test root: %v", err) - return 1 - } - defer os.RemoveAll(testRoot) - - if err = os.Setenv("PHOTOPRISM_STORAGE_PATH", filepath.Join(testRoot, "storage")); err != nil { - log.Errorf("set PHOTOPRISM_STORAGE_PATH: %v", err) - return 1 - } - - if err = os.Setenv("PHOTOPRISM_TEST_DRIVER", "sqlite"); err != nil { - log.Errorf("set PHOTOPRISM_TEST_DRIVER: %v", err) - return 1 - } - - testDsn := filepath.Join(testRoot, "photoprism-test.db") + "?_busy_timeout=5000" - if err = os.Setenv("PHOTOPRISM_TEST_DSN", testDsn); err != nil { - log.Errorf("set PHOTOPRISM_TEST_DSN: %v", err) - return 1 - } - // Remove temporary SQLite files before running the tests. fs.PurgeTestDbFiles(".", false) c := config.NewTestConfig("photoprism") + config.OnceTestConfig(c) SetConfig(c) - + defer c.CleanupTestFolder() defer func() { - if err = c.CloseDb(); err != nil { + if err := c.CloseDb(); err != nil { log.Warnf("close db: %v", err) } - // Remove temporary SQLite files after running the tests. fs.PurgeTestDbFiles(".", false) }() diff --git a/internal/photoprism/related_test.go b/internal/photoprism/related_test.go index a9d3ebf49..c1f743d5a 100644 --- a/internal/photoprism/related_test.go +++ b/internal/photoprism/related_test.go @@ -13,15 +13,15 @@ func TestRelatedFiles_HasPreview(t *testing.T) { cfg := config.TestConfig() t.Run("JPEG", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") if err != nil { t.Fatal(err) } - mediaFile2, err2 := NewMediaFile(cfg.ExamplesPath() + "/gopher-video.mp4") + mediaFile2, err2 := NewMediaFile(cfg.SamplesPath() + "/gopher-video.mp4") if err2 != nil { t.Fatal(err2) } - mediaFile3, err3 := NewMediaFile(cfg.ExamplesPath() + "/iphone_7.heic") + mediaFile3, err3 := NewMediaFile(cfg.SamplesPath() + "/iphone_7.heic") if err3 != nil { t.Fatal(err3) } @@ -32,15 +32,15 @@ func TestRelatedFiles_HasPreview(t *testing.T) { assert.True(t, relatedFiles.HasPreview()) }) t.Run("PNG", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/gopher-video.mp4") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/gopher-video.mp4") if err != nil { t.Fatal(err) } - mediaFile2, err2 := NewMediaFile(cfg.ExamplesPath() + "/Screenshot 2019-05-21 at 10.45.52.png") + mediaFile2, err2 := NewMediaFile(cfg.SamplesPath() + "/Screenshot 2019-05-21 at 10.45.52.png") if err2 != nil { t.Fatal(err2) } - mediaFile3, err3 := NewMediaFile(cfg.ExamplesPath() + "/iphone_7.heic") + mediaFile3, err3 := NewMediaFile(cfg.SamplesPath() + "/iphone_7.heic") if err3 != nil { t.Fatal(err3) } @@ -51,11 +51,11 @@ func TestRelatedFiles_HasPreview(t *testing.T) { assert.True(t, relatedFiles.HasPreview()) }) t.Run("False", func(t *testing.T) { - mediaFile3, err3 := NewMediaFile(cfg.ExamplesPath() + "/iphone_7.heic") + mediaFile3, err3 := NewMediaFile(cfg.SamplesPath() + "/iphone_7.heic") if err3 != nil { t.Fatal(err3) } - mediaFile2, err2 := NewMediaFile(cfg.ExamplesPath() + "/gopher-video.mp4") + mediaFile2, err2 := NewMediaFile(cfg.SamplesPath() + "/gopher-video.mp4") if err2 != nil { t.Fatal(err2) } @@ -71,15 +71,15 @@ func TestRelatedFiles_String(t *testing.T) { cfg := config.TestConfig() t.Run("True", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") if err != nil { t.Fatal(err) } - mediaFile2, err2 := NewMediaFile(cfg.ExamplesPath() + "/Screenshot 2019-05-21 at 10.45.52.png") + mediaFile2, err2 := NewMediaFile(cfg.SamplesPath() + "/Screenshot 2019-05-21 at 10.45.52.png") if err2 != nil { t.Fatal(err2) } - mediaFile3, err3 := NewMediaFile(cfg.ExamplesPath() + "/iphone_7.heic") + mediaFile3, err3 := NewMediaFile(cfg.SamplesPath() + "/iphone_7.heic") if err3 != nil { t.Fatal(err3) } @@ -95,15 +95,15 @@ func TestRelatedFiles_Len(t *testing.T) { cfg := config.TestConfig() t.Run("True", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") if err != nil { t.Fatal(err) } - mediaFile2, err2 := NewMediaFile(cfg.ExamplesPath() + "/Screenshot 2019-05-21 at 10.45.52.png") + mediaFile2, err2 := NewMediaFile(cfg.SamplesPath() + "/Screenshot 2019-05-21 at 10.45.52.png") if err2 != nil { t.Fatal(err2) } - mediaFile3, err3 := NewMediaFile(cfg.ExamplesPath() + "/iphone_7.heic") + mediaFile3, err3 := NewMediaFile(cfg.SamplesPath() + "/iphone_7.heic") if err3 != nil { t.Fatal(err3) } @@ -125,7 +125,7 @@ func TestRelatedFiles_Count(t *testing.T) { assert.Equal(t, 0, relatedFiles.Count()) }) t.Run("None", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") if err != nil { t.Fatal(err) } @@ -136,15 +136,15 @@ func TestRelatedFiles_Count(t *testing.T) { assert.Equal(t, 0, relatedFiles.Count()) }) t.Run("One", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") if err != nil { t.Fatal(err) } - mediaFile2, err2 := NewMediaFile(cfg.ExamplesPath() + "/Screenshot 2019-05-21 at 10.45.52.png") + mediaFile2, err2 := NewMediaFile(cfg.SamplesPath() + "/Screenshot 2019-05-21 at 10.45.52.png") if err2 != nil { t.Fatal(err2) } - mediaFile3, err3 := NewMediaFile(cfg.ExamplesPath() + "/iphone_7.heic") + mediaFile3, err3 := NewMediaFile(cfg.SamplesPath() + "/iphone_7.heic") if err3 != nil { t.Fatal(err3) } @@ -166,7 +166,7 @@ func TestRelatedFiles_MainFileType(t *testing.T) { assert.Equal(t, "", relatedFiles.MainFileType()) }) t.Run("Primary", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") if err != nil { t.Fatal(err) } @@ -177,15 +177,15 @@ func TestRelatedFiles_MainFileType(t *testing.T) { assert.Equal(t, string(fs.ImageJpeg), relatedFiles.MainFileType()) }) t.Run("Heif", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") if err != nil { t.Fatal(err) } - mediaFile2, err2 := NewMediaFile(cfg.ExamplesPath() + "/Screenshot 2019-05-21 at 10.45.52.png") + mediaFile2, err2 := NewMediaFile(cfg.SamplesPath() + "/Screenshot 2019-05-21 at 10.45.52.png") if err2 != nil { t.Fatal(err2) } - mediaFile3, err3 := NewMediaFile(cfg.ExamplesPath() + "/iphone_7.heic") + mediaFile3, err3 := NewMediaFile(cfg.SamplesPath() + "/iphone_7.heic") if err3 != nil { t.Fatal(err3) } @@ -207,7 +207,7 @@ func TestRelatedFiles_MainLogName(t *testing.T) { assert.Equal(t, "", relatedFiles.MainFileType()) }) t.Run("Telegram", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") if err != nil { t.Fatal(err) } @@ -218,15 +218,15 @@ func TestRelatedFiles_MainLogName(t *testing.T) { assert.Equal(t, "telegram_2020-01-30_09-57-18.jpg", relatedFiles.MainLogName()) }) t.Run("IPhoneSeven", func(t *testing.T) { - mediaFile, err := NewMediaFile(cfg.ExamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") + mediaFile, err := NewMediaFile(cfg.SamplesPath() + "/telegram_2020-01-30_09-57-18.jpg") if err != nil { t.Fatal(err) } - mediaFile2, err2 := NewMediaFile(cfg.ExamplesPath() + "/Screenshot 2019-05-21 at 10.45.52.png") + mediaFile2, err2 := NewMediaFile(cfg.SamplesPath() + "/Screenshot 2019-05-21 at 10.45.52.png") if err2 != nil { t.Fatal(err2) } - mediaFile3, err3 := NewMediaFile(cfg.ExamplesPath() + "/iphone_7.heic") + mediaFile3, err3 := NewMediaFile(cfg.SamplesPath() + "/iphone_7.heic") if err3 != nil { t.Fatal(err3) } diff --git a/internal/photoprism/thumbs.go b/internal/photoprism/thumbs.go index 097979bbb..a57a87417 100644 --- a/internal/photoprism/thumbs.go +++ b/internal/photoprism/thumbs.go @@ -1,7 +1,6 @@ package photoprism import ( - "errors" "fmt" "path/filepath" "runtime/debug" @@ -14,6 +13,9 @@ import ( "github.com/photoprism/photoprism/internal/mutex" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" + "github.com/photoprism/photoprism/pkg/fs/disk" + "github.com/photoprism/photoprism/pkg/i18n" + "github.com/photoprism/photoprism/pkg/log/status" ) // Thumbs represents a thumbnail image generator. @@ -26,6 +28,19 @@ func NewThumbs(conf *config.Config) *Thumbs { return &Thumbs{conf: conf} } +// insufficientStorage reports whether thumbnail generation must abort because the +// configured files quota is reached or the storage path is critically low on free disk space. +func (w *Thumbs) insufficientStorage() bool { + if !w.conf.InsufficientStorage() { + return false + } + + // Do not leak server internals like the size of the storage volume. + log.Errorf("thumbs: aborting due to insufficient storage") + event.ErrorMsg(i18n.ErrInsufficientStorage) + return true +} + // Start creates thumbnails for files in the originals and sidecar folders. func (w *Thumbs) Start(dir string, force, originalsOnly bool) (err error) { defer func() { @@ -48,6 +63,13 @@ func (w *Thumbs) Start(dir string, force, originalsOnly bool) (err error) { // Scan sidecar folder? originalsOnly = originalsOnly || sidecarPath == "" || sidecarPath == originalsPath || !fs.PathExists(sidecarDir) + // Reset the cached disk usage so a freshly freed disk is detected immediately. + disk.FlushFree() + + if w.insufficientStorage() { + return status.ErrInsufficientStorage + } + // Start creating thumbnails. if _, err = w.Dir(originalsDir, force); err != nil || originalsOnly { return err @@ -97,7 +119,13 @@ func (w *Thumbs) Dir(dir string, force bool) (fs.Done, error) { }() if mutex.IndexWorker.Canceled() { - return errors.New("canceled") + return status.ErrCanceled + } + + // Stop the walk if storage drops below the threshold mid-scan. + if w.insufficientStorage() { + mutex.IndexWorker.Cancel() + return status.ErrInsufficientStorage } isDir, _ := info.IsDirOrSymlinkToDir() diff --git a/internal/photoprism/thumbs_storage_test.go b/internal/photoprism/thumbs_storage_test.go new file mode 100644 index 000000000..69e9743f3 --- /dev/null +++ b/internal/photoprism/thumbs_storage_test.go @@ -0,0 +1,40 @@ +package photoprism + +import ( + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/pkg/fs/disk" +) + +func TestThumbs_InsufficientStorage(t *testing.T) { + cfg := config.NewMinimalTestConfig(t.TempDir()) + w := NewThumbs(cfg) + require.NotNil(t, w) + + // Reset the storage-check latch, which an earlier test may have tripped by probing a + // temp path that duf cannot resolve to a mount point. + config.DisableStorageCheck.Store(false) + + // With no files quota configured, insufficientStorage falls through to the disk probe. + // Seeding the cache keeps the verdict independent of the host filesystem and of + // duf's ability to resolve the temp directory to a mount point. The quota branch of + // InsufficientStorage() is covered by config.TestConfig_InsufficientStorage. + t.Run("Healthy", func(t *testing.T) { + disk.FlushFree() + t.Cleanup(disk.FlushFree) + disk.SetFree(cfg.StoragePath(), 999*disk.MB, 1000*disk.MB) + + assert.False(t, w.insufficientStorage()) + }) + t.Run("Low", func(t *testing.T) { + disk.FlushFree() + t.Cleanup(disk.FlushFree) + disk.SetFree(cfg.StoragePath(), 1*disk.MB, 1000*disk.MB) + + assert.True(t, w.insufficientStorage()) + }) +} diff --git a/internal/photoprism/thumbs_test.go b/internal/photoprism/thumbs_test.go index 4e82058fd..1279d16ac 100644 --- a/internal/photoprism/thumbs_test.go +++ b/internal/photoprism/thumbs_test.go @@ -8,8 +8,6 @@ import ( "github.com/stretchr/testify/assert" - "github.com/disintegration/imaging" - "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/thumb" @@ -70,7 +68,8 @@ func TestThumbs_DirHonorsPPIgnore(t *testing.T) { } imageName := filepath.Join(dir, "ignored.jpg") - if err = os.WriteFile(imageName, jpgData, fs.ModeFile); err != nil { + // The destination is a fixed test filename under t.TempDir(). + if err = os.WriteFile(imageName, jpgData, fs.ModeFile); err != nil { //nolint:gosec t.Fatal(err) } @@ -104,7 +103,7 @@ func TestThumb_Filename(t *testing.T) { t.Fatal(err) } - assert.True(t, strings.HasSuffix(filename, "/storage/testdata/cache/_tmp/9/9/9/99988_150x150_fit.jpg")) + assert.True(t, strings.HasSuffix(filename, "/testdata/cache/_tmp/9/9/9/99988_150x150_fit.jpg")) }) t.Run("InvalidHash", func(t *testing.T) { _, err := thumb.FileName("999", thumbsPath, 150, 150, thumb.ResampleFit, thumb.ResampleNearestNeighbor) @@ -152,7 +151,7 @@ func TestThumb_FromFile(t *testing.T) { t.Run("ValidParameter", func(t *testing.T) { file := &entity.File{ - FileName: c.ExamplesPath() + "/elephants.jpg", + FileName: c.SamplesPath() + "/elephants.jpg", FileHash: "1234568889", } @@ -162,7 +161,7 @@ func TestThumb_FromFile(t *testing.T) { }) t.Run("HashTooShort", func(t *testing.T) { file := &entity.File{ - FileName: c.ExamplesPath() + "/elephants.jpg", + FileName: c.SamplesPath() + "/elephants.jpg", FileHash: "123", } @@ -233,7 +232,7 @@ func TestThumb_Create(t *testing.T) { t.Error(err) } - img, err := imaging.Open(conf.ExamplesPath()+"/elephants.jpg", imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(conf.SamplesPath() + "/elephants.jpg") if err != nil { t.Errorf("cannot open original: %s", err) @@ -260,7 +259,7 @@ func TestThumb_Create(t *testing.T) { t.Error(err) } - img, err := imaging.Open(conf.ExamplesPath()+"/elephants.jpg", imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(conf.SamplesPath() + "/elephants.jpg") if err != nil { t.Errorf("cannot open original: %s", err) @@ -285,7 +284,7 @@ func TestThumb_Create(t *testing.T) { t.Error(err) } - img, err := imaging.Open(conf.ExamplesPath()+"/elephants.jpg", imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(conf.SamplesPath() + "/elephants.jpg") if err != nil { t.Errorf("cannot open original: %s", err) diff --git a/internal/photoprism/thumbs_worker.go b/internal/photoprism/thumbs_worker.go index b41b827f9..076f435b2 100644 --- a/internal/photoprism/thumbs_worker.go +++ b/internal/photoprism/thumbs_worker.go @@ -1,5 +1,14 @@ package photoprism +import ( + "errors" + + "github.com/photoprism/photoprism/internal/event" + "github.com/photoprism/photoprism/internal/mutex" + "github.com/photoprism/photoprism/pkg/i18n" + "github.com/photoprism/photoprism/pkg/log/status" +) + // ThumbsJob encapsulates thumbnail generation parameters for a media file. type ThumbsJob struct { mediaFile *MediaFile @@ -18,7 +27,25 @@ func ThumbsWorker(jobs <-chan ThumbsJob) { } if err := mf.GenerateThumbnails(job.path, job.force); err != nil { + // Stop the run if the disk filled mid-scan instead of failing every remaining file. + if errors.Is(err, status.ErrInsufficientStorage) { + cancelThumbsInsufficientStorage() + continue + } + log.Errorf("thumbs: %s", err) } } } + +// cancelThumbsInsufficientStorage logs the insufficient-storage cause once and cancels the +// index worker so the directory walk stops, instead of failing every remaining thumbnail job. +func cancelThumbsInsufficientStorage() { + if mutex.IndexWorker.Canceled() { + return + } + + log.Errorf("thumbs: aborting due to insufficient storage") + event.ErrorMsg(i18n.ErrInsufficientStorage) + mutex.IndexWorker.Cancel() +} diff --git a/internal/photoprism/thumbs_worker_test.go b/internal/photoprism/thumbs_worker_test.go new file mode 100644 index 000000000..3a72b92ab --- /dev/null +++ b/internal/photoprism/thumbs_worker_test.go @@ -0,0 +1,28 @@ +package photoprism + +import ( + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/internal/mutex" +) + +func TestCancelThumbsInsufficientStorage(t *testing.T) { + t.Run("CancelsRunningWorker", func(t *testing.T) { + require.NoError(t, mutex.IndexWorker.Start()) + defer mutex.IndexWorker.Stop() + require.False(t, mutex.IndexWorker.Canceled()) + + cancelThumbsInsufficientStorage() + assert.True(t, mutex.IndexWorker.Canceled()) + }) + t.Run("NoopWhenNotRunning", func(t *testing.T) { + // Cancel only takes effect while the worker is running, so an idle worker stays uncanceled. + require.False(t, mutex.IndexWorker.Canceled()) + + cancelThumbsInsufficientStorage() + assert.False(t, mutex.IndexWorker.Canceled()) + }) +} diff --git a/internal/photoprism/timezone_test.go b/internal/photoprism/timezone_test.go index 57aca05de..7a90a6a5e 100644 --- a/internal/photoprism/timezone_test.go +++ b/internal/photoprism/timezone_test.go @@ -12,7 +12,7 @@ func TestMediaFile_TimeZone(t *testing.T) { t.Run("ElephantsJpg", func(t *testing.T) { conf := config.TestConfig() - img, err := NewMediaFile(conf.ExamplesPath() + "/elephants.jpg") + img, err := NewMediaFile(conf.SamplesPath() + "/elephants.jpg") assert.Nil(t, err) diff --git a/internal/raw/README.md b/internal/raw/README.md new file mode 100644 index 000000000..5322f57fe --- /dev/null +++ b/internal/raw/README.md @@ -0,0 +1,60 @@ +## PhotoPrism — RAW Image Conversion + +**Last Updated:** June 30, 2026 + +### Overview + +`internal/raw` provides command builders and heuristics for converting camera RAW images (including Adobe Digital Negative, `.dng`) to JPEG with Darktable, RawTherapee, and ExifTool. It mirrors the `internal/ffmpeg` pattern: the builders return `*exec.Cmd` and the caller passes the binary path plus options, while the orchestration that runs the commands and accepts their output stays in `internal/photoprism` (`Convert.JpegConvertCmds` and the `ToImage` convert loop). + +The package owns the small amount of RAW-specific knowledge that would otherwise be scattered through the converter: the command flags, the stderr patterns that mark an untrustworthy decode, and the list of formats whose embedded preview is unusable. + +#### Builders + +- `DarktableCmd(DarktableOptions) (*exec.Cmd, bool)` — also reports whether the command needs a global mutex (presets mode runs one instance at a time). +- `TherapeeCmd(bin, rawName, jpegName, profile string, quality int) *exec.Cmd` — RawTherapee render to JPEG (named without the `Raw` prefix to avoid a `raw.RawTherapee…` stutter). +- `ExifToolJpgFromRawCmd` / `ExifToolPreviewImageCmd` — extract the full-resolution / smaller embedded preview to stdout. + +### Converter Priority + +For a RAW input, `JpegConvertCmds` appends commands in this order, and the convert loop accepts the first whose output passes: + +1. **Darktable** — full RAW developer (preferred). +2. **RawTherapee** — full RAW developer (when Darktable is unavailable or fails). +3. **Embedded camera preview** via ExifTool (largest first) — the last resort. + +The embedded preview is last because a full render is higher quality, but it has correct colors when the RAW developers cannot identify the sensor (e.g. very recent Canon CR3 bodies otherwise come out magenta), so it wins when the developers are unavailable or — for the gated formats described below — produce an untrustworthy render. + +### Conversion Gating (`--disable-raw`) + +`PHOTOPRISM_DISABLE_RAW` disables both **indexing** and **conversion** of RAW, via two independent gates: + +- **Indexing/import/upload** skip RAW entirely before it reaches the converter (`index.go`, `mediafile_related.go`, `import.go`, `users_upload.go`). +- **Conversion** gates only the RAW *renderers* (Darktable, RawTherapee, and the macOS `sips` path) on `RawEnabled()`. ExifTool preview extraction runs regardless, so an already-embedded preview can still be extracted when rendering is disabled (e.g. via the `convert` CLI). + +### Error Handling + +The three tools fail differently, so they are guarded differently: + +- **Darktable** signals an unsupported sensor with a **non-zero exit code** and writes no file (its diagnostics go to stdout, e.g. `[libraw_open] detected unsupported image`). The convert loop's exit-code check skips it, so no stderr inspection is needed. +- **RawTherapee** can **exit 0 yet produce wrong colors** (e.g. a default white balance for an unidentified sensor) while printing a dcraw-derived message to stderr. For formats in the discard set (`DiscardRenderOnWarning`, default `.cr3`) its command is tagged with `ConvertCmd.WithStderrRejection(raw.DecoderErrors...)`; a match discards the output and the loop falls through to the embedded preview. `WhiteBalanceError` is the canonical case; `DecoderErrors` adds the other untrustworthy-decode messages (sourced from `dcraw.c`). Other RAW formats keep the render — see *Discard-on-Warning Gate* below. +- **Embedded previews** can be header-valid yet fail the thumbnailer (a bogus Huffman table only surfaces during shrink-on-load), so they are tagged `WithImageVerification`, which runs `thumb.Verify` to force the decode before acceptance. + +Because of this, `StderrRejected` is RawTherapee-specific by design — Darktable does not need it (it fails via exit code, not via accepted-but-wrong output). + +### Discard-on-Warning Gate + +`DiscardRenderOnWarning(ext)` decides, per RAW format, whether a RawTherapee render is discarded when its stderr matches `DecoderErrors`. It defaults to Canon CR3 (`.cr3`): recent CR3 bodies, which neither RAW developer can demosaic, render magenta, but they reliably embed a good preview to fall back to. The white-balance warning alone cannot tell a magenta render from a fine one — RawTherapee emits it for any sensor whose coefficients it cannot read, including obscure bodies whose default-WB render is perfectly fine — so the rejection is gated on the format as well as the warning. + +Formats RawTherapee alone can decode (e.g. `.raw`, `.kdc`) are deliberately left out: they have no embedded preview to fall back to, so discarding the render would leave nothing to index. The set is overridable via `PHOTOPRISM_RAW_DISCARD_ON_WARNING_EXT` (a comma-separated list that **replaces** the default), an escape hatch — outside the CLI/config surface — for adding a newly found magenta-prone format without a rebuild. A gated format must allow embedded-preview extraction (`PreviewExtAllowed`); otherwise its render would be discarded with no fallback, so PhotoPrism logs a warning at startup if an override names such a format. + +### Preview-Unsafe Formats + +`previewUnsafeExt` lists RAW extensions whose embedded JPEG preview is known to be unusable, exposed via `PreviewExtAllowed(ext)`. Currently `.mos` (Leaf), whose preview is a bogus-Huffman JPEG that passes a MIME sniff but fails thumbnailing; skipping it forces a full RAW render. + +### PNG Output (Deferred) + +RAW is not converted to PNG today: `ToImage` writes a `.jpg` sidecar for RAW, and `PngConvertCmds` has no RAW renderer at all (it logs and skips RAW). A lossless RAW export/preview (e.g. a future UI "export" tool) is the case that would need RAW→PNG. When that lands, build the PNG path to its own spec rather than copying `JpegConvertCmds`: it should render with Darktable/RawTherapee in **PNG mode** (RawTherapee needs `-n`/`-b16`, a new builder), and it should **not** use the embedded-JPEG preview fallback, which is lossy and would defeat a lossless export. + +### Known Gaps + +- RAW→PNG is unimplemented (see *PNG Output* above); `PngConvertCmds` logs and skips RAW. RAW rendering to JPEG (Darktable, RawTherapee, `sips`) is gated on `RawEnabled()`. diff --git a/internal/raw/convert.go b/internal/raw/convert.go new file mode 100644 index 000000000..c602cf54a --- /dev/null +++ b/internal/raw/convert.go @@ -0,0 +1,74 @@ +package raw + +import ( + "fmt" + "os/exec" + "strconv" +) + +// DarktableOptions configures a Darktable RAW to JPEG conversion command. +type DarktableOptions struct { + Bin string // darktable-cli binary path + RawName string // source RAW file name + XmpName string // optional XMP sidecar file name + JpegName string // destination JPEG file name + MaxSize int // maximum edge length in pixels + Presets bool // apply custom presets (requires a global mutex) + ConfigDir string // optional darktable config directory + CacheDir string // optional darktable cache directory +} + +// DarktableCmd builds the Darktable CLI command and reports whether it requires a global mutex. +// Presets mode can run only one instance at a time, so the caller must serialize those invocations. +func DarktableCmd(o DarktableOptions) (*exec.Cmd, bool) { + var args []string + + if o.XmpName != "" { + args = []string{o.RawName, o.XmpName, o.JpegName} + } else { + args = []string{o.RawName, o.JpegName} + } + + maxSize := strconv.Itoa(o.MaxSize) + + if o.Presets { + args = append(args, "--width", maxSize, "--height", maxSize, "--hq", "true", "--upscale", "false") + } else { + // --apply-custom-presets=false disables locking. + args = append(args, "--apply-custom-presets", "false", "--width", maxSize, "--height", maxSize, "--hq", "true", "--upscale", "false") + } + + args = append(args, "--core", "--library", ":memory:") + + if o.ConfigDir != "" { + args = append(args, "--configdir", o.ConfigDir) + } + + if o.CacheDir != "" { + args = append(args, "--cachedir", o.CacheDir) + } + + // #nosec G204 -- arguments are built from validated config and file paths. + return exec.Command(o.Bin, args...), o.Presets +} + +// TherapeeCmd builds the RawTherapee CLI command that renders a RAW file to JPEG. +func TherapeeCmd(bin, rawName, jpegName, profile string, quality int) *exec.Cmd { + jpegQuality := fmt.Sprintf("-j%d", quality) + args := []string{"-o", jpegName, "-p", profile, "-s", "-d", jpegQuality, "-js3", "-b8", "-c", rawName} + + // #nosec G204 -- arguments are built from validated config and file paths. + return exec.Command(bin, args...) +} + +// ExifToolJpgFromRawCmd builds the ExifTool command that extracts the full-resolution embedded preview to stdout. +func ExifToolJpgFromRawCmd(bin, rawName string) *exec.Cmd { + // #nosec G204 -- arguments are built from validated config and file paths. + return exec.Command(bin, "-q", "-q", "-b", "-JpgFromRaw", rawName) +} + +// ExifToolPreviewImageCmd builds the ExifTool command that extracts the smaller embedded preview to stdout. +func ExifToolPreviewImageCmd(bin, rawName string) *exec.Cmd { + // #nosec G204 -- arguments are built from validated config and file paths. + return exec.Command(bin, "-q", "-q", "-b", "-PreviewImage", rawName) +} diff --git a/internal/raw/convert_test.go b/internal/raw/convert_test.go new file mode 100644 index 000000000..cb60df7d0 --- /dev/null +++ b/internal/raw/convert_test.go @@ -0,0 +1,64 @@ +package raw + +import ( + "strings" + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestDarktableCmd(t *testing.T) { + t.Run("Presets", func(t *testing.T) { + cmd, useMutex := DarktableCmd(DarktableOptions{ + Bin: "/usr/bin/darktable-cli", + RawName: "image.cr2", + JpegName: "image.cr2.jpg", + MaxSize: 7680, + Presets: true, + }) + assert.True(t, useMutex) + s := cmd.String() + assert.Contains(t, s, "/usr/bin/darktable-cli") + assert.Contains(t, s, "image.cr2 image.cr2.jpg") + assert.Contains(t, s, "--width 7680 --height 7680") + assert.NotContains(t, s, "--apply-custom-presets") + }) + t.Run("NoPresetsWithXmpAndDirs", func(t *testing.T) { + cmd, useMutex := DarktableCmd(DarktableOptions{ + Bin: "/usr/bin/darktable-cli", + RawName: "image.cr2", + XmpName: "image.cr2.xmp", + JpegName: "image.cr2.jpg", + MaxSize: 1920, + Presets: false, + ConfigDir: "/cfg", + CacheDir: "/cache", + }) + assert.False(t, useMutex) + s := cmd.String() + assert.Contains(t, s, "image.cr2 image.cr2.xmp image.cr2.jpg") + assert.Contains(t, s, "--apply-custom-presets false") + assert.Contains(t, s, "--configdir /cfg") + assert.Contains(t, s, "--cachedir /cache") + }) +} + +func TestTherapeeCmd(t *testing.T) { + cmd := TherapeeCmd("/usr/bin/rawtherapee-cli", "image.cr2", "image.cr2.jpg", "/assets/raw.pp3", 92) + s := cmd.String() + assert.Contains(t, s, "/usr/bin/rawtherapee-cli") + assert.Contains(t, s, "-o image.cr2.jpg") + assert.Contains(t, s, "-p /assets/raw.pp3") + assert.Contains(t, s, "-j92") + assert.Contains(t, s, "-c image.cr2") +} + +func TestExifToolJpgFromRawCmd(t *testing.T) { + cmd := ExifToolJpgFromRawCmd("/usr/bin/exiftool", "image.cr2") + assert.Equal(t, []string{"/usr/bin/exiftool", "-q", "-q", "-b", "-JpgFromRaw", "image.cr2"}, cmd.Args) +} + +func TestExifToolPreviewImageCmd(t *testing.T) { + cmd := ExifToolPreviewImageCmd("/usr/bin/exiftool", "image.cr2") + assert.True(t, strings.HasSuffix(cmd.String(), "-q -q -b -PreviewImage image.cr2")) +} diff --git a/internal/raw/discard.go b/internal/raw/discard.go new file mode 100644 index 000000000..075e31b4c --- /dev/null +++ b/internal/raw/discard.go @@ -0,0 +1,77 @@ +package raw + +import ( + "os" + "sort" + "strings" +) + +// discardOnWarningEnv overrides the RAW extensions whose RawTherapee render is discarded on a decode +// warning, as a comma-separated list that replaces the default set (e.g. "cr3, cr2"). It is an escape +// hatch outside the CLI/config surface for adding a newly found magenta-prone format without a rebuild. +const discardOnWarningEnv = "PHOTOPRISM_RAW_DISCARD_ON_WARNING_EXT" + +// discardRenderOnWarning holds the RAW extensions (lowercase, leading dot) whose RawTherapee render is +// discarded when its stderr matches DecoderErrors, so the embedded preview wins (see README.md). +// A gated format must allow preview extraction (PreviewExtAllowed), or its render has no fallback. +var discardRenderOnWarning = defaultDiscardExt() + +// init warns when a configured gated format has no usable embedded preview, since a discarded render +// would then have no fallback and the file would fail to index. +func init() { + for _, ext := range discardExtMissingPreview() { + log.Warnf("raw: discard-on-warning format %s has no embedded preview to fall back to", ext) + } +} + +// defaultDiscardExt returns the gated-extension set, reading discardOnWarningEnv when set and falling +// back to Canon CR3 otherwise. +func defaultDiscardExt() map[string]bool { + if env := strings.TrimSpace(os.Getenv(discardOnWarningEnv)); env != "" { + return parseDiscardExt(env) + } + + return parseDiscardExt(".cr3") +} + +// parseDiscardExt parses a comma-separated extension list into a normalized set (lowercase, leading +// dot). An override that yields no valid entry returns an empty set, disabling the gate entirely. +func parseDiscardExt(s string) map[string]bool { + set := make(map[string]bool) + + for _, item := range strings.Split(s, ",") { + ext := strings.ToLower(strings.TrimSpace(item)) + if ext == "" { + continue + } + if !strings.HasPrefix(ext, ".") { + ext = "." + ext + } + set[ext] = true + } + + return set +} + +// discardExtMissingPreview returns the gated extensions that have no usable embedded preview, sorted, so +// a discarded render would have no fallback. The default set always returns none. +func discardExtMissingPreview() []string { + var missing []string + + for ext := range discardRenderOnWarning { + if !PreviewExtAllowed(ext) { + missing = append(missing, ext) + } + } + + sort.Strings(missing) + + return missing +} + +// DiscardRenderOnWarning reports whether a RawTherapee render of the extension should be discarded when +// its stderr reports a decode warning (DecoderErrors), preferring the embedded preview. The extension +// must be lowercase with a leading dot (e.g. ".cr3"). +func DiscardRenderOnWarning(ext string) bool { + return discardRenderOnWarning[ext] +} diff --git a/internal/raw/discard_test.go b/internal/raw/discard_test.go new file mode 100644 index 000000000..95d532150 --- /dev/null +++ b/internal/raw/discard_test.go @@ -0,0 +1,101 @@ +package raw + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestDiscardRenderOnWarning(t *testing.T) { + // Pin the gated set so the predicate is independent of any process-level env override. + orig := discardRenderOnWarning + discardRenderOnWarning = parseDiscardExt(".cr3") + t.Cleanup(func() { discardRenderOnWarning = orig }) + + t.Run("Gated", func(t *testing.T) { + assert.True(t, DiscardRenderOnWarning(".cr3")) + }) + t.Run("NotGated", func(t *testing.T) { + assert.False(t, DiscardRenderOnWarning(".raw")) + assert.False(t, DiscardRenderOnWarning(".kdc")) + assert.False(t, DiscardRenderOnWarning(".cr2")) + assert.False(t, DiscardRenderOnWarning(".dng")) + }) + t.Run("Empty", func(t *testing.T) { + assert.False(t, DiscardRenderOnWarning("")) + }) +} + +func TestDefaultDiscardExt(t *testing.T) { + t.Run("Default", func(t *testing.T) { + set := defaultDiscardExt() + assert.True(t, set[".cr3"]) + assert.Len(t, set, 1) + }) + t.Run("EnvOverrideReplaces", func(t *testing.T) { + // The override replaces the default set rather than extending it. + t.Setenv(discardOnWarningEnv, "cr2, kdc") + set := defaultDiscardExt() + assert.True(t, set[".cr2"]) + assert.True(t, set[".kdc"]) + assert.False(t, set[".cr3"]) + }) + t.Run("EnvBlankFallsBack", func(t *testing.T) { + t.Setenv(discardOnWarningEnv, " ") + set := defaultDiscardExt() + assert.True(t, set[".cr3"]) + assert.Len(t, set, 1) + }) + t.Run("EnvDisablesGate", func(t *testing.T) { + // A comma-only value yields no valid extension and disables the gate. + t.Setenv(discardOnWarningEnv, ",") + assert.Empty(t, defaultDiscardExt()) + }) +} + +func TestParseDiscardExt(t *testing.T) { + t.Run("AddsLeadingDot", func(t *testing.T) { + set := parseDiscardExt("cr3") + assert.True(t, set[".cr3"]) + }) + t.Run("KeepsLeadingDot", func(t *testing.T) { + set := parseDiscardExt(".cr3") + assert.True(t, set[".cr3"]) + }) + t.Run("TrimsAndLowercases", func(t *testing.T) { + set := parseDiscardExt(" .CR3 , KDC ") + assert.True(t, set[".cr3"]) + assert.True(t, set[".kdc"]) + assert.Len(t, set, 2) + }) + t.Run("SkipsBlankEntries", func(t *testing.T) { + set := parseDiscardExt("cr3, , ,cr2") + assert.True(t, set[".cr3"]) + assert.True(t, set[".cr2"]) + assert.Len(t, set, 2) + }) + t.Run("EmptyInput", func(t *testing.T) { + assert.Empty(t, parseDiscardExt("")) + }) +} + +func TestDiscardExtMissingPreview(t *testing.T) { + orig := discardRenderOnWarning + t.Cleanup(func() { discardRenderOnWarning = orig }) + + t.Run("ShippedDefaultIsSafe", func(t *testing.T) { + // The default gated set must never include a preview-unsafe format. + for ext := range defaultDiscardExt() { + assert.Truef(t, PreviewExtAllowed(ext), "default gated format %s must allow preview extraction", ext) + } + }) + t.Run("DefaultClean", func(t *testing.T) { + discardRenderOnWarning = parseDiscardExt(".cr3") + assert.Empty(t, discardExtMissingPreview()) + }) + t.Run("DetectsPreviewUnsafe", func(t *testing.T) { + // A preview-unsafe override (.mos) would discard the render with no fallback. + discardRenderOnWarning = parseDiscardExt(".cr3, .mos") + assert.Equal(t, []string{".mos"}, discardExtMissingPreview()) + }) +} diff --git a/internal/raw/errors.go b/internal/raw/errors.go new file mode 100644 index 000000000..4c2c250d3 --- /dev/null +++ b/internal/raw/errors.go @@ -0,0 +1,35 @@ +package raw + +import "strings" + +// WhiteBalanceError is the RawTherapee/dcraw stderr message indicating it could not read the camera +// white balance, so its colors are untrustworthy and the embedded camera preview is preferred. +const WhiteBalanceError = "Cannot use camera white balance" + +// DecoderErrors lists RawTherapee/dcraw stderr substrings that signal an untrustworthy render — +// wrong colors or a corrupt decode — so callers can fall back to the embedded camera preview. +// Sourced from dcraw.c; verbose progress lines are deliberately excluded. +var DecoderErrors = []string{ + WhiteBalanceError, // no camera white balance coefficients: defaults applied, wrong colors + "matrix not found", // color matrix missing: generic colors, wrong rendering + "Invalid white balance", // unknown white balance preset: wrong colors + "Corrupt data near", // corrupt raw stream: unreliable pixels + "Unexpected end of file", // truncated raw: unreliable pixels + "decoder table overflow", // Huffman decoder overflow: unreliable pixels + "incorrect JPEG dimensions", // lossless-JPEG raw mismatch: unreliable pixels +} + +// Untrustworthy reports whether RAW-decoder stderr output indicates the render cannot be trusted. +func Untrustworthy(stderr string) bool { + if stderr == "" { + return false + } + + for _, pattern := range DecoderErrors { + if strings.Contains(stderr, pattern) { + return true + } + } + + return false +} diff --git a/internal/raw/errors_test.go b/internal/raw/errors_test.go new file mode 100644 index 000000000..5930cba59 --- /dev/null +++ b/internal/raw/errors_test.go @@ -0,0 +1,34 @@ +package raw + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestUntrustworthy(t *testing.T) { + t.Run("WhiteBalance", func(t *testing.T) { + assert.True(t, Untrustworthy("Processing...\nCannot use camera white balance.\n")) + }) + t.Run("MatrixNotFound", func(t *testing.T) { + assert.True(t, Untrustworthy(`image.x3f: "Foo" matrix not found!`)) + }) + t.Run("CorruptData", func(t *testing.T) { + assert.True(t, Untrustworthy("Corrupt data near 0x1234")) + }) + t.Run("BenignWarning", func(t *testing.T) { + assert.False(t, Untrustworthy("Warning: sidecar file requested but not found for: image.cr2")) + }) + t.Run("VerboseProgress", func(t *testing.T) { + assert.False(t, Untrustworthy("AHD interpolation...\nConverting to sRGB colorspace...\n")) + }) + t.Run("Empty", func(t *testing.T) { + assert.False(t, Untrustworthy("")) + }) +} + +func TestDecoderErrors(t *testing.T) { + assert.Equal(t, WhiteBalanceError, DecoderErrors[0]) + assert.Contains(t, DecoderErrors, "matrix not found") + assert.Contains(t, DecoderErrors, "incorrect JPEG dimensions") +} diff --git a/internal/raw/preview.go b/internal/raw/preview.go new file mode 100644 index 000000000..956fcc875 --- /dev/null +++ b/internal/raw/preview.go @@ -0,0 +1,13 @@ +package raw + +// previewUnsafeExt lists RAW extensions whose embedded JPEG preview is unusable (e.g. fails +// thumbnailing), so preview extraction is skipped in favor of a full RAW render. +var previewUnsafeExt = map[string]bool{ + ".mos": true, // Leaf .mos files ship a bogus-Huffman embedded preview. +} + +// PreviewExtAllowed reports whether the embedded preview may be extracted for the extension, +// which must be lowercase with a leading dot (e.g. ".cr3"). +func PreviewExtAllowed(ext string) bool { + return !previewUnsafeExt[ext] +} diff --git a/internal/raw/preview_test.go b/internal/raw/preview_test.go new file mode 100644 index 000000000..fb70f2263 --- /dev/null +++ b/internal/raw/preview_test.go @@ -0,0 +1,18 @@ +package raw + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestPreviewExtAllowed(t *testing.T) { + t.Run("Allowed", func(t *testing.T) { + assert.True(t, PreviewExtAllowed(".cr3")) + assert.True(t, PreviewExtAllowed(".dng")) + assert.True(t, PreviewExtAllowed(".nef")) + }) + t.Run("Unsafe", func(t *testing.T) { + assert.False(t, PreviewExtAllowed(".mos")) + }) +} diff --git a/internal/raw/raw.go b/internal/raw/raw.go new file mode 100644 index 000000000..edd3197a2 --- /dev/null +++ b/internal/raw/raw.go @@ -0,0 +1,34 @@ +/* +Package raw provides command builders and helpers for converting camera RAW +images to JPEG with Darktable, RawTherapee, and ExifTool, including the +heuristics that decide, per format, when to discard an untrustworthy decode and +when to skip an unusable embedded preview. + +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. + + This program is free software: you can redistribute it and/or modify + it under Version 3 of the GNU Affero General Public License (the "AGPL"): + <https://docs.photoprism.app/license/agpl> + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + The AGPL is supplemented by our Trademark and Brand Guidelines, + which describe how our Brand Assets may be used: + <https://www.photoprism.app/trademark/> + +Feel free to send an email to hello@photoprism.app if you have questions, +want to support our work, or just want to say hello. + +Additional information can be found in our Developer Guide: +<https://docs.photoprism.app/developer-guide/> +*/ +package raw + +import ( + "github.com/photoprism/photoprism/internal/event" +) + +var log = event.Log diff --git a/internal/server/README.md b/internal/server/README.md index d8b21a2c4..78a9336f9 100644 --- a/internal/server/README.md +++ b/internal/server/README.md @@ -1,6 +1,6 @@ ## PhotoPrism — HTTP Server -**Last Updated:** March 4, 2026 +**Last Updated:** May 3, 2026 ### Overview @@ -28,6 +28,7 @@ - `start.go` — main startup flow, listener selection (HTTP/HTTPS/AutoTLS/Unix socket), graceful shutdown. - `routes_webapp.go` — Web UI routes and shared method helpers (`MethodsGetHead`). +- `static_precompressed.go` — `PrecompressedStatic` handler that serves bundled `/static/*` assets from precompressed siblings emitted by `frontend/scripts/precompress.js`; the same handler accepts operator-supplied siblings for `/c/static/*` and falls back to identity when none exist. Range requests always serve identity, and `http.ServeContent` continues to handle `Last-Modified` + `If-Modified-Since` revalidation for both encoded and identity responses (the handler does not set an `ETag`, so `If-None-Match` is latent rather than active). - `recovery.go` — panic recovery middleware with stack trace logging. - `logger.go` — request logging middleware (enabled in debug mode). - `security.go` — security headers and trusted proxy/platform handling. @@ -44,7 +45,8 @@ ### Configuration & Safety Notes -- Compression: only gzip is enabled; brotli requests log a notice. +- Compression: configured via `PHOTOPRISM_HTTP_COMPRESSION` / `--http-compression` as a comma-separated preference list. Supported tokens are `zstd`, `gzip`, and `none` (empty value also disables compression). The default ships as `zstd,gzip` so capable clients receive zstd while everyone else falls back to gzip; unknown tokens are ignored with a startup warning. +- Bundled frontend assets under `/static/*` are served with precompressed `.zst` / `.gz` siblings produced at build time by `frontend/scripts/precompress.js` (the npm `postbuild` hook for `make build-js`), selected via `PrecompressedStatic` in `static_precompressed.go`. Custom static assets under `/c/static/*` go through the same handler so extensions and operators *may* ship precompressed siblings alongside their files; without siblings the route serves identity. The runtime middleware bypasses both routes so it never re-encodes an already-encoded body and so `PHOTOPRISM_HTTP_COMPRESSION=none` consistently disables every encoded code path on these routes. - Trusted proxies/platform headers are read from config; keep the list tight. - If no trusted proxy ranges are configured (or the configured ranges are invalid), proxy trust is disabled and client IP resolution falls back to the TCP peer address. - HTTP hardening defaults: @@ -55,6 +57,7 @@ - WebDAV response behavior: - Built-in security middleware skips browser-document headers (`Content-Security-Policy`, `X-Frame-Options`) on `/originals` and `/import` paths. - PROPFIND `207 Multi-Status` responses normalize XML media type to `application/xml; charset=utf-8`. + - Request errors go to the console-only system log (`event.System*`), not the browser log stream, since `x/net/webdav` embeds absolute server paths in its messages. A `MKCOL` on an existing collection is a benign sync-client probe: it returns 405 and is logged at debug rather than as an error. - AutoTLS: uses `autocert` and spins up a redirect listener; ensure ports 80/443 are reachable. - Unix sockets: optional `force` query removes stale sockets; permissions can be set via `mode` query. - Health endpoints (`/livez`, `/health`, `/healthz`, `/readyz`) return `Cache-Control: no-store` and `Access-Control-Allow-Origin: *`. diff --git a/internal/server/compress.go b/internal/server/compress.go new file mode 100644 index 000000000..e3bbe74db --- /dev/null +++ b/internal/server/compress.go @@ -0,0 +1,200 @@ +package server + +import ( + "compress/gzip" + "io" + "net/http" + "strings" + "sync" + + "github.com/gin-gonic/gin" + "github.com/klauspost/compress/zstd" + + "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/pkg/http/header" +) + +// compressFlusher is the optional interface implemented by encoder writers +// that buffer output internally and need to be flushed before the underlying +// http.ResponseWriter is flushed. +type compressFlusher interface { + Flush() error +} + +// statusBypassesCompression reports whether responses with the given status +// should be sent uncompressed: 4xx/5xx (tiny error bodies aren't worth the CPU), +// 206 Partial Content (Range offsets are over the identity representation), and +// 204/304 (no body to encode). Status 0 means the handler hasn't written yet +// and defaults to 200, which is compressible. +func statusBypassesCompression(status int) bool { + switch { + case status >= 400: + return true + case status == http.StatusPartialContent: + return true + case status == http.StatusNoContent, status == http.StatusNotModified: + return true + } + return false +} + +// weakenETag rewrites a strong ETag to its weak form (W/"…") so caches don't +// reuse a compressed representation across content-codings. Per RFC 9110 +// §13.2.4 strong validators must change when the bytes change. Already-weak +// or missing ETags are left as-is. +func weakenETag(h http.Header) { + etag := h.Get(header.ETag) + if etag == "" || strings.HasPrefix(etag, "W/") { + return + } + h.Set(header.ETag, "W/"+etag) +} + +// compressWriter wraps a Gin ResponseWriter and routes body writes through the +// configured encoder. On the first Write it either bypasses the encoder (for +// 4xx/5xx/204/304 — Content-Encoding is removed) or clears Content-Length so +// subsequent writes can stream through. `encoded` tracks whether any byte +// reached the encoder so the middleware can suppress an empty frame trailer. +type compressWriter struct { + gin.ResponseWriter + encoder io.Writer + encoding string + headerDone bool + bypass bool + encoded bool +} + +// Write encodes data through the wrapper or bypasses the encoder for error/ +// bodyless responses. The first call also clears Content-Length, weakens any +// strong ETag (so caches don't mix encodings), and removes Content-Encoding +// in the bypass path. +func (cw *compressWriter) Write(p []byte) (int, error) { + if !cw.headerDone { + cw.headerDone = true + if statusBypassesCompression(cw.Status()) { + cw.bypass = true + cw.ResponseWriter.Header().Del(header.ContentEncoding) + } else { + cw.ResponseWriter.Header().Del(header.ContentLength) + weakenETag(cw.Header()) + } + } + if cw.bypass { + return cw.ResponseWriter.Write(p) + } + cw.encoded = true + return cw.encoder.Write(p) +} + +// WriteString delegates to Write so bypass and Content-Length-reset logic stays in one place. +func (cw *compressWriter) WriteString(s string) (int, error) { + return cw.Write([]byte(s)) +} + +// Flush forwards to the encoder (when not bypassed) and then to the underlying +// ResponseWriter so streaming consumers receive partial output. +func (cw *compressWriter) Flush() { + if !cw.bypass { + if f, ok := cw.encoder.(compressFlusher); ok { + _ = f.Flush() + } + } + cw.ResponseWriter.Flush() +} + +// NewCompressMiddleware returns a Gin middleware that negotiates gzip or zstd +// content-encoding per request based on the operator's preferences and the +// client's Accept-Encoding header. Connection upgrades, paths excluded by +// NewShouldCompressFn, HEAD requests, and 4xx/5xx/204/206/304 bodies are +// skipped. Eligible responses always set `Vary: Accept-Encoding`. Returns a +// pass-through middleware when conf is nil or no encodings are configured. +func NewCompressMiddleware(conf *config.Config) gin.HandlerFunc { + if conf == nil { + return func(c *gin.Context) { c.Next() } + } + + prefs := conf.HttpCompressionPreferences() + if len(prefs) == 0 { + return func(c *gin.Context) { c.Next() } + } + + shouldCompress := NewShouldCompressFn(conf) + + gzipPool := &sync.Pool{ + New: func() interface{} { + gz, _ := gzip.NewWriterLevel(io.Discard, gzip.DefaultCompression) + return gz + }, + } + zstdPool := &sync.Pool{ + New: func() interface{} { + zw, _ := zstd.NewWriter(io.Discard, zstd.WithEncoderLevel(zstd.SpeedDefault)) + return zw + }, + } + + return func(c *gin.Context) { + if c == nil || c.Request == nil { + c.Next() + return + } + + // Connection upgrades (e.g. WebSockets) must not be wrapped. + if strings.Contains(strings.ToLower(c.GetHeader("Connection")), "upgrade") { + c.Next() + return + } + + // Path is excluded from compression — pass through and skip Vary too, + // since the response shape does not depend on Accept-Encoding here. + if !shouldCompress(c) { + c.Next() + return + } + + // Vary: Accept-Encoding on every eligible response so shared caches keep + // separate entries even when the negotiator selects identity. Also set + // on HEAD per RFC 9110 §15.4.5 since the corresponding GET would vary. + c.Writer.Header().Add(header.Vary, header.AcceptEncoding) + + // HEAD bodies are discarded by net/http — skip the encoder pool entirely. + if c.Request.Method == http.MethodHead { + c.Next() + return + } + + switch NegotiateEncoding(c.GetHeader(header.AcceptEncoding), prefs) { + case EncodingGzip: + gz := gzipPool.Get().(*gzip.Writer) + gz.Reset(c.Writer) + c.Header(header.ContentEncoding, EncodingGzip) + cw := &compressWriter{ResponseWriter: c.Writer, encoder: gz, encoding: EncodingGzip} + c.Writer = cw + defer func() { + // Nothing encoded — drop Content-Encoding and discard the trailer. + if !cw.encoded { + cw.ResponseWriter.Header().Del(header.ContentEncoding) + gz.Reset(io.Discard) + } + _ = gz.Close() + gzipPool.Put(gz) + }() + case EncodingZstd: + zw := zstdPool.Get().(*zstd.Encoder) + zw.Reset(c.Writer) + c.Header(header.ContentEncoding, EncodingZstd) + cw := &compressWriter{ResponseWriter: c.Writer, encoder: zw, encoding: EncodingZstd} + c.Writer = cw + defer func() { + if !cw.encoded { + cw.ResponseWriter.Header().Del(header.ContentEncoding) + zw.Reset(io.Discard) + } + _ = zw.Close() + zstdPool.Put(zw) + }() + } + + c.Next() + } +} diff --git a/internal/server/compress_negotiate.go b/internal/server/compress_negotiate.go new file mode 100644 index 000000000..1d4b03669 --- /dev/null +++ b/internal/server/compress_negotiate.go @@ -0,0 +1,81 @@ +package server + +import ( + "strconv" + "strings" +) + +// EncodingIdentity is the sentinel returned by NegotiateEncoding when no +// configured content-encoding is acceptable to the client. +const EncodingIdentity = "identity" + +// EncodingGzip is the IANA token for the gzip content-encoding. +const EncodingGzip = "gzip" + +// EncodingZstd is the IANA token for the zstd content-encoding (RFC 8478). +const EncodingZstd = "zstd" + +// NegotiateEncoding picks an encoding from prefs that the client accepts per +// RFC 9110 §12.5.3 (q=0 refusal beats "*", missing q defaults to 1), returning +// EncodingIdentity when none is acceptable. Never returns an encoding outside prefs. +func NegotiateEncoding(acceptEncoding string, prefs []string) string { + if len(prefs) == 0 { + return EncodingIdentity + } + + accepted := parseAcceptEncoding(acceptEncoding) + starQ, hasStar := accepted["*"] + + for _, enc := range prefs { + enc = strings.ToLower(strings.TrimSpace(enc)) + if enc == "" { + continue + } + if q, ok := accepted[enc]; ok { + if q > 0 { + return enc + } + // q=0 explicitly refuses this encoding; do not let "*" override it. + continue + } + if hasStar && starQ > 0 { + return enc + } + } + return EncodingIdentity +} + +// parseAcceptEncoding parses an Accept-Encoding header into a map of lowercase +// tokens to q-values; missing or malformed q defaults to 1. +func parseAcceptEncoding(header string) map[string]float64 { + result := make(map[string]float64) + if header == "" { + return result + } + for part := range strings.SplitSeq(header, ",") { + part = strings.TrimSpace(part) + if part == "" { + continue + } + token := part + q := 1.0 + if i := strings.IndexByte(part, ';'); i >= 0 { + token = strings.TrimSpace(part[:i]) + for p := range strings.SplitSeq(part[i+1:], ";") { + p = strings.TrimSpace(p) + if !strings.HasPrefix(strings.ToLower(p), "q=") { + continue + } + if v, err := strconv.ParseFloat(strings.TrimSpace(p[2:]), 64); err == nil { + q = v + } + } + } + token = strings.ToLower(token) + if token == "" { + continue + } + result[token] = q + } + return result +} diff --git a/internal/server/compress_negotiate_test.go b/internal/server/compress_negotiate_test.go new file mode 100644 index 000000000..482ce2fc1 --- /dev/null +++ b/internal/server/compress_negotiate_test.go @@ -0,0 +1,88 @@ +package server + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestNegotiateEncoding(t *testing.T) { + tests := []struct { + name string + accept string + prefs []string + want string + }{ + {"PrefersFirstConfigured", "zstd, gzip", []string{"zstd", "gzip"}, "zstd"}, + {"FallsBackToSecondConfigured", "gzip", []string{"zstd", "gzip"}, "gzip"}, + {"OperatorPrefsWinOverClientOrder", "zstd, gzip", []string{"gzip", "zstd"}, "gzip"}, + {"QZeroIsExplicitRefusal", "zstd;q=0, gzip", []string{"zstd", "gzip"}, "gzip"}, + {"QZeroBeatsStarFallback", "zstd;q=0, *", []string{"zstd", "gzip"}, "gzip"}, + {"StarMatchesAnyConfigured", "*", []string{"zstd", "gzip"}, "zstd"}, + {"StarWithZeroQualityYieldsIdentity", "*;q=0", []string{"zstd", "gzip"}, "identity"}, + {"UnknownAcceptYieldsIdentity", "br", []string{"zstd", "gzip"}, "identity"}, + {"EmptyAcceptYieldsIdentity", "", []string{"zstd", "gzip"}, "identity"}, + {"MissingHeaderYieldsIdentity", "", []string{"gzip"}, "identity"}, + {"EmptyPrefsYieldsIdentity", "gzip, zstd", nil, "identity"}, + {"WhitespaceTolerant", " zstd , gzip ", []string{"zstd", "gzip"}, "zstd"}, + {"AcceptIsCaseInsensitive", "ZSTD, GZIP", []string{"zstd", "gzip"}, "zstd"}, + {"PrefsAreCaseInsensitive", "gzip", []string{"GZIP"}, "gzip"}, + {"MalformedQDefaultsToOne", "gzip;q=abc", []string{"gzip"}, "gzip"}, + {"FractionalQAboveZeroAccepted", "gzip;q=0.1", []string{"gzip"}, "gzip"}, + {"MultipleParametersIgnoreNonQ", "gzip;foo=bar;q=0.8", []string{"gzip"}, "gzip"}, + {"DropsEmptyTokens", " , gzip , ", []string{"gzip"}, "gzip"}, + // The next two cases document a deliberate pragmatic deviation from a + // strict reading of RFC 9110 §12.5.3: when the client refuses every + // configured coding AND identity, RFC says the server SHOULD return + // 406 Not Acceptable. We instead fall back to identity, matching the + // long-standing behavior of gin-contrib/gzip and most Go HTTP + // middleware. Returning 406 from compression middleware would + // short-circuit handler logic, audit events, and authn checks — too + // invasive for a SHOULD-level requirement that real browsers never + // trigger (they always include identity implicitly with q=1). + {"AllRefusedFallsBackToIdentity", "gzip;q=0, zstd;q=0, identity;q=0", []string{"zstd", "gzip"}, "identity"}, + {"AllConfiguredRefusedNoIdentityRefused", "gzip;q=0, zstd;q=0", []string{"zstd", "gzip"}, "identity"}, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + assert.Equal(t, tt.want, NegotiateEncoding(tt.accept, tt.prefs)) + }) + } +} + +func TestParseAcceptEncoding(t *testing.T) { + t.Run("Empty", func(t *testing.T) { + assert.Empty(t, parseAcceptEncoding("")) + }) + + t.Run("SingleToken", func(t *testing.T) { + got := parseAcceptEncoding("gzip") + assert.Equal(t, map[string]float64{"gzip": 1.0}, got) + }) + + t.Run("MultipleWithQuality", func(t *testing.T) { + got := parseAcceptEncoding("zstd;q=0.9, gzip;q=0.5, br;q=0") + assert.InDelta(t, 0.9, got["zstd"], 1e-9) + assert.InDelta(t, 0.5, got["gzip"], 1e-9) + assert.InDelta(t, 0.0, got["br"], 1e-9) + }) + + t.Run("Wildcard", func(t *testing.T) { + got := parseAcceptEncoding("*") + assert.Equal(t, 1.0, got["*"]) + }) + + t.Run("MalformedQualityFallsBackToOne", func(t *testing.T) { + got := parseAcceptEncoding("gzip;q=not-a-number") + assert.InDelta(t, 1.0, got["gzip"], 1e-9) + }) + + t.Run("LowercasesTokens", func(t *testing.T) { + got := parseAcceptEncoding("GZIP, ZSTD") + _, gzipOK := got["gzip"] + _, zstdOK := got["zstd"] + assert.True(t, gzipOK) + assert.True(t, zstdOK) + }) +} diff --git a/internal/server/gzip.go b/internal/server/compress_predicate.go similarity index 64% rename from internal/server/gzip.go rename to internal/server/compress_predicate.go index ad69427f6..95cf9ee33 100644 --- a/internal/server/gzip.go +++ b/internal/server/compress_predicate.go @@ -10,9 +10,10 @@ import ( "github.com/photoprism/photoprism/pkg/http/proxy" ) -// gzipExcludedExtensions contains file extensions that should never be gzip-compressed. -// These formats are already compressed or typically served as large binary payloads. -var gzipExcludedExtensions = map[string]struct{}{ +// excludedExtensions lists file extensions whose responses should never be +// HTTP-compressed. These formats are already compressed or typically served +// as large binary payloads where gzip/zstd add CPU cost without saving bytes. +var excludedExtensions = map[string]struct{}{ ".png": {}, ".gif": {}, ".jpeg": {}, @@ -24,10 +25,13 @@ var gzipExcludedExtensions = map[string]struct{}{ ".gz": {}, } -// NewGzipShouldCompressFn returns a high-performance gzip decision function for PhotoPrism. -// It mirrors the legacy exclusion rules (extensions and path prefixes) and adds targeted -// route exclusions for binary/streaming endpoints that must not be compressed. -func NewGzipShouldCompressFn(conf *config.Config) func(c *gin.Context) bool { +// NewShouldCompressFn returns an encoding-agnostic predicate that decides +// whether a given request is eligible for HTTP response compression. The +// predicate inspects the request URL path, file extension, and matched Gin +// route pattern; it deliberately does not look at Accept-Encoding or +// Connection headers (the middleware owns those checks). When conf is nil it +// returns a predicate that always declines. +func NewShouldCompressFn(conf *config.Config) func(c *gin.Context) bool { if conf == nil { return func(*gin.Context) bool { return false } } @@ -39,16 +43,16 @@ func NewGzipShouldCompressFn(conf *config.Config) func(c *gin.Context) bool { photoDlPrefix := apiBase + "/photos/" clusterThemePath := apiBase + "/cluster/theme" - // FullPath patterns (exact match) for dynamic routes that should bypass gzip. + // FullPath patterns (exact match) for dynamic routes that should bypass compression. excludedFullPaths := map[string]struct{}{ apiBase + "/photos/:uid/dl": {}, apiBase + "/cluster/theme": {}, conf.BaseUri("/s/:token/:shared/preview"): {}, } - // Path prefixes that should bypass gzip (prefix match on raw URL path). + // Path prefixes that should bypass compression (prefix match on raw URL path). excludedPrefixes := []string{ - // Health endpoints are small and frequently polled; gzip would add overhead. + // Health endpoints are small and frequently polled; compression would add overhead. conf.BaseUri("/livez"), conf.BaseUri("/health"), conf.BaseUri("/readyz"), @@ -60,6 +64,13 @@ func NewGzipShouldCompressFn(conf *config.Config) func(c *gin.Context) bool { conf.BaseUri(config.ApiUri + "/labels"), conf.BaseUri(config.ApiUri + "/videos"), conf.BaseUri(proxy.PathPrefix), + // Bundled and custom static assets are served with precompressed + // .zst / .gz siblings via PrecompressedStatic; bypass the runtime + // encoder so it never re-encodes an already-encoded body and so + // PHOTOPRISM_HTTP_COMPRESSION=none consistently disables every + // encoded code path on these routes. + conf.BaseUri(config.StaticUri), + conf.BaseUri(config.CustomStaticUri), } return func(c *gin.Context) bool { @@ -67,14 +78,6 @@ func NewGzipShouldCompressFn(conf *config.Config) func(c *gin.Context) bool { return false } - // Only compress when the client explicitly accepts gzip and the connection is not upgraded. - if !strings.Contains(strings.ToLower(c.GetHeader("Accept-Encoding")), "gzip") { - return false - } - if strings.Contains(strings.ToLower(c.GetHeader("Connection")), "upgrade") { - return false - } - path := c.Request.URL.Path if path == "" { return false @@ -82,7 +85,7 @@ func NewGzipShouldCompressFn(conf *config.Config) func(c *gin.Context) bool { // Exclude known already-compressed/binary extensions. if ext := strings.ToLower(filepath.Ext(path)); ext != "" { - if _, ok := gzipExcludedExtensions[ext]; ok { + if _, ok := excludedExtensions[ext]; ok { return false } } diff --git a/internal/server/compress_predicate_test.go b/internal/server/compress_predicate_test.go new file mode 100644 index 000000000..ef1b0172a --- /dev/null +++ b/internal/server/compress_predicate_test.go @@ -0,0 +1,100 @@ +package server + +import ( + "net/http" + "net/http/httptest" + "testing" + + "github.com/gin-gonic/gin" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/pkg/http/proxy" +) + +func TestNewShouldCompressFn(t *testing.T) { + gin.SetMode(gin.TestMode) + + t.Run("NilConfigDeclines", func(t *testing.T) { + fn := NewShouldCompressFn(nil) + assert.False(t, fn(nil)) + }) + + conf := config.TestConfig() + fn := NewShouldCompressFn(conf) + + // Build a router so c.FullPath() resolves for the dynamic route exclusions. + r := gin.New() + check := func(c *gin.Context) { + if fn(c) { + c.Status(http.StatusOK) + } else { + c.Status(http.StatusNoContent) + } + } + r.GET("/anything", check) + r.GET("/file.jpg", check) + r.GET(conf.BaseUri("/livez"), check) + r.GET(conf.BaseUri("/health"), check) + r.GET(conf.BaseUri("/readyz"), check) + r.GET(conf.BaseUri(config.ApiUri+"/dl/test"), check) + r.GET(conf.BaseUri(config.ApiUri+"/photos/:uid/dl"), check) + r.GET(conf.BaseUri(config.ApiUri+"/cluster/theme"), check) + r.GET(conf.BaseUri("/s/:token/:shared/preview"), check) + r.GET(conf.BaseUri(proxy.PathPrefix+"test/ok"), check) + r.GET(conf.BaseUri(config.StaticUri+"/build/app.js"), check) + r.GET(conf.BaseUri(config.CustomStaticUri+"/foo.css"), check) + + doRequest := func(path string) int { + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, path, nil) + r.ServeHTTP(w, req) + return w.Code + } + + t.Run("CompressesGenericPath", func(t *testing.T) { + assert.Equal(t, http.StatusOK, doRequest("/anything")) + }) + t.Run("ExcludesAlreadyCompressedExtensions", func(t *testing.T) { + assert.Equal(t, http.StatusNoContent, doRequest("/file.jpg")) + }) + t.Run("ExcludesHealthPrefixes", func(t *testing.T) { + for _, p := range []string{"/livez", "/health", "/readyz"} { + assert.Equalf(t, http.StatusNoContent, doRequest(conf.BaseUri(p)), "path=%s", p) + } + }) + t.Run("ExcludesApiDlPrefix", func(t *testing.T) { + assert.Equal(t, http.StatusNoContent, doRequest(conf.BaseUri(config.ApiUri+"/dl/test"))) + }) + t.Run("ExcludesPhotoOriginalDownload", func(t *testing.T) { + assert.Equal(t, http.StatusNoContent, doRequest(conf.BaseUri(config.ApiUri+"/photos/abc/dl"))) + }) + t.Run("ExcludesClusterTheme", func(t *testing.T) { + assert.Equal(t, http.StatusNoContent, doRequest(conf.BaseUri(config.ApiUri+"/cluster/theme"))) + }) + t.Run("ExcludesSharePreview", func(t *testing.T) { + assert.Equal(t, http.StatusNoContent, doRequest(conf.BaseUri("/s/tok/shared/preview"))) + }) + t.Run("ExcludesPortalProxy", func(t *testing.T) { + assert.Equal(t, http.StatusNoContent, doRequest(conf.BaseUri(proxy.PathPrefix+"test/ok"))) + }) + t.Run("ExcludesBundledStatic", func(t *testing.T) { + // /static/* is served by PrecompressedStatic, which serves precompressed + // siblings inline; the runtime middleware must not double-encode. + assert.Equal(t, http.StatusNoContent, doRequest(conf.BaseUri(config.StaticUri+"/build/app.js"))) + }) + t.Run("ExcludesCustomStatic", func(t *testing.T) { + // Custom-extension static assets share the same precompressed pipeline. + assert.Equal(t, http.StatusNoContent, doRequest(conf.BaseUri(config.CustomStaticUri+"/foo.css"))) + }) + + t.Run("DoesNotCheckAcceptEncoding", func(t *testing.T) { + // Predicate is encoding-agnostic — middleware owns the Accept-Encoding negotiation. + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/anything", nil) + // No Accept-Encoding header, but the predicate should still return true. + r.ServeHTTP(w, req) + require.Equal(t, http.StatusOK, w.Code) + }) +} diff --git a/internal/server/gzip_test.go b/internal/server/gzip_test.go index 7bdbf9189..1880a0f9d 100644 --- a/internal/server/gzip_test.go +++ b/internal/server/gzip_test.go @@ -8,7 +8,6 @@ import ( "net/http/httptest" "testing" - "github.com/gin-contrib/gzip" "github.com/gin-gonic/gin" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" @@ -17,18 +16,14 @@ import ( "github.com/photoprism/photoprism/pkg/http/proxy" ) -func TestGzipMiddleware(t *testing.T) { +func TestNewCompressMiddleware_Gzip(t *testing.T) { gin.SetMode(gin.TestMode) - // Enable gzip for this test router. conf := config.TestConfig() conf.Options().HttpCompression = "gzip" r := gin.New() - r.Use(gzip.Gzip( - gzip.DefaultCompression, - gzip.WithCustomShouldCompressFn(NewGzipShouldCompressFn(conf)), - )) + r.Use(NewCompressMiddleware(conf)) r.GET("/ok", func(c *gin.Context) { c.String(http.StatusOK, "hello world") @@ -69,6 +64,10 @@ func TestGzipMiddleware(t *testing.T) { c.String(http.StatusOK, "theme") }) + r.NoRoute(func(c *gin.Context) { + c.String(http.StatusNotFound, "404 page not found") + }) + sharePreviewRoute := conf.BaseUri("/s/:token/:shared/preview") r.GET(sharePreviewRoute, func(c *gin.Context) { c.String(http.StatusOK, "preview") @@ -89,6 +88,7 @@ func TestGzipMiddleware(t *testing.T) { require.Equal(t, http.StatusOK, w.Code) assert.Equal(t, "gzip", w.Header().Get("Content-Encoding")) + assert.Contains(t, w.Header().Get("Vary"), "Accept-Encoding") zr, err := stdgzip.NewReader(bytes.NewReader(w.Body.Bytes())) require.NoError(t, err) @@ -105,6 +105,7 @@ func TestGzipMiddleware(t *testing.T) { require.Equal(t, http.StatusOK, w.Code) assert.Empty(t, w.Header().Get("Content-Encoding")) + assert.Empty(t, w.Header().Get("Vary")) assert.Equal(t, "download", w.Body.String()) }) t.Run("DoesNotCompressExcludedExtensions", func(t *testing.T) { @@ -161,13 +162,19 @@ func TestGzipMiddleware(t *testing.T) { require.Equal(t, http.StatusOK, w.Code) assert.Empty(t, w.Header().Get("Content-Encoding")) + // Vary still set so caches don't serve compressed bytes to clients that won't accept them. + assert.Contains(t, w.Header().Get("Vary"), "Accept-Encoding") assert.Equal(t, "hello world", w.Body.String()) }) - t.Run("DoesNotCompressNotFound", func(t *testing.T) { + t.Run("BypassesCompressionFor404", func(t *testing.T) { w := doRequest("/missing", true) + // 404 falls through NoRoute; error responses bypass the encoder so the + // raw body lands on the wire, even though the predicate would have + // allowed compression for this path. require.Equal(t, http.StatusNotFound, w.Code) assert.Empty(t, w.Header().Get("Content-Encoding")) + assert.Contains(t, w.Header().Get("Vary"), "Accept-Encoding") assert.Contains(t, w.Body.String(), "404") }) } diff --git a/internal/server/limiter/limiter.go b/internal/server/limiter/limiter.go index 7060ef1f6..3000fc6e4 100644 --- a/internal/server/limiter/limiter.go +++ b/internal/server/limiter/limiter.go @@ -1,7 +1,7 @@ /* Package limiter provides an IP request rate limiter with Gin middleware. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/server/process/process.go b/internal/server/process/process.go index 9fca8c275..d1528addf 100644 --- a/internal/server/process/process.go +++ b/internal/server/process/process.go @@ -1,7 +1,7 @@ /* Package process provides server process information and handling. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/server/routes.go b/internal/server/routes.go index 4a42b1fd8..d6a1734b7 100644 --- a/internal/server/routes.go +++ b/internal/server/routes.go @@ -50,6 +50,7 @@ func registerRoutes(router *gin.Engine, conf *config.Config) { api.OAuthUserinfo(APIv1) api.OAuthToken(APIv1) api.OAuthRevoke(APIv1) + api.OAuthLogout(APIv1) // OIDC Client Endpoints. api.OIDCLogin(APIv1) @@ -105,6 +106,7 @@ func registerRoutes(router *gin.Engine, conf *config.Config) { // Photo Search and Organization. api.SearchPhotos(APIv1) + api.SearchPhotosView(APIv1) api.SearchGeo(APIv1) api.GetPlacesReverse(APIv1) api.GetPlacesSearch(APIv1) @@ -184,6 +186,14 @@ func registerRoutes(router *gin.Engine, conf *config.Config) { api.GetFace(APIv1) api.UpdateFace(APIv1) + // Cameras. + api.SearchCameras(APIv1) + api.UpdateCamera(APIv1) + + // Lenses. + api.SearchLenses(APIv1) + api.UpdateLens(APIv1) + // Batch Operations. api.BatchAlbumsDelete(APIv1) api.BatchLabelsDelete(APIv1) @@ -205,6 +215,11 @@ func registerRoutes(router *gin.Engine, conf *config.Config) { api.ClusterMetrics(APIv1) api.ClusterHealth(APIv1) + // Model Context Protocol (MCP). Can be disabled via --disable-mcp / + // PHOTOPRISM_DISABLE_MCP if the endpoint is not needed or should not + // be exposed (e.g. for security reasons). + api.ServeMCP(APIv1) + // Technical Endpoints. api.GetSvg(APIv1) api.GetStatus(APIv1) diff --git a/internal/server/routes_static.go b/internal/server/routes_static.go index c64c87cd9..56dfb7dad 100644 --- a/internal/server/routes_static.go +++ b/internal/server/routes_static.go @@ -124,20 +124,23 @@ func registerStaticRoutes(router *gin.Engine, conf *config.Config) { // Serves static favicon. router.StaticFile(conf.BaseUri("/favicon.ico"), conf.SiteFavicon()) - // Serves bundled assets like JS, CSS, and fonts. + // Serves bundled assets like JS, CSS, and fonts. Prefers precompressed + // .zst / .gz siblings emitted by frontend/scripts/precompress.js when the + // client's Accept-Encoding allows; see static_precompressed.go for the + // negotiation rules and Range/Vary handling. if dir := conf.StaticPath(); dir != "" { group := router.Group(conf.BaseUri(config.StaticUri), Static(conf)) - { - group.Static("", dir) - } + handler := PrecompressedStatic(conf, dir) + group.GET("/*filepath", handler) + group.HEAD("/*filepath", handler) } // Serves custom assets, e.g. bundled with extensions. if dir := conf.CustomStaticPath(); dir != "" { group := router.Group(conf.BaseUri(config.CustomStaticUri), Static(conf)) - { - group.Static("", dir) - } + handler := PrecompressedStatic(conf, dir) + group.GET("/*filepath", handler) + group.HEAD("/*filepath", handler) } // Serves rainbow test page. diff --git a/internal/server/routes_test.go b/internal/server/routes_test.go index 97186f5a6..df8d1343b 100644 --- a/internal/server/routes_test.go +++ b/internal/server/routes_test.go @@ -321,6 +321,10 @@ func TestWebAppRoutes(t *testing.T) { assert.True(t, strings.Contains(manifest, `"start_url": "`+pwa.StartUrl(conf.BaseUri("/"), conf.FrontendUri(``))+`",`)) assert.True(t, strings.Contains(manifest, `"url": "library/browse"`)) assert.True(t, strings.Contains(manifest, "/static/icons/logo/128.png")) + assert.True(t, strings.Contains(manifest, `"purpose": "maskable"`)) + assert.True(t, strings.Contains(manifest, "/static/icons/logo/maskable/512.png")) + assert.True(t, strings.Contains(manifest, `"lang":`)) + assert.True(t, strings.Contains(manifest, `"form_factor": "wide"`)) }) t.Run("GetServiceWorker", func(t *testing.T) { w := httptest.NewRecorder() diff --git a/internal/server/routes_wellknown.go b/internal/server/routes_wellknown.go index 4108eb817..ac5ba4e8c 100644 --- a/internal/server/routes_wellknown.go +++ b/internal/server/routes_wellknown.go @@ -22,7 +22,14 @@ func registerWellknownRoutes(router *gin.Engine, conf *config.Config) { }) // Registers the "/.well-known/openid-configuration" service discovery endpoint for OpenID Connect clients. + // Portal builds advertise the Portal OIDC OP shape (EdDSA ID tokens, authorization-code + PKCE); + // other builds advertise the instance's OAuth2 server. router.Any(conf.BaseUri("/.well-known/openid-configuration"), func(c *gin.Context) { + c.Header(header.CacheControl, "max-age=300, public") + if conf.Portal() { + c.JSON(http.StatusOK, wellknown.NewPortalOpenIDConfiguration(conf)) + return + } c.JSON(http.StatusOK, wellknown.NewOpenIDConfiguration(conf)) }) diff --git a/internal/server/server.go b/internal/server/server.go index d02ebc05c..da1d86054 100644 --- a/internal/server/server.go +++ b/internal/server/server.go @@ -1,7 +1,7 @@ /* Package server provides REST and Web server routing, request handling and logging. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/server/server_test.go b/internal/server/server_test.go index ce1c79a8e..7a115f764 100644 --- a/internal/server/server_test.go +++ b/internal/server/server_test.go @@ -13,7 +13,12 @@ import ( "github.com/photoprism/photoprism/pkg/fs" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) (code int) { // Init test logger. log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) @@ -24,20 +29,20 @@ func TestMain(m *testing.M) { // Init test config. c := config.TestConfig() + defer c.CleanupTestFolder() + defer func() { + if err := c.CloseDb(); err != nil { + log.Warnf("close db: %v", err) + } + // Remove temporary SQLite files after running the tests. + fs.PurgeTestDbFiles(".", false) + }() + get.SetConfig(c) // Increase login rate limit for testing. limiter.Login = limiter.NewLimit(1, 10000) // Run unit tests. - code := m.Run() - - if err := c.CloseDb(); err != nil { - log.Warnf("close db: %v", err) - } - - // Remove temporary SQLite files after running the tests. - fs.PurgeTestDbFiles(".", false) - - os.Exit(code) + return m.Run() } diff --git a/internal/server/start.go b/internal/server/start.go index 45b2f4a45..dce7116ed 100644 --- a/internal/server/start.go +++ b/internal/server/start.go @@ -7,13 +7,14 @@ import ( "fmt" "net" "net/http" + "net/url" "os" + "strings" "time" "golang.org/x/crypto/acme/autocert" "golang.org/x/sync/errgroup" - "github.com/gin-contrib/gzip" "github.com/gin-gonic/gin" "github.com/photoprism/photoprism/internal/api" @@ -67,17 +68,15 @@ func Start(ctx context.Context, conf *config.Config) { router.Use(Logger()) } + // Warn once per unsupported compression token so operator typos are visible. + for _, token := range conf.HttpCompressionUnknown() { + log.Warnf("server: ignored unsupported http-compression value %q", token) + } + // Register compression middleware if enabled in the configuration. - switch conf.HttpCompression() { - case "br", "brotli": - log.Infof("server: brotli compression is currently not supported") - case "gzip": - // Use a custom compression predicate for fast, targeted exclusions. - router.Use(gzip.Gzip( - gzip.DefaultCompression, - gzip.WithCustomShouldCompressFn(NewGzipShouldCompressFn(conf)), - )) - log.Infof("server: enabled gzip compression") + if prefs := conf.HttpCompressionPreferences(); len(prefs) > 0 { + router.Use(NewCompressMiddleware(conf)) + log.Infof("server: enabled http compression (%s)", strings.Join(prefs, " > ")) } // Register security middleware. @@ -279,7 +278,9 @@ func StartAutoTLS(s *http.Server, m *autocert.Manager, conf *config.Config) { var g errgroup.Group g.Go(func() error { - redirectSrv := newHTTPServer(m.HTTPHandler(http.HandlerFunc(redirect)), conf) + redirectSrv := newHTTPServer(m.HTTPHandler(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { + redirect(w, req, conf) + })), conf) redirectSrv.Addr = fmt.Sprintf("%s:%d", conf.HttpHost(), conf.HttpPort()) return redirectSrv.ListenAndServe() @@ -298,12 +299,55 @@ func StartAutoTLS(s *http.Server, m *autocert.Manager, conf *config.Config) { } } -func redirect(w http.ResponseWriter, req *http.Request) { - target := "https://" + req.Host + req.RequestURI +// redirect sends HTTP requests to the configured HTTPS site host. +func redirect(w http.ResponseWriter, req *http.Request, conf *config.Config) { + target := canonicalRedirectTarget(req, conf) http.Redirect(w, req, target, httpsRedirect) } +// canonicalRedirectTarget returns the HTTPS redirect target using the configured public site host. +func canonicalRedirectTarget(req *http.Request, conf *config.Config) string { + targetHost := "" + + if req != nil { + targetHost = req.Host + } + + if conf != nil { + if host := conf.SiteHost(); host != "" { + targetHost = host + } + } + + return HTTPSRedirectTarget(req, targetHost) +} + +// HTTPSRedirectTarget returns the HTTPS redirect target for the provided request and host. +func HTTPSRedirectTarget(req *http.Request, host string) string { + target := &url.URL{ + Scheme: "https", + Host: host, + Path: "/", + RawPath: "", + RawQuery: "", + } + + if req != nil && req.URL != nil { + target.Path = req.URL.Path + target.RawPath = req.URL.RawPath + target.RawQuery = req.URL.RawQuery + } else if req != nil && req.RequestURI != "" { + if u, err := url.ParseRequestURI(req.RequestURI); err == nil { + target.Path = u.Path + target.RawPath = u.RawPath + target.RawQuery = u.RawQuery + } + } + + return target.String() +} + // newHTTPServer creates an HTTP server with hardened header and idle settings. func newHTTPServer(handler http.Handler, conf *config.Config) *http.Server { headerTimeout := config.DefaultHttpHeaderTimeout diff --git a/internal/server/start_test.go b/internal/server/start_test.go index 61602fe5b..a0932f45a 100644 --- a/internal/server/start_test.go +++ b/internal/server/start_test.go @@ -6,6 +6,8 @@ import ( "testing" "time" + "golang.org/x/crypto/acme/autocert" + "github.com/gin-gonic/gin" "github.com/stretchr/testify/assert" @@ -104,3 +106,69 @@ func TestNewHTTPServer(t *testing.T) { assert.Equal(t, config.DefaultHttpHeaderBytes, server.MaxHeaderBytes) }) } + +func TestCanonicalRedirectTarget(t *testing.T) { + t.Run("UsesConfiguredSiteHostInsteadOfRequestHost", func(t *testing.T) { + conf := config.NewConfig(config.CliTestContext()) + conf.Options().SiteUrl = "https://photos.example.com:7443/library/" + + req := httptest.NewRequest(http.MethodGet, "http://evil.example.test/library/login?next=%2Flibrary", nil) + req.Host = "evil.example.test" + + target := canonicalRedirectTarget(req, conf) + + assert.Equal(t, "https://photos.example.com:7443/library/login?next=%2Flibrary", target) + }) + t.Run("FallsBackToRequestHostWithoutConfig", func(t *testing.T) { + req := httptest.NewRequest(http.MethodGet, "http://localhost:2342/library", nil) + req.Host = "localhost:2342" + + target := canonicalRedirectTarget(req, nil) + + assert.Equal(t, "https://localhost:2342/library", target) + }) +} + +func TestAutoTLSHTTPHandler(t *testing.T) { + t.Run("UsesCanonicalHostForFallbackRedirect", func(t *testing.T) { + conf := config.NewConfig(config.CliTestContext()) + conf.Options().SiteUrl = "https://photos.example.com:7443/library/" + + handler := (&autocert.Manager{ + HostPolicy: autocert.HostWhitelist(conf.SiteDomain()), + }).HTTPHandler(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + redirect(w, r, conf) + })) + + req := httptest.NewRequest(http.MethodGet, "http://evil.example.test/library/login?next=%2Flibrary", nil) + req.Host = "evil.example.test" + + w := httptest.NewRecorder() + handler.ServeHTTP(w, req) + + assert.Equal(t, httpsRedirect, w.Code) + assert.Equal(t, "https://photos.example.com:7443/library/login?next=%2Flibrary", w.Header().Get(header.Location)) + }) + t.Run("HandlesAcmeChallengeWithoutFallbackRedirect", func(t *testing.T) { + conf := config.NewConfig(config.CliTestContext()) + conf.Options().SiteUrl = "https://photos.example.com/" + + fallbackCalled := false + handler := (&autocert.Manager{ + HostPolicy: autocert.HostWhitelist(conf.SiteDomain()), + }).HTTPHandler(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + fallbackCalled = true + redirect(w, r, conf) + })) + + req := httptest.NewRequest(http.MethodGet, "http://photos.example.com/.well-known/acme-challenge/test-token", nil) + req.Host = conf.SiteDomain() + + w := httptest.NewRecorder() + handler.ServeHTTP(w, req) + + assert.False(t, fallbackCalled) + assert.Equal(t, http.StatusNotFound, w.Code) + assert.Empty(t, w.Header().Get(header.Location)) + }) +} diff --git a/internal/server/static_precompressed.go b/internal/server/static_precompressed.go new file mode 100644 index 000000000..9351fe5f6 --- /dev/null +++ b/internal/server/static_precompressed.go @@ -0,0 +1,161 @@ +package server + +import ( + "mime" + "net/http" + "path/filepath" + "strconv" + "strings" + "time" + + "github.com/gin-gonic/gin" + + "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/pkg/http/header" +) + +// precompressedExtensions maps each supported content-encoding to the +// sibling file suffix produced by frontend/scripts/precompress.js. +var precompressedExtensions = map[string]string{ + EncodingZstd: ".zst", + EncodingGzip: ".gz", +} + +// PrecompressedStatic serves files from dir, preferring the precompressed +// `.zst`/`.gz` sibling when Accept-Encoding allows. Range requests always go +// through the identity representation (Range offsets are over identity bytes). +// Vary: Accept-Encoding is emitted only when a sibling actually exists; when +// HttpCompressionPreferences is empty the handler degrades to identity-only. +func PrecompressedStatic(conf *config.Config, dir string) gin.HandlerFunc { + fs := http.Dir(dir) + prefs := conf.HttpCompressionPreferences() + + return func(c *gin.Context) { + // Gin only registers this handler for GET/HEAD, but guard anyway so + // odd verbs (e.g. via an upstream rewrite) get a clean 405 instead of + // a half-served body. + if c.Request.Method != http.MethodGet && c.Request.Method != http.MethodHead { + c.AbortWithStatus(http.StatusMethodNotAllowed) + return + } + + rel := c.Param("filepath") + if rel == "" { + rel = "/" + } + + // http.Dir.Open rejects path-traversal attempts, returning os.ErrNotExist + // for cleaned paths that escape the root. + f, err := fs.Open(rel) + if err != nil { + c.AbortWithStatus(http.StatusNotFound) + return + } + info, err := f.Stat() + if err != nil || info.IsDir() { + _ = f.Close() + c.AbortWithStatus(http.StatusNotFound) + return + } + + // Vary: Accept-Encoding only when an encoded sibling could be selected. + if len(prefs) > 0 { + for _, suffix := range precompressedExtensions { + if siblingExists(fs, rel+suffix) { + c.Writer.Header().Add(header.Vary, header.AcceptEncoding) + break + } + } + } + + // Range requests and disabled compression both fall through to identity. + if c.Request.Header.Get(header.Range) != "" || len(prefs) == 0 { + http.ServeContent(c.Writer, c.Request, info.Name(), info.ModTime(), f) + _ = f.Close() + return + } + + // Negotiate and stream the encoded sibling when one exists. + switch encoding := NegotiateEncoding(c.Request.Header.Get(header.AcceptEncoding), prefs); encoding { + case EncodingZstd, EncodingGzip: + suffix := precompressedExtensions[encoding] + if suffix != "" && siblingExists(fs, rel+suffix) { + _ = f.Close() + if servePrecompressed(c, fs, rel+suffix, encoding, info.Name(), info.ModTime()) { + return + } + // Sibling vanished between probe and Open — fall back to identity. + if reopen, openErr := fs.Open(rel); openErr == nil { + http.ServeContent(c.Writer, c.Request, info.Name(), info.ModTime(), reopen) + _ = reopen.Close() + } else { + c.AbortWithStatus(http.StatusNotFound) + } + return + } + } + + http.ServeContent(c.Writer, c.Request, info.Name(), info.ModTime(), f) + _ = f.Close() + } +} + +// servePrecompressed streams the precompressed sibling via http.ServeContent, +// advertising Content-Encoding and deriving Content-Type from the identity +// filename. Uses identityModTime (not the sibling's) so Last-Modified + +// If-Modified-Since revalidation stays aligned across encodings. +// Returns false if the sibling can no longer be opened so the caller can fall back. +func servePrecompressed( + c *gin.Context, + fs http.FileSystem, + siblingPath, encoding, identityName string, + identityModTime time.Time, +) bool { + sibling, err := fs.Open(siblingPath) + if err != nil { + return false + } + defer func() { _ = sibling.Close() }() + + info, err := sibling.Stat() + if err != nil || info.IsDir() { + return false + } + + // Set headers before http.ServeContent so its 304 path can strip them. + if ct := contentTypeForName(identityName); ct != "" { + c.Writer.Header().Set(header.ContentType, ct) + } + c.Writer.Header().Set(header.ContentEncoding, encoding) + // http.ServeContent won't set Content-Length when Content-Encoding is set; + // set it explicitly from the sibling's on-disk size. + c.Writer.Header().Set(header.ContentLength, strconv.FormatInt(info.Size(), 10)) + + http.ServeContent(c.Writer, c.Request, identityName, identityModTime, sibling) + return true +} + +// siblingExists reports whether a regular file exists at the given path +// within the static filesystem. Directories are not considered siblings. +func siblingExists(fs http.FileSystem, p string) bool { + f, err := fs.Open(p) + if err != nil { + return false + } + defer func() { _ = f.Close() }() + info, err := f.Stat() + if err != nil || info.IsDir() { + return false + } + return true +} + +// contentTypeForName returns the MIME type for a filename via the stdlib +// mime package, or "" when the extension is unknown. +func contentTypeForName(name string) string { + ext := strings.ToLower(filepath.Ext(name)) + if ext == "" { + return "" + } + return mime.TypeByExtension(ext) +} diff --git a/internal/server/static_precompressed_test.go b/internal/server/static_precompressed_test.go new file mode 100644 index 000000000..9e1922664 --- /dev/null +++ b/internal/server/static_precompressed_test.go @@ -0,0 +1,401 @@ +package server + +import ( + "bytes" + "compress/gzip" + "io" + "net/http" + "net/http/httptest" + "os" + "path/filepath" + "strings" + "testing" + "time" + + "github.com/gin-gonic/gin" + "github.com/klauspost/compress/zstd" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/internal/config" +) + +// staticFixture writes a deterministic identity file plus precompressed +// gzip and zstd siblings into a fresh temp dir and returns the dir path, +// the relative file name, and the raw identity bytes for assertions. +func staticFixture(t *testing.T, name string, size int) (dir, filename string, identity []byte) { + t.Helper() + + dir = t.TempDir() + alphabet := "0123456789abcdefghijklmnopqrstuvwxyz" + identity = bytes.Repeat([]byte(alphabet), (size/len(alphabet))+1)[:size] + require.NoError(t, os.WriteFile(filepath.Join(dir, name), identity, 0o600)) + + var gz bytes.Buffer + gw := gzip.NewWriter(&gz) + _, err := gw.Write(identity) + require.NoError(t, err) + require.NoError(t, gw.Close()) + require.NoError(t, os.WriteFile(filepath.Join(dir, name+".gz"), gz.Bytes(), 0o600)) + + zenc, err := zstd.NewWriter(nil) + require.NoError(t, err) + zbytes := zenc.EncodeAll(identity, nil) + require.NoError(t, zenc.Close()) + require.NoError(t, os.WriteFile(filepath.Join(dir, name+".zst"), zbytes, 0o600)) + + return dir, name, identity +} + +// newPrecompressedTestRouter builds a router that mirrors the real +// production wiring: NewCompressMiddleware is registered globally and +// /static/*filepath is served by PrecompressedStatic. The runtime +// middleware should be a no-op for /static/* because the predicate now +// excludes those paths. +func newPrecompressedTestRouter(t *testing.T, prefs, dir string) *gin.Engine { + t.Helper() + gin.SetMode(gin.TestMode) + + conf := config.TestConfig() + conf.Options().HttpCompression = prefs + + r := gin.New() + r.Use(NewCompressMiddleware(conf)) + handler := PrecompressedStatic(conf, dir) + r.GET("/static/*filepath", handler) + r.HEAD("/static/*filepath", handler) + return r +} + +func TestPrecompressedStatic_ServesZstdSibling(t *testing.T) { + dir, name, identity := staticFixture(t, "app.js", 4096) + r := newPrecompressedTestRouter(t, "zstd,gzip", dir) + + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/static/"+name, nil) + req.Header.Set("Accept-Encoding", "zstd, gzip") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Equal(t, "zstd", w.Header().Get("Content-Encoding"), + "zstd preference + zstd-capable client should pick the .zst sibling") + assert.Contains(t, w.Header().Get("Vary"), "Accept-Encoding", + "Vary belongs on every response that could vary by Accept-Encoding") + assert.Contains(t, w.Header().Get("Content-Type"), "javascript", + "Content-Type must reflect the identity filename, not the .zst suffix") + + dec, err := zstd.NewReader(bytes.NewReader(w.Body.Bytes())) + require.NoError(t, err) + defer dec.Close() + out, err := io.ReadAll(dec) + require.NoError(t, err) + assert.Equal(t, identity, out, "zstd-decoded body must round-trip to the identity bytes") +} + +func TestPrecompressedStatic_ServesGzipFallback(t *testing.T) { + dir, name, identity := staticFixture(t, "app.css", 4096) + r := newPrecompressedTestRouter(t, "zstd,gzip", dir) + + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/static/"+name, nil) + req.Header.Set("Accept-Encoding", "gzip") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Equal(t, "gzip", w.Header().Get("Content-Encoding"), + "gzip-only clients fall back to the .gz sibling even when zstd is preferred") + assert.Contains(t, w.Header().Get("Vary"), "Accept-Encoding") + + gr, err := gzip.NewReader(bytes.NewReader(w.Body.Bytes())) + require.NoError(t, err) + defer gr.Close() + out, err := io.ReadAll(gr) + require.NoError(t, err) + assert.Equal(t, identity, out) +} + +func TestPrecompressedStatic_ServesIdentityWhenNoEncodingMatches(t *testing.T) { + dir, name, identity := staticFixture(t, "app.js", 4096) + r := newPrecompressedTestRouter(t, "zstd,gzip", dir) + + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/static/"+name, nil) + // Client only accepts brotli, which we don't have a sibling for. + req.Header.Set("Accept-Encoding", "br") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Empty(t, w.Header().Get("Content-Encoding"), + "identity fallback must not set Content-Encoding") + assert.Contains(t, w.Header().Get("Vary"), "Accept-Encoding", + "Vary still belongs on the response since a sibling existed for some encoding") + assert.Equal(t, identity, w.Body.Bytes(), "body must be the raw identity bytes") +} + +func TestPrecompressedStatic_ServesIdentityWhenNoSiblings(t *testing.T) { + // File without precompressed siblings — happens during dev (watch mode) + // and for assets that don't compress meaningfully (skipped by the build + // script's MIN_RATIO threshold). + dir := t.TempDir() + identity := []byte(strings.Repeat("0123456789abcdefghijklmnopqrstuvwxyz", 16)) + name := "raw.bin" + require.NoError(t, os.WriteFile(filepath.Join(dir, name), identity, 0o600)) + + r := newPrecompressedTestRouter(t, "zstd,gzip", dir) + + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/static/"+name, nil) + req.Header.Set("Accept-Encoding", "zstd, gzip") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Empty(t, w.Header().Get("Content-Encoding"), + "no sibling exists, so the response must be identity") + assert.Empty(t, w.Header().Get("Vary"), + "Vary must not be set when no precompressed sibling could ever have been served") + assert.Equal(t, identity, w.Body.Bytes()) +} + +func TestPrecompressedStatic_RangeRequestServesIdentity(t *testing.T) { + dir, name, identity := staticFixture(t, "app.js", 256) + r := newPrecompressedTestRouter(t, "zstd,gzip", dir) + + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/static/"+name, nil) + req.Header.Set("Range", "bytes=10-19") + req.Header.Set("Accept-Encoding", "zstd, gzip") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusPartialContent, w.Code, + "Range requests on existing siblings must still produce 206") + assert.Empty(t, w.Header().Get("Content-Encoding"), + "Range responses must serve the identity slice — byte offsets are over identity bytes") + assert.Contains(t, w.Header().Get("Vary"), "Accept-Encoding", + "Vary still belongs on Range responses so caches don't reuse the slice for non-Range requests") + assert.Equal(t, identity[10:20], w.Body.Bytes(), + "206 body must be the raw identity slice the client requested") +} + +func TestPrecompressedStatic_RuntimeMiddlewareDoesNotDoubleEncode(t *testing.T) { + dir, name, identity := staticFixture(t, "app.js", 4096) + r := newPrecompressedTestRouter(t, "zstd,gzip", dir) + + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/static/"+name, nil) + req.Header.Set("Accept-Encoding", "zstd, gzip") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Equal(t, "zstd", w.Header().Get("Content-Encoding"), + "a single Content-Encoding header must be present — no double encoding") + assert.Len(t, w.Header().Values("Content-Encoding"), 1, + "Content-Encoding must not be wrapped twice when the runtime middleware is also active") + + // Decode once and confirm the identity bytes pop out — if the runtime + // middleware had wrapped the body again, this single zstd decode would + // fail or yield encoded bytes instead of the original. + dec, err := zstd.NewReader(bytes.NewReader(w.Body.Bytes())) + require.NoError(t, err) + defer dec.Close() + out, err := io.ReadAll(dec) + require.NoError(t, err, "single zstd decode must succeed; double encoding would fail or return encoded bytes") + assert.Equal(t, identity, out, "single zstd decode must yield the identity bytes") +} + +func TestPrecompressedStatic_NoneDisablesEncodedSelection(t *testing.T) { + dir, name, identity := staticFixture(t, "app.js", 4096) + r := newPrecompressedTestRouter(t, "none", dir) + + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/static/"+name, nil) + req.Header.Set("Accept-Encoding", "zstd, gzip") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Empty(t, w.Header().Get("Content-Encoding"), + "PHOTOPRISM_HTTP_COMPRESSION=none must disable precompressed-sibling selection") + assert.Empty(t, w.Header().Get("Vary"), + "with compression disabled the response never varies by Accept-Encoding — "+ + "setting Vary would mislead shared caches into keeping redundant per-encoding entries") + assert.Equal(t, identity, w.Body.Bytes()) +} + +func TestPrecompressedStatic_PrecompressedResponseHasLastModified(t *testing.T) { + // http.ServeContent emits Last-Modified on every successful response + // from a non-zero modtime, which is what enables clients to revalidate + // later via If-Modified-Since. Confirm it survives the precompressed + // path so caches don't lose validators when zstd/gzip is selected. + dir, name, _ := staticFixture(t, "app.js", 4096) + + mtime := time.Date(2026, 5, 1, 12, 0, 0, 0, time.UTC) + require.NoError(t, os.Chtimes(filepath.Join(dir, name), mtime, mtime)) + + r := newPrecompressedTestRouter(t, "zstd,gzip", dir) + + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/static/"+name, nil) + req.Header.Set("Accept-Encoding", "zstd") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Equal(t, "zstd", w.Header().Get("Content-Encoding")) + assert.NotEmpty(t, w.Header().Get("Last-Modified"), + "precompressed responses must carry Last-Modified so clients can revalidate") +} + +func TestPrecompressedStatic_PrecompressedReturns304OnIfModifiedSince(t *testing.T) { + // Conditional revalidation must work for precompressed siblings; before + // the http.ServeContent refactor servePrecompressed wrote 200 OK + // unconditionally, which would have broken cache freshness checks for + // every bundled JS/CSS asset in the wild. + dir, name, _ := staticFixture(t, "app.js", 4096) + + mtime := time.Date(2026, 5, 1, 12, 0, 0, 0, time.UTC) + require.NoError(t, os.Chtimes(filepath.Join(dir, name), mtime, mtime)) + + r := newPrecompressedTestRouter(t, "zstd,gzip", dir) + + t.Run("ServerSideMatchReturns304", func(t *testing.T) { + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/static/"+name, nil) + req.Header.Set("Accept-Encoding", "zstd") + // If-Modified-Since equal to or after mtime — serve must 304. + req.Header.Set("If-Modified-Since", mtime.Add(time.Hour).UTC().Format(http.TimeFormat)) + r.ServeHTTP(w, req) + + assert.Equal(t, http.StatusNotModified, w.Code, + "a fresh If-Modified-Since must short-circuit to 304 even on the precompressed path") + assert.Empty(t, w.Body.Bytes(), "304 responses must not carry a body") + // http.ServeContent's writeNotModified strips Content-Encoding / + // Content-Length / Content-Type; assert that to lock in the contract. + assert.Empty(t, w.Header().Get("Content-Encoding"), + "304 must not advertise an encoding for an empty body") + assert.Empty(t, w.Header().Get("Content-Length"), + "304 must not advertise a body size for an empty body") + }) + + t.Run("StaleIfModifiedSinceStillReturns200", func(t *testing.T) { + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/static/"+name, nil) + req.Header.Set("Accept-Encoding", "zstd") + // If-Modified-Since strictly before mtime — serve must 200 with the + // encoded body, just like the non-conditional case. + req.Header.Set("If-Modified-Since", mtime.Add(-time.Hour).UTC().Format(http.TimeFormat)) + r.ServeHTTP(w, req) + + assert.Equal(t, http.StatusOK, w.Code, + "a stale If-Modified-Since must not suppress the body") + assert.Equal(t, "zstd", w.Header().Get("Content-Encoding")) + assert.NotEmpty(t, w.Body.Bytes(), + "200 responses must carry the encoded body") + }) +} + +func TestPrecompressedStatic_ServiceWorkerKeepsJavaScriptMimeType(t *testing.T) { + // Browsers reject service workers served with a non-JavaScript + // Content-Type, so registering /static/build/sw.js must keep the .js + // MIME type when the encoded sibling is selected — otherwise the PWA + // would silently break on every refresh once the bundle is precompressed. + // This also covers the importScripts() shim (sw-scope-cleanup.js) and + // every workbox-*.js helper, since they share the same code path. + dir, name, _ := staticFixture(t, "sw.js", 4096) + r := newPrecompressedTestRouter(t, "zstd,gzip", dir) + + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/static/"+name, nil) + req.Header.Set("Accept-Encoding", "zstd") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Equal(t, "zstd", w.Header().Get("Content-Encoding")) + assert.Contains(t, w.Header().Get("Content-Type"), "javascript", + "sw.js Content-Type must be derived from the identity filename, not the .zst suffix — "+ + "otherwise the browser refuses to register the service worker") +} + +func TestPrecompressedStatic_HeadRequest(t *testing.T) { + dir, name, identity := staticFixture(t, "app.js", 4096) + r := newPrecompressedTestRouter(t, "zstd,gzip", dir) + + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodHead, "/static/"+name, nil) + req.Header.Set("Accept-Encoding", "zstd") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Equal(t, "zstd", w.Header().Get("Content-Encoding"), + "HEAD must advertise the same encoding the GET would use") + assert.NotEmpty(t, w.Header().Get("Content-Length"), + "HEAD must report the precompressed sibling's size in Content-Length") + assert.Empty(t, w.Body.Bytes(), + "HEAD must not write a body even when a sibling exists") + _ = identity +} + +func TestPrecompressedStatic_NotFound(t *testing.T) { + dir, _, _ := staticFixture(t, "app.js", 4096) + r := newPrecompressedTestRouter(t, "zstd,gzip", dir) + + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/static/missing.js", nil) + req.Header.Set("Accept-Encoding", "zstd") + r.ServeHTTP(w, req) + + assert.Equal(t, http.StatusNotFound, w.Code, + "unknown identity files must 404, not silently fall through to the sibling") +} + +func TestPrecompressedStatic_RejectsPathTraversal(t *testing.T) { + // Sanity check that http.Dir.Open rejects "..". Without this guard, + // a crafted /static/..%2Fetc%2Fpasswd could leak files outside the + // static root. + dir, _, _ := staticFixture(t, "app.js", 4096) + // Place a sentinel file outside the static root. + outside := filepath.Join(filepath.Dir(dir), "secret.txt") + require.NoError(t, os.WriteFile(outside, []byte("super secret"), 0o600)) + t.Cleanup(func() { _ = os.Remove(outside) }) + + r := newPrecompressedTestRouter(t, "zstd,gzip", dir) + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/static/../secret.txt", nil) + r.ServeHTTP(w, req) + + assert.NotEqual(t, http.StatusOK, w.Code, + "path traversal must not return a successful response") + assert.NotContains(t, w.Body.String(), "super secret", + "path traversal must not leak file contents from outside the static root") +} + +func TestSiblingExists(t *testing.T) { + dir := t.TempDir() + require.NoError(t, os.WriteFile(filepath.Join(dir, "yes.js"), []byte("x"), 0o600)) + require.NoError(t, os.MkdirAll(filepath.Join(dir, "subdir"), 0o750)) + + fs := http.Dir(dir) + + t.Run("FileExists", func(t *testing.T) { + assert.True(t, siblingExists(fs, "yes.js")) + }) + t.Run("FileMissing", func(t *testing.T) { + assert.False(t, siblingExists(fs, "no.js")) + }) + t.Run("DirectoryNotConsideredFile", func(t *testing.T) { + // Directories are valid filesystem entries but not valid siblings. + assert.False(t, siblingExists(fs, "subdir")) + }) +} + +func TestContentTypeForName(t *testing.T) { + t.Run("Js", func(t *testing.T) { + assert.Contains(t, contentTypeForName("app.js"), "javascript") + }) + t.Run("Css", func(t *testing.T) { + assert.Contains(t, contentTypeForName("app.css"), "css") + }) + t.Run("UnknownExtensionReturnsEmpty", func(t *testing.T) { + assert.Equal(t, "", contentTypeForName("blob.xyzzy")) + }) + t.Run("NoExtensionReturnsEmpty", func(t *testing.T) { + assert.Equal(t, "", contentTypeForName("README")) + }) +} diff --git a/internal/server/sw_fallback.js b/internal/server/sw_fallback.js index 556e0c23b..1a356973c 100644 --- a/internal/server/sw_fallback.js +++ b/internal/server/sw_fallback.js @@ -9,6 +9,6 @@ self.addEventListener("activate", (event) => { }); self.addEventListener("fetch", () => { - // Default network-first behaviour; caching is delegated to the + // Default network-first behavior; caching is delegated to the // Workbox-generated service worker in production builds. }); diff --git a/internal/server/webdav.go b/internal/server/webdav.go index 7ebc60175..5d45d984a 100644 --- a/internal/server/webdav.go +++ b/internal/server/webdav.go @@ -1,6 +1,7 @@ package server import ( + "errors" "fmt" "net/http" "os" @@ -11,7 +12,9 @@ import ( "github.com/gin-gonic/gin" "golang.org/x/net/webdav" + "github.com/photoprism/photoprism/internal/api" "github.com/photoprism/photoprism/internal/config" + "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/internal/mutex" "github.com/photoprism/photoprism/internal/workers/auto" "github.com/photoprism/photoprism/pkg/clean" @@ -54,13 +57,19 @@ func WebDAV(dir string, router *gin.RouterGroup, conf *config.Config) { // Request logger function. loggerFunc := func(request *http.Request, err error) { if err != nil { - switch request.Method { - case header.MethodPut, header.MethodMkcol, header.MethodDelete, header.MethodMove, header.MethodCopy, header.MethodProppatch, header.MethodLock, header.MethodUnlock: - log.Errorf("webdav: %s in %s %s", clean.Error(err), clean.Log(request.Method), clean.Log(request.URL.String())) - case header.MethodPropfind: - log.Tracef("webdav: %s in %s %s", clean.Error(err), clean.Log(request.Method), clean.Log(request.URL.String())) + // Route WebDAV request errors to the console-only system log, not log.*. + // x/net/webdav embeds absolute originals/import paths in its messages, + // which must stay out of the browser log viewer and the persisted errors + // table; operators still see full detail in the server console. + switch { + case request.Method == header.MethodMkcol && errors.Is(err, os.ErrExist): + // MKCOL on an existing collection is a benign probe: sync clients such as + // PhotoSync test for a directory before creating it — expected, not a failure. + event.SystemDebug([]string{"webdav", "collection %s already exists"}, clean.Log(request.URL.String())) + case WebDAVWriteMethod(request.Method): + event.SystemError([]string{"webdav", "%s in %s %s"}, clean.Error(err), clean.Log(request.Method), clean.Log(request.URL.String())) default: - log.Debugf("webdav: %s in %s %s", clean.Error(err), clean.Log(request.Method), clean.Log(request.URL.String())) + event.SystemDebug([]string{"webdav", "%s in %s %s"}, clean.Error(err), clean.Log(request.Method), clean.Log(request.URL.String())) } } else { // Determine the filename if it is an uploaded file and process custom request headers, if any. @@ -112,12 +121,21 @@ func WebDAV(dir string, router *gin.RouterGroup, conf *config.Config) { // is not enough free storage to upload new files. switch c.Request.Method { case header.MethodPut, header.MethodCopy: - if conf.FilesQuotaReached() { + if conf.InsufficientStorage() { c.AbortWithStatus(http.StatusInsufficientStorage) return } } + // Bound an uploaded file to the configured originals size limit (when set) so a single + // PUT cannot stream an unbounded body to disk; the free-storage check above only catches + // the next request. No-op when no originals limit is configured. + if c.Request.Method == header.MethodPut { + if limit := conf.OriginalsLimitBytes(); limit > 0 { + api.LimitRequestBodyBytes(c, limit) + } + } + // Invoke handler callback. WebDAVHandler(c, router, srv) } @@ -210,23 +228,40 @@ func WebDAVFileName(request *http.Request, router *gin.RouterGroup, conf *config } // joinUnderBase joins a base directory with a relative name and ensures -// that the resulting path stays within the base directory. Absolute -// paths and Windows-style volume names are rejected. +// that the resulting path stays within the base directory. Absolute paths, +// Windows-style volume names, and drive-letter prefixes are rejected, and +// containment is verified with filepath.Rel rather than a string prefix. +// This mirrors the hardened safe-join used for archive extraction in pkg/fs. func joinUnderBase(baseDir, rel string) (string, error) { if rel == "" { return "", fmt.Errorf("invalid path") } + + // Normalize separators so mixed '/' and '\\' are handled consistently. + rel = strings.ReplaceAll(rel, "\\", "/") + + // Reject Windows-style drive-letter prefixes even on non-Windows platforms. + if len(rel) >= 2 && rel[1] == ':' && ((rel[0] >= 'A' && rel[0] <= 'Z') || (rel[0] >= 'a' && rel[0] <= 'z')) { + return "", fmt.Errorf("invalid path: absolute or volume path not allowed") + } + // Reject absolute or volume paths. if filepath.IsAbs(rel) || filepath.VolumeName(rel) != "" { return "", fmt.Errorf("invalid path: absolute or volume path not allowed") } + cleaned := filepath.Clean(rel) - // Compose destination and verify it stays inside base. - dest := filepath.Join(baseDir, cleaned) base := filepath.Clean(baseDir) - if dest != base && !strings.HasPrefix(dest, base+string(os.PathSeparator)) { + + // Compose destination and verify it stays inside base using filepath.Rel. + dest := filepath.Join(base, cleaned) + relToBase, err := filepath.Rel(base, dest) + if err != nil { + return "", fmt.Errorf("invalid path: %w", err) + } else if relToBase == ".." || strings.HasPrefix(relToBase, ".."+string(os.PathSeparator)) { return "", fmt.Errorf("invalid path: outside base directory") } + return dest, nil } @@ -242,13 +277,15 @@ func WebDAVSetFavoriteFlag(fileName string) { // Make sure directory exists. if err := fs.MkdirAll(filepath.Dir(yamlName)); err != nil { - log.Errorf("webdav: %s", err.Error()) + // Console-only: the error embeds the absolute sidecar path (see loggerFunc). + event.SystemError([]string{"webdav", "%s"}, clean.Error(err)) return } // Write YAML data to file. if err := fs.WriteFile(yamlName, []byte("Favorite: true\n"), fs.ModeConfigFile); err != nil { - log.Errorf("webdav: %s", err.Error()) + // Console-only: the error embeds the absolute sidecar path (see loggerFunc). + event.SystemError([]string{"webdav", "%s"}, clean.Error(err)) return } diff --git a/internal/server/webdav_actions_test.go b/internal/server/webdav_actions_test.go index e79cb181d..8d62c5e1c 100644 --- a/internal/server/webdav_actions_test.go +++ b/internal/server/webdav_actions_test.go @@ -5,7 +5,10 @@ import ( "path/filepath" "testing" + "github.com/sirupsen/logrus" "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/event" ) func TestWebDAVSetFavoriteFlag_CreatesYamlOnce(t *testing.T) { @@ -26,6 +29,31 @@ func TestWebDAVSetFavoriteFlag_CreatesYamlOnce(t *testing.T) { assert.Equal(t, string(orig), string(now)) } +func TestWebDAVSetFavoriteFlag_WriteErrorGoesToSystemLog(t *testing.T) { + dir := t.TempDir() + // A regular file where a directory is expected makes MkdirAll fail with an + // error that embeds the absolute path; that must not reach the UI log stream. + blocker := filepath.Join(dir, "blocker") + assert.NoError(t, os.WriteFile(blocker, []byte("x"), 0o600)) + file := filepath.Join(blocker, "img.jpg") + + hook := &logCapture{} + event.SystemLog.ReplaceHooks(logrus.LevelHooks{}) + event.SystemLog.AddHook(hook) + defer event.SystemLog.ReplaceHooks(logrus.LevelHooks{}) + + WebDAVSetFavoriteFlag(file) + + var found bool + for _, e := range hook.entries { + if e.Level == logrus.ErrorLevel { + found = true + } + } + assert.True(t, found, "sidecar write failure must be logged on the system log") + assert.NoFileExists(t, filepath.Join(blocker, "img.yml")) +} + func TestWebDAVSetFileMtime_NoFuture(t *testing.T) { dir := t.TempDir() file := filepath.Join(dir, "a.txt") diff --git a/internal/server/webdav_auth.go b/internal/server/webdav_auth.go index e09477c30..2c73ed73e 100644 --- a/internal/server/webdav_auth.go +++ b/internal/server/webdav_auth.go @@ -25,8 +25,9 @@ import ( "github.com/photoprism/photoprism/pkg/rnd" ) -// Use auth cache to improve WebDAV performance. It has a standard expiration time of about 5 minutes. -var webdavAuthExpiration = 5 * time.Minute +// Use auth cache to improve WebDAV performance. The short expiration time bounds how long +// a credential keeps working after the account is changed or its WebDAV access is revoked. +var webdavAuthExpiration = 1 * time.Minute var webdavAuthCache = gc.New(webdavAuthExpiration, webdavAuthExpiration) var webdavAuthMutex = sync.Mutex{} @@ -114,6 +115,16 @@ func WebDAVAuth(conf *config.Config) gin.HandlerFunc { event.AuditErr([]string{clientIp, "webdav", "client %s", "session %s", "access without user account", status.Denied}, clean.Log(sess.GetClientInfo()), sess.RefID) WebDAVAbortUnauthorized(c) return + } else if sess.IsApplication() && conf.DisableAppPasswords() { + // Reject app passwords when the feature is disabled, so tokens minted before + // the flag was turned off stop working. Identified by the session's auth + // provider (IsApplication). A previously-authorized app password may persist + // until its WebDAV auth-cache entry expires (~5 min). The 401 (vs the REST + // path's 403) is the standard WebDAV re-auth response. + limiter.Auth.Reserve(clientIp) + event.AuditWarn([]string{clientIp, "webdav", "access with app passwords disabled", status.Denied}) + WebDAVAbortUnauthorized(c) + return } else if sess.IsClient() && sess.InsufficientScope(acl.ResourceWebDAV, nil) { // Log error if the client is allowed to access webdav based on its scope. message := authn.ErrInsufficientScope.Error() diff --git a/internal/server/webdav_auth_test.go b/internal/server/webdav_auth_test.go index d88ae36c8..fbf4a59e4 100644 --- a/internal/server/webdav_auth_test.go +++ b/internal/server/webdav_auth_test.go @@ -145,6 +145,28 @@ func TestWebDAVAuth(t *testing.T) { webdavAuthCache.Flush() webdavHandler(c) + assert.Equal(t, http.StatusUnauthorized, c.Writer.Status()) + assert.Equal(t, BasicAuthRealm, c.Writer.Header().Get("WWW-Authenticate")) + }) + t.Run("AppPasswordsDisabled", func(t *testing.T) { + w := httptest.NewRecorder() + c, _ := gin.CreateTestContext(w) + c.Request = &http.Request{ + Header: make(http.Header), + } + + // A real app-password session (OIDC-only user, session grant) read from fixtures + // so the gate's provider check is exercised without a database write. + sess := entity.SessionFixtures.Get("alice_app_password") + assert.True(t, sess.IsApplication()) + header.SetAuthorization(c.Request, sess.AuthToken()) + + conf.Settings().Features.AppPasswords = false + defer func() { conf.Settings().Features.AppPasswords = true }() + + webdavAuthCache.Flush() + webdavHandler(c) + assert.Equal(t, http.StatusUnauthorized, c.Writer.Status()) assert.Equal(t, BasicAuthRealm, c.Writer.Header().Get("WWW-Authenticate")) }) diff --git a/internal/server/webdav_path_test.go b/internal/server/webdav_path_test.go index 7c41558d7..e3c931119 100644 --- a/internal/server/webdav_path_test.go +++ b/internal/server/webdav_path_test.go @@ -1,8 +1,14 @@ package server -import "testing" +import ( + "testing" + + "github.com/photoprism/photoprism/pkg/http/proxy" +) func TestIsWebDAVPath(t *testing.T) { + // Derive proxy paths from the configured prefix so the cases stay valid + // regardless of the proxy.PathPrefix / proxy.DefaultPathPrefix value. tests := []struct { name string path string @@ -11,12 +17,12 @@ func TestIsWebDAVPath(t *testing.T) { }{ {name: "RootOriginals", path: "/originals", want: true}, {name: "RootImportChild", path: "/import/folder/file.jpg", want: true}, - {name: "ProxyOriginals", path: "/i/acme/originals/", want: true}, - {name: "ProxyImport", path: "/i/acme/import/a.jpg", want: true}, + {name: "ProxyOriginals", path: proxy.PathPrefix + "acme/originals/", want: true}, + {name: "ProxyImport", path: proxy.PathPrefix + "acme/import/a.jpg", want: true}, {name: "CustomBaseOriginals", path: "/instance-a/originals/album", basePaths: []string{"/instance-a/originals", "/instance-a/import"}, want: true}, {name: "CustomBaseImport", path: "/instance-a/import", basePaths: []string{"/instance-a/originals", "/instance-a/import"}, want: true}, {name: "LibraryPath", path: "/library/browse", want: false}, - {name: "ProxyNonDAV", path: "/i/acme/library", want: false}, + {name: "ProxyNonDAV", path: proxy.PathPrefix + "acme/library", want: false}, } for _, tc := range tests { diff --git a/internal/server/webdav_secure_test.go b/internal/server/webdav_secure_test.go index 46c1089a4..a89ca978d 100644 --- a/internal/server/webdav_secure_test.go +++ b/internal/server/webdav_secure_test.go @@ -18,16 +18,58 @@ import ( func TestJoinUnderBase(t *testing.T) { base := t.TempDir() - // Normal join - out, err := joinUnderBase(base, "a/b/c.txt") - assert.NoError(t, err) - assert.Equal(t, filepath.Join(base, "a/b/c.txt"), out) - // Absolute rejected - _, err = joinUnderBase(base, "/etc/passwd") - assert.Error(t, err) - // Parent traversal rejected - _, err = joinUnderBase(base, "../../etc/passwd") - assert.Error(t, err) + t.Run("NormalJoin", func(t *testing.T) { + out, err := joinUnderBase(base, "a/b/c.txt") + assert.NoError(t, err) + assert.Equal(t, filepath.Join(base, "a/b/c.txt"), out) + }) + t.Run("BackslashNormalized", func(t *testing.T) { + out, err := joinUnderBase(base, "a\\b\\c.txt") + assert.NoError(t, err) + assert.Equal(t, filepath.Join(base, "a/b/c.txt"), out) + }) + t.Run("CleansInsideBase", func(t *testing.T) { + out, err := joinUnderBase(base, "dir/../evil.txt") + assert.NoError(t, err) + assert.Equal(t, filepath.Join(base, "evil.txt"), out) + }) + t.Run("EmptyRejected", func(t *testing.T) { + _, err := joinUnderBase(base, "") + assert.Error(t, err) + }) + t.Run("AbsoluteRejected", func(t *testing.T) { + _, err := joinUnderBase(base, "/etc/passwd") + assert.Error(t, err) + }) + t.Run("RootedBackslashRejected", func(t *testing.T) { + // "\rooted\path.txt" normalizes to "/rooted/path.txt", caught as absolute. + _, err := joinUnderBase(base, "\\rooted\\path.txt") + assert.Error(t, err) + }) + t.Run("ParentTraversalRejected", func(t *testing.T) { + _, err := joinUnderBase(base, "../../etc/passwd") + assert.Error(t, err) + }) + t.Run("BackslashTraversalRejected", func(t *testing.T) { + _, err := joinUnderBase(base, "..\\..\\etc\\passwd") + assert.Error(t, err) + }) + t.Run("DriveLetterForwardSlashRejected", func(t *testing.T) { + _, err := joinUnderBase(base, "C:/drive.txt") + assert.Error(t, err) + }) + t.Run("DriveLetterBackslashRejected", func(t *testing.T) { + _, err := joinUnderBase(base, "C:\\drive.txt") + assert.Error(t, err) + }) + t.Run("LowercaseDriveLetterRejected", func(t *testing.T) { + _, err := joinUnderBase(base, "c:/drive.txt") + assert.Error(t, err) + }) + t.Run("VolumeNameOnlyRejected", func(t *testing.T) { + _, err := joinUnderBase(base, "C:") + assert.Error(t, err) + }) } func TestWebDAVFileName_PathTraversalRejected(t *testing.T) { @@ -55,6 +97,17 @@ func TestWebDAVFileName_PathTraversalRejected(t *testing.T) { assert.Equal(t, insideFile, got) } +func TestWebDAVFileName_DriveLetterRejected(t *testing.T) { + conf := newWebDAVTestConfig(t) + r := gin.New() + grp := r.Group(conf.BaseUri(WebDAVOriginals)) + // A Windows drive-letter prefix must not resolve to an in-tree name. + req := &http.Request{Method: header.MethodPut} + req.URL = &url.URL{Path: conf.BaseUri(WebDAVOriginals) + "/C:/drive.txt"} + got := WebDAVFileName(req, grp, conf) + assert.Equal(t, "", got, "should reject drive-letter path") +} + func TestWebDAVFileName_MethodNotPut(t *testing.T) { conf := newWebDAVTestConfig(t) r := gin.New() diff --git a/internal/server/webdav_write_test.go b/internal/server/webdav_write_test.go index d4dfe95f7..f58179c1e 100644 --- a/internal/server/webdav_write_test.go +++ b/internal/server/webdav_write_test.go @@ -11,10 +11,12 @@ import ( "testing" "github.com/gin-gonic/gin" + "github.com/sirupsen/logrus" "github.com/stretchr/testify/assert" "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/entity" + "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/pkg/http/header" ) @@ -64,6 +66,90 @@ func TestWebDAVWrite_MKCOL_PUT(t *testing.T) { assert.Equal(t, "hello", string(b)) } +// logCapture is a logrus hook that records emitted entries for assertions. +type logCapture struct{ entries []*logrus.Entry } + +// Levels reports the log levels the capture hook fires on. +func (h *logCapture) Levels() []logrus.Level { return logrus.AllLevels } + +// Fire records the given log entry. +func (h *logCapture) Fire(e *logrus.Entry) error { + h.entries = append(h.entries, e) + return nil +} + +func TestWebDAVWrite_MKCOL_Exists(t *testing.T) { + conf := newWebDAVTestConfig(t) + if err := conf.CreateDirectories(); err != nil { + t.Fatalf("failed to create test directories: %v", err) + } + r := setupWebDAVRouter(conf) + + // First MKCOL creates the collection. + w := httptest.NewRecorder() + req := httptest.NewRequest(header.MethodMkcol, conf.BaseUri(WebDAVOriginals)+"/exists", nil) + authBearer(req) + r.ServeHTTP(w, req) + assert.Equal(t, http.StatusCreated, w.Code) + + // Capture the console-only system log while repeating the MKCOL against the + // existing collection. Errors from x/net/webdav are routed through + // event.SystemLog (never the browser log.* stream), so we hook it here. + hook := &logCapture{} + event.SystemLog.ReplaceHooks(logrus.LevelHooks{}) + event.SystemLog.AddHook(hook) + defer event.SystemLog.ReplaceHooks(logrus.LevelHooks{}) + + w = httptest.NewRecorder() + req = httptest.NewRequest(header.MethodMkcol, conf.BaseUri(WebDAVOriginals)+"/exists", nil) + authBearer(req) + r.ServeHTTP(w, req) + // Probing an existing collection is a client-side no-op; x/net/webdav returns 405. + assert.Equal(t, http.StatusMethodNotAllowed, w.Code) + + // The benign probe must not be logged as an error, and must not leak the server path. + var found bool + for _, e := range hook.entries { + if e.Level == logrus.DebugLevel && assert.Contains(t, e.Message, "already exists") { + found = true + assert.NotContains(t, e.Message, conf.OriginalsPath()) + } + assert.NotEqual(t, logrus.ErrorLevel, e.Level, "MKCOL on existing collection must not log an error") + } + assert.True(t, found, "expected a debug entry for the existing collection") +} + +func TestWebDAVWrite_PUT_OriginalsLimit(t *testing.T) { + conf := newWebDAVTestConfig(t) + conf.Options().OriginalsLimit = 1 // cap uploaded files at 1 MB + if err := conf.CreateDirectories(); err != nil { + t.Fatalf("failed to create test directories: %v", err) + } + r := setupWebDAVRouter(conf) + + t.Run("UnderLimitAccepted", func(t *testing.T) { + w := httptest.NewRecorder() + req := httptest.NewRequest(header.MethodPut, conf.BaseUri(WebDAVOriginals)+"/small.bin", bytes.NewReader(make([]byte, 512*1024))) + authBearer(req) + r.ServeHTTP(w, req) + assert.InDelta(t, 201, w.Code, 1) + }) + t.Run("OverLimitRejected", func(t *testing.T) { + w := httptest.NewRecorder() + req := httptest.NewRequest(header.MethodPut, conf.BaseUri(WebDAVOriginals)+"/big.bin", bytes.NewReader(make([]byte, 2*1024*1024))) + authBearer(req) + r.ServeHTTP(w, req) + // The oversized PUT must not be accepted, and the bytes written to disk must not + // exceed the configured originals limit (the body cap stops io.Copy mid-stream). + assert.NotEqual(t, http.StatusCreated, w.Code) + path := filepath.Join(conf.OriginalsPath(), "big.bin") + // #nosec G304 -- test reads file created under controlled temp directory. + if info, err := os.Stat(path); err == nil { + assert.LessOrEqual(t, info.Size(), conf.OriginalsLimitBytes()) + } + }) +} + func TestWebDAV_NoTrailingSlashRedirectOnBasePath(t *testing.T) { testCases := []struct { name string diff --git a/internal/server/wellknown/openid.go b/internal/server/wellknown/openid.go index c036c65eb..1c1f7b94d 100644 --- a/internal/server/wellknown/openid.go +++ b/internal/server/wellknown/openid.go @@ -38,11 +38,10 @@ type OpenIDConfiguration struct { // NewOpenIDConfiguration creates a service discovery endpoint response based on the config provided. func NewOpenIDConfiguration(conf *config.Config) *OpenIDConfiguration { - jwksPath := conf.BaseUri("/.well-known/jwks.json") - if jwksPath == "" { - jwksPath = "/.well-known/jwks.json" - } - jwksURL := strings.TrimRight(conf.SiteUrl(), "/") + jwksPath + // SiteUrl already carries any deployment base path, so append the bare + // well-known path (mirrors the endpoint construction below). Using + // conf.BaseUri here would double the base path for sub-path deployments. + jwksURL := strings.TrimRight(conf.SiteUrl(), "/") + "/.well-known/jwks.json" return &OpenIDConfiguration{ Issuer: conf.SiteUrl(), diff --git a/internal/server/wellknown/openid_portal.go b/internal/server/wellknown/openid_portal.go new file mode 100644 index 000000000..7fd50106d --- /dev/null +++ b/internal/server/wellknown/openid_portal.go @@ -0,0 +1,56 @@ +package wellknown + +import ( + "strings" + + "github.com/photoprism/photoprism/internal/config" +) + +// Portal OIDC OP metadata, distinct from the generic OAuth2 metadata above. +// These values are dictated by the Portal OIDC spec: ID tokens are signed +// with EdDSA, only the authorization-code flow is supported, PKCE S256 is +// required, and the OIDC standard scope vocabulary applies. +var ( + PortalOIDCResponseTypes = []string{"code"} + PortalOIDCGrantTypes = []string{"authorization_code"} + PortalOIDCSubjectTypes = []string{"public"} + PortalOIDCIDTokenSigningAlgs = []string{"EdDSA"} + PortalOIDCScopes = []string{"openid", "profile", "email", "cluster", "groups"} + PortalOIDCCodeChallengeMethods = []string{"S256"} + PortalOIDCTokenEndpointAuthMethods = []string{"client_secret_basic", "client_secret_post"} +) + +// NewPortalOpenIDConfiguration builds the discovery JSON for the Portal's +// OIDC OP. The returned shape advertises the endpoints, signing algorithm, +// and scope vocabulary documented in specs/portal/cluster-oidc.md; instances +// consume it through their existing OIDC RP code. +func NewPortalOpenIDConfiguration(conf *config.Config) *OpenIDConfiguration { + issuer := strings.TrimRight(conf.PortalOIDCIssuer(), "/") + + return &OpenIDConfiguration{ + Issuer: issuer + "/", + // The OP authorize/token/userinfo endpoints live under the APIv1 path, and + // the JWKS under /.well-known. The bare paths are correct here (not + // conf.ApiUri() / conf.BaseUri(...)): the issuer already carries any + // deployment base path, so prefixing with the already-base-pathed accessor + // would double it for sub-path deployments. + AuthorizationEndpoint: issuer + config.ApiUri + "/oauth/authorize", + TokenEndpoint: issuer + config.ApiUri + "/oauth/token", + UserinfoEndpoint: issuer + config.ApiUri + "/oauth/userinfo", + EndSessionEndpoint: issuer + config.ApiUri + "/oauth/logout", + JwksUri: issuer + "/.well-known/jwks.json", + ResponseTypesSupported: PortalOIDCResponseTypes, + GrantTypesSupported: PortalOIDCGrantTypes, + SubjectTypesSupported: PortalOIDCSubjectTypes, + IdTokenSigningAlgValuesSupported: PortalOIDCIDTokenSigningAlgs, + ScopesSupported: PortalOIDCScopes, + TokenEndpointAuthMethodsSupported: PortalOIDCTokenEndpointAuthMethods, + CodeChallengeMethodsSupported: PortalOIDCCodeChallengeMethods, + ResponseModesSupported: []string{}, + ClaimsSupported: []string{}, + IntrospectionEndpointAuthMethodsSupported: []string{}, + RevocationEndpointAuthMethodsSupported: []string{}, + RequestObjectSigningAlgValuesSupported: []string{}, + DpopSigningAlgValuesSupported: []string{}, + } +} diff --git a/internal/server/wellknown/openid_portal_test.go b/internal/server/wellknown/openid_portal_test.go new file mode 100644 index 000000000..685ea419b --- /dev/null +++ b/internal/server/wellknown/openid_portal_test.go @@ -0,0 +1,69 @@ +package wellknown + +import ( + "strings" + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/internal/config" +) + +func TestPortalOpenIDConfiguration(t *testing.T) { + conf := config.TestConfig() + + t.Run("Shape", func(t *testing.T) { + result := NewPortalOpenIDConfiguration(conf) + require.IsType(t, &OpenIDConfiguration{}, result) + + // The OP authorize/token/userinfo endpoints live under the APIv1 path. + assert.Equal(t, "http://localhost:2342/", result.Issuer) + assert.Equal(t, "http://localhost:2342/api/v1/oauth/authorize", result.AuthorizationEndpoint) + assert.Equal(t, "http://localhost:2342/api/v1/oauth/token", result.TokenEndpoint) + assert.Equal(t, "http://localhost:2342/api/v1/oauth/userinfo", result.UserinfoEndpoint) + assert.Equal(t, "http://localhost:2342/api/v1/oauth/logout", result.EndSessionEndpoint) + assert.Equal(t, "http://localhost:2342/.well-known/jwks.json", result.JwksUri) + }) + t.Run("Capabilities", func(t *testing.T) { + result := NewPortalOpenIDConfiguration(conf) + + // All capability lists must match the values published in the spec — + // instances key off the exact strings to know what to send. + assert.Equal(t, []string{"code"}, result.ResponseTypesSupported) + assert.Equal(t, []string{"authorization_code"}, result.GrantTypesSupported) + assert.Equal(t, []string{"public"}, result.SubjectTypesSupported) + assert.Equal(t, []string{"EdDSA"}, result.IdTokenSigningAlgValuesSupported) + assert.Equal(t, []string{"openid", "profile", "email", "cluster", "groups"}, result.ScopesSupported) + assert.Equal(t, []string{"S256"}, result.CodeChallengeMethodsSupported) + assert.Equal(t, []string{"client_secret_basic", "client_secret_post"}, result.TokenEndpointAuthMethodsSupported) + }) + t.Run("BasePathDeployment", func(t *testing.T) { + // For a sub-path Portal (SiteUrl carries a base path), every advertised + // URL must contain the base path exactly once — the issuer already carries + // it, so the appended paths must be bare. Guards against the JwksUri + // base-path doubling regression. + c := config.NewConfig(config.CliTestContext()) + c.Options().SiteUrl = "http://foo:2342/foo/" + result := NewPortalOpenIDConfiguration(c) + + for _, u := range []string{result.Issuer, result.AuthorizationEndpoint, result.TokenEndpoint, result.UserinfoEndpoint, result.EndSessionEndpoint, result.JwksUri} { + assert.Equal(t, 1, strings.Count(u, "/foo/"), "base path must appear exactly once in %s", u) + assert.NotContains(t, u, "/foo/foo/", "base path must not be doubled in %s", u) + } + assert.Equal(t, "http://foo:2342/foo/api/v1/oauth/authorize", result.AuthorizationEndpoint) + assert.Equal(t, "http://foo:2342/foo/api/v1/oauth/token", result.TokenEndpoint) + assert.Equal(t, "http://foo:2342/foo/api/v1/oauth/userinfo", result.UserinfoEndpoint) + assert.Equal(t, "http://foo:2342/foo/api/v1/oauth/logout", result.EndSessionEndpoint) + assert.Equal(t, "http://foo:2342/foo/.well-known/jwks.json", result.JwksUri) + }) + t.Run("IssuerWithTrailingSlashIsNormalized", func(t *testing.T) { + // The Portal-issuer accessor falls through to SiteUrl which already + // includes a trailing slash; the generator must not double it. + result := NewPortalOpenIDConfiguration(conf) + assert.Equal(t, "http://localhost:2342/", result.Issuer, "issuer must end with exactly one slash") + assert.NotContains(t, result.AuthorizationEndpoint, "//api") + assert.NotContains(t, result.TokenEndpoint, "//api") + assert.NotContains(t, result.UserinfoEndpoint, "//api") + }) +} diff --git a/internal/server/wellknown/openid_test.go b/internal/server/wellknown/openid_test.go index 334bcec18..57fec8ce7 100644 --- a/internal/server/wellknown/openid_test.go +++ b/internal/server/wellknown/openid_test.go @@ -1,6 +1,7 @@ package wellknown import ( + "strings" "testing" "github.com/stretchr/testify/assert" @@ -20,4 +21,18 @@ func TestOpenIDConfiguration(t *testing.T) { assert.Equal(t, OAuthResponseTypes, result.ResponseTypesSupported) assert.Equal(t, OAuthRevocationEndpointAuthMethods, result.RevocationEndpointAuthMethodsSupported) }) + t.Run("BasePathDeployment", func(t *testing.T) { + // For a sub-path deployment, every advertised URL must contain the base + // path exactly once. Guards against the JwksUri base-path doubling. + c := config.NewConfig(config.CliTestContext()) + c.Options().SiteUrl = "http://foo:2342/foo/" + result := NewOpenIDConfiguration(c) + + for _, u := range []string{result.Issuer, result.AuthorizationEndpoint, result.TokenEndpoint, result.UserinfoEndpoint, result.RevocationEndpoint, result.JwksUri} { + assert.Equal(t, 1, strings.Count(u, "/foo/"), "base path must appear exactly once in %s", u) + assert.NotContains(t, u, "/foo/foo/", "base path must not be doubled in %s", u) + } + assert.Equal(t, "http://foo:2342/foo/api/v1/oauth/token", result.TokenEndpoint) + assert.Equal(t, "http://foo:2342/foo/.well-known/jwks.json", result.JwksUri) + }) } diff --git a/internal/server/wellknown/wellknown.go b/internal/server/wellknown/wellknown.go index 8060facc2..425738e2a 100644 --- a/internal/server/wellknown/wellknown.go +++ b/internal/server/wellknown/wellknown.go @@ -1,7 +1,7 @@ /* Package wellknown provides data types and abstractions for service discovery endpoints. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/server/wellknown/wellknown_test.go b/internal/server/wellknown/wellknown_test.go index 69a9277e0..62d296814 100644 --- a/internal/server/wellknown/wellknown_test.go +++ b/internal/server/wellknown/wellknown_test.go @@ -4,18 +4,27 @@ import ( "os" "testing" + "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/pkg/fs" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) (code int) { // Remove temporary SQLite files before running the tests. fs.PurgeTestDbFiles(".", false) + c := config.TestConfig() + defer c.CleanupTestFolder() + defer func() { + c.CloseDb() + // Remove temporary SQLite files after running the tests. + fs.PurgeTestDbFiles(".", false) + }() + // Run unit tests. - code := m.Run() - - // Remove temporary SQLite files after running the tests. - fs.PurgeTestDbFiles(".", false) - - os.Exit(code) + return m.Run() } diff --git a/internal/server/zstd_test.go b/internal/server/zstd_test.go new file mode 100644 index 000000000..35cfc9f68 --- /dev/null +++ b/internal/server/zstd_test.go @@ -0,0 +1,443 @@ +package server + +import ( + "io" + "net/http" + "net/http/httptest" + "os" + "path/filepath" + "strings" + "testing" + + "github.com/gin-gonic/gin" + "github.com/klauspost/compress/zstd" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/internal/config" +) + +// newCompressTestRouter builds a router with the configured compression +// preferences applied via NewCompressMiddleware. The optional handler is +// registered at /ok for round-trip assertions; additional routes that share +// the standard handler can be registered by the caller. +func newCompressTestRouter(t *testing.T, prefs string) (*gin.Engine, *config.Config) { + t.Helper() + + gin.SetMode(gin.TestMode) + conf := config.TestConfig() + conf.Options().HttpCompression = prefs + + r := gin.New() + r.Use(NewCompressMiddleware(conf)) + r.GET("/ok", func(c *gin.Context) { + c.String(http.StatusOK, "hello world") + }) + return r, conf +} + +func TestNewCompressMiddleware_Zstd(t *testing.T) { + r, conf := newCompressTestRouter(t, "zstd") + + excludedPath := conf.BaseUri(config.ApiUri + "/dl/test") + r.GET(excludedPath, func(c *gin.Context) { + c.String(http.StatusOK, "download") + }) + + doRequest := func(path, accept string) *httptest.ResponseRecorder { + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, path, nil) + if accept != "" { + req.Header.Set("Accept-Encoding", accept) + } + r.ServeHTTP(w, req) + return w + } + + t.Run("EncodesAndRoundTrips", func(t *testing.T) { + w := doRequest("/ok", "zstd") + require.Equal(t, http.StatusOK, w.Code) + assert.Equal(t, "zstd", w.Header().Get("Content-Encoding")) + assert.Contains(t, w.Header().Get("Vary"), "Accept-Encoding") + + zr, err := zstd.NewReader(strings.NewReader(w.Body.String())) + require.NoError(t, err) + defer zr.Close() + decoded, err := io.ReadAll(zr) + require.NoError(t, err) + assert.Equal(t, "hello world", string(decoded)) + }) + + t.Run("ClientWithoutZstdGetsIdentityWithVary", func(t *testing.T) { + w := doRequest("/ok", "gzip") + require.Equal(t, http.StatusOK, w.Code) + assert.Empty(t, w.Header().Get("Content-Encoding")) + assert.Contains(t, w.Header().Get("Vary"), "Accept-Encoding") + assert.Equal(t, "hello world", w.Body.String()) + }) + + t.Run("MissingAcceptEncodingFallsThrough", func(t *testing.T) { + w := doRequest("/ok", "") + require.Equal(t, http.StatusOK, w.Code) + assert.Empty(t, w.Header().Get("Content-Encoding")) + assert.Contains(t, w.Header().Get("Vary"), "Accept-Encoding") + assert.Equal(t, "hello world", w.Body.String()) + }) + + t.Run("ExcludedPathIsNeverCompressed", func(t *testing.T) { + w := doRequest(excludedPath, "zstd") + require.Equal(t, http.StatusOK, w.Code) + assert.Empty(t, w.Header().Get("Content-Encoding")) + assert.Empty(t, w.Header().Get("Vary")) + assert.Equal(t, "download", w.Body.String()) + }) + + t.Run("ConnectionUpgradeBypassesCompression", func(t *testing.T) { + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/ok", nil) + req.Header.Set("Accept-Encoding", "zstd") + req.Header.Set("Connection", "Upgrade") + req.Header.Set("Upgrade", "websocket") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Empty(t, w.Header().Get("Content-Encoding")) + assert.Empty(t, w.Header().Get("Vary")) + }) +} + +func TestNewCompressMiddleware_PrefersZstdOverGzip(t *testing.T) { + r, _ := newCompressTestRouter(t, "zstd,gzip") + + t.Run("BothAcceptedZstdWins", func(t *testing.T) { + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/ok", nil) + req.Header.Set("Accept-Encoding", "gzip, zstd") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Equal(t, "zstd", w.Header().Get("Content-Encoding")) + assert.Contains(t, w.Header().Get("Vary"), "Accept-Encoding") + }) + + t.Run("OnlyGzipAcceptedFallsBack", func(t *testing.T) { + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/ok", nil) + req.Header.Set("Accept-Encoding", "gzip") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Equal(t, "gzip", w.Header().Get("Content-Encoding")) + }) + + t.Run("UnknownEncodingYieldsIdentityWithVary", func(t *testing.T) { + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/ok", nil) + req.Header.Set("Accept-Encoding", "br") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Empty(t, w.Header().Get("Content-Encoding")) + assert.Contains(t, w.Header().Get("Vary"), "Accept-Encoding") + assert.Equal(t, "hello world", w.Body.String()) + }) +} + +func TestNewCompressMiddleware_BypassesPartialContent(t *testing.T) { + // 206 Partial Content responses serve a slice of the identity + // representation. Compressing them would scramble the byte offsets the + // client asked for and contradict the Content-Range header. The bundled + // `/static/*` route is now served by PrecompressedStatic and excluded + // from the runtime middleware, so this test uses a non-excluded path + // to verify the middleware-side 206 bypass for any future compressible + // route that may produce a 206 (e.g. routes_webapp.go). + for _, prefs := range []string{"gzip", "zstd"} { + t.Run("Prefs="+prefs, func(t *testing.T) { + gin.SetMode(gin.TestMode) + conf := config.TestConfig() + conf.Options().HttpCompression = prefs + + r := gin.New() + r.Use(NewCompressMiddleware(conf)) + // Mimic what http.ServeContent does for a Range request: set + // Content-Range, status 206, and write only the requested slice. + r.GET("/bundle/app.js", func(c *gin.Context) { + c.Header("Content-Range", "bytes 0-9/100") + c.Header("Accept-Ranges", "bytes") + c.Data(http.StatusPartialContent, "application/javascript", []byte("0123456789")) + }) + + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/bundle/app.js", nil) + req.Header.Set("Range", "bytes=0-9") + req.Header.Set("Accept-Encoding", prefs) + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusPartialContent, w.Code) + assert.Empty(t, w.Header().Get("Content-Encoding"), + "206 must not carry Content-Encoding — the slice corresponds to identity bytes") + assert.Equal(t, "bytes 0-9/100", w.Header().Get("Content-Range")) + assert.Equal(t, "0123456789", w.Body.String(), + "206 body must be the raw slice the handler wrote, not encoded bytes") + assert.Contains(t, w.Header().Get("Vary"), "Accept-Encoding", + "Vary still belongs on the response so caches don't reuse the slice for a non-Range request") + }) + } +} + +func TestNewCompressMiddleware_BypassesPartialContentViaGinStatic(t *testing.T) { + // End-to-end check that the bypass also works when 206 is produced by + // gin.Static (i.e. http.ServeFile / http.ServeContent), not just by a + // hand-crafted handler. The bundled `/static/*` and `/c/static/*` routes + // are now served by PrecompressedStatic and excluded from the runtime + // middleware via NewShouldCompressFn, so this test uses a route that is + // still in the runtime middleware's scope to exercise the same code + // path on any future compressible static-file route. + for _, prefs := range []string{"gzip", "zstd"} { + t.Run("Prefs="+prefs, func(t *testing.T) { + gin.SetMode(gin.TestMode) + conf := config.TestConfig() + conf.Options().HttpCompression = prefs + + // Write a real file with deterministic content so we can assert + // the byte slice that comes back through the wire. + dir := t.TempDir() + path := filepath.Join(dir, "app.js") + alphabet := "0123456789abcdefghijklmnopqrstuvwxyz" // 36 bytes + content := []byte(strings.Repeat(alphabet, 3))[:100] + require.Len(t, content, 100) + require.NoError(t, os.WriteFile(path, content, 0o600)) + + r := gin.New() + r.Use(NewCompressMiddleware(conf)) + // Use a route that is not on the predicate's exclusion list so + // the middleware's 206 bypass — not the static-route exclusion — + // is what we're verifying here. + r.Static("/bundle", dir) + + t.Run("RangeRequestReturns206RawBytes", func(t *testing.T) { + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/bundle/app.js", nil) + req.Header.Set("Range", "bytes=10-19") + req.Header.Set("Accept-Encoding", prefs) + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusPartialContent, w.Code, + "http.ServeContent should produce 206 for a satisfiable Range request") + assert.Empty(t, w.Header().Get("Content-Encoding"), + "206 from gin.Static must not be re-encoded by the compression middleware") + assert.Equal(t, "bytes 10-19/100", w.Header().Get("Content-Range")) + assert.Equal(t, "abcdefghij", w.Body.String(), + "206 body must be the raw byte slice that http.ServeContent wrote, not encoded") + assert.Contains(t, w.Header().Get("Vary"), "Accept-Encoding", + "Vary still belongs on the response so caches don't reuse the slice for non-Range requests") + }) + + t.Run("FullRequestStillCompresses", func(t *testing.T) { + // Sanity check: a non-Range GET on the same route still + // goes through the encoder, so we know the bypass is targeted + // at 206 rather than blanket-disabling compression for the path. + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/bundle/app.js", nil) + req.Header.Set("Accept-Encoding", prefs) + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Equal(t, prefs, w.Header().Get("Content-Encoding"), + "non-Range GET on a compressible static asset should still be encoded") + }) + }) + } +} + +func TestNewCompressMiddleware_BypassesErrorResponses(t *testing.T) { + // Both encoders should bypass for 4xx/5xx and bodyless statuses so the + // server doesn't burn CPU compressing tiny error payloads (e.g. 429 during + // a rate-limit storm) and so the encoder doesn't emit a stray frame + // trailer when the handler writes no body (e.g. 204). + for _, prefs := range []string{"gzip", "zstd"} { + t.Run("Prefs="+prefs, func(t *testing.T) { + gin.SetMode(gin.TestMode) + conf := config.TestConfig() + conf.Options().HttpCompression = prefs + r := gin.New() + r.Use(NewCompressMiddleware(conf)) + r.GET("/rate-limited", func(c *gin.Context) { + c.String(http.StatusTooManyRequests, `{"error":"too many requests"}`) + }) + r.GET("/server-error", func(c *gin.Context) { + c.String(http.StatusServiceUnavailable, `{"error":"unavailable"}`) + }) + r.GET("/no-content", func(c *gin.Context) { + c.Status(http.StatusNoContent) + }) + r.GET("/not-modified", func(c *gin.Context) { + c.Status(http.StatusNotModified) + }) + + cases := []struct { + name string + path string + code int + body string + }{ + {"429RateLimited", "/rate-limited", http.StatusTooManyRequests, `{"error":"too many requests"}`}, + {"503ServiceUnavailable", "/server-error", http.StatusServiceUnavailable, `{"error":"unavailable"}`}, + {"204NoContent", "/no-content", http.StatusNoContent, ""}, + {"304NotModified", "/not-modified", http.StatusNotModified, ""}, + } + + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, tc.path, nil) + req.Header.Set("Accept-Encoding", prefs) + r.ServeHTTP(w, req) + + require.Equal(t, tc.code, w.Code) + assert.Empty(t, w.Header().Get("Content-Encoding"), + "%s response must not advertise Content-Encoding", tc.name) + assert.Contains(t, w.Header().Get("Vary"), "Accept-Encoding", + "%s response should still carry Vary so caches stay correct", tc.name) + assert.Equal(t, tc.body, w.Body.String(), + "%s body must match the handler's raw bytes", tc.name) + }) + } + }) + } +} + +func TestNewCompressMiddleware_HeadRequests(t *testing.T) { + // HEAD requests carry no body — Go's net/http discards body writes for + // HEAD on the wire — so the encoder must be skipped to save pool slots + // and CPU. But Vary: Accept-Encoding must still be set when the + // corresponding GET would be content-coding negotiated, so caches don't + // reuse the response for clients that asked for a different encoding + // (RFC 9110 §15.4.5: HEAD may legitimately omit content-determined + // fields like Content-Length, but Vary still belongs on the response). + for _, prefs := range []string{"gzip", "zstd", "zstd,gzip"} { + t.Run("Prefs="+strings.ReplaceAll(prefs, ",", "_"), func(t *testing.T) { + gin.SetMode(gin.TestMode) + conf := config.TestConfig() + conf.Options().HttpCompression = prefs + r := gin.New() + r.Use(NewCompressMiddleware(conf)) + r.Any("/ok", func(c *gin.Context) { + c.String(http.StatusOK, "hello world") + }) + r.Any(conf.BaseUri(config.ApiUri+"/dl/test"), func(c *gin.Context) { + c.String(http.StatusOK, "download") + }) + + t.Run("CompressiblePathSetsVaryButSkipsEncoder", func(t *testing.T) { + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodHead, "/ok", nil) + req.Header.Set("Accept-Encoding", "zstd, gzip") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Empty(t, w.Header().Get("Content-Encoding"), + "HEAD response must not advertise Content-Encoding (encoder is skipped)") + assert.Contains(t, w.Header().Get("Vary"), "Accept-Encoding", + "HEAD must still set Vary so caches know the GET varies by Accept-Encoding") + }) + + t.Run("ExcludedPathSetsNoVary", func(t *testing.T) { + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodHead, conf.BaseUri(config.ApiUri+"/dl/test"), nil) + req.Header.Set("Accept-Encoding", "zstd, gzip") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Empty(t, w.Header().Get("Content-Encoding")) + assert.Empty(t, w.Header().Get("Vary"), + "HEAD on a predicate-excluded path does not vary by Accept-Encoding") + }) + }) + } +} + +func TestNewCompressMiddleware_WeakensETagOnEncodedResponses(t *testing.T) { + // When the response is compressed, strong ETags must be rewritten to + // W/<value> so caches don't reuse a compressed body for a client that + // asked for a different content-coding (RFC 9110 §13.2.4). Weak ETags + // and missing ETags must be left untouched. Bypassed responses + // (4xx/5xx/204/304) keep their original ETag because the wire bytes + // match the strong validator. + cases := []struct { + name string + prefs string + accept string + status int + etagIn string + etagOut string + encoding string + }{ + {"GzipWeakensStrongETag", "gzip", "gzip", http.StatusOK, `"abc123"`, `W/"abc123"`, "gzip"}, + {"ZstdWeakensStrongETag", "zstd", "zstd", http.StatusOK, `"abc123"`, `W/"abc123"`, "zstd"}, + {"PreservesAlreadyWeakETag", "gzip", "gzip", http.StatusOK, `W/"abc123"`, `W/"abc123"`, "gzip"}, + {"DoesNothingWhenNoETag", "gzip", "gzip", http.StatusOK, "", "", "gzip"}, + {"PreservesETagOnBypass4xx", "gzip", "gzip", http.StatusBadRequest, `"abc123"`, `"abc123"`, ""}, + {"PreservesETagOnBypass5xx", "zstd", "zstd", http.StatusInternalServerError, `"abc123"`, `"abc123"`, ""}, + {"DoesNothingWhenIdentityNegotiated", "zstd", "br", http.StatusOK, `"abc123"`, `"abc123"`, ""}, + } + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + gin.SetMode(gin.TestMode) + conf := config.TestConfig() + conf.Options().HttpCompression = tc.prefs + r := gin.New() + r.Use(NewCompressMiddleware(conf)) + r.GET("/ok", func(c *gin.Context) { + if tc.etagIn != "" { + c.Header("ETag", tc.etagIn) + } + c.String(tc.status, "payload") + }) + + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/ok", nil) + req.Header.Set("Accept-Encoding", tc.accept) + r.ServeHTTP(w, req) + + require.Equal(t, tc.status, w.Code) + assert.Equal(t, tc.etagOut, w.Header().Get("ETag"), + "ETag header should match expected value after middleware processing") + assert.Equal(t, tc.encoding, w.Header().Get("Content-Encoding"), + "Content-Encoding should match expected encoding") + }) + } +} + +func TestNewCompressMiddleware_NoOpWhenDisabled(t *testing.T) { + t.Run("NilConfig", func(t *testing.T) { + gin.SetMode(gin.TestMode) + r := gin.New() + r.Use(NewCompressMiddleware(nil)) + r.GET("/ok", func(c *gin.Context) { c.String(http.StatusOK, "hi") }) + + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/ok", nil) + req.Header.Set("Accept-Encoding", "gzip") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Empty(t, w.Header().Get("Content-Encoding")) + assert.Empty(t, w.Header().Get("Vary")) + assert.Equal(t, "hi", w.Body.String()) + }) + + t.Run("NoneDisablesCompression", func(t *testing.T) { + r, _ := newCompressTestRouter(t, "none") + + w := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/ok", nil) + req.Header.Set("Accept-Encoding", "gzip, zstd") + r.ServeHTTP(w, req) + + require.Equal(t, http.StatusOK, w.Code) + assert.Empty(t, w.Header().Get("Content-Encoding")) + assert.Empty(t, w.Header().Get("Vary")) + assert.Equal(t, "hello world", w.Body.String()) + }) +} diff --git a/internal/service/cidr.go b/internal/service/cidr.go index 3a2bfdc09..6fcc73d0b 100644 --- a/internal/service/cidr.go +++ b/internal/service/cidr.go @@ -21,7 +21,7 @@ func ParseCIDRs(raw string) (result []*net.IPNet, err error) { return result, nil } - for _, token := range strings.Split(raw, ",") { + for token := range strings.SplitSeq(raw, ",") { token = strings.TrimSpace(token) if token == "" { diff --git a/internal/service/cluster/AGENTS.md b/internal/service/cluster/AGENTS.md new file mode 100644 index 000000000..f4f5bfd95 --- /dev/null +++ b/internal/service/cluster/AGENTS.md @@ -0,0 +1,45 @@ +# Cluster Guidelines + +**Last Updated:** April 9, 2026 + +## Bootstrap & Registration + +- Keep bootstrap code decoupled: do not import `internal/service/cluster/node/*` from `internal/config` or the cluster root; nodes talk to the Portal over HTTP(S) and use `internal/service/cluster/const.go`. +- On `401` or `403`, bootstrap refreshes node OAuth credentials by rotating the secret and retrying; log that at info level. If the secret file cannot be written, keep the rotated value in memory. +- Portal validation may accept HTTP advertise URLs only for loopback or cluster-internal domains such as `*.svc`, `*.cluster.local`, and `*.internal`; all other advertise URLs must use HTTPS. +- Registration flow: send `rotate=true` only for MySQL or MariaDB nodes without credentials, treat `401`, `403`, and `404` as terminal, include `ClientID` plus `ClientSecret` when renaming an existing node, and persist only newly generated secrets or DB settings. +- Config init order for cluster-aware startup is: load `options.yml` with `c.initSettings()`, run `EarlyExt().InitEarly(c)`, connect or register the DB, then invoke `Ext().Init(c)`. + +## Registry, DTOs & Provisioning + +- Use `NewClientRegistryWithConfig`; the file-backed registry is legacy. +- Nodes are keyed by UUID v7 at `/api/v1/cluster/nodes/{uuid}`. Keep the registry interface UUID-first: `Get`, `FindByNodeUUID`, `FindByClientID`, `RotateSecret`, and `DeleteAllByUUID`. +- CLI lookups should resolve `uuid -> ClientID -> name`. +- DTOs normalize `Database.{Name,User,Driver,RotatedAt}` and expose `ClientSecret` only during creation or rotation. +- `nodes rm --all-ids` must clean duplicate client rows. +- Registry files live under `conf.PortalConfigPath()/nodes/` with mode `0600`, and `ClientData` no longer stores `NodeUUID`. +- Database and user names use UUID-based HMACs in `<prefix>d<hmac11>` and `<prefix>u<hmac11>` form; the prefix defaults to `cluster_` and may be overridden only by the portal-only `database-provision-prefix` flag. +- `BuildDSN` accepts a `driver` but falls back to MySQL format with a warning when the driver is unsupported. +- If Postgres provisioning is added, extend both `BuildDSN` and `provisioner.DatabaseDriver`, add validations, and return `driver=postgres` consistently in API and CLI output. + +## Cluster API & Theme Changes + +- When renaming or adding cluster response fields, update DTOs in `internal/service/cluster/response.go`, handlers, Swagger, tests, specs, and grep for old and new field names. +- The theme endpoint `GET /api/v1/cluster/theme` streams a zip from `conf.ThemePath()`. Reinstall only when `app.js` is missing and use the shared helpers in `pkg/http/header`. +- Admin responses may include `AdvertiseUrl` and `Database`; client and user sessions must remain redacted. + +## Cluster Tests + +- Generate OAuth client IDs with `rnd.GenerateUID(entity.ClientUID)` and node UUIDs with `rnd.UUIDv7()`; treat `node.uuid` as required in responses. +- Cluster registry tests under `internal/service/cluster/registry` intentionally use a full `config.TestConfig()` because they persist `entity.Client` rows. Do not switch them to minimal config helpers unless the tests stop touching the database. +- Exercise Portal endpoints with `httptest`, guard extraction paths with `pkg/fs.Unzip` size caps, and confirm admin-only fields disappear for client or user sessions. +- Portal proxy URI validation must use the Portal test environment with `NODES=2` and verify both instance routes when changing `PHOTOPRISM_PORTAL_PROXY_URI` or matching node `PHOTOPRISM_SITE_URL` prefixes; use `PORTAL_TEST_ENV_ARGS=--proxy-uri=/instance/` to regenerate consistent `.env` values. +- Before `make -C portal test-start`, run a full rebuild with `make -C portal test-env NODES=2`; avoid `--no-build` refreshes unless you are intentionally validating env-only changes. + +## Cluster Preflight + +- `go build ./...` +- `make fmt-go swag-fmt swag` +- `go test ./internal/service/cluster/registry -count=1` +- `go test ./internal/api -run 'Cluster' -count=1` +- `go test ./internal/commands -run 'ClusterRegister|ClusterNodesRotate' -count=1` diff --git a/internal/service/cluster/cluster.go b/internal/service/cluster/cluster.go index 13b97c779..8d9ea0868 100644 --- a/internal/service/cluster/cluster.go +++ b/internal/service/cluster/cluster.go @@ -1,7 +1,7 @@ /* Package cluster provides multi-instance deployment and orchestration functionality. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/service/cluster/node/bootstrap.go b/internal/service/cluster/node/bootstrap.go index 382385283..2b43f261b 100644 --- a/internal/service/cluster/node/bootstrap.go +++ b/internal/service/cluster/node/bootstrap.go @@ -23,6 +23,7 @@ import ( "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" "github.com/photoprism/photoprism/pkg/http/dns" + "github.com/photoprism/photoprism/pkg/http/scheme" "github.com/photoprism/photoprism/pkg/rnd" ) @@ -40,10 +41,6 @@ func init() { // InitConfig performs node bootstrap: optional registration with the Portal // and theme installation. Runs early during config.Init(). func InitConfig(c *config.Config) error { - if !cluster.BootstrapAutoJoinEnabled && !cluster.BootstrapAutoThemeEnabled { - return nil - } - role := c.NodeRole() // Skip on portal nodes and unknown node types. @@ -52,12 +49,40 @@ func InitConfig(c *config.Config) error { return nil } + // Auto-join the cluster and sync the theme when enabled and configured. + if cluster.BootstrapAutoJoinEnabled || cluster.BootstrapAutoThemeEnabled { + bootstrapClusterNode(c) + } + + // Derive the OIDC RP credentials from the node client (PHOTOPRISM_CLUSTER_OIDC), + // independent of the auto-join/theme toggles, so a registered instance re-wires + // the OIDC RP on every restart. + resolveNodeOIDCClient(c) + + // Log cluster UUID. + if uuid := c.ClusterUUID(); uuid != "" { + log.Infof("cluster: UUID %s", clean.Log(uuid)) + } + + return nil +} + +// bootstrapClusterNode registers the node with the configured Portal and installs +// its theme, honoring the auto-join/theme toggles. All failures are non-fatal so +// the node still boots; it is a no-op when no Portal URL or join token is set. +func bootstrapClusterNode(c *config.Config) { portalURL := strings.TrimSpace(c.PortalUrl()) joinToken := strings.TrimSpace(c.JoinToken()) - if portalURL == "" || joinToken == "" { + // Proceed with either a join token (first join) or the node's own OAuth + // credentials (already joined). The credential-only case lets a plain restart + // re-send the idempotent registration so a changed declarative config reaches + // the Portal after the join token has been removed from the environment. + hasNodeCreds := strings.TrimSpace(c.NodeClientID()) != "" && strings.TrimSpace(c.NodeClientSecret()) != "" + + if portalURL == "" || (joinToken == "" && !hasNodeCreds) { log.Debugf("cluster: no bootstrap configuration found") - return nil + return } log.Debugf("config: attempting to join the configured cluster") @@ -65,7 +90,7 @@ func InitConfig(c *config.Config) error { u, err := url.Parse(portalURL) if err != nil || u.Scheme == "" || u.Host == "" { log.Warnf("cluster: invalid portal URL %s", clean.Log(portalURL)) - return nil + return } // Register with retry policy. @@ -84,13 +109,50 @@ func InitConfig(c *config.Config) error { } activateNodeThemeIfPresent(c) } +} - // Log cluster UUID. - if uuid := c.ClusterUUID(); uuid != "" { - log.Infof("cluster: UUID %s", clean.Log(uuid)) +// resolveNodeOIDCClient derives the instance's OIDC RP credentials from the node +// client credentials when PHOTOPRISM_CLUSTER_OIDC is enabled, so a Portal-fronted +// instance logs in on first boot without injecting PHOTOPRISM_OIDC_*. An explicit +// OIDC client id wins; the issuer defaults to the instance's own origin when unset; +// the secret is read file-first so a rotation propagates on the next start. +func resolveNodeOIDCClient(c *config.Config) { + if c == nil || !c.ClusterOIDC() { + return } - return nil + // Explicit OIDC client credentials (a different IdP, or a hand-issued client) + // win unchanged. + if strings.TrimSpace(c.OIDCClient()) != "" { + return + } + + if c.NodeRole() != cluster.RoleInstance { + log.Warnf("cluster: ignoring cluster OIDC because this node is not an instance") + return + } + + id := strings.TrimSpace(c.NodeClientID()) + secret := strings.TrimSpace(c.NodeClientSecret()) + + if id == "" || secret == "" { + log.Warnf("cluster: cannot derive the OIDC client from node credentials yet (node not registered)") + return + } + + // Default the OIDC issuer to the instance's own origin root (the shared-domain + // Portal OP) when unset, so enabling cluster OIDC is the only configuration an + // instance needs. An explicit PHOTOPRISM_OIDC_URI (e.g. a subdomain-isolated + // Portal) is respected. + if c.OIDCUri().Host == "" { + if issuer := scheme.OriginURL(c.SiteUrl()); issuer != "" { + c.SetOIDCUri(issuer) + } + } + + c.SetOIDCClient(id) + c.SetOIDCSecret(secret) + log.Infof("cluster: OIDC login configured via the Portal using node client %s", clean.Log(id)) } // newHTTPClient returns a short-lived HTTP client configured with the provided @@ -305,6 +367,14 @@ func buildRegisterPayload(c *config.Config) cluster.RegisterRequest { Theme: clean.TypeUnicode(c.NodeThemeVersion()), } + // Report a human-friendly DisplayName from the operator's configured branding via + // Config.SiteName (SITE_NAME, then the raw AppName, then SiteTitle). It is empty + // for an unbranded instance, so the Portal falls back to the node Name slug, and + // it ignores the product Name default so an unbranded Pro node does not look + // configured. SiteCaption is intentionally excluded: Plus/Pro default it to the + // shared marketing description, so it is not a per-instance label. + payload.DisplayName = c.SiteName() + // Auto-derive Advertise/Site URLs from node name and cluster domain when not configured. if domain := strings.TrimSpace(defaultClusterDomain(c)); domain != "" { if payload.NodeName == "" { @@ -327,6 +397,13 @@ func buildRegisterPayload(c *config.Config) cluster.RegisterRequest { payload.SiteUrl = su } + // Declare the instance's group-based admission config so it takes effect on + // first boot and every re-registration; an admin override on the Portal + // still wins (see the registry's group-config source precedence). + payload.AllowGroups = c.ClusterAllowGroups() + payload.AllowGroupRoles = c.ClusterAllowGroupRoles() + payload.GroupsFullView = c.ClusterGroupsFullView() + return payload } @@ -361,6 +438,15 @@ func persistRegistration(c *config.Config, r *cluster.RegisterResponse, wantRota c.SetJWKSUrl(jwksUrl) } + // Apply the validating setter first and persist only what it accepted, so + // a malformed URL from a misbehaving Portal is never written to options.yml. + if loginUrl := strings.TrimSpace(r.PortalLoginUrl); loginUrl != "" { + c.SetPortalLoginUrl(loginUrl) + if v := c.PortalLoginUrl(); v != "" { + updates.SetPortalLoginUrl(v) + } + } + // Persist NodeUUID from portal response if provided and not set locally. if r.Node.UUID != "" && c.NodeUUID() == "" { updates.SetNodeUUID(r.Node.UUID) diff --git a/internal/service/cluster/node/bootstrap_test.go b/internal/service/cluster/node/bootstrap_test.go index 37d7195a5..3eec1c27b 100644 --- a/internal/service/cluster/node/bootstrap_test.go +++ b/internal/service/cluster/node/bootstrap_test.go @@ -52,9 +52,49 @@ func TestInitConfig_ServiceRole(t *testing.T) { assert.NoError(t, InitConfig(c)) } +func TestInitConfig_ClusterOIDCWithoutBootstrap(t *testing.T) { + // A registered instance must wire its OIDC RP from the persisted node credentials + // even when both bootstrap toggles are disabled, since OIDC derivation is not a + // bootstrap-policy concern. + origJoin, origTheme := cluster.BootstrapAutoJoinEnabled, cluster.BootstrapAutoThemeEnabled + cluster.BootstrapAutoJoinEnabled = false + cluster.BootstrapAutoThemeEnabled = false + t.Cleanup(func() { + cluster.BootstrapAutoJoinEnabled = origJoin + cluster.BootstrapAutoThemeEnabled = origTheme + }) + + c := newBootstrapTestConfig(t, "init-cluster-oidc") + c.Options().NodeRole = cluster.RoleInstance + c.Options().ClusterOIDC = true + c.Options().SiteUrl = "https://app.localssl.dev/i/pro-1/" + c.Options().NodeClientID = cluster.ExampleClientID + c.Options().NodeClientSecret = cluster.ExampleClientSecret + + assert.NoError(t, InitConfig(c)) + assert.Equal(t, cluster.ExampleClientID, c.OIDCClient()) + assert.Equal(t, cluster.ExampleClientSecret, c.OIDCSecret()) + assert.Equal(t, "https://app.localssl.dev/", c.OIDCUri().String()) +} + +func TestBootstrapClusterNode(t *testing.T) { + t.Run("NoConfig", func(t *testing.T) { + c := newBootstrapTestConfig(t, "bootstrap-node-noconfig") + // No Portal URL / join token configured → no-op, no panic. + assert.NotPanics(t, func() { bootstrapClusterNode(c) }) + }) + t.Run("InvalidPortalURL", func(t *testing.T) { + c := newBootstrapTestConfig(t, "bootstrap-node-badurl") + c.Options().PortalUrl = "://nope" + c.Options().JoinToken = cluster.ExampleJoinToken + assert.NotPanics(t, func() { bootstrapClusterNode(c) }) + }) +} + func TestRegister_PersistSecretAndDB(t *testing.T) { // Fake Portal server. var jwksURL string + var portalLoginURL string expectedSite := "https://public.example.test/" var expectedAppName string var expectedAppVersion string @@ -70,11 +110,12 @@ func TestRegister_PersistSecretAndDB(t *testing.T) { w.Header().Set("Content-Type", "application/json") w.WriteHeader(http.StatusCreated) resp := cluster.RegisterResponse{ - Node: cluster.Node{Name: "pp-node-01"}, - UUID: rnd.UUID(), - ClusterCIDR: "192.0.2.0/24", - Secrets: &cluster.RegisterSecrets{ClientSecret: cluster.ExampleClientSecret}, - JWKSUrl: jwksURL, + Node: cluster.Node{Name: "pp-node-01"}, + UUID: rnd.UUID(), + ClusterCIDR: "192.0.2.0/24", + Secrets: &cluster.RegisterSecrets{ClientSecret: cluster.ExampleClientSecret}, + JWKSUrl: jwksURL, + PortalLoginUrl: portalLoginURL, Database: cluster.RegisterDatabase{ Driver: dsn.DriverMySQL, Host: "db.local", @@ -94,6 +135,7 @@ func TestRegister_PersistSecretAndDB(t *testing.T) { } })) jwksURL = srv.URL + "/.well-known/jwks.json" + portalLoginURL = srv.URL + "/portal/login" defer srv.Close() c := newBootstrapTestConfig(t, "bootstrap-reg") @@ -121,6 +163,7 @@ func TestRegister_PersistSecretAndDB(t *testing.T) { assert.Contains(t, c.Options().DatabaseDSN, "@tcp(db.local:3306)/pp_db") assert.Equal(t, dsn.DriverMySQL, c.Options().DatabaseDriver) assert.Equal(t, srv.URL+"/.well-known/jwks.json", c.JWKSUrl()) + assert.Equal(t, srv.URL+"/portal/login", c.PortalLoginUrl()) assert.Equal(t, "192.0.2.0/24", c.ClusterCIDR()) // Secret must be stored in the secret file, not written inline to options.yml. @@ -139,6 +182,67 @@ func TestRegister_PersistSecretAndDB(t *testing.T) { } } +func TestResolveNodeOIDCClient(t *testing.T) { + // portalInstance returns a config with cluster OIDC enabled, a shared-domain + // SiteUrl, and the node registered (client credentials persisted). + portalInstance := func(t *testing.T, name string) *config.Config { + c := newBootstrapTestConfig(t, name) + c.Options().NodeRole = cluster.RoleInstance + c.Options().ClusterOIDC = true + c.Options().SiteUrl = "https://app.localssl.dev/i/pro-1/" + c.Options().NodeClientID = cluster.ExampleClientID + c.Options().NodeClientSecret = cluster.ExampleClientSecret + return c + } + + t.Run("DerivesFromNodeCredentialsAndDefaultsIssuer", func(t *testing.T) { + c := portalInstance(t, "oidc-node-derive") + resolveNodeOIDCClient(c) + assert.Equal(t, cluster.ExampleClientID, c.OIDCClient()) + assert.Equal(t, cluster.ExampleClientSecret, c.OIDCSecret()) + // The issuer defaults to the instance's own origin root (the shared-domain + // Portal OP), so a single flag suffices. + assert.Equal(t, "https://app.localssl.dev/", c.OIDCUri().String()) + }) + t.Run("HonorsExplicitIssuer", func(t *testing.T) { + c := portalInstance(t, "oidc-node-issuer") + c.Options().OIDCUri = "https://portal.example.com/" + resolveNodeOIDCClient(c) + assert.Equal(t, cluster.ExampleClientID, c.OIDCClient()) + assert.Equal(t, "https://portal.example.com/", c.OIDCUri().String(), "an explicit issuer must be respected") + }) + t.Run("DisabledIsNoOp", func(t *testing.T) { + c := portalInstance(t, "oidc-node-disabled") + c.Options().ClusterOIDC = false + resolveNodeOIDCClient(c) + assert.Equal(t, "", c.OIDCClient()) + assert.Equal(t, "", c.OIDCSecret()) + }) + t.Run("ExplicitClientWins", func(t *testing.T) { + c := portalInstance(t, "oidc-node-explicit") + c.Options().OIDCClient = "cs5cpu17n6gj2qo5" + c.Options().OIDCSecret = "explicit-secret" + c.Options().OIDCUri = "https://keycloak.example.com/realms/main" + resolveNodeOIDCClient(c) + assert.Equal(t, "cs5cpu17n6gj2qo5", c.OIDCClient(), "an explicit client id must not be overwritten") + assert.Equal(t, "explicit-secret", c.OIDCSecret()) + }) + t.Run("NotRegisteredLeavesClientEmpty", func(t *testing.T) { + c := portalInstance(t, "oidc-node-unregistered") + c.Options().NodeClientID = "" + c.Options().NodeClientSecret = "" + resolveNodeOIDCClient(c) + assert.Equal(t, "", c.OIDCClient(), "without node credentials nothing is derived") + assert.Equal(t, "", c.OIDCSecret()) + }) + t.Run("ServiceRoleNotDerived", func(t *testing.T) { + c := portalInstance(t, "oidc-node-service") + c.Options().NodeRole = cluster.RoleService + resolveNodeOIDCClient(c) + assert.Equal(t, "", c.OIDCClient()) + }) +} + func TestRegisterAuthToken_UsesJoinTokenWithoutNodeCredentials(t *testing.T) { c := newBootstrapTestConfig(t, "bootstrap-auth-join") portal, err := url.Parse("https://portal.example.test") @@ -214,6 +318,84 @@ func TestRegisterAuthToken_OAuthFailure(t *testing.T) { } } +// TestBootstrapClusterNode_ReRegistersWithNodeCredentials verifies an +// already-joined node (OAuth credentials, no join token) re-registers via OAuth +// on boot, propagating its declared group config without rotating credentials. +func TestBootstrapClusterNode_ReRegistersWithNodeCredentials(t *testing.T) { + prevTheme := cluster.BootstrapAutoThemeEnabled + cluster.BootstrapAutoThemeEnabled = false + t.Cleanup(func() { cluster.BootstrapAutoThemeEnabled = prevTheme }) + + var tokenCalls, registerCalls int + var gotAuth string + var gotPayload cluster.RegisterRequest + + srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + switch r.URL.Path { + case "/api/v1/oauth/token": + tokenCalls++ + w.Header().Set("Content-Type", "application/json") + _, _ = w.Write([]byte(`{"access_token":"oauth-node-token","token_type":"Bearer"}`)) + case "/api/v1/cluster/nodes/register": + registerCalls++ + gotAuth = r.Header.Get("Authorization") + _ = json.NewDecoder(r.Body).Decode(&gotPayload) + w.Header().Set("Content-Type", "application/json") + w.WriteHeader(http.StatusOK) + _ = json.NewEncoder(w).Encode(cluster.RegisterResponse{Node: cluster.Node{Name: "pp-node-01"}}) + default: + http.NotFound(w, r) + } + })) + defer srv.Close() + + c := newBootstrapTestConfig(t, "bootstrap-refresh-creds") + c.Options().PortalUrl = srv.URL + c.Options().NodeName = "pp-node-01" + c.Options().NodeRole = cluster.RoleInstance + c.Options().SiteUrl = "https://media.example.com/" + // Already joined: node OAuth credentials present, join token removed. + c.Options().JoinToken = "" + c.Options().NodeClientID = cluster.ExampleClientID + c.Options().NodeClientSecret = cluster.ExampleClientSecret + // Declarative group config that must reach the Portal on this restart. + c.Options().ClusterAllowGroupRoles = []string{"photoprism-admins=admin"} + + bootstrapClusterNode(c) + + assert.Equal(t, 1, tokenCalls, "must authenticate the re-registration via OAuth") + assert.Equal(t, 1, registerCalls, "an already-joined node must re-register on boot") + assert.Equal(t, "Bearer oauth-node-token", gotAuth, "re-registration must use the node OAuth token, not a join token") + assert.Equal(t, map[string]string{"photoprism-admins": "admin"}, gotPayload.AllowGroupRoles, + "the declared group config must be reported on the boot re-registration") + // The refresh must not rotate credentials. + assert.False(t, gotPayload.RotateSecret, "a boot refresh must never request a client-secret rotation") + assert.False(t, gotPayload.RotateDatabase, "a boot refresh must never request a database rotation when credentials exist") + assert.Equal(t, cluster.ExampleClientID, c.NodeClientID(), "the client ID must be unchanged") + assert.Equal(t, cluster.ExampleClientSecret, c.NodeClientSecret(), "the client secret must be unchanged") +} + +// TestBootstrapClusterNode_NoCredsNoToken confirms bootstrap is a no-op when a +// node has neither a join token nor OAuth credentials to authenticate with. +func TestBootstrapClusterNode_NoCredsNoToken(t *testing.T) { + var hits int + srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { + hits++ + w.WriteHeader(http.StatusOK) + })) + defer srv.Close() + + c := newBootstrapTestConfig(t, "bootstrap-no-creds") + c.Options().PortalUrl = srv.URL + c.Options().NodeRole = cluster.RoleInstance + c.Options().JoinToken = "" + c.Options().NodeClientID = "" + c.Options().NodeClientSecret = "" + + bootstrapClusterNode(c) + assert.Equal(t, 0, hits, "without credentials or a join token, bootstrap must not contact the Portal") +} + func TestInitConfig_DoesNotRetryWithJoinTokenAfterOAuthFailure(t *testing.T) { var tokenCalls int var registerCalls int @@ -468,7 +650,7 @@ func TestRegister_SQLite_NoDBPersist(t *testing.T) { // NodeClientSecret should persist, but DB should remain SQLite (no DSN update). assert.Equal(t, cluster.ExampleClientSecret, c.NodeClientSecret()) - assert.Equal(t, config.SQLite3, c.DatabaseDriver()) + assert.Equal(t, dsn.DriverSQLite3, c.DatabaseDriver()) assert.Equal(t, origDSN, c.Options().DatabaseDSN) assert.Equal(t, srv.URL+"/.well-known/jwks.json", c.JWKSUrl()) assert.Equal(t, "203.0.113.0/24", c.ClusterCIDR()) @@ -514,6 +696,82 @@ func TestDefaultNodeURL(t *testing.T) { assert.Equal(t, "https://node-1.photoprism.example", defaultNodeURL("NODE_1", "photoprism.example")) } +func TestBuildRegisterPayload_DisplayName(t *testing.T) { + c := newBootstrapTestConfig(t, "node-displayname") + reset := func() { + c.Options().SiteName = "" + c.Options().AppName = "" + c.Options().SiteTitle = "" + c.Options().SiteCaption = "" + c.Options().Name = "" + } + t.Run("PrefersSiteName", func(t *testing.T) { + reset() + c.Options().SiteName = "Acme Media" + c.Options().AppName = "Family Photos" + c.Options().SiteTitle = "Our Trip" + assert.Equal(t, "Acme Media", buildRegisterPayload(c).DisplayName) + }) + t.Run("PrefersAppName", func(t *testing.T) { + reset() + c.Options().AppName = "Family Photos" + c.Options().SiteTitle = "Our Trip" + c.Options().SiteCaption = "Tagline" + assert.Equal(t, "Family Photos", buildRegisterPayload(c).DisplayName) + }) + t.Run("FallsBackToSiteTitle", func(t *testing.T) { + reset() + c.Options().SiteTitle = "Our Trip" + assert.Equal(t, "Our Trip", buildRegisterPayload(c).DisplayName) + }) + t.Run("IgnoresSiteCaption", func(t *testing.T) { + // SiteCaption is excluded: Plus/Pro default it to the shared marketing + // description, so it is not a distinctive per-instance label. + reset() + c.Options().SiteCaption = "Browse Your Life" + assert.Equal(t, "", buildRegisterPayload(c).DisplayName) + }) + t.Run("EmptyWhenUnbranded", func(t *testing.T) { + reset() + assert.Equal(t, "", buildRegisterPayload(c).DisplayName) + }) + t.Run("AppNameSurvivesNameAliasing", func(t *testing.T) { + // The Pro edition aliases Name to AppName; reading the raw AppName option + // means DisplayName still reports it instead of treating it as a default. + reset() + c.Options().AppName = "Studio One" + c.Options().Name = "Studio One" + assert.Equal(t, "Studio One", buildRegisterPayload(c).DisplayName) + }) +} + +func TestBuildRegisterPayload_GroupConfig(t *testing.T) { + c := newBootstrapTestConfig(t, "node-groupconfig") + + t.Run("Default", func(t *testing.T) { + payload := buildRegisterPayload(c) + assert.Nil(t, payload.AllowGroups) + assert.Nil(t, payload.AllowGroupRoles) + assert.False(t, payload.GroupsFullView) + }) + t.Run("DeclaresConfiguredPolicy", func(t *testing.T) { + c.Options().ClusterAllowGroups = []string{"Media-Acme-Viewer"} + c.Options().ClusterAllowGroupRoles = []string{"Media-Acme-Admin=admin"} + c.Options().ClusterGroupsFullView = true + defer func() { + c.Options().ClusterAllowGroups = nil + c.Options().ClusterAllowGroupRoles = nil + c.Options().ClusterGroupsFullView = false + }() + + payload := buildRegisterPayload(c) + assert.Equal(t, []string{"media-acme-viewer", "media-acme-admin"}, payload.AllowGroups, + "role-map keys must be admitted too") + assert.Equal(t, map[string]string{"media-acme-admin": "admin"}, payload.AllowGroupRoles) + assert.True(t, payload.GroupsFullView) + }) +} + func TestRegister_404_NoRetry(t *testing.T) { var hits int srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { diff --git a/internal/service/cluster/node/node.go b/internal/service/cluster/node/node.go index ce252a154..33999e6a3 100644 --- a/internal/service/cluster/node/node.go +++ b/internal/service/cluster/node/node.go @@ -15,7 +15,7 @@ Responsibilities include: The package deliberately avoids importing Portal internals and communicates with the Portal using HTTP-only APIs. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -28,7 +28,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/service/cluster/node/node_test.go b/internal/service/cluster/node/node_test.go index 6650e1700..eff007351 100644 --- a/internal/service/cluster/node/node_test.go +++ b/internal/service/cluster/node/node_test.go @@ -7,16 +7,18 @@ import ( "github.com/photoprism/photoprism/pkg/fs" ) -// TestMain ensures SQLite test DB artifacts are purged after the suite runs. +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +// TestMain ensures SQLite test DB artifacts are purged after the suite runs. +func runTestMain(m *testing.M) int { // Remove temporary SQLite files before running the tests. fs.PurgeTestDbFiles(".", false) + // Remove temporary SQLite files after running the tests. + defer fs.PurgeTestDbFiles(".", false) // Run unit tests. - code := m.Run() - - // Remove temporary SQLite files after running the tests. - fs.PurgeTestDbFiles(".", false) - - os.Exit(code) + return m.Run() } diff --git a/internal/service/cluster/options_update.go b/internal/service/cluster/options_update.go index 82dee50c9..4885d8eef 100644 --- a/internal/service/cluster/options_update.go +++ b/internal/service/cluster/options_update.go @@ -7,6 +7,7 @@ type OptionsUpdate struct { ClusterCIDR *string NodeClientID *string JWKSUrl *string + PortalLoginUrl *string NodeUUID *string DatabaseDriver *string DatabaseDSN *string @@ -22,6 +23,7 @@ func (u OptionsUpdate) IsZero() bool { u.ClusterCIDR == nil && u.NodeClientID == nil && u.JWKSUrl == nil && + u.PortalLoginUrl == nil && u.NodeUUID == nil && u.DatabaseDriver == nil && u.DatabaseDSN == nil && @@ -63,6 +65,11 @@ func (u *OptionsUpdate) SetJWKSUrl(value string) { u.JWKSUrl = stringPtr(value) } +// SetPortalLoginUrl sets the browser-facing Portal login page URL. +func (u *OptionsUpdate) SetPortalLoginUrl(value string) { + u.PortalLoginUrl = stringPtr(value) +} + // SetNodeUUID sets the node UUID. func (u *OptionsUpdate) SetNodeUUID(value string) { u.NodeUUID = stringPtr(value) @@ -112,6 +119,9 @@ func (u OptionsUpdate) Visit(fn func(string, any)) { if u.JWKSUrl != nil { fn("JWKSUrl", *u.JWKSUrl) } + if u.PortalLoginUrl != nil { + fn("PortalLoginUrl", *u.PortalLoginUrl) + } if u.NodeUUID != nil { fn("NodeUUID", *u.NodeUUID) } diff --git a/internal/service/cluster/options_update_test.go b/internal/service/cluster/options_update_test.go index 14fdcd9e4..b7fbdc836 100644 --- a/internal/service/cluster/options_update_test.go +++ b/internal/service/cluster/options_update_test.go @@ -44,6 +44,7 @@ func TestOptionsUpdate_Apply(t *testing.T) { update.SetClusterCIDR("192.0.2.0/24") update.SetDatabaseName("cluster_database") update.SetDatabaseUser("cluster_user") + update.SetPortalLoginUrl("https://portal.example.com/portal/login") written, err := conf.SaveClusterOptionsUpdate(update) require.NoError(t, err) @@ -60,6 +61,7 @@ func TestOptionsUpdate_Apply(t *testing.T) { assert.Equal(t, "192.0.2.0/24", merged["ClusterCIDR"]) assert.Equal(t, "cluster_database", merged["DatabaseName"]) assert.Equal(t, "cluster_user", merged["DatabaseUser"]) + assert.Equal(t, "https://portal.example.com/portal/login", merged["PortalLoginUrl"]) // Applying an empty update should be a no-op. empty := cluster.OptionsUpdate{} diff --git a/internal/service/cluster/provisioner/README.md b/internal/service/cluster/provisioner/README.md index 2f039e59f..19f42fa11 100644 --- a/internal/service/cluster/provisioner/README.md +++ b/internal/service/cluster/provisioner/README.md @@ -6,7 +6,7 @@ The provisioner package manages per-instance MariaDB schemas and users for clust ### Development Workflow -- Configuration lives in `database.go`. The admin connection string is `ProvisionDSN` (default `root:photoprism@tcp(mariadb:4001)/photoprism`). Query parameters are optional when configuring the portal flag/env (`database-provision-dsn`), for example `charset=utf8mb4,utf8&collation=utf8mb4_unicode_ci&parseTime=true&timeout=15s`. +- Configuration lives in `database.go`. The admin connection string is `ProvisionDSN`; the default targets the dev MariaDB service (`root:photoprism@tcp(mariadb:<port>)/photoprism`) using the port from the `MARIADB_PORT` environment variable (falls back to `4001`). Query parameters are optional when configuring the portal flag/env (`database-provision-dsn`), for example `charset=utf8mb4,utf8&collation=utf8mb4_unicode_ci&parseTime=true&timeout=15s`. - `EnsureCredentials` accepts the technical node UUID/name identifiers, creates the schema if needed, and returns credentials plus rotation metadata. `DropCredentials` revokes grants, drops the user, and removes the schema. Both functions require a context; prefer `context.WithTimeout` in callers. - Identifier generation is centralized in `GenerateCredentials`. Call it instead of handcrafting database or user names so tests, CLI, and API stay aligned. The resulting identifiers follow `<prefix>d<hmac11>` for schemas and `<prefix>u<hmac11>` for users. Portal deployments may override the prefix via the `database-provision-prefix` flag; defaults are `cluster_d…` / `cluster_u…`. @@ -28,7 +28,7 @@ The provisioner package manages per-instance MariaDB schemas and users for clust ### MariaDB Troubleshooting -- Connect from the dev container using `mariadb` (already configured to reach `mariadb:4001`). Common snippets: +- Connect from the dev container using `mariadb` (configured via `.my.cnf` to reach the dev MariaDB service; the default port is `4001` unless `MARIADB_PORT` overrides it in `.env`). Common snippets: ```bash cat <<'SQL' | mariadb SHOW DATABASES LIKE 'cluster_d%'; -- adjust prefix if database-provision-prefix overrides the default diff --git a/internal/service/cluster/provisioner/database.go b/internal/service/cluster/provisioner/database.go index feb1cfee4..899869bdf 100644 --- a/internal/service/cluster/provisioner/database.go +++ b/internal/service/cluster/provisioner/database.go @@ -5,7 +5,9 @@ import ( "database/sql" "errors" "fmt" + "os" "regexp" + "strconv" "strings" "sync" "time" @@ -13,15 +15,26 @@ import ( _ "github.com/go-sql-driver/mysql" // register MySQL driver ) +// devDatabasePort returns the dev MariaDB port, honoring MARIADB_PORT when set so +// the provisioner stays aligned with compose.yaml overrides. +func devDatabasePort() int { + if v := os.Getenv("MARIADB_PORT"); v != "" { + if n, err := strconv.Atoi(v); err == nil && n > 0 && n < 65536 { + return n + } + } + return 4001 +} + // ProvisionDSN specifies the admin DSN used for auto-provisioning, for example: // root:insecure@tcp(127.0.0.1:3306)/photoprism?charset=utf8mb4,utf8&collation=utf8mb4_unicode_ci&parseTime=true -var ProvisionDSN = "root:photoprism@tcp(mariadb:4001)/photoprism?charset=utf8mb4,utf8&collation=utf8mb4_unicode_ci&parseTime=true" +var ProvisionDSN = fmt.Sprintf("root:photoprism@tcp(mariadb:%d)/photoprism?charset=utf8mb4,utf8&collation=utf8mb4_unicode_ci&parseTime=true", devDatabasePort()) // DatabaseHost is the hostname of the admin server used for provisioning operations. var DatabaseHost = "mariadb" // DatabasePort is the port of the admin server used for provisioning operations. -var DatabasePort = 4001 +var DatabasePort = devDatabasePort() // DatabaseDriver indicates the SQL driver used for provisioning (independent from the app DB driver). var DatabaseDriver = "mysql" diff --git a/internal/service/cluster/provisioner/database_test.go b/internal/service/cluster/provisioner/database_test.go index 002413f5e..3ecd8cef7 100644 --- a/internal/service/cluster/provisioner/database_test.go +++ b/internal/service/cluster/provisioner/database_test.go @@ -11,6 +11,29 @@ import ( "github.com/stretchr/testify/assert" ) +// --- devDatabasePort --------------------------------------------------------- + +func TestDevDatabasePort(t *testing.T) { + t.Run("Default", func(t *testing.T) { + t.Setenv("MARIADB_PORT", "") + assert.Equal(t, 4001, devDatabasePort()) + }) + t.Run("Override", func(t *testing.T) { + t.Setenv("MARIADB_PORT", "4002") + assert.Equal(t, 4002, devDatabasePort()) + }) + t.Run("InvalidNonNumeric", func(t *testing.T) { + t.Setenv("MARIADB_PORT", "not-a-port") + assert.Equal(t, 4001, devDatabasePort()) + }) + t.Run("InvalidOutOfRange", func(t *testing.T) { + t.Setenv("MARIADB_PORT", "0") + assert.Equal(t, 4001, devDatabasePort()) + t.Setenv("MARIADB_PORT", "70000") + assert.Equal(t, 4001, devDatabasePort()) + }) +} + // --- Quoting helpers --------------------------------------------------------- func TestQuoteIdent_Valid(t *testing.T) { diff --git a/internal/service/cluster/provisioner/naming_test.go b/internal/service/cluster/provisioner/naming_test.go index 7d18c5291..d4d89ae78 100644 --- a/internal/service/cluster/provisioner/naming_test.go +++ b/internal/service/cluster/provisioner/naming_test.go @@ -7,6 +7,8 @@ import ( "github.com/stretchr/testify/assert" + "github.com/photoprism/photoprism/pkg/dsn" + "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/service/cluster" ) @@ -103,7 +105,7 @@ func TestEnsureCredentials_SqliteRejected(t *testing.T) { ctx := context.Background() c := config.NewConfig(config.CliTestContext()) origDriver := DatabaseDriver - DatabaseDriver = config.SQLite3 + DatabaseDriver = dsn.DriverSQLite3 t.Cleanup(func() { DatabaseDriver = origDriver }) _, _, err := EnsureCredentials(ctx, c, "11111111-1111-4111-8111-111111111111", "pp-node-01", false) diff --git a/internal/service/cluster/provisioner/provisioner.go b/internal/service/cluster/provisioner/provisioner.go index 2efca14f3..989ef9d2a 100644 --- a/internal/service/cluster/provisioner/provisioner.go +++ b/internal/service/cluster/provisioner/provisioner.go @@ -25,7 +25,7 @@ uses the Admin DSN and skips automatically if the DSN cannot be opened/pinged. Historically, behavior was also validated via Docker Compose and broader repo targets such as "make run-test-mariadb". -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -38,7 +38,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/service/cluster/provisioner/provisioner_test.go b/internal/service/cluster/provisioner/provisioner_test.go index d67ea852e..c3e0b5e16 100644 --- a/internal/service/cluster/provisioner/provisioner_test.go +++ b/internal/service/cluster/provisioner/provisioner_test.go @@ -7,16 +7,18 @@ import ( "github.com/photoprism/photoprism/pkg/fs" ) -// TestMain ensures SQLite test DB artifacts are purged after the suite runs. +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +// TestMain ensures SQLite test DB artifacts are purged after the suite runs. +func runTestMain(m *testing.M) int { // Remove temporary SQLite files before running the tests. fs.PurgeTestDbFiles(".", false) + // Remove temporary SQLite files after running the tests. + defer fs.PurgeTestDbFiles(".", false) // Run unit tests. - code := m.Run() - - // Remove temporary SQLite files after running the tests. - fs.PurgeTestDbFiles(".", false) - - os.Exit(code) + return m.Run() } diff --git a/internal/service/cluster/registry/client.go b/internal/service/cluster/registry/client.go index eb519b868..30f9c390b 100644 --- a/internal/service/cluster/registry/client.go +++ b/internal/service/cluster/registry/client.go @@ -43,6 +43,7 @@ func toNode(c *entity.Client) *Node { UUID: c.NodeUUID, Name: c.ClientName, Role: role, + DisplayName: c.DisplayName, ClientID: c.ClientUID, AdvertiseUrl: c.ClientURL, AppName: c.AppName, @@ -68,11 +69,89 @@ func toNode(c *entity.Client) *Node { } n.RotatedAt = data.RotatedAt n.Theme = data.Theme + if len(data.RedirectURIs) > 0 { + n.RedirectURIs = append([]string(nil), data.RedirectURIs...) + } + if len(data.AllowGroups) > 0 { + n.AllowGroups = append([]string(nil), data.AllowGroups...) + } + if len(data.AllowGroupRoles) > 0 { + n.AllowGroupRoles = maps.Clone(data.AllowGroupRoles) + } + if data.GroupsFullView { + v := true + n.GroupsFullView = &v + } + // n.Node.GroupsSrc is the read DTO field; n.GroupsSrc (registry.Node) is + // the separate write-control input, so this assignment is qualified. + n.Node.GroupsSrc = data.GroupsSrc } return n } +// applyGroupConfig applies the node's group-based admission config to data, +// honoring source priority per n.GroupsSrc: an admin-pinned (manual) config is +// never replaced by an instance-declared (node) one, an instance declaration +// replaces the config wholesale and clears values it previously declared, and +// callers that don't manage group config (empty GroupsSrc) get plain +// nil-means-no-change semantics without provenance updates. +func applyGroupConfig(data *entity.ClientData, n *Node) { + switch n.GroupsSrc { + case entity.ClientGroupsSrcManual: + changed := false + if n.AllowGroups != nil { + data.AllowGroups = append([]string(nil), n.AllowGroups...) + changed = true + } + if n.AllowGroupRoles != nil { + data.AllowGroupRoles = maps.Clone(n.AllowGroupRoles) + changed = true + } + if n.GroupsFullView != nil { + data.GroupsFullView = *n.GroupsFullView + changed = true + } + if !changed { + return + } + // A fully cleared config un-pins the override so a declared instance + // config can repopulate it on the next registration. + if len(data.AllowGroups) == 0 && len(data.AllowGroupRoles) == 0 && !data.GroupsFullView { + data.GroupsSrc = "" + } else { + data.GroupsSrc = entity.ClientGroupsSrcManual + } + case entity.ClientGroupsSrcNode: + if data.GroupsSrc == entity.ClientGroupsSrcManual { + return + } + if len(n.AllowGroups) > 0 || len(n.AllowGroupRoles) > 0 || (n.GroupsFullView != nil && *n.GroupsFullView) { + data.AllowGroups = append([]string(nil), n.AllowGroups...) + data.AllowGroupRoles = maps.Clone(n.AllowGroupRoles) + data.GroupsFullView = n.GroupsFullView != nil && *n.GroupsFullView + data.GroupsSrc = entity.ClientGroupsSrcNode + } else if data.GroupsSrc == entity.ClientGroupsSrcNode { + // The instance stopped declaring a config; clear only values it + // previously declared, never unmanaged or admin-set ones. + data.AllowGroups = nil + data.AllowGroupRoles = nil + data.GroupsFullView = false + data.GroupsSrc = "" + } + default: + if n.AllowGroups != nil { + data.AllowGroups = append([]string(nil), n.AllowGroups...) + } + if n.AllowGroupRoles != nil { + data.AllowGroupRoles = maps.Clone(n.AllowGroupRoles) + } + if n.GroupsFullView != nil { + data.GroupsFullView = *n.GroupsFullView + } + } +} + // Put creates or updates a node record, preferring NodeUUID as the primary key // and falling back to ClientID or Name when required. The provided Node pointer // is updated with persisted identifiers so API/CLI layers can echo the result. @@ -151,10 +230,22 @@ func (r *ClientRegistry) Put(n *Node) error { if n.SiteUrl != "" { data.SiteURL = n.SiteUrl } + + // DisplayName follows the same source-priority rule as User.SetDisplayName: + // an admin override (SrcManual) pins the value so later instance + // registrations (SrcAuto) can't overwrite it, and clearing it un-pins. + m.SetDisplayName(n.DisplayName, n.NameSrc) if n.UUID != "" { m.NodeUUID = n.UUID } + // nil = no change so callers that don't touch the field can't clear it; non-nil replaces. + if n.RedirectURIs != nil { + data.RedirectURIs = append([]string(nil), n.RedirectURIs...) + } + + applyGroupConfig(data, n) + data.RotatedAt = n.RotatedAt if theme := clean.TypeUnicode(n.Theme); theme != "" { @@ -190,6 +281,7 @@ func (r *ClientRegistry) Put(n *Node) error { n.ClientID = m.ClientUID n.Name = m.ClientName n.Role = m.ClientRole + n.DisplayName = m.DisplayName n.AdvertiseUrl = m.ClientURL n.AppName = m.AppName n.AppVersion = m.AppVersion @@ -210,6 +302,30 @@ func (r *ClientRegistry) Put(n *Node) error { } n.RotatedAt = d.RotatedAt n.Theme = d.Theme + if len(d.RedirectURIs) > 0 { + n.RedirectURIs = append([]string(nil), d.RedirectURIs...) + } else { + n.RedirectURIs = nil + } + if len(d.AllowGroups) > 0 { + n.AllowGroups = append([]string(nil), d.AllowGroups...) + } else { + n.AllowGroups = nil + } + if len(d.AllowGroupRoles) > 0 { + n.AllowGroupRoles = maps.Clone(d.AllowGroupRoles) + } else { + n.AllowGroupRoles = nil + } + if d.GroupsFullView { + v := true + n.GroupsFullView = &v + } else { + n.GroupsFullView = nil + } + // Reflect the persisted provenance back into the read DTO field + // (qualified to bypass the registry.Node write-control GroupsSrc). + n.Node.GroupsSrc = d.GroupsSrc } // Set initial secret if provided on create/update. diff --git a/internal/service/cluster/registry/client_more_test.go b/internal/service/cluster/registry/client_more_test.go index 4dd9be886..ddbccc451 100644 --- a/internal/service/cluster/registry/client_more_test.go +++ b/internal/service/cluster/registry/client_more_test.go @@ -18,8 +18,11 @@ func TestClientRegistry_DuplicateNamePrefersLatest(t *testing.T) { // Create two clients directly to simulate duplicates with same name. c1 := entity.NewClient().SetName("pp-dupe").SetRole(cluster.RoleInstance) assert.NoError(t, c1.Create()) - // Stagger times - time.Sleep(10 * time.Millisecond) + // Backdate c1 so c2 is unambiguously the most recently updated. Timestamps are + // stored with second precision, so a sub-second stagger would not separate them. + assert.NoError(t, entity.UnscopedDb().Model(&entity.Client{}). + Where("client_uid = ?", c1.ClientUID). + UpdateColumn("updated_at", entity.Now().Add(-time.Hour)).Error) c2 := entity.NewClient().SetName("pp-dupe").SetRole(cluster.RoleService) assert.NoError(t, c2.Create()) @@ -35,6 +38,46 @@ func TestClientRegistry_DuplicateNamePrefersLatest(t *testing.T) { } } +// DisplayName: instance-reported names update freely until an admin pins one; +// an admin override is sticky across registrations, and clearing it un-pins. +func TestClientRegistry_DisplayNameOverride(t *testing.T) { + c := newRegistryTestConfig(t, "cluster-registry-displayname") + r, _ := NewClientRegistryWithConfig(c) + + // Instance reports a display name on first registration. + assert.NoError(t, r.Put(&Node{Node: cluster.Node{Name: "pp-dn", Role: cluster.RoleInstance, DisplayName: "First Title"}})) + got, err := r.FindByName("pp-dn") + assert.NoError(t, err) + if !assert.NotNil(t, got) { + return + } + assert.Equal(t, "First Title", got.DisplayName) + + // A later instance registration updates the reported name (no admin pin yet). + assert.NoError(t, r.Put(&Node{Node: cluster.Node{ClientID: got.ClientID, Name: got.Name, DisplayName: "Second Title"}})) + got, _ = r.FindByName("pp-dn") + assert.Equal(t, "Second Title", got.DisplayName) + + // Admin override (SrcManual) pins the value. + assert.NoError(t, r.Put(&Node{Node: cluster.Node{ClientID: got.ClientID, Name: got.Name, DisplayName: "Admin Pinned"}, NameSrc: entity.SrcManual})) + got, _ = r.FindByName("pp-dn") + assert.Equal(t, "Admin Pinned", got.DisplayName) + + // A subsequent instance registration must NOT overwrite the admin override. + assert.NoError(t, r.Put(&Node{Node: cluster.Node{ClientID: got.ClientID, Name: got.Name, DisplayName: "Instance Again"}})) + got, _ = r.FindByName("pp-dn") + assert.Equal(t, "Admin Pinned", got.DisplayName) + + // Admin clears the override (empty + SrcManual): un-pins and falls back, then + // the next instance registration repopulates it. + assert.NoError(t, r.Put(&Node{Node: cluster.Node{ClientID: got.ClientID, Name: got.Name, DisplayName: ""}, NameSrc: entity.SrcManual})) + got, _ = r.FindByName("pp-dn") + assert.Equal(t, "", got.DisplayName) + assert.NoError(t, r.Put(&Node{Node: cluster.Node{ClientID: got.ClientID, Name: got.Name, DisplayName: "After Clear"}})) + got, _ = r.FindByName("pp-dn") + assert.Equal(t, "After Clear", got.DisplayName) +} + // Role change path: Put should update ClientRole via mapping. func TestClientRegistry_RoleChange(t *testing.T) { c := newRegistryTestConfig(t, "cluster-registry-role") diff --git a/internal/service/cluster/registry/helpers_test.go b/internal/service/cluster/registry/helpers_test.go index 6fe249f41..98f43751a 100644 --- a/internal/service/cluster/registry/helpers_test.go +++ b/internal/service/cluster/registry/helpers_test.go @@ -19,3 +19,16 @@ func newRegistryTestConfig(t *testing.T, name string) *cfg.Config { return c } + +// listNodeByName returns the listed node with the given name, or nil if absent. +// List queries are not isolated per test on the shared MariaDB test database, so +// tests assert on membership with this helper rather than an exact result count. +func listNodeByName(list []Node, name string) *Node { + for i := range list { + if list[i].Name == name { + return &list[i] + } + } + + return nil +} diff --git a/internal/service/cluster/registry/node.go b/internal/service/cluster/registry/node.go index 29c75fc3b..42c9b8508 100644 --- a/internal/service/cluster/registry/node.go +++ b/internal/service/cluster/registry/node.go @@ -10,6 +10,16 @@ type Node struct { ClientSecret string `json:"-"` // plaintext only when newly created/rotated in-memory RotatedAt string `json:"RotatedAt,omitempty"` // secret rotation timestamp AuthEnabled bool `json:"-"` // auth client is enabled + // NameSrc carries the DisplayName provenance for this write (entity.SrcAuto + // for instance registrations, entity.SrcManual for admin overrides) so Put + // can apply the same source-priority rule as User.SetDisplayName. It is a + // write-control field, not serialized. + NameSrc string `json:"-"` + // GroupsSrc carries the group-config provenance for this write + // (entity.ClientGroupsSrcNode for instance registrations, + // entity.ClientGroupsSrcManual for admin edits); callers that don't manage + // group config leave it empty. It is a write-control field, not serialized. + GroupsSrc string `json:"-"` } // ensureDatabase returns a writable NodeDatabase, creating one if missing. diff --git a/internal/service/cluster/registry/registry.go b/internal/service/cluster/registry/registry.go index e83ca242d..71df587e4 100644 --- a/internal/service/cluster/registry/registry.go +++ b/internal/service/cluster/registry/registry.go @@ -6,7 +6,7 @@ and exposes CRUD-style operations to create, lookup, list, delete, and rotate secrets for nodes. Helper mappers convert internal Node records to API/CLI response DTOs while redacting sensitive fields. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -19,7 +19,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/service/cluster/registry/registry_list_negative_test.go b/internal/service/cluster/registry/registry_list_negative_test.go index 3b27ec3b7..2a71b4ed2 100644 --- a/internal/service/cluster/registry/registry_list_negative_test.go +++ b/internal/service/cluster/registry/registry_list_negative_test.go @@ -29,11 +29,14 @@ func TestClientRegistry_ListExcludesNodeRoleWithoutUUID(t *testing.T) { list, err := r.List() assert.NoError(t, err) - // Only the UUID-backed record should be present - if assert.Equal(t, 1, len(list)) { - assert.Equal(t, "pp-good", list[0].Name) - assert.NotEmpty(t, list[0].UUID) - assert.NotEqual(t, "pp-bad1", list[0].Name) - assert.NotEqual(t, "pp-bad2", list[0].Name) + // The MariaDB test database is shared across tests (unlike the per-test SQLite + // file), so List() also returns nodes created elsewhere. Assert on membership + // rather than the exact count: the UUID-backed node is listed and the node-role + // records without a NodeUUID are not. + if found := listNodeByName(list, "pp-good"); assert.NotNil(t, found, "UUID-backed node should be listed") { + assert.NotEmpty(t, found.UUID) } + + assert.Nil(t, listNodeByName(list, "pp-bad1"), "node role without UUID must be excluded") + assert.Nil(t, listNodeByName(list, "pp-bad2"), "node role without UUID must be excluded") } diff --git a/internal/service/cluster/registry/registry_test.go b/internal/service/cluster/registry/registry_test.go index b2c43f41c..80517f2e6 100644 --- a/internal/service/cluster/registry/registry_test.go +++ b/internal/service/cluster/registry/registry_test.go @@ -13,18 +13,20 @@ import ( "github.com/photoprism/photoprism/pkg/rnd" ) -// TestMain ensures SQLite test DB artifacts are purged after the suite runs. +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +// TestMain ensures SQLite test DB artifacts are purged after the suite runs. +func runTestMain(m *testing.M) int { // Remove temporary SQLite files before running the tests. fs.PurgeTestDbFiles(".", false) + // Remove temporary SQLite files after running the tests. + defer fs.PurgeTestDbFiles(".", false) // Run unit tests. - code := m.Run() - - // Remove temporary SQLite files after running the tests. - fs.PurgeTestDbFiles(".", false) - - os.Exit(code) + return m.Run() } func TestClientRegistry_GetAndDelete(t *testing.T) { @@ -37,12 +39,17 @@ func TestClientRegistry_GetAndDelete(t *testing.T) { t.Fatalf("expected error for invalid uuid") } - // Create node + // Create node with an instance-declared group policy (write-control + // GroupsSrc marks this write's provenance). n := &Node{Node: cluster.Node{Name: "pp-del", Role: cluster.RoleInstance, UUID: rnd.UUIDv7()}} + n.AllowGroups = []string{"g-ops"} + n.GroupsSrc = entity.ClientGroupsSrcNode assert.NoError(t, r.Put(n)) assert.NotEmpty(t, n.ClientID) assert.True(t, rnd.IsUID(n.ClientID, entity.ClientUID)) assert.True(t, rnd.IsUUID(n.UUID)) + // Put reflects the persisted provenance into the read DTO field. + assert.Equal(t, entity.ClientGroupsSrcNode, n.Node.GroupsSrc) // Get by UUID got, err := r.Get(n.UUID) @@ -52,6 +59,10 @@ func TestClientRegistry_GetAndDelete(t *testing.T) { assert.Equal(t, "pp-del", got.Name) assert.True(t, rnd.IsUUID(got.UUID)) assert.True(t, rnd.IsUID(got.ClientID, entity.ClientUID)) + assert.Equal(t, []string{"g-ops"}, got.AllowGroups) + // toNode maps ClientData.GroupsSrc onto the read DTO field; got.GroupsSrc + // (registry.Node) is the separate write-control field, hence the qualifier. + assert.Equal(t, entity.ClientGroupsSrcNode, got.Node.GroupsSrc) } // Delete by UUID @@ -112,11 +123,21 @@ func TestResponseBuilders_RedactionAndOpts(t *testing.T) { dbInfo.Name = "dbn" dbInfo.User = "dbu" dbInfo.RotatedAt = time.Now().UTC().Format(time.RFC3339) + fullView := true + n.AllowGroups = []string{"media-acme-admin"} + n.AllowGroupRoles = map[string]string{"media-acme-admin": "admin"} + n.GroupsFullView = &fullView + // Set the read DTO field, not the registry.Node write-control GroupsSrc. + n.Node.GroupsSrc = entity.ClientGroupsSrcNode - // Non-admin (default opts): redact advertise/database + // Non-admin (default opts): redact advertise/database and access rules out := BuildClusterNode(n, NodeOpts{}) assert.Equal(t, "", out.AdvertiseUrl) assert.Nil(t, out.Database) + assert.Nil(t, out.AllowGroups) + assert.Nil(t, out.AllowGroupRoles) + assert.Nil(t, out.GroupsFullView) + assert.Empty(t, out.GroupsSrc) // Include advertise only out2 := BuildClusterNode(n, NodeOpts{IncludeAdvertiseUrl: true}) @@ -129,6 +150,16 @@ func TestResponseBuilders_RedactionAndOpts(t *testing.T) { assert.Equal(t, "dbn", out3.Database.Name) assert.Equal(t, "dbu", out3.Database.User) } + assert.Nil(t, out3.AllowGroups, "access rules require IncludeAccessRules") + + // Include access rules (full admin view) + out4 := BuildClusterNode(n, NodeOpts{IncludeAdvertiseUrl: true, IncludeDatabase: true, IncludeAccessRules: true}) + assert.Equal(t, []string{"media-acme-admin"}, out4.AllowGroups) + assert.Equal(t, map[string]string{"media-acme-admin": "admin"}, out4.AllowGroupRoles) + if assert.NotNil(t, out4.GroupsFullView) { + assert.True(t, *out4.GroupsFullView) + } + assert.Equal(t, entity.ClientGroupsSrcNode, out4.GroupsSrc) // BuildClusterNodes on empty input returns empty slice (not nil) list := BuildClusterNodes(nil, NodeOpts{}) @@ -136,6 +167,78 @@ func TestResponseBuilders_RedactionAndOpts(t *testing.T) { assert.Equal(t, 0, len(list)) } +func TestApplyGroupConfig(t *testing.T) { + boolPtr := func(v bool) *bool { return &v } + declared := func(groups []string, roles map[string]string, fullView bool) *Node { + n := &Node{GroupsSrc: entity.ClientGroupsSrcNode} + n.AllowGroups = groups + n.AllowGroupRoles = roles + if fullView { + n.GroupsFullView = boolPtr(true) + } + return n + } + + t.Run("NodeDeclares", func(t *testing.T) { + data := &entity.ClientData{} + applyGroupConfig(data, declared([]string{"g1"}, map[string]string{"g1": "admin"}, true)) + assert.Equal(t, []string{"g1"}, data.AllowGroups) + assert.Equal(t, map[string]string{"g1": "admin"}, data.AllowGroupRoles) + assert.True(t, data.GroupsFullView) + assert.Equal(t, entity.ClientGroupsSrcNode, data.GroupsSrc) + }) + t.Run("NodeNeverClobbersManual", func(t *testing.T) { + data := &entity.ClientData{AllowGroups: []string{"pinned"}, GroupsSrc: entity.ClientGroupsSrcManual} + applyGroupConfig(data, declared([]string{"g1"}, nil, false)) + assert.Equal(t, []string{"pinned"}, data.AllowGroups) + assert.Equal(t, entity.ClientGroupsSrcManual, data.GroupsSrc) + }) + t.Run("EmptyDeclarationClearsNodeValues", func(t *testing.T) { + data := &entity.ClientData{AllowGroups: []string{"g1"}, GroupsFullView: true, GroupsSrc: entity.ClientGroupsSrcNode} + applyGroupConfig(data, declared(nil, nil, false)) + assert.Empty(t, data.AllowGroups) + assert.False(t, data.GroupsFullView) + assert.Equal(t, "", data.GroupsSrc) + }) + t.Run("EmptyDeclarationKeepsUnmanagedValues", func(t *testing.T) { + data := &entity.ClientData{AllowGroups: []string{"legacy"}} + applyGroupConfig(data, declared(nil, nil, false)) + assert.Equal(t, []string{"legacy"}, data.AllowGroups, "values without provenance must not be cleared") + }) + t.Run("ManualEditPins", func(t *testing.T) { + data := &entity.ClientData{AllowGroups: []string{"g1"}, GroupsSrc: entity.ClientGroupsSrcNode} + n := &Node{GroupsSrc: entity.ClientGroupsSrcManual} + n.AllowGroups = []string{"g2"} + applyGroupConfig(data, n) + assert.Equal(t, []string{"g2"}, data.AllowGroups) + assert.Equal(t, entity.ClientGroupsSrcManual, data.GroupsSrc) + }) + t.Run("ManualClearAllUnpins", func(t *testing.T) { + data := &entity.ClientData{AllowGroups: []string{"g1"}, GroupsFullView: true, GroupsSrc: entity.ClientGroupsSrcManual} + n := &Node{GroupsSrc: entity.ClientGroupsSrcManual} + n.AllowGroups = []string{} + n.AllowGroupRoles = map[string]string{} + n.GroupsFullView = boolPtr(false) + applyGroupConfig(data, n) + assert.Empty(t, data.AllowGroups) + assert.Equal(t, "", data.GroupsSrc, "a fully cleared manual config must un-pin") + }) + t.Run("ManualNoFieldsNoChange", func(t *testing.T) { + data := &entity.ClientData{AllowGroups: []string{"g1"}, GroupsSrc: entity.ClientGroupsSrcNode} + applyGroupConfig(data, &Node{GroupsSrc: entity.ClientGroupsSrcManual}) + assert.Equal(t, []string{"g1"}, data.AllowGroups) + assert.Equal(t, entity.ClientGroupsSrcNode, data.GroupsSrc) + }) + t.Run("UnmanagedCallerLegacySemantics", func(t *testing.T) { + data := &entity.ClientData{AllowGroups: []string{"g1"}, GroupsSrc: entity.ClientGroupsSrcNode} + n := &Node{} + n.AllowGroups = []string{"g2"} + applyGroupConfig(data, n) + assert.Equal(t, []string{"g2"}, data.AllowGroups) + assert.Equal(t, entity.ClientGroupsSrcNode, data.GroupsSrc, "no provenance update without a source") + }) +} + func TestNodeOptsForSession_AdminVsNonAdmin(t *testing.T) { // Admin: SuperAdmin=true suffices for IsAdmin() admin := &entity.User{SuperAdmin: true} @@ -186,6 +289,54 @@ func TestToNode_Mapping(t *testing.T) { } } +// TestClientRegistry_RedirectURIs_RoundTrip confirms RedirectURIs flow +// through Put → reload → toNode unchanged, that a nil slice on update +// means "no change" (preserves the previous set), and that a non-nil +// slice (even empty) replaces it. +func TestClientRegistry_RedirectURIs_RoundTrip(t *testing.T) { + c := newRegistryTestConfig(t, "cluster-registry-redirecturis") + assert.NoError(t, c.Init()) + r, _ := NewClientRegistryWithConfig(c) + + uri1 := "https://photos.example.com/api/v1/oidc/redirect" + uri2 := "http://127.0.0.1:2342/api/v1/oidc/redirect" + + n := &Node{Node: cluster.Node{ + Name: "pp-redir", + Role: cluster.RoleInstance, + UUID: rnd.UUIDv7(), + RedirectURIs: []string{uri1, uri2}, + }} + assert.NoError(t, r.Put(n)) + + reloaded, err := r.FindByNodeUUID(n.UUID) + assert.NoError(t, err) + if assert.NotNil(t, reloaded) { + assert.Equal(t, []string{uri1, uri2}, reloaded.RedirectURIs) + } + + // nil on a subsequent Put preserves the previously persisted set. + reloaded.RedirectURIs = nil + reloaded.Name = "pp-redir-renamed" + assert.NoError(t, r.Put(reloaded)) + + again, err := r.FindByNodeUUID(n.UUID) + assert.NoError(t, err) + if assert.NotNil(t, again) { + assert.Equal(t, []string{uri1, uri2}, again.RedirectURIs, "nil slice must not clear persisted redirect uris") + } + + // Empty non-nil slice replaces (clears) the persisted set. + again.RedirectURIs = []string{} + assert.NoError(t, r.Put(again)) + + cleared, err := r.FindByNodeUUID(n.UUID) + assert.NoError(t, err) + if assert.NotNil(t, cleared) { + assert.Empty(t, cleared.RedirectURIs, "empty slice must clear the persisted set") + } +} + func TestClientRegistry_GetClusterNodeByUUID(t *testing.T) { c := newRegistryTestConfig(t, "cluster-registry-getbyuuid") assert.NoError(t, c.Init()) diff --git a/internal/service/cluster/registry/registry_uuid_test.go b/internal/service/cluster/registry/registry_uuid_test.go index c4a83d0cf..423a0575b 100644 --- a/internal/service/cluster/registry/registry_uuid_test.go +++ b/internal/service/cluster/registry/registry_uuid_test.go @@ -102,11 +102,16 @@ func TestClientRegistry_ListOnlyUUID(t *testing.T) { r, _ := NewClientRegistryWithConfig(c) list, err := r.List() assert.NoError(t, err) - // Only the NodeUUID-backed record should be present - if assert.Equal(t, 1, len(list)) { - assert.Equal(t, "pp-node", list[0].Name) - assert.NotEmpty(t, list[0].UUID) + + // The MariaDB test database is shared across tests (unlike the per-test SQLite + // file), so List() also returns nodes created elsewhere. Assert on membership + // rather than the exact count: the NodeUUID-backed record is listed and the + // non-node client is not. + if found := listNodeByName(list, "pp-node"); assert.NotNil(t, found, "node should be listed") { + assert.NotEmpty(t, found.UUID) } + + assert.Nil(t, listNodeByName(list, "webapp"), "non-node client must be excluded") } // Put should prefer UUID over ClientID when both are provided, avoiding cross-attachment. diff --git a/internal/service/cluster/registry/response.go b/internal/service/cluster/registry/response.go index ec0317388..db7c8a254 100644 --- a/internal/service/cluster/registry/response.go +++ b/internal/service/cluster/registry/response.go @@ -9,13 +9,15 @@ import ( type NodeOpts struct { IncludeAdvertiseUrl bool IncludeDatabase bool + IncludeAccessRules bool } // NodeOptsForSession returns the default exposure policy for a session. -// Admin users see AdvertiseUrl and DB metadata; others get a redacted view. +// Admin users see AdvertiseUrl, DB metadata, and group-based access rules; +// others get a redacted view. func NodeOptsForSession(s *entity.Session) NodeOpts { if s != nil && s.GetUser() != nil && s.GetUser().IsAdmin() { - return NodeOpts{IncludeAdvertiseUrl: true, IncludeDatabase: true} + return NodeOpts{IncludeAdvertiseUrl: true, IncludeDatabase: true, IncludeAccessRules: true} } return NodeOpts{} @@ -33,6 +35,13 @@ func BuildClusterNode(n Node, opts NodeOpts) cluster.Node { out.Database = nil } + if !opts.IncludeAccessRules { + out.AllowGroups = nil + out.AllowGroupRoles = nil + out.GroupsFullView = nil + out.GroupsSrc = "" + } + return out } diff --git a/internal/service/cluster/request.go b/internal/service/cluster/request.go index 12325d203..cc91cd897 100644 --- a/internal/service/cluster/request.go +++ b/internal/service/cluster/request.go @@ -5,17 +5,21 @@ package cluster // // swagger:model RegisterRequest type RegisterRequest struct { - NodeName string `json:"NodeName"` - NodeUUID string `json:"NodeUUID,omitempty"` - NodeRole string `json:"NodeRole,omitempty"` - Labels map[string]string `json:"Labels,omitempty"` - AppName string `json:"AppName,omitempty"` - AppVersion string `json:"AppVersion,omitempty"` - Theme string `json:"Theme,omitempty"` - AdvertiseUrl string `json:"AdvertiseUrl,omitempty"` - SiteUrl string `json:"SiteUrl,omitempty"` - ClientID string `json:"ClientID,omitempty"` - ClientSecret string `json:"ClientSecret,omitempty"` //nolint:gosec // G117: Rotated OAuth client secret payload. - RotateDatabase bool `json:"RotateDatabase,omitempty"` - RotateSecret bool `json:"RotateSecret,omitempty"` + NodeName string `json:"NodeName"` + NodeUUID string `json:"NodeUUID,omitempty"` + NodeRole string `json:"NodeRole,omitempty"` + DisplayName string `json:"DisplayName,omitempty"` + Labels map[string]string `json:"Labels,omitempty"` + AppName string `json:"AppName,omitempty"` + AppVersion string `json:"AppVersion,omitempty"` + Theme string `json:"Theme,omitempty"` + AdvertiseUrl string `json:"AdvertiseUrl,omitempty"` + SiteUrl string `json:"SiteUrl,omitempty"` + AllowGroups []string `json:"AllowGroups,omitempty"` + AllowGroupRoles map[string]string `json:"AllowGroupRoles,omitempty"` + GroupsFullView bool `json:"GroupsFullView,omitempty"` + ClientID string `json:"ClientID,omitempty"` + ClientSecret string `json:"ClientSecret,omitempty"` //nolint:gosec // G117: Rotated OAuth client secret payload. + RotateDatabase bool `json:"RotateDatabase,omitempty"` + RotateSecret bool `json:"RotateSecret,omitempty"` } diff --git a/internal/service/cluster/response.go b/internal/service/cluster/response.go index 45cd257b6..afeb5f3b0 100644 --- a/internal/service/cluster/response.go +++ b/internal/service/cluster/response.go @@ -15,6 +15,7 @@ type Node struct { UUID string `json:"UUID"` // NodeUUID Name string `json:"Name"` // NodeName Role string `json:"Role"` // NodeRole + DisplayName string `json:"DisplayName,omitempty"` ClientID string `json:"ClientID,omitempty"` AppName string `json:"AppName,omitempty"` AppVersion string `json:"AppVersion,omitempty"` @@ -22,9 +23,20 @@ type Node struct { SiteUrl string `json:"SiteUrl,omitempty"` AdvertiseUrl string `json:"AdvertiseUrl,omitempty"` Labels map[string]string `json:"Labels,omitempty"` - CreatedAt string `json:"CreatedAt"` - UpdatedAt string `json:"UpdatedAt"` - Database *NodeDatabase `json:"Database,omitempty"` + RedirectURIs []string `json:"RedirectURIs,omitempty"` + // Group-based admission config (redacted for non-admin sessions): + // AllowGroups admits matching login-time groups, AllowGroupRoles + // optionally overrides the default role per group, GroupsFullView opts the + // node into receiving the user's full group set, and GroupsSrc is the + // AllowGroups provenance ("node" = instance-declared via env, "manual" = + // admin-pinned; empty = unmanaged). + AllowGroups []string `json:"AllowGroups,omitempty"` + AllowGroupRoles map[string]string `json:"AllowGroupRoles,omitempty"` + GroupsFullView *bool `json:"GroupsFullView,omitempty"` + GroupsSrc string `json:"GroupsSrc,omitempty"` + CreatedAt string `json:"CreatedAt"` + UpdatedAt string `json:"UpdatedAt"` + Database *NodeDatabase `json:"Database,omitempty"` } // DatabaseInfo provides basic database connection metadata for summary endpoints. @@ -84,6 +96,7 @@ type RegisterResponse struct { Database RegisterDatabase `json:"Database"` Secrets *RegisterSecrets `json:"Secrets,omitempty"` JWKSUrl string `json:"JWKSUrl,omitempty"` + PortalLoginUrl string `json:"PortalLoginUrl,omitempty"` AlreadyRegistered bool `json:"AlreadyRegistered"` AlreadyProvisioned bool `json:"AlreadyProvisioned"` Theme string `json:"Theme,omitempty"` diff --git a/internal/service/cluster/theme/theme.go b/internal/service/cluster/theme/theme.go index 59629ff6a..8b8612985 100644 --- a/internal/service/cluster/theme/theme.go +++ b/internal/service/cluster/theme/theme.go @@ -3,7 +3,7 @@ Package theme contains helpers shared by cluster services to inspect bundled portal themes, for example detecting their version or validating required assets. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -16,7 +16,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/service/hub/hub.go b/internal/service/hub/hub.go index e76a1d716..2fd298d1a 100644 --- a/internal/service/hub/hub.go +++ b/internal/service/hub/hub.go @@ -1,7 +1,7 @@ /* Package hub provides privacy-preserving reverse geocoding and other backend services. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/service/hub/hub_test.go b/internal/service/hub/hub_test.go index 731a9c17c..55c771be4 100644 --- a/internal/service/hub/hub_test.go +++ b/internal/service/hub/hub_test.go @@ -13,15 +13,18 @@ import ( "github.com/stretchr/testify/assert" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) int { log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) ApplyTestConfig() - code := m.Run() - - os.Exit(code) + return m.Run() } // Token returns a random token with length of up to 10 characters. diff --git a/internal/service/hub/places/cell.go b/internal/service/hub/places/cell.go index f039a0739..e6cc411ca 100644 --- a/internal/service/hub/places/cell.go +++ b/internal/service/hub/places/cell.go @@ -50,10 +50,11 @@ func Cell(id string, locale string) (result Location, err error) { } var r *http.Response + var reqUrl string // Query the specified places service URLs. for _, serviceUrl := range LocationServiceUrls { - reqUrl := fmt.Sprintf(serviceUrl, id) + reqUrl = fmt.Sprintf(serviceUrl, id) if r, err = GetRequest(reqUrl, locale); err == nil { break } @@ -61,7 +62,7 @@ func Cell(id string, locale string) (result Location, err error) { // Failed? if err != nil { - log.Errorf("places: %s (location request failed)", err.Error()) + log.Warnf("places: location request to %s failed (%s)", serviceHost(reqUrl), safeError(err)) return result, err } else if r == nil { err = fmt.Errorf("location request could not be performed") diff --git a/internal/service/hub/places/latlng.go b/internal/service/hub/places/latlng.go index d00389f38..e26257df3 100644 --- a/internal/service/hub/places/latlng.go +++ b/internal/service/hub/places/latlng.go @@ -41,10 +41,11 @@ func LatLng(lat, lng float64, locale string) (result Location, err error) { } var r *http.Response + var reqUrl string // Query the specified places service URLs. for _, serviceUrl := range ReverseServiceUrls { - reqUrl := fmt.Sprintf("%s?%s", serviceUrl, params) + reqUrl = fmt.Sprintf("%s?%s", serviceUrl, params) if r, err = GetRequest(reqUrl, locale); err == nil { break } @@ -52,7 +53,7 @@ func LatLng(lat, lng float64, locale string) (result Location, err error) { // Failed? if err != nil { - log.Errorf("places: %s (location request failed)", err.Error()) + log.Errorf("places: location request to %s failed (%s)", serviceHost(reqUrl), safeError(err)) return result, err } else if r == nil { err = fmt.Errorf("location request could not be performed") diff --git a/internal/service/hub/places/places.go b/internal/service/hub/places/places.go index 17d05db45..7a2255148 100644 --- a/internal/service/hub/places/places.go +++ b/internal/service/hub/places/places.go @@ -1,7 +1,7 @@ /* Package places provides global location information to enrich metadata with location details. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/service/hub/places/request.go b/internal/service/hub/places/request.go index 7b780394e..8fc7c0685 100644 --- a/internal/service/hub/places/request.go +++ b/internal/service/hub/places/request.go @@ -2,19 +2,73 @@ package places import ( "crypto/sha1" //nolint:gosec // required for upstream signature scheme + "errors" "fmt" "net/http" + "net/url" + "strings" "time" "github.com/photoprism/photoprism/pkg/http/header" "github.com/photoprism/photoprism/pkg/http/safe" ) -// GetRequest fetches the cell ID data from the service URL. +// sharedTransport is a connection-pooling transport reused across all geocoding +// requests. The idle-connection pool lives in the transport, not the client, so +// a large index keeps warm connections instead of a fresh TLS handshake per +// lookup — while each request still uses its own client for a request-scoped +// timeout (see GetRequest). +var sharedTransport = newTransport() + +// newTransport returns an http.Transport tuned for many short geocoding +// requests. It keeps a larger idle-connection pool than the stdlib default to +// reduce TLS-handshake churn, while leaving IdleConnTimeout below the backend's +// so the client closes idle connections first and avoids the reuse race. +func newTransport() *http.Transport { + t := http.DefaultTransport.(*http.Transport).Clone() + t.MaxIdleConns = 64 + t.MaxIdleConnsPerHost = 16 + t.IdleConnTimeout = 90 * time.Second + return t +} + +// serviceHost returns the host of a request URL for UI-visible logs. It drops +// the query so request coordinates never reach those logs; if the URL cannot be +// parsed into a host, it still strips any query string rather than falling back +// to the raw value. +func serviceHost(reqUrl string) string { + if u, err := url.Parse(reqUrl); err == nil && u.Host != "" { + return u.Host + } + if i := strings.IndexByte(reqUrl, '?'); i >= 0 { + return reqUrl[:i] + } + return reqUrl +} + +// safeError returns an error message safe for UI-visible logs. A failed request +// yields a *url.Error whose Error() embeds the full request URL — including the +// geocoding coordinates — so for that type only the underlying transport error +// is returned; other errors are returned unchanged. +func safeError(err error) string { + var urlErr *url.Error + if errors.As(err, &urlErr) && urlErr.Err != nil { + return urlErr.Err.Error() + } + if err != nil { + return err.Error() + } + return "" +} + +// GetRequest fetches data from the specified geocoding service URL. Because +// these are idempotent GET requests, it retries transient connection-level +// failures up to Retries times with a linear backoff before giving up. func GetRequest(reqUrl string, locale string) (r *http.Response, err error) { var req *http.Request - // Log request URL. + // Full request URL at trace level only; trace is developer-only and not + // surfaced in the UI, unlike the host-only error logs. log.Tracef("places: sending request to %s", reqUrl) if _, parseErr := safe.URL(reqUrl); parseErr != nil { @@ -26,7 +80,7 @@ func GetRequest(reqUrl string, locale string) (r *http.Response, err error) { // Ok? if err != nil { - log.Errorf("places: %s", err.Error()) + log.Errorf("places: request to %s failed (%s)", serviceHost(reqUrl), safeError(err)) return r, err } @@ -48,28 +102,27 @@ func GetRequest(reqUrl string, locale string) (r *http.Response, err error) { req.Header.Set("X-Signature", fmt.Sprintf("%x", sha1.Sum([]byte(Key+reqUrl+Secret)))) //nolint:gosec // upstream expects SHA1 } - // Create new http.Client. - // - // NOTE: Timeout specifies a time limit for requests made by - // this Client. The timeout includes connection time, any - // redirects, and reading the response body. The timer remains - // running after GetRequest, Head, Post, or Do return and will - // interrupt reading of the Response.Body. - client := &http.Client{Timeout: 60 * time.Second} + // Per-request client sharing the pooled transport. The client stays per + // request because Client.Timeout covers reading the response body and keeps + // running after Do returns, so the deadline must be scoped to this request; + // the connection pool lives in sharedTransport, so lookups still reuse warm + // connections. + client := &http.Client{Timeout: 60 * time.Second, Transport: sharedTransport} - // Perform request. + // Retry transient connection-level failures on this idempotent GET with a + // linear backoff. for i := 0; i < Retries; i++ { // #nosec G704 reqUrl is parsed and scheme-validated above. - r, err = client.Do(req) - - // Ok? - if err == nil { + if r, err = client.Do(req); err == nil { return r, nil } - // Wait before trying again? - if RetryDelay.Nanoseconds() > 0 { - time.Sleep(RetryDelay) + // Full URL and raw error at trace level for developer troubleshooting. + log.Tracef("places: request to %s failed (%s)", reqUrl, err) + + // Back off before the next attempt, skipping the wait after the last try. + if RetryDelay > 0 && i < Retries-1 { + time.Sleep(RetryDelay * time.Duration(i+1)) } } diff --git a/internal/service/hub/places/request_test.go b/internal/service/hub/places/request_test.go index 0d3a894b9..881317d53 100644 --- a/internal/service/hub/places/request_test.go +++ b/internal/service/hub/places/request_test.go @@ -1,8 +1,12 @@ package places import ( + "errors" "net/http" "net/http/httptest" + "net/url" + "strings" + "sync/atomic" "testing" "time" ) @@ -69,4 +73,117 @@ func TestGetRequest(t *testing.T) { t.Fatal("expected URL parse error") } }) + t.Run("RetryOnConnectionError", func(t *testing.T) { + prevRetries := Retries + prevDelay := RetryDelay + prevAgent := UserAgent + prevKey := Key + prevSecret := Secret + defer func() { + Retries = prevRetries + RetryDelay = prevDelay + UserAgent = prevAgent + Key = prevKey + Secret = prevSecret + }() + + Retries = 3 + RetryDelay = 0 + UserAgent = "PhotoPrism/TestSuite" + Key = "" + Secret = "" + + var attempts int32 + server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + // Drop the connection on the first attempt to simulate a transient + // connection-level failure, then answer normally on the retry. + if atomic.AddInt32(&attempts, 1) == 1 { + if hj, ok := w.(http.Hijacker); ok { + if conn, _, hjErr := hj.Hijack(); hjErr == nil { + _ = conn.Close() + return + } + } + } + w.WriteHeader(http.StatusOK) + })) + defer server.Close() + + resp, err := GetRequest(server.URL+"/v1/reverse", "en") + if err != nil { + t.Fatalf("expected success after retry, got %v", err) + } + if resp == nil { + t.Fatal("expected response") + } + _ = resp.Body.Close() + if got := atomic.LoadInt32(&attempts); got < 2 { + t.Fatalf("expected at least 2 attempts (a retry), got %d", got) + } + }) +} + +// TestServiceHost verifies host extraction and query stripping for log safety. +func TestServiceHost(t *testing.T) { + t.Run("WithQuery", func(t *testing.T) { + if got := serviceHost("https://places.photoprism.app/v1/reverse?lat=52.520000&lng=13.405000"); got != "places.photoprism.app" { + t.Fatalf("expected host without query, got %q", got) + } + }) + t.Run("PathOnly", func(t *testing.T) { + if got := serviceHost("https://places.photoprism.xyz/v1/location/1e95998417cc"); got != "places.photoprism.xyz" { + t.Fatalf("expected host, got %q", got) + } + }) + t.Run("HostlessStripsQuery", func(t *testing.T) { + // No host to extract, but the query (coordinates) must still be dropped. + if got := serviceHost("/v1/reverse?lat=52.520000&lng=13.405000"); got != "/v1/reverse" { + t.Fatalf("expected query stripped, got %q", got) + } + }) + t.Run("Unparseable", func(t *testing.T) { + if got := serviceHost("://nope"); got != "://nope" { + t.Fatalf("expected raw fallback, got %q", got) + } + }) +} + +// TestSafeError verifies that a *url.Error's embedded request URL is dropped. +func TestSafeError(t *testing.T) { + t.Run("StripsURLError", func(t *testing.T) { + err := &url.Error{Op: "Get", URL: "https://places.photoprism.app/v1/reverse?lat=52.520000&lng=13.405000", Err: errors.New("tls: EOF")} + got := safeError(err) + if got != "tls: EOF" { + t.Fatalf("expected underlying error only, got %q", got) + } + if strings.Contains(got, "lat=") || strings.Contains(got, "reverse") { + t.Fatalf("coordinates leaked into log message: %q", got) + } + }) + t.Run("PlainError", func(t *testing.T) { + if got := safeError(errors.New("boom")); got != "boom" { + t.Fatalf("expected passthrough, got %q", got) + } + }) + t.Run("Nil", func(t *testing.T) { + if got := safeError(nil); got != "" { + t.Fatalf("expected empty string, got %q", got) + } + }) +} + +func TestNewTransport(t *testing.T) { + tr := newTransport() + if tr == nil { + t.Fatal("expected transport") + } + if tr.MaxIdleConnsPerHost != 16 { + t.Fatalf("expected MaxIdleConnsPerHost 16, got %d", tr.MaxIdleConnsPerHost) + } + if tr.MaxIdleConns != 64 { + t.Fatalf("expected MaxIdleConns 64, got %d", tr.MaxIdleConns) + } + if tr.IdleConnTimeout != 90*time.Second { + t.Fatalf("expected IdleConnTimeout 90s, got %s", tr.IdleConnTimeout) + } } diff --git a/internal/service/hub/places/search.go b/internal/service/hub/places/search.go index a5f6e39cb..e71a46e14 100644 --- a/internal/service/hub/places/search.go +++ b/internal/service/hub/places/search.go @@ -48,10 +48,11 @@ func Search(q, locale string, count int) (results SearchResults, err error) { } var r *http.Response + var reqUrl string // Query the specified places service URLs. for _, serviceUrl := range SearchServiceUrls { - reqUrl := fmt.Sprintf("%s?%s", serviceUrl, params) + reqUrl = fmt.Sprintf("%s?%s", serviceUrl, params) if r, err = GetRequest(reqUrl, locale); err == nil { break } @@ -59,7 +60,7 @@ func Search(q, locale string, count int) (results SearchResults, err error) { // Failed? if err != nil { - log.Errorf("places: %s (search request failed)", err.Error()) + log.Errorf("places: search request to %s failed (%s)", serviceHost(reqUrl), safeError(err)) return results, err } else if r == nil { err = fmt.Errorf("search request could not be performed") diff --git a/internal/service/maps/maps.go b/internal/service/maps/maps.go index 36f2caa03..ba8a6fad9 100644 --- a/internal/service/maps/maps.go +++ b/internal/service/maps/maps.go @@ -1,7 +1,7 @@ /* Package maps provides a location lookup abstraction including a normalized list of countries. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/service/service.go b/internal/service/service.go index ab874d405..3d675990a 100644 --- a/internal/service/service.go +++ b/internal/service/service.go @@ -1,7 +1,7 @@ /* Package service provides detection of remote services for file sharing and synchronization. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/service/webdav/README.md b/internal/service/webdav/README.md new file mode 100644 index 000000000..9616443c2 --- /dev/null +++ b/internal/service/webdav/README.md @@ -0,0 +1,72 @@ +## PhotoPrism — WebDAV Service Client + +**Last Updated:** March 7, 2026 + +### Overview + +`internal/service/webdav` contains the outbound WebDAV client used by PhotoPrism services and background workers. It wraps `github.com/emersion/go-webdav` with PhotoPrism-specific URL validation, control-operation timeouts, filesystem mapping, and error/logging behavior for remote uploads, downloads, and synchronization. + +### Main Responsibilities + +- Validate remote endpoints against `services-cidr` before opening outbound connections. +- Normalize remote paths and expose them as `pkg/fs.FileInfo` values. +- Support uploads, downloads, deletes, and remote directory creation. +- Enumerate remote directories for service folder browsing and sync refresh jobs. +- Exclude hidden dotfiles and entries inside hidden dot-directories because these are often lock files, partial uploads, or provider-managed metadata. + +### Recursive Directory Discovery + +`Client.Directories(dir, recursive, timeout)` is the main entry point for remote folder discovery. + +- Fast path: when `recursive=true`, the client first performs a recursive `PROPFIND` using `Depth: infinity` through the upstream WebDAV library. +- Compatibility fallback: if the recursive request fails, the client retries discovery by walking the tree with repeated non-recursive `PROPFIND` requests using `Depth: 1`. +- Scope: this fallback is intentionally limited to directory enumeration. It does not change upload, download, delete, or file-listing semantics. + +This behavior exists because some providers and appliances accept `Depth: 1` but reject `Depth: infinity`. The fallback keeps those servers usable for: + +- service folder browsing via `entity.Service.Directories()`, +- sync refresh in `internal/workers/sync_refresh.go`. + +### Timeout Behavior + +Available timeout settings for `Service.AccTimeout` and `webdav.Timeout`: + +| Setting | Value | Effective Timeout | +|:--------|:-----------|:------------------| +| Default | `""` | `60s` | +| Medium | `"medium"` | `60s` | +| Low | `"low"` | `30s` | +| High | `"high"` | `120s` | +| None | `"none"` | no timeout | + +- `Timeout` values map to total HTTP request timeouts for non-transfer WebDAV calls such as directory discovery, file listing, directory creation, and delete operations. +- `Upload()` and `Download()` intentionally bypass the service timeout so long-running file transfers are not aborted by a total request deadline. +- Transfer requests still apply connection-level safeguards such as connect, TLS handshake, and pooled idle connection limits to avoid hanging before a transfer is established. +- In timeout-aware helper calls, `timeout=0` means "use the client's configured default timeout" (`c.timeout`), not "disable timeouts". +- A negative helper timeout means "do not override the current client/request timeout behavior"; this is used internally for legacy no-override call paths. +- Recursive directory discovery also applies the effective timeout as an overall traversal deadline, so iterative fallback walks do not run indefinitely. +- `MaxRequestDuration` is used for long-running recursive directory discovery, including the `Depth: 1` fallback. + +### Logging + +When a recursive `PROPFIND` fails, the client logs the failure and emits an informational message if it successfully switches to the iterative `Depth: 1` fallback. Successful fallback logs include the number of follow-up `PROPFIND` requests and the elapsed traversal time so operators can diagnose depth-limited servers without reducing the user-facing API response to only "could not connect". + +### Package Layout + +- `webdav.go` — package comment, timeout constants, and shared logger. +- `client.go` — outbound WebDAV client wrapper and compatibility fallback. +- `path.go` — shared path normalization helpers. +- `client_test.go` — unit tests, including a local `httptest` WebDAV fixture for depth-limited servers. + +### Related Files + +- [`internal/entity/service.go`](../../entity/service.go) — service-level directory discovery. +- [`internal/workers/sync_refresh.go`](../../workers/sync_refresh.go) — sync refresh that enumerates remote directories before file listing. +- [`scripts/dav-probe.sh`](../../../scripts/dav-probe.sh) — captures `PROPFIND` responses for troubleshooting remote server behavior. + +### Testing + +- Focused client tests: `go test ./internal/service/webdav -run 'TestClient_Directories' -count=1` +- Service-level regression checks: `go test ./internal/entity -run 'TestService_Directories' -count=1` + +The local test server in `client_test.go` simulates both compliant servers and depth-1-only servers so the fallback can be validated without relying on the external dummy WebDAV container. diff --git a/internal/service/webdav/client.go b/internal/service/webdav/client.go index e9c5a5240..739def34d 100644 --- a/internal/service/webdav/client.go +++ b/internal/service/webdav/client.go @@ -5,6 +5,7 @@ import ( "fmt" "io" "net" + "net/http" "net/url" "os" "path" @@ -22,12 +23,25 @@ import ( // Client represents a webdav client. type Client struct { - client *webdav.Client - ctx context.Context - endpoint *url.URL - timeout time.Duration - mkdir map[string]bool - cidrs []*net.IPNet + client *webdav.Client + ctx context.Context + endpoint *url.URL + timeout time.Duration + mkdir map[string]bool + cidrs []*net.IPNet + downloadLimit int64 +} + +// SetDownloadLimit bounds the size of a single downloaded file in bytes; a value +// of zero or less leaves downloads unbounded. The remote endpoint is a separate +// trust domain, so this caps how much one response can write to local storage — +// files above the configured originals limit are rejected by the indexer anyway. +func (c *Client) SetDownloadLimit(maxBytes int64) { + if c == nil { + return + } + + c.downloadLimit = maxBytes } // clientUrl returns the validated server url including username and password, if specified. @@ -46,6 +60,37 @@ func clientUrl(serverUrl, user, pass string) (*url.URL, error) { return result, nil } +// newTransferHTTPClient returns an HTTP client with connection-level safeguards but no total transfer deadline. +func newTransferHTTPClient(cidrs []*net.IPNet) *http.Client { + client := service.NewHTTPClient(0, cidrs) + transport, ok := client.Transport.(*http.Transport) + + if !ok || transport == nil { + return client + } + + transport = transport.Clone() + + if baseDial := transport.DialContext; baseDial != nil { + transport.DialContext = func(ctx context.Context, network, addr string) (net.Conn, error) { + if transferConnectTimeout > 0 { + var cancel context.CancelFunc + ctx, cancel = context.WithTimeout(ctx, transferConnectTimeout) + defer cancel() + } + + return baseDial(ctx, network, addr) + } + } + + transport.TLSHandshakeTimeout = transferTLSHandshakeTimeout + transport.IdleConnTimeout = transferIdleConnTimeout + transport.ExpectContinueTimeout = transferExpectContinueTimeout + client.Transport = transport + + return client +} + // NewClient creates a new WebDAV client for the specified endpoint. func NewClient(serverUrl, user, pass string, timeout Timeout, servicesCIDR string) (*Client, error) { endpoint, err := clientUrl(serverUrl, user, pass) @@ -68,7 +113,7 @@ func NewClient(serverUrl, user, pass string, timeout Timeout, servicesCIDR strin log.Debugf("webdav: connecting to %s", clean.Log(serverUrl)) - client, err := webdav.NewClient(service.NewHTTPClient(0, allowedCIDRs), serverUrl) + client, err := webdav.NewClient(newTransferHTTPClient(allowedCIDRs), serverUrl) if err != nil { return nil, err @@ -105,15 +150,115 @@ func (c *Client) withTimeout(timeout time.Duration) *webdav.Client { return client } -// readDirWithTimeout returns the contents of the specified directory with a request time limit if timeout is not negative. -func (c *Client) readDirWithTimeout(dir string, recursive bool, timeout time.Duration) ([]webdav.FileInfo, error) { - dir = trimPath(dir) - return c.withTimeout(timeout).ReadDir(c.ctx, dir, recursive) +// effectiveTimeout returns the effective request timeout used by WebDAV calls. +func (c *Client) effectiveTimeout(timeout time.Duration) time.Duration { + if timeout < 0 { + return -1 + } else if timeout == 0 { + return c.timeout + } + + return timeout } -// readDir returns the contents of the specified directory without a request timeout. -func (c *Client) readDir(dir string, recursive bool) ([]webdav.FileInfo, error) { - return c.readDirWithTimeout(dir, recursive, -1) +// timeoutContext returns a request context bounded by the configured timeout when applicable. +func (c *Client) timeoutContext(timeout time.Duration) (context.Context, context.CancelFunc) { + if timeout = c.effectiveTimeout(timeout); timeout > 0 { + return context.WithTimeout(c.ctx, timeout) + } + + return c.ctx, func() {} +} + +// timeoutRequest returns a timeout-aware client and context for outbound WebDAV calls. +func (c *Client) timeoutRequest(timeout time.Duration) (*webdav.Client, context.Context, context.CancelFunc) { + ctx, cancel := c.timeoutContext(timeout) + return c.withTimeout(timeout), ctx, cancel +} + +// readDirPath returns an absolute WebDAV collection path rooted at the configured endpoint. +func (c *Client) readDirPath(dir string) string { + basePath := c.endpoint.Path + + if basePath == "" { + basePath = "/" + } else if !strings.HasSuffix(basePath, "/") { + basePath += "/" + } + + if dir = trimPath(dir); dir != "" { + return strings.TrimRight(basePath, "/") + "/" + dir + "/" + } + + return basePath +} + +// readDirContext returns the contents of the specified directory using the provided request context. +func (c *Client) readDirContext(ctx context.Context, dir string, recursive bool, timeout time.Duration) ([]webdav.FileInfo, error) { + dir = c.readDirPath(dir) + return c.withTimeout(timeout).ReadDir(ctx, dir, recursive) +} + +// appendUniqueEntries adds new WebDAV entries only once while preserving response order. +func appendUniqueEntries(result []webdav.FileInfo, found []webdav.FileInfo, seen map[string]bool) []webdav.FileInfo { + for _, entry := range found { + entryPath := trimPath(entry.Path) + + if seen[entryPath] { + continue + } + + seen[entryPath] = true + result = append(result, entry) + } + + return result +} + +// appendTraversalDirs adds unseen child directories from a non-recursive PROPFIND response to the queue. +func appendTraversalDirs(queue []string, current string, found []webdav.FileInfo, seen map[string]bool) []string { + current = trimPath(current) + + for _, entry := range found { + if !entry.IsDir { + continue + } + + entryPath := trimPath(entry.Path) + + if entryPath == "" || entryPath == current || isHiddenPath(entryPath) || seen[entryPath] { + continue + } + + seen[entryPath] = true + queue = append(queue, entryPath) + } + + return queue +} + +// readDirFallback traverses directories with repeated non-recursive PROPFIND requests. +func (c *Client) readDirFallback(ctx context.Context, dir string, timeout time.Duration) (result []webdav.FileInfo, requests int, err error) { + queue := []string{trimPath(dir)} + traversed := map[string]bool{trimPath(dir): true} + seenEntries := map[string]bool{} + + for len(queue) > 0 { + current := queue[0] + queue = queue[1:] + requests++ + + found, readErr := c.readDirContext(ctx, current, false, timeout) + + if readErr != nil { + return result, requests, readErr + } + + result = appendUniqueEntries(result, found, seenEntries) + queue = appendTraversalDirs(queue, current, found, traversed) + } + + return result, requests, nil } // Files returns information about files in a directory, optionally recursively. @@ -125,8 +270,10 @@ func (c *Client) Files(dir string, recursive bool) (result fs.FileInfos, err err }() dir = trimPath(dir) + ctx, cancel := c.timeoutContext(0) + defer cancel() - found, err := c.readDir(dir, recursive) + found, err := c.readDirContext(ctx, dir, recursive, 0) if err != nil { return result, err @@ -135,7 +282,7 @@ func (c *Client) Files(dir string, recursive bool) (result fs.FileInfos, err err result = make(fs.FileInfos, 0, len(found)) for _, f := range found { - if f.IsDir || f.Path == "" || strings.HasPrefix(f.Path, ".") { + if f.IsDir || f.Path == "" || isHiddenPath(f.Path) { continue } @@ -147,11 +294,26 @@ func (c *Client) Files(dir string, recursive bool) (result fs.FileInfos, err err return result, nil } -// Directories returns all subdirectories in a path as string slice. +// Directories returns all subdirectories in a path and falls back to iterative Depth: 1 traversal when needed. func (c *Client) Directories(dir string, recursive bool, timeout time.Duration) (result fs.FileInfos, err error) { dir = trimPath(dir) + ctx, cancel := c.timeoutContext(timeout) + defer cancel() - found, err := c.readDirWithTimeout(dir, recursive, timeout) + found, err := c.readDirContext(ctx, dir, recursive, timeout) + + if err != nil && recursive { + started := time.Now() + + if fallback, requests, fallbackErr := c.readDirFallback(ctx, dir, timeout); fallbackErr == nil { + log.Infof("webdav: recursive PROPFIND failed for %s, using iterative Depth: 1 fallback after %d requests [%s] (%s)", clean.Log(path.Join("/", dir)), requests, time.Since(started).Round(time.Millisecond), clean.Error(err)) + found = fallback + err = nil + } else { + log.Warnf("webdav: recursive PROPFIND failed for %s (%s)", clean.Log(path.Join("/", dir)), clean.Error(err)) + log.Debugf("webdav: Depth: 1 fallback failed for %s after %d requests [%s] (%s)", clean.Log(path.Join("/", dir)), requests, time.Since(started).Round(time.Millisecond), clean.Error(fallbackErr)) + } + } if err != nil { return result, err @@ -160,7 +322,7 @@ func (c *Client) Directories(dir string, recursive bool, timeout time.Duration) result = make(fs.FileInfos, 0, len(found)) for _, f := range found { - if !f.IsDir || f.Path == "" || strings.HasPrefix(f.Path, ".") { + if !f.IsDir || f.Path == "" || isHiddenPath(f.Path) { continue } @@ -203,8 +365,10 @@ func (c *Client) Mkdir(dir string) error { } c.mkdir[dir] = true + client, ctx, cancel := c.timeoutRequest(0) + defer cancel() - err := c.client.Mkdir(c.ctx, dir) + err := client.Mkdir(ctx, dir) if err == nil { return nil @@ -243,7 +407,6 @@ func (c *Client) Upload(src, dest string) (err error) { }() var writer io.WriteCloser - writer, err = c.client.Create(c.ctx, dest) if err != nil { @@ -294,7 +457,6 @@ func (c *Client) Download(src, dest string, force bool) (err error) { } var reader io.ReadCloser - // Start download. reader, err = c.client.Open(c.ctx, src) @@ -317,7 +479,21 @@ func (c *Client) Download(src, dest string, force bool) (err error) { return fmt.Errorf("webdav: failed to create %s", clean.Log(path.Base(dest))) } - if _, err = f.ReadFrom(reader); err != nil { + if c.downloadLimit > 0 { + // Read one byte past the limit so an exact-size overflow is detected + // instead of being silently truncated into a corrupt local file. + if n, copyErr := io.Copy(f, io.LimitReader(reader, c.downloadLimit+1)); copyErr != nil { + err = copyErr + } else if n > c.downloadLimit { + _ = f.Close() + _ = os.Remove(dest) + return fmt.Errorf("webdav: %s exceeds the maximum size of %d bytes", clean.Log(path.Base(dest)), c.downloadLimit) + } + } else { + _, err = f.ReadFrom(reader) + } + + if err != nil { _ = f.Close() log.Errorf("webdav: %s", clean.Error(err)) return fmt.Errorf("webdav: failed writing to %s", clean.Log(path.Base(dest))) @@ -366,5 +542,7 @@ func (c *Client) DownloadDir(src, dest string, recursive, force bool) (errs []er // Delete deletes a single file or directory on a remote server. func (c *Client) Delete(dir string) error { dir = trimPath(dir) - return c.client.RemoveAll(c.ctx, dir) + client, ctx, cancel := c.timeoutRequest(0) + defer cancel() + return client.RemoveAll(ctx, dir) } diff --git a/internal/service/webdav/client_test.go b/internal/service/webdav/client_test.go index f5f67de80..177e9028c 100644 --- a/internal/service/webdav/client_test.go +++ b/internal/service/webdav/client_test.go @@ -1,11 +1,19 @@ package webdav import ( + "io" + "net/http" + "net/http/httptest" "os" + "path" "path/filepath" + "strconv" + "strings" "testing" + "time" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" "github.com/photoprism/photoprism/pkg/fs" "github.com/photoprism/photoprism/pkg/rnd" @@ -17,6 +25,259 @@ const ( testPass = "photoprism" ) +// testWebDAVEntry represents a directory entry returned by the test WebDAV server. +type testWebDAVEntry struct { + Href string + Dir bool + Size int64 +} + +// testWebDAVServerOptions controls quirks exposed by the local WebDAV fixture. +type testWebDAVServerOptions struct { + rejectInfinity bool + duplicateDepthOne bool + redirectSlashlessDepthOne bool + requireBasicAuthOnDepthOne bool + requestPathPrefix string +} + +// testWebDAVTree defines the depth-1 PROPFIND responses returned by the test server. +var testWebDAVTree = map[string][]testWebDAVEntry{ + "/": { + {Href: "/", Dir: true}, + {Href: "/.locks/", Dir: true}, + {Href: "/.partial-upload", Size: 1}, + {Href: "/Photos/", Dir: true}, + {Href: "/Shared/", Dir: true}, + }, + "/.locks": { + {Href: "/.locks/", Dir: true}, + {Href: "/.locks/upload.tmp", Size: 2}, + }, + "/Photos": { + {Href: "/Photos/", Dir: true}, + {Href: "/Photos/.upload.part", Size: 3}, + {Href: "/Photos/.staging/", Dir: true}, + {Href: "/Photos/cover.jpg", Size: 4}, + {Href: "/Photos/2020/", Dir: true}, + {Href: "/Photos/2021/", Dir: true}, + }, + "/Photos/.staging": { + {Href: "/Photos/.staging/", Dir: true}, + {Href: "/Photos/.staging/incomplete.jpg", Size: 5}, + }, + "/Photos/2020": { + {Href: "/Photos/2020/", Dir: true}, + {Href: "/Photos/2020/03/", Dir: true}, + }, + "/Photos/2020/03": { + {Href: "/Photos/2020/03/", Dir: true}, + }, + "/Photos/2021": { + {Href: "/Photos/2021/", Dir: true}, + }, + "/Shared": { + {Href: "/Shared/", Dir: true}, + }, +} + +// newTestWebDAVServer returns a minimal WebDAV endpoint for recursive listing tests. +func newTestWebDAVServer(rejectInfinity bool) *httptest.Server { + return newTestWebDAVServerWithOptions(testWebDAVServerOptions{rejectInfinity: rejectInfinity}) +} + +// newTestWebDAVServerWithOptions returns a minimal WebDAV endpoint with optional quirks for regression coverage. +func newTestWebDAVServerWithOptions(options testWebDAVServerOptions) *httptest.Server { + return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + if r.Method != "PROPFIND" { + http.Error(w, "method not allowed", http.StatusMethodNotAllowed) + return + } + + rawPath := r.URL.Path + + if prefix := strings.TrimRight(options.requestPathPrefix, "/"); prefix != "" { + if !strings.HasPrefix(rawPath, prefix) { + http.Error(w, "not found", http.StatusNotFound) + return + } + + rawPath = strings.TrimPrefix(rawPath, prefix) + + if rawPath == "" { + rawPath = "/" + } + } + + requestPath := testWebDAVCollectionPath(rawPath) + depth := strings.ToLower(strings.TrimSpace(r.Header.Get("Depth"))) + + if depth == "" { + depth = "infinity" + } + + if depth == "infinity" && options.rejectInfinity { + http.Error(w, `webdav: Depth: infinity is not supported`, http.StatusBadRequest) + return + } + + var entries []testWebDAVEntry + + switch depth { + case "1": + if options.redirectSlashlessDepthOne && requestPath != "/" && !strings.HasSuffix(rawPath, "/") { + http.Redirect(w, r, rawPath+"/", http.StatusMovedPermanently) + return + } + + if options.requireBasicAuthOnDepthOne { + user, pass, ok := r.BasicAuth() + + if !ok || user != testUser || pass != testPass { + http.Error(w, "unauthorized", http.StatusUnauthorized) + return + } + } + + entries = testWebDAVDepthOneEntries(requestPath) + + if options.duplicateDepthOne && requestPath == "/Photos" { + entries = append(entries, + testWebDAVEntry{Href: "/Photos/2020/", Dir: true}, + testWebDAVEntry{Href: "/Photos/cover.jpg", Size: 4}, + ) + } + case "infinity": + entries = testWebDAVDepthInfinityEntries(requestPath) + default: + http.Error(w, "unsupported depth", http.StatusBadRequest) + return + } + + if len(entries) == 0 { + http.Error(w, "not found", http.StatusNotFound) + return + } + + w.Header().Set("Content-Type", "application/xml; charset=utf-8") + w.WriteHeader(http.StatusMultiStatus) + //nolint:gosec // test fixture emits locally generated WebDAV XML only + _, _ = w.Write([]byte(testWebDAVMultiStatus(entries))) + })) +} + +// newSlowWebDAVServer returns a WebDAV-like server that responds after a fixed delay. +func newSlowWebDAVServer(delay time.Duration, slowHeaders bool) *httptest.Server { + return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + switch r.Method { + case "MKCOL": + time.Sleep(delay) + w.WriteHeader(http.StatusCreated) + case http.MethodDelete: + time.Sleep(delay) + w.WriteHeader(http.StatusNoContent) + case "PROPFIND": + time.Sleep(delay) + w.Header().Set("Content-Type", "application/xml; charset=utf-8") + w.WriteHeader(http.StatusMultiStatus) + _, _ = io.WriteString(w, testWebDAVMultiStatus(testWebDAVDepthOneEntries("/"))) + case http.MethodGet: + if slowHeaders { + time.Sleep(delay) + } + w.WriteHeader(http.StatusOK) + _, _ = io.WriteString(w, "test") + case http.MethodPut: + _, _ = io.Copy(io.Discard, r.Body) + _ = r.Body.Close() + if slowHeaders { + time.Sleep(delay) + } + w.WriteHeader(http.StatusCreated) + default: + http.Error(w, "method not allowed", http.StatusMethodNotAllowed) + } + })) +} + +// testWebDAVCollectionPath normalizes collection paths used by the test server. +func testWebDAVCollectionPath(value string) string { + if value = path.Clean("/" + strings.TrimSpace(value)); value != "." { + return value + } + + return "/" +} + +// testWebDAVDepthOneEntries returns the direct child entries for a collection path. +func testWebDAVDepthOneEntries(collectionPath string) []testWebDAVEntry { + return testWebDAVTree[testWebDAVCollectionPath(collectionPath)] +} + +// testWebDAVDepthInfinityEntries returns the full subtree for a collection path. +func testWebDAVDepthInfinityEntries(collectionPath string) (result []testWebDAVEntry) { + queue := []string{testWebDAVCollectionPath(collectionPath)} + traversed := map[string]bool{testWebDAVCollectionPath(collectionPath): true} + seen := map[string]bool{} + + for len(queue) > 0 { + current := queue[0] + queue = queue[1:] + + for _, entry := range testWebDAVDepthOneEntries(current) { + entryPath := testWebDAVCollectionPath(entry.Href) + + if !seen[entryPath] { + seen[entryPath] = true + result = append(result, entry) + } + + if entry.Dir && entryPath != current && !traversed[entryPath] { + traversed[entryPath] = true + queue = append(queue, entryPath) + } + } + } + + return result +} + +// testWebDAVMultiStatus renders a simple 207 Multi-Status XML document for the test server. +func testWebDAVMultiStatus(entries []testWebDAVEntry) string { + var builder strings.Builder + + builder.WriteString(`<?xml version="1.0" encoding="utf-8"?>`) + builder.WriteString(`<D:multistatus xmlns:D="DAV:">`) + + for _, entry := range entries { + builder.WriteString(`<D:response>`) + builder.WriteString(`<D:href>`) + builder.WriteString(entry.Href) + builder.WriteString(`</D:href>`) + builder.WriteString(`<D:propstat><D:prop><D:resourcetype>`) + + if entry.Dir { + builder.WriteString(`<D:collection/>`) + } + + builder.WriteString(`</D:resourcetype>`) + builder.WriteString(`<D:getlastmodified>Mon, 02 Jan 2006 15:04:05 GMT</D:getlastmodified>`) + + if !entry.Dir { + builder.WriteString(`<D:getcontentlength>`) + builder.WriteString(strconv.FormatInt(entry.Size, 10)) + builder.WriteString(`</D:getcontentlength>`) + } + + builder.WriteString(`</D:prop><D:status>HTTP/1.1 200 OK</D:status></D:propstat>`) + builder.WriteString(`</D:response>`) + } + + builder.WriteString(`</D:multistatus>`) + + return builder.String() +} + func TestClientUrl(t *testing.T) { result, err := clientUrl(testUrl, testUser, testPass) @@ -116,6 +377,174 @@ func TestClient_Directories(t *testing.T) { }) } +func TestClient_DirectoriesDepthFallback(t *testing.T) { + expected := []string{"/", "/Photos", "/Photos/2020", "/Photos/2020/03", "/Photos/2021", "/Shared"} + + t.Run("RecursiveFastPath", func(t *testing.T) { + server := newTestWebDAVServer(false) + t.Cleanup(server.Close) + + client, err := NewClient(server.URL+"/", "", "", TimeoutLow, "") + require.NoError(t, err) + + dirs, err := client.Directories("", true, MaxRequestDuration) + require.NoError(t, err) + assert.ElementsMatch(t, expected, dirs.Abs()) + }) + t.Run("DepthOneFallback", func(t *testing.T) { + server := newTestWebDAVServer(true) + t.Cleanup(server.Close) + + client, err := NewClient(server.URL+"/", "", "", TimeoutLow, "") + require.NoError(t, err) + + dirs, err := client.Directories("", true, MaxRequestDuration) + require.NoError(t, err) + assert.ElementsMatch(t, expected, dirs.Abs()) + }) + t.Run("DepthOneFallbackUsesCollectionPaths", func(t *testing.T) { + server := newTestWebDAVServerWithOptions(testWebDAVServerOptions{ + rejectInfinity: true, + redirectSlashlessDepthOne: true, + requireBasicAuthOnDepthOne: true, + }) + t.Cleanup(server.Close) + + client, err := NewClient(server.URL+"/", testUser, testPass, TimeoutLow, "") + require.NoError(t, err) + + dirs, err := client.Directories("", true, MaxRequestDuration) + require.NoError(t, err) + assert.ElementsMatch(t, expected, dirs.Abs()) + }) + t.Run("DepthOneFallbackPreservesEndpointPrefix", func(t *testing.T) { + server := newTestWebDAVServerWithOptions(testWebDAVServerOptions{ + rejectInfinity: true, + redirectSlashlessDepthOne: true, + requireBasicAuthOnDepthOne: true, + requestPathPrefix: "/dav", + }) + t.Cleanup(server.Close) + + client, err := NewClient(server.URL+"/dav/", testUser, testPass, TimeoutLow, "") + require.NoError(t, err) + + dirs, err := client.Directories("", true, MaxRequestDuration) + require.NoError(t, err) + assert.ElementsMatch(t, expected, dirs.Abs()) + }) +} + +func TestClient_DirectoriesDepthFallback_DeduplicatesEntries(t *testing.T) { + server := newTestWebDAVServerWithOptions(testWebDAVServerOptions{ + rejectInfinity: true, + duplicateDepthOne: true, + }) + t.Cleanup(server.Close) + + client, err := NewClient(server.URL+"/", "", "", TimeoutLow, "") + require.NoError(t, err) + + dirs, err := client.Directories("Photos", true, MaxRequestDuration) + require.NoError(t, err) + assert.ElementsMatch(t, []string{"/Photos", "/Photos/2020", "/Photos/2020/03", "/Photos/2021"}, dirs.Abs()) +} + +func TestClient_FilesExcludeHiddenEntries(t *testing.T) { + server := newTestWebDAVServer(false) + t.Cleanup(server.Close) + + client, err := NewClient(server.URL+"/", "", "", TimeoutLow, "") + require.NoError(t, err) + + t.Run("NonRecursive", func(t *testing.T) { + files, err := client.Files("Photos", false) + require.NoError(t, err) + require.Len(t, files, 1) + assert.Equal(t, "/Photos/cover.jpg", files[0].Abs) + }) + t.Run("Recursive", func(t *testing.T) { + files, err := client.Files("", true) + require.NoError(t, err) + + paths := files.Abs() + assert.Contains(t, paths, "/Photos/cover.jpg") + assert.NotContains(t, paths, "/.partial-upload") + assert.NotContains(t, paths, "/.locks/upload.tmp") + assert.NotContains(t, paths, "/Photos/.upload.part") + assert.NotContains(t, paths, "/Photos/.staging/incomplete.jpg") + }) +} + +func TestClient_OperationTimeouts(t *testing.T) { + server := newSlowWebDAVServer(200*time.Millisecond, false) + t.Cleanup(server.Close) + + client, err := NewClient(server.URL+"/", "", "", TimeoutLow, "") + require.NoError(t, err) + client.timeout = 25 * time.Millisecond + + t.Run("Mkdir", func(t *testing.T) { + err := client.Mkdir("slow-dir") + require.Error(t, err) + assert.True(t, strings.Contains(err.Error(), "Client.Timeout") || strings.Contains(err.Error(), "context deadline exceeded")) + }) + t.Run("Files", func(t *testing.T) { + _, err := client.Files("", false) + require.Error(t, err) + assert.True(t, strings.Contains(err.Error(), "Client.Timeout") || strings.Contains(err.Error(), "context deadline exceeded")) + }) + t.Run("Delete", func(t *testing.T) { + err := client.Delete("/slow.txt") + require.Error(t, err) + assert.True(t, strings.Contains(err.Error(), "Client.Timeout") || strings.Contains(err.Error(), "context deadline exceeded")) + }) +} + +func TestClient_TransferOperationsIgnoreServiceTimeout(t *testing.T) { + server := newSlowWebDAVServer(200*time.Millisecond, false) + t.Cleanup(server.Close) + + client, err := NewClient(server.URL+"/", "", "", TimeoutLow, "") + require.NoError(t, err) + client.timeout = 25 * time.Millisecond + + t.Run("Upload", func(t *testing.T) { + err := client.Upload(fs.Abs("testdata/example.jpg"), "slow-upload.jpg") + require.NoError(t, err) + }) + t.Run("Download", func(t *testing.T) { + dest := filepath.Join(t.TempDir(), "slow.txt") + err := client.Download("/slow.txt", dest, false) + require.NoError(t, err) + + //nolint:gosec // test reads back a file created in t.TempDir() + data, readErr := os.ReadFile(dest) + require.NoError(t, readErr) + assert.Equal(t, "test", string(data)) + }) +} + +func TestClient_TransferOperationsIgnoreSlowResponseHeaders(t *testing.T) { + server := newSlowWebDAVServer(200*time.Millisecond, true) + t.Cleanup(server.Close) + + client, err := NewClient(server.URL+"/", "", "", TimeoutLow, "") + require.NoError(t, err) + client.timeout = 25 * time.Millisecond + + t.Run("UploadResponseHeaders", func(t *testing.T) { + err := client.Upload(fs.Abs("testdata/example.jpg"), "slow-upload.jpg") + require.NoError(t, err) + }) + t.Run("DownloadResponseHeaders", func(t *testing.T) { + dest := filepath.Join(t.TempDir(), "slow.txt") + err := client.Download("/slow.txt", dest, false) + require.NoError(t, err) + assert.True(t, fs.FileExists(dest)) + }) +} + func TestClient_UploadAndDelete(t *testing.T) { c, err := NewClient(testUrl, testUser, testPass, TimeoutLow, "") @@ -211,3 +640,55 @@ func TestClient_DownloadDir(t *testing.T) { } }) } + +func TestClient_DownloadLimit(t *testing.T) { + const bodySize = 2048 + + server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + if r.Method != http.MethodGet { + http.Error(w, "method not allowed", http.StatusMethodNotAllowed) + return + } + w.WriteHeader(http.StatusOK) + //nolint:gosec // test fixture writes a locally generated payload only + _, _ = w.Write(make([]byte, bodySize)) + })) + t.Cleanup(server.Close) + + newClient := func(t *testing.T) *Client { + t.Helper() + c, err := NewClient(server.URL+"/", "", "", TimeoutLow, "") + require.NoError(t, err) + return c + } + + t.Run("OverLimitRejected", func(t *testing.T) { + client := newClient(t) + client.SetDownloadLimit(1024) + dest := filepath.Join(t.TempDir(), "big.bin") + err := client.Download("/big.bin", dest, false) + require.Error(t, err) + // The oversized partial file must not be left behind. + assert.False(t, fs.FileExists(dest)) + }) + t.Run("UnderLimitAccepted", func(t *testing.T) { + client := newClient(t) + client.SetDownloadLimit(4096) + dest := filepath.Join(t.TempDir(), "ok.bin") + err := client.Download("/ok.bin", dest, false) + require.NoError(t, err) + info, statErr := os.Stat(dest) + require.NoError(t, statErr) + assert.Equal(t, int64(bodySize), info.Size()) + }) + t.Run("ZeroLimitUnbounded", func(t *testing.T) { + client := newClient(t) + client.SetDownloadLimit(-1) + dest := filepath.Join(t.TempDir(), "unbounded.bin") + err := client.Download("/unbounded.bin", dest, false) + require.NoError(t, err) + info, statErr := os.Stat(dest) + require.NoError(t, statErr) + assert.Equal(t, int64(bodySize), info.Size()) + }) +} diff --git a/internal/service/webdav/path.go b/internal/service/webdav/path.go index 23e4b9e93..0b61e293e 100644 --- a/internal/service/webdav/path.go +++ b/internal/service/webdav/path.go @@ -5,6 +5,17 @@ import ( "strings" ) +// isHiddenPath reports whether any segment of a WebDAV path starts with a dot. +func isHiddenPath(dir string) bool { + for segment := range strings.SplitSeq(trimPath(dir), "/") { + if strings.HasPrefix(segment, ".") { + return true + } + } + + return false +} + func trimPath(dir string) string { if dir = strings.Trim(path.Clean(dir), "/"); dir != "." && dir != ".." { return dir diff --git a/internal/service/webdav/webdav.go b/internal/service/webdav/webdav.go index 067ccab35..952a41821 100644 --- a/internal/service/webdav/webdav.go +++ b/internal/service/webdav/webdav.go @@ -1,7 +1,11 @@ /* Package webdav provides WebDAV file sharing and synchronization. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +It includes the outbound client wrapper used by services and sync workers for +recursive directory discovery, uploads, downloads, and compatibility fallbacks +when remote servers reject recursive PROPFIND requests with "Depth: infinity". + +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +18,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. @@ -50,9 +54,21 @@ const ( //revive:disable-next-line:time-naming // keep exported constant name for API compatibility const Second = time.Second -// MaxRequestDuration is the maximum request duration e.g. for recursive retrieval of large remote directory structures. +// MaxRequestDuration is the maximum request duration for large recursive directory listings, including fallback traversal. const MaxRequestDuration = 30 * time.Minute +// transferConnectTimeout limits TCP connect time for upload and download requests without imposing a total transfer deadline. +const transferConnectTimeout = 30 * time.Second + +// transferTLSHandshakeTimeout limits TLS handshakes for upload and download requests. +const transferTLSHandshakeTimeout = 20 * time.Second + +// transferIdleConnTimeout limits how long pooled idle WebDAV connections are kept for transfer operations. +const transferIdleConnTimeout = 90 * time.Second + +// transferExpectContinueTimeout limits how long transfer requests wait for an initial 100-continue response. +const transferExpectContinueTimeout = 10 * time.Second + // Durations maps Timeout options to specific time durations. var Durations = map[Timeout]time.Duration{ TimeoutHigh: 120 * Second, diff --git a/internal/thumb/README.md b/internal/thumb/README.md index 46a84f19e..c55422f57 100644 --- a/internal/thumb/README.md +++ b/internal/thumb/README.md @@ -1,16 +1,18 @@ ## PhotoPrism — Thumbnails Package -**Last Updated:** March 3, 2026 +**Last Updated:** April 1, 2026 ### Overview -`internal/thumb` builds thumbnails with libvips, handling resize/crop options, color management, metadata stripping, and format export (JPEG/PNG). It is used by PhotoPrism’s workers and CLI to generate cached thumbs consistently. +`internal/thumb` builds thumbnails with libvips, handling resize/crop options, color management, metadata stripping, and format export (JPEG/PNG). It also contains bounded helper paths for reading trusted cached thumbs plus lightweight stdlib/x-image helpers for already-decoded in-memory images. ### Constraints - Uses libvips via govips; initialization is centralized in `VipsInit`. - Requires libvips 8.14+ with the current govips bindings (`github.com/davidbyttow/govips/v2`). - Works on files or in-memory buffers; writes outputs with `fs.ModeFile`. +- Generic Go `image.Decode()` / `image.DecodeConfig()` dispatch is intentionally not used for TIFF inputs. +- TIFF originals should be opened through libvips where possible; helper decode paths validate the TIFF header and first IFD offset before calling the direct TIFF decoder. - ICC handling: if a JPEG lacks an embedded profile but sets EXIF `InteroperabilityIndex` (`R03`/Adobe RGB, `R98`/sRGB, `THM`/thumbnail), we embed an Adobe-compatible profile; otherwise we leave color untouched. - Metadata is removed from outputs to keep thumbs small. @@ -30,6 +32,7 @@ - `vips.go` — main `Vips` entry: load, resize/crop, strip metadata, export. - `vips_icc.go` — EXIF InteroperabilityIndex handling and ICC embedding. - `icc.go` — lists bundled ICC filenames (`IccProfiles`) and `GetIccProfile` helper. +- `open.go`, `open_jpeg.go` — bounded file decode helpers for non-libvips paths, including explicit JPEG color handling and TIFF-safe dispatch via `pkg/fs`. - `resample.go`, `sizes.go` — resample options and predefined sizes. - `thumb.go` and helpers — naming, caching, file info. - Tests live alongside sources (`*_test.go`, fixtures under `testdata/`). @@ -69,13 +72,20 @@ - When adding ICC files, place them in `assets/profiles/icc/` and append to `IccProfiles`. - Comments for exported identifiers must start with the identifier name (Go style). +### Format Handling + +- Cached thumbnails are written as JPEG or PNG and may be reopened through bounded helper paths for crop, preview, and AI follow-up work. +- TIFF is intentionally excluded from generic Go decoder registration in this package and related callers so future code paths cannot reach the unsafe generic TIFF dispatch by accident. +- Already-decoded `image.Image` values are resized, cropped, rotated, and saved through stdlib plus `golang.org/x/image/draw` helpers so the package no longer depends on `github.com/disintegration/imaging`. +- HEIC/HEIF and AVIF originals are converted through `vipsConvert`, which uses libvips (via libheif) to load and export the image. Because libheif always applies ISOBMFF `irot`/`imir` container transforms during decode and the HEIF spec treats EXIF orientation as informational only (see `strukturag/libheif#227`), `vipsConvert` skips explicit EXIF-based rotation entirely for images loaded through `heifload`. Older Apple HEIC files without `irot` (e.g. iPhone 7) that carry EXIF orientation are non-conformant per the spec and are not auto-rotated by this path. + ### Go 1.26 JPEG Notes Go `1.26.0` replaced the standard `image/jpeg` encoder and decoder. This package primarily relies on libvips for thumbnail generation, but helper paths and tests that decode or encode JPEGs through Go libraries can observe behavior changes after toolchain upgrades. Observed impact during internal comparison runs (Go `1.25.4` vs `1.26.0`): -- **Compatibility** — No decode failures for 55/55 JPEG fixtures in `assets/examples` on either version. +- **Compatibility** — No decode failures for 55/55 JPEG fixtures in `assets/samples` on either version. - **Decoded Pixels** — All scanned JPEG fixtures produced different decoded pixel hashes across versions, even though dimensions were unchanged. - **Re-Encode Size** — Re-encoded JPEG sizes changed slightly in both directions; aggregate deltas were small (about `+0.014%` at default quality, about `+0.017%` at quality 95 in our fixture scan). - **Throughput** — Micro-benchmark runs showed modest improvements in decode and decode+encode throughput in Go `1.26.0`. diff --git a/internal/thumb/avatar/avatar.go b/internal/thumb/avatar/avatar.go index 0f17e5582..b698bd5ee 100644 --- a/internal/thumb/avatar/avatar.go +++ b/internal/thumb/avatar/avatar.go @@ -1,7 +1,7 @@ /* Package avatar provides helper functions to download and update avatar images. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. @@ -30,7 +30,6 @@ import ( _ "image/png" // register png decoder _ "golang.org/x/image/bmp" // register bmp decoder - _ "golang.org/x/image/tiff" // register tiff decoder _ "golang.org/x/image/webp" // register webp decoder "github.com/photoprism/photoprism/internal/event" diff --git a/internal/thumb/avatar/avatar_test.go b/internal/thumb/avatar/avatar_test.go index 1cc098cfe..c61be3dc3 100644 --- a/internal/thumb/avatar/avatar_test.go +++ b/internal/thumb/avatar/avatar_test.go @@ -12,7 +12,12 @@ import ( "github.com/photoprism/photoprism/pkg/fs" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) (code int) { log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) @@ -20,21 +25,19 @@ func TestMain(m *testing.M) { if err != nil { panic(err) } + defer os.RemoveAll(tempDir) c := config.NewMinimalTestConfigWithDb("avatar", tempDir) + defer c.CleanupTestFolder() + defer func() { + if err := c.CloseDb(); err != nil { + log.Warnf("close db: %v", err) + } + // Remove temporary SQLite files after running the tests. + fs.PurgeTestDbFiles(".", false) + }() get.SetConfig(c) photoprism.SetConfig(c) - code := m.Run() - - if err = c.CloseDb(); err != nil { - log.Warnf("close db: %v", err) - } - - _ = os.RemoveAll(tempDir) - - // Remove temporary SQLite files after running the tests. - fs.PurgeTestDbFiles(".", false) - - os.Exit(code) + return m.Run() } diff --git a/internal/thumb/color_test.go b/internal/thumb/color_test.go index b4017e1c5..8c501d2e9 100644 --- a/internal/thumb/color_test.go +++ b/internal/thumb/color_test.go @@ -13,10 +13,10 @@ func TestParseColor(t *testing.T) { assert.Equal(t, ColorPreserve, ParseColor(ColorSRGB, LibVips)) assert.Equal(t, ColorPreserve, ParseColor(ColorNone, LibVips)) }) - t.Run("Imaging", func(t *testing.T) { - assert.Equal(t, ColorNone, ParseColor("", LibImaging)) - assert.Equal(t, ColorSRGB, ParseColor(ColorAuto, LibImaging)) - assert.Equal(t, ColorSRGB, ParseColor(ColorSRGB, LibImaging)) - assert.Equal(t, ColorNone, ParseColor(ColorNone, LibImaging)) + t.Run("LegacyImagingFallback", func(t *testing.T) { + assert.Equal(t, ColorNone, ParseColor("", "imaging")) + assert.Equal(t, ColorSRGB, ParseColor(ColorAuto, "imaging")) + assert.Equal(t, ColorSRGB, ParseColor(ColorSRGB, "imaging")) + assert.Equal(t, ColorNone, ParseColor(ColorNone, "imaging")) }) } diff --git a/internal/thumb/config.go b/internal/thumb/config.go index 6f1451979..17a3c8918 100644 --- a/internal/thumb/config.go +++ b/internal/thumb/config.go @@ -6,13 +6,13 @@ import ( // Package configuration variables. var ( - Library = LibImaging // Image processing library to be used. + Library = LibVips // Image processing library to be used. Color = ColorAuto // Color sets the standard color profile for thumbnails. Filter = ResampleLanczos // Filter specifies the default downscaling filter. SizeCached = SizeFit1920.Width // Pre-generated thumbnail size limit. - SizeOnDemand = SizeFit5120.Width // On-demand thumbnail size limit. + SizeOnDemand = SizeFit7680.Width // On-demand thumbnail size limit. JpegQualityDefault = QualityMedium // JpegQualityDefault sets the compression level of newly created JPEGs. CachePublic = false // Specifies if static content may be cached by a CDN or caching proxy. - ExamplesPath = fs.Abs("../../assets/examples") + SamplesPath = fs.Abs("../../assets/samples") IccProfilesPath = fs.Abs("../../assets/profiles/icc") ) diff --git a/internal/thumb/config_test.go b/internal/thumb/config_test.go index 887d2cf40..a018f8c7e 100644 --- a/internal/thumb/config_test.go +++ b/internal/thumb/config_test.go @@ -9,13 +9,13 @@ import ( ) func TestConfig(t *testing.T) { - t.Run("ExamplesPath", func(t *testing.T) { - t.Logf("examples-path: %s", ExamplesPath) - assert.Equal(t, fs.Abs("../../assets/examples"), ExamplesPath) - assert.True(t, fs.PathExists(ExamplesPath)) + t.Run("SamplesPath", func(t *testing.T) { + t.Logf("samples-path: %s", SamplesPath) + assert.Equal(t, fs.Abs("../../assets/samples"), SamplesPath) + assert.True(t, fs.PathExists(SamplesPath)) }) t.Run("IccProfilesPath", func(t *testing.T) { - t.Logf("icc-profiles-path: %s", ExamplesPath) + t.Logf("icc-profiles-path: %s", SamplesPath) assert.Equal(t, fs.Abs("../../assets/profiles/icc"), IccProfilesPath) // assert.True(t, fs.PathExists(IccProfilesPath)) }) diff --git a/internal/thumb/create.go b/internal/thumb/create.go index 59fdd1fe9..5ed82d906 100644 --- a/internal/thumb/create.go +++ b/internal/thumb/create.go @@ -4,12 +4,9 @@ import ( "errors" "fmt" "image" - "image/png" "path" "path/filepath" - "github.com/disintegration/imaging" - "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" ) @@ -134,15 +131,7 @@ func Create(img image.Image, fileName string, width, height int, opts ...Resampl result = Resample(img, width, height, opts...) - var quality imaging.EncodeOption - - if fs.FileType(fileName) == fs.ImagePng { - quality = imaging.PNGCompressionLevel(png.DefaultCompression) - } else { - quality = JpegQuality(width, height).EncodeOption() - } - - err = imaging.Save(result, fileName, quality) + err = Save(result, fileName, JpegQuality(width, height)) if err != nil { log.Debugf("thumb: failed to save %s", clean.Log(filepath.Base(fileName))) diff --git a/internal/thumb/create_test.go b/internal/thumb/create_test.go index 7c986998c..475c8a452 100644 --- a/internal/thumb/create_test.go +++ b/internal/thumb/create_test.go @@ -6,7 +6,6 @@ import ( "strings" "testing" - "github.com/disintegration/imaging" "github.com/stretchr/testify/assert" "github.com/photoprism/photoprism/pkg/fs" @@ -17,21 +16,21 @@ func TestResampleOptions(t *testing.T) { method, filter, format := ResampleOptions(ResamplePng, ResampleFillCenter, ResampleDefault) assert.Equal(t, ResampleFillCenter, method) - assert.Equal(t, imaging.Lanczos.Support, filter.Imaging().Support) + assert.Equal(t, ResampleLanczos, filter) assert.Equal(t, fs.ImagePng, format) }) t.Run("ResampleNearestNeighborFillTopLeft", func(t *testing.T) { method, filter, format := ResampleOptions(ResampleNearestNeighbor, ResampleFillTopLeft) assert.Equal(t, ResampleFillTopLeft, method) - assert.Equal(t, imaging.NearestNeighbor.Support, filter.Imaging().Support) + assert.Equal(t, ResampleNearest, filter) assert.Equal(t, fs.ImageJpeg, format) }) t.Run("ResampleNearestNeighborFillBottomRight", func(t *testing.T) { method, filter, format := ResampleOptions(ResampleNearestNeighbor, ResampleFillBottomRight) assert.Equal(t, ResampleFillBottomRight, method) - assert.Equal(t, imaging.NearestNeighbor.Support, filter.Imaging().Support) + assert.Equal(t, ResampleNearest, filter) assert.Equal(t, fs.ImageJpeg, format) }) } @@ -44,7 +43,7 @@ func TestResample(t *testing.T) { assert.FileExists(t, src) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) @@ -69,7 +68,7 @@ func TestResample(t *testing.T) { assert.FileExists(t, src) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) @@ -94,7 +93,7 @@ func TestResample(t *testing.T) { assert.FileExists(t, src) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) @@ -119,7 +118,7 @@ func TestResample(t *testing.T) { assert.FileExists(t, src) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) @@ -406,7 +405,7 @@ func TestCreate(t *testing.T) { assert.FileExists(t, src) assert.NoFileExists(t, dst) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) @@ -443,7 +442,7 @@ func TestCreate(t *testing.T) { assert.FileExists(t, src) assert.NoFileExists(t, dst) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) @@ -480,7 +479,7 @@ func TestCreate(t *testing.T) { assert.FileExists(t, src) assert.NoFileExists(t, dst) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) @@ -507,7 +506,7 @@ func TestCreate(t *testing.T) { assert.FileExists(t, src) assert.NoFileExists(t, dst) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) diff --git a/internal/thumb/crop/crop.go b/internal/thumb/crop/crop.go index 06e8aba1d..551df51fb 100644 --- a/internal/thumb/crop/crop.go +++ b/internal/thumb/crop/crop.go @@ -1,7 +1,7 @@ /* Package crop provides image crop data structures and helpers. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/thumb/crop/image.go b/internal/thumb/crop/image.go index 3601c1aa5..dba62d452 100644 --- a/internal/thumb/crop/image.go +++ b/internal/thumb/crop/image.go @@ -1,16 +1,13 @@ package crop import ( - "bytes" "fmt" "image" - "os" + "image/draw" "path" "path/filepath" "strings" - "github.com/disintegration/imaging" - "github.com/photoprism/photoprism/internal/thumb" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" @@ -25,6 +22,7 @@ var thumbFileNames = []string{ "%s_4096x4096_fit.jpg", "%s_5120x5120_fit.jpg", "%s_7680x4320_fit.jpg", + "%s_15360x8640_fit.jpg", } // Suitable thumb file sizes. @@ -36,6 +34,7 @@ var thumbFileSizes = []thumb.Size{ thumb.Sizes[thumb.Fit4096], thumb.Sizes[thumb.Fit5120], thumb.Sizes[thumb.Fit7680], + thumb.Sizes[thumb.Fit15360], } // ImageFromThumb returns a cropped area from an existing thumbnail image. @@ -58,7 +57,7 @@ func ImageFromThumb(thumbName string, area Area, size Size, cache bool) (img ima // Cached? if !fs.FileExists(cropName) { // Do nothing. - } else if cropImg, cropErr := imaging.Open(cropName); cropErr != nil { + } else if cropImg, _, cropErr := fs.DecodeImageFile(cropName); cropErr != nil { log.Errorf("crop: failed loading %s", filepath.Base(cropName)) } else { return cropImg, cropName, nil @@ -79,14 +78,14 @@ func ImageFromThumb(thumbName string, area Area, size Size, cache bool) (img ima } // Crop area from image. - img = imaging.Crop(img, image.Rect(posMin.X, posMin.Y, posMax.X, posMax.Y)) + img = imageCrop(img, image.Rect(posMin.X, posMin.Y, posMax.X, posMax.Y)) // Resample crop area. img = thumb.Resample(img, size.Width, size.Height, size.Options...) // Cache crop image? if cache { - if err = imaging.Save(img, cropName); err != nil { + if err = thumb.Save(img, cropName); err != nil { log.Errorf("crop: failed caching %s", filepath.Base(cropName)) } else { log.Debugf("crop: saved %s", filepath.Base(cropName)) @@ -177,20 +176,28 @@ func openIdealThumbFile(fileName, hash string, area Area, size Size) (result ima if len(hash) != 40 || area.W <= 0 || size.Width <= 0 { // Not a standard thumb name with sha1 hash prefix. - if imageBuffer, err := os.ReadFile(fileName); err != nil { //nolint:gosec // file path comes from resolved thumbnails - return nil, err - } else { - return imaging.Decode(bytes.NewReader(imageBuffer), imaging.AutoOrientation(true)) - } + result, _, err = fs.DecodeImageFile(fileName) + return result, err } if name := findIdealThumbFileName(hash, area.FileWidth(size), filepath.Dir(fileName)); name != "" { fileName = name } - if imageBuffer, err := os.ReadFile(fileName); err != nil { //nolint:gosec // file path comes from resolved thumbnails - return nil, err - } else { - return imaging.Decode(bytes.NewReader(imageBuffer)) - } + result, _, err = fs.DecodeImageFile(fileName) + return result, err +} + +// imageCrop returns a copy of the requested crop rectangle. +func imageCrop(img image.Image, rect image.Rectangle) image.Image { + rect = rect.Intersect(img.Bounds()) + + if rect.Dx() <= 0 || rect.Dy() <= 0 { + return image.NewNRGBA(image.Rect(0, 0, 0, 0)) + } + + cropped := image.NewNRGBA(image.Rect(0, 0, rect.Dx(), rect.Dy())) + draw.Draw(cropped, cropped.Bounds(), img, rect.Min, draw.Src) + + return cropped } diff --git a/internal/thumb/crop/image_test.go b/internal/thumb/crop/image_test.go index 683cdb3ef..9a20c4430 100644 --- a/internal/thumb/crop/image_test.go +++ b/internal/thumb/crop/image_test.go @@ -1,10 +1,14 @@ package crop import ( + "path/filepath" "strings" "testing" "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/internal/thumb" + "github.com/photoprism/photoprism/pkg/fs" ) func TestThumbFileName(t *testing.T) { @@ -114,3 +118,32 @@ func TestFindIdealThumbFileName(t *testing.T) { assert.True(t, strings.HasSuffix(r, "testdata/b/c/c/bccfeaa526a36e19b555fd4ca5e8f767d5604289_720x720_fit.jpg"), r) }) } + +func TestImageFromThumb(t *testing.T) { + t.Run("Layered16BitTiffThumbnail", func(t *testing.T) { + prevLibrary := thumb.Library + thumb.Library = thumb.LibVips + t.Cleanup(func() { + thumb.Library = prevLibrary + }) + + cachePath := t.TempDir() + src := fs.Abs("../../../assets/samples/layered-16bit-small.tif") + fit720 := thumb.Sizes[thumb.Fit720] + + thumbName, err := thumb.FromFile(src, "bccfeaa526a36e19b555fd4ca5e8f767d5604289", cachePath, fit720.Width, fit720.Height, thumb.OrientationNormal, fit720.Options...) + if err != nil { + t.Fatal(err) + } + + img, cropName, err := ImageFromThumb(thumbName, NewArea("crop", 0, 0, 1, 1), Sizes[Tile50], false) + if err != nil { + t.Fatal(err) + } + + assert.NotEmpty(t, cropName) + assert.Equal(t, filepath.Join(filepath.Dir(thumbName), "bccfeaa526a36e19b555fd4ca5e8f767d5604289_50x50_crop_0000003e83e8.jpg"), cropName) + assert.Equal(t, 50, img.Bounds().Dx()) + assert.Equal(t, 50, img.Bounds().Dy()) + }) +} diff --git a/internal/thumb/crop/request.go b/internal/thumb/crop/request.go index bf90380dd..93abccf1c 100644 --- a/internal/thumb/crop/request.go +++ b/internal/thumb/crop/request.go @@ -1,14 +1,10 @@ package crop import ( - "bytes" "fmt" "image" - "os" "path/filepath" - "github.com/disintegration/imaging" - "github.com/photoprism/photoprism/internal/thumb" "github.com/photoprism/photoprism/pkg/fs" ) @@ -31,13 +27,7 @@ func FromRequest(hash, area string, size Size, thumbPath string) (fileName strin cropBase := fmt.Sprintf("%s_%dx%d_crop_%s%s", hash, size.Width, size.Height, area, fs.ExtJpeg) cropName := filepath.Join(filepath.Dir(thumbName), cropBase) - imageBuffer, err := os.ReadFile(thumbName) //nolint:gosec // thumbName resolved from validated cache path - - if err != nil { - return "", err - } - - img, err := imaging.Decode(bytes.NewReader(imageBuffer)) + img, _, err := fs.DecodeImageFile(thumbName) if err != nil { return "", err @@ -51,13 +41,13 @@ func FromRequest(hash, area string, size Size, thumbPath string) (fileName strin } // Crop area from image. - img = imaging.Crop(img, image.Rect(min.X, min.Y, max.X, max.Y)) + img = imageCrop(img, image.Rect(min.X, min.Y, max.X, max.Y)) // Resample crop area. img = thumb.Resample(img, size.Width, size.Height, size.Options...) // Save crop image. - if err := imaging.Save(img, cropName); err != nil { + if err := thumb.Save(img, cropName); err != nil { log.Errorf("failed saving %s - no permission or disk full?", filepath.Base(cropName)) log.Debug(err.Error()) } else { diff --git a/internal/thumb/fileinfo.go b/internal/thumb/fileinfo.go index bd0b0540b..158e0c296 100644 --- a/internal/thumb/fileinfo.go +++ b/internal/thumb/fileinfo.go @@ -6,7 +6,6 @@ import ( _ "image/gif" // register GIF decoder for config reads _ "image/jpeg" // register JPEG decoder for config reads _ "image/png" // register PNG decoder for config reads - "os" "runtime/debug" _ "golang.org/x/image/bmp" // register BMP decoder for config reads @@ -29,24 +28,8 @@ func FileInfo(fileName string) (info image.Config, err error) { return info, err } - file, err := os.Open(fileName) //nolint:gosec // fileName is resolved path provided by caller; reading images is expected - - if err != nil || file == nil { - return info, err - } - - defer file.Close() - - // Reset file offset. - // see https://github.com/golang/go/issues/45902#issuecomment-1007953723 - _, err = file.Seek(0, 0) - - if err != nil { - return info, fmt.Errorf("%s on seek", err) - } - - // Decode image config (dimensions). - info, _, err = image.DecodeConfig(file) + // Decode image config (dimensions) with a reader bounded to the file size. + info, _, err = fs.DecodeImageConfigFile(fileName) if err != nil { return info, fmt.Errorf("%s while decoding file info", err) diff --git a/internal/thumb/fileinfo_test.go b/internal/thumb/fileinfo_test.go index 89e1afbea..333242e75 100644 --- a/internal/thumb/fileinfo_test.go +++ b/internal/thumb/fileinfo_test.go @@ -1,9 +1,12 @@ package thumb import ( + "os" + "path/filepath" "testing" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" "github.com/photoprism/photoprism/pkg/fs" ) @@ -59,4 +62,13 @@ func TestFileInfo(t *testing.T) { assert.Equal(t, 67, fileInfo.Height) } }) + t.Run("MalformedTiffIfdOffset", func(t *testing.T) { + fileName := filepath.Join(t.TempDir(), "evil.tiff") + payload := []byte{0x49, 0x49, 0x2a, 0x00, 0xff, 0xff, 0xff, 0xff} + require.NoError(t, os.WriteFile(fileName, payload, fs.ModeFile)) + + _, err := FileInfo(fileName) + + require.Error(t, err) + }) } diff --git a/internal/thumb/filter.go b/internal/thumb/filter.go index 26b4dc694..d36c4ff96 100644 --- a/internal/thumb/filter.go +++ b/internal/thumb/filter.go @@ -2,7 +2,6 @@ package thumb import ( "github.com/davidbyttow/govips/v2/vips" - "github.com/disintegration/imaging" "github.com/photoprism/photoprism/pkg/clean" ) @@ -25,24 +24,6 @@ func (a ResampleFilter) String() string { return string(a) } -// Imaging returns the downscaling filter for use with the "imaging" library. -func (a ResampleFilter) Imaging() imaging.ResampleFilter { - switch a { - case ResampleBlackman: - return imaging.Blackman - case ResampleLanczos, ResampleAuto: - return imaging.Lanczos - case ResampleCubic: - return imaging.CatmullRom - case ResampleLinear: - return imaging.Linear - case ResampleNearest: - return imaging.NearestNeighbor - default: - return imaging.Lanczos - } -} - // Vips returns the downscaling filter for use with the "govips" library. func (a ResampleFilter) Vips() vips.Kernel { switch a { diff --git a/internal/thumb/filter_test.go b/internal/thumb/filter_test.go index 2c7e76a18..a6178e99c 100644 --- a/internal/thumb/filter_test.go +++ b/internal/thumb/filter_test.go @@ -17,14 +17,14 @@ func TestParseFilter(t *testing.T) { assert.Equal(t, ResampleAuto, ParseFilter("linear", LibVips)) assert.Equal(t, ResampleAuto, ParseFilter("invalid", LibVips)) }) - t.Run("Imaging", func(t *testing.T) { - assert.Equal(t, ResampleLanczos, ParseFilter("", LibImaging)) - assert.Equal(t, ResampleLanczos, ParseFilter("auto", LibImaging)) - assert.Equal(t, ResampleBlackman, ParseFilter("blackman", LibImaging)) - assert.Equal(t, ResampleLanczos, ParseFilter("lanczos", LibImaging)) - assert.Equal(t, ResampleCubic, ParseFilter("cubic", LibImaging)) - assert.Equal(t, ResampleLinear, ParseFilter("linear", LibImaging)) - assert.Equal(t, ResampleLanczos, ParseFilter("invalid", LibImaging)) + t.Run("LegacyImagingFallback", func(t *testing.T) { + assert.Equal(t, ResampleLanczos, ParseFilter("", "imaging")) + assert.Equal(t, ResampleLanczos, ParseFilter("auto", "imaging")) + assert.Equal(t, ResampleBlackman, ParseFilter("blackman", "imaging")) + assert.Equal(t, ResampleLanczos, ParseFilter("lanczos", "imaging")) + assert.Equal(t, ResampleCubic, ParseFilter("cubic", "imaging")) + assert.Equal(t, ResampleLinear, ParseFilter("linear", "imaging")) + assert.Equal(t, ResampleLanczos, ParseFilter("invalid", "imaging")) }) } diff --git a/internal/thumb/fit.go b/internal/thumb/fit.go index e7320fcc9..f5495df17 100644 --- a/internal/thumb/fit.go +++ b/internal/thumb/fit.go @@ -5,6 +5,7 @@ import "image" // FitSizes contains "fit" cropped thumbnail sizes from largest to smallest. // Best for the viewer as proportional resizing maintains the aspect ratio. var FitSizes = SizeList{ + Sizes[Fit15360], Sizes[Fit7680], Sizes[Fit5120], Sizes[Fit4096], diff --git a/internal/thumb/fit_test.go b/internal/thumb/fit_test.go index ed55aaf79..ac19630c5 100644 --- a/internal/thumb/fit_test.go +++ b/internal/thumb/fit_test.go @@ -3,9 +3,9 @@ package thumb import ( "testing" - "github.com/disintegration/imaging" - "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/pkg/fs" ) func TestFit(t *testing.T) { @@ -19,7 +19,9 @@ func TestFit(t *testing.T) { assert.Equal(t, Sizes[Fit4096], Fit(2300, 2000)) assert.Equal(t, Sizes[Fit5120], Fit(5000, 2000)) assert.Equal(t, Sizes[Fit7680], Fit(6020, 2000)) - assert.Equal(t, Sizes[Fit7680], Fit(8000, 8000)) + assert.Equal(t, Sizes[Fit15360], Fit(8000, 8000)) + assert.Equal(t, Sizes[Fit15360], Fit(15520, 7760)) + assert.Equal(t, Sizes[Fit15360], Fit(20000, 20000)) } func TestFitBounds(t *testing.T) { @@ -28,7 +30,7 @@ func TestFitBounds(t *testing.T) { assert.FileExists(t, src) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) @@ -48,7 +50,7 @@ func TestFitBounds(t *testing.T) { assert.FileExists(t, src) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) @@ -68,7 +70,7 @@ func TestFitBounds(t *testing.T) { assert.FileExists(t, src) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) diff --git a/internal/thumb/frame/collage.go b/internal/thumb/frame/collage.go index 94077d711..35fe355c4 100644 --- a/internal/thumb/frame/collage.go +++ b/internal/thumb/frame/collage.go @@ -5,8 +5,6 @@ import ( "image" "image/color" - "github.com/disintegration/imaging" - "github.com/photoprism/photoprism/pkg/clean" ) @@ -18,7 +16,7 @@ func Collage(t Type, images []image.Image) (collage image.Image, err error) { width := 1600 height := 900 - collage = imaging.New(width, height, CollageBackground) + collage = newCanvas(width, height, CollageBackground) if len(images) == 0 { return collage, nil @@ -42,13 +40,13 @@ func polaroidCollage(collage image.Image, images []image.Image) (image.Image, er if framed, err := polaroid(images[0], RandomAngle(20)); err != nil { return collage, err } else { - collage = imaging.Overlay(collage, framed, image.Pt(50, -80), 1) + collage = overlayImage(collage, framed, image.Pt(50, -80)) } if framed, err := polaroid(images[1], RandomAngle(20)); err != nil { return collage, err } else { - collage = imaging.Overlay(collage, framed, image.Pt(500, -30), 1) + collage = overlayImage(collage, framed, image.Pt(500, -30)) } } else { dl := 1500 / n @@ -63,13 +61,13 @@ func polaroidCollage(collage image.Image, images []image.Image) (image.Image, er return collage, err } - collage = imaging.Overlay(collage, framed, RandomPoint(850-i*dl, -150-((i%2)*50), 950-i*dr, 125-((i%2)*125)), 1) + collage = overlayImage(collage, framed, RandomPoint(850-i*dl, -150-((i%2)*50), 950-i*dr, 125-((i%2)*125))) } if framed, err := polaroid(images[0], RandomAngle(15)); err != nil { return collage, err } else { - collage = imaging.Overlay(collage, framed, image.Pt(275, -50), 1) + collage = overlayImage(collage, framed, image.Pt(275, -50)) } } diff --git a/internal/thumb/frame/collage_test.go b/internal/thumb/frame/collage_test.go index a4f6b858e..d538ca8c0 100644 --- a/internal/thumb/frame/collage_test.go +++ b/internal/thumb/frame/collage_test.go @@ -5,8 +5,7 @@ import ( "os" "testing" - "github.com/disintegration/imaging" - + "github.com/photoprism/photoprism/internal/thumb" "github.com/photoprism/photoprism/pkg/fs" "github.com/photoprism/photoprism/pkg/http/header" @@ -17,7 +16,7 @@ func TestCollage(t *testing.T) { t.Run("Polaroid", func(t *testing.T) { var images []image.Image - img, err := imaging.Open("testdata/500x500.jpg") + img, _, err := fs.DecodeImageFile("testdata/500x500.jpg") assert.NoError(t, err) for i := 0; i <= 5; i++ { @@ -29,7 +28,7 @@ func TestCollage(t *testing.T) { assert.NoError(t, err) - err = imaging.Save(preview, saveName) + err = thumb.Save(preview, saveName) assert.NoError(t, err) mimeType, _ := fs.DetectMimeType(saveName) @@ -40,7 +39,7 @@ func TestCollage(t *testing.T) { t.Run("Two", func(t *testing.T) { var images []image.Image - img, err := imaging.Open("testdata/500x500.jpg") + img, _, err := fs.DecodeImageFile("testdata/500x500.jpg") assert.NoError(t, err) for i := 0; i <= 1; i++ { @@ -52,7 +51,7 @@ func TestCollage(t *testing.T) { assert.NoError(t, err) - err = imaging.Save(preview, saveName) + err = thumb.Save(preview, saveName) assert.NoError(t, err) mimeType, _ := fs.DetectMimeType(saveName) @@ -68,7 +67,7 @@ func TestCollage(t *testing.T) { assert.NoError(t, err) - err = imaging.Save(preview, saveName) + err = thumb.Save(preview, saveName) assert.NoError(t, err) mimeType, _ := fs.DetectMimeType(saveName) @@ -79,7 +78,7 @@ func TestCollage(t *testing.T) { t.Run("UnknownCollageType", func(t *testing.T) { var images []image.Image - img, err := imaging.Open("testdata/500x500.jpg") + img, _, err := fs.DecodeImageFile("testdata/500x500.jpg") assert.NoError(t, err) for i := 0; i <= 5; i++ { @@ -93,7 +92,7 @@ func TestCollage(t *testing.T) { assert.Error(t, err) assert.Equal(t, "unknown collage type Unknown", err.Error()) - err = imaging.Save(preview, saveName) + err = thumb.Save(preview, saveName) assert.NoError(t, err) diff --git a/internal/thumb/frame/frame.go b/internal/thumb/frame/frame.go index 236f13156..df82ead7e 100644 --- a/internal/thumb/frame/frame.go +++ b/internal/thumb/frame/frame.go @@ -1,7 +1,7 @@ /* Package frame provides helper functions to embed images into frames. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/internal/thumb/frame/image_ops.go b/internal/thumb/frame/image_ops.go new file mode 100644 index 000000000..8e6f49fe2 --- /dev/null +++ b/internal/thumb/frame/image_ops.go @@ -0,0 +1,109 @@ +package frame + +import ( + "image" + "image/color" + "image/draw" + "math" +) + +// cloneImage normalizes an image to an origin-based NRGBA image. +func cloneImage(img image.Image) *image.NRGBA { + bounds := img.Bounds() + clone := image.NewNRGBA(image.Rect(0, 0, bounds.Dx(), bounds.Dy())) + draw.Draw(clone, clone.Bounds(), img, bounds.Min, draw.Src) + return clone +} + +// newCanvas allocates a solid-color NRGBA canvas. +func newCanvas(width, height int, fill color.Color) *image.NRGBA { + canvas := image.NewNRGBA(image.Rect(0, 0, width, height)) + draw.Draw(canvas, canvas.Bounds(), &image.Uniform{C: fill}, image.Point{}, draw.Src) + return canvas +} + +// overlayImage composites one image over another at the requested position. +func overlayImage(base image.Image, overlay image.Image, position image.Point) image.Image { + dst := cloneImage(base) + rect := image.Rectangle{Min: position, Max: position.Add(overlay.Bounds().Size())} + draw.Draw(dst, rect, overlay, overlay.Bounds().Min, draw.Over) + return dst +} + +// rotateImage rotates an image by an arbitrary angle using bilinear sampling. +func rotateImage(img image.Image, angle float64, background color.NRGBA) image.Image { + if angle == 0 { + return cloneImage(img) + } + + src := cloneImage(img) + width := src.Bounds().Dx() + height := src.Bounds().Dy() + + radians := angle * math.Pi / 180 + sin, cos := math.Sincos(radians) + dstWidth := int(math.Ceil(math.Abs(float64(width)*cos) + math.Abs(float64(height)*sin))) + dstHeight := int(math.Ceil(math.Abs(float64(width)*sin) + math.Abs(float64(height)*cos))) + dst := newCanvas(dstWidth, dstHeight, background) + + srcCX := float64(width-1) / 2 + srcCY := float64(height-1) / 2 + dstCX := float64(dstWidth-1) / 2 + dstCY := float64(dstHeight-1) / 2 + + for y := 0; y < dstHeight; y++ { + for x := 0; x < dstWidth; x++ { + dx := float64(x) - dstCX + dy := float64(y) - dstCY + srcX := cos*dx + sin*dy + srcCX + srcY := -sin*dx + cos*dy + srcCY + + if srcX < 0 || srcX > float64(width-1) || srcY < 0 || srcY > float64(height-1) { + continue + } + + dst.SetNRGBA(x, y, sampleNRGBA(src, srcX, srcY)) + } + } + + return dst +} + +// sampleNRGBA bilinearly samples a pixel from an NRGBA image. +func sampleNRGBA(src *image.NRGBA, x, y float64) color.NRGBA { + x0 := int(math.Floor(x)) + y0 := int(math.Floor(y)) + x1 := minInt(x0+1, src.Bounds().Dx()-1) + y1 := minInt(y0+1, src.Bounds().Dy()-1) + tx := x - float64(x0) + ty := y - float64(y0) + + c00 := src.NRGBAAt(x0, y0) + c10 := src.NRGBAAt(x1, y0) + c01 := src.NRGBAAt(x0, y1) + c11 := src.NRGBAAt(x1, y1) + + return color.NRGBA{ + R: interpolateChannel(c00.R, c10.R, c01.R, c11.R, tx, ty), + G: interpolateChannel(c00.G, c10.G, c01.G, c11.G, tx, ty), + B: interpolateChannel(c00.B, c10.B, c01.B, c11.B, tx, ty), + A: interpolateChannel(c00.A, c10.A, c01.A, c11.A, tx, ty), + } +} + +// interpolateChannel bilinearly interpolates a single 8-bit channel. +func interpolateChannel(c00, c10, c01, c11 uint8, tx, ty float64) uint8 { + top := (1-tx)*float64(c00) + tx*float64(c10) + bottom := (1-tx)*float64(c01) + tx*float64(c11) + value := (1-ty)*top + ty*bottom + return uint8(math.Round(value)) +} + +// minInt returns the smaller of two ints. +func minInt(a, b int) int { + if a < b { + return a + } + + return b +} diff --git a/internal/thumb/frame/image_test.go b/internal/thumb/frame/image_test.go index 5125810b9..08db686fb 100644 --- a/internal/thumb/frame/image_test.go +++ b/internal/thumb/frame/image_test.go @@ -4,8 +4,7 @@ import ( "os" "testing" - "github.com/disintegration/imaging" - + "github.com/photoprism/photoprism/internal/thumb" "github.com/photoprism/photoprism/pkg/fs" "github.com/photoprism/photoprism/pkg/http/header" @@ -14,7 +13,7 @@ import ( func TestImage(t *testing.T) { t.Run("Polaroid", func(t *testing.T) { - img, err := imaging.Open("testdata/500x500.jpg") + img, _, err := fs.DecodeImageFile("testdata/500x500.jpg") assert.NoError(t, err) saveName := "testdata/test-image.png" @@ -23,7 +22,7 @@ func TestImage(t *testing.T) { assert.NoError(t, err) - err = imaging.Save(out, saveName) + err = thumb.Save(out, saveName) assert.NoError(t, err) mimeType, _ := fs.DetectMimeType(saveName) @@ -32,7 +31,7 @@ func TestImage(t *testing.T) { _ = os.Remove(saveName) }) t.Run("TypeUnknown", func(t *testing.T) { - img, err := imaging.Open("testdata/500x500.jpg") + img, _, err := fs.DecodeImageFile("testdata/500x500.jpg") assert.NoError(t, err) saveName := "testdata/test-image.png" @@ -42,7 +41,7 @@ func TestImage(t *testing.T) { assert.Error(t, err) assert.Equal(t, "unknown collage type unknown", err.Error()) - err = imaging.Save(out, saveName) + err = thumb.Save(out, saveName) assert.NoError(t, err) mimeType, _ := fs.DetectMimeType(saveName) diff --git a/internal/thumb/frame/polaroid.go b/internal/thumb/frame/polaroid.go index 52b55a2ee..4bf7e64d0 100644 --- a/internal/thumb/frame/polaroid.go +++ b/internal/thumb/frame/polaroid.go @@ -5,8 +5,7 @@ import ( _ "embed" "image" "image/color" - - "github.com/disintegration/imaging" + "image/png" ) //go:embed polaroid.png @@ -15,18 +14,18 @@ var polaroidPng []byte // Polaroid embeds the specified image file into a Polaroid frame and returns the resulting image. func polaroid(img image.Image, rotate float64) (image.Image, error) { // Create image frame. - frm, err := imaging.Decode(bytes.NewReader(polaroidPng)) + frm, err := png.Decode(bytes.NewReader(polaroidPng)) if err != nil { return nil, err } // Paste image into frame. - out := imaging.Paste(frm, img, image.Pt(200, 152)) + out := overlayImage(frm, img, image.Pt(200, 152)) // Rotate image before returning it? if rotate != 0.0 { - out = imaging.Rotate(out, rotate, color.NRGBA{255, 255, 255, 0}) + out = rotateImage(out, rotate, color.NRGBA{255, 255, 255, 0}) } return out, nil diff --git a/internal/thumb/frame/polaroid_test.go b/internal/thumb/frame/polaroid_test.go index 5303fc4f8..8568b39b5 100644 --- a/internal/thumb/frame/polaroid_test.go +++ b/internal/thumb/frame/polaroid_test.go @@ -4,8 +4,7 @@ import ( "os" "testing" - "github.com/disintegration/imaging" - + "github.com/photoprism/photoprism/internal/thumb" "github.com/photoprism/photoprism/pkg/fs" "github.com/photoprism/photoprism/pkg/http/header" @@ -14,7 +13,7 @@ import ( func TestPolaroid(t *testing.T) { t.Run("RandomAngle", func(t *testing.T) { - img, err := imaging.Open("testdata/500x500.jpg") + img, _, err := fs.DecodeImageFile("testdata/500x500.jpg") assert.NoError(t, err) saveName := "testdata/test-polaroid.png" @@ -23,7 +22,7 @@ func TestPolaroid(t *testing.T) { assert.NoError(t, err) - err = imaging.Save(out, saveName) + err = thumb.Save(out, saveName) assert.NoError(t, err) mimeType, _ := fs.DetectMimeType(saveName) diff --git a/internal/thumb/generator.go b/internal/thumb/generator.go index cc0bf94c2..6508fbb8e 100644 --- a/internal/thumb/generator.go +++ b/internal/thumb/generator.go @@ -5,7 +5,6 @@ type Lib = string // Supported image processing libraries. const ( - LibAuto Lib = "auto" - LibVips Lib = "vips" - LibImaging Lib = "imaging" + LibAuto Lib = "auto" + LibVips Lib = "vips" ) diff --git a/internal/thumb/image_ops.go b/internal/thumb/image_ops.go new file mode 100644 index 000000000..cc8724cd0 --- /dev/null +++ b/internal/thumb/image_ops.go @@ -0,0 +1,242 @@ +package thumb + +import ( + "fmt" + "image" + "image/draw" + "image/jpeg" + "image/png" + "math" + "os" + "path/filepath" + + xdraw "golang.org/x/image/draw" + + "github.com/photoprism/photoprism/pkg/fs" +) + +// Save writes an image to disk using the file extension to choose the encoder. +func Save(img image.Image, fileName string, quality ...Quality) error { + if img == nil { + return fmt.Errorf("thumb: image is nil") + } + + dirName := filepath.Dir(fileName) + baseName := filepath.Base(fileName) + fileQuality := JpegQualityDefault + + if len(quality) > 0 && quality[0] > 0 { + fileQuality = quality[0] + } + + tmpFile, err := os.CreateTemp(dirName, "."+baseName+".tmp-*") + if err != nil { + return err + } + + tmpName := tmpFile.Name() + renamed := false + + defer func() { + _ = tmpFile.Close() + + if !renamed { + _ = os.Remove(tmpName) + } + }() + + if err = tmpFile.Chmod(fs.ModeFile); err != nil { + return err + } + + if err = encodeImageFile(tmpFile, img, fileName, fileQuality); err != nil { + return err + } + + if err = tmpFile.Close(); err != nil { + return err + } + + if err = os.Rename(tmpName, fileName); err != nil { + return err + } + + renamed = true + + return nil +} + +// encodeImageFile writes an image to an open file using the correct encoder for the destination type. +func encodeImageFile(file *os.File, img image.Image, fileName string, quality Quality) error { + switch fs.FileType(fileName) { + case fs.ImagePng: + return encodePNG(file, img) + default: + return encodeJPEG(file, img, quality) + } +} + +// encodePNG writes an image as PNG. +func encodePNG(file *os.File, img image.Image) error { + encoder := png.Encoder{CompressionLevel: png.DefaultCompression} + return encoder.Encode(file, img) +} + +// encodeJPEG writes an image as JPEG. +func encodeJPEG(file *os.File, img image.Image, quality Quality) error { + return jpeg.Encode(file, img, &jpeg.Options{Quality: quality.Int()}) +} + +// cloneImage normalizes an image to an origin-based NRGBA image. +func cloneImage(img image.Image) *image.NRGBA { + bounds := img.Bounds() + clone := image.NewNRGBA(image.Rect(0, 0, bounds.Dx(), bounds.Dy())) + draw.Draw(clone, clone.Bounds(), img, bounds.Min, draw.Src) + return clone +} + +// cropImage returns a cropped copy of the requested rectangle. +func cropImage(img image.Image, rect image.Rectangle) image.Image { + rect = rect.Intersect(img.Bounds()) + + if rect.Dx() <= 0 || rect.Dy() <= 0 { + return image.NewNRGBA(image.Rect(0, 0, 0, 0)) + } + + cropped := image.NewNRGBA(image.Rect(0, 0, rect.Dx(), rect.Dy())) + draw.Draw(cropped, cropped.Bounds(), img, rect.Min, draw.Src) + + return cropped +} + +// resizeImage rescales an image to the requested size, preserving aspect ratio when one dimension is zero. +func resizeImage(img image.Image, width, height int, filter ResampleFilter) image.Image { + bounds := img.Bounds() + srcWidth := bounds.Dx() + srcHeight := bounds.Dy() + + if srcWidth <= 0 || srcHeight <= 0 { + return image.NewNRGBA(image.Rect(0, 0, 0, 0)) + } + + width, height = normalizeResizeTarget(srcWidth, srcHeight, width, height) + + if width <= 0 || height <= 0 { + return cloneImage(img) + } + + if width == srcWidth && height == srcHeight { + return cloneImage(img) + } + + dst := image.NewNRGBA(image.Rect(0, 0, width, height)) + resampleScaler(filter).Scale(dst, dst.Bounds(), img, bounds, draw.Src, nil) + + return dst +} + +// fitImage rescales an image to fit inside the requested bounds without cropping. +func fitImage(img image.Image, width, height int, filter ResampleFilter) image.Image { + bounds := img.Bounds() + srcWidth := bounds.Dx() + srcHeight := bounds.Dy() + + if srcWidth <= 0 || srcHeight <= 0 || width <= 0 || height <= 0 { + return cloneImage(img) + } + + scale := math.Min(float64(width)/float64(srcWidth), float64(height)/float64(srcHeight)) + scale = math.Min(scale, 1) + + if scale <= 0 { + return cloneImage(img) + } + + targetWidth := maxInt(1, int(float64(srcWidth)*scale)) + targetHeight := maxInt(1, int(float64(srcHeight)*scale)) + + return resizeImage(img, targetWidth, targetHeight, filter) +} + +// fillImage rescales an image to cover the requested bounds and then crops it. +func fillImage(img image.Image, width, height int, filter ResampleFilter, anchor cropAnchor) image.Image { + bounds := img.Bounds() + srcWidth := bounds.Dx() + srcHeight := bounds.Dy() + + if srcWidth <= 0 || srcHeight <= 0 || width <= 0 || height <= 0 { + return cloneImage(img) + } + + scale := math.Max(float64(width)/float64(srcWidth), float64(height)/float64(srcHeight)) + + if scale <= 0 { + return cloneImage(img) + } + + targetWidth := maxInt(width, int(math.Ceil(float64(srcWidth)*scale))) + targetHeight := maxInt(height, int(math.Ceil(float64(srcHeight)*scale))) + resized := resizeImage(img, targetWidth, targetHeight, filter) + left, top := anchorOffset(resized.Bounds().Dx(), resized.Bounds().Dy(), width, height, anchor) + + return cropImage(resized, image.Rect(left, top, left+width, top+height)) +} + +// normalizeResizeTarget derives the missing resize dimension when only one target edge is provided. +func normalizeResizeTarget(srcWidth, srcHeight, width, height int) (int, int) { + switch { + case width <= 0 && height <= 0: + return srcWidth, srcHeight + case width <= 0: + width = maxInt(1, int(math.Round(float64(srcWidth)*float64(height)/float64(srcHeight)))) + case height <= 0: + height = maxInt(1, int(math.Round(float64(srcHeight)*float64(width)/float64(srcWidth)))) + } + + return width, height +} + +// resampleScaler maps configured filters to x/image scalers for in-memory fallback work. +func resampleScaler(filter ResampleFilter) xdraw.Scaler { + switch filter { + case ResampleLinear: + return xdraw.ApproxBiLinear + case ResampleNearest: + return xdraw.NearestNeighbor + default: + return xdraw.CatmullRom + } +} + +// cropAnchor defines how Fill-style crops are aligned after resizing. +type cropAnchor int + +const ( + // cropAnchorCenter keeps the crop centered on both axes. + cropAnchorCenter cropAnchor = iota + // cropAnchorTopLeft keeps the crop pinned to the top-left corner. + cropAnchorTopLeft + // cropAnchorBottomRight keeps the crop pinned to the bottom-right corner. + cropAnchorBottomRight +) + +// anchorOffset calculates the crop origin for the requested anchor. +func anchorOffset(srcWidth, srcHeight, width, height int, anchor cropAnchor) (left, top int) { + switch anchor { + case cropAnchorTopLeft: + return 0, 0 + case cropAnchorBottomRight: + return maxInt(0, srcWidth-width), maxInt(0, srcHeight-height) + default: + return maxInt(0, (srcWidth-width)/2), maxInt(0, (srcHeight-height)/2) + } +} + +// maxInt returns the larger of two ints. +func maxInt(a, b int) int { + if a > b { + return a + } + + return b +} diff --git a/internal/thumb/image_ops_test.go b/internal/thumb/image_ops_test.go new file mode 100644 index 000000000..17e526bd4 --- /dev/null +++ b/internal/thumb/image_ops_test.go @@ -0,0 +1,205 @@ +package thumb + +import ( + "image" + "image/color" + "os" + "path/filepath" + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/pkg/fs" +) + +func TestSave(t *testing.T) { + t.Run("JPEG", func(t *testing.T) { + dst := filepath.Join(t.TempDir(), "test.jpg") + img := image.NewNRGBA(image.Rect(0, 0, 10, 10)) + + err := Save(img, dst) + require.NoError(t, err) + assert.FileExists(t, dst) + + // Verify it's a valid JPEG. + mime := fs.MimeType(dst) + assert.Equal(t, "image/jpeg", mime) + }) + t.Run("PNG", func(t *testing.T) { + dst := filepath.Join(t.TempDir(), "test.png") + img := image.NewNRGBA(image.Rect(0, 0, 10, 10)) + + err := Save(img, dst) + require.NoError(t, err) + assert.FileExists(t, dst) + + mime := fs.MimeType(dst) + assert.Equal(t, "image/png", mime) + }) + t.Run("NilImage", func(t *testing.T) { + dst := filepath.Join(t.TempDir(), "test.jpg") + err := Save(nil, dst) + assert.Error(t, err) + assert.NoFileExists(t, dst) + }) + t.Run("InvalidDir", func(t *testing.T) { + err := Save(image.NewNRGBA(image.Rect(0, 0, 1, 1)), "/nonexistent/dir/test.jpg") + assert.Error(t, err) + }) + t.Run("NoPartialFileOnEncodeSuccess", func(t *testing.T) { + dir := t.TempDir() + dst := filepath.Join(dir, "output.jpg") + img := image.NewNRGBA(image.Rect(0, 0, 2, 2)) + + require.NoError(t, Save(img, dst)) + assert.FileExists(t, dst) + + // No temp files should remain. + entries, _ := os.ReadDir(dir) + assert.Equal(t, 1, len(entries), "only the final file should remain") + }) +} + +func TestCloneImage(t *testing.T) { + t.Run("NonOriginBounds", func(t *testing.T) { + // SubImage returns an image with non-zero Min. + src := image.NewNRGBA(image.Rect(0, 0, 10, 10)) + src.SetNRGBA(5, 5, color.NRGBA{R: 200, A: 255}) + sub := src.SubImage(image.Rect(5, 5, 10, 10)) + + clone := cloneImage(sub) + assert.Equal(t, 0, clone.Bounds().Min.X) + assert.Equal(t, 0, clone.Bounds().Min.Y) + assert.Equal(t, 5, clone.Bounds().Dx()) + assert.Equal(t, 5, clone.Bounds().Dy()) + + // Verify pixel was preserved. + r, _, _, _ := clone.At(0, 0).RGBA() + assert.Equal(t, uint32(200<<8|200), r) + }) +} + +func TestResizeImage(t *testing.T) { + t.Run("ZeroSource", func(t *testing.T) { + src := image.NewNRGBA(image.Rect(0, 0, 0, 0)) + result := resizeImage(src, 100, 100, ResampleLanczos) + assert.Equal(t, 0, result.Bounds().Dx()) + assert.Equal(t, 0, result.Bounds().Dy()) + }) + t.Run("IdentitySize", func(t *testing.T) { + src := image.NewNRGBA(image.Rect(0, 0, 50, 50)) + result := resizeImage(src, 50, 50, ResampleLanczos) + assert.Equal(t, 50, result.Bounds().Dx()) + assert.Equal(t, 50, result.Bounds().Dy()) + }) + t.Run("Downscale", func(t *testing.T) { + src := image.NewNRGBA(image.Rect(0, 0, 100, 200)) + result := resizeImage(src, 50, 100, ResampleLanczos) + assert.Equal(t, 50, result.Bounds().Dx()) + assert.Equal(t, 100, result.Bounds().Dy()) + }) + t.Run("WidthZeroPreservesRatio", func(t *testing.T) { + src := image.NewNRGBA(image.Rect(0, 0, 100, 200)) + result := resizeImage(src, 0, 100, ResampleLanczos) + assert.Equal(t, 50, result.Bounds().Dx()) + assert.Equal(t, 100, result.Bounds().Dy()) + }) + t.Run("HeightZeroPreservesRatio", func(t *testing.T) { + src := image.NewNRGBA(image.Rect(0, 0, 100, 200)) + result := resizeImage(src, 50, 0, ResampleLanczos) + assert.Equal(t, 50, result.Bounds().Dx()) + assert.Equal(t, 100, result.Bounds().Dy()) + }) + t.Run("BothZeroReturnsClone", func(t *testing.T) { + src := image.NewNRGBA(image.Rect(0, 0, 100, 200)) + result := resizeImage(src, 0, 0, ResampleLanczos) + assert.Equal(t, 100, result.Bounds().Dx()) + assert.Equal(t, 200, result.Bounds().Dy()) + }) +} + +func TestFitImage(t *testing.T) { + t.Run("FitLarger", func(t *testing.T) { + src := image.NewNRGBA(image.Rect(0, 0, 100, 200)) + result := fitImage(src, 50, 200, ResampleLanczos) + // Scale limited by width: 50/100 = 0.5, so 100*0.5 = 50, 200*0.5 = 100. + assert.Equal(t, 50, result.Bounds().Dx()) + assert.Equal(t, 100, result.Bounds().Dy()) + }) + t.Run("NoUpscale", func(t *testing.T) { + src := image.NewNRGBA(image.Rect(0, 0, 50, 50)) + result := fitImage(src, 200, 200, ResampleLanczos) + // fitImage caps scale at 1.0, so image stays at 50x50. + assert.Equal(t, 50, result.Bounds().Dx()) + assert.Equal(t, 50, result.Bounds().Dy()) + }) + t.Run("ZeroDimension", func(t *testing.T) { + src := image.NewNRGBA(image.Rect(0, 0, 50, 50)) + result := fitImage(src, 0, 100, ResampleLanczos) + // Returns clone when width is 0. + assert.Equal(t, 50, result.Bounds().Dx()) + assert.Equal(t, 50, result.Bounds().Dy()) + }) +} + +func TestFillImage(t *testing.T) { + t.Run("Center", func(t *testing.T) { + src := image.NewNRGBA(image.Rect(0, 0, 100, 200)) + result := fillImage(src, 50, 50, ResampleLanczos, cropAnchorCenter) + assert.Equal(t, 50, result.Bounds().Dx()) + assert.Equal(t, 50, result.Bounds().Dy()) + }) + t.Run("TopLeft", func(t *testing.T) { + src := image.NewNRGBA(image.Rect(0, 0, 100, 200)) + result := fillImage(src, 50, 50, ResampleLanczos, cropAnchorTopLeft) + assert.Equal(t, 50, result.Bounds().Dx()) + assert.Equal(t, 50, result.Bounds().Dy()) + }) + t.Run("BottomRight", func(t *testing.T) { + src := image.NewNRGBA(image.Rect(0, 0, 100, 200)) + result := fillImage(src, 50, 50, ResampleLanczos, cropAnchorBottomRight) + assert.Equal(t, 50, result.Bounds().Dx()) + assert.Equal(t, 50, result.Bounds().Dy()) + }) + t.Run("ZeroDimension", func(t *testing.T) { + src := image.NewNRGBA(image.Rect(0, 0, 50, 50)) + result := fillImage(src, 0, 50, ResampleLanczos, cropAnchorCenter) + assert.Equal(t, 50, result.Bounds().Dx()) + assert.Equal(t, 50, result.Bounds().Dy()) + }) +} + +func TestCropImage(t *testing.T) { + t.Run("ValidRegion", func(t *testing.T) { + src := image.NewNRGBA(image.Rect(0, 0, 100, 100)) + result := cropImage(src, image.Rect(10, 10, 50, 50)) + assert.Equal(t, 40, result.Bounds().Dx()) + assert.Equal(t, 40, result.Bounds().Dy()) + }) + t.Run("OutOfBounds", func(t *testing.T) { + src := image.NewNRGBA(image.Rect(0, 0, 10, 10)) + result := cropImage(src, image.Rect(20, 20, 30, 30)) + // No overlap — returns empty image. + assert.Equal(t, 0, result.Bounds().Dx()) + assert.Equal(t, 0, result.Bounds().Dy()) + }) + t.Run("PartialOverlap", func(t *testing.T) { + src := image.NewNRGBA(image.Rect(0, 0, 10, 10)) + result := cropImage(src, image.Rect(5, 5, 20, 20)) + assert.Equal(t, 5, result.Bounds().Dx()) + assert.Equal(t, 5, result.Bounds().Dy()) + }) +} + +func TestResampleScaler(t *testing.T) { + t.Run("Linear", func(t *testing.T) { + assert.NotNil(t, resampleScaler(ResampleLinear)) + }) + t.Run("Nearest", func(t *testing.T) { + assert.NotNil(t, resampleScaler(ResampleNearest)) + }) + t.Run("DefaultCatmullRom", func(t *testing.T) { + assert.NotNil(t, resampleScaler(ResampleLanczos)) + }) +} diff --git a/internal/thumb/init.go b/internal/thumb/init.go index 778172ace..7db3e823b 100644 --- a/internal/thumb/init.go +++ b/internal/thumb/init.go @@ -63,7 +63,7 @@ func Init(availableMemory uint64, maxWorkers int, imgLib string) { Library = LibVips log.Debugf("vips: max cache size is %d MB, using up to %s", MaxCacheMem/MiB, english.Plural(NumWorkers, "worker", "workers")) default: - Library = LibImaging + Library = LibVips } } diff --git a/internal/thumb/init_test.go b/internal/thumb/init_test.go index f023c388d..a5acd6b58 100644 --- a/internal/thumb/init_test.go +++ b/internal/thumb/init_test.go @@ -33,11 +33,11 @@ func TestInit(t *testing.T) { assert.Equal(t, 1, NumWorkers) assert.Equal(t, LibVips, Library) }) - t.Run("LibImaging", func(t *testing.T) { - Init(memory.FreeMemory(), runtime.NumCPU(), LibImaging) + t.Run("LegacyLibImagingFallsBackToVips", func(t *testing.T) { + Init(memory.FreeMemory(), runtime.NumCPU(), "imaging") assert.GreaterOrEqual(t, MaxCacheMem, 64*MiB) assert.GreaterOrEqual(t, NumWorkers, 1) - assert.Equal(t, LibImaging, Library) + assert.Equal(t, LibVips, Library) }) t.Run("Dynamic", func(t *testing.T) { Init(memory.FreeMemory(), runtime.NumCPU(), LibVips) @@ -46,9 +46,3 @@ func TestInit(t *testing.T) { assert.Equal(t, LibVips, Library) }) } - -func TestShutdown_NoPanic(t *testing.T) { - // Call Shutdown twice to cover both not-started and already-reset states. - Shutdown() - Shutdown() -} diff --git a/internal/thumb/jpeg.go b/internal/thumb/jpeg.go index 317bea021..e9f725c2a 100644 --- a/internal/thumb/jpeg.go +++ b/internal/thumb/jpeg.go @@ -6,8 +6,6 @@ import ( "path/filepath" "runtime/debug" - "github.com/disintegration/imaging" - "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" ) @@ -27,29 +25,12 @@ func Jpeg(srcFile, jpgFile string, orientation int) (img image.Image, err error) return img, err } - // Open source image. - img, err = imaging.Open(srcFile) - - // Failed? + img, err = vipsConvert(srcFile, jpgFile, orientation) if err != nil { log.Debugf("jpeg: failed to open %s", clean.Log(filepath.Base(srcFile))) return img, err } - // Adjust orientation. - if orientation > 1 { - img = Rotate(img, orientation) - } - - // Get JPEG quality setting. - quality := JpegQualityDefault.EncodeOption() - - // Save JPEG file. - if err = imaging.Save(img, jpgFile, quality); err != nil { - log.Errorf("jpeg: failed to save %s", clean.Log(filepath.Base(jpgFile))) - return img, err - } - // Return JPEG image. return img, nil } diff --git a/internal/thumb/jpeg_test.go b/internal/thumb/jpeg_test.go index 43df302c6..c5f2f7bb7 100644 --- a/internal/thumb/jpeg_test.go +++ b/internal/thumb/jpeg_test.go @@ -2,9 +2,11 @@ package thumb import ( "os" + "path/filepath" "testing" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" "github.com/photoprism/photoprism/pkg/fs" ) @@ -251,4 +253,40 @@ func TestJpeg(t *testing.T) { assert.Error(t, err) }) + t.Run("MalformedTiffIfdOffset", func(t *testing.T) { + src := filepath.Join(t.TempDir(), "evil.tiff") + dst := filepath.Join(t.TempDir(), "evil.jpg") + payload := []byte{0x49, 0x49, 0x2a, 0x00, 0xff, 0xff, 0xff, 0xff} + require.NoError(t, os.WriteFile(src, payload, fs.ModeFile)) + + img, err := Jpeg(src, dst, OrientationNormal) + + assert.NoFileExists(t, dst) + assert.Nil(t, img) + assert.Error(t, err) + }) + t.Run("MalformedBigEndianTiffIfdOffset", func(t *testing.T) { + src := filepath.Join(t.TempDir(), "evil-mm.tiff") + dst := filepath.Join(t.TempDir(), "evil-mm.jpg") + payload := []byte{0x4d, 0x4d, 0x00, 0x2a, 0xff, 0xff, 0xff, 0xff} + require.NoError(t, os.WriteFile(src, payload, fs.ModeFile)) + + img, err := Jpeg(src, dst, OrientationNormal) + + assert.NoFileExists(t, dst) + assert.Nil(t, img) + assert.Error(t, err) + }) + t.Run("TruncatedTiffBody", func(t *testing.T) { + src := filepath.Join(t.TempDir(), "truncated.tiff") + dst := filepath.Join(t.TempDir(), "truncated.jpg") + payload := []byte{0x49, 0x49, 0x2a, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00} + require.NoError(t, os.WriteFile(src, payload, fs.ModeFile)) + + img, err := Jpeg(src, dst, OrientationNormal) + + assert.NoFileExists(t, dst) + assert.Nil(t, img) + require.Error(t, err) + }) } diff --git a/internal/thumb/jpegxl.go b/internal/thumb/jpegxl.go new file mode 100644 index 000000000..16a1207c7 --- /dev/null +++ b/internal/thumb/jpegxl.go @@ -0,0 +1,25 @@ +package thumb + +import ( + "sync" + + "github.com/davidbyttow/govips/v2/vips" +) + +var ( + jpegXLOnce sync.Once + jpegXLSupported bool +) + +// JpegXLSupported reports whether the libvips runtime can decode JPEG XL images. +// The result is probed once and cached, since libvips capabilities are fixed for the +// lifetime of the process. Support depends on the libvips build including the JXL +// module (libjxl); when it is missing, callers fall back to the external "djxl" decoder. +func JpegXLSupported() bool { + jpegXLOnce.Do(func() { + VipsInit() + jpegXLSupported = vips.IsTypeSupported(vips.ImageTypeJXL) + }) + + return jpegXLSupported +} diff --git a/internal/thumb/jpegxl_test.go b/internal/thumb/jpegxl_test.go new file mode 100644 index 000000000..8799670e9 --- /dev/null +++ b/internal/thumb/jpegxl_test.go @@ -0,0 +1,31 @@ +package thumb + +import ( + "path/filepath" + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func TestJpegXLSupported(t *testing.T) { + // The development and CI runtime ships libvips with the JXL module (libjxl). + assert.True(t, JpegXLSupported()) +} + +func TestJpeg_JpegXL(t *testing.T) { + if !JpegXLSupported() { + t.Skip("libvips was built without JPEG XL support") + } + + src := filepath.Join(SamplesPath, "dice.jxl") + dst := filepath.Join(t.TempDir(), "dice.jxl.jpg") + + img, err := Jpeg(src, dst, OrientationNormal) + require.NoError(t, err) + require.NotNil(t, img) + + assert.FileExists(t, dst) + assert.Greater(t, img.Bounds().Max.X, 0) + assert.Greater(t, img.Bounds().Max.Y, 0) +} diff --git a/internal/thumb/memsize_test.go b/internal/thumb/memsize_test.go index cb2e53c11..dd5a3f085 100644 --- a/internal/thumb/memsize_test.go +++ b/internal/thumb/memsize_test.go @@ -5,8 +5,9 @@ import ( "image/color" "testing" - "github.com/disintegration/imaging" "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/pkg/fs" ) func TestMemSize(t *testing.T) { @@ -14,7 +15,7 @@ func TestMemSize(t *testing.T) { assert.FileExists(t, src) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) diff --git a/internal/thumb/names.go b/internal/thumb/names.go index 479ebcfc5..123706bd8 100644 --- a/internal/thumb/names.go +++ b/internal/thumb/names.go @@ -45,10 +45,12 @@ const ( Fit4096 Name = "fit_4096" Fit5120 Name = "fit_5120" Fit7680 Name = "fit_7680" + Fit15360 Name = "fit_15360" ) // Names contains all default size names. var Names = []Name{ + Fit15360, Fit7680, Fit5120, Fit4096, diff --git a/internal/thumb/open.go b/internal/thumb/open.go index 83a0e5fd9..899dce844 100644 --- a/internal/thumb/open.go +++ b/internal/thumb/open.go @@ -4,12 +4,10 @@ import ( "fmt" "image" - "github.com/disintegration/imaging" - "github.com/photoprism/photoprism/pkg/fs" ) -// Open loads an image from disk, rotates it, and converts the color profile if necessary. +// Open loads a natively supported image file from disk, rotates it, and converts the color profile if necessary. func Open(fileName string, orientation int) (result image.Image, err error) { // Filename missing? if fileName == "" { @@ -26,8 +24,8 @@ func Open(fileName string, orientation int) (result image.Image, err error) { return OpenJpeg(fileName, orientation) } - // Open file with imaging function. - img, err := imaging.Open(fileName) + // Open file with a reader bounded to the actual file size. + img, _, err := fs.DecodeImageFile(fileName) if err != nil { return result, err diff --git a/internal/thumb/open_jpeg.go b/internal/thumb/open_jpeg.go index 294f298ef..b3d0181e6 100644 --- a/internal/thumb/open_jpeg.go +++ b/internal/thumb/open_jpeg.go @@ -3,11 +3,11 @@ package thumb import ( "fmt" "image" + "image/jpeg" "io" "os" "path/filepath" - "github.com/disintegration/imaging" "github.com/mandykoh/prism/meta" "github.com/mandykoh/prism/meta/autometa" @@ -21,7 +21,7 @@ func decodeImage(reader io.ReadSeeker, logName string) (metaData *meta.Data, img metaData, imgReader, err := autometa.Load(reader) if err == nil { - img, err = imaging.Decode(imgReader) + img, err = jpeg.Decode(imgReader) return metaData, img, err } @@ -35,7 +35,7 @@ func decodeImage(reader io.ReadSeeker, logName string) (metaData *meta.Data, img } // Decode image file. - img, err = imaging.Decode(reader) + img, err = jpeg.Decode(reader) return metaData, img, err } diff --git a/internal/thumb/open_test.go b/internal/thumb/open_test.go index 7e86d02ee..7c123d808 100644 --- a/internal/thumb/open_test.go +++ b/internal/thumb/open_test.go @@ -1,7 +1,14 @@ package thumb import ( + "os" + "path/filepath" "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/photoprism/photoprism/pkg/fs" ) func TestOpen(t *testing.T) { @@ -55,4 +62,28 @@ func TestOpen(t *testing.T) { t.Error("img must not be nil") } }) + t.Run("Layered16BitTiff", func(t *testing.T) { + img, err := Open(fs.Abs("../../assets/samples/layered-16bit-small.tif"), 0) + require.NoError(t, err) + require.NotNil(t, img) + assert.Equal(t, 236, img.Bounds().Dx()) + assert.Equal(t, 158, img.Bounds().Dy()) + }) + t.Run("TiffExplicitOrientation", func(t *testing.T) { + img, err := Open(fs.Abs("../photoprism/testdata/rotate/6.tiff"), OrientationRotate90) + require.NoError(t, err) + require.NotNil(t, img) + assert.Equal(t, 43, img.Bounds().Dx()) + assert.Equal(t, 65, img.Bounds().Dy()) + }) + t.Run("MalformedTiffIfdOffset", func(t *testing.T) { + fileName := filepath.Join(t.TempDir(), "evil.tiff") + payload := []byte{0x49, 0x49, 0x2a, 0x00, 0xff, 0xff, 0xff, 0xff} + require.NoError(t, os.WriteFile(fileName, payload, fs.ModeFile)) + + img, err := Open(fileName, 0) + + require.Error(t, err) + require.Nil(t, img) + }) } diff --git a/internal/thumb/options.go b/internal/thumb/options.go index cd51c527b..f829669ac 100644 --- a/internal/thumb/options.go +++ b/internal/thumb/options.go @@ -16,6 +16,7 @@ const ( ResampleNearestNeighbor ResampleDefault ResamplePng + ResampleStripICC ) // ResampleMethods maps resample options to their string identifiers. diff --git a/internal/thumb/png.go b/internal/thumb/png.go index 929da8247..f7d402d29 100644 --- a/internal/thumb/png.go +++ b/internal/thumb/png.go @@ -3,12 +3,9 @@ package thumb import ( "fmt" "image" - "image/png" "path/filepath" "runtime/debug" - "github.com/disintegration/imaging" - "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" ) @@ -28,26 +25,12 @@ func Png(srcFile, pngFile string, orientation int) (img image.Image, err error) return img, err } - // Open source image. - img, err = imaging.Open(srcFile) - - // Failed? + img, err = vipsConvert(srcFile, pngFile, orientation) if err != nil { log.Debugf("png: failed to open %s", clean.Log(filepath.Base(srcFile))) return img, err } - // Adjust orientation. - if orientation > 1 { - img = Rotate(img, orientation) - } - - // Save PNG file. - if err = imaging.Save(img, pngFile, imaging.PNGCompressionLevel(png.BestCompression)); err != nil { - log.Errorf("png: failed to save %s", clean.Log(filepath.Base(pngFile))) - return img, err - } - // Return PNG image. return img, nil } diff --git a/internal/thumb/png_test.go b/internal/thumb/png_test.go index 86310f00e..1f96d4823 100644 --- a/internal/thumb/png_test.go +++ b/internal/thumb/png_test.go @@ -2,9 +2,11 @@ package thumb import ( "os" + "path/filepath" "testing" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" "github.com/photoprism/photoprism/pkg/fs" ) @@ -251,4 +253,55 @@ func TestPng(t *testing.T) { assert.Error(t, err) }) + t.Run("MalformedTiffIfdOffset", func(t *testing.T) { + src := filepath.Join(t.TempDir(), "evil.tiff") + dst := filepath.Join(t.TempDir(), "evil.png") + payload := []byte{0x49, 0x49, 0x2a, 0x00, 0xff, 0xff, 0xff, 0xff} + require.NoError(t, os.WriteFile(src, payload, fs.ModeFile)) + + img, err := Png(src, dst, OrientationNormal) + + assert.NoFileExists(t, dst) + assert.Nil(t, img) + assert.Error(t, err) + }) + t.Run("MalformedBigEndianTiffIfdOffset", func(t *testing.T) { + src := filepath.Join(t.TempDir(), "evil-mm.tiff") + dst := filepath.Join(t.TempDir(), "evil-mm.png") + payload := []byte{0x4d, 0x4d, 0x00, 0x2a, 0xff, 0xff, 0xff, 0xff} + require.NoError(t, os.WriteFile(src, payload, fs.ModeFile)) + + img, err := Png(src, dst, OrientationNormal) + + assert.NoFileExists(t, dst) + assert.Nil(t, img) + assert.Error(t, err) + }) + t.Run("TruncatedTiffBody", func(t *testing.T) { + src := filepath.Join(t.TempDir(), "truncated.tiff") + dst := filepath.Join(t.TempDir(), "truncated.png") + payload := []byte{0x49, 0x49, 0x2a, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00} + require.NoError(t, os.WriteFile(src, payload, fs.ModeFile)) + + img, err := Png(src, dst, OrientationNormal) + + assert.NoFileExists(t, dst) + assert.Nil(t, img) + require.Error(t, err) + }) + t.Run("BadIccProfileSurvivesPngConversion", func(t *testing.T) { + // The vipsConvert PNG path (used for vector → PNG and other + // format conversions) must recover when libpng rejects a malformed + // iCCP chunk by retrying without the broken profile. + src := "testdata/icc_profile_bad_length.jpg" + dst := filepath.Join(t.TempDir(), "icc_profile_bad_length.jpg.png") + + img, err := Png(src, dst, OrientationNormal) + + if err != nil { + t.Fatal(err) + } + assert.FileExists(t, dst) + assert.NotNil(t, img) + }) } diff --git a/internal/thumb/quality.go b/internal/thumb/quality.go index 9937bf73d..89cdc8d96 100644 --- a/internal/thumb/quality.go +++ b/internal/thumb/quality.go @@ -4,8 +4,6 @@ import ( "strconv" "strings" - "github.com/disintegration/imaging" - "github.com/photoprism/photoprism/pkg/txt" ) @@ -22,11 +20,6 @@ const ( // Quality represents a JPEG image quality. type Quality int -// EncodeOption returns the quality as imaging.EncodeOption. -func (q Quality) EncodeOption() imaging.EncodeOption { - return imaging.JPEGQuality(int(q)) -} - // String returns the quality as string. func (q Quality) String() string { return strconv.Itoa(int(q)) diff --git a/internal/thumb/resample.go b/internal/thumb/resample.go index 62594d739..2000cbc91 100644 --- a/internal/thumb/resample.go +++ b/internal/thumb/resample.go @@ -2,28 +2,24 @@ package thumb import ( "image" - - "github.com/disintegration/imaging" ) // Resample downscales an image and returns it. func Resample(img image.Image, width, height int, opts ...ResampleOption) image.Image { - var resImg image.Image - method, filter, _ := ResampleOptions(opts...) switch method { case ResampleFit: - resImg = imaging.Fit(img, width, height, filter.Imaging()) + return fitImage(img, width, height, filter) case ResampleFillCenter: - resImg = imaging.Fill(img, width, height, imaging.Center, filter.Imaging()) + return fillImage(img, width, height, filter, cropAnchorCenter) case ResampleFillTopLeft: - resImg = imaging.Fill(img, width, height, imaging.TopLeft, filter.Imaging()) + return fillImage(img, width, height, filter, cropAnchorTopLeft) case ResampleFillBottomRight: - resImg = imaging.Fill(img, width, height, imaging.BottomRight, filter.Imaging()) + return fillImage(img, width, height, filter, cropAnchorBottomRight) case ResampleResize: - resImg = imaging.Resize(img, width, height, filter.Imaging()) + return resizeImage(img, width, height, filter) + default: + return cloneImage(img) } - - return resImg } diff --git a/internal/thumb/rotate.go b/internal/thumb/rotate.go index 3bf477f24..44731634c 100644 --- a/internal/thumb/rotate.go +++ b/internal/thumb/rotate.go @@ -2,8 +2,7 @@ package thumb import ( "image" - - "github.com/disintegration/imaging" + "image/color" ) // EXIF orientation values. @@ -21,28 +20,146 @@ const ( // Rotate rotates an image based on the Exif orientation. func Rotate(img image.Image, o int) image.Image { + src := cloneImage(img) + switch o { case OrientationUnspecified: - // Do nothing. + return src case OrientationNormal: - // Do nothing. + return src case OrientationFlipH: - img = imaging.FlipH(img) + return flipImageHorizontal(src) case OrientationFlipV: - img = imaging.FlipV(img) + return flipImageVertical(src) case OrientationRotate90: - img = imaging.Rotate90(img) + return rotateImage90(src) case OrientationRotate180: - img = imaging.Rotate180(img) + return rotateImage180(src) case OrientationRotate270: - img = imaging.Rotate270(img) + return rotateImage270(src) case OrientationTranspose: - img = imaging.Transpose(img) + return transposeImage(src) case OrientationTransverse: - img = imaging.Transverse(img) + return transverseImage(src) default: log.Debugf("thumb: invalid orientation %d (rotate)", o) + return src + } +} + +// flipImageHorizontal mirrors an image along the vertical axis. +func flipImageHorizontal(src *image.NRGBA) image.Image { + bounds := src.Bounds() + width := bounds.Dx() + height := bounds.Dy() + dst := image.NewNRGBA(image.Rect(0, 0, width, height)) + + for y := 0; y < height; y++ { + for x := 0; x < width; x++ { + setPixel(dst, width-1-x, y, src.NRGBAAt(x, y)) + } } - return img + return dst +} + +// flipImageVertical mirrors an image along the horizontal axis. +func flipImageVertical(src *image.NRGBA) image.Image { + bounds := src.Bounds() + width := bounds.Dx() + height := bounds.Dy() + dst := image.NewNRGBA(image.Rect(0, 0, width, height)) + + for y := 0; y < height; y++ { + for x := 0; x < width; x++ { + setPixel(dst, x, height-1-y, src.NRGBAAt(x, y)) + } + } + + return dst +} + +// rotateImage90 rotates an image 90 degrees counterclockwise. +func rotateImage90(src *image.NRGBA) image.Image { + bounds := src.Bounds() + width := bounds.Dx() + height := bounds.Dy() + dst := image.NewNRGBA(image.Rect(0, 0, height, width)) + + for y := 0; y < height; y++ { + for x := 0; x < width; x++ { + setPixel(dst, y, width-1-x, src.NRGBAAt(x, y)) + } + } + + return dst +} + +// rotateImage180 rotates an image 180 degrees. +func rotateImage180(src *image.NRGBA) image.Image { + bounds := src.Bounds() + width := bounds.Dx() + height := bounds.Dy() + dst := image.NewNRGBA(image.Rect(0, 0, width, height)) + + for y := 0; y < height; y++ { + for x := 0; x < width; x++ { + setPixel(dst, width-1-x, height-1-y, src.NRGBAAt(x, y)) + } + } + + return dst +} + +// rotateImage270 rotates an image 270 degrees counterclockwise. +func rotateImage270(src *image.NRGBA) image.Image { + bounds := src.Bounds() + width := bounds.Dx() + height := bounds.Dy() + dst := image.NewNRGBA(image.Rect(0, 0, height, width)) + + for y := 0; y < height; y++ { + for x := 0; x < width; x++ { + setPixel(dst, height-1-y, x, src.NRGBAAt(x, y)) + } + } + + return dst +} + +// transposeImage mirrors an image along the top-left to bottom-right diagonal. +func transposeImage(src *image.NRGBA) image.Image { + bounds := src.Bounds() + width := bounds.Dx() + height := bounds.Dy() + dst := image.NewNRGBA(image.Rect(0, 0, height, width)) + + for y := 0; y < height; y++ { + for x := 0; x < width; x++ { + setPixel(dst, y, x, src.NRGBAAt(x, y)) + } + } + + return dst +} + +// transverseImage mirrors an image along the top-right to bottom-left diagonal. +func transverseImage(src *image.NRGBA) image.Image { + bounds := src.Bounds() + width := bounds.Dx() + height := bounds.Dy() + dst := image.NewNRGBA(image.Rect(0, 0, height, width)) + + for y := 0; y < height; y++ { + for x := 0; x < width; x++ { + setPixel(dst, height-1-y, width-1-x, src.NRGBAAt(x, y)) + } + } + + return dst +} + +// setPixel stores a pixel in an NRGBA image. +func setPixel(dst *image.NRGBA, x, y int, c color.NRGBA) { + dst.SetNRGBA(x, y, c) } diff --git a/internal/thumb/rotate_test.go b/internal/thumb/rotate_test.go new file mode 100644 index 000000000..62ffa7fa4 --- /dev/null +++ b/internal/thumb/rotate_test.go @@ -0,0 +1,114 @@ +package thumb + +import ( + "image" + "image/color" + "testing" + + "github.com/stretchr/testify/assert" +) + +// newTestImage creates a small non-square NRGBA image for rotation tests. +// The top-left pixel is red so the caller can verify orientation. +func newTestImage(width, height int) image.Image { + img := image.NewNRGBA(image.Rect(0, 0, width, height)) + + // Fill with white. + for y := 0; y < height; y++ { + for x := 0; x < width; x++ { + img.SetNRGBA(x, y, color.NRGBA{R: 255, G: 255, B: 255, A: 255}) + } + } + + // Mark top-left pixel red. + img.SetNRGBA(0, 0, color.NRGBA{R: 255, A: 255}) + + return img +} + +func TestRotate(t *testing.T) { + const w, h = 4, 3 + + t.Run("Unspecified", func(t *testing.T) { + result := Rotate(newTestImage(w, h), OrientationUnspecified) + assert.Equal(t, w, result.Bounds().Dx()) + assert.Equal(t, h, result.Bounds().Dy()) + }) + t.Run("Normal", func(t *testing.T) { + result := Rotate(newTestImage(w, h), OrientationNormal) + assert.Equal(t, w, result.Bounds().Dx()) + assert.Equal(t, h, result.Bounds().Dy()) + }) + t.Run("FlipH", func(t *testing.T) { + result := Rotate(newTestImage(w, h), OrientationFlipH) + assert.Equal(t, w, result.Bounds().Dx()) + assert.Equal(t, h, result.Bounds().Dy()) + + // Top-left pixel should now be at top-right. + r, _, _, _ := result.At(w-1, 0).RGBA() + assert.Equal(t, uint32(0xffff), r, "red pixel should be at top-right after horizontal flip") + }) + t.Run("Rotate180", func(t *testing.T) { + result := Rotate(newTestImage(w, h), OrientationRotate180) + assert.Equal(t, w, result.Bounds().Dx()) + assert.Equal(t, h, result.Bounds().Dy()) + + // Top-left pixel should now be at bottom-right. + r, _, _, _ := result.At(w-1, h-1).RGBA() + assert.Equal(t, uint32(0xffff), r, "red pixel should be at bottom-right after 180 rotation") + }) + t.Run("FlipV", func(t *testing.T) { + result := Rotate(newTestImage(w, h), OrientationFlipV) + assert.Equal(t, w, result.Bounds().Dx()) + assert.Equal(t, h, result.Bounds().Dy()) + + // Top-left pixel should now be at bottom-left. + r, _, _, _ := result.At(0, h-1).RGBA() + assert.Equal(t, uint32(0xffff), r, "red pixel should be at bottom-left after vertical flip") + }) + t.Run("Rotate90", func(t *testing.T) { + result := Rotate(newTestImage(w, h), OrientationRotate90) + // 90 CCW swaps dimensions. + assert.Equal(t, h, result.Bounds().Dx()) + assert.Equal(t, w, result.Bounds().Dy()) + + // Top-left pixel should now be at bottom-left. + r, _, _, _ := result.At(0, w-1).RGBA() + assert.Equal(t, uint32(0xffff), r, "red pixel should be at bottom-left after 90 CCW rotation") + }) + t.Run("Rotate270", func(t *testing.T) { + result := Rotate(newTestImage(w, h), OrientationRotate270) + // 270 CCW swaps dimensions. + assert.Equal(t, h, result.Bounds().Dx()) + assert.Equal(t, w, result.Bounds().Dy()) + + // Top-left pixel should now be at top-right. + r, _, _, _ := result.At(h-1, 0).RGBA() + assert.Equal(t, uint32(0xffff), r, "red pixel should be at top-right after 270 CCW rotation") + }) + t.Run("Transpose", func(t *testing.T) { + result := Rotate(newTestImage(w, h), OrientationTranspose) + // Transpose swaps dimensions. + assert.Equal(t, h, result.Bounds().Dx()) + assert.Equal(t, w, result.Bounds().Dy()) + + // Transpose mirrors along top-left to bottom-right diagonal: (x,y) -> (y,x). + r, _, _, _ := result.At(0, 0).RGBA() + assert.Equal(t, uint32(0xffff), r, "red pixel should stay at top-left after transpose") + }) + t.Run("Transverse", func(t *testing.T) { + result := Rotate(newTestImage(w, h), OrientationTransverse) + // Transverse swaps dimensions. + assert.Equal(t, h, result.Bounds().Dx()) + assert.Equal(t, w, result.Bounds().Dy()) + + // Transverse mirrors along top-right to bottom-left diagonal. + r, _, _, _ := result.At(h-1, w-1).RGBA() + assert.Equal(t, uint32(0xffff), r, "red pixel should be at bottom-right after transverse") + }) + t.Run("InvalidOrientation", func(t *testing.T) { + result := Rotate(newTestImage(w, h), 99) + assert.Equal(t, w, result.Bounds().Dx()) + assert.Equal(t, h, result.Bounds().Dy()) + }) +} diff --git a/internal/thumb/size_test.go b/internal/thumb/size_test.go index 262b9a77c..5fffff4c9 100644 --- a/internal/thumb/size_test.go +++ b/internal/thumb/size_test.go @@ -4,8 +4,9 @@ import ( "image" "testing" - "github.com/disintegration/imaging" "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/pkg/fs" ) func TestSkip(t *testing.T) { @@ -40,7 +41,7 @@ func TestSize_Skip(t *testing.T) { assert.FileExists(t, src) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) @@ -53,7 +54,7 @@ func TestSize_Skip(t *testing.T) { assert.FileExists(t, src) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) @@ -66,7 +67,7 @@ func TestSize_Skip(t *testing.T) { assert.FileExists(t, src) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) @@ -79,7 +80,7 @@ func TestSize_Skip(t *testing.T) { assert.FileExists(t, src) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) @@ -92,7 +93,7 @@ func TestSize_Skip(t *testing.T) { assert.FileExists(t, src) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) @@ -105,7 +106,7 @@ func TestSize_Skip(t *testing.T) { assert.FileExists(t, src) - img, err := imaging.Open(src, imaging.AutoOrientation(true)) + img, _, err := fs.DecodeImageFile(src) if err != nil { t.Fatal(err) diff --git a/internal/thumb/sizes.go b/internal/thumb/sizes.go index 76b226984..b23c230e5 100644 --- a/internal/thumb/sizes.go +++ b/internal/thumb/sizes.go @@ -48,7 +48,7 @@ func (m SizeMap) All() SizeList { // Size presets used throughout the application. var ( - SizeColors = Size{Colors, Fit720, "Color Detection", 3, 3, false, false, false, true, Options{ResampleResize, ResampleNearestNeighbor, ResamplePng}} + SizeColors = Size{Colors, Fit720, "Color Detection", 3, 3, false, false, false, true, Options{ResampleResize, ResampleNearestNeighbor, ResamplePng, ResampleStripICC}} SizeTile50 = Size{Tile50, Fit720, "List View", 50, 50, false, false, false, true, Options{ResampleFillCenter, ResampleDefault}} SizeTile100 = Size{Tile100, Fit720, "Places View", 100, 100, false, false, false, true, Options{ResampleFillCenter, ResampleDefault}} SizeTile224 = Size{Tile224, Fit720, "AI, Mosaic View", 224, 224, false, false, false, true, Options{ResampleFillCenter, ResampleDefault}} @@ -71,7 +71,8 @@ var ( SizeFit3840 = Size{Fit3840, Fit4096, "4K Ultra HD", 3840, 2400, false, true, true, false, Options{ResampleFit, ResampleDefault}} SizeFit4096 = Size{Fit4096, "", "DCI 4K, Retina 4K", 4096, 4096, true, true, false, false, Options{ResampleFit, ResampleDefault}} SizeFit5120 = Size{Fit5120, "", "Retina 5K", 5120, 5120, true, true, false, false, Options{ResampleFit, ResampleDefault}} - SizeFit7680 = Size{Fit7680, "", "8K Ultra HD 2", 7680, 4320, true, true, false, false, Options{ResampleFit, ResampleDefault}} + SizeFit7680 = Size{Fit7680, Fit15360, "8K Ultra HD 2", 7680, 4320, true, true, false, false, Options{ResampleFit, ResampleDefault}} + SizeFit15360 = Size{Fit15360, "", "16K UHD", 15360, 8640, true, true, false, false, Options{ResampleFit, ResampleDefault}} ) // Sizes contains the properties of all thumbnail sizes. @@ -100,6 +101,7 @@ var Sizes = SizeMap{ Fit4096: SizeFit4096, Fit5120: SizeFit5120, Fit7680: SizeFit7680, + Fit15360: SizeFit15360, // On-demand only by default; for 8K+ 360° media. } // All contains all thumbnail sizes sorted by width. diff --git a/internal/thumb/sizes_test.go b/internal/thumb/sizes_test.go index 7d085cf7c..273ac8bdd 100644 --- a/internal/thumb/sizes_test.go +++ b/internal/thumb/sizes_test.go @@ -49,18 +49,3 @@ func TestSize_Uncached(t *testing.T) { SizeCached = 2048 SizeOnDemand = 7680 } - -func TestResampleFilter_Imaging(t *testing.T) { - t.Run("Blackman", func(t *testing.T) { - r := ResampleBlackman.Imaging() - assert.Equal(t, float64(3), r.Support) - }) - t.Run("Cubic", func(t *testing.T) { - r := ResampleCubic.Imaging() - assert.Equal(t, float64(2), r.Support) - }) - t.Run("Linear", func(t *testing.T) { - r := ResampleLinear.Imaging() - assert.Equal(t, float64(1), r.Support) - }) -} diff --git a/internal/thumb/testdata/corrupt-preview.jpg b/internal/thumb/testdata/corrupt-preview.jpg new file mode 100644 index 000000000..8bb9bf923 Binary files /dev/null and b/internal/thumb/testdata/corrupt-preview.jpg differ diff --git a/internal/thumb/testdata/icc_profile_bad_length.jpg b/internal/thumb/testdata/icc_profile_bad_length.jpg new file mode 100644 index 000000000..fc6191162 Binary files /dev/null and b/internal/thumb/testdata/icc_profile_bad_length.jpg differ diff --git a/internal/thumb/thumb.go b/internal/thumb/thumb.go index e8b1f622b..8cc080338 100644 --- a/internal/thumb/thumb.go +++ b/internal/thumb/thumb.go @@ -1,7 +1,7 @@ /* Package thumb provides JPEG resampling and thumbnail generation. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. @@ -32,7 +32,6 @@ import ( "math" _ "golang.org/x/image/bmp" // register BMP decoder for thumbnail generation - _ "golang.org/x/image/tiff" // register TIFF decoder for thumbnail generation _ "golang.org/x/image/webp" // register WEBP decoder for thumbnail generation "github.com/photoprism/photoprism/internal/event" diff --git a/internal/thumb/thumb_test.go b/internal/thumb/thumb_test.go index 5c0d88221..fa87f2798 100644 --- a/internal/thumb/thumb_test.go +++ b/internal/thumb/thumb_test.go @@ -10,21 +10,23 @@ import ( "github.com/photoprism/photoprism/internal/event" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) int { log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) event.AuditLog = log - code := m.Run() - - Shutdown() - + defer Shutdown() // Remove generated test files and folders. - _ = os.RemoveAll("testdata/1") - _ = os.RemoveAll("testdata/cache") - _ = os.RemoveAll("testdata/vips") + defer os.RemoveAll("testdata/1") + defer os.RemoveAll("testdata/cache") + defer os.RemoveAll("testdata/vips") - os.Exit(code) + return m.Run() } func TestNew(t *testing.T) { diff --git a/internal/thumb/verify.go b/internal/thumb/verify.go new file mode 100644 index 000000000..86a8d8b78 --- /dev/null +++ b/internal/thumb/verify.go @@ -0,0 +1,41 @@ +package thumb + +import ( + "fmt" + + "github.com/davidbyttow/govips/v2/vips" +) + +// VerifySize is the target edge length used to force a thumbnail decode during Verify; +// it matches the standard tile size whose center-crop decode rejects corrupt previews. +const VerifySize = 500 + +// Verify reports an error if the image file cannot be decoded by the active rendering library. +// Used to reject corrupt converter output (e.g. a bogus-Huffman embedded RAW preview that passes a +// MIME sniff but later fails libvips) so the conversion loop can try the next converter. +func Verify(fileName string) error { + if fileName == "" { + return fmt.Errorf("verify: empty filename") + } + + // Run the same shrink-on-load path the thumbnailer uses so the check matches GenerateThumbnails. + if Library == LibVips { + VipsInit() + + img, err := vips.LoadImageFromFile(fileName, VipsImportParams()) + if err != nil { + return err + } + + defer img.Close() + + // libvips loads JPEGs lazily, so force the decode now (it would otherwise fail later in + // GenerateThumbnails and mark the photo IndexFailed). Mirror the center-crop tile path, + // which rejects bogus-Huffman previews a plain fit resize can skip. + return img.ThumbnailWithSize(VerifySize, VerifySize, vips.InterestingCentre, vips.SizeBoth) + } + + _, err := Open(fileName, 1) + + return err +} diff --git a/internal/thumb/verify_test.go b/internal/thumb/verify_test.go new file mode 100644 index 000000000..75f89ad0d --- /dev/null +++ b/internal/thumb/verify_test.go @@ -0,0 +1,34 @@ +package thumb + +import ( + "os" + "path/filepath" + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestVerify(t *testing.T) { + t.Run("ValidJPEG", func(t *testing.T) { + assert.NoError(t, Verify("testdata/example.jpg")) + }) + t.Run("ValidPNG", func(t *testing.T) { + assert.NoError(t, Verify("testdata/example.png")) + }) + t.Run("EmptyFilename", func(t *testing.T) { + assert.Error(t, Verify("")) + }) + t.Run("NotAnImage", func(t *testing.T) { + name := filepath.Join(t.TempDir(), "garbage.jpg") + assert.NoError(t, os.WriteFile(name, []byte("this is not a valid jpeg payload, only plain text"), 0o600)) + assert.Error(t, Verify(name)) + }) + t.Run("CorruptPreviewLoadsButFailsThumbnail", func(t *testing.T) { + // A real Leaf .mos embedded preview: a header-valid JPEG that decodes as a full image + // but fails the thumbnailer's shrink-on-load with a bogus Huffman table. + assert.Error(t, Verify("testdata/corrupt-preview.jpg")) + }) + t.Run("MissingFile", func(t *testing.T) { + assert.Error(t, Verify(filepath.Join(t.TempDir(), "does-not-exist.jpg"))) + }) +} diff --git a/internal/thumb/video.go b/internal/thumb/video.go index 5ae6bad36..8911f86a3 100644 --- a/internal/thumb/video.go +++ b/internal/thumb/video.go @@ -1,8 +1,15 @@ package thumb // VideoSizes contains all valid video output sizes sorted by size. +// The upper end matches the photo "fit" sizes (up to Fit15360) so high-resolution +// 360° footage is not downscaled; the codec/source still bound the actual output, +// since VideoFilter only ever scales down to min(SizeLimit, source). The 4K UHD +// (Fit3840) and 2K (Fit2048) steps are video-specific and kept to avoid changing +// the size a pre-existing ffmpeg-size config snaps to. var VideoSizes = SizeList{ + Sizes[Fit15360], Sizes[Fit7680], + Sizes[Fit5120], Sizes[Fit4096], Sizes[Fit3840], Sizes[Fit2560], @@ -16,7 +23,7 @@ var VideoSizes = SizeList{ func VideoSize(limit int) Size { switch { case limit < 0: - return Sizes[Fit7680] // maximum + return Sizes[Fit15360] // maximum case limit == 0: return Sizes[Fit4096] // default case limit <= 720: @@ -31,5 +38,5 @@ func VideoSize(limit int) Size { } // Return maximum size. - return Sizes[Fit7680] + return Sizes[Fit15360] } diff --git a/internal/thumb/video_test.go b/internal/thumb/video_test.go index 02d7faeb0..08ce8148d 100644 --- a/internal/thumb/video_test.go +++ b/internal/thumb/video_test.go @@ -17,6 +17,9 @@ func TestVideoSize(t *testing.T) { assert.Equal(t, Sizes[Fit2560], VideoSize(3000)) assert.Equal(t, Sizes[Fit3840], VideoSize(4000)) assert.Equal(t, Sizes[Fit4096], VideoSize(0)) + assert.Equal(t, Sizes[Fit5120], VideoSize(5120)) assert.Equal(t, Sizes[Fit7680], VideoSize(8000)) - assert.Equal(t, Sizes[Fit7680], VideoSize(-1)) + assert.Equal(t, Sizes[Fit15360], VideoSize(15360)) + assert.Equal(t, Sizes[Fit15360], VideoSize(20000)) + assert.Equal(t, Sizes[Fit15360], VideoSize(-1)) } diff --git a/internal/thumb/viewer.go b/internal/thumb/viewer.go index 5f6f8b309..2464e300b 100644 --- a/internal/thumb/viewer.go +++ b/internal/thumb/viewer.go @@ -6,13 +6,14 @@ import ( // Viewer represents thumbnail URLs for the photo/video viewer. type Viewer struct { - Fit720 *Thumb `json:"fit_720"` - Fit1280 *Thumb `json:"fit_1280"` - Fit1920 *Thumb `json:"fit_1920"` - Fit2560 *Thumb `json:"fit_2560"` - Fit4096 *Thumb `json:"fit_4096"` - Fit5120 *Thumb `json:"fit_5120"` - Fit7680 *Thumb `json:"fit_7680"` + Fit720 *Thumb `json:"fit_720"` + Fit1280 *Thumb `json:"fit_1280"` + Fit1920 *Thumb `json:"fit_1920"` + Fit2560 *Thumb `json:"fit_2560"` + Fit4096 *Thumb `json:"fit_4096"` + Fit5120 *Thumb `json:"fit_5120"` + Fit7680 *Thumb `json:"fit_7680"` + Fit15360 *Thumb `json:"fit_15360"` } // ViewerThumbs creates and returns a Viewer struct pointer with the required thumbnail URLs for the photo/video viewer. diff --git a/internal/thumb/viewer_test.go b/internal/thumb/viewer_test.go index 087d313e7..c3e317047 100644 --- a/internal/thumb/viewer_test.go +++ b/internal/thumb/viewer_test.go @@ -31,5 +31,8 @@ func TestViewerThumbs(t *testing.T) { assert.Equal(t, 2000, result.Fit7680.W) assert.Equal(t, 1500, result.Fit7680.H) assert.Equal(t, "https://example.com/t/011df944f313a05f89d170a561fad09ce6cef44e/12345678/fit_2560", result.Fit7680.Src) + assert.Equal(t, 2000, result.Fit15360.W) + assert.Equal(t, 1500, result.Fit15360.H) + assert.Equal(t, "https://example.com/t/011df944f313a05f89d170a561fad09ce6cef44e/12345678/fit_2560", result.Fit15360.Src) }) } diff --git a/internal/thumb/vips.go b/internal/thumb/vips.go index a45a62269..93e4a02ea 100644 --- a/internal/thumb/vips.go +++ b/internal/thumb/vips.go @@ -33,8 +33,10 @@ func Vips(imageName string, imageBuffer []byte, hash, thumbPath string, width, h // Get thumb cache filename. thumbName, err = FileName(hash, thumbPath, width, height, opts...) + logName := clean.Log(filepath.Base(imageName)) + if err != nil { - log.Debugf("thumb: %s in %s (filename)", err, clean.Log(filepath.Base(imageName))) + log.Debugf("thumb: %s in %s (filename)", err, logName) return "", nil, err } @@ -46,13 +48,14 @@ func Vips(imageName string, imageBuffer []byte, hash, thumbPath string, width, h if len(imageBuffer) == 0 { if img, err = vips.LoadImageFromFile(imageName, VipsImportParams()); err != nil { - log.Debugf("vips: %s in %s (load image from file)", err, clean.Log(filepath.Base(imageName))) + log.Debugf("vips: %s in %s (load image from file)", err, logName) return "", nil, err } } else if img, err = vips.LoadImageFromBuffer(imageBuffer, VipsImportParams()); err != nil { - log.Debugf("vips: %s in %s (load image from buffer)", err, clean.Log(filepath.Base(imageName))) + log.Debugf("vips: %s in %s (load image from buffer)", err, logName) return "", nil, err } + defer img.Close() // Set resample options. var method ResampleOption @@ -80,45 +83,86 @@ func Vips(imageName string, imageBuffer []byte, hash, thumbPath string, width, h } // Embed an ICC profile when a JPEG declares its color space via the EXIF InteroperabilityIndex tag. - if err = vipsSetIccProfileForInteropIndex(img, clean.Log(filepath.Base(imageName))); err != nil { - log.Debugf("vips: %s in %s (set icc profile for interop index tag)", err, clean.Log(filepath.Base(imageName))) + if err = vipsSetIccProfileForInteropIndex(img, logName); err != nil { + log.Debugf("vips: %s in %s (set icc profile for interop index tag)", err, logName) } // Create thumbnail image. if err = img.ThumbnailWithSize(width, height, crop, size); err != nil { - log.Debugf("vips: %s in %s (create thumbnail)", err, clean.Log(filepath.Base(imageName))) + log.Debugf("vips: %s in %s (create thumbnail)", err, logName) + return "", nil, err + } + + // Guard against zero-dimension intermediates so callers see the real cause + // instead of an opaque libvips "unable to write to target" further downstream. + if w, h := img.Width(), img.Height(); w <= 0 || h <= 0 { + err = fmt.Errorf("vips: produced empty %dx%d image for %s", w, h, logName) + log.Debugf("%s (create thumbnail)", err) return "", nil, err } // Remove metadata from thumbnail. if err = img.RemoveMetadata(); err != nil { - log.Debugf("vips: %s in %s (remove metadata)", err, clean.Log(filepath.Base(imageName))) + log.Debugf("vips: %s in %s (remove metadata)", err, logName) return "", nil, err } // Export to standard image format. + var format string switch fs.FileType(thumbName) { case fs.ImagePng: - thumbBuffer, _, err = img.ExportPng(VipsPngExportParams(width, height)) + format = "png" + pngParams := VipsPngExportParams(width, height) + // If ResampleStripICC is set, remove the ICC profile. + if Options(opts).Contains(ResampleStripICC) && img.HasICCProfile() { + if iccErr := img.RemoveICCProfile(); iccErr != nil { + log.Debugf("vips: %s in %s (remove icc profile)", iccErr, logName) + } + } + // Try to export PNG thumbnail image. + thumbBuffer, _, err = img.ExportPng(pngParams) + // If that fails, try again without the ICC profile, since libpng may reject an invalid ICCP chunk (e.g. malformed profile length). + if err != nil && img.HasICCProfile() { + log.Tracef("vips: %s in %s (export png with icc)", err, logName) + if iccErr := img.RemoveICCProfile(); iccErr != nil { + log.Debugf("vips: %s in %s (remove icc profile)", iccErr, logName) + } else if thumbBuffer, _, err = img.ExportPng(pngParams); err != nil { + log.Debugf("vips: %s in %s (export png without icc)", err, logName) + } + } default: + format = "jpeg" thumbBuffer, _, err = img.ExportJpeg(VipsJpegExportParams(width, height)) } // Check if export failed. if err != nil { - log.Debugf("vips: %s in %s (export thumbnail)", err, clean.Log(filepath.Base(imageName))) + err = wrapVipsExportErr(format, thumbName, width, height, err) + log.Debugf("%s (export thumbnail)", err) return "", thumbBuffer, err } // Write thumbnail to file. if err = os.WriteFile(thumbName, thumbBuffer, fs.ModeFile); err != nil { - log.Debugf("vips: %s in %s (write thumbnail to file)", err, clean.Log(filepath.Base(imageName))) + err = wrapVipsWriteErr(thumbName, err) + log.Debugf("%s (write thumbnail to file)", err) return "", thumbBuffer, err } return thumbName, thumbBuffer, nil } +// wrapVipsExportErr annotates a libvips export error with the target format, filename, and dimensions. +func wrapVipsExportErr(format, thumbName string, width, height int, err error) error { + return fmt.Errorf("vips: %s export failed for %s at %dx%d (%w)", + format, clean.Log(filepath.Base(thumbName)), width, height, err) +} + +// wrapVipsWriteErr annotates a thumbnail file-write error with the destination filename. +func wrapVipsWriteErr(thumbName string, err error) error { + return fmt.Errorf("vips: failed to write thumbnail %s (%w)", clean.Log(filepath.Base(thumbName)), err) +} + // VipsImportParams provides parameters for opening files with libvips. func VipsImportParams() *vips.ImportParams { params := &vips.ImportParams{} diff --git a/internal/thumb/vips_convert.go b/internal/thumb/vips_convert.go new file mode 100644 index 000000000..4bf67361e --- /dev/null +++ b/internal/thumb/vips_convert.go @@ -0,0 +1,92 @@ +package thumb + +import ( + "fmt" + "image" + "os" + "path/filepath" + + "github.com/davidbyttow/govips/v2/vips" + + "github.com/photoprism/photoprism/pkg/clean" + "github.com/photoprism/photoprism/pkg/fs" +) + +// vipsConvertImportParams provides libvips import parameters for image conversion helpers. +func vipsConvertImportParams() *vips.ImportParams { + params := &vips.ImportParams{} + params.FailOnError.Set(false) + return params +} + +// vipsConvert loads a source image with libvips, applies the explicit +// orientation, and exports it. EXIF orientation is skipped for HEIF/AVIF +// (libheif already applied any irot/imir during decode — the HEIF spec treats +// EXIF orientation as informational only). Non-conformant HEIC files that +// carry EXIF orientation without irot will not be auto-rotated by this path. +func vipsConvert(srcFile, dstFile string, orientation int) (_ image.Image, err error) { + VipsInit() + + logName := clean.Log(filepath.Base(dstFile)) + + img, err := vips.LoadImageFromFile(srcFile, vipsConvertImportParams()) + if err != nil { + return nil, err + } + defer img.Close() + + // Skip EXIF orientation for HEIF/AVIF — libheif already applied irot/imir during decode. + if orientation > OrientationNormal && !vipsLoadedViaHeif(img) { + if err = VipsRotate(img, orientation); err != nil { + return nil, err + } + } + + if err = img.RemoveOrientation(); err != nil { + return nil, err + } + + width, height := img.Width(), img.Height() + + var imageBytes []byte + switch fs.FileType(dstFile) { + case fs.ImagePng: + params := VipsPngExportParams(width, height) + // Try to export PNG image. + imageBytes, _, err = img.ExportPng(params) + // If that fails, try again without the ICC profile, since libpng may reject an invalid ICCP chunk (e.g. malformed profile length). + if err != nil && img.HasICCProfile() { + log.Tracef("vips: %s in %s (export png with icc)", err, logName) + if iccErr := img.RemoveICCProfile(); iccErr != nil { + log.Debugf("vips: %s in %s (remove icc profile)", iccErr, logName) + } else if imageBytes, _, err = img.ExportPng(params); err != nil { + log.Debugf("vips: %s in %s (export png without icc)", err, logName) + } + } + default: + params := VipsJpegExportParams(width, height) + imageBytes, _, err = img.ExportJpeg(params) + } + + if err != nil { + return nil, err + } + + if err = os.WriteFile(dstFile, imageBytes, fs.ModeFile); err != nil { + return nil, err + } + + decoded, _, err := fs.DecodeImageData(imageBytes) + + if err != nil { + return nil, fmt.Errorf("vips: %s in %s (decode exported image)", err, logName) + } + + return decoded, nil +} + +// vipsLoadedViaHeif reports whether the image was decoded by the libheif loader. +func vipsLoadedViaHeif(img *vips.ImageRef) bool { + loader := img.GetString("vips-loader") + return len(loader) >= 8 && loader[:8] == "heifload" +} diff --git a/internal/thumb/vips_icc_test.go b/internal/thumb/vips_icc_test.go index 42c1e930b..aee3a0e42 100644 --- a/internal/thumb/vips_icc_test.go +++ b/internal/thumb/vips_icc_test.go @@ -14,6 +14,7 @@ func TestVipsSetIccProfileForInteropIndex(t *testing.T) { img, err := vips.LoadImageFromFile("testdata/interop_index_srgb_icc.jpg", VipsImportParams()) require.NoError(t, err) + defer img.Close() iiFull := img.GetString("exif-ifd4-InteroperabilityIndex") require.NotEmpty(t, iiFull) @@ -32,6 +33,7 @@ func TestVipsSetIccProfileForInteropIndex(t *testing.T) { img, err := vips.LoadImageFromFile("testdata/interop_index.jpg", VipsImportParams()) require.NoError(t, err) + defer img.Close() require.False(t, img.HasICCProfile(), "fixture should have no embedded ICC profile") err = vipsSetIccProfileForInteropIndex(img, "interop_index.jpg") @@ -44,6 +46,7 @@ func TestVipsSetIccProfileForInteropIndex(t *testing.T) { img, err := vips.LoadImageFromFile("testdata/example.jpg", VipsImportParams()) require.NoError(t, err) + defer img.Close() hasICCBefore := img.HasICCProfile() err = vipsSetIccProfileForInteropIndex(img, "example.jpg") @@ -55,6 +58,7 @@ func TestVipsSetIccProfileForInteropIndex(t *testing.T) { img, err := vips.LoadImageFromFile("testdata/interop_index_r98.jpg", VipsImportParams()) require.NoError(t, err) + defer img.Close() require.False(t, img.HasICCProfile(), "fixture should have no embedded ICC profile") err = vipsSetIccProfileForInteropIndex(img, "interop_index_r98.jpg") @@ -66,6 +70,7 @@ func TestVipsSetIccProfileForInteropIndex(t *testing.T) { img, err := vips.LoadImageFromFile("testdata/interop_index_thm.jpg", VipsImportParams()) require.NoError(t, err) + defer img.Close() require.False(t, img.HasICCProfile(), "fixture should have no embedded ICC profile") err = vipsSetIccProfileForInteropIndex(img, "interop_index_thm.jpg") diff --git a/internal/thumb/vips_init.go b/internal/thumb/vips_init.go index 979c1036d..5886302d0 100644 --- a/internal/thumb/vips_init.go +++ b/internal/thumb/vips_init.go @@ -10,27 +10,39 @@ import ( var ( vipsStarted = false + vipsStopped = false vipsStart = sync.Once{} ) // VipsInit initializes libvips by checking its version and loading the ICC profiles once. func VipsInit() { + if vipsStopped { + log.Debugf("vips: restart requested after shutdown, ignoring") + return + } + vipsStart.Do(vipsInit) } -// VipsShutdown shuts down libvips and removes temporary files. +// VipsShutdown shuts down libvips once as terminal process cleanup. func VipsShutdown() { - if vipsStarted { - vipsStarted = false - vipsStart = sync.Once{} - vips.Shutdown() + if !vipsStarted || vipsStopped { + return } + + vipsStopped = true + vips.Shutdown() } // vipsInit calls vips.Startup() to initialize libvips. func vipsInit() { + if vipsStopped { + log.Debugf("vips: restart requested after shutdown, ignoring") + return + } + if vipsStarted { - log.Warnf("vips: already initialized - you may have found a bug") + log.Debugf("vips: already initialized") return } diff --git a/internal/thumb/vips_rotate_test.go b/internal/thumb/vips_rotate_test.go index 1d9cd0613..aa18f3cba 100644 --- a/internal/thumb/vips_rotate_test.go +++ b/internal/thumb/vips_rotate_test.go @@ -26,6 +26,7 @@ func TestVipsRotate(t *testing.T) { if err != nil { t.Fatal(err) } + defer img.Close() if err = VipsRotate(img, OrientationNormal); err != nil { t.Fatal(err) @@ -57,6 +58,7 @@ func TestVipsRotate(t *testing.T) { if err != nil { t.Fatal(err) } + defer img.Close() if err = VipsRotate(img, OrientationRotate90); err != nil { t.Fatal(err) @@ -88,6 +90,7 @@ func TestVipsRotate(t *testing.T) { if err != nil { t.Fatal(err) } + defer img.Close() if err = VipsRotate(img, OrientationRotate180); err != nil { t.Fatal(err) @@ -119,6 +122,7 @@ func TestVipsRotate(t *testing.T) { if err != nil { t.Fatal(err) } + defer img.Close() if err = VipsRotate(img, OrientationRotate270); err != nil { t.Fatal(err) diff --git a/internal/thumb/vips_test.go b/internal/thumb/vips_test.go index 33c159a4d..51f2d0f36 100644 --- a/internal/thumb/vips_test.go +++ b/internal/thumb/vips_test.go @@ -1,6 +1,7 @@ package thumb import ( + "errors" "strings" "testing" @@ -25,6 +26,81 @@ func TestVips(t *testing.T) { assert.True(t, strings.HasSuffix(fileName, dst)) assert.FileExists(t, dst) }) + t.Run("ColorsBadIccProfile", func(t *testing.T) { + // Regression for #5612 / #5616: Samsung Galaxy JPEGs ship an ICC + // profile whose 4-byte size header is off by two bytes. SizeColors + // declares ResampleStripICC, so the broken profile is dropped before + // export and indexing succeeds. + colorThumb := Sizes[Colors] + src := "testdata/icc_profile_bad_length.jpg" + dst := "testdata/vips/1/4/4/144456789098765432_3x3_resize.png" + + assert.FileExists(t, src) + + fileName, _, err := Vips(src, nil, "144456789098765432", "testdata/vips", colorThumb.Width, colorThumb.Height, colorThumb.Options...) + + if err != nil { + t.Fatal(err) + } + + assert.True(t, strings.HasSuffix(fileName, dst)) + assert.FileExists(t, dst) + + dstimg, err := vips.LoadImageFromFile(dst, vips.NewImportParams()) + assert.NoError(t, err) + defer dstimg.Close() + assert.False(t, dstimg.HasICCProfile(), "SizeColors output must not embed an ICC profile") + }) + t.Run("ColorsStripsValidIccProfile", func(t *testing.T) { + // Confirms ResampleStripICC strips the profile even when libpng would + // have accepted it: SizeColors is a temporary 3x3 cache consumed for + // raw-pixel sampling, so an ICC chunk is wasted bytes on every photo. + colorThumb := Sizes[Colors] + src := "testdata/interop_index_srgb_icc.jpg" + dst := "testdata/vips/1/5/5/155456789098765432_3x3_resize.png" + + assert.FileExists(t, src) + + srcimg, err := vips.LoadImageFromFile(src, vips.NewImportParams()) + assert.NoError(t, err) + assert.True(t, srcimg.HasICCProfile(), "fixture sanity: input must carry an ICC profile") + srcimg.Close() + + fileName, _, err := Vips(src, nil, "155456789098765432", "testdata/vips", colorThumb.Width, colorThumb.Height, colorThumb.Options...) + + if err != nil { + t.Fatal(err) + } + + assert.True(t, strings.HasSuffix(fileName, dst)) + assert.FileExists(t, dst) + + dstimg, err := vips.LoadImageFromFile(dst, vips.NewImportParams()) + assert.NoError(t, err) + defer dstimg.Close() + assert.False(t, dstimg.HasICCProfile(), "ResampleStripICC must drop the profile") + }) + t.Run("PngWithoutStripICCKeepsValidProfile", func(t *testing.T) { + // Gates the new flag: a PNG export configured without ResampleStripICC + // must preserve a valid ICC profile end-to-end. Guards against a + // future regression that would generalize the strip to all PNGs. + src := "testdata/interop_index_srgb_icc.jpg" + dst := "testdata/vips/1/6/6/166456789098765432_3x3_resize.png" + + fileName, _, err := Vips(src, nil, "166456789098765432", "testdata/vips", 3, 3, ResampleResize, ResampleNearestNeighbor, ResamplePng) + + if err != nil { + t.Fatal(err) + } + + assert.True(t, strings.HasSuffix(fileName, dst)) + assert.FileExists(t, dst) + + dstimg, err := vips.LoadImageFromFile(dst, vips.NewImportParams()) + assert.NoError(t, err) + defer dstimg.Close() + assert.True(t, dstimg.HasICCProfile(), "PNG without ResampleStripICC must preserve the profile") + }) t.Run("InteropIndexColors", func(t *testing.T) { thumb := Sizes[Tile500] src := "testdata/interop_index.jpg" @@ -44,6 +120,7 @@ func TestVips(t *testing.T) { dstimg, err := vips.LoadImageFromFile(dst, vips.NewImportParams()) assert.NoError(t, err) + defer dstimg.Close() assert.True(t, dstimg.HasICCProfile()) assert.True(t, dstimg.IsColorSpaceSupported()) }) @@ -216,3 +293,45 @@ func TestVipsJpegExportParams(t *testing.T) { assert.Equal(t, JpegQualitySmall().Int(), result.Quality) }) } + +func TestWrapVipsExportErr(t *testing.T) { + t.Run("Success", func(t *testing.T) { + inner := errors.New("vips2png: unable to write to target") + err := wrapVipsExportErr("png", "/cache/1/2/3/colors.png", 3, 3, inner) + + assert.Error(t, err) + assert.Contains(t, err.Error(), "png export failed") + assert.Contains(t, err.Error(), "colors.png") + assert.Contains(t, err.Error(), "3x3") + assert.Contains(t, err.Error(), "unable to write to target") + assert.True(t, errors.Is(err, inner), "wrapped error must remain unwrappable") + }) + t.Run("StripsDirectory", func(t *testing.T) { + // Only the basename should appear in the message so logs stay compact. + err := wrapVipsExportErr("jpeg", "/cache/deep/nested/path/photo.jpg", 1920, 1080, errors.New("boom")) + + assert.Contains(t, err.Error(), "photo.jpg") + assert.NotContains(t, err.Error(), "/cache/deep/nested") + }) +} + +func TestWrapVipsWriteErr(t *testing.T) { + t.Run("Success", func(t *testing.T) { + inner := errors.New("no space left on device") + err := wrapVipsWriteErr("/cache/1/2/3/colors.png", inner) + + assert.Error(t, err) + assert.Contains(t, err.Error(), "failed to write thumbnail") + assert.Contains(t, err.Error(), "colors.png") + assert.Contains(t, err.Error(), "no space left on device") + assert.True(t, errors.Is(err, inner), "wrapped error must remain unwrappable") + }) + t.Run("StripsDirectory", func(t *testing.T) { + // Only the basename should appear so the server filesystem layout is not leaked + // to the UI via the event-bus log hook. + err := wrapVipsWriteErr("/photoprism/storage/cache/thumbnails/1/2/3/photo.jpg", errors.New("boom")) + + assert.Contains(t, err.Error(), "photo.jpg") + assert.NotContains(t, err.Error(), "/photoprism/storage") + }) +} diff --git a/internal/workers/auto/auto.go b/internal/workers/auto/auto.go index 6d37701dd..552562144 100644 --- a/internal/workers/auto/auto.go +++ b/internal/workers/auto/auto.go @@ -1,7 +1,7 @@ /* Package auto provides workers for background indexing and import operations. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. @@ -51,19 +51,21 @@ func Start(conf *config.Config) { ticker.Stop() return case <-ticker.C: - if mustIndex(conf.AutoIndex()) { - log.Debugf("auto-index: starting") - ResetIndex() - if err := Index(); err != nil { - log.Errorf("auto-index: %s", err) + event.Safe(func() { + if mustIndex(conf.AutoIndex()) { + log.Debugf("auto-index: starting") + ResetIndex() + if err := Index(); err != nil { + log.Errorf("auto-index: %s", err) + } + } else if mustImport(conf.AutoImport()) { + log.Debugf("auto-import: starting") + ResetImport() + if err := Import(); err != nil { + log.Errorf("auto-import: %s", err) + } } - } else if mustImport(conf.AutoImport()) { - log.Debugf("auto-import: starting") - ResetImport() - if err := Import(); err != nil { - log.Errorf("auto-import: %s", err) - } - } + }) } } }() diff --git a/internal/workers/auto/auto_test.go b/internal/workers/auto/auto_test.go index 04cac6752..3e32d29cc 100644 --- a/internal/workers/auto/auto_test.go +++ b/internal/workers/auto/auto_test.go @@ -10,23 +10,30 @@ import ( "github.com/photoprism/photoprism/pkg/fs" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) (code int) { log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) - c := config.TestConfig() - - // Run unit tests. - code := m.Run() - - if err := c.CloseDb(); err != nil { - log.Warnf("close db: %v", err) - } - - // Remove temporary SQLite files after running the tests. + // Remove temporary SQLite files before running the tests. fs.PurgeTestDbFiles(".", false) - os.Exit(code) + c := config.TestConfig() + defer c.CleanupTestFolder() + defer func() { + if err := c.CloseDb(); err != nil { + log.Warnf("close db: %v", err) + } + // Remove temporary SQLite files after running the tests. + fs.PurgeTestDbFiles(".", false) + }() + + // Run unit tests. + return m.Run() } func TestStart(t *testing.T) { diff --git a/internal/workers/backup.go b/internal/workers/backup.go index c651e1179..b264961fb 100644 --- a/internal/workers/backup.go +++ b/internal/workers/backup.go @@ -1,7 +1,6 @@ package workers import ( - "errors" "fmt" "runtime/debug" "time" @@ -11,6 +10,8 @@ import ( "github.com/photoprism/photoprism/internal/config" "github.com/photoprism/photoprism/internal/mutex" "github.com/photoprism/photoprism/internal/photoprism/backup" + "github.com/photoprism/photoprism/pkg/fs/disk" + "github.com/photoprism/photoprism/pkg/log/status" ) // Backup represents a background backup worker. @@ -44,6 +45,13 @@ func (w *Backup) Start(database, albums bool, force bool, retain int) (err error return nil } + // Reset the cached disk usage so a freshly freed disk is detected immediately. + disk.FlushFree() + + if w.conf.InsufficientStorage() { + return status.ErrInsufficientStorage + } + // Return error if backup worker is already running. if err = mutex.BackupWorker.Start(); err != nil { return err @@ -64,7 +72,7 @@ func (w *Backup) Start(database, albums bool, force bool, retain int) (err error } if mutex.BackupWorker.Canceled() { - return errors.New("canceled") + return status.ErrCanceled } // Create albums backup. diff --git a/internal/workers/sync.go b/internal/workers/sync.go index a6474b8ed..1f028b009 100644 --- a/internal/workers/sync.go +++ b/internal/workers/sync.go @@ -126,7 +126,7 @@ func (w *Sync) Start() (err error) { case entity.SyncStatusUpload: if complete, uploadErr := w.upload(a); uploadErr != nil { accErrors++ - accError = clip.Chars(uploadErr.Error(), txt.ClipError) + accError = clip.Bytes(uploadErr.Error(), txt.ClipError) syncStatus = entity.SyncStatusRefresh } else if complete { synced = true diff --git a/internal/workers/sync_download.go b/internal/workers/sync_download.go index 6acd02fcc..af67ed180 100644 --- a/internal/workers/sync_download.go +++ b/internal/workers/sync_download.go @@ -95,6 +95,10 @@ func (w *Sync) download(a entity.Service) (complete bool, err error) { return false, err } + // Bound each download to the originals size limit so a remote sync target + // cannot overrun local storage with a single oversized file. + client.SetDownloadLimit(w.conf.OriginalsLimitBytes()) + var baseDir string if a.SyncFilenames { @@ -106,7 +110,7 @@ func (w *Sync) download(a entity.Service) (complete bool, err error) { done := make(map[string]bool) for _, files := range relatedFiles { - if w.conf.FilesQuotaReached() { + if w.conf.InsufficientStorage() { log.Warnf("sync: skipped downloading files from %s due to insufficient storage", clean.Log(a.AccName)) return false, nil } diff --git a/internal/workers/vision.go b/internal/workers/vision.go index c62b81984..f34ba0f3d 100644 --- a/internal/workers/vision.go +++ b/internal/workers/vision.go @@ -270,6 +270,13 @@ func (w *Vision) Start(filter string, count int, models []string, customSrc stri if saveErr := m.SaveVision(); saveErr == nil { updated++ } + + // Save sidecar YAML backup if enabled. + if w.conf.SidecarYaml() { + if yamlErr := m.SaveSidecarYaml(w.conf.OriginalsPath(), w.conf.SidecarPath()); yamlErr != nil { + log.Errorf("vision: %s (save yaml sidecar)", yamlErr) + } + } } if mutex.VisionWorker.Canceled() { diff --git a/internal/workers/workers.go b/internal/workers/workers.go index bda4e5769..22594cd68 100644 --- a/internal/workers/workers.go +++ b/internal/workers/workers.go @@ -1,7 +1,7 @@ /* Package workers provides index, sync, and metadata optimization background workers. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. @@ -97,9 +97,11 @@ func Start(conf *config.Config) { mutex.SyncWorker.Cancel() return case <-ticker.C: - RunMeta(conf) - RunShare(conf) - RunSync(conf) + event.Safe(func() { + RunMeta(conf) + RunShare(conf) + RunSync(conf) + }) } } }() diff --git a/internal/workers/workers_test.go b/internal/workers/workers_test.go index 22deed9ef..01a74eea2 100644 --- a/internal/workers/workers_test.go +++ b/internal/workers/workers_test.go @@ -13,7 +13,12 @@ import ( "github.com/photoprism/photoprism/pkg/fs" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) (code int) { log = logrus.StandardLogger() log.SetLevel(logrus.TraceLevel) event.AuditLog = log @@ -22,19 +27,18 @@ func TestMain(m *testing.M) { fs.PurgeTestDbFiles(".", false) c := config.TestConfig() + defer c.CleanupTestFolder() + defer func() { + if err := c.CloseDb(); err != nil { + log.Warnf("close db: %v", err) + } + // Remove temporary SQLite files after running the tests. + fs.PurgeTestDbFiles(".", false) + }() get.SetConfig(c) photoprism.SetConfig(c) // Run unit tests. - code := m.Run() - - if err := c.CloseDb(); err != nil { - log.Warnf("close db: %v", err) - } - - // Remove temporary SQLite files after running the tests. - fs.PurgeTestDbFiles(".", false) - - os.Exit(code) + return m.Run() } diff --git a/package-lock.json b/package-lock.json index 2953764f0..a0b4a69e8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,87 +14,80 @@ "version": "1", "license": "AGPL-3.0", "dependencies": { - "@babel/cli": "^7.28.6", - "@babel/core": "^7.29.0", - "@babel/plugin-transform-runtime": "^7.29.0", - "@babel/preset-env": "^7.29.0", - "@babel/register": "^7.28.6", - "@babel/runtime": "^7.28.6", - "@eslint/eslintrc": "^3.3.4", + "@babel/cli": "^7.29.7", + "@babel/core": "^7.29.7", + "@babel/plugin-transform-runtime": "^7.29.7", + "@babel/preset-env": "^7.29.7", + "@babel/register": "^7.29.7", + "@babel/runtime": "^7.29.7", + "@eslint/eslintrc": "^3.3.5", "@eslint/js": "^9.33.0", "@mdi/font": "^7.4.47", + "@photo-sphere-viewer/core": "^5.14.3", + "@photo-sphere-viewer/equirectangular-video-adapter": "^5.14.3", + "@photo-sphere-viewer/video-plugin": "^5.14.3", "@testing-library/jest-dom": "^6.9.1", - "@testing-library/react": "^16.3.2", - "@vitejs/plugin-react": "^5.1.4", - "@vitejs/plugin-vue": "^6.0.4", - "@vitest/browser": "^3.2.4", - "@vitest/coverage-v8": "^3.2.4", - "@vitest/ui": "^3.2.4", - "@vue/compiler-sfc": "^3.5.18", - "@vue/language-server": "^3.2.5", - "@vue/test-utils": "^2.4.6", + "@vitejs/plugin-vue": "^6.0.7", + "@vitest/coverage-v8": "^4.1.10", + "@vue/compiler-sfc": "^3.5.39", + "@vue/language-server": "^3.3.6", + "@vue/test-utils": "^2.4.11", "@vvo/tzdb": "^6.198.0", - "axios": "^1.13.6", + "axios": "1.18.1", "axios-mock-adapter": "^2.1.0", - "babel-loader": "^10.0.0", - "babel-plugin-istanbul": "^7.0.1", - "babel-plugin-polyfill-corejs3": "^0.13.0", - "browserslist": "^4.28.1", - "cheerio": "1.0.0-rc.12", - "core-js": "^3.48.0", - "cross-env": "^7.0.3", + "babel-loader": "^10.1.1", + "babel-plugin-polyfill-corejs3": "^0.14.2", + "browserslist": "^4.28.5", + "core-js": "^3.49.0", + "cross-env": "^10.1.0", "css-loader": "^7.1.4", - "cssnano": "^7.1.2", - "escape-string-regexp": "^4.0.0", - "eslint": "^9.39.3", + "cssnano": "^7.1.9", + "eslint": "^9.39.4", "eslint-config-prettier": "^10.1.8", "eslint-formatter-pretty": "^6.0.1", "eslint-plugin-html": "^8.1.4", "eslint-plugin-import": "^2.32.0", "eslint-plugin-node": "^11.1.0", - "eslint-plugin-prettier": "^5.5.5", - "eslint-plugin-vue": "^10.8.0", - "eslint-plugin-vuetify": "^2.5.3", + "eslint-plugin-vue": "^10.9.2", + "eslint-plugin-vuetify": "^2.7.2", "eslint-webpack-plugin": "^5.0.3", "eventsource-polyfill": "^0.9.6", "file-loader": "^6.2.0", "file-saver": "^2.0.5", - "floating-vue": "^5.2.2", - "globals": "^16.5.0", - "hls.js": "^1.6.15", + "globals": "^17.7.0", + "hls.js": "^1.6.16", "i": "^0.3.7", - "jsdom": "^26.1.0", + "jsdom": "^29.1.1", "luxon": "^3.7.2", - "maplibre-gl": "^5.19.0", + "maplibre-gl": "^5.24.0", "memoize-one": "^6.0.0", - "mini-css-extract-plugin": "^2.10.0", + "mini-css-extract-plugin": "^2.10.2", "minimist": "^1.2.8", "node-storage-shim": "^2.0.1", "passive-events-support": "^1.1.0", "photoswipe": "^5.4.4", - "playwright": "^1.58.2", - "postcss": "^8.5.8", + "playwright": "^1.61.1", + "postcss": "^8.5.16", "postcss-import": "^16.1.1", "postcss-loader": "^8.2.1", "postcss-preset-env": "^10.6.1", "postcss-reporter": "^7.1.0", - "postcss-url": "^10.1.3", - "prettier": "^3.8.1", + "prettier": "^3.9.3", "pubsub-js": "^1.9.5", "regenerator-runtime": "^0.14.1", "resolve-url-loader": "^5.0.0", - "sanitize-html": "^2.17.1", - "sass": "^1.97.3", - "sass-loader": "^16.0.7", + "sanitize-html": "^2.17.5", + "sass": "^1.101.0", + "sass-loader": "^16.0.8", "sockette": "^2.0.6", "style-loader": "^4.0.0", - "svg-url-loader": "^8.0.0", - "tar": "^7.5.9", + "svg-url-loader": "^8.1.0", + "tar": "^7.5.19", "url-loader": "^4.1.1", "util": "^0.12.5", - "vite-tsconfig-paths": "^5.1.4", - "vitest": "^3.2.4", - "vue": "^3.5.18", + "vite": "^8.1.3", + "vitest": "^4.1.10", + "vue": "^3.5.39", "vue-3-sanitize": "^0.1.4", "vue-loader": "^17.4.2", "vue-loader-plugin": "^1.3.0", @@ -103,65 +96,80 @@ "vue-sanitize-directive": "^0.2.1", "vue-style-loader": "^4.1.3", "vue3-gettext": "^2.4.0", - "vuetify": "~3.11.9", - "webpack": "^5.105.3", - "webpack-bundle-analyzer": "^4.10.2", + "vuetify": "3.12.2", + "webpack": "5.107.2", + "webpack-bundle-analyzer": "^5.3.0", "webpack-cli": "^6.0.1", "webpack-hot-middleware": "^2.26.1", "webpack-manifest-plugin": "^5.0.1", "webpack-md5-hash": "^0.0.6", "webpack-merge": "^6.0.1", "webpack-plugin-vuetify": "^3.1.3", - "workbox-webpack-plugin": "^7.4.0" + "workbox-webpack-plugin": "^7.4.1" }, "engines": { - "node": ">= 18.0.0", + "node": ">= 22.15.0", "npm": ">= 9.0.0", "yarn": "please use npm" } }, "node_modules/@adobe/css-tools": { - "version": "4.4.4", - "resolved": "https://registry.npmjs.org/@adobe/css-tools/-/css-tools-4.4.4.tgz", - "integrity": "sha512-Elp+iwUx5rN5+Y8xLt5/GRoG20WGoDCQ/1Fb+1LiGtvwbDavuSk0jhD/eZdckHAuzcDzccnkv+rEjyWfRx18gg==", + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/@adobe/css-tools/-/css-tools-4.5.0.tgz", + "integrity": "sha512-6OzddxPio9UiWTCemp4N8cYLV2ZN1ncRnV1cVGtve7dhPOtRkleRyx32GQCYSwDYgaHU3USMm84tNsvKzRCa1Q==", "license": "MIT" }, - "node_modules/@ampproject/remapping": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.3.0.tgz", - "integrity": "sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw==", - "license": "Apache-2.0", - "dependencies": { - "@jridgewell/gen-mapping": "^0.3.5", - "@jridgewell/trace-mapping": "^0.3.24" - }, - "engines": { - "node": ">=6.0.0" - } - }, "node_modules/@asamuzakjp/css-color": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/@asamuzakjp/css-color/-/css-color-3.2.0.tgz", - "integrity": "sha512-K1A6z8tS3XsmCMM86xoWdn7Fkdn9m6RSVtocUrJYIwZnFVkng/PvkEoWtOWmP+Scc6saYWHWZYbndEEXxl24jw==", + "version": "5.1.11", + "resolved": "https://registry.npmjs.org/@asamuzakjp/css-color/-/css-color-5.1.11.tgz", + "integrity": "sha512-KVw6qIiCTUQhByfTd78h2yD1/00waTmm9uy/R7Ck/ctUyAPj+AEDLkQIdJW0T8+qGgj3j5bpNKK7Q3G+LedJWg==", "license": "MIT", "dependencies": { - "@csstools/css-calc": "^2.1.3", - "@csstools/css-color-parser": "^3.0.9", - "@csstools/css-parser-algorithms": "^3.0.4", - "@csstools/css-tokenizer": "^3.0.3", - "lru-cache": "^10.4.3" + "@asamuzakjp/generational-cache": "^1.0.1", + "@csstools/css-calc": "^3.2.0", + "@csstools/css-color-parser": "^4.1.0", + "@csstools/css-parser-algorithms": "^4.0.0", + "@csstools/css-tokenizer": "^4.0.0" + }, + "engines": { + "node": "^20.19.0 || ^22.12.0 || >=24.0.0" } }, - "node_modules/@asamuzakjp/css-color/node_modules/lru-cache": { - "version": "10.4.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", - "integrity": "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==", - "license": "ISC" + "node_modules/@asamuzakjp/dom-selector": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/@asamuzakjp/dom-selector/-/dom-selector-7.1.1.tgz", + "integrity": "sha512-67RZDnYRc8H/8MLDgQCDE//zoqVFwajkepHZgmXrbwybzXOEwOWGPYGmALYl9J2DOLfFPPs6kKCqmbzV895hTQ==", + "license": "MIT", + "dependencies": { + "@asamuzakjp/generational-cache": "^1.0.1", + "@asamuzakjp/nwsapi": "^2.3.9", + "bidi-js": "^1.0.3", + "css-tree": "^3.2.1", + "is-potential-custom-element-name": "^1.0.1" + }, + "engines": { + "node": "^20.19.0 || ^22.12.0 || >=24.0.0" + } + }, + "node_modules/@asamuzakjp/generational-cache": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@asamuzakjp/generational-cache/-/generational-cache-1.0.1.tgz", + "integrity": "sha512-wajfB8KqzMCN2KGNFdLkReeHncd0AslUSrvHVvvYWuU8ghncRJoA50kT3zP9MVL0+9g4/67H+cdvBskj9THPzg==", + "license": "MIT", + "engines": { + "node": "^20.19.0 || ^22.12.0 || >=24.0.0" + } + }, + "node_modules/@asamuzakjp/nwsapi": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/@asamuzakjp/nwsapi/-/nwsapi-2.3.9.tgz", + "integrity": "sha512-n8GuYSrI9bF7FFZ/SjhwevlHc8xaVlb/7HmHelnc/PZXBD2ZR49NnN9sMMuDdEGPeeRQ5d0hqlSlEpgCX3Wl0Q==", + "license": "MIT" }, "node_modules/@babel/cli": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/cli/-/cli-7.28.6.tgz", - "integrity": "sha512-6EUNcuBbNkj08Oj4gAZ+BUU8yLCgKzgVX4gaTh09Ya2C8ICM4P+G30g4m3akRxSYAp3A/gnWchrNst7px4/nUQ==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/cli/-/cli-7.29.7.tgz", + "integrity": "sha512-/75HwRbAYPqXv/Ax1h7Fg3IZfXgdU98jnA8H93/m/QBaPV3Hp5ICoLqzGYye1yHBCgpmXvtqgSUN8oOKX5tojQ==", "license": "MIT", "dependencies": { "@jridgewell/trace-mapping": "^0.3.28", @@ -188,12 +196,12 @@ } }, "node_modules/@babel/code-frame": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.29.0.tgz", - "integrity": "sha512-9NhCeYjq9+3uxgdtp20LSiJXJvN0FeCtNGpJxuMFZ1Kv3cWUNb6DOhJwUvcVCzKGR66cw4njwM6hrJLqgOwbcw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.29.7.tgz", + "integrity": "sha512-Aup7aUOfpbAUg2ROOJN6Iw5f9DMBlzu0mIkm/malLQFN/YQgO48wCj0Kxa3sEHJvPVFg7siR+qRInwXd2qhQKw==", "license": "MIT", "dependencies": { - "@babel/helper-validator-identifier": "^7.28.5", + "@babel/helper-validator-identifier": "^7.29.7", "js-tokens": "^4.0.0", "picocolors": "^1.1.1" }, @@ -202,29 +210,29 @@ } }, "node_modules/@babel/compat-data": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.29.0.tgz", - "integrity": "sha512-T1NCJqT/j9+cn8fvkt7jtwbLBfLC/1y1c7NtCeXFRgzGTsafi68MRv8yzkYSapBnFA6L3U2VSc02ciDzoAJhJg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.29.7.tgz", + "integrity": "sha512-locTkQyKvwIEgBzVrn8693ebc97F2U8ZHjbXwDXJ5Fn2TCpNwTlKcaKLkdHop5c/icOFE7qt7Q9JC5hnKNa6Gg==", "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/core": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.29.0.tgz", - "integrity": "sha512-CGOfOJqWjg2qW/Mb6zNsDm+u5vFQ8DxXfbM09z69p5Z6+mE1ikP2jUXw+j42Pf1XTYED2Rni5f95npYeuwMDQA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.29.7.tgz", + "integrity": "sha512-RgHBCvtjbOK2gXSNBNIkNoEc9qoVEtau3hj8gEqKQuL3HZAibKarWFEI3Lfm6EYKkLalOh8eSrj9b+ch9H/VBA==", "license": "MIT", "dependencies": { - "@babel/code-frame": "^7.29.0", - "@babel/generator": "^7.29.0", - "@babel/helper-compilation-targets": "^7.28.6", - "@babel/helper-module-transforms": "^7.28.6", - "@babel/helpers": "^7.28.6", - "@babel/parser": "^7.29.0", - "@babel/template": "^7.28.6", - "@babel/traverse": "^7.29.0", - "@babel/types": "^7.29.0", + "@babel/code-frame": "^7.29.7", + "@babel/generator": "^7.29.7", + "@babel/helper-compilation-targets": "^7.29.7", + "@babel/helper-module-transforms": "^7.29.7", + "@babel/helpers": "^7.29.7", + "@babel/parser": "^7.29.7", + "@babel/template": "^7.29.7", + "@babel/traverse": "^7.29.7", + "@babel/types": "^7.29.7", "@jridgewell/remapping": "^2.3.5", "convert-source-map": "^2.0.0", "debug": "^4.1.0", @@ -241,13 +249,13 @@ } }, "node_modules/@babel/generator": { - "version": "7.29.1", - "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.29.1.tgz", - "integrity": "sha512-qsaF+9Qcm2Qv8SRIMMscAvG4O3lJ0F1GuMo5HR/Bp02LopNgnZBC/EkbevHFeGs4ls/oPz9v+Bsmzbkbe+0dUw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.29.7.tgz", + "integrity": "sha512-DkXD5OJQaAQIdZ1bt3UZdEnHAn9Imd3IVBdX03UFe+ony9Ojw5pzr9YVKGDY1jt+Gcn/FnGkNf8r+Vj5NOJWtQ==", "license": "MIT", "dependencies": { - "@babel/parser": "^7.29.0", - "@babel/types": "^7.29.0", + "@babel/parser": "^7.29.7", + "@babel/types": "^7.29.7", "@jridgewell/gen-mapping": "^0.3.12", "@jridgewell/trace-mapping": "^0.3.28", "jsesc": "^3.0.2" @@ -257,25 +265,25 @@ } }, "node_modules/@babel/helper-annotate-as-pure": { - "version": "7.27.3", - "resolved": "https://registry.npmjs.org/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.27.3.tgz", - "integrity": "sha512-fXSwMQqitTGeHLBC08Eq5yXz2m37E4pJX1qAU1+2cNedz/ifv/bVXft90VeSav5nFO61EcNgwr0aJxbyPaWBPg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.29.7.tgz", + "integrity": "sha512-OoK6239jHPuSQOoS0kfTVKn0b/rVTk0seKq4Gd2UMLtmOVLjDC0ki3e+c90Trqv2gMfvJFqkiljrr568+qddiw==", "license": "MIT", "dependencies": { - "@babel/types": "^7.27.3" + "@babel/types": "^7.29.7" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-compilation-targets": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.28.6.tgz", - "integrity": "sha512-JYtls3hqi15fcx5GaSNL7SCTJ2MNmjrkHXg4FSpOA/grxK8KwyZ5bubHsCq8FXCkua6xhuaaBit+3b7+VZRfcA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.29.7.tgz", + "integrity": "sha512-wem6WaBj4NaVYVdNhLPPVacES6ZJ+KBBfSkTMD3YZxbP3rm3Di85tJU5ljaUNhaOynt+Aj0xruhYuzQBt8n71g==", "license": "MIT", "dependencies": { - "@babel/compat-data": "^7.28.6", - "@babel/helper-validator-option": "^7.27.1", + "@babel/compat-data": "^7.29.7", + "@babel/helper-validator-option": "^7.29.7", "browserslist": "^4.24.0", "lru-cache": "^5.1.1", "semver": "^6.3.1" @@ -285,17 +293,17 @@ } }, "node_modules/@babel/helper-create-class-features-plugin": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.28.6.tgz", - "integrity": "sha512-dTOdvsjnG3xNT9Y0AUg1wAl38y+4Rl4sf9caSQZOXdNqVn+H+HbbJ4IyyHaIqNR6SW9oJpA/RuRjsjCw2IdIow==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.29.7.tgz", + "integrity": "sha512-IY3ZD9Tmooqr3TUhc3DUWxiuo8xx1DWLhd5M7hQ+ZWJamqM2BbalrBJb2MisSLoYorOj75U03qULCxQTY9r3hg==", "license": "MIT", "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.3", - "@babel/helper-member-expression-to-functions": "^7.28.5", - "@babel/helper-optimise-call-expression": "^7.27.1", - "@babel/helper-replace-supers": "^7.28.6", - "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", - "@babel/traverse": "^7.28.6", + "@babel/helper-annotate-as-pure": "^7.29.7", + "@babel/helper-member-expression-to-functions": "^7.29.7", + "@babel/helper-optimise-call-expression": "^7.29.7", + "@babel/helper-replace-supers": "^7.29.7", + "@babel/helper-skip-transparent-expression-wrappers": "^7.29.7", + "@babel/traverse": "^7.29.7", "semver": "^6.3.1" }, "engines": { @@ -306,12 +314,12 @@ } }, "node_modules/@babel/helper-create-regexp-features-plugin": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.28.5.tgz", - "integrity": "sha512-N1EhvLtHzOvj7QQOUCCS3NrPJP8c5W6ZXCHDn7Yialuy1iu4r5EmIYkXlKNqT99Ciw+W0mDqWoR6HWMZlFP3hw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.29.7.tgz", + "integrity": "sha512-907Uymvqgg1dwUA+7IGwFAOSYzQOuzPXKNJ1yxzwPffzkYFg2q2eHi1fIOs6sXkG9NbIUMunnUlkYsfRFNvomg==", "license": "MIT", "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.3", + "@babel/helper-annotate-as-pure": "^7.29.7", "regexpu-core": "^6.3.1", "semver": "^6.3.1" }, @@ -323,9 +331,9 @@ } }, "node_modules/@babel/helper-define-polyfill-provider": { - "version": "0.6.6", - "resolved": "https://registry.npmjs.org/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.6.6.tgz", - "integrity": "sha512-mOAsxeeKkUKayvZR3HeTYD/fICpCPLJrU5ZjelT/PA6WHtNDBOE436YiaEUvHN454bRM3CebhDsIpieCc4texA==", + "version": "0.6.8", + "resolved": "https://registry.npmjs.org/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.6.8.tgz", + "integrity": "sha512-47UwBLPpQi1NoWzLuHNjRoHlYXMwIJoBf7MFou6viC/sIHWYygpvr0B6IAyh5sBdA2nr2LPIRww8lfaUVQINBA==", "license": "MIT", "dependencies": { "@babel/helper-compilation-targets": "^7.28.6", @@ -339,49 +347,49 @@ } }, "node_modules/@babel/helper-globals": { - "version": "7.28.0", - "resolved": "https://registry.npmjs.org/@babel/helper-globals/-/helper-globals-7.28.0.tgz", - "integrity": "sha512-+W6cISkXFa1jXsDEdYA8HeevQT/FULhxzR99pxphltZcVaugps53THCeiWA8SguxxpSp3gKPiuYfSWopkLQ4hw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-globals/-/helper-globals-7.29.7.tgz", + "integrity": "sha512-3nQVUAtvkKH9zahfWgw96Jc/uFOmjACE1kQz82E2lqWmHBgjzbNlsC22nuQTfahmWeQtTq5nQ/4Nnd2A1wj4zA==", "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-member-expression-to-functions": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.28.5.tgz", - "integrity": "sha512-cwM7SBRZcPCLgl8a7cY0soT1SptSzAlMH39vwiRpOQkJlh53r5hdHwLSCZpQdVLT39sZt+CRpNwYG4Y2v77atg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.29.7.tgz", + "integrity": "sha512-j+7JYmk1JYDtACIGj0QJqqWZjoUpMoEikQGADMaHgCMCSDqd2+P32rfcibUNrGOMWrlzK1WJBdxrB3JJQZwWtg==", "license": "MIT", "dependencies": { - "@babel/traverse": "^7.28.5", - "@babel/types": "^7.28.5" + "@babel/traverse": "^7.29.7", + "@babel/types": "^7.29.7" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-module-imports": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.28.6.tgz", - "integrity": "sha512-l5XkZK7r7wa9LucGw9LwZyyCUscb4x37JWTPz7swwFE/0FMQAGpiWUZn8u9DzkSBWEcK25jmvubfpw2dnAMdbw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.29.7.tgz", + "integrity": "sha512-ejHwrQQYcm9xnTivShn2IDOlIzInN34AXskvq9QicvCtEzq1Vzclu/tKF8Jq1Cg8JG2GL6/EmjgsCT7lXepE3g==", "license": "MIT", "dependencies": { - "@babel/traverse": "^7.28.6", - "@babel/types": "^7.28.6" + "@babel/traverse": "^7.29.7", + "@babel/types": "^7.29.7" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-module-transforms": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.28.6.tgz", - "integrity": "sha512-67oXFAYr2cDLDVGLXTEABjdBJZ6drElUSI7WKp70NrpyISso3plG9SAGEF6y7zbha/wOzUByWWTJvEDVNIUGcA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.29.7.tgz", + "integrity": "sha512-UPUVSyXbOh627KiCIGQSgwWzGeBKLkaJ9PJEdrngIwMSzxLR4jS4+f1f1jb7VzBbg8nFLaYotvVPFCTqdrmTAg==", "license": "MIT", "dependencies": { - "@babel/helper-module-imports": "^7.28.6", - "@babel/helper-validator-identifier": "^7.28.5", - "@babel/traverse": "^7.28.6" + "@babel/helper-module-imports": "^7.29.7", + "@babel/helper-validator-identifier": "^7.29.7", + "@babel/traverse": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -391,35 +399,35 @@ } }, "node_modules/@babel/helper-optimise-call-expression": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.27.1.tgz", - "integrity": "sha512-URMGH08NzYFhubNSGJrpUEphGKQwMQYBySzat5cAByY1/YgIRkULnIy3tAMeszlL/so2HbeilYloUmSpd7GdVw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.29.7.tgz", + "integrity": "sha512-+kmGVjcT9RGYzoDwdwEqEvGgKe3BYq+O1iGzjFubaNgZHwYHP6lsF2Yghf4kEuv9BV7tYDZ913aBW9am6YKong==", "license": "MIT", "dependencies": { - "@babel/types": "^7.27.1" + "@babel/types": "^7.29.7" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-plugin-utils": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.28.6.tgz", - "integrity": "sha512-S9gzZ/bz83GRysI7gAD4wPT/AI3uCnY+9xn+Mx/KPs2JwHJIz1W8PZkg2cqyt3RNOBM8ejcXhV6y8Og7ly/Dug==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.29.7.tgz", + "integrity": "sha512-G7sHYigPY17oO5SYWnfD/0MTBwVR781S/JI643e/JhUYgVgWE/61SoW3NH9KWUKyKq5LVh3npif99Wkt6j86Jw==", "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-remap-async-to-generator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.27.1.tgz", - "integrity": "sha512-7fiA521aVw8lSPeI4ZOD3vRFkoqkJcS+z4hFo82bFSH/2tNd6eJ5qCVMS5OzDmZh/kaHQeBaeyxK6wljcPtveA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.29.7.tgz", + "integrity": "sha512-16AMiW26DbXWBbr3B8wNozKM0ydMLB892vaOaJW/fPJdnT8vJk5sdkQcU/isqUxyCE0cEoa8wZOcbgDuC4b6Og==", "license": "MIT", "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.1", - "@babel/helper-wrap-function": "^7.27.1", - "@babel/traverse": "^7.27.1" + "@babel/helper-annotate-as-pure": "^7.29.7", + "@babel/helper-wrap-function": "^7.29.7", + "@babel/traverse": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -429,14 +437,14 @@ } }, "node_modules/@babel/helper-replace-supers": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.28.6.tgz", - "integrity": "sha512-mq8e+laIk94/yFec3DxSjCRD2Z0TAjhVbEJY3UQrlwVo15Lmt7C2wAUbK4bjnTs4APkwsYLTahXRraQXhb1WCg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.29.7.tgz", + "integrity": "sha512-atfGXWSeCiF4DnKZIfmJfQRkSw9b9gNNXR1kqKjbhG4pGYCOnkp8OcTB8E3NXjBu8NpheSnOeNKz8KT7UNFTmQ==", "license": "MIT", "dependencies": { - "@babel/helper-member-expression-to-functions": "^7.28.5", - "@babel/helper-optimise-call-expression": "^7.27.1", - "@babel/traverse": "^7.28.6" + "@babel/helper-member-expression-to-functions": "^7.29.7", + "@babel/helper-optimise-call-expression": "^7.29.7", + "@babel/traverse": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -446,79 +454,79 @@ } }, "node_modules/@babel/helper-skip-transparent-expression-wrappers": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.27.1.tgz", - "integrity": "sha512-Tub4ZKEXqbPjXgWLl2+3JpQAYBJ8+ikpQ2Ocj/q/r0LwE3UhENh7EUabyHjz2kCEsrRY83ew2DQdHluuiDQFzg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.29.7.tgz", + "integrity": "sha512-brcMGQaVzIeUb+6/bs1Av0f8YuNNjKY2JyvfRCsFuFsdKccEQ5Ges2y74D74NZ1Rz8lKJ9ksJkfqwQFJ/iNEyQ==", "license": "MIT", "dependencies": { - "@babel/traverse": "^7.27.1", - "@babel/types": "^7.27.1" + "@babel/traverse": "^7.29.7", + "@babel/types": "^7.29.7" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-string-parser": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz", - "integrity": "sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.29.7.tgz", + "integrity": "sha512-Pb5ijPrZ89GDH8223L4UP8i6QApWxs04RbPQJTeWDV0/keR2E36MeKnyr6LYmUUvqRRI+Iv87SuF1W6ErINzYw==", "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-validator-identifier": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz", - "integrity": "sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.29.7.tgz", + "integrity": "sha512-qehxGkRj55h/ff8EMaJ+cYhyaKlHIxqYDn682wQD7RNp9UujOQsHog2uS0r2vzr4pW+sXf90NeeayjcNaX3fFg==", "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-validator-option": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.27.1.tgz", - "integrity": "sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.29.7.tgz", + "integrity": "sha512-N9ZErrD+yW5geCDtBqnOoxmR8+tNKiGuxKlDpuJxfsqpa2dFcexaziGAE/qoHLiDDreVNMupxGmSoNlyvsA3gw==", "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-wrap-function": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helper-wrap-function/-/helper-wrap-function-7.28.6.tgz", - "integrity": "sha512-z+PwLziMNBeSQJonizz2AGnndLsP2DeGHIxDAn+wdHOGuo4Fo1x1HBPPXeE9TAOPHNNWQKCSlA2VZyYyyibDnQ==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-wrap-function/-/helper-wrap-function-7.29.7.tgz", + "integrity": "sha512-iES0Skag9ERIF68aXadpO6dbXa03mNWK3sEqJaMnLNs/eC3l0lkImdfoy6Y09/SfkpawdAB4RjQ7PVA7TcVGdw==", "license": "MIT", "dependencies": { - "@babel/template": "^7.28.6", - "@babel/traverse": "^7.28.6", - "@babel/types": "^7.28.6" + "@babel/template": "^7.29.7", + "@babel/traverse": "^7.29.7", + "@babel/types": "^7.29.7" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helpers": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.28.6.tgz", - "integrity": "sha512-xOBvwq86HHdB7WUDTfKfT/Vuxh7gElQ+Sfti2Cy6yIWNW05P8iUslOVcZ4/sKbE+/jQaukQAdz/gf3724kYdqw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.29.7.tgz", + "integrity": "sha512-1k2lAGRMfHTcwuNYcCNUmaUffmQv8KWMfh2iJUUeRlwlwH4FdNG7mfPI10NPfLHJFThE4Tyr4mv7kTNZOiPuBg==", "license": "MIT", "dependencies": { - "@babel/template": "^7.28.6", - "@babel/types": "^7.28.6" + "@babel/template": "^7.29.7", + "@babel/types": "^7.29.7" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/parser": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.29.0.tgz", - "integrity": "sha512-IyDgFV5GeDUVX4YdF/3CPULtVGSXXMLh1xVIgdCgxApktqnQV0r7/8Nqthg+8YLGaAtdyIlo2qIdZrbCv4+7ww==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.29.7.tgz", + "integrity": "sha512-hnORnjP/1P/zFEndoeX+n+t1RwWRJiJpM/jO7FW32Kn9r5+sJB2JWOdYo4L6k78j15eCwY3Gm/7364B1EMwtNg==", "license": "MIT", "dependencies": { - "@babel/types": "^7.29.0" + "@babel/types": "^7.29.7" }, "bin": { "parser": "bin/babel-parser.js" @@ -528,13 +536,13 @@ } }, "node_modules/@babel/plugin-bugfix-firefox-class-in-computed-class-key": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-firefox-class-in-computed-class-key/-/plugin-bugfix-firefox-class-in-computed-class-key-7.28.5.tgz", - "integrity": "sha512-87GDMS3tsmMSi/3bWOte1UblL+YUTFMV8SZPZ2eSEL17s74Cw/l63rR6NmGVKMYW2GYi85nE+/d6Hw5N0bEk2Q==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-firefox-class-in-computed-class-key/-/plugin-bugfix-firefox-class-in-computed-class-key-7.29.7.tgz", + "integrity": "sha512-j8SrR0zLZrRsC09DlszEx8FpMiwukKffYXMK0d5LmOglO7vGG6sz/BR/20yHqWH+Lnn31JTt2PE3hIWNgM2J6w==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/traverse": "^7.28.5" + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/traverse": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -544,12 +552,12 @@ } }, "node_modules/@babel/plugin-bugfix-safari-class-field-initializer-scope": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-class-field-initializer-scope/-/plugin-bugfix-safari-class-field-initializer-scope-7.27.1.tgz", - "integrity": "sha512-qNeq3bCKnGgLkEXUuFry6dPlGfCdQNZbn7yUAPCInwAJHMU7THJfrBSozkcWq5sNM6RcF3S8XyQL2A52KNR9IA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-class-field-initializer-scope/-/plugin-bugfix-safari-class-field-initializer-scope-7.29.7.tgz", + "integrity": "sha512-r8j8escF+U2FUHo0KOhPUdMzUO+jp9fInva6+ACVAF3Y97Ev+5iNZwiqTghmzNeWwDkOPlYuTcfb1vDaoZKmAQ==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -559,12 +567,28 @@ } }, "node_modules/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression/-/plugin-bugfix-safari-id-destructuring-collision-in-function-expression-7.27.1.tgz", - "integrity": "sha512-g4L7OYun04N1WyqMNjldFwlfPCLVkgB54A/YCXICZYBsvJJE3kByKv9c9+R/nAfmIfjl2rKYLNyMHboYbZaWaA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression/-/plugin-bugfix-safari-id-destructuring-collision-in-function-expression-7.29.7.tgz", + "integrity": "sha512-GE1TFSiuFeGsCxmYXZl8HwoPrVlwe4rHPFE8weieGKZqnDORK+Ar3vgWMgW+AOxQ6/2TgLSKx9p6W7O4rC6qgQ==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-bugfix-safari-rest-destructuring-rhs-array": { + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-rest-destructuring-rhs-array/-/plugin-bugfix-safari-rest-destructuring-rhs-array-7.29.7.tgz", + "integrity": "sha512-oBNVCvnO5tND+xSopWvV8WNGfpTfgP4Zr/YXXSj8zfmcPktp5Ku/aZlsIowgSD4fjmgHn6sGmB9APVsU5zOdhA==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/helper-skip-transparent-expression-wrappers": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -574,14 +598,14 @@ } }, "node_modules/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining/-/plugin-bugfix-v8-spread-parameters-in-optional-chaining-7.27.1.tgz", - "integrity": "sha512-oO02gcONcD5O1iTLi/6frMJBIwWEHceWGSGqrpCmEL8nogiS6J9PBlE48CaK20/Jx1LuRml9aDftLgdjXT8+Cw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining/-/plugin-bugfix-v8-spread-parameters-in-optional-chaining-7.29.7.tgz", + "integrity": "sha512-QQt9qKHZ2sg/kivaLr7lnQr8HVrQDdBNSfCsTjiDxRuX/K5ORyKq+Bu8Xr0cDE3Dfkv0cw28Ve0EKyKMvulkOw==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", - "@babel/plugin-transform-optional-chaining": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/helper-skip-transparent-expression-wrappers": "^7.29.7", + "@babel/plugin-transform-optional-chaining": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -591,13 +615,13 @@ } }, "node_modules/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly/-/plugin-bugfix-v8-static-class-fields-redefine-readonly-7.28.6.tgz", - "integrity": "sha512-a0aBScVTlNaiUe35UtfxAN7A/tehvvG4/ByO6+46VPKTRSlfnAFsgKy0FUh+qAkQrDTmhDkT+IBOKlOoMUxQ0g==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly/-/plugin-bugfix-v8-static-class-fields-redefine-readonly-7.29.7.tgz", + "integrity": "sha512-pn6QacGLgvCcwc+syUhKE/qSjV2D1IHDB84RNxWYSt1mW3K/SCtjinZ2p0cETJxAWBjPy3K/1lHwG5BjjPxNlw==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/traverse": "^7.28.6" + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/traverse": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -619,12 +643,12 @@ } }, "node_modules/@babel/plugin-syntax-import-assertions": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-assertions/-/plugin-syntax-import-assertions-7.28.6.tgz", - "integrity": "sha512-pSJUpFHdx9z5nqTSirOCMtYVP2wFgoWhP0p3g8ONK/4IHhLIBd0B9NYqAvIUAhq+OkhO4VM1tENCt0cjlsNShw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-assertions/-/plugin-syntax-import-assertions-7.29.7.tgz", + "integrity": "sha512-/An1OCBN93thpBAGyfsK2pcf0jvju1SAtKkL2Ny++B5Sy6sqgzXDQH1cZxWbF96Wuk+bn41MDA9bLd4VVAw6rw==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -634,12 +658,12 @@ } }, "node_modules/@babel/plugin-syntax-import-attributes": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.28.6.tgz", - "integrity": "sha512-jiLC0ma9XkQT3TKJ9uYvlakm66Pamywo+qwL+oL8HJOvc6TWdZXVfhqJr8CCzbSGUAbDOzlGHJC1U+vRfLQDvw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.29.7.tgz", + "integrity": "sha512-zGYcYfq/WmZ4V+kBIXQon9dSSc8ircGZqw9ZaNhhGj9nZkeBu1jHLBDQqYYi5WA9uawvA2sIMbry2nCFhf5Djg==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -665,12 +689,12 @@ } }, "node_modules/@babel/plugin-transform-arrow-functions": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.27.1.tgz", - "integrity": "sha512-8Z4TGic6xW70FKThA5HYEKKyBpOOsucTOD1DjU3fZxDg+K3zBJcXMFnt/4yQiZnf5+MiOMSXQ9PaEK/Ilh1DeA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.29.7.tgz", + "integrity": "sha512-N7zArUXWzAMzm+/N0uPBeVB3Fam5lMxtUwMmDK5f/IBBS7a7p1qeUoxd/6CckXoxUdgsntq1Dh8xNW06maZbDQ==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -680,14 +704,14 @@ } }, "node_modules/@babel/plugin-transform-async-generator-functions": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.29.0.tgz", - "integrity": "sha512-va0VdWro4zlBr2JsXC+ofCPB2iG12wPtVGTWFx2WLDOM3nYQZZIGP82qku2eW/JR83sD+k2k+CsNtyEbUqhU6w==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.29.7.tgz", + "integrity": "sha512-d98gXZkgswvkyohMBABkhm3GeXhYj8psWfwQ2C7gtfrKGTykQa/iOIi+JJhwMjPlZ6Vm2XN+DCf3Es1EoG4ZLA==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/helper-remap-async-to-generator": "^7.27.1", - "@babel/traverse": "^7.29.0" + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/helper-remap-async-to-generator": "^7.29.7", + "@babel/traverse": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -697,14 +721,14 @@ } }, "node_modules/@babel/plugin-transform-async-to-generator": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.28.6.tgz", - "integrity": "sha512-ilTRcmbuXjsMmcZ3HASTe4caH5Tpo93PkTxF9oG2VZsSWsahydmcEHhix9Ik122RcTnZnUzPbmux4wh1swfv7g==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.29.7.tgz", + "integrity": "sha512-pcUb2SS+RMo9TWVBwKGI5ShtoG7R+zBsFmCKDa6fe8c+hPr3XJlZgoE5j6i8W7gDjhyvy+85vmYexanvXh3d1w==", "license": "MIT", "dependencies": { - "@babel/helper-module-imports": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/helper-remap-async-to-generator": "^7.27.1" + "@babel/helper-module-imports": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/helper-remap-async-to-generator": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -714,12 +738,12 @@ } }, "node_modules/@babel/plugin-transform-block-scoped-functions": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoped-functions/-/plugin-transform-block-scoped-functions-7.27.1.tgz", - "integrity": "sha512-cnqkuOtZLapWYZUYM5rVIdv1nXYuFVIltZ6ZJ7nIj585QsjKM5dhL2Fu/lICXZ1OyIAFc7Qy+bvDAtTXqGrlhg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoped-functions/-/plugin-transform-block-scoped-functions-7.29.7.tgz", + "integrity": "sha512-cUSmjh72N+rN4PrkFlN1dJwNCwjVp5d38/CQrEsFggkD10UiFlBFgdH3tv5dNsLuHY+3S8db2xCHjhZcv5WgvA==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -729,12 +753,12 @@ } }, "node_modules/@babel/plugin-transform-block-scoping": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.28.6.tgz", - "integrity": "sha512-tt/7wOtBmwHPNMPu7ax4pdPz6shjFrmHDghvNC+FG9Qvj7D6mJcoRQIF5dy4njmxR941l6rgtvfSB2zX3VlUIw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.29.7.tgz", + "integrity": "sha512-ONyr4+AZhKh8yKWInVxU9AXA9EbsyeLcL6V0dJy6M2/62vuvpGm29zzuymbTpdc451GEpDIdAyPLP3r+P61yKQ==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -744,13 +768,13 @@ } }, "node_modules/@babel/plugin-transform-class-properties": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-properties/-/plugin-transform-class-properties-7.28.6.tgz", - "integrity": "sha512-dY2wS3I2G7D697VHndN91TJr8/AAfXQNt5ynCTI/MpxMsSzHp+52uNivYT5wCPax3whc47DR8Ba7cmlQMg24bw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-properties/-/plugin-transform-class-properties-7.29.7.tgz", + "integrity": "sha512-GtcpjFvanPfzNQi3eTitsCqtRRmmqzpy/A+yhTR1HaZo1Ly3EA8ZXxlPyHdR8/IuRMYc3E4wdGBewB2QKQjAaA==", "license": "MIT", "dependencies": { - "@babel/helper-create-class-features-plugin": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-create-class-features-plugin": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -760,13 +784,13 @@ } }, "node_modules/@babel/plugin-transform-class-static-block": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.28.6.tgz", - "integrity": "sha512-rfQ++ghVwTWTqQ7w8qyDxL1XGihjBss4CmTgGRCTAC9RIbhVpyp4fOeZtta0Lbf+dTNIVJer6ych2ibHwkZqsQ==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.29.7.tgz", + "integrity": "sha512-kibJgmEdX2iMwsHY2tSZNDgj8PwIlCQz7FK9KuGKO8zsuoUwSEhoNnNVp/emKWrbY4HeO6kkXfdMqRKKKXBm2A==", "license": "MIT", "dependencies": { - "@babel/helper-create-class-features-plugin": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-create-class-features-plugin": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -776,17 +800,17 @@ } }, "node_modules/@babel/plugin-transform-classes": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-classes/-/plugin-transform-classes-7.28.6.tgz", - "integrity": "sha512-EF5KONAqC5zAqT783iMGuM2ZtmEBy+mJMOKl2BCvPZ2lVrwvXnB6o+OBWCS+CoeCCpVRF2sA2RBKUxvT8tQT5Q==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-classes/-/plugin-transform-classes-7.29.7.tgz", + "integrity": "sha512-qV0OGGBVacduzQHE649JyCneOFI/maT+YKsO+K4Yi3xv2wTPNjM/W2o2gdzMwEAZz7fXNTHAe0NcSg30bIN69g==", "license": "MIT", "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.3", - "@babel/helper-compilation-targets": "^7.28.6", - "@babel/helper-globals": "^7.28.0", - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/helper-replace-supers": "^7.28.6", - "@babel/traverse": "^7.28.6" + "@babel/helper-annotate-as-pure": "^7.29.7", + "@babel/helper-compilation-targets": "^7.29.7", + "@babel/helper-globals": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/helper-replace-supers": "^7.29.7", + "@babel/traverse": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -796,13 +820,13 @@ } }, "node_modules/@babel/plugin-transform-computed-properties": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.28.6.tgz", - "integrity": "sha512-bcc3k0ijhHbc2lEfpFHgx7eYw9KNXqOerKWfzbxEHUGKnS3sz9C4CNL9OiFN1297bDNfUiSO7DaLzbvHQQQ1BQ==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.29.7.tgz", + "integrity": "sha512-RK7/IyU5phpuCdBAuig5VkzG/EnbDaui5SQGdU9BFrHdV+mV4cUjLMQ9lJDjLNtWHsqtiefpGZUXQP2BiTYMsA==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/template": "^7.28.6" + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/template": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -812,13 +836,13 @@ } }, "node_modules/@babel/plugin-transform-destructuring": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.28.5.tgz", - "integrity": "sha512-Kl9Bc6D0zTUcFUvkNuQh4eGXPKKNDOJQXVyyM4ZAQPMveniJdxi8XMJwLo+xSoW3MIq81bD33lcUe9kZpl0MCw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.29.7.tgz", + "integrity": "sha512-iPX8aD6H9zV5s7ZsqTdNocPN/MGQ5sSMnElKrktxjJRMnB2jN/1p2+R7GkfD6CAYoVFqy5A4XnSIUeGgJzIWpg==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/traverse": "^7.28.5" + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/traverse": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -828,13 +852,13 @@ } }, "node_modules/@babel/plugin-transform-dotall-regex": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.28.6.tgz", - "integrity": "sha512-SljjowuNKB7q5Oayv4FoPzeB74g3QgLt8IVJw9ADvWy3QnUb/01aw8I4AVv8wYnPvQz2GDDZ/g3GhcNyDBI4Bg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.29.7.tgz", + "integrity": "sha512-3qc18hsD2RdZiyJNDNc7HQpv6xbncwh8FYtxNFFzclSyh/trPD9KkVR9BDECUjDLvb7yJVF15GfYUuC+LMkkiQ==", "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.28.5", - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-create-regexp-features-plugin": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -844,12 +868,12 @@ } }, "node_modules/@babel/plugin-transform-duplicate-keys": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-keys/-/plugin-transform-duplicate-keys-7.27.1.tgz", - "integrity": "sha512-MTyJk98sHvSs+cvZ4nOauwTTG1JeonDjSGvGGUNHreGQns+Mpt6WX/dVzWBHgg+dYZhkC4X+zTDfkTU+Vy9y7Q==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-keys/-/plugin-transform-duplicate-keys-7.29.7.tgz", + "integrity": "sha512-6IvRRriEMqnBwD6chtxdLpMYCHWEzN+oL5cyQtjykya19UgzbmKhxmhZgKC/LHxS2nYr9Q/qYPZ5Lr6jOL9+yQ==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -859,13 +883,13 @@ } }, "node_modules/@babel/plugin-transform-duplicate-named-capturing-groups-regex": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-named-capturing-groups-regex/-/plugin-transform-duplicate-named-capturing-groups-regex-7.29.0.tgz", - "integrity": "sha512-zBPcW2lFGxdiD8PUnPwJjag2J9otbcLQzvbiOzDxpYXyCuYX9agOwMPGn1prVH0a4qzhCKu24rlH4c1f7yA8rw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-named-capturing-groups-regex/-/plugin-transform-duplicate-named-capturing-groups-regex-7.29.7.tgz", + "integrity": "sha512-2wiIyo2BjtgU7HufSeDnL9L2O7zr8jmhFKuSr65VpRkUiRKRNpb0mdlk56+XPPKoIrfHqzbMuglDvZun0RISsA==", "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.28.5", - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-create-regexp-features-plugin": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -875,12 +899,12 @@ } }, "node_modules/@babel/plugin-transform-dynamic-import": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dynamic-import/-/plugin-transform-dynamic-import-7.27.1.tgz", - "integrity": "sha512-MHzkWQcEmjzzVW9j2q8LGjwGWpG2mjwaaB0BNQwst3FIjqsg8Ct/mIZlvSPJvfi9y2AC8mi/ktxbFVL9pZ1I4A==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dynamic-import/-/plugin-transform-dynamic-import-7.29.7.tgz", + "integrity": "sha512-giOlEm/EFjfjr+te9NsdjkUo2v4f8rS/SXPumRVHAtbNcyNlvtREkU1dZzaIDclNpnaVhlCqRdFKhJBjBikzLg==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -890,13 +914,13 @@ } }, "node_modules/@babel/plugin-transform-explicit-resource-management": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-explicit-resource-management/-/plugin-transform-explicit-resource-management-7.28.6.tgz", - "integrity": "sha512-Iao5Konzx2b6g7EPqTy40UZbcdXE126tTxVFr/nAIj+WItNxjKSYTEw3RC+A2/ZetmdJsgueL1KhaMCQHkLPIg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-explicit-resource-management/-/plugin-transform-explicit-resource-management-7.29.7.tgz", + "integrity": "sha512-Rstj7coNz8sE+7Ju7ihpHLI564lsK5pUpNNlvptCIC/16E/S5hbl6n3kESPKdNRmqEWlpn5xpS5Q2dvXBsySLw==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/plugin-transform-destructuring": "^7.28.5" + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/plugin-transform-destructuring": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -906,12 +930,12 @@ } }, "node_modules/@babel/plugin-transform-exponentiation-operator": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.28.6.tgz", - "integrity": "sha512-WitabqiGjV/vJ0aPOLSFfNY1u9U3R7W36B03r5I2KoNix+a3sOhJ3pKFB3R5It9/UiK78NiO0KE9P21cMhlPkw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.29.7.tgz", + "integrity": "sha512-zFpMOTLZBdW5LfObqcSbL6kefg4R4eLdmvS0wbN9M6D5Mym/sKm9toOoWyVOa+xDjvCnuWcHls2YonXwHvH3CQ==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -921,12 +945,12 @@ } }, "node_modules/@babel/plugin-transform-export-namespace-from": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-export-namespace-from/-/plugin-transform-export-namespace-from-7.27.1.tgz", - "integrity": "sha512-tQvHWSZ3/jH2xuq/vZDy0jNn+ZdXJeM8gHvX4lnJmsc3+50yPlWdZXIc5ay+umX+2/tJIqHqiEqcJvxlmIvRvQ==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-export-namespace-from/-/plugin-transform-export-namespace-from-7.29.7.tgz", + "integrity": "sha512-24B2nOy2TeJSMheqwPD4DDQOV/elLSIlKxjZt4i05H5AgdPdWR3n18HnNrcJ+j76WJd9gbwb9jPjNYUy6RautA==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -936,13 +960,13 @@ } }, "node_modules/@babel/plugin-transform-for-of": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.27.1.tgz", - "integrity": "sha512-BfbWFFEJFQzLCQ5N8VocnCtA8J1CLkNTe2Ms2wocj75dd6VpiqS5Z5quTYcUoo4Yq+DN0rtikODccuv7RU81sw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.29.7.tgz", + "integrity": "sha512-zeSIHh0+E1Um1WJRXCFlHQYu2ieJNdivLLjlBEp+dIBu3S51n+SZZmIXjxnItw6pz56Cn+KvK68BIBVsxq2JiQ==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/helper-skip-transparent-expression-wrappers": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -952,14 +976,14 @@ } }, "node_modules/@babel/plugin-transform-function-name": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-function-name/-/plugin-transform-function-name-7.27.1.tgz", - "integrity": "sha512-1bQeydJF9Nr1eBCMMbC+hdwmRlsv5XYOMu03YSWFwNs0HsAmtSxxF1fyuYPqemVldVyFmlCU7w8UE14LupUSZQ==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-function-name/-/plugin-transform-function-name-7.29.7.tgz", + "integrity": "sha512-otRWaHXE6fbAGkePvaj/kvs3HsqXfPhlnzwSOlnFgbqCPMd975dW+4wZ00WFBt+/YlBGcJwNrARQTOJOb4ZrIg==", "license": "MIT", "dependencies": { - "@babel/helper-compilation-targets": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/traverse": "^7.27.1" + "@babel/helper-compilation-targets": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/traverse": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -969,12 +993,12 @@ } }, "node_modules/@babel/plugin-transform-json-strings": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-json-strings/-/plugin-transform-json-strings-7.28.6.tgz", - "integrity": "sha512-Nr+hEN+0geQkzhbdgQVPoqr47lZbm+5fCUmO70722xJZd0Mvb59+33QLImGj6F+DkK3xgDi1YVysP8whD6FQAw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-json-strings/-/plugin-transform-json-strings-7.29.7.tgz", + "integrity": "sha512-RRnE2+eon1rJAq8MnoF1b5kTpY1vU88twHcvcKMrsqP/jxIRqDVs9iJB5fqPuqyeFAW0wJo4MlUIPpQCq/aRsg==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -984,12 +1008,12 @@ } }, "node_modules/@babel/plugin-transform-literals": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-literals/-/plugin-transform-literals-7.27.1.tgz", - "integrity": "sha512-0HCFSepIpLTkLcsi86GG3mTUzxV5jpmbv97hTETW3yzrAij8aqlD36toB1D0daVFJM8NK6GvKO0gslVQmm+zZA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-literals/-/plugin-transform-literals-7.29.7.tgz", + "integrity": "sha512-DZ/oLP21ZuWx1vKqnoNv6/tvEK48AQOBRai40CX9dTjGluvT/YZCyY3rryDtyUqCEoyNroy5KKPwX2iQCiRvyw==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -999,12 +1023,12 @@ } }, "node_modules/@babel/plugin-transform-logical-assignment-operators": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-logical-assignment-operators/-/plugin-transform-logical-assignment-operators-7.28.6.tgz", - "integrity": "sha512-+anKKair6gpi8VsM/95kmomGNMD0eLz1NQ8+Pfw5sAwWH9fGYXT50E55ZpV0pHUHWf6IUTWPM+f/7AAff+wr9A==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-logical-assignment-operators/-/plugin-transform-logical-assignment-operators-7.29.7.tgz", + "integrity": "sha512-A0H91hh6W8MFRkp5TqJmMr39jzGD1A1E1Ysiv2O06Sfbhkapm+XyIzxWCEh5kqwOZ1/8QZ0dY3SeQ7XBqfJd5Q==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1014,12 +1038,12 @@ } }, "node_modules/@babel/plugin-transform-member-expression-literals": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-member-expression-literals/-/plugin-transform-member-expression-literals-7.27.1.tgz", - "integrity": "sha512-hqoBX4dcZ1I33jCSWcXrP+1Ku7kdqXf1oeah7ooKOIiAdKQ+uqftgCFNOSzA5AMS2XIHEYeGFg4cKRCdpxzVOQ==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-member-expression-literals/-/plugin-transform-member-expression-literals-7.29.7.tgz", + "integrity": "sha512-hl1kwFZCCiDyfH25Xmco9jTrkPgnS9pmOzSG7W5I4SaGbLeqKv417hcU2RKmaxoPEgsoJh7ZPOrnPGq99bHoUg==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1029,13 +1053,13 @@ } }, "node_modules/@babel/plugin-transform-modules-amd": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.27.1.tgz", - "integrity": "sha512-iCsytMg/N9/oFq6n+gFTvUYDZQOMK5kEdeYxmxt91fcJGycfxVP9CnrxoliM0oumFERba2i8ZtwRUCMhvP1LnA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.29.7.tgz", + "integrity": "sha512-fxtQoH3m5ywUSIfaH0FGCzWu4McsYon5bD3K4XnskC7f+OyQMj7rsOMi4NvvmJ83WwBAg4UCe+ov4VZlqEvyew==", "license": "MIT", "dependencies": { - "@babel/helper-module-transforms": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-module-transforms": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1045,13 +1069,13 @@ } }, "node_modules/@babel/plugin-transform-modules-commonjs": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.28.6.tgz", - "integrity": "sha512-jppVbf8IV9iWWwWTQIxJMAJCWBuuKx71475wHwYytrRGQ2CWiDvYlADQno3tcYpS/T2UUWFQp3nVtYfK/YBQrA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.29.7.tgz", + "integrity": "sha512-j0vCldybPC5b5dwCQOJ21uKtHzt7hxLygJTg9eF1ScfaikEDNfzn94XoW5Fi+seBR0nCyL23xaBFFkq7dTM8XQ==", "license": "MIT", "dependencies": { - "@babel/helper-module-transforms": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-module-transforms": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1061,15 +1085,15 @@ } }, "node_modules/@babel/plugin-transform-modules-systemjs": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.29.0.tgz", - "integrity": "sha512-PrujnVFbOdUpw4UHiVwKvKRLMMic8+eC0CuNlxjsyZUiBjhFdPsewdXCkveh2KqBA9/waD0W1b4hXSOBQJezpQ==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.29.7.tgz", + "integrity": "sha512-TM2ZcQLoG2/y4HODiStCo10DibYhWhGWAwVv+EQKmG/7GFl0N+AAmUiXOMKM+aiJ9XBJ9AHVZBvTzMnJ2sM3cQ==", "license": "MIT", "dependencies": { - "@babel/helper-module-transforms": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/helper-validator-identifier": "^7.28.5", - "@babel/traverse": "^7.29.0" + "@babel/helper-module-transforms": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/helper-validator-identifier": "^7.29.7", + "@babel/traverse": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1079,13 +1103,13 @@ } }, "node_modules/@babel/plugin-transform-modules-umd": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-umd/-/plugin-transform-modules-umd-7.27.1.tgz", - "integrity": "sha512-iQBE/xC5BV1OxJbp6WG7jq9IWiD+xxlZhLrdwpPkTX3ydmXdvoCpyfJN7acaIBZaOqTfr76pgzqBJflNbeRK+w==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-umd/-/plugin-transform-modules-umd-7.29.7.tgz", + "integrity": "sha512-B4UkaTK3QpgCwJnrxKfMPKdo92CN7OKXAlpAAnM3UPu0Q0lCCk57ylA9AJbRy2v8dDKOPAAWcoR6CMyeoHwRCA==", "license": "MIT", "dependencies": { - "@babel/helper-module-transforms": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-module-transforms": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1095,13 +1119,13 @@ } }, "node_modules/@babel/plugin-transform-named-capturing-groups-regex": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.29.0.tgz", - "integrity": "sha512-1CZQA5KNAD6ZYQLPw7oi5ewtDNxH/2vuCh+6SmvgDfhumForvs8a1o9n0UrEoBD8HU4djO2yWngTQlXl1NDVEQ==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.29.7.tgz", + "integrity": "sha512-vuFoLwr4qnv2xbZ16SQd6uPcH5FNrLHhk/Jzo++0XJFcaDsr4gjJVg6j398oMHiC+83k/GiBzviwF5KBJkPUtQ==", "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.28.5", - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-create-regexp-features-plugin": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1111,12 +1135,12 @@ } }, "node_modules/@babel/plugin-transform-new-target": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-new-target/-/plugin-transform-new-target-7.27.1.tgz", - "integrity": "sha512-f6PiYeqXQ05lYq3TIfIDu/MtliKUbNwkGApPUvyo6+tc7uaR4cPjPe7DFPr15Uyycg2lZU6btZ575CuQoYh7MQ==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-new-target/-/plugin-transform-new-target-7.29.7.tgz", + "integrity": "sha512-fEo41GmsOUhOBlw8ioo6zvjX5Xc2Lqkzlyfqbpsk3eB6TReV18uhxZ0esfEokVbY2+PVJAQHNKxER6lGrzNd3A==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1126,12 +1150,12 @@ } }, "node_modules/@babel/plugin-transform-nullish-coalescing-operator": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-nullish-coalescing-operator/-/plugin-transform-nullish-coalescing-operator-7.28.6.tgz", - "integrity": "sha512-3wKbRgmzYbw24mDJXT7N+ADXw8BC/imU9yo9c9X9NKaLF1fW+e5H1U5QjMUBe4Qo4Ox/o++IyUkl1sVCLgevKg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-nullish-coalescing-operator/-/plugin-transform-nullish-coalescing-operator-7.29.7.tgz", + "integrity": "sha512-idmp1dFaekP9GbcMvG24Kvw2BfhFZjHnNJCkV4WuIY4PskJzwI3f1N5OdgYke38T7rftO6ERulFRn2cFeZwRkg==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1141,12 +1165,12 @@ } }, "node_modules/@babel/plugin-transform-numeric-separator": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-numeric-separator/-/plugin-transform-numeric-separator-7.28.6.tgz", - "integrity": "sha512-SJR8hPynj8outz+SlStQSwvziMN4+Bq99it4tMIf5/Caq+3iOc0JtKyse8puvyXkk3eFRIA5ID/XfunGgO5i6w==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-numeric-separator/-/plugin-transform-numeric-separator-7.29.7.tgz", + "integrity": "sha512-zR7fv/z14OjgHl4AgRtkDBvBMhIzCxqV/qN/2BCRC7LjFwvuzjYe7gDWxC4Wl/SNsLM6SE1IWvRPYMgSJaUvNw==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1156,16 +1180,16 @@ } }, "node_modules/@babel/plugin-transform-object-rest-spread": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.28.6.tgz", - "integrity": "sha512-5rh+JR4JBC4pGkXLAcYdLHZjXudVxWMXbB6u6+E9lRL5TrGVbHt1TjxGbZ8CkmYw9zjkB7jutzOROArsqtncEA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.29.7.tgz", + "integrity": "sha512-Ld98jn4c0smUywL57m7SgsHq3OpThOa6LqZJif3G6jYOovPleoFhVrBJ1WegRApSFB2wu4+RelAj9AC9G08Z4A==", "license": "MIT", "dependencies": { - "@babel/helper-compilation-targets": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/plugin-transform-destructuring": "^7.28.5", - "@babel/plugin-transform-parameters": "^7.27.7", - "@babel/traverse": "^7.28.6" + "@babel/helper-compilation-targets": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/plugin-transform-destructuring": "^7.29.7", + "@babel/plugin-transform-parameters": "^7.29.7", + "@babel/traverse": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1175,13 +1199,13 @@ } }, "node_modules/@babel/plugin-transform-object-super": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-super/-/plugin-transform-object-super-7.27.1.tgz", - "integrity": "sha512-SFy8S9plRPbIcxlJ8A6mT/CxFdJx/c04JEctz4jf8YZaVS2px34j7NXRrlGlHkN/M2gnpL37ZpGRGVFLd3l8Ng==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-super/-/plugin-transform-object-super-7.29.7.tgz", + "integrity": "sha512-Ea/diGcw0twB5IlZPO5sgET6fJsLJqPABqTuFWIR+iMPGPZJkATEIWx0wa+aEQ5UY1CBQyP/gkAiLEqn1vBiQA==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-replace-supers": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/helper-replace-supers": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1191,12 +1215,12 @@ } }, "node_modules/@babel/plugin-transform-optional-catch-binding": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-catch-binding/-/plugin-transform-optional-catch-binding-7.28.6.tgz", - "integrity": "sha512-R8ja/Pyrv0OGAvAXQhSTmWyPJPml+0TMqXlO5w+AsMEiwb2fg3WkOvob7UxFSL3OIttFSGSRFKQsOhJ/X6HQdQ==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-catch-binding/-/plugin-transform-optional-catch-binding-7.29.7.tgz", + "integrity": "sha512-sLsyndxK2VwX6yNUOakMb7Sh553ZTe/vVM1XJ+9Z5aW1ytsc8xOIwmyk05NNjN60vkc5/KqoTH6hB4V41LJhng==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1206,13 +1230,13 @@ } }, "node_modules/@babel/plugin-transform-optional-chaining": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-chaining/-/plugin-transform-optional-chaining-7.28.6.tgz", - "integrity": "sha512-A4zobikRGJTsX9uqVFdafzGkqD30t26ck2LmOzAuLL8b2x6k3TIqRiT2xVvA9fNmFeTX484VpsdgmKNA0bS23w==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-chaining/-/plugin-transform-optional-chaining-7.29.7.tgz", + "integrity": "sha512-6GM1dhvK3gNODkXcEcMCOLEDCLSoZ/sBbro2Ax8HURyasQ4NshagQixkRFdh5niI6E4gmA/jYI/4aT7rRos3ZQ==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/helper-skip-transparent-expression-wrappers": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1222,12 +1246,12 @@ } }, "node_modules/@babel/plugin-transform-parameters": { - "version": "7.27.7", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.27.7.tgz", - "integrity": "sha512-qBkYTYCb76RRxUM6CcZA5KRu8K4SM8ajzVeUgVdMVO9NN9uI/GaVmBg/WKJJGnNokV9SY8FxNOVWGXzqzUidBg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.29.7.tgz", + "integrity": "sha512-ZDOBqV/qLYJI0YElr8DcENEyARsFQeESqWXH6gZlghYXuPPjvweuDhP4VyEi4BlUBlLRFZVjxoZDMjxhLW766g==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1237,13 +1261,13 @@ } }, "node_modules/@babel/plugin-transform-private-methods": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-methods/-/plugin-transform-private-methods-7.28.6.tgz", - "integrity": "sha512-piiuapX9CRv7+0st8lmuUlRSmX6mBcVeNQ1b4AYzJxfCMuBfB0vBXDiGSmm03pKJw1v6cZ8KSeM+oUnM6yAExg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-methods/-/plugin-transform-private-methods-7.29.7.tgz", + "integrity": "sha512-/6Rz4DK1ETDEM/bWHsPHcaEe7ZaT1EqSXjtSP/L0DijOYuaUhiRiOKcwpZ8P7zR4xXEHc2ITdiCgBm9Tpyv9ug==", "license": "MIT", "dependencies": { - "@babel/helper-create-class-features-plugin": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-create-class-features-plugin": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1253,14 +1277,14 @@ } }, "node_modules/@babel/plugin-transform-private-property-in-object": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-property-in-object/-/plugin-transform-private-property-in-object-7.28.6.tgz", - "integrity": "sha512-b97jvNSOb5+ehyQmBpmhOCiUC5oVK4PMnpRvO7+ymFBoqYjeDHIU9jnrNUuwHOiL9RpGDoKBpSViarV+BU+eVA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-property-in-object/-/plugin-transform-private-property-in-object-7.29.7.tgz", + "integrity": "sha512-+BNo06dnrzdNNqCm1X6YUaVv0DKk8Q+JYcoZfOkLhYWNCXzlwTSRq8zGWayT1csjcpNXV9CQTBRRbmTLZac5cA==", "license": "MIT", "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.3", - "@babel/helper-create-class-features-plugin": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-annotate-as-pure": "^7.29.7", + "@babel/helper-create-class-features-plugin": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1270,42 +1294,12 @@ } }, "node_modules/@babel/plugin-transform-property-literals": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-property-literals/-/plugin-transform-property-literals-7.27.1.tgz", - "integrity": "sha512-oThy3BCuCha8kDZ8ZkgOg2exvPYUlprMukKQXI1r1pJ47NCvxfkEy8vK+r/hT9nF0Aa4H1WUPZZjHTFtAhGfmQ==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-property-literals/-/plugin-transform-property-literals-7.29.7.tgz", + "integrity": "sha512-bOMRLQuI0A5ZqHq3OWJ89/rXpJ/NJrbVhXiP4zwPGMs6kpcVsuTUNjwoE30K0Qm3mf48a/TnRYYD6vPNqcg6jA==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-react-jsx-self": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx-self/-/plugin-transform-react-jsx-self-7.27.1.tgz", - "integrity": "sha512-6UzkCs+ejGdZ5mFFC/OCUrv028ab2fp1znZmCZjAOBKiBK2jXD1O+BPSfX8X2qjJ75fZBMSnQn3Rq2mrBJK2mw==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-react-jsx-source": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx-source/-/plugin-transform-react-jsx-source-7.27.1.tgz", - "integrity": "sha512-zbwoTsBruTeKB9hSq73ha66iFeJHuaFkUbwvqElnygoNbj/jHRsSeokowZFN3CZ64IvEqcmmkVe89OPXc7ldAw==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1315,12 +1309,12 @@ } }, "node_modules/@babel/plugin-transform-regenerator": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.29.0.tgz", - "integrity": "sha512-FijqlqMA7DmRdg/aINBSs04y8XNTYw/lr1gJ2WsmBnnaNw1iS43EPkJW+zK7z65auG3AWRFXWj+NcTQwYptUog==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.29.7.tgz", + "integrity": "sha512-rNNFV0DBAJp988xW2DOntfDoYn1eR8GGF5AT5vYc+rjyfaQkM242c9tZUHHPe7KYaiJizXPWhQTzzdbXySyhBw==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1330,13 +1324,13 @@ } }, "node_modules/@babel/plugin-transform-regexp-modifiers": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regexp-modifiers/-/plugin-transform-regexp-modifiers-7.28.6.tgz", - "integrity": "sha512-QGWAepm9qxpaIs7UM9FvUSnCGlb8Ua1RhyM4/veAxLwt3gMat/LSGrZixyuj4I6+Kn9iwvqCyPTtbdxanYoWYg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regexp-modifiers/-/plugin-transform-regexp-modifiers-7.29.7.tgz", + "integrity": "sha512-mB5Fs0VWrJ42ZCmc8114v60qetdaUVNkj9PmSZRmanCZM3S9hm0CFRLjRmYIsuXav14l2jvZ+4T8iiCGnhj3nQ==", "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.28.5", - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-create-regexp-features-plugin": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1346,12 +1340,12 @@ } }, "node_modules/@babel/plugin-transform-reserved-words": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-reserved-words/-/plugin-transform-reserved-words-7.27.1.tgz", - "integrity": "sha512-V2ABPHIJX4kC7HegLkYoDpfg9PVmuWy/i6vUM5eGK22bx4YVFD3M5F0QQnWQoDs6AGsUWTVOopBiMFQgHaSkVw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-reserved-words/-/plugin-transform-reserved-words-7.29.7.tgz", + "integrity": "sha512-5+YhdpVgmfSmwZyLMftfaiffLRMHjzIRHFHHLdibcSyJm2pasMrKHrO3Ptrt2DRshjvpgjEJJ1zVW14WPq/6QA==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1361,13 +1355,13 @@ } }, "node_modules/@babel/plugin-transform-runtime": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.29.0.tgz", - "integrity": "sha512-jlaRT5dJtMaMCV6fAuLbsQMSwz/QkvaHOHOSXRitGGwSpR1blCY4KUKoyP2tYO8vJcqYe8cEj96cqSztv3uF9w==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.29.7.tgz", + "integrity": "sha512-xmAscdE/AsqRW7vutbPNoUmu/nF5SrLKPs7aoJgEjo35lLKA/Bc0i2rMv/hr1+Y0o1bQCiVtith3u2vdgRL39Q==", "license": "MIT", "dependencies": { - "@babel/helper-module-imports": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-module-imports": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7", "babel-plugin-polyfill-corejs2": "^0.4.14", "babel-plugin-polyfill-corejs3": "^0.13.0", "babel-plugin-polyfill-regenerator": "^0.6.5", @@ -1380,13 +1374,26 @@ "@babel/core": "^7.0.0-0" } }, - "node_modules/@babel/plugin-transform-shorthand-properties": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-shorthand-properties/-/plugin-transform-shorthand-properties-7.27.1.tgz", - "integrity": "sha512-N/wH1vcn4oYawbJ13Y/FxcQrWk63jhfNa7jef0ih7PHSIHX2LB7GWE1rkPrOnka9kwMxb6hMl19p7lidA+EHmQ==", + "node_modules/@babel/plugin-transform-runtime/node_modules/babel-plugin-polyfill-corejs3": { + "version": "0.13.0", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.13.0.tgz", + "integrity": "sha512-U+GNwMdSFgzVmfhNm8GJUX88AadB3uo9KpJqS3FaqNIPKgySuvMb+bHPsOmmuWyIcuqZj/pzt1RUIUZns4y2+A==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-define-polyfill-provider": "^0.6.5", + "core-js-compat": "^3.43.0" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/@babel/plugin-transform-shorthand-properties": { + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-shorthand-properties/-/plugin-transform-shorthand-properties-7.29.7.tgz", + "integrity": "sha512-I+WYbGBAiCn7nA6xBrlgPH+MB7HWb4u8pv5S0Pv7OtwNvIFvCCb24YlttKEeUFVurfBCEaOTnuhlqsb7f0Z5Dg==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1396,13 +1403,13 @@ } }, "node_modules/@babel/plugin-transform-spread": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-spread/-/plugin-transform-spread-7.28.6.tgz", - "integrity": "sha512-9U4QObUC0FtJl05AsUcodau/RWDytrU6uKgkxu09mLR9HLDAtUMoPuuskm5huQsoktmsYpI+bGmq+iapDcriKA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-spread/-/plugin-transform-spread-7.29.7.tgz", + "integrity": "sha512-/u5K1QWada7tbYNqTjMh96718g9NTwh9tfPJMsSmVsQwGT447FskV+KcfeXkXq2GWki4EM/MuTdmBec+hOuVTQ==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/helper-skip-transparent-expression-wrappers": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1412,12 +1419,12 @@ } }, "node_modules/@babel/plugin-transform-sticky-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-sticky-regex/-/plugin-transform-sticky-regex-7.27.1.tgz", - "integrity": "sha512-lhInBO5bi/Kowe2/aLdBAawijx+q1pQzicSgnkB6dUPc1+RC8QmJHKf2OjvU+NZWitguJHEaEmbV6VWEouT58g==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-sticky-regex/-/plugin-transform-sticky-regex-7.29.7.tgz", + "integrity": "sha512-BCHzNYJGe9l7EpwwDBN/ztlL2NYFFq8hp9ddjtUEM9f2O7S7kKV/lL6Fwo7IF7NSkYhPK2vO+86nIGltA90MsA==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1427,12 +1434,12 @@ } }, "node_modules/@babel/plugin-transform-template-literals": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-template-literals/-/plugin-transform-template-literals-7.27.1.tgz", - "integrity": "sha512-fBJKiV7F2DxZUkg5EtHKXQdbsbURW3DZKQUWphDum0uRP6eHGGa/He9mc0mypL680pb+e/lDIthRohlv8NCHkg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-template-literals/-/plugin-transform-template-literals-7.29.7.tgz", + "integrity": "sha512-NCSEJ4sLFU2gqAub45HYh4fus2yQ36rr6ei6vpU7NdoJqCpxvEG8E6eJpscGyXP3VHD2Ny+fSXr04k1hoUrFqA==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1442,12 +1449,12 @@ } }, "node_modules/@babel/plugin-transform-typeof-symbol": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typeof-symbol/-/plugin-transform-typeof-symbol-7.27.1.tgz", - "integrity": "sha512-RiSILC+nRJM7FY5srIyc4/fGIwUhyDuuBSdWn4y6yT6gm652DpCHZjIipgn6B7MQ1ITOUnAKWixEUjQRIBIcLw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typeof-symbol/-/plugin-transform-typeof-symbol-7.29.7.tgz", + "integrity": "sha512-223mNGoTkBiTEWFoK+Q6Go3tueMRclO8vxxxxquNCYuNI4jWOofFKJRRDu6SDrB8Sgo1UEGW9T4GAQ8ZyRso1A==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1457,12 +1464,12 @@ } }, "node_modules/@babel/plugin-transform-unicode-escapes": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-escapes/-/plugin-transform-unicode-escapes-7.27.1.tgz", - "integrity": "sha512-Ysg4v6AmF26k9vpfFuTZg8HRfVWzsh1kVfowA23y9j/Gu6dOuahdUVhkLqpObp3JIv27MLSii6noRnuKN8H0Mg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-escapes/-/plugin-transform-unicode-escapes-7.29.7.tgz", + "integrity": "sha512-jCfXxSjf94lf4E0hKE0AByxF6F3/pVFqRdUUNkDJhsY0m1ZKjnN6ZYyMeHNpzflxb/0q5b7t3p+BE+SLF1WOtA==", "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1472,13 +1479,13 @@ } }, "node_modules/@babel/plugin-transform-unicode-property-regex": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-property-regex/-/plugin-transform-unicode-property-regex-7.28.6.tgz", - "integrity": "sha512-4Wlbdl/sIZjzi/8St0evF0gEZrgOswVO6aOzqxh1kDZOl9WmLrHq2HtGhnOJZmHZYKP8WZ1MDLCt5DAWwRo57A==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-property-regex/-/plugin-transform-unicode-property-regex-7.29.7.tgz", + "integrity": "sha512-OgZ+zoAJgZLUCunsTRQ5LAjOywDv5zzZ2/hQ5aMw1pGXyY2rtE8/chXYUmu3AlVHKpm10KEdG9aMwbI/K76ZGw==", "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.28.5", - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-create-regexp-features-plugin": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1488,13 +1495,13 @@ } }, "node_modules/@babel/plugin-transform-unicode-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.27.1.tgz", - "integrity": "sha512-xvINq24TRojDuyt6JGtHmkVkrfVV3FPT16uytxImLeBZqW3/H52yN+kM1MGuyPkIQxrzKwPHs5U/MP3qKyzkGw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.29.7.tgz", + "integrity": "sha512-7D/x/23/d/3VqZ0QA+LGbZMlGwZjztBygSWWWsfTPoQ1oQ6Q1P6Mr3d0kk42XabyUVw+fha3LqdRsFqeKqvCyA==", "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-regexp-features-plugin": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1504,13 +1511,13 @@ } }, "node_modules/@babel/plugin-transform-unicode-sets-regex": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-sets-regex/-/plugin-transform-unicode-sets-regex-7.28.6.tgz", - "integrity": "sha512-/wHc/paTUmsDYN7SZkpWxogTOBNnlx7nBQYfy6JJlCT7G3mVhltk3e++N7zV0XfgGsrqBxd4rJQt9H16I21Y1Q==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-sets-regex/-/plugin-transform-unicode-sets-regex-7.29.7.tgz", + "integrity": "sha512-BLOhLht9DOJwIxlmp91wHvkXv1lguuHS3/FwUO8HL1H0u8s4hR1gASVFyilu9iGtcTRYqjTZmlsFFeQletntEg==", "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.28.5", - "@babel/helper-plugin-utils": "^7.28.6" + "@babel/helper-create-regexp-features-plugin": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1520,75 +1527,76 @@ } }, "node_modules/@babel/preset-env": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.29.0.tgz", - "integrity": "sha512-fNEdfc0yi16lt6IZo2Qxk3knHVdfMYX33czNb4v8yWhemoBhibCpQK/uYHtSKIiO+p/zd3+8fYVXhQdOVV608w==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.29.7.tgz", + "integrity": "sha512-GYzX36n1nsciIb0uyH0GHwxwtNwPQIcpxSeiVLDtG/B7jB5xXgchnmL1f/jCX5o+pwnaDBtO60ONSJhEBJfxYA==", "license": "MIT", "dependencies": { - "@babel/compat-data": "^7.29.0", - "@babel/helper-compilation-targets": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/helper-validator-option": "^7.27.1", - "@babel/plugin-bugfix-firefox-class-in-computed-class-key": "^7.28.5", - "@babel/plugin-bugfix-safari-class-field-initializer-scope": "^7.27.1", - "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": "^7.27.1", - "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": "^7.27.1", - "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": "^7.28.6", + "@babel/compat-data": "^7.29.7", + "@babel/helper-compilation-targets": "^7.29.7", + "@babel/helper-plugin-utils": "^7.29.7", + "@babel/helper-validator-option": "^7.29.7", + "@babel/plugin-bugfix-firefox-class-in-computed-class-key": "^7.29.7", + "@babel/plugin-bugfix-safari-class-field-initializer-scope": "^7.29.7", + "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": "^7.29.7", + "@babel/plugin-bugfix-safari-rest-destructuring-rhs-array": "^7.29.7", + "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": "^7.29.7", + "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": "^7.29.7", "@babel/plugin-proposal-private-property-in-object": "7.21.0-placeholder-for-preset-env.2", - "@babel/plugin-syntax-import-assertions": "^7.28.6", - "@babel/plugin-syntax-import-attributes": "^7.28.6", + "@babel/plugin-syntax-import-assertions": "^7.29.7", + "@babel/plugin-syntax-import-attributes": "^7.29.7", "@babel/plugin-syntax-unicode-sets-regex": "^7.18.6", - "@babel/plugin-transform-arrow-functions": "^7.27.1", - "@babel/plugin-transform-async-generator-functions": "^7.29.0", - "@babel/plugin-transform-async-to-generator": "^7.28.6", - "@babel/plugin-transform-block-scoped-functions": "^7.27.1", - "@babel/plugin-transform-block-scoping": "^7.28.6", - "@babel/plugin-transform-class-properties": "^7.28.6", - "@babel/plugin-transform-class-static-block": "^7.28.6", - "@babel/plugin-transform-classes": "^7.28.6", - "@babel/plugin-transform-computed-properties": "^7.28.6", - "@babel/plugin-transform-destructuring": "^7.28.5", - "@babel/plugin-transform-dotall-regex": "^7.28.6", - "@babel/plugin-transform-duplicate-keys": "^7.27.1", - "@babel/plugin-transform-duplicate-named-capturing-groups-regex": "^7.29.0", - "@babel/plugin-transform-dynamic-import": "^7.27.1", - "@babel/plugin-transform-explicit-resource-management": "^7.28.6", - "@babel/plugin-transform-exponentiation-operator": "^7.28.6", - "@babel/plugin-transform-export-namespace-from": "^7.27.1", - "@babel/plugin-transform-for-of": "^7.27.1", - "@babel/plugin-transform-function-name": "^7.27.1", - "@babel/plugin-transform-json-strings": "^7.28.6", - "@babel/plugin-transform-literals": "^7.27.1", - "@babel/plugin-transform-logical-assignment-operators": "^7.28.6", - "@babel/plugin-transform-member-expression-literals": "^7.27.1", - "@babel/plugin-transform-modules-amd": "^7.27.1", - "@babel/plugin-transform-modules-commonjs": "^7.28.6", - "@babel/plugin-transform-modules-systemjs": "^7.29.0", - "@babel/plugin-transform-modules-umd": "^7.27.1", - "@babel/plugin-transform-named-capturing-groups-regex": "^7.29.0", - "@babel/plugin-transform-new-target": "^7.27.1", - "@babel/plugin-transform-nullish-coalescing-operator": "^7.28.6", - "@babel/plugin-transform-numeric-separator": "^7.28.6", - "@babel/plugin-transform-object-rest-spread": "^7.28.6", - "@babel/plugin-transform-object-super": "^7.27.1", - "@babel/plugin-transform-optional-catch-binding": "^7.28.6", - "@babel/plugin-transform-optional-chaining": "^7.28.6", - "@babel/plugin-transform-parameters": "^7.27.7", - "@babel/plugin-transform-private-methods": "^7.28.6", - "@babel/plugin-transform-private-property-in-object": "^7.28.6", - "@babel/plugin-transform-property-literals": "^7.27.1", - "@babel/plugin-transform-regenerator": "^7.29.0", - "@babel/plugin-transform-regexp-modifiers": "^7.28.6", - "@babel/plugin-transform-reserved-words": "^7.27.1", - "@babel/plugin-transform-shorthand-properties": "^7.27.1", - "@babel/plugin-transform-spread": "^7.28.6", - "@babel/plugin-transform-sticky-regex": "^7.27.1", - "@babel/plugin-transform-template-literals": "^7.27.1", - "@babel/plugin-transform-typeof-symbol": "^7.27.1", - "@babel/plugin-transform-unicode-escapes": "^7.27.1", - "@babel/plugin-transform-unicode-property-regex": "^7.28.6", - "@babel/plugin-transform-unicode-regex": "^7.27.1", - "@babel/plugin-transform-unicode-sets-regex": "^7.28.6", + "@babel/plugin-transform-arrow-functions": "^7.29.7", + "@babel/plugin-transform-async-generator-functions": "^7.29.7", + "@babel/plugin-transform-async-to-generator": "^7.29.7", + "@babel/plugin-transform-block-scoped-functions": "^7.29.7", + "@babel/plugin-transform-block-scoping": "^7.29.7", + "@babel/plugin-transform-class-properties": "^7.29.7", + "@babel/plugin-transform-class-static-block": "^7.29.7", + "@babel/plugin-transform-classes": "^7.29.7", + "@babel/plugin-transform-computed-properties": "^7.29.7", + "@babel/plugin-transform-destructuring": "^7.29.7", + "@babel/plugin-transform-dotall-regex": "^7.29.7", + "@babel/plugin-transform-duplicate-keys": "^7.29.7", + "@babel/plugin-transform-duplicate-named-capturing-groups-regex": "^7.29.7", + "@babel/plugin-transform-dynamic-import": "^7.29.7", + "@babel/plugin-transform-explicit-resource-management": "^7.29.7", + "@babel/plugin-transform-exponentiation-operator": "^7.29.7", + "@babel/plugin-transform-export-namespace-from": "^7.29.7", + "@babel/plugin-transform-for-of": "^7.29.7", + "@babel/plugin-transform-function-name": "^7.29.7", + "@babel/plugin-transform-json-strings": "^7.29.7", + "@babel/plugin-transform-literals": "^7.29.7", + "@babel/plugin-transform-logical-assignment-operators": "^7.29.7", + "@babel/plugin-transform-member-expression-literals": "^7.29.7", + "@babel/plugin-transform-modules-amd": "^7.29.7", + "@babel/plugin-transform-modules-commonjs": "^7.29.7", + "@babel/plugin-transform-modules-systemjs": "^7.29.7", + "@babel/plugin-transform-modules-umd": "^7.29.7", + "@babel/plugin-transform-named-capturing-groups-regex": "^7.29.7", + "@babel/plugin-transform-new-target": "^7.29.7", + "@babel/plugin-transform-nullish-coalescing-operator": "^7.29.7", + "@babel/plugin-transform-numeric-separator": "^7.29.7", + "@babel/plugin-transform-object-rest-spread": "^7.29.7", + "@babel/plugin-transform-object-super": "^7.29.7", + "@babel/plugin-transform-optional-catch-binding": "^7.29.7", + "@babel/plugin-transform-optional-chaining": "^7.29.7", + "@babel/plugin-transform-parameters": "^7.29.7", + "@babel/plugin-transform-private-methods": "^7.29.7", + "@babel/plugin-transform-private-property-in-object": "^7.29.7", + "@babel/plugin-transform-property-literals": "^7.29.7", + "@babel/plugin-transform-regenerator": "^7.29.7", + "@babel/plugin-transform-regexp-modifiers": "^7.29.7", + "@babel/plugin-transform-reserved-words": "^7.29.7", + "@babel/plugin-transform-shorthand-properties": "^7.29.7", + "@babel/plugin-transform-spread": "^7.29.7", + "@babel/plugin-transform-sticky-regex": "^7.29.7", + "@babel/plugin-transform-template-literals": "^7.29.7", + "@babel/plugin-transform-typeof-symbol": "^7.29.7", + "@babel/plugin-transform-unicode-escapes": "^7.29.7", + "@babel/plugin-transform-unicode-property-regex": "^7.29.7", + "@babel/plugin-transform-unicode-regex": "^7.29.7", + "@babel/plugin-transform-unicode-sets-regex": "^7.29.7", "@babel/preset-modules": "0.1.6-no-external-plugins", "babel-plugin-polyfill-corejs2": "^0.4.15", "babel-plugin-polyfill-corejs3": "^0.14.0", @@ -1603,19 +1611,6 @@ "@babel/core": "^7.0.0-0" } }, - "node_modules/@babel/preset-env/node_modules/babel-plugin-polyfill-corejs3": { - "version": "0.14.0", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.14.0.tgz", - "integrity": "sha512-AvDcMxJ34W4Wgy4KBIIePQTAOP1Ie2WFwkQp3dB7FQ/f0lI5+nM96zUnYEOE1P9sEg0es5VCP0HxiWu5fUHZAQ==", - "license": "MIT", - "dependencies": { - "@babel/helper-define-polyfill-provider": "^0.6.6", - "core-js-compat": "^3.48.0" - }, - "peerDependencies": { - "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" - } - }, "node_modules/@babel/preset-modules": { "version": "0.1.6-no-external-plugins", "resolved": "https://registry.npmjs.org/@babel/preset-modules/-/preset-modules-0.1.6-no-external-plugins.tgz", @@ -1631,9 +1626,9 @@ } }, "node_modules/@babel/register": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/register/-/register-7.28.6.tgz", - "integrity": "sha512-pgcbbEl/dWQYb6L6Yew6F94rdwygfuv+vJ/tXfwIOYAfPB6TNWpXUMEtEq3YuTeHRdvMIhvz13bkT9CNaS+wqA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/register/-/register-7.29.7.tgz", + "integrity": "sha512-AMGJoWuES861riy6pcB0fphE1YXybtQnBYQMuIyPv6mKLiosfa79BKTnAOyx215c/3RJPJpdQwoHZ3earVH7AA==", "license": "MIT", "dependencies": { "clone-deep": "^4.0.1", @@ -1650,40 +1645,40 @@ } }, "node_modules/@babel/runtime": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.28.6.tgz", - "integrity": "sha512-05WQkdpL9COIMz4LjTxGpPNCdlpyimKppYNoJ5Di5EUObifl8t4tuLuUBBZEpoLYOmfvIWrsp9fCl0HoPRVTdA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.29.7.tgz", + "integrity": "sha512-Nq8OhGWiZIZGV6hLHoyAKLLcJihP/xFeBMGJoUrxTX2psI8dCifzLhZISFb+VWS3wFMRDmCGw5R+dOySCqPLhw==", "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/template": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.28.6.tgz", - "integrity": "sha512-YA6Ma2KsCdGb+WC6UpBVFJGXL58MDA6oyONbjyF/+5sBgxY/dwkhLogbMT2GXXyU84/IhRw/2D1Os1B/giz+BQ==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.29.7.tgz", + "integrity": "sha512-puq+Gf35oI24FeN11LkoUQFqv9uwNeWpxXZi/Ji3rRIoKAzKnxRaZ+Gkj0vKS9ZCiTESfng1N9LyOyXvo+m+Gg==", "license": "MIT", "dependencies": { - "@babel/code-frame": "^7.28.6", - "@babel/parser": "^7.28.6", - "@babel/types": "^7.28.6" + "@babel/code-frame": "^7.29.7", + "@babel/parser": "^7.29.7", + "@babel/types": "^7.29.7" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/traverse": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.29.0.tgz", - "integrity": "sha512-4HPiQr0X7+waHfyXPZpWPfWL/J7dcN1mx9gL6WdQVMbPnF3+ZhSMs8tCxN7oHddJE9fhNE7+lxdnlyemKfJRuA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.29.7.tgz", + "integrity": "sha512-EhlfNQtZ+NK22w5BM61ciuiq1m58ed33Wr1Xan//ZRTy6hgjnwyCffRYwzsGXdASJSUJ1guZILsErh1eQcl+zw==", "license": "MIT", "dependencies": { - "@babel/code-frame": "^7.29.0", - "@babel/generator": "^7.29.0", - "@babel/helper-globals": "^7.28.0", - "@babel/parser": "^7.29.0", - "@babel/template": "^7.28.6", - "@babel/types": "^7.29.0", + "@babel/code-frame": "^7.29.7", + "@babel/generator": "^7.29.7", + "@babel/helper-globals": "^7.29.7", + "@babel/parser": "^7.29.7", + "@babel/template": "^7.29.7", + "@babel/types": "^7.29.7", "debug": "^4.3.1" }, "engines": { @@ -1691,13 +1686,13 @@ } }, "node_modules/@babel/types": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.29.0.tgz", - "integrity": "sha512-LwdZHpScM4Qz8Xw2iKSzS+cfglZzJGvofQICy7W7v4caru4EaAmyUuO6BGrbyQ2mYV11W0U8j5mBhd14dd3B0A==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.29.7.tgz", + "integrity": "sha512-4zBIxpPzowiZpusoFkyGVwakdRJUyuH5PxQ/PrqghfdFWWasvnCdPfQXHrenDai+gyLARulZjZowCOj6fjT4pA==", "license": "MIT", "dependencies": { - "@babel/helper-string-parser": "^7.27.1", - "@babel/helper-validator-identifier": "^7.28.5" + "@babel/helper-string-parser": "^7.29.7", + "@babel/helper-validator-identifier": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1712,33 +1707,28 @@ "node": ">=18" } }, - "node_modules/@csstools/cascade-layer-name-parser": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/@csstools/cascade-layer-name-parser/-/cascade-layer-name-parser-2.0.5.tgz", - "integrity": "sha512-p1ko5eHgV+MgXFVa4STPKpvPxr6ReS8oS2jzTukjR74i5zJNyWO1ZM1m8YKBXnzDKWfBN1ztLYlHxbVemDD88A==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], + "node_modules/@bramus/specificity": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/@bramus/specificity/-/specificity-2.4.2.tgz", + "integrity": "sha512-ctxtJ/eA+t+6q2++vj5j7FYX3nRu311q1wfYH3xjlLOsczhlhxAg2FWNUXhpGvAw3BWo1xBcvOV6/YLc2r5FJw==", "license": "MIT", - "engines": { - "node": ">=18" + "dependencies": { + "css-tree": "^3.0.0" }, - "peerDependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" + "bin": { + "specificity": "bin/cli.js" } }, + "node_modules/@colordx/core": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/@colordx/core/-/core-5.5.0.tgz", + "integrity": "sha512-3PxTH8itZzltK0U9jTwVVnjLXvnDYuq3m+QXsHkENxWiPRh4WaoLcs1SQjqgZ55kS+QyirpH5BVwzP2gMVG6EQ==", + "license": "MIT" + }, "node_modules/@csstools/color-helpers": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", - "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-6.1.0.tgz", + "integrity": "sha512-064IFJdjTfUqnjpCVpMOdbr8FLQBhinbZj6yRv2An2E41O/pLEXqfFRWqGq/SxlE5PEUYTlvWsG2r8MswAVvkg==", "funding": [ { "type": "github", @@ -1751,13 +1741,13 @@ ], "license": "MIT-0", "engines": { - "node": ">=18" + "node": ">=20.19.0" } }, "node_modules/@csstools/css-calc": { - "version": "2.1.4", - "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", - "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-3.2.1.tgz", + "integrity": "sha512-DtdHlgXh5ZkA43cwBcAm+huzgJiwx3ZTWVjBs94kwz2xKqSimDA3lBgCjphYgwgVUMWatSM0pDd8TILB1yrVVg==", "funding": [ { "type": "github", @@ -1770,17 +1760,17 @@ ], "license": "MIT", "engines": { - "node": ">=18" + "node": ">=20.19.0" }, "peerDependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" + "@csstools/css-parser-algorithms": "^4.0.0", + "@csstools/css-tokenizer": "^4.0.0" } }, "node_modules/@csstools/css-color-parser": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", - "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", + "version": "4.1.9", + "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-4.1.9.tgz", + "integrity": "sha512-paQcIaOO53Rk5+YrBaBjm/SgrV4INImjo2BT1DtQRYr+XeTRbeAYlS+jxXp9drqvKmtFnWRJKIalDLhZZDu42A==", "funding": [ { "type": "github", @@ -1793,21 +1783,21 @@ ], "license": "MIT", "dependencies": { - "@csstools/color-helpers": "^5.1.0", - "@csstools/css-calc": "^2.1.4" + "@csstools/color-helpers": "^6.1.0", + "@csstools/css-calc": "^3.2.1" }, "engines": { - "node": ">=18" + "node": ">=20.19.0" }, "peerDependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" + "@csstools/css-parser-algorithms": "^4.0.0", + "@csstools/css-tokenizer": "^4.0.0" } }, "node_modules/@csstools/css-parser-algorithms": { - "version": "3.0.5", - "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", - "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-4.0.0.tgz", + "integrity": "sha512-+B87qS7fIG3L5h3qwJ/IFbjoVoOe/bpOdh9hAjXbvx0o8ImEmUsGXN0inFOnk2ChCFgqkkGFQ+TpM5rbhkKe4w==", "funding": [ { "type": "github", @@ -1820,16 +1810,40 @@ ], "license": "MIT", "engines": { - "node": ">=18" + "node": ">=20.19.0" }, "peerDependencies": { - "@csstools/css-tokenizer": "^3.0.4" + "@csstools/css-tokenizer": "^4.0.0" + } + }, + "node_modules/@csstools/css-syntax-patches-for-csstree": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/@csstools/css-syntax-patches-for-csstree/-/css-syntax-patches-for-csstree-1.1.6.tgz", + "integrity": "sha512-TcJCWFbXLPpJYq6z7bfOyjWYJDiDg2/I4gyUC9pqPNqHFRIey0EB0q0L5cSnQDfWJg8Jd6VadakxdIez/3zkqQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "peerDependencies": { + "css-tree": "^3.2.1" + }, + "peerDependenciesMeta": { + "css-tree": { + "optional": true + } } }, "node_modules/@csstools/css-tokenizer": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", - "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-4.0.0.tgz", + "integrity": "sha512-QxULHAm7cNu72w97JUNCBFODFaXpbDg+dP8b/oWFAZ2MTRppA3U00Y2L1HqaS4J6yBqxwa/Y3nMBaxVKbB/NsA==", "funding": [ { "type": "github", @@ -1842,30 +1856,7 @@ ], "license": "MIT", "engines": { - "node": ">=18" - } - }, - "node_modules/@csstools/media-query-list-parser": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/@csstools/media-query-list-parser/-/media-query-list-parser-4.0.3.tgz", - "integrity": "sha512-HAYH7d3TLRHDOUQK4mZKf9k9Ph/m8Akstg66ywKR4SFAigjs3yBiUeZtFxywiTm5moZMAp/5W/ZuFnNXXYLuuQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" + "node": ">=20.19.0" } }, "node_modules/@csstools/postcss-alpha-function": { @@ -1897,6 +1888,116 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-alpha-function/node_modules/@csstools/color-helpers": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", + "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/postcss-alpha-function/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-alpha-function/node_modules/@csstools/css-color-parser": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", + "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/color-helpers": "^5.1.0", + "@csstools/css-calc": "^2.1.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-alpha-function/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-alpha-function/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-cascade-layers": { "version": "5.0.2", "resolved": "https://registry.npmjs.org/@csstools/postcss-cascade-layers/-/postcss-cascade-layers-5.0.2.tgz", @@ -1981,6 +2082,226 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-color-function-display-p3-linear/node_modules/@csstools/color-helpers": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", + "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/postcss-color-function-display-p3-linear/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-color-function-display-p3-linear/node_modules/@csstools/css-color-parser": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", + "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/color-helpers": "^5.1.0", + "@csstools/css-calc": "^2.1.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-color-function-display-p3-linear/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-color-function-display-p3-linear/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/postcss-color-function/node_modules/@csstools/color-helpers": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", + "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/postcss-color-function/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-color-function/node_modules/@csstools/css-color-parser": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", + "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/color-helpers": "^5.1.0", + "@csstools/css-calc": "^2.1.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-color-function/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-color-function/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-color-mix-function": { "version": "3.0.12", "resolved": "https://registry.npmjs.org/@csstools/postcss-color-mix-function/-/postcss-color-mix-function-3.0.12.tgz", @@ -2010,6 +2331,116 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-color-mix-function/node_modules/@csstools/color-helpers": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", + "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/postcss-color-mix-function/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-color-mix-function/node_modules/@csstools/css-color-parser": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", + "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/color-helpers": "^5.1.0", + "@csstools/css-calc": "^2.1.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-color-mix-function/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-color-mix-function/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-color-mix-variadic-function-arguments": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/@csstools/postcss-color-mix-variadic-function-arguments/-/postcss-color-mix-variadic-function-arguments-1.0.2.tgz", @@ -2039,6 +2470,116 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-color-mix-variadic-function-arguments/node_modules/@csstools/color-helpers": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", + "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/postcss-color-mix-variadic-function-arguments/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-color-mix-variadic-function-arguments/node_modules/@csstools/css-color-parser": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", + "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/color-helpers": "^5.1.0", + "@csstools/css-calc": "^2.1.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-color-mix-variadic-function-arguments/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-color-mix-variadic-function-arguments/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-content-alt-text": { "version": "2.0.8", "resolved": "https://registry.npmjs.org/@csstools/postcss-content-alt-text/-/postcss-content-alt-text-2.0.8.tgz", @@ -2067,6 +2608,47 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-content-alt-text/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-content-alt-text/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-contrast-color-function": { "version": "2.0.12", "resolved": "https://registry.npmjs.org/@csstools/postcss-contrast-color-function/-/postcss-contrast-color-function-2.0.12.tgz", @@ -2096,6 +2678,116 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-contrast-color-function/node_modules/@csstools/color-helpers": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", + "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/postcss-contrast-color-function/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-contrast-color-function/node_modules/@csstools/css-color-parser": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", + "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/color-helpers": "^5.1.0", + "@csstools/css-calc": "^2.1.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-contrast-color-function/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-contrast-color-function/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-exponential-functions": { "version": "2.0.9", "resolved": "https://registry.npmjs.org/@csstools/postcss-exponential-functions/-/postcss-exponential-functions-2.0.9.tgz", @@ -2123,6 +2815,70 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-exponential-functions/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-exponential-functions/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-exponential-functions/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-font-format-keywords": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/@csstools/postcss-font-format-keywords/-/postcss-font-format-keywords-4.0.0.tgz", @@ -2176,6 +2932,116 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-gamut-mapping/node_modules/@csstools/color-helpers": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", + "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/postcss-gamut-mapping/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-gamut-mapping/node_modules/@csstools/css-color-parser": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", + "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/color-helpers": "^5.1.0", + "@csstools/css-calc": "^2.1.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-gamut-mapping/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-gamut-mapping/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-gradients-interpolation-method": { "version": "5.0.12", "resolved": "https://registry.npmjs.org/@csstools/postcss-gradients-interpolation-method/-/postcss-gradients-interpolation-method-5.0.12.tgz", @@ -2205,6 +3071,116 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-gradients-interpolation-method/node_modules/@csstools/color-helpers": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", + "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/postcss-gradients-interpolation-method/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-gradients-interpolation-method/node_modules/@csstools/css-color-parser": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", + "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/color-helpers": "^5.1.0", + "@csstools/css-calc": "^2.1.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-gradients-interpolation-method/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-gradients-interpolation-method/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-hwb-function": { "version": "4.0.12", "resolved": "https://registry.npmjs.org/@csstools/postcss-hwb-function/-/postcss-hwb-function-4.0.12.tgz", @@ -2234,6 +3210,116 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-hwb-function/node_modules/@csstools/color-helpers": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", + "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/postcss-hwb-function/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-hwb-function/node_modules/@csstools/css-color-parser": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", + "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/color-helpers": "^5.1.0", + "@csstools/css-calc": "^2.1.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-hwb-function/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-hwb-function/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-ic-unit": { "version": "4.0.4", "resolved": "https://registry.npmjs.org/@csstools/postcss-ic-unit/-/postcss-ic-unit-4.0.4.tgz", @@ -2337,6 +3423,47 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-light-dark-function/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-light-dark-function/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-logical-float-and-clear": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-float-and-clear/-/postcss-logical-float-and-clear-3.0.0.tgz", @@ -2454,6 +3581,25 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-logical-viewport-units/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-media-minmax": { "version": "2.0.9", "resolved": "https://registry.npmjs.org/@csstools/postcss-media-minmax/-/postcss-media-minmax-2.0.9.tgz", @@ -2482,6 +3628,93 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-media-minmax/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-media-minmax/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-media-minmax/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/postcss-media-minmax/node_modules/@csstools/media-query-list-parser": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/@csstools/media-query-list-parser/-/media-query-list-parser-4.0.3.tgz", + "integrity": "sha512-HAYH7d3TLRHDOUQK4mZKf9k9Ph/m8Akstg66ywKR4SFAigjs3yBiUeZtFxywiTm5moZMAp/5W/ZuFnNXXYLuuQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, "node_modules/@csstools/postcss-media-queries-aspect-ratio-number-values": { "version": "3.0.5", "resolved": "https://registry.npmjs.org/@csstools/postcss-media-queries-aspect-ratio-number-values/-/postcss-media-queries-aspect-ratio-number-values-3.0.5.tgz", @@ -2509,6 +3742,70 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-media-queries-aspect-ratio-number-values/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-media-queries-aspect-ratio-number-values/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/postcss-media-queries-aspect-ratio-number-values/node_modules/@csstools/media-query-list-parser": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/@csstools/media-query-list-parser/-/media-query-list-parser-4.0.3.tgz", + "integrity": "sha512-HAYH7d3TLRHDOUQK4mZKf9k9Ph/m8Akstg66ywKR4SFAigjs3yBiUeZtFxywiTm5moZMAp/5W/ZuFnNXXYLuuQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, "node_modules/@csstools/postcss-nested-calc": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/@csstools/postcss-nested-calc/-/postcss-nested-calc-4.0.0.tgz", @@ -2589,6 +3886,116 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-oklab-function/node_modules/@csstools/color-helpers": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", + "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/postcss-oklab-function/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-oklab-function/node_modules/@csstools/css-color-parser": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", + "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/color-helpers": "^5.1.0", + "@csstools/css-calc": "^2.1.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-oklab-function/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-oklab-function/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-position-area-property": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/@csstools/postcss-position-area-property/-/postcss-position-area-property-1.0.0.tgz", @@ -2662,6 +4069,47 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-property-rule-prelude-list/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-property-rule-prelude-list/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-random-function": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/@csstools/postcss-random-function/-/postcss-random-function-2.0.1.tgz", @@ -2689,6 +4137,70 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-random-function/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-random-function/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-random-function/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-relative-color-syntax": { "version": "3.0.12", "resolved": "https://registry.npmjs.org/@csstools/postcss-relative-color-syntax/-/postcss-relative-color-syntax-3.0.12.tgz", @@ -2718,6 +4230,116 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-relative-color-syntax/node_modules/@csstools/color-helpers": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", + "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/postcss-relative-color-syntax/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-relative-color-syntax/node_modules/@csstools/css-color-parser": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", + "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/color-helpers": "^5.1.0", + "@csstools/css-calc": "^2.1.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-relative-color-syntax/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-relative-color-syntax/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-scope-pseudo-class": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/@csstools/postcss-scope-pseudo-class/-/postcss-scope-pseudo-class-4.0.1.tgz", @@ -2770,6 +4392,70 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-sign-functions/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-sign-functions/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-sign-functions/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-stepped-value-functions": { "version": "4.0.9", "resolved": "https://registry.npmjs.org/@csstools/postcss-stepped-value-functions/-/postcss-stepped-value-functions-4.0.9.tgz", @@ -2797,6 +4483,70 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-stepped-value-functions/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-stepped-value-functions/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-stepped-value-functions/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-syntax-descriptor-syntax-production": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/@csstools/postcss-syntax-descriptor-syntax-production/-/postcss-syntax-descriptor-syntax-production-1.0.1.tgz", @@ -2822,6 +4572,25 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-syntax-descriptor-syntax-production/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-system-ui-font-family": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/@csstools/postcss-system-ui-font-family/-/postcss-system-ui-font-family-1.0.0.tgz", @@ -2848,6 +4617,47 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-system-ui-font-family/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-system-ui-font-family/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-text-decoration-shorthand": { "version": "4.0.3", "resolved": "https://registry.npmjs.org/@csstools/postcss-text-decoration-shorthand/-/postcss-text-decoration-shorthand-4.0.3.tgz", @@ -2874,6 +4684,25 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-text-decoration-shorthand/node_modules/@csstools/color-helpers": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", + "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-trigonometric-functions": { "version": "4.0.9", "resolved": "https://registry.npmjs.org/@csstools/postcss-trigonometric-functions/-/postcss-trigonometric-functions-4.0.9.tgz", @@ -2901,6 +4730,70 @@ "postcss": "^8.4" } }, + "node_modules/@csstools/postcss-trigonometric-functions/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-trigonometric-functions/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-trigonometric-functions/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/postcss-unset-value": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/@csstools/postcss-unset-value/-/postcss-unset-value-4.0.0.tgz", @@ -2990,12 +4883,12 @@ } }, "node_modules/@discoveryjs/json-ext": { - "version": "0.5.7", - "resolved": "https://registry.npmjs.org/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz", - "integrity": "sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw==", + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/@discoveryjs/json-ext/-/json-ext-0.6.3.tgz", + "integrity": "sha512-4B4OijXeVNOPZlYA2oEwWOTkzyltLao+xbotHQeqN++Rv27Y6s818+n2Qkp8q+Fxhn0t/5lA5X1Mxktud8eayQ==", "license": "MIT", "engines": { - "node": ">=10.0.0" + "node": ">=14.17.0" } }, "node_modules/@emmetio/abbreviation": { @@ -3053,421 +4946,42 @@ "integrity": "sha512-ZsZ2I9Vzso3Ho/pjZFsmmZ++FWeEd/txqybHTm4OgaZzdS8V9V/YYWQwg5TC38Z7uLWUV1vavpLLbjJtKubR1A==", "license": "MIT" }, - "node_modules/@esbuild/aix-ppc64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.3.tgz", - "integrity": "sha512-9fJMTNFTWZMh5qwrBItuziu834eOCUcEqymSH7pY+zoMVEZg3gcPuBNxH1EvfVYe9h0x/Ptw8KBzv7qxb7l8dg==", - "cpu": [ - "ppc64" - ], + "node_modules/@emnapi/core": { + "version": "1.11.1", + "resolved": "https://registry.npmjs.org/@emnapi/core/-/core-1.11.1.tgz", + "integrity": "sha512-RSvbQmHzdKzNsLYa/wHrbc3KN4sYLKAdPZxqiM2HATqv/SBk2/ENSHpvXGaLOMcsAyz0poEGqkmmKYG3OWiJEQ==", "license": "MIT", "optional": true, - "os": [ - "aix" - ], - "engines": { - "node": ">=18" + "dependencies": { + "@emnapi/wasi-threads": "1.2.2", + "tslib": "^2.4.0" } }, - "node_modules/@esbuild/android-arm": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.27.3.tgz", - "integrity": "sha512-i5D1hPY7GIQmXlXhs2w8AWHhenb00+GxjxRncS2ZM7YNVGNfaMxgzSGuO8o8SJzRc/oZwU2bcScvVERk03QhzA==", - "cpu": [ - "arm" - ], + "node_modules/@emnapi/runtime": { + "version": "1.11.1", + "resolved": "https://registry.npmjs.org/@emnapi/runtime/-/runtime-1.11.1.tgz", + "integrity": "sha512-vgj7R3y3Wgx24IQaGPA/R6YFXLHVMOZ0uVEyIQPaWs+rd1AzfEMXlAC22FYwO1XkKR6NPsq7mUandH8oIRdZFw==", "license": "MIT", "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=18" + "dependencies": { + "tslib": "^2.4.0" } }, - "node_modules/@esbuild/android-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.27.3.tgz", - "integrity": "sha512-YdghPYUmj/FX2SYKJ0OZxf+iaKgMsKHVPF1MAq/P8WirnSpCStzKJFjOjzsW0QQ7oIAiccHdcqjbHmJxRb/dmg==", - "cpu": [ - "arm64" - ], + "node_modules/@emnapi/wasi-threads": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/@emnapi/wasi-threads/-/wasi-threads-1.2.2.tgz", + "integrity": "sha512-c95qOXkHdydNKhscBTebqEC1CVAZpyqOfVfBzQ1qgzyl3gfeldUjIggDbIZgDKsHLgnsM+igH7TJ/eAasaVuMA==", "license": "MIT", "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=18" + "dependencies": { + "tslib": "^2.4.0" } }, - "node_modules/@esbuild/android-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.27.3.tgz", - "integrity": "sha512-IN/0BNTkHtk8lkOM8JWAYFg4ORxBkZQf9zXiEOfERX/CzxW3Vg1ewAhU7QSWQpVIzTW+b8Xy+lGzdYXV6UZObQ==", - "cpu": [ - "x64" - ], - "license": "MIT", - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/darwin-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.27.3.tgz", - "integrity": "sha512-Re491k7ByTVRy0t3EKWajdLIr0gz2kKKfzafkth4Q8A5n1xTHrkqZgLLjFEHVD+AXdUGgQMq+Godfq45mGpCKg==", - "cpu": [ - "arm64" - ], - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/darwin-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.27.3.tgz", - "integrity": "sha512-vHk/hA7/1AckjGzRqi6wbo+jaShzRowYip6rt6q7VYEDX4LEy1pZfDpdxCBnGtl+A5zq8iXDcyuxwtv3hNtHFg==", - "cpu": [ - "x64" - ], - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/freebsd-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.27.3.tgz", - "integrity": "sha512-ipTYM2fjt3kQAYOvo6vcxJx3nBYAzPjgTCk7QEgZG8AUO3ydUhvelmhrbOheMnGOlaSFUoHXB6un+A7q4ygY9w==", - "cpu": [ - "arm64" - ], - "license": "MIT", - "optional": true, - "os": [ - "freebsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/freebsd-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.27.3.tgz", - "integrity": "sha512-dDk0X87T7mI6U3K9VjWtHOXqwAMJBNN2r7bejDsc+j03SEjtD9HrOl8gVFByeM0aJksoUuUVU9TBaZa2rgj0oA==", - "cpu": [ - "x64" - ], - "license": "MIT", - "optional": true, - "os": [ - "freebsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-arm": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.27.3.tgz", - "integrity": "sha512-s6nPv2QkSupJwLYyfS+gwdirm0ukyTFNl3KTgZEAiJDd+iHZcbTPPcWCcRYH+WlNbwChgH2QkE9NSlNrMT8Gfw==", - "cpu": [ - "arm" - ], - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.27.3.tgz", - "integrity": "sha512-sZOuFz/xWnZ4KH3YfFrKCf1WyPZHakVzTiqji3WDc0BCl2kBwiJLCXpzLzUBLgmp4veFZdvN5ChW4Eq/8Fc2Fg==", - "cpu": [ - "arm64" - ], - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-ia32": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.27.3.tgz", - "integrity": "sha512-yGlQYjdxtLdh0a3jHjuwOrxQjOZYD/C9PfdbgJJF3TIZWnm/tMd/RcNiLngiu4iwcBAOezdnSLAwQDPqTmtTYg==", - "cpu": [ - "ia32" - ], - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-loong64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.27.3.tgz", - "integrity": "sha512-WO60Sn8ly3gtzhyjATDgieJNet/KqsDlX5nRC5Y3oTFcS1l0KWba+SEa9Ja1GfDqSF1z6hif/SkpQJbL63cgOA==", - "cpu": [ - "loong64" - ], - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-mips64el": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.27.3.tgz", - "integrity": "sha512-APsymYA6sGcZ4pD6k+UxbDjOFSvPWyZhjaiPyl/f79xKxwTnrn5QUnXR5prvetuaSMsb4jgeHewIDCIWljrSxw==", - "cpu": [ - "mips64el" - ], - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-ppc64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.27.3.tgz", - "integrity": "sha512-eizBnTeBefojtDb9nSh4vvVQ3V9Qf9Df01PfawPcRzJH4gFSgrObw+LveUyDoKU3kxi5+9RJTCWlj4FjYXVPEA==", - "cpu": [ - "ppc64" - ], - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-riscv64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.27.3.tgz", - "integrity": "sha512-3Emwh0r5wmfm3ssTWRQSyVhbOHvqegUDRd0WhmXKX2mkHJe1SFCMJhagUleMq+Uci34wLSipf8Lagt4LlpRFWQ==", - "cpu": [ - "riscv64" - ], - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-s390x": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.27.3.tgz", - "integrity": "sha512-pBHUx9LzXWBc7MFIEEL0yD/ZVtNgLytvx60gES28GcWMqil8ElCYR4kvbV2BDqsHOvVDRrOxGySBM9Fcv744hw==", - "cpu": [ - "s390x" - ], - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.27.3.tgz", - "integrity": "sha512-Czi8yzXUWIQYAtL/2y6vogER8pvcsOsk5cpwL4Gk5nJqH5UZiVByIY8Eorm5R13gq+DQKYg0+JyQoytLQas4dA==", - "cpu": [ - "x64" - ], - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/netbsd-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.27.3.tgz", - "integrity": "sha512-sDpk0RgmTCR/5HguIZa9n9u+HVKf40fbEUt+iTzSnCaGvY9kFP0YKBWZtJaraonFnqef5SlJ8/TiPAxzyS+UoA==", - "cpu": [ - "arm64" - ], - "license": "MIT", - "optional": true, - "os": [ - "netbsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/netbsd-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.27.3.tgz", - "integrity": "sha512-P14lFKJl/DdaE00LItAukUdZO5iqNH7+PjoBm+fLQjtxfcfFE20Xf5CrLsmZdq5LFFZzb5JMZ9grUwvtVYzjiA==", - "cpu": [ - "x64" - ], - "license": "MIT", - "optional": true, - "os": [ - "netbsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/openbsd-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.27.3.tgz", - "integrity": "sha512-AIcMP77AvirGbRl/UZFTq5hjXK+2wC7qFRGoHSDrZ5v5b8DK/GYpXW3CPRL53NkvDqb9D+alBiC/dV0Fb7eJcw==", - "cpu": [ - "arm64" - ], - "license": "MIT", - "optional": true, - "os": [ - "openbsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/openbsd-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.27.3.tgz", - "integrity": "sha512-DnW2sRrBzA+YnE70LKqnM3P+z8vehfJWHXECbwBmH/CU51z6FiqTQTHFenPlHmo3a8UgpLyH3PT+87OViOh1AQ==", - "cpu": [ - "x64" - ], - "license": "MIT", - "optional": true, - "os": [ - "openbsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/openharmony-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.27.3.tgz", - "integrity": "sha512-NinAEgr/etERPTsZJ7aEZQvvg/A6IsZG/LgZy+81wON2huV7SrK3e63dU0XhyZP4RKGyTm7aOgmQk0bGp0fy2g==", - "cpu": [ - "arm64" - ], - "license": "MIT", - "optional": true, - "os": [ - "openharmony" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/sunos-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.27.3.tgz", - "integrity": "sha512-PanZ+nEz+eWoBJ8/f8HKxTTD172SKwdXebZ0ndd953gt1HRBbhMsaNqjTyYLGLPdoWHy4zLU7bDVJztF5f3BHA==", - "cpu": [ - "x64" - ], - "license": "MIT", - "optional": true, - "os": [ - "sunos" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/win32-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.27.3.tgz", - "integrity": "sha512-B2t59lWWYrbRDw/tjiWOuzSsFh1Y/E95ofKz7rIVYSQkUYBjfSgf6oeYPNWHToFRr2zx52JKApIcAS/D5TUBnA==", - "cpu": [ - "arm64" - ], - "license": "MIT", - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/win32-ia32": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.27.3.tgz", - "integrity": "sha512-QLKSFeXNS8+tHW7tZpMtjlNb7HKau0QDpwm49u0vUp9y1WOF+PEzkU84y9GqYaAVW8aH8f3GcBck26jh54cX4Q==", - "cpu": [ - "ia32" - ], - "license": "MIT", - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/win32-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.27.3.tgz", - "integrity": "sha512-4uJGhsxuptu3OcpVAzli+/gWusVGwZZHTlS63hh++ehExkVT8SgiEf7/uC/PclrPPkLhZqGgCTjd0VWLo6xMqA==", - "cpu": [ - "x64" - ], - "license": "MIT", - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=18" - } + "node_modules/@epic-web/invariant": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@epic-web/invariant/-/invariant-1.0.0.tgz", + "integrity": "sha512-lrTPqgvfFQtR/eY/qkIzp98OGdNJu0m5ji3q/nJI8v3SXkRKEnWiOxMmbvcSoAIzv/cGiuvRy57k4suKQSAdwA==", + "license": "MIT" }, "node_modules/@eslint-community/eslint-utils": { "version": "4.9.1", @@ -3509,14 +5023,14 @@ } }, "node_modules/@eslint/config-array": { - "version": "0.21.1", - "resolved": "https://registry.npmjs.org/@eslint/config-array/-/config-array-0.21.1.tgz", - "integrity": "sha512-aw1gNayWpdI/jSYVgzN5pL0cfzU02GT3NBpeT/DXbx1/1x7ZKxFPd9bwrzygx/qiwIQiJ1sw/zD8qY/kRvlGHA==", + "version": "0.21.2", + "resolved": "https://registry.npmjs.org/@eslint/config-array/-/config-array-0.21.2.tgz", + "integrity": "sha512-nJl2KGTlrf9GjLimgIru+V/mzgSK0ABCDQRvxw5BjURL7WfH5uoWmizbH7QB6MmnMBd8cIC9uceWnezL1VZWWw==", "license": "Apache-2.0", "dependencies": { "@eslint/object-schema": "^2.1.7", "debug": "^4.3.1", - "minimatch": "^3.1.2" + "minimatch": "^3.1.5" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -3547,9 +5061,9 @@ } }, "node_modules/@eslint/eslintrc": { - "version": "3.3.4", - "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-3.3.4.tgz", - "integrity": "sha512-4h4MVF8pmBsncB60r0wSJiIeUKTSD4m7FmTFThG8RHlsg9ajqckLm9OraguFGZE4vVdpiI1Q4+hFnisopmG6gQ==", + "version": "3.3.5", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-3.3.5.tgz", + "integrity": "sha512-4IlJx0X0qftVsN5E+/vGujTRIFtwuLbNsVUe7TO6zYPDR1O6nFwvwhIKEKSrl6dZchmYBITazxKoUYOjdtjlRg==", "license": "MIT", "dependencies": { "ajv": "^6.14.0", @@ -3559,7 +5073,7 @@ "ignore": "^5.2.0", "import-fresh": "^3.2.1", "js-yaml": "^4.1.1", - "minimatch": "^3.1.3", + "minimatch": "^3.1.5", "strip-json-comments": "^3.1.1" }, "engines": { @@ -3582,9 +5096,9 @@ } }, "node_modules/@eslint/js": { - "version": "9.39.3", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.39.3.tgz", - "integrity": "sha512-1B1VkCq6FuUNlQvlBYb+1jDu/gV297TIs/OeiaSR9l1H27SVW55ONE1e1Vp16NqP683+xEGzxYtv4XCiDPaQiw==", + "version": "9.39.4", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.39.4.tgz", + "integrity": "sha512-nE7DEIchvtiFTwBw4Lfbu59PG+kCofhjsKaCWzxTpt4lfRjRMqG6uMBzKXuEcyXhOHoUp9riAm7/aWYGhXZ9cw==", "license": "MIT", "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -3615,52 +5129,58 @@ "node": "^18.18.0 || ^20.9.0 || >=21.1.0" } }, - "node_modules/@floating-ui/core": { - "version": "1.7.5", - "resolved": "https://registry.npmjs.org/@floating-ui/core/-/core-1.7.5.tgz", - "integrity": "sha512-1Ih4WTWyw0+lKyFMcBHGbb5U5FtuHJuujoyyr5zTaWS5EYMeT6Jb2AuDeftsCsEuchO+mM2ij5+q9crhydzLhQ==", + "node_modules/@exodus/bytes": { + "version": "1.15.1", + "resolved": "https://registry.npmjs.org/@exodus/bytes/-/bytes-1.15.1.tgz", + "integrity": "sha512-S6mL0yNB/Abt9Ei4tq8gDhcczc4S3+vQ4ra7vxnAf+YHC02srtqxKKZghx2Dq6p0e66THKwR6r8N6P95wEty7Q==", "license": "MIT", - "dependencies": { - "@floating-ui/utils": "^0.2.11" + "engines": { + "node": "^20.19.0 || ^22.12.0 || >=24.0.0" + }, + "peerDependencies": { + "@noble/hashes": "^1.8.0 || ^2.0.0" + }, + "peerDependenciesMeta": { + "@noble/hashes": { + "optional": true + } } }, - "node_modules/@floating-ui/dom": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/@floating-ui/dom/-/dom-1.1.1.tgz", - "integrity": "sha512-TpIO93+DIujg3g7SykEAGZMDtbJRrmnYRCNYSjJlvIbGhBjRSNTLVbNeDQBrzy9qDgUbiWdc7KA0uZHZ2tJmiw==", - "license": "MIT", - "dependencies": { - "@floating-ui/core": "^1.1.0" - } - }, - "node_modules/@floating-ui/utils": { - "version": "0.2.11", - "resolved": "https://registry.npmjs.org/@floating-ui/utils/-/utils-0.2.11.tgz", - "integrity": "sha512-RiB/yIh78pcIxl6lLMG0CgBXAZ2Y0eVHqMPYugu+9U0AeT6YBeiJpf7lbdJNIugFP5SIjwNRgo4DhR1Qxi26Gg==", - "license": "MIT" - }, "node_modules/@humanfs/core": { - "version": "0.19.1", - "resolved": "https://registry.npmjs.org/@humanfs/core/-/core-0.19.1.tgz", - "integrity": "sha512-5DyQ4+1JEUzejeK1JGICcideyfUbGixgS9jNgex5nqkW+cY7WZhxBigmieN5Qnw9ZosSNVC9KQKyb+GUaGyKUA==", + "version": "0.19.2", + "resolved": "https://registry.npmjs.org/@humanfs/core/-/core-0.19.2.tgz", + "integrity": "sha512-UhXNm+CFMWcbChXywFwkmhqjs3PRCmcSa/hfBgLIb7oQ5HNb1wS0icWsGtSAUNgefHeI+eBrA8I1fxmbHsGdvA==", "license": "Apache-2.0", + "dependencies": { + "@humanfs/types": "^0.15.0" + }, "engines": { "node": ">=18.18.0" } }, "node_modules/@humanfs/node": { - "version": "0.16.7", - "resolved": "https://registry.npmjs.org/@humanfs/node/-/node-0.16.7.tgz", - "integrity": "sha512-/zUx+yOsIrG4Y43Eh2peDeKCxlRt/gET6aHfaKpuq267qXdYDFViVHfMaLyygZOnl0kGWxFIgsBy8QFuTLUXEQ==", + "version": "0.16.8", + "resolved": "https://registry.npmjs.org/@humanfs/node/-/node-0.16.8.tgz", + "integrity": "sha512-gE1eQNZ3R++kTzFUpdGlpmy8kDZD/MLyHqDwqjkVQI0JMdI1D51sy1H958PNXYkM2rAac7e5/CnIKZrHtPh3BQ==", "license": "Apache-2.0", "dependencies": { - "@humanfs/core": "^0.19.1", + "@humanfs/core": "^0.19.2", + "@humanfs/types": "^0.15.0", "@humanwhocodes/retry": "^0.4.0" }, "engines": { "node": ">=18.18.0" } }, + "node_modules/@humanfs/types": { + "version": "0.15.0", + "resolved": "https://registry.npmjs.org/@humanfs/types/-/types-0.15.0.tgz", + "integrity": "sha512-ZZ1w0aoQkwuUuC7Yf+7sdeaNfqQiiLcSRbfI08oAxqLtpXQr9AIVX7Ay7HLDuiLYAaFPu8oBYNq/QIi9URHJ3Q==", + "license": "Apache-2.0", + "engines": { + "node": ">=18.18.0" + } + }, "node_modules/@humanwhocodes/module-importer": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz", @@ -3739,105 +5259,6 @@ "node": ">=18.0.0" } }, - "node_modules/@istanbuljs/load-nyc-config": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/@istanbuljs/load-nyc-config/-/load-nyc-config-1.1.0.tgz", - "integrity": "sha512-VjeHSlIzpv/NyD3N0YuHfXOPDIixcA1q2ZV98wsMqcYlPmv2n3Yb2lYP9XMElnaFVXg5A7YLTeLu6V84uQDjmQ==", - "license": "ISC", - "dependencies": { - "camelcase": "^5.3.1", - "find-up": "^4.1.0", - "get-package-type": "^0.1.0", - "js-yaml": "^3.13.1", - "resolve-from": "^5.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/@istanbuljs/load-nyc-config/node_modules/argparse": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", - "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", - "license": "MIT", - "dependencies": { - "sprintf-js": "~1.0.2" - } - }, - "node_modules/@istanbuljs/load-nyc-config/node_modules/find-up": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", - "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", - "license": "MIT", - "dependencies": { - "locate-path": "^5.0.0", - "path-exists": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/@istanbuljs/load-nyc-config/node_modules/js-yaml": { - "version": "3.14.2", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.2.tgz", - "integrity": "sha512-PMSmkqxr106Xa156c2M265Z+FTrPl+oxd/rgOQy2tijQeK5TxQ43psO1ZCwhVOSdnn+RzkzlRz/eY4BgJBYVpg==", - "license": "MIT", - "dependencies": { - "argparse": "^1.0.7", - "esprima": "^4.0.0" - }, - "bin": { - "js-yaml": "bin/js-yaml.js" - } - }, - "node_modules/@istanbuljs/load-nyc-config/node_modules/locate-path": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", - "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", - "license": "MIT", - "dependencies": { - "p-locate": "^4.1.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/@istanbuljs/load-nyc-config/node_modules/p-limit": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", - "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", - "license": "MIT", - "dependencies": { - "p-try": "^2.0.0" - }, - "engines": { - "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@istanbuljs/load-nyc-config/node_modules/p-locate": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", - "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", - "license": "MIT", - "dependencies": { - "p-limit": "^2.2.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/@istanbuljs/schema": { - "version": "0.1.3", - "resolved": "https://registry.npmjs.org/@istanbuljs/schema/-/schema-0.1.3.tgz", - "integrity": "sha512-ZXRY4jNvVgSVQ8DL3LTcakaAtXwTVUxE81hslsyD2AtoXW/wVob10HkOJ1X/pAlcI7D+2YoZKg5do8G/w6RYgA==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, "node_modules/@jest/schemas": { "version": "29.6.3", "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.6.3.tgz", @@ -3928,25 +5349,13 @@ "@jridgewell/sourcemap-codec": "^1.4.14" } }, - "node_modules/@mapbox/geojson-rewind": { - "version": "0.5.2", - "resolved": "https://registry.npmjs.org/@mapbox/geojson-rewind/-/geojson-rewind-0.5.2.tgz", - "integrity": "sha512-tJaT+RbYGJYStt7wI3cq4Nl4SXxG8W7JDG5DMJu97V25RnbNg3QtQtf+KD+VLjNpWKYsRvXDNmNrBgEETr1ifA==", - "license": "ISC", - "dependencies": { - "get-stream": "^6.0.1", - "minimist": "^1.2.6" - }, - "bin": { - "geojson-rewind": "geojson-rewind" - } - }, "node_modules/@mapbox/jsonlint-lines-primitives": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/@mapbox/jsonlint-lines-primitives/-/jsonlint-lines-primitives-2.0.2.tgz", - "integrity": "sha512-rY0o9A5ECsTQRVhv7tL/OyDpGAoUB4tTvLiW1DSzQGq4bvTPhNw1VpSNjDJc5GFZ2XuyOtSWSVN05qOtcD71qQ==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@mapbox/jsonlint-lines-primitives/-/jsonlint-lines-primitives-2.0.3.tgz", + "integrity": "sha512-0SElaV0uMxEnxzBhhX9WTuPyUeMsAN/SS0i16tjuba4/mio63MG9khjC1a0JAiPGXAwvwm4UfHJURCN7nyudQg==", + "license": "MIT", "engines": { - "node": ">= 0.6" + "node": ">= 22" } }, "node_modules/@mapbox/point-geometry": { @@ -3956,9 +5365,9 @@ "license": "ISC" }, "node_modules/@mapbox/tiny-sdf": { - "version": "2.0.7", - "resolved": "https://registry.npmjs.org/@mapbox/tiny-sdf/-/tiny-sdf-2.0.7.tgz", - "integrity": "sha512-25gQLQMcpivjOSA40g3gO6qgiFPDpWRoMfd+G/GoppPIeP6JDaMMkMrEJnMZhKyyS6iKwVt5YKu02vCUyJM3Ug==", + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/@mapbox/tiny-sdf/-/tiny-sdf-2.2.0.tgz", + "integrity": "sha512-LVL4wgI9YAum5V+LNVQO6QgFBPw7/MIIY4XJPNsPDMrjEwcE+JfKk1LuIl8GnF197ejVdC9QdPaxrx5gfgdGXg==", "license": "BSD-2-Clause" }, "node_modules/@mapbox/unitbezier": { @@ -3968,14 +5377,14 @@ "license": "BSD-2-Clause" }, "node_modules/@mapbox/vector-tile": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/@mapbox/vector-tile/-/vector-tile-2.0.4.tgz", - "integrity": "sha512-AkOLcbgGTdXScosBWwmmD7cDlvOjkg/DetGva26pIRiZPdeJYjYKarIlb4uxVzi6bwHO6EWH82eZ5Nuv4T5DUg==", + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@mapbox/vector-tile/-/vector-tile-2.0.5.tgz", + "integrity": "sha512-pXj8m7KTsqZt+1jsE0xIpGvqTSbblfkuEJL/NJmNePMtEwxO8V3XMDo9WMSfDeqHvCtBI9Lmt4mGcGR10zecmw==", "license": "BSD-3-Clause", "dependencies": { "@mapbox/point-geometry": "~1.1.0", "@types/geojson": "^7946.0.16", - "pbf": "^4.0.1" + "pbf": "^4.0.2" } }, "node_modules/@mapbox/whoots-js": { @@ -3988,23 +5397,25 @@ } }, "node_modules/@maplibre/geojson-vt": { - "version": "5.0.4", - "resolved": "https://registry.npmjs.org/@maplibre/geojson-vt/-/geojson-vt-5.0.4.tgz", - "integrity": "sha512-KGg9sma45S+stfH9vPCJk1J0lSDLWZgCT9Y8u8qWZJyjFlP8MNP1WGTxIMYJZjDvVT3PDn05kN1C95Sut1HpgQ==", - "license": "ISC" + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/@maplibre/geojson-vt/-/geojson-vt-6.1.1.tgz", + "integrity": "sha512-FVMOcmSP/yqol45t7StApEyTL5/vmqBCuFhH9n+fFuINenhaX+YgHHIt1yJ86S8kln3uJLcMvmEU2cfn6E2eCQ==", + "license": "ISC", + "dependencies": { + "kdbush": "^4.1.0" + } }, "node_modules/@maplibre/maplibre-gl-style-spec": { - "version": "24.6.0", - "resolved": "https://registry.npmjs.org/@maplibre/maplibre-gl-style-spec/-/maplibre-gl-style-spec-24.6.0.tgz", - "integrity": "sha512-+lxMYE+DvInshwVrqSQ3CkW9YRwVlRXeDzfthVOa1c9pwK5d7YgCwhgFwlSmjJLvTXn4gL8EvPUGT620sk2Pzg==", + "version": "24.10.0", + "resolved": "https://registry.npmjs.org/@maplibre/maplibre-gl-style-spec/-/maplibre-gl-style-spec-24.10.0.tgz", + "integrity": "sha512-lichxSiagMEBBrqHF0trtMQH9RKh+9jUlIJl0qW0QHvt2H/tbvUWdE+ZzI2Jd0/pT7j/iavLonlPu7EQ/ixTOw==", "license": "ISC", "dependencies": { "@mapbox/jsonlint-lines-primitives": "~2.0.2", - "@mapbox/unitbezier": "^0.0.1", + "@mapbox/unitbezier": "^1.0.0", "json-stringify-pretty-compact": "^4.0.0", "minimist": "^1.2.8", "quickselect": "^3.0.0", - "rw": "^1.3.3", "tinyqueue": "^3.0.0" }, "bin": { @@ -4013,28 +5424,42 @@ "gl-style-validate": "dist/gl-style-validate.mjs" } }, + "node_modules/@maplibre/maplibre-gl-style-spec/node_modules/@mapbox/unitbezier": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@mapbox/unitbezier/-/unitbezier-1.0.0.tgz", + "integrity": "sha512-fqd515fjBmANKGGsQ286E2Wvj/XvDFpGzwJxq4CI6jMQue6Oy04uCKp+JWKF00xRTmk6cEu1jPJ9p3xqH8YWqQ==", + "license": "BSD-2-Clause" + }, "node_modules/@maplibre/mlt": { - "version": "1.1.6", - "resolved": "https://registry.npmjs.org/@maplibre/mlt/-/mlt-1.1.6.tgz", - "integrity": "sha512-rgtY3x65lrrfXycLf6/T22ZnjTg5WgIOsptOIoCaMZy4O4UAKTyZlYY0h6v8le721pTptF94U65yMDQkug+URw==", + "version": "1.1.12", + "resolved": "https://registry.npmjs.org/@maplibre/mlt/-/mlt-1.1.12.tgz", + "integrity": "sha512-ZeK5w2TTeHOajcLaEQs1KZXw2V9wIKo1PmThlxlsHoXsQsYlBqLJzPOd6tJHRtGTChUY3DPPmjXRArYVvAbmZw==", "license": "(MIT OR Apache-2.0)", "dependencies": { "@mapbox/point-geometry": "^1.1.0" } }, "node_modules/@maplibre/vt-pbf": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/@maplibre/vt-pbf/-/vt-pbf-4.3.0.tgz", - "integrity": "sha512-jIvp8F5hQCcreqOOpEt42TJMUlsrEcpf/kI1T2v85YrQRV6PPXUcEXUg5karKtH6oh47XJZ4kHu56pUkOuqA7w==", + "version": "4.3.2", + "resolved": "https://registry.npmjs.org/@maplibre/vt-pbf/-/vt-pbf-4.3.2.tgz", + "integrity": "sha512-j6p0AdjvAR19Z3XaCysle7A4ZSo08tYOzxD0Y9NQylwPAkwJJeYub5b2eVucdeDh7erhv69DahoLOevDRERRUw==", "license": "MIT", "dependencies": { "@mapbox/point-geometry": "^1.1.0", - "@mapbox/vector-tile": "^2.0.4", - "@maplibre/geojson-vt": "^5.0.4", "@types/geojson": "^7946.0.16", - "@types/supercluster": "^7.1.3", - "pbf": "^4.0.1", - "supercluster": "^8.0.1" + "pbf": "^5.1.0" + } + }, + "node_modules/@maplibre/vt-pbf/node_modules/pbf": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/pbf/-/pbf-5.1.0.tgz", + "integrity": "sha512-Wv0yo0+uZepnoNEKsquhar1F18LogB8oeEikIhUXG16udbiXG7JecHGySwoo6kuMgjmbQYzdrTZlO+/K9t8eZg==", + "license": "BSD-3-Clause", + "dependencies": { + "resolve-protobuf-schema": "^2.1.0" + }, + "bin": { + "pbf": "bin/pbf" } }, "node_modules/@mdi/font": { @@ -4043,6 +5468,24 @@ "integrity": "sha512-43MtGpd585SNzHZPcYowu/84Vz2a2g31TvPMTm9uTiCSWzaheQySUcSyUH/46fPnuPQWof2yd0pGBtzee/IQWw==", "license": "Apache-2.0" }, + "node_modules/@napi-rs/wasm-runtime": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/@napi-rs/wasm-runtime/-/wasm-runtime-1.1.6.tgz", + "integrity": "sha512-ZLv/JdUfkvOy9eCnnBaGfiO+XimbjebAeO+MRQqD/B+FR1tnRN0tpKSJHRbE8sFfS6aqsXZ67TQjfwfsxULVbg==", + "license": "MIT", + "optional": true, + "dependencies": { + "@tybys/wasm-util": "^0.10.3" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/Brooooooklyn" + }, + "peerDependencies": { + "@emnapi/core": "^1.7.1", + "@emnapi/runtime": "^1.7.1" + } + }, "node_modules/@nicolo-ribaudo/chokidar-2": { "version": "2.1.8-no-fsevents.3", "resolved": "https://registry.npmjs.org/@nicolo-ribaudo/chokidar-2/-/chokidar-2-2.1.8-no-fsevents.3.tgz", @@ -4056,6 +5499,15 @@ "integrity": "sha512-XuySG1E38YScSJoMlqovLru4KTUNSjgVTIjyh7qMX6aNN5HY5Ct5LhRJdxO79JtTzKfzV/bnWpz+zquYrISsvw==", "license": "MIT" }, + "node_modules/@oxc-project/types": { + "version": "0.137.0", + "resolved": "https://registry.npmjs.org/@oxc-project/types/-/types-0.137.0.tgz", + "integrity": "sha512-WT+Gb24i8hmvo85AIv2oEYouEXkRlKAlT9WaCa3TfLgNCN+GhrJOGZuIlMouAh38Qe4QOx26eUOVsq70qXrywA==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/Boshen" + } + }, "node_modules/@parcel/watcher": { "version": "2.5.6", "resolved": "https://registry.npmjs.org/@parcel/watcher/-/watcher-2.5.6.tgz", @@ -4370,6 +5822,43 @@ "url": "https://opencollective.com/parcel" } }, + "node_modules/@photo-sphere-viewer/core": { + "version": "5.14.3", + "resolved": "https://registry.npmjs.org/@photo-sphere-viewer/core/-/core-5.14.3.tgz", + "integrity": "sha512-gSDzM1fuVfWQiDf8Y4AgI+un/wsKmeFO7cY4IFEbjhD1BTXUviSL8GuCXABNfPK2EThZLJqpOXxrbYAhblJrfQ==", + "license": "MIT", + "dependencies": { + "three": "^0.184.0" + }, + "funding": { + "url": "https://github.com/sponsors/mistic100" + } + }, + "node_modules/@photo-sphere-viewer/equirectangular-video-adapter": { + "version": "5.14.3", + "resolved": "https://registry.npmjs.org/@photo-sphere-viewer/equirectangular-video-adapter/-/equirectangular-video-adapter-5.14.3.tgz", + "integrity": "sha512-jgdFMAGkVgtybq0d+zP3Qbu8SNw1Makw/EOpqyeo1klHK+S5JBRp1ibtq/9NRPtYTlf3Ral03iYR6iDgJuxJbg==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/mistic100" + }, + "peerDependencies": { + "@photo-sphere-viewer/core": "5.14.3", + "@photo-sphere-viewer/video-plugin": "5.14.3" + } + }, + "node_modules/@photo-sphere-viewer/video-plugin": { + "version": "5.14.3", + "resolved": "https://registry.npmjs.org/@photo-sphere-viewer/video-plugin/-/video-plugin-5.14.3.tgz", + "integrity": "sha512-yMUd3JG0ROJpJkPXJbdFiIkz+m6lDMRrIeLm/bwXvaX+Q1uSgyX0ipIkJrQnAtdk/IU5fdyqBwfn9ExlQ27c2A==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/mistic100" + }, + "peerDependencies": { + "@photo-sphere-viewer/core": "5.14.3" + } + }, "node_modules/@pkgjs/parseargs": { "version": "0.11.0", "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", @@ -4380,34 +5869,308 @@ "node": ">=14" } }, - "node_modules/@pkgr/core": { - "version": "0.2.9", - "resolved": "https://registry.npmjs.org/@pkgr/core/-/core-0.2.9.tgz", - "integrity": "sha512-QNqXyfVS2wm9hweSYD2O7F0G06uurj9kZ96TRQE5Y9hU7+tgdZwIkbAKc5Ocy1HxEY2kuDQa6cQ1WRs/O5LFKA==", - "license": "MIT", - "engines": { - "node": "^12.20.0 || ^14.18.0 || >=16.0.0" - }, - "funding": { - "url": "https://opencollective.com/pkgr" - } - }, "node_modules/@polka/url": { "version": "1.0.0-next.29", "resolved": "https://registry.npmjs.org/@polka/url/-/url-1.0.0-next.29.tgz", "integrity": "sha512-wwQAWhWSuHaag8c4q/KN/vCoeOJYshAIvMQwD4GpSb3OiZklFfvAgmj0VCBBImRpuF/aFgIRzllXlVX93Jevww==", "license": "MIT" }, + "node_modules/@rolldown/binding-android-arm64": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-android-arm64/-/binding-android-arm64-1.1.3.tgz", + "integrity": "sha512-DT6Z3PhvioeHMvxo+xHc3KtqggrI7CCTXCmC2h/5zUlp5jVitv7XEy+9q5/7v8IolhlioawpMo8Kg0EEBy7J0g==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@rolldown/binding-darwin-arm64": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-darwin-arm64/-/binding-darwin-arm64-1.1.3.tgz", + "integrity": "sha512-0NwgwsjM7LrsuVnXMK3koTpagBNOhloc/BNjKqZjv4V5zI5r13qx69uVhRx+o5Z0yy4Hzq+lpy7TAgUG/ocvrw==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@rolldown/binding-darwin-x64": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-darwin-x64/-/binding-darwin-x64-1.1.3.tgz", + "integrity": "sha512-YtiBp4disu6V560loT6PjMdiRaWmVvDNrUunAalbiFx2ggeJwxdAsgZMcoGP17uyAsTwAj5V1niksxlHnVQ1Sw==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@rolldown/binding-freebsd-x64": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-freebsd-x64/-/binding-freebsd-x64-1.1.3.tgz", + "integrity": "sha512-yD3EkEdXk2LypPxnf/kSZHirarsI8gcPzc62SukhR9VJTyvV+F9Q/GxWNuCojc7sXyuVC4DxRGhdDK4X8VSsbw==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@rolldown/binding-linux-arm-gnueabihf": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-arm-gnueabihf/-/binding-linux-arm-gnueabihf-1.1.3.tgz", + "integrity": "sha512-c+8vieQbsD7HNAHKIA34w0GJ9FedFFuJGD+7E6vz7Q3uqAIugL5p45fhlsj4UaAsHpcmlqugBWMhA0/j7o0sIg==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@rolldown/binding-linux-arm64-gnu": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-arm64-gnu/-/binding-linux-arm64-gnu-1.1.3.tgz", + "integrity": "sha512-50jD0uUwLvur7Zz9LHz17kaAdTPjn5wN93hEgjvmYFRZwiR7ZJYovTd5ipyWJDAnXKvZ+wgc+/Ika6dwSF5OcA==", + "cpu": [ + "arm64" + ], + "libc": [ + "glibc" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@rolldown/binding-linux-arm64-musl": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-arm64-musl/-/binding-linux-arm64-musl-1.1.3.tgz", + "integrity": "sha512-BO9+oPL8K9poZJBfYPsXNtYjPE5uM3qeehT3aFcW4LITOl+iSqhp0abzjR2nWBUNjIZeKXjAEWBZ64WjNoHd6w==", + "cpu": [ + "arm64" + ], + "libc": [ + "musl" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@rolldown/binding-linux-ppc64-gnu": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-ppc64-gnu/-/binding-linux-ppc64-gnu-1.1.3.tgz", + "integrity": "sha512-f3VpLB1vQ0Eo6ecr/6cekLnvYMFF4YBFoVGkfkvPLq1bAkbAwHYQPZKoAmG6OJyTcxxoC+AvezGx/S1obNC0Mw==", + "cpu": [ + "ppc64" + ], + "libc": [ + "glibc" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@rolldown/binding-linux-s390x-gnu": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-s390x-gnu/-/binding-linux-s390x-gnu-1.1.3.tgz", + "integrity": "sha512-AmurZ26Pqx/RI9N1gzEOCklkKXl927yjfXWUUS0O7Puh8ARM/Ob8qfrD3qnWksScdw6cSrW5PSHE9DyLu7+PtA==", + "cpu": [ + "s390x" + ], + "libc": [ + "glibc" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@rolldown/binding-linux-x64-gnu": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-x64-gnu/-/binding-linux-x64-gnu-1.1.3.tgz", + "integrity": "sha512-JJpqs8bRGITDOdbkNKnlojzBabbOHrqjSvDr0IVsZObE1lBcPjxItUEY9eWIDbxaJ3cGrXPWGfGkIxFijg/URg==", + "cpu": [ + "x64" + ], + "libc": [ + "glibc" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@rolldown/binding-linux-x64-musl": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-x64-musl/-/binding-linux-x64-musl-1.1.3.tgz", + "integrity": "sha512-rSJcdjPxzA/by/6/rYs+v+bXU7UjvnbUWz8MJb6kh6+knqB1dCrtHg0uu7C/4haqJvqdkYHQ5IGn+tCH9GLW/g==", + "cpu": [ + "x64" + ], + "libc": [ + "musl" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@rolldown/binding-openharmony-arm64": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-openharmony-arm64/-/binding-openharmony-arm64-1.1.3.tgz", + "integrity": "sha512-hQ3/PYkDJICgevvyNcVrihVeqq7k1Pp3VZ9lY+dauAYUJKO+auqApvANhvR1An9BhmqYKvW2Mu1F9u4DXSMLxQ==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@rolldown/binding-wasm32-wasi": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-wasm32-wasi/-/binding-wasm32-wasi-1.1.3.tgz", + "integrity": "sha512-Elcv/BtML9lXrV6JuKITc/grN2kYV9gjsQpW8Jfw4ioK0TOkjBjye0nnyqQNy9STNaI20lXNaQBRrD5gSgR0Yg==", + "cpu": [ + "wasm32" + ], + "license": "MIT", + "optional": true, + "dependencies": { + "@emnapi/core": "1.11.1", + "@emnapi/runtime": "1.11.1", + "@napi-rs/wasm-runtime": "^1.1.6" + }, + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@rolldown/binding-win32-arm64-msvc": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-win32-arm64-msvc/-/binding-win32-arm64-msvc-1.1.3.tgz", + "integrity": "sha512-2DrEfhluH9yhiaFApmsjsjwrSYbNcY1oFTzYSP1a535jDbV98zCFanA/96TBUd0iDFcxGmw9QRExwGCXz3U+/g==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@rolldown/binding-win32-x64-msvc": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-win32-x64-msvc/-/binding-win32-x64-msvc-1.1.3.tgz", + "integrity": "sha512-OL4OMk7UPXOeVGGd3qo5zJyPIljf4AFgk5QAkPPS+OoLuOOozhuaQGC18MxVTnw/06q93gShAJzlwnSCY9YtqA==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, "node_modules/@rolldown/pluginutils": { - "version": "1.0.0-rc.3", - "resolved": "https://registry.npmjs.org/@rolldown/pluginutils/-/pluginutils-1.0.0-rc.3.tgz", - "integrity": "sha512-eybk3TjzzzV97Dlj5c+XrBFW57eTNhzod66y9HrBlzJ6NsCrWCp/2kaPS3K9wJmurBC0Tdw4yPjXKZqlznim3Q==", + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@rolldown/pluginutils/-/pluginutils-1.0.1.tgz", + "integrity": "sha512-2j9bGt5Jh8hj+vPtgzPtl72j0yRxHAyumoo6TNfAjsLB04UtpSvPbPcDcBMxz7n+9CYB0c1GxQFxYRg2jimqGw==", "license": "MIT" }, + "node_modules/@rollup/plugin-babel": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/@rollup/plugin-babel/-/plugin-babel-6.1.0.tgz", + "integrity": "sha512-dFZNuFD2YRcoomP4oYf+DvQNSUA9ih+A3vUqopQx5EdtPGo3WBnQcI/S8pwpz91UsGfL0HsMSOlaMld8HrbubA==", + "license": "MIT", + "dependencies": { + "@babel/helper-module-imports": "^7.18.6", + "@rollup/pluginutils": "^5.0.1" + }, + "engines": { + "node": ">=14.0.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0", + "@types/babel__core": "^7.1.9", + "rollup": "^1.20.0||^2.0.0||^3.0.0||^4.0.0" + }, + "peerDependenciesMeta": { + "@types/babel__core": { + "optional": true + }, + "rollup": { + "optional": true + } + } + }, "node_modules/@rollup/plugin-node-resolve": { - "version": "15.3.1", - "resolved": "https://registry.npmjs.org/@rollup/plugin-node-resolve/-/plugin-node-resolve-15.3.1.tgz", - "integrity": "sha512-tgg6b91pAybXHJQMAAwW9VuWBO6Thi+q7BCNARLwSqlmsHz0XYURtGvh/AuwSADXSI4h/2uHbs7s4FzlZDGSGA==", + "version": "16.0.3", + "resolved": "https://registry.npmjs.org/@rollup/plugin-node-resolve/-/plugin-node-resolve-16.0.3.tgz", + "integrity": "sha512-lUYM3UBGuM93CnMPG1YocWu7X802BrNF3jW2zny5gQyLQgRFJhV1Sq0Zi74+dh/6NBx1DxFC4b4GXg9wUCG5Qg==", "license": "MIT", "dependencies": { "@rollup/pluginutils": "^5.0.1", @@ -4428,18 +6191,39 @@ } } }, - "node_modules/@rollup/plugin-terser": { - "version": "0.4.4", - "resolved": "https://registry.npmjs.org/@rollup/plugin-terser/-/plugin-terser-0.4.4.tgz", - "integrity": "sha512-XHeJC5Bgvs8LfukDwWZp7yeqin6ns8RTl2B9avbejt6tZqsqvVoWI7ZTQrcNsfKEDWBTnTxM8nMDkO2IFFbd0A==", + "node_modules/@rollup/plugin-replace": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/@rollup/plugin-replace/-/plugin-replace-6.0.3.tgz", + "integrity": "sha512-J4RZarRvQAm5IF0/LwUUg+obsm+xZhYnbMXmXROyoSE1ATJe3oXSb9L5MMppdxP2ylNSjv6zFBwKYjcKMucVfA==", "license": "MIT", "dependencies": { - "serialize-javascript": "^6.0.1", + "@rollup/pluginutils": "^5.0.1", + "magic-string": "^0.30.3" + }, + "engines": { + "node": ">=14.0.0" + }, + "peerDependencies": { + "rollup": "^1.20.0||^2.0.0||^3.0.0||^4.0.0" + }, + "peerDependenciesMeta": { + "rollup": { + "optional": true + } + } + }, + "node_modules/@rollup/plugin-terser": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@rollup/plugin-terser/-/plugin-terser-1.0.0.tgz", + "integrity": "sha512-FnCxhTBx6bMOYQrar6C8h3scPt8/JwIzw3+AJ2K++6guogH5fYaIFia+zZuhqv0eo1RN7W1Pz630SyvLbDjhtQ==", + "license": "MIT", + "dependencies": { + "serialize-javascript": "^7.0.3", "smob": "^1.0.0", "terser": "^5.17.4" }, "engines": { - "node": ">=14.0.0" + "node": ">=20.0.0" }, "peerDependencies": { "rollup": "^2.0.0||^3.0.0||^4.0.0" @@ -4451,9 +6235,9 @@ } }, "node_modules/@rollup/pluginutils": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/@rollup/pluginutils/-/pluginutils-5.3.0.tgz", - "integrity": "sha512-5EdhGZtnu3V88ces7s53hhfK5KSASnJZv8Lulpc04cWO3REESroJXg73DFsOmgbU2BhwV0E20bu2IDZb3VKW4Q==", + "version": "5.4.0", + "resolved": "https://registry.npmjs.org/@rollup/pluginutils/-/pluginutils-5.4.0.tgz", + "integrity": "sha512-MfPp06CjRLfXQ3wY0R8vJDYBy/MvVcc9OulEfR0B8Iv9ko+GCNaRZ+EpJYFl27LhKsZK0o420sYCRHCjfCgeUg==", "license": "MIT", "dependencies": { "@types/estree": "^1.0.0", @@ -4472,16 +6256,10 @@ } } }, - "node_modules/@rollup/pluginutils/node_modules/estree-walker": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.2.tgz", - "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==", - "license": "MIT" - }, "node_modules/@rollup/rollup-android-arm-eabi": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.59.0.tgz", - "integrity": "sha512-upnNBkA6ZH2VKGcBj9Fyl9IGNPULcjXRlg0LLeaioQWueH30p6IXtJEbKAgvyv+mJaMxSm1l6xwDXYjpEMiLMg==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.62.2.tgz", + "integrity": "sha512-6o7ZLZK+BeenkZCFNDXqpbjw9bD6nuWonvS/lwQJp7NoVVxm6p3qE7qQ5jGuBjiFsgvqjD8mZAU5oWxTmbOeOg==", "cpu": [ "arm" ], @@ -4492,9 +6270,9 @@ ] }, "node_modules/@rollup/rollup-android-arm64": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.59.0.tgz", - "integrity": "sha512-hZ+Zxj3SySm4A/DylsDKZAeVg0mvi++0PYVceVyX7hemkw7OreKdCvW2oQ3T1FMZvCaQXqOTHb8qmBShoqk69Q==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.62.2.tgz", + "integrity": "sha512-BaH7BllCACHoH1LguOU56UItGfUWjujlO65kS9LAodViaN4bwIKd7oeW/ZHJ/4ljr/7MIiENnNy3HJ0zXv8Zkw==", "cpu": [ "arm64" ], @@ -4505,9 +6283,9 @@ ] }, "node_modules/@rollup/rollup-darwin-arm64": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.59.0.tgz", - "integrity": "sha512-W2Psnbh1J8ZJw0xKAd8zdNgF9HRLkdWwwdWqubSVk0pUuQkoHnv7rx4GiF9rT4t5DIZGAsConRE3AxCdJ4m8rg==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.62.2.tgz", + "integrity": "sha512-v39RCCvj4He82I9sFmk+M1VZ0PLM9sfsLVikjfx2hYBNALhrrOR2D3JjQA6AhlaSOgcR+RzrKY7e1+bT6SUO/A==", "cpu": [ "arm64" ], @@ -4518,9 +6296,9 @@ ] }, "node_modules/@rollup/rollup-darwin-x64": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.59.0.tgz", - "integrity": "sha512-ZW2KkwlS4lwTv7ZVsYDiARfFCnSGhzYPdiOU4IM2fDbL+QGlyAbjgSFuqNRbSthybLbIJ915UtZBtmuLrQAT/w==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.62.2.tgz", + "integrity": "sha512-yl0y2vq3S3lHeuXhEdss6TWfKW8vkujImO12tn4ZkG/4oghr09LvdYm2RElVjokTQiUvDUGXLGsYeLqUMCKpGA==", "cpu": [ "x64" ], @@ -4531,9 +6309,9 @@ ] }, "node_modules/@rollup/rollup-freebsd-arm64": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.59.0.tgz", - "integrity": "sha512-EsKaJ5ytAu9jI3lonzn3BgG8iRBjV4LxZexygcQbpiU0wU0ATxhNVEpXKfUa0pS05gTcSDMKpn3Sx+QB9RlTTA==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.62.2.tgz", + "integrity": "sha512-tT4pvt4qXD+vEoezupCWi+a1F0vvDiksiHc+PxRlYTOH1I6/X4id9jPxTP+Fg+545euaFT1jJVs4CEdHZAU1vw==", "cpu": [ "arm64" ], @@ -4544,9 +6322,9 @@ ] }, "node_modules/@rollup/rollup-freebsd-x64": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.59.0.tgz", - "integrity": "sha512-d3DuZi2KzTMjImrxoHIAODUZYoUUMsuUiY4SRRcJy6NJoZ6iIqWnJu9IScV9jXysyGMVuW+KNzZvBLOcpdl3Vg==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.62.2.tgz", + "integrity": "sha512-6nU5F2wCW+qvCBhTn1pdIU3bzsIoF7EUwsCDRxilWGprQR6yd508YnH9+OKFCwpfS8pjZqDUmnCAr7exax0XCg==", "cpu": [ "x64" ], @@ -4557,9 +6335,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-gnueabihf": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.59.0.tgz", - "integrity": "sha512-t4ONHboXi/3E0rT6OZl1pKbl2Vgxf9vJfWgmUoCEVQVxhW6Cw/c8I6hbbu7DAvgp82RKiH7TpLwxnJeKv2pbsw==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.62.2.tgz", + "integrity": "sha512-n1GJHPOvpIfhi3TmrCeh6S6URt9BFCt0KQE3qvexyGCTAKpR4Lg+eWvNZEqu7epxwus/8ElT3hacYEucm49SZg==", "cpu": [ "arm" ], @@ -4573,9 +6351,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-musleabihf": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.59.0.tgz", - "integrity": "sha512-CikFT7aYPA2ufMD086cVORBYGHffBo4K8MQ4uPS/ZnY54GKj36i196u8U+aDVT2LX4eSMbyHtyOh7D7Zvk2VvA==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.62.2.tgz", + "integrity": "sha512-JqgflS8wEB+UXV/vS1RpRbifGBeN4D5lz8D8oOFbFZw4vedvdOgCFAjfBmIMdW3yL10XpQQ0Ambepw6MXrhOnA==", "cpu": [ "arm" ], @@ -4589,9 +6367,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-gnu": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.59.0.tgz", - "integrity": "sha512-jYgUGk5aLd1nUb1CtQ8E+t5JhLc9x5WdBKew9ZgAXg7DBk0ZHErLHdXM24rfX+bKrFe+Xp5YuJo54I5HFjGDAA==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.62.2.tgz", + "integrity": "sha512-wnFJkogWvN4jm/hQRF2UBaeUmk20j5+DmHvoyWii2b8HJDyvz1MF2OU/6ynXt2KR63rbZLWkFpoytpdc/yBuSA==", "cpu": [ "arm64" ], @@ -4605,9 +6383,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-musl": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.59.0.tgz", - "integrity": "sha512-peZRVEdnFWZ5Bh2KeumKG9ty7aCXzzEsHShOZEFiCQlDEepP1dpUl/SrUNXNg13UmZl+gzVDPsiCwnV1uI0RUA==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.62.2.tgz", + "integrity": "sha512-HVu2bp0zhvJ8xHEV9+UUs7S90VadmBSY3LcIMvozbPo4AuMGDWlz3ymHLHZPX4hR67TKTt8Qp5PJ5RBg/i+RMQ==", "cpu": [ "arm64" ], @@ -4621,9 +6399,9 @@ ] }, "node_modules/@rollup/rollup-linux-loong64-gnu": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.59.0.tgz", - "integrity": "sha512-gbUSW/97f7+r4gHy3Jlup8zDG190AuodsWnNiXErp9mT90iCy9NKKU0Xwx5k8VlRAIV2uU9CsMnEFg/xXaOfXg==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.62.2.tgz", + "integrity": "sha512-mQqqAV8QaoSgr9I2fKDLY2BAVvmKjWoGiu/cSYQonsLvtqwEn1E4QYfnCOcp5zoEqNhsDYin1s6jx/VJmrxlZg==", "cpu": [ "loong64" ], @@ -4637,9 +6415,9 @@ ] }, "node_modules/@rollup/rollup-linux-loong64-musl": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.59.0.tgz", - "integrity": "sha512-yTRONe79E+o0FWFijasoTjtzG9EBedFXJMl888NBEDCDV9I2wGbFFfJQQe63OijbFCUZqxpHz1GzpbtSFikJ4Q==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.62.2.tgz", + "integrity": "sha512-IxKLoxCQ2IWi6bT2akyDUBGsOImDKB+sPp4EsTmwFQ/fMwpCKm8uLSSgP/Kx/QYUgKis6SEZ5/Nlhup0DIA0PQ==", "cpu": [ "loong64" ], @@ -4653,9 +6431,9 @@ ] }, "node_modules/@rollup/rollup-linux-ppc64-gnu": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.59.0.tgz", - "integrity": "sha512-sw1o3tfyk12k3OEpRddF68a1unZ5VCN7zoTNtSn2KndUE+ea3m3ROOKRCZxEpmT9nsGnogpFP9x6mnLTCaoLkA==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.62.2.tgz", + "integrity": "sha512-Mk5ha2RQSgyFfmYYLkBpPnUk8D8FriBxesO1u9O75X0mHgXL1UQcH5Itl2lurWL2tj0RxV9b9tJgipac0hRY9A==", "cpu": [ "ppc64" ], @@ -4669,9 +6447,9 @@ ] }, "node_modules/@rollup/rollup-linux-ppc64-musl": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.59.0.tgz", - "integrity": "sha512-+2kLtQ4xT3AiIxkzFVFXfsmlZiG5FXYW7ZyIIvGA7Bdeuh9Z0aN4hVyXS/G1E9bTP/vqszNIN/pUKCk/BTHsKA==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.62.2.tgz", + "integrity": "sha512-CjvEnqJL/0/TQ3TXX3OPIJ/kmBellrWd4heXUmHeJlTnmwjKpSJzoehLaL6Xk0ZnMHBu9dZuFADNOrtjF4v+2w==", "cpu": [ "ppc64" ], @@ -4685,9 +6463,9 @@ ] }, "node_modules/@rollup/rollup-linux-riscv64-gnu": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.59.0.tgz", - "integrity": "sha512-NDYMpsXYJJaj+I7UdwIuHHNxXZ/b/N2hR15NyH3m2qAtb/hHPA4g4SuuvrdxetTdndfj9b1WOmy73kcPRoERUg==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.62.2.tgz", + "integrity": "sha512-1SiZbzwdkaDURsew/tSOrooKiYy7EQGT6m8ufavAi9NEyQb/6VuIxFXAL1fqa4iZe3g4NbNk4P7J32z2tw5Mgg==", "cpu": [ "riscv64" ], @@ -4701,9 +6479,9 @@ ] }, "node_modules/@rollup/rollup-linux-riscv64-musl": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.59.0.tgz", - "integrity": "sha512-nLckB8WOqHIf1bhymk+oHxvM9D3tyPndZH8i8+35p/1YiVoVswPid2yLzgX7ZJP0KQvnkhM4H6QZ5m0LzbyIAg==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.62.2.tgz", + "integrity": "sha512-nQts12zJ3NQRoE6uYljOH89v7szzLDvG2JD/vsX+vGXU8w/At1GowTZ5/7qeFQ8m7L55rpR8Okugnuo5bgjy2Q==", "cpu": [ "riscv64" ], @@ -4717,9 +6495,9 @@ ] }, "node_modules/@rollup/rollup-linux-s390x-gnu": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.59.0.tgz", - "integrity": "sha512-oF87Ie3uAIvORFBpwnCvUzdeYUqi2wY6jRFWJAy1qus/udHFYIkplYRW+wo+GRUP4sKzYdmE1Y3+rY5Gc4ZO+w==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.62.2.tgz", + "integrity": "sha512-E9/ll019jhPIJgpzfZoIkBGhcz+kKNgVWYRY0zr9srBdPPFVpvOKW8VaJKUbeK+eZXyQF9ltME+Kk6affeaPgg==", "cpu": [ "s390x" ], @@ -4733,9 +6511,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-gnu": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.59.0.tgz", - "integrity": "sha512-3AHmtQq/ppNuUspKAlvA8HtLybkDflkMuLK4DPo77DfthRb71V84/c4MlWJXixZz4uruIH4uaa07IqoAkG64fg==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.62.2.tgz", + "integrity": "sha512-5BqxR/pshjey51iliyzTD5Xi3EN0aLmQ2lZ3lvefVV9c82BvrLo2/6OT55iifpWBufs6kdwWbuOKS841DrmK9A==", "cpu": [ "x64" ], @@ -4749,9 +6527,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-musl": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.59.0.tgz", - "integrity": "sha512-2UdiwS/9cTAx7qIUZB/fWtToJwvt0Vbo0zmnYt7ED35KPg13Q0ym1g442THLC7VyI6JfYTP4PiSOWyoMdV2/xg==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.62.2.tgz", + "integrity": "sha512-uNN83XxQrRAh/w0/pmAfibcwyb6YWt4gP+dpnQKPVJshAloQ785ii8CT8ZCIxkGg9opVsvAlGhFitSm6D1Jjpg==", "cpu": [ "x64" ], @@ -4765,9 +6543,9 @@ ] }, "node_modules/@rollup/rollup-openbsd-x64": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.59.0.tgz", - "integrity": "sha512-M3bLRAVk6GOwFlPTIxVBSYKUaqfLrn8l0psKinkCFxl4lQvOSz8ZrKDz2gxcBwHFpci0B6rttydI4IpS4IS/jQ==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.62.2.tgz", + "integrity": "sha512-srjEIxSH3LRnJN6THczDHWQplqEMFiAJrTab0msUryh9kwNpkICf3Ea6q6MN/2cZwRFUNx5w+h6Hpi4QuHS6Zg==", "cpu": [ "x64" ], @@ -4778,9 +6556,9 @@ ] }, "node_modules/@rollup/rollup-openharmony-arm64": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.59.0.tgz", - "integrity": "sha512-tt9KBJqaqp5i5HUZzoafHZX8b5Q2Fe7UjYERADll83O4fGqJ49O1FsL6LpdzVFQcpwvnyd0i+K/VSwu/o/nWlA==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.62.2.tgz", + "integrity": "sha512-8hOJnxgbyObnCm5AlRA3A931xX19xq80RjVTKgJOvEKWqJruP/Uf12IbAOaDjjEXYRewwHLfmF0YRIdK3OwKWA==", "cpu": [ "arm64" ], @@ -4791,9 +6569,9 @@ ] }, "node_modules/@rollup/rollup-win32-arm64-msvc": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.59.0.tgz", - "integrity": "sha512-V5B6mG7OrGTwnxaNUzZTDTjDS7F75PO1ae6MJYdiMu60sq0CqN5CVeVsbhPxalupvTX8gXVSU9gq+Rx1/hvu6A==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.62.2.tgz", + "integrity": "sha512-mmF4AY1i0hG/bLWUctUq59gtmgaSIRa3cu/A3JFRp/sCNEme2bgDEiDS22P9FbnJB8NJNF4jPJiSP5RHQpUTDg==", "cpu": [ "arm64" ], @@ -4804,9 +6582,9 @@ ] }, "node_modules/@rollup/rollup-win32-ia32-msvc": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.59.0.tgz", - "integrity": "sha512-UKFMHPuM9R0iBegwzKF4y0C4J9u8C6MEJgFuXTBerMk7EJ92GFVFYBfOZaSGLu6COf7FxpQNqhNS4c4icUPqxA==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.62.2.tgz", + "integrity": "sha512-DZgkknc6jhHrk46V25vbAM0zZkyP0nSDkJB8/dRkLTxv470dOmWDqGoEJl/9A0dFfS7yE3REOwNDxpHwSLSt0Q==", "cpu": [ "ia32" ], @@ -4817,9 +6595,9 @@ ] }, "node_modules/@rollup/rollup-win32-x64-gnu": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.59.0.tgz", - "integrity": "sha512-laBkYlSS1n2L8fSo1thDNGrCTQMmxjYY5G0WFWjFFYZkKPjsMBsgJfGf4TLxXrF6RyhI60L8TMOjBMvXiTcxeA==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.62.2.tgz", + "integrity": "sha512-T6xr6ucWSFto+VGajA8YH26LdpHRuP4YLHEKAtCWvJDOlnmWcDZVCI2Jmjr+IFHDlt2zRaTAKE4tfjTaWLgJBg==", "cpu": [ "x64" ], @@ -4830,9 +6608,9 @@ ] }, "node_modules/@rollup/rollup-win32-x64-msvc": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.59.0.tgz", - "integrity": "sha512-2HRCml6OztYXyJXAvdDXPKcawukWY2GpR5/nxKp4iBgiO3wcoEGkAaqctIbZcNB6KlUQBIqt8VYkNSj2397EfA==", + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.62.2.tgz", + "integrity": "sha512-BfzEnDJOt9T8M989/lA37EcJgat01wLRnoi5dQf3QzOH7jzpqTAzdDbVfRljVr5r+jzKqpbHeyOfAaXxAd0PAA==", "cpu": [ "x64" ], @@ -4854,45 +6632,11 @@ "integrity": "sha512-MTBk/3jGLNB2tVxv6uLlFh1iu64iYOQ2PbdOSK3NW8JZsmlaOh2q6sdtKowBhfw8QFLmYNzTW4/oK4uATIi6ZA==", "license": "MIT" }, - "node_modules/@surma/rollup-plugin-off-main-thread": { - "version": "2.2.3", - "resolved": "https://registry.npmjs.org/@surma/rollup-plugin-off-main-thread/-/rollup-plugin-off-main-thread-2.2.3.tgz", - "integrity": "sha512-lR8q/9W7hZpMWweNiAKU7NQerBnzQQLvi8qnTDU/fxItPhtZVMbPV3lbCwjhIlNBe9Bbr5V+KHshvWmVSG9cxQ==", - "license": "Apache-2.0", - "dependencies": { - "ejs": "^3.1.6", - "json5": "^2.2.0", - "magic-string": "^0.25.0", - "string.prototype.matchall": "^4.0.6" - } - }, - "node_modules/@surma/rollup-plugin-off-main-thread/node_modules/magic-string": { - "version": "0.25.9", - "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.25.9.tgz", - "integrity": "sha512-RmF0AsMzgt25qzqqLc1+MbHmhdx0ojF2Fvs4XnOqz2ZOBXzzkEwc/dJQZCYHAn7v1jbVOjAZfK8msRn4BxO4VQ==", - "license": "MIT", - "dependencies": { - "sourcemap-codec": "^1.4.8" - } - }, - "node_modules/@testing-library/dom": { - "version": "10.4.1", - "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-10.4.1.tgz", - "integrity": "sha512-o4PXJQidqJl82ckFaXUeoAW+XysPLauYI43Abki5hABd853iMhitooc6znOnczgbTYmEP6U6/y1ZyKAIsvMKGg==", - "license": "MIT", - "dependencies": { - "@babel/code-frame": "^7.10.4", - "@babel/runtime": "^7.12.5", - "@types/aria-query": "^5.0.1", - "aria-query": "5.3.0", - "dom-accessibility-api": "^0.5.9", - "lz-string": "^1.5.0", - "picocolors": "1.1.1", - "pretty-format": "^27.0.2" - }, - "engines": { - "node": ">=18" - } + "node_modules/@standard-schema/spec": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@standard-schema/spec/-/spec-1.1.0.tgz", + "integrity": "sha512-l2aFy5jALhniG5HgqrD6jXLi/rUWrKvqN/qJx6yoJsgKhblVd+iqqU4RCXavm/jPityDo5TCvKMnpjKnOriy0w==", + "license": "MIT" }, "node_modules/@testing-library/jest-dom": { "version": "6.9.1", @@ -4913,97 +6657,29 @@ "yarn": ">=1" } }, - "node_modules/@testing-library/jest-dom/node_modules/dom-accessibility-api": { - "version": "0.6.3", - "resolved": "https://registry.npmjs.org/dom-accessibility-api/-/dom-accessibility-api-0.6.3.tgz", - "integrity": "sha512-7ZgogeTnjuHbo+ct10G9Ffp0mif17idi0IyWNVA/wcwcm7NPOD/WEHVP3n7n3MhXqxoIYm8d6MuZohYWIZ4T3w==", - "license": "MIT" - }, - "node_modules/@testing-library/react": { - "version": "16.3.2", - "resolved": "https://registry.npmjs.org/@testing-library/react/-/react-16.3.2.tgz", - "integrity": "sha512-XU5/SytQM+ykqMnAnvB2umaJNIOsLF3PVv//1Ew4CTcpz0/BRyy/af40qqrt7SjKpDdT1saBMc42CUok5gaw+g==", - "license": "MIT", + "node_modules/@trickfilm400/rollup-plugin-off-main-thread": { + "version": "3.0.0-pre1", + "resolved": "https://registry.npmjs.org/@trickfilm400/rollup-plugin-off-main-thread/-/rollup-plugin-off-main-thread-3.0.0-pre1.tgz", + "integrity": "sha512-/67zpWDBLV+oYAEL682s1ktXL0HgqX76f6gaVGkGnVZlBbm1zd0v4Bz8MFF2GGhoX9rvfq3KSQHubFHwa6w6/Q==", + "license": "Apache-2.0", "dependencies": { - "@babel/runtime": "^7.12.5" + "ejs": "^3.1.10", + "json5": "^2.2.3", + "magic-string": "^0.30.21", + "string.prototype.matchall": "^4.0.12" }, "engines": { - "node": ">=18" - }, - "peerDependencies": { - "@testing-library/dom": "^10.0.0", - "@types/react": "^18.0.0 || ^19.0.0", - "@types/react-dom": "^18.0.0 || ^19.0.0", - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - }, - "peerDependenciesMeta": { - "@types/react": { - "optional": true - }, - "@types/react-dom": { - "optional": true - } + "node": ">=12" } }, - "node_modules/@testing-library/user-event": { - "version": "14.6.1", - "resolved": "https://registry.npmjs.org/@testing-library/user-event/-/user-event-14.6.1.tgz", - "integrity": "sha512-vq7fv0rnt+QTXgPxr5Hjc210p6YKq2kmdziLgnsZGgLJ9e6VAShx1pACLuRjd/AS/sr7phAR58OIIpf0LlmQNw==", - "license": "MIT", - "engines": { - "node": ">=12", - "npm": ">=6" - }, - "peerDependencies": { - "@testing-library/dom": ">=7.21.4" - } - }, - "node_modules/@types/aria-query": { - "version": "5.0.4", - "resolved": "https://registry.npmjs.org/@types/aria-query/-/aria-query-5.0.4.tgz", - "integrity": "sha512-rfT93uj5s0PRL7EzccGMs3brplhcrghnDoV26NqKhCAS1hVo+WdNsPvE/yb6ilfr5hi2MEk6d5EWJTKdxg8jVw==", - "license": "MIT" - }, - "node_modules/@types/babel__core": { - "version": "7.20.5", - "resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.20.5.tgz", - "integrity": "sha512-qoQprZvz5wQFJwMDqeseRXWv3rqMvhgpbXFfVyWhbx9X47POIA6i/+dXefEmZKoAgOaTdaIgNSMqMIU61yRyzA==", + "node_modules/@tybys/wasm-util": { + "version": "0.10.3", + "resolved": "https://registry.npmjs.org/@tybys/wasm-util/-/wasm-util-0.10.3.tgz", + "integrity": "sha512-F3fo1MYrRJYL3zER0OUOmkutjr1Vp23m7OsSgp7nq4SP6OqX6C/56XFIPAl5bt3zaBRjmW7SGz3u/6LwFpYcOg==", "license": "MIT", + "optional": true, "dependencies": { - "@babel/parser": "^7.20.7", - "@babel/types": "^7.20.7", - "@types/babel__generator": "*", - "@types/babel__template": "*", - "@types/babel__traverse": "*" - } - }, - "node_modules/@types/babel__generator": { - "version": "7.27.0", - "resolved": "https://registry.npmjs.org/@types/babel__generator/-/babel__generator-7.27.0.tgz", - "integrity": "sha512-ufFd2Xi92OAVPYsy+P4n7/U7e68fex0+Ee8gSG9KX7eo084CWiQ4sdxktvdl0bOPupXtVJPY19zk6EwWqUQ8lg==", - "license": "MIT", - "dependencies": { - "@babel/types": "^7.0.0" - } - }, - "node_modules/@types/babel__template": { - "version": "7.4.4", - "resolved": "https://registry.npmjs.org/@types/babel__template/-/babel__template-7.4.4.tgz", - "integrity": "sha512-h/NUaSyG5EyxBIp8YRxo4RMe2/qQgvyowRwVMzhYhBCONbW8PUsg4lkFMrhgZhUe5z3L3MiLDuvyJ/CaPa2A8A==", - "license": "MIT", - "dependencies": { - "@babel/parser": "^7.1.0", - "@babel/types": "^7.0.0" - } - }, - "node_modules/@types/babel__traverse": { - "version": "7.28.0", - "resolved": "https://registry.npmjs.org/@types/babel__traverse/-/babel__traverse-7.28.0.tgz", - "integrity": "sha512-8PvcXf70gTDZBgt9ptxJ8elBeBjcLOAcOtoO/mPJjtji1+CdGbHgm77om1GrsPxsiE+uXIpNSK64UYaIwQXd4Q==", - "license": "MIT", - "dependencies": { - "@babel/types": "^7.28.2" + "tslib": "^2.4.0" } }, "node_modules/@types/chai": { @@ -5032,20 +6708,10 @@ "@types/json-schema": "*" } }, - "node_modules/@types/eslint-scope": { - "version": "3.7.7", - "resolved": "https://registry.npmjs.org/@types/eslint-scope/-/eslint-scope-3.7.7.tgz", - "integrity": "sha512-MzMFlSLBqNF2gcHWO0G1vP/YQyfvrxZ0bF+u7mzUdZ1/xK4A4sru+nraZz5i3iEIk1l1uyicaDVTB4QbbEkAYg==", - "license": "MIT", - "dependencies": { - "@types/eslint": "*", - "@types/estree": "*" - } - }, "node_modules/@types/estree": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", - "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.9.tgz", + "integrity": "sha512-GhdPgy1el4/ImP05X05Uw4cw2/M93BCUmnEvWZNStlCzEKME4Fkk+YpoA5OiHNQmoS7Cafb8Xa3Pya8m1Qrzeg==", "license": "MIT" }, "node_modules/@types/geojson": { @@ -5107,12 +6773,12 @@ "license": "MIT" }, "node_modules/@types/node": { - "version": "25.3.3", - "resolved": "https://registry.npmjs.org/@types/node/-/node-25.3.3.tgz", - "integrity": "sha512-DpzbrH7wIcBaJibpKo9nnSQL0MTRdnWttGyE5haGwK86xgMOkFLp7vEyfQPGLOJh5wNYiJ3V9PmUMDhV9u8kkQ==", + "version": "26.0.1", + "resolved": "https://registry.npmjs.org/@types/node/-/node-26.0.1.tgz", + "integrity": "sha512-fc3KiUoBt6kie0N9bIW3E47vZsuaMf0PM2AaUpLCLT0s/LvX1nxAim6Fc049cNxODPpGm6qRAuUOB86SkRuPQw==", "license": "MIT", "dependencies": { - "undici-types": "~7.18.0" + "undici-types": "~8.3.0" } }, "node_modules/@types/parse-json": { @@ -5133,15 +6799,6 @@ "integrity": "sha512-60BCwRFOZCQhDncwQdxxeOEEkbc5dIMccYLwbxsS4TUNeVECQ/pBJ0j09mrHOl/JJvpRPGwO9SvE4nR2Nb/a4Q==", "license": "MIT" }, - "node_modules/@types/supercluster": { - "version": "7.1.3", - "resolved": "https://registry.npmjs.org/@types/supercluster/-/supercluster-7.1.3.tgz", - "integrity": "sha512-Z0pOY34GDFl3Q6hUFYf3HkTwKEE02e7QgtJppBt+beEAxnyOpJua+voGFvxINBHa06GwLFFym7gRPY2SiKIfIA==", - "license": "MIT", - "dependencies": { - "@types/geojson": "*" - } - }, "node_modules/@types/trusted-types": { "version": "2.0.7", "resolved": "https://registry.npmjs.org/@types/trusted-types/-/trusted-types-2.0.7.tgz", @@ -5163,109 +6820,45 @@ "integrity": "sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ==", "license": "MIT" }, - "node_modules/@vitejs/plugin-react": { - "version": "5.1.4", - "resolved": "https://registry.npmjs.org/@vitejs/plugin-react/-/plugin-react-5.1.4.tgz", - "integrity": "sha512-VIcFLdRi/VYRU8OL/puL7QXMYafHmqOnwTZY50U1JPlCNj30PxCMx65c494b1K9be9hX83KVt0+gTEwTWLqToA==", - "license": "MIT", - "dependencies": { - "@babel/core": "^7.29.0", - "@babel/plugin-transform-react-jsx-self": "^7.27.1", - "@babel/plugin-transform-react-jsx-source": "^7.27.1", - "@rolldown/pluginutils": "1.0.0-rc.3", - "@types/babel__core": "^7.20.5", - "react-refresh": "^0.18.0" - }, - "engines": { - "node": "^20.19.0 || >=22.12.0" - }, - "peerDependencies": { - "vite": "^4.2.0 || ^5.0.0 || ^6.0.0 || ^7.0.0" - } - }, "node_modules/@vitejs/plugin-vue": { - "version": "6.0.4", - "resolved": "https://registry.npmjs.org/@vitejs/plugin-vue/-/plugin-vue-6.0.4.tgz", - "integrity": "sha512-uM5iXipgYIn13UUQCZNdWkYk+sysBeA97d5mHsAoAt1u/wpN3+zxOmsVJWosuzX+IMGRzeYUNytztrYznboIkQ==", + "version": "6.0.7", + "resolved": "https://registry.npmjs.org/@vitejs/plugin-vue/-/plugin-vue-6.0.7.tgz", + "integrity": "sha512-km+p+XdSz9Sxm5rqUbqcSfZYaAniKxWBj1KURl+Jr7UaPvvX7BmaWMdP69I5rrFDeQGyxAG7NXdc57vz+snhWg==", "license": "MIT", "dependencies": { - "@rolldown/pluginutils": "1.0.0-rc.2" + "@rolldown/pluginutils": "^1.0.1" }, "engines": { "node": "^20.19.0 || >=22.12.0" }, "peerDependencies": { - "vite": "^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0-0", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0", "vue": "^3.2.25" } }, - "node_modules/@vitejs/plugin-vue/node_modules/@rolldown/pluginutils": { - "version": "1.0.0-rc.2", - "resolved": "https://registry.npmjs.org/@rolldown/pluginutils/-/pluginutils-1.0.0-rc.2.tgz", - "integrity": "sha512-izyXV/v+cHiRfozX62W9htOAvwMo4/bXKDrQ+vom1L1qRuexPock/7VZDAhnpHCLNejd3NJ6hiab+tO0D44Rgw==", - "license": "MIT" - }, - "node_modules/@vitest/browser": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/browser/-/browser-3.2.4.tgz", - "integrity": "sha512-tJxiPrWmzH8a+w9nLKlQMzAKX/7VjFs50MWgcAj7p9XQ7AQ9/35fByFYptgPELyLw+0aixTnC4pUWV+APcZ/kw==", - "license": "MIT", - "dependencies": { - "@testing-library/dom": "^10.4.0", - "@testing-library/user-event": "^14.6.1", - "@vitest/mocker": "3.2.4", - "@vitest/utils": "3.2.4", - "magic-string": "^0.30.17", - "sirv": "^3.0.1", - "tinyrainbow": "^2.0.0", - "ws": "^8.18.2" - }, - "funding": { - "url": "https://opencollective.com/vitest" - }, - "peerDependencies": { - "playwright": "*", - "vitest": "3.2.4", - "webdriverio": "^7.0.0 || ^8.0.0 || ^9.0.0" - }, - "peerDependenciesMeta": { - "playwright": { - "optional": true - }, - "safaridriver": { - "optional": true - }, - "webdriverio": { - "optional": true - } - } - }, "node_modules/@vitest/coverage-v8": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-3.2.4.tgz", - "integrity": "sha512-EyF9SXU6kS5Ku/U82E259WSnvg6c8KTjppUncuNdm5QHpe17mwREHnjDzozC8x9MZ0xfBUFSaLkRv4TMA75ALQ==", + "version": "4.1.10", + "resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-4.1.10.tgz", + "integrity": "sha512-IM49HmthevbgAO4anp1hwtoT9wYe59w0LR00gr+eagHE+ZJ5lK4sLPeO0ubgoJcwLk6dehU3R24N+FbEEKDc8g==", "license": "MIT", "dependencies": { - "@ampproject/remapping": "^2.3.0", "@bcoe/v8-coverage": "^1.0.2", - "ast-v8-to-istanbul": "^0.3.3", - "debug": "^4.4.1", + "@vitest/utils": "4.1.10", + "ast-v8-to-istanbul": "^1.0.0", "istanbul-lib-coverage": "^3.2.2", "istanbul-lib-report": "^3.0.1", - "istanbul-lib-source-maps": "^5.0.6", - "istanbul-reports": "^3.1.7", - "magic-string": "^0.30.17", - "magicast": "^0.3.5", - "std-env": "^3.9.0", - "test-exclude": "^7.0.1", - "tinyrainbow": "^2.0.0" + "istanbul-reports": "^3.2.0", + "magicast": "^0.5.2", + "obug": "^2.1.1", + "std-env": "^4.0.0-rc.1", + "tinyrainbow": "^3.1.0" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { - "@vitest/browser": "3.2.4", - "vitest": "3.2.4" + "@vitest/browser": "4.1.10", + "vitest": "4.1.10" }, "peerDependenciesMeta": { "@vitest/browser": { @@ -5274,37 +6867,38 @@ } }, "node_modules/@vitest/expect": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-3.2.4.tgz", - "integrity": "sha512-Io0yyORnB6sikFlt8QW5K7slY4OjqNX9jmJQ02QDda8lyM6B5oNgVWoSoKPac8/kgnCUzuHQKrSLtu/uOqqrig==", + "version": "4.1.10", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-4.1.10.tgz", + "integrity": "sha512-YsCn+qAk1GWjQOWFEsEcL2gNQ0zmVmQu3T03qP6UyjhtmdtwtbuI+DASn/7iQB3HGTXkdBwGddzxPlmiql5vlA==", "license": "MIT", "dependencies": { + "@standard-schema/spec": "^1.1.0", "@types/chai": "^5.2.2", - "@vitest/spy": "3.2.4", - "@vitest/utils": "3.2.4", - "chai": "^5.2.0", - "tinyrainbow": "^2.0.0" + "@vitest/spy": "4.1.10", + "@vitest/utils": "4.1.10", + "chai": "^6.2.2", + "tinyrainbow": "^3.1.0" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/mocker": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-3.2.4.tgz", - "integrity": "sha512-46ryTE9RZO/rfDd7pEqFl7etuyzekzEhUbTW3BvmeO/BcCMEgq59BKhek3dXDWgAj4oMK6OZi+vRr1wPW6qjEQ==", + "version": "4.1.10", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-4.1.10.tgz", + "integrity": "sha512-v0xaezt+DKEmKfaxg133ldzADrwLGd7Ze1MfQQTYfvs8OqZIwbxyxaYURivwV7sWy5fqn3rH5uOrSp07bp44Ow==", "license": "MIT", "dependencies": { - "@vitest/spy": "3.2.4", + "@vitest/spy": "4.1.10", "estree-walker": "^3.0.3", - "magic-string": "^0.30.17" + "magic-string": "^0.30.21" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { "msw": "^2.4.9", - "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0" }, "peerDependenciesMeta": { "msw": { @@ -5315,40 +6909,49 @@ } } }, - "node_modules/@vitest/pretty-format": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-3.2.4.tgz", - "integrity": "sha512-IVNZik8IVRJRTr9fxlitMKeJeXFFFN0JaB9PHPGQ8NKQbGpfjlTx9zO4RefN8gp7eqjNy8nyK3NZmBzOPeIxtA==", + "node_modules/@vitest/mocker/node_modules/estree-walker": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", + "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", "license": "MIT", "dependencies": { - "tinyrainbow": "^2.0.0" + "@types/estree": "^1.0.0" + } + }, + "node_modules/@vitest/pretty-format": { + "version": "4.1.10", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-4.1.10.tgz", + "integrity": "sha512-W1HsjSH4MXQ9YfmmhLAoIYf1HRfekQCGngeIgcei6MP5QQGWUe0gkopdZQaVCFO+JDJMrAJGwa5pRpNpvy4P8Q==", + "license": "MIT", + "dependencies": { + "tinyrainbow": "^3.1.0" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/runner": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-3.2.4.tgz", - "integrity": "sha512-oukfKT9Mk41LreEW09vt45f8wx7DordoWUZMYdY/cyAk7w5TWkTRCNZYF7sX7n2wB7jyGAl74OxgwhPgKaqDMQ==", + "version": "4.1.10", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-4.1.10.tgz", + "integrity": "sha512-IKI6kpIH+LmpROplyLwBBaCfMgOZOMsygVa6BARD6ahA04VRuJSa6OaVG7kRvSEMD870Vd91rSSw0eegtWyLGg==", "license": "MIT", "dependencies": { - "@vitest/utils": "3.2.4", - "pathe": "^2.0.3", - "strip-literal": "^3.0.0" + "@vitest/utils": "4.1.10", + "pathe": "^2.0.3" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/snapshot": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-3.2.4.tgz", - "integrity": "sha512-dEYtS7qQP2CjU27QBC5oUOxLE/v5eLkGqPE0ZKEIDGMs4vKWe7IjgLOeauHsR0D5YuuycGRO5oSRXnwnmA78fQ==", + "version": "4.1.10", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-4.1.10.tgz", + "integrity": "sha512-xRkfOT1qpTAi/Ti4Y1LtfRc3kEuqxGw59eN2jN9pRWMtS/XDevekhcFSqvQqjUNGksfjMJu3Y+oJ+4Ypn2OaJw==", "license": "MIT", "dependencies": { - "@vitest/pretty-format": "3.2.4", - "magic-string": "^0.30.17", + "@vitest/pretty-format": "4.1.10", + "@vitest/utils": "4.1.10", + "magic-string": "^0.30.21", "pathe": "^2.0.3" }, "funding": { @@ -5356,47 +6959,23 @@ } }, "node_modules/@vitest/spy": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-3.2.4.tgz", - "integrity": "sha512-vAfasCOe6AIK70iP5UD11Ac4siNUNJ9i/9PZ3NKx07sG6sUxeag1LWdNrMWeKKYBLlzuK+Gn65Yd5nyL6ds+nw==", + "version": "4.1.10", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-4.1.10.tgz", + "integrity": "sha512-PLf/Ugvoq5wO/b4rwYCR1h2PSIdXz7wnkQFMiUpLdtM7l6pqVFcQIBEHyT1+l+cj7mNwAfZHzqXqDyjvOuwbDw==", "license": "MIT", - "dependencies": { - "tinyspy": "^4.0.3" - }, "funding": { "url": "https://opencollective.com/vitest" } }, - "node_modules/@vitest/ui": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/ui/-/ui-3.2.4.tgz", - "integrity": "sha512-hGISOaP18plkzbWEcP/QvtRW1xDXF2+96HbEX6byqQhAUbiS5oH6/9JwW+QsQCIYON2bI6QZBF+2PvOmrRZ9wA==", - "license": "MIT", - "dependencies": { - "@vitest/utils": "3.2.4", - "fflate": "^0.8.2", - "flatted": "^3.3.3", - "pathe": "^2.0.3", - "sirv": "^3.0.1", - "tinyglobby": "^0.2.14", - "tinyrainbow": "^2.0.0" - }, - "funding": { - "url": "https://opencollective.com/vitest" - }, - "peerDependencies": { - "vitest": "3.2.4" - } - }, "node_modules/@vitest/utils": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-3.2.4.tgz", - "integrity": "sha512-fB2V0JFrQSMsCo9HiSq3Ezpdv4iYaXRG1Sx8edX3MwxfyNn83mKiGzOcH+Fkxt4MHxr3y42fQi1oeAInqgX2QA==", + "version": "4.1.10", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-4.1.10.tgz", + "integrity": "sha512-fy9am/HWxbaGt/Sawrp90vt6Y6jQwf1RX77cz3uwoJwJVMli/e1IEwRPnMNJ7vKfPTwo0diXifkpPvwH9v7nGA==", "license": "MIT", "dependencies": { - "@vitest/pretty-format": "3.2.4", - "loupe": "^3.1.4", - "tinyrainbow": "^2.0.0" + "@vitest/pretty-format": "4.1.10", + "convert-source-map": "^2.0.0", + "tinyrainbow": "^3.1.0" }, "funding": { "url": "https://opencollective.com/vitest" @@ -5477,65 +7056,53 @@ "license": "MIT" }, "node_modules/@vue/compiler-core": { - "version": "3.5.29", - "resolved": "https://registry.npmjs.org/@vue/compiler-core/-/compiler-core-3.5.29.tgz", - "integrity": "sha512-cuzPhD8fwRHk8IGfmYaR4eEe4cAyJEL66Ove/WZL7yWNL134nqLddSLwNRIsFlnnW1kK+p8Ck3viFnC0chXCXw==", + "version": "3.5.39", + "resolved": "https://registry.npmjs.org/@vue/compiler-core/-/compiler-core-3.5.39.tgz", + "integrity": "sha512-16KBTEXAJCpDr0mwlw+AZyhu8iyC7R3S2vBwsI7QnWJU6X3WKc9VKeNEZpiMdZ569qWhz9574L3vV55qRL0Vtw==", "license": "MIT", "dependencies": { - "@babel/parser": "^7.29.0", - "@vue/shared": "3.5.29", + "@babel/parser": "^7.29.7", + "@vue/shared": "3.5.39", "entities": "^7.0.1", "estree-walker": "^2.0.2", "source-map-js": "^1.2.1" } }, - "node_modules/@vue/compiler-core/node_modules/estree-walker": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.2.tgz", - "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==", - "license": "MIT" - }, "node_modules/@vue/compiler-dom": { - "version": "3.5.29", - "resolved": "https://registry.npmjs.org/@vue/compiler-dom/-/compiler-dom-3.5.29.tgz", - "integrity": "sha512-n0G5o7R3uBVmVxjTIYcz7ovr8sy7QObFG8OQJ3xGCDNhbG60biP/P5KnyY8NLd81OuT1WJflG7N4KWYHaeeaIg==", + "version": "3.5.39", + "resolved": "https://registry.npmjs.org/@vue/compiler-dom/-/compiler-dom-3.5.39.tgz", + "integrity": "sha512-oQPigALqYbNxTNPvNgSOe+czwVExfbVF02lz8jP0S3AXJiu3jxYDygNUiqSep4ezzW8XgnubqH63My2A7JR/vg==", "license": "MIT", "dependencies": { - "@vue/compiler-core": "3.5.29", - "@vue/shared": "3.5.29" + "@vue/compiler-core": "3.5.39", + "@vue/shared": "3.5.39" } }, "node_modules/@vue/compiler-sfc": { - "version": "3.5.29", - "resolved": "https://registry.npmjs.org/@vue/compiler-sfc/-/compiler-sfc-3.5.29.tgz", - "integrity": "sha512-oJZhN5XJs35Gzr50E82jg2cYdZQ78wEwvRO6Y63TvLVTc+6xICzJHP1UIecdSPPYIbkautNBanDiWYa64QSFIA==", + "version": "3.5.39", + "resolved": "https://registry.npmjs.org/@vue/compiler-sfc/-/compiler-sfc-3.5.39.tgz", + "integrity": "sha512-d0ki86iOyN8LoZPBmk5SJWNwHP19CnDDCfuo//+2WJa2g5Ke0Jay983PIBIcSSzldC68I8DrD5GrHV3OSDfodg==", "license": "MIT", "dependencies": { - "@babel/parser": "^7.29.0", - "@vue/compiler-core": "3.5.29", - "@vue/compiler-dom": "3.5.29", - "@vue/compiler-ssr": "3.5.29", - "@vue/shared": "3.5.29", + "@babel/parser": "^7.29.7", + "@vue/compiler-core": "3.5.39", + "@vue/compiler-dom": "3.5.39", + "@vue/compiler-ssr": "3.5.39", + "@vue/shared": "3.5.39", "estree-walker": "^2.0.2", "magic-string": "^0.30.21", - "postcss": "^8.5.6", + "postcss": "^8.5.15", "source-map-js": "^1.2.1" } }, - "node_modules/@vue/compiler-sfc/node_modules/estree-walker": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.2.tgz", - "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==", - "license": "MIT" - }, "node_modules/@vue/compiler-ssr": { - "version": "3.5.29", - "resolved": "https://registry.npmjs.org/@vue/compiler-ssr/-/compiler-ssr-3.5.29.tgz", - "integrity": "sha512-Y/ARJZE6fpjzL5GH/phJmsFwx3g6t2KmHKHx5q+MLl2kencADKIrhH5MLF6HHpRMmlRAYBRSvv347Mepf1zVNw==", + "version": "3.5.39", + "resolved": "https://registry.npmjs.org/@vue/compiler-ssr/-/compiler-ssr-3.5.39.tgz", + "integrity": "sha512-Ce7/wvwMHai74bdszfXExdazFigYnlF9zgCmEQUcM1j0fOymlouZ7XilTYNo8oUjhlnjYOZbGrcYKuqjz89Ucw==", "license": "MIT", "dependencies": { - "@vue/compiler-dom": "3.5.29", - "@vue/shared": "3.5.29" + "@vue/compiler-dom": "3.5.39", + "@vue/shared": "3.5.39" } }, "node_modules/@vue/devtools-api": { @@ -5545,31 +7112,44 @@ "license": "MIT" }, "node_modules/@vue/language-core": { - "version": "3.2.5", - "resolved": "https://registry.npmjs.org/@vue/language-core/-/language-core-3.2.5.tgz", - "integrity": "sha512-d3OIxN/+KRedeM5wQ6H6NIpwS3P5gC9nmyaHgBk+rO6dIsjY+tOh4UlPpiZbAh3YtLdCGEX4M16RmsBqPmJV+g==", + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/@vue/language-core/-/language-core-3.3.6.tgz", + "integrity": "sha512-LgBMZAy2sR3cQWknpyaxnI6yBkqDfLBPkbdhwRhQCvzfNJRQXPilgQIrdI/v4ytJ0sAq9bWhaPsjqBqneomJ3Q==", "license": "MIT", "dependencies": { "@volar/language-core": "2.4.28", "@vue/compiler-dom": "^3.5.0", "@vue/shared": "^3.5.0", - "alien-signals": "^3.0.0", + "alien-signals": "^3.2.0", "muggle-string": "^0.4.1", "path-browserify": "^1.0.1", - "picomatch": "^4.0.2" + "picomatch": "^4.0.4" + } + }, + "node_modules/@vue/language-plugin-pug": { + "version": "3.2.9", + "resolved": "https://registry.npmjs.org/@vue/language-plugin-pug/-/language-plugin-pug-3.2.9.tgz", + "integrity": "sha512-EaRtg3/1TQo9D20nBex1G3NtWElJbSgiiisZe6TwiNKpSCRwFmmvuAkz+AfMmsQc53si3zbkApU8RF0o6ULQag==", + "license": "MIT", + "dependencies": { + "@volar/source-map": "2.4.28", + "muggle-string": "^0.4.1", + "pug-lexer": "^5.0.1", + "pug-parser": "^6.0.0", + "vscode-languageserver-textdocument": "^1.0.12" } }, "node_modules/@vue/language-server": { - "version": "3.2.5", - "resolved": "https://registry.npmjs.org/@vue/language-server/-/language-server-3.2.5.tgz", - "integrity": "sha512-heOphAHSAOJanlmiIH7gZOmh0DVfNkhTvbk+gOnfnwKQpwA8KqpgYb8On5/WIuLBlJuJavSfVdm75WdZGQM2Rg==", + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/@vue/language-server/-/language-server-3.3.6.tgz", + "integrity": "sha512-86t6vpJP85TBMqInkuBJP+bzZ+tkCqp6JWSFAQw6wI7Tatoah0XNP/7DQE5cCC+u+byXJ51Fzt+sjv4L9vFbBg==", "license": "MIT", "dependencies": { "@volar/language-server": "2.4.28", - "@vue/language-core": "3.2.5", - "@vue/language-service": "3.2.5", - "@vue/typescript-plugin": "3.2.5", - "vscode-uri": "^3.0.8" + "@vue/language-core": "3.3.6", + "@vue/language-service": "3.3.6", + "@vue/typescript-plugin": "3.3.6", + "vscode-uri": "^3.1.0" }, "bin": { "vue-language-server": "bin/vue-language-server.js" @@ -5579,97 +7159,107 @@ } }, "node_modules/@vue/language-service": { - "version": "3.2.5", - "resolved": "https://registry.npmjs.org/@vue/language-service/-/language-service-3.2.5.tgz", - "integrity": "sha512-Bzu75iKy3Lf3afn/2WswhAmyV/0Yn7ZhKlBnHTtC+qKWXPAMlk75P018yFssOc1EAbPDmKSVNrCZJhjtWEMJPg==", + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/@vue/language-service/-/language-service-3.3.6.tgz", + "integrity": "sha512-9OYuFCdmKkrle74pzOx0u5nuwVX67vsnA/1FXb1xYBPl5XEKG9XDC2RUaIs7WJ/g/mRnXJAnDbYWi43U+VMmng==", "license": "MIT", "dependencies": { "@volar/language-service": "2.4.28", - "@vue/language-core": "3.2.5", + "@vue/language-core": "3.3.6", "@vue/shared": "^3.5.0", "path-browserify": "^1.0.1", - "volar-service-css": "0.0.68", - "volar-service-emmet": "0.0.68", - "volar-service-html": "0.0.68", - "volar-service-json": "0.0.68", - "volar-service-pug": "0.0.68", - "volar-service-pug-beautify": "0.0.68", - "volar-service-typescript": "0.0.68", - "vscode-html-languageservice": "^5.2.0", - "vscode-uri": "^3.0.8" + "volar-service-css": "0.0.71", + "volar-service-emmet": "0.0.71", + "volar-service-html": "0.0.71", + "volar-service-json": "0.0.71", + "volar-service-pug": "0.0.71", + "volar-service-pug-beautify": "0.0.71", + "volar-service-typescript": "0.0.71", + "vscode-html-languageservice": "^5.6.2", + "vscode-uri": "^3.1.0" } }, "node_modules/@vue/reactivity": { - "version": "3.5.29", - "resolved": "https://registry.npmjs.org/@vue/reactivity/-/reactivity-3.5.29.tgz", - "integrity": "sha512-zcrANcrRdcLtmGZETBxWqIkoQei8HaFpZWx/GHKxx79JZsiZ8j1du0VUJtu4eJjgFvU/iKL5lRXFXksVmI+5DA==", + "version": "3.5.39", + "resolved": "https://registry.npmjs.org/@vue/reactivity/-/reactivity-3.5.39.tgz", + "integrity": "sha512-TpsuBJ9gGlZa5d23XcM2y8EXanz9dZeVDQBXRwzy46ItgvM+rWpzs+UVM0wcRLxGvcav0HE5jz2gNL53xlRAog==", "license": "MIT", "dependencies": { - "@vue/shared": "3.5.29" + "@vue/shared": "3.5.39" } }, "node_modules/@vue/runtime-core": { - "version": "3.5.29", - "resolved": "https://registry.npmjs.org/@vue/runtime-core/-/runtime-core-3.5.29.tgz", - "integrity": "sha512-8DpW2QfdwIWOLqtsNcds4s+QgwSaHSJY/SUe04LptianUQ/0xi6KVsu/pYVh+HO3NTVvVJjIPL2t6GdeKbS4Lg==", + "version": "3.5.39", + "resolved": "https://registry.npmjs.org/@vue/runtime-core/-/runtime-core-3.5.39.tgz", + "integrity": "sha512-9GLtNyRvPAUMbX+7ono0RC2j0guo2LXVi8LvcmAooImACUKm0oFf0jjwbX8/H0AE/t1nxhAkn8RSl9PMCzzxZw==", "license": "MIT", "dependencies": { - "@vue/reactivity": "3.5.29", - "@vue/shared": "3.5.29" + "@vue/reactivity": "3.5.39", + "@vue/shared": "3.5.39" } }, "node_modules/@vue/runtime-dom": { - "version": "3.5.29", - "resolved": "https://registry.npmjs.org/@vue/runtime-dom/-/runtime-dom-3.5.29.tgz", - "integrity": "sha512-AHvvJEtcY9tw/uk+s/YRLSlxxQnqnAkjqvK25ZiM4CllCZWzElRAoQnCM42m9AHRLNJ6oe2kC5DCgD4AUdlvXg==", + "version": "3.5.39", + "resolved": "https://registry.npmjs.org/@vue/runtime-dom/-/runtime-dom-3.5.39.tgz", + "integrity": "sha512-7Y6aAGboKcXAZ3ECuUy7RrS5yy2r47dhTp2SKaJmYxjopImaVFaNa5Ne66NwGovsrxVAl5S5rwc7m22UG7Lmww==", "license": "MIT", "dependencies": { - "@vue/reactivity": "3.5.29", - "@vue/runtime-core": "3.5.29", - "@vue/shared": "3.5.29", + "@vue/reactivity": "3.5.39", + "@vue/runtime-core": "3.5.39", + "@vue/shared": "3.5.39", "csstype": "^3.2.3" } }, "node_modules/@vue/server-renderer": { - "version": "3.5.29", - "resolved": "https://registry.npmjs.org/@vue/server-renderer/-/server-renderer-3.5.29.tgz", - "integrity": "sha512-G/1k6WK5MusLlbxSE2YTcqAAezS+VuwHhOvLx2KnQU7G2zCH6KIb+5Wyt6UjMq7a3qPzNEjJXs1hvAxDclQH+g==", + "version": "3.5.39", + "resolved": "https://registry.npmjs.org/@vue/server-renderer/-/server-renderer-3.5.39.tgz", + "integrity": "sha512-yZSakiAGw85rZfG7UM8akMnIF+FmeiNk47uvHf2nVBBSe+dIKUhZuZq9+XgJhbV3nS5Z4ALH23/MpXofW+mbcw==", "license": "MIT", "dependencies": { - "@vue/compiler-ssr": "3.5.29", - "@vue/shared": "3.5.29" + "@vue/compiler-ssr": "3.5.39", + "@vue/shared": "3.5.39" }, "peerDependencies": { - "vue": "3.5.29" + "vue": "3.5.39" } }, "node_modules/@vue/shared": { - "version": "3.5.29", - "resolved": "https://registry.npmjs.org/@vue/shared/-/shared-3.5.29.tgz", - "integrity": "sha512-w7SR0A5zyRByL9XUkCfdLs7t9XOHUyJ67qPGQjOou3p6GvBeBW+AVjUUmlxtZ4PIYaRvE+1LmK44O4uajlZwcg==", + "version": "3.5.39", + "resolved": "https://registry.npmjs.org/@vue/shared/-/shared-3.5.39.tgz", + "integrity": "sha512-l1rrBtBfTnmxvtsvdQDXltUUy8S1Y+ZaqdfUzmAnJkTd8Z8rv5v/ytW+TKiqEOWyHPoqtPlNFSs0lhRmYVSHVA==", "license": "MIT" }, "node_modules/@vue/test-utils": { - "version": "2.4.6", - "resolved": "https://registry.npmjs.org/@vue/test-utils/-/test-utils-2.4.6.tgz", - "integrity": "sha512-FMxEjOpYNYiFe0GkaHsnJPXFHxQ6m4t8vI/ElPGpMWxZKpmRvQ33OIrvRXemy6yha03RxhOlQuy+gZMC3CQSow==", + "version": "2.4.11", + "resolved": "https://registry.npmjs.org/@vue/test-utils/-/test-utils-2.4.11.tgz", + "integrity": "sha512-GDqaqZsA6m2E5vNzej0aYiIb6BX8xV9pNSbbbXKOfEYwg7ZNblVX8suyqmUBThq8VIrgAJNxn+z72hVtUeiWHA==", "license": "MIT", "dependencies": { "js-beautify": "^1.14.9", - "vue-component-type-helpers": "^2.0.0" + "vue-component-type-helpers": "^3.0.0" + }, + "peerDependencies": { + "@vue/compiler-dom": "3.x", + "@vue/server-renderer": "3.x", + "vue": "3.x" + }, + "peerDependenciesMeta": { + "@vue/server-renderer": { + "optional": true + } } }, "node_modules/@vue/typescript-plugin": { - "version": "3.2.5", - "resolved": "https://registry.npmjs.org/@vue/typescript-plugin/-/typescript-plugin-3.2.5.tgz", - "integrity": "sha512-efEFD1QEq4tQhLpsVOdPXNiJlhQU4Z4yG52ggvuXK8r+wrLLNMAlrM47lfzk7Mua7HCeVzxXL1r401JcCVVNMw==", + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/@vue/typescript-plugin/-/typescript-plugin-3.3.6.tgz", + "integrity": "sha512-3jubnULC27+N2DYw2gLWMeQMdQuS5lUjeR6yzvDh76tx35zYO2c4z+LNLenJqncAOXdhqkCRLzuBgDSkTEJCqg==", "license": "MIT", "dependencies": { "@volar/typescript": "2.4.28", - "@vue/language-core": "3.2.5", + "@vue/language-core": "3.3.6", "@vue/shared": "^3.5.0", "path-browserify": "^1.0.1", - "vue-component-meta": "3.2.5" + "vue-component-meta": "3.3.6" } }, "node_modules/@vuetify/loader-shared": { @@ -5903,9 +7493,9 @@ } }, "node_modules/acorn": { - "version": "8.16.0", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.16.0.tgz", - "integrity": "sha512-UVJyE9MttOsBQIDKw1skb9nAwQuR5wuGD3+82K6JgJlm/Y+KI92oNsMNGZCYdDsVtRHSak0pcV5Dno5+4jh9sw==", + "version": "8.17.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.17.0.tgz", + "integrity": "sha512-xRQbDb9BnwDafYNn6Vwl839DYVjqXYb1XVGtWAZ1kcDc6iwAL4hg3B1dZlRiuENFeO2H53gFG3in621AdERVAg==", "license": "MIT", "bin": { "acorn": "bin/acorn" @@ -5961,18 +7551,21 @@ } }, "node_modules/agent-base": { - "version": "7.1.4", - "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.4.tgz", - "integrity": "sha512-MnA+YT8fwfJPgBx3m60MNqakm30XOkyIoH1y6huTQvC0PwZG7ki8NacLBcrPbNoo8vEZy7Jpuk7+jMO+CUovTQ==", + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-6.0.2.tgz", + "integrity": "sha512-RZNwNclF7+MS/8bDg70amg32dyeZGZxiDuQmZxKLAlQjr3jGyLx+4Kkk58UO7D2QdgFIQCovuSuZESne6RG6XQ==", "license": "MIT", + "dependencies": { + "debug": "4" + }, "engines": { - "node": ">= 14" + "node": ">= 6.0.0" } }, "node_modules/ajv": { - "version": "6.14.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.14.0.tgz", - "integrity": "sha512-IWrosm/yrn43eiKqkfkHis7QioDleaXQHdDVPKg0FSwwd/DuvyX79TZnFOnYpB7dcsFAMmtFztZuXPDvSePkFw==", + "version": "6.15.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.15.0.tgz", + "integrity": "sha512-fgFx7Hfoq60ytK2c7DhnF8jIvzYgOMxfugjLOSMHjLIPgenqa7S7oaagATUq99mV6IYvN2tRmC0wnTYX6iPbMw==", "license": "MIT", "dependencies": { "fast-deep-equal": "^3.1.1", @@ -6003,9 +7596,9 @@ } }, "node_modules/ajv-formats/node_modules/ajv": { - "version": "8.18.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.18.0.tgz", - "integrity": "sha512-PlXPeEWMXMZ7sPYOHqmDyCJzcfNrUr3fGNKtezX14ykXOEIvyK81d+qydx89KY5O71FKMPaQ2vBfBFI5NHR63A==", + "version": "8.20.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.20.0.tgz", + "integrity": "sha512-Thbli+OlOj+iMPYFBVBfJ3OmCAnaSyNn4M1vz9T6Gka5Jt9ba/HIR56joy65tY6kx/FCF5VXNB819Y7/GUrBGA==", "license": "MIT", "dependencies": { "fast-deep-equal": "^3.1.3", @@ -6034,9 +7627,9 @@ } }, "node_modules/alien-signals": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/alien-signals/-/alien-signals-3.1.2.tgz", - "integrity": "sha512-d9dYqZTS90WLiU0I5c6DHj/HcKkF8ZyGN3G5x8wSbslulz70KOxaqCT0hQCo9KOyhVqzqGojvNdJXoTumZOtcw==", + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/alien-signals/-/alien-signals-3.2.1.tgz", + "integrity": "sha512-I8FjmltrfnDFoZedi5CG8DghVYNhzb/Ijluz7tCSJH0xpd0484Kowhbb1XDYOxfJpU1p5wnM2X54dA+IfGyD1g==", "license": "MIT" }, "node_modules/ansi-escapes": { @@ -6064,12 +7657,15 @@ } }, "node_modules/ansi-regex": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", - "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", + "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", "license": "MIT", "engines": { - "node": ">=8" + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" } }, "node_modules/ansi-styles": { @@ -6102,9 +7698,9 @@ } }, "node_modules/anymatch/node_modules/picomatch": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.2.tgz", + "integrity": "sha512-V7+vQEJ06Z+c5tSye8S+nHUfI51xoXIXjHQ99cQtKUkQqqO1kO/KCJUfZXuB47h/YBlDhah2H3hdUGXn8ie0oA==", "license": "MIT", "optional": true, "engines": { @@ -6121,12 +7717,12 @@ "license": "Python-2.0" }, "node_modules/aria-query": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.3.0.tgz", - "integrity": "sha512-b0P0sZPKtyu8HkeRAfCq0IfURZK+SuwMjY1UXGBU27wpAiTwQAIlq56IbIO+ytk/JjS1fMR14ee5WBBfKi5J6A==", + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.3.2.tgz", + "integrity": "sha512-COROpnaoap1E2F000S62r6A60uHZnmlvomhfyT2DlTcrY1OrBKn2UhH7qn5wTC9zMvD0AY7csdPSNwKP+7WiQw==", "license": "Apache-2.0", - "dependencies": { - "dequal": "^2.0.3" + "engines": { + "node": ">= 0.4" } }, "node_modules/array-back": { @@ -6264,9 +7860,9 @@ } }, "node_modules/ast-v8-to-istanbul": { - "version": "0.3.12", - "resolved": "https://registry.npmjs.org/ast-v8-to-istanbul/-/ast-v8-to-istanbul-0.3.12.tgz", - "integrity": "sha512-BRRC8VRZY2R4Z4lFIL35MwNXmwVqBityvOIwETtsCSwvjl0IdgFsy9NhdaA6j74nUdtJJlIypeRhpDam19Wq3g==", + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/ast-v8-to-istanbul/-/ast-v8-to-istanbul-1.0.4.tgz", + "integrity": "sha512-0bC0/4bTSrnwdhU3IsZDwEdojvuPrSg59OYZfKsLRtJZ0u8VBx9DebfqqG8bRdCC0I7vjgxmPi41P0lpkhJHtA==", "license": "MIT", "dependencies": { "@jridgewell/trace-mapping": "^0.3.31", @@ -6274,6 +7870,15 @@ "js-tokens": "^10.0.0" } }, + "node_modules/ast-v8-to-istanbul/node_modules/estree-walker": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", + "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + } + }, "node_modules/ast-v8-to-istanbul/node_modules/js-tokens": { "version": "10.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-10.0.0.tgz", @@ -6311,9 +7916,9 @@ } }, "node_modules/autoprefixer": { - "version": "10.4.27", - "resolved": "https://registry.npmjs.org/autoprefixer/-/autoprefixer-10.4.27.tgz", - "integrity": "sha512-NP9APE+tO+LuJGn7/9+cohklunJsXWiaWEfV3si4Gi/XHDwVNgkwr1J3RQYFIvPy76GmJ9/bW8vyoU1LcxwKHA==", + "version": "10.5.2", + "resolved": "https://registry.npmjs.org/autoprefixer/-/autoprefixer-10.5.2.tgz", + "integrity": "sha512-rD5t5DwOjJdmSORcTq64j8MawTC+tbQ+HHqjR4NDumamy/ambn1UJrlKL+KdwujWxMkFjPM3pPHOEA9tl4767Q==", "funding": [ { "type": "opencollective", @@ -6330,8 +7935,8 @@ ], "license": "MIT", "dependencies": { - "browserslist": "^4.28.1", - "caniuse-lite": "^1.0.30001774", + "browserslist": "^4.28.4", + "caniuse-lite": "^1.0.30001799", "fraction.js": "^5.3.4", "picocolors": "^1.1.1", "postcss-value-parser": "^4.2.0" @@ -6362,14 +7967,15 @@ } }, "node_modules/axios": { - "version": "1.13.6", - "resolved": "https://registry.npmjs.org/axios/-/axios-1.13.6.tgz", - "integrity": "sha512-ChTCHMouEe2kn713WHbQGcuYrr6fXTBiu460OTwWrWob16g1bXn4vtz07Ope7ewMozJAnEquLk5lWQWtBig9DQ==", + "version": "1.18.1", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.18.1.tgz", + "integrity": "sha512-3nTvFlvpn9Zu/RkHUqtc7/+al4UpRW5az71ap5zccp6e8RAYEzhMTecX8Dz1wWDYrPpUoB1HAQEGEAEvUr7S9g==", "license": "MIT", "dependencies": { - "follow-redirects": "^1.15.11", + "follow-redirects": "^1.16.0", "form-data": "^4.0.5", - "proxy-from-env": "^1.1.0" + "https-proxy-agent": "^5.0.1", + "proxy-from-env": "^2.1.0" } }, "node_modules/axios-mock-adapter": { @@ -6386,9 +7992,9 @@ } }, "node_modules/babel-loader": { - "version": "10.0.0", - "resolved": "https://registry.npmjs.org/babel-loader/-/babel-loader-10.0.0.tgz", - "integrity": "sha512-z8jt+EdS61AMw22nSfoNJAZ0vrtmhPRVi6ghL3rCeRZI8cdNYFiV5xeV3HbE7rlZZNmGH8BVccwWt8/ED0QOHA==", + "version": "10.1.1", + "resolved": "https://registry.npmjs.org/babel-loader/-/babel-loader-10.1.1.tgz", + "integrity": "sha512-JwKSzk2kjIe7mgPK+/lyZ2QAaJcpahNAdM+hgR2HI8D0OJVkdj8Rl6J3kaLYki9pwF7P2iWnD8qVv80Lq1ABtg==", "license": "MIT", "dependencies": { "find-up": "^5.0.0" @@ -6397,51 +8003,27 @@ "node": "^18.20.0 || ^20.10.0 || >=22.0.0" }, "peerDependencies": { - "@babel/core": "^7.12.0", + "@babel/core": "^7.12.0 || ^8.0.0-beta.1", + "@rspack/core": "^1.0.0 || ^2.0.0-0", "webpack": ">=5.61.0" - } - }, - "node_modules/babel-plugin-istanbul": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/babel-plugin-istanbul/-/babel-plugin-istanbul-7.0.1.tgz", - "integrity": "sha512-D8Z6Qm8jCvVXtIRkBnqNHX0zJ37rQcFJ9u8WOS6tkYOsRdHBzypCstaxWiu5ZIlqQtviRYbgnRLSoCEvjqcqbA==", - "license": "BSD-3-Clause", - "workspaces": [ - "test/babel-8" - ], - "dependencies": { - "@babel/helper-plugin-utils": "^7.0.0", - "@istanbuljs/load-nyc-config": "^1.0.0", - "@istanbuljs/schema": "^0.1.3", - "istanbul-lib-instrument": "^6.0.2", - "test-exclude": "^6.0.0" }, - "engines": { - "node": ">=12" - } - }, - "node_modules/babel-plugin-istanbul/node_modules/test-exclude": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", - "integrity": "sha512-cAGWPIyOHU6zlmg88jwm7VRyXnMN7iV68OGAbYDk/Mh/xC/pzVPlQtY6ngoIH/5/tciuhGfvESU8GrHrcxD56w==", - "license": "ISC", - "dependencies": { - "@istanbuljs/schema": "^0.1.2", - "glob": "^7.1.4", - "minimatch": "^3.0.4" - }, - "engines": { - "node": ">=8" + "peerDependenciesMeta": { + "@rspack/core": { + "optional": true + }, + "webpack": { + "optional": true + } } }, "node_modules/babel-plugin-polyfill-corejs2": { - "version": "0.4.15", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.15.tgz", - "integrity": "sha512-hR3GwrRwHUfYwGfrisXPIDP3JcYfBrW7wKE7+Au6wDYl7fm/ka1NEII6kORzxNU556JjfidZeBsO10kYvtV1aw==", + "version": "0.4.17", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.17.tgz", + "integrity": "sha512-aTyf30K/rqAsNwN76zYrdtx8obu0E4KoUME29B1xj+B3WxgvWkp943vYQ+z8Mv3lw9xHXMHpvSPOBxzAkIa94w==", "license": "MIT", "dependencies": { "@babel/compat-data": "^7.28.6", - "@babel/helper-define-polyfill-provider": "^0.6.6", + "@babel/helper-define-polyfill-provider": "^0.6.8", "semver": "^6.3.1" }, "peerDependencies": { @@ -6449,25 +8031,25 @@ } }, "node_modules/babel-plugin-polyfill-corejs3": { - "version": "0.13.0", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.13.0.tgz", - "integrity": "sha512-U+GNwMdSFgzVmfhNm8GJUX88AadB3uo9KpJqS3FaqNIPKgySuvMb+bHPsOmmuWyIcuqZj/pzt1RUIUZns4y2+A==", + "version": "0.14.2", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.14.2.tgz", + "integrity": "sha512-coWpDLJ410R781Npmn/SIBZEsAetR4xVi0SxLMXPaMO4lSf1MwnkGYMtkFxew0Dn8B3/CpbpYxN0JCgg8mn67g==", "license": "MIT", "dependencies": { - "@babel/helper-define-polyfill-provider": "^0.6.5", - "core-js-compat": "^3.43.0" + "@babel/helper-define-polyfill-provider": "^0.6.8", + "core-js-compat": "^3.48.0" }, "peerDependencies": { "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" } }, "node_modules/babel-plugin-polyfill-regenerator": { - "version": "0.6.6", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.6.6.tgz", - "integrity": "sha512-hYm+XLYRMvupxiQzrvXUj7YyvFFVfv5gI0R71AJzudg1g2AI2vyCPPIFEBjk162/wFzti3inBHo7isWFuEVS/A==", + "version": "0.6.8", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.6.8.tgz", + "integrity": "sha512-M762rNHfSF1EV3SLtnCJXFoQbbIIz0OyRwnCmV0KPC7qosSfCO0QLTSuJX3ayAebubhE6oYBAYPrBA5ljowaZg==", "license": "MIT", "dependencies": { - "@babel/helper-define-polyfill-provider": "^0.6.6" + "@babel/helper-define-polyfill-provider": "^0.6.8" }, "peerDependencies": { "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" @@ -6480,9 +8062,9 @@ "license": "MIT" }, "node_modules/baseline-browser-mapping": { - "version": "2.10.0", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.0.tgz", - "integrity": "sha512-lIyg0szRfYbiy67j9KN8IyeD7q7hcmqnJ1ddWmNt19ItGpNN64mnllmxUNFIOdOm6by97jlL6wfpTTJrmnjWAA==", + "version": "2.10.42", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.42.tgz", + "integrity": "sha512-c/jurFrDLyui7o1J86yLkRu4LMsTYcBohveus7/I2Hzdn9KIP2bdJPTue/lR1KH46enoPbD77GKeSYNdyPoD3Q==", "license": "Apache-2.0", "bin": { "baseline-browser-mapping": "dist/cli.cjs" @@ -6491,6 +8073,15 @@ "node": ">=6.0.0" } }, + "node_modules/bidi-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/bidi-js/-/bidi-js-1.0.3.tgz", + "integrity": "sha512-RKshQI1R3YQ+n9YJz2QQ147P66ELpa1FQEg20Dk8oW9t2KgLbpDLLp9aGZ7y8WHSshDknG0bknqGw5/tyCs5tw==", + "license": "MIT", + "dependencies": { + "require-from-string": "^2.0.2" + } + }, "node_modules/big.js": { "version": "5.2.2", "resolved": "https://registry.npmjs.org/big.js/-/big.js-5.2.2.tgz", @@ -6520,9 +8111,9 @@ "license": "ISC" }, "node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", + "version": "1.1.15", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.15.tgz", + "integrity": "sha512-EwOCDEex4quD37XhqM3omwtMoJjr//isUZz1JopUNWms+4Z2ViyM/k1YIRePpoVNnQhENnxtFjLaxNHrT7xIUg==", "license": "MIT", "dependencies": { "balanced-match": "^1.0.0", @@ -6542,9 +8133,9 @@ } }, "node_modules/browserslist": { - "version": "4.28.1", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.1.tgz", - "integrity": "sha512-ZC5Bd0LgJXgwGqUknZY/vkUQ04r8NXnJZ3yYi4vDmSiZmC/pdSN0NbNRPxZpbtO4uAfDUAFffO8IZoM3Gj8IkA==", + "version": "4.28.5", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.5.tgz", + "integrity": "sha512-Cu2E6QejHWzuDMTkuwgpABFgDfZrXLQq5V13YOACZx4mFAG4IwGTbTfHPMr4WtxlHoXSM8FIuRwYYCz5XiabaQ==", "funding": [ { "type": "opencollective", @@ -6561,11 +8152,11 @@ ], "license": "MIT", "dependencies": { - "baseline-browser-mapping": "^2.9.0", - "caniuse-lite": "^1.0.30001759", - "electron-to-chromium": "^1.5.263", - "node-releases": "^2.0.27", - "update-browserslist-db": "^1.2.0" + "baseline-browser-mapping": "^2.10.42", + "caniuse-lite": "^1.0.30001800", + "electron-to-chromium": "^1.5.387", + "node-releases": "^2.0.50", + "update-browserslist-db": "^1.2.3" }, "bin": { "browserslist": "cli.js" @@ -6580,24 +8171,15 @@ "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", "license": "MIT" }, - "node_modules/cac": { - "version": "6.7.14", - "resolved": "https://registry.npmjs.org/cac/-/cac-6.7.14.tgz", - "integrity": "sha512-b6Ilus+c3RrdDk+JhLKUAQfzzgLEPy6wcXqS7f/xe1EETvsDP6GORG7SFuOs6cID5YkqchW/LXZbX5bc8j7ZcQ==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, "node_modules/call-bind": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.8.tgz", - "integrity": "sha512-oKlSFMcMwpUg2ednkhQ454wfWiU/ul3CkJe/PEHcTKuiX6RpbehUiFMXu13HalGZxfUwCQzZG747YXBn1im9ww==", + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.9.tgz", + "integrity": "sha512-a/hy+pNsFUTR+Iz8TCJvXudKVLAnz/DyeSUo10I5yvFDQJBFU2s9uqQpoSrJlroHUKoKqzg+epxyP9lqFdzfBQ==", "license": "MIT", "dependencies": { - "call-bind-apply-helpers": "^1.0.0", - "es-define-property": "^1.0.0", - "get-intrinsic": "^1.2.4", + "call-bind-apply-helpers": "^1.0.2", + "es-define-property": "^1.0.1", + "get-intrinsic": "^1.3.0", "set-function-length": "^1.2.2" }, "engines": { @@ -6653,15 +8235,6 @@ "node": ">=6" } }, - "node_modules/camelcase": { - "version": "5.3.1", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", - "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", - "license": "MIT", - "engines": { - "node": ">=6" - } - }, "node_modules/caniuse-api": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/caniuse-api/-/caniuse-api-3.0.0.tgz", @@ -6675,9 +8248,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001776", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001776.tgz", - "integrity": "sha512-sg01JDPzZ9jGshqKSckOQthXnYwOEP50jeVFhaSFbZcOy05TiuuaffDOfcwtCisJ9kNQuLBFibYywv2Bgm9osw==", + "version": "1.0.30001803", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001803.tgz", + "integrity": "sha512-g/uHREV2ZpK9qMalCsWaxmA6ol+DX8GYhuf3T40RKoP+oL7vhRJh8LNt73PCjpnR6l14FzfPrB5Yux4PKm2meg==", "funding": [ { "type": "opencollective", @@ -6695,17 +8268,10 @@ "license": "CC-BY-4.0" }, "node_modules/chai": { - "version": "5.3.3", - "resolved": "https://registry.npmjs.org/chai/-/chai-5.3.3.tgz", - "integrity": "sha512-4zNhdJD/iOjSH0A05ea+Ke6MU5mmpQcbQsSOkgdaUMJ9zTlDTD/GYlwohmIE2u0gaxHYiVHEn1Fw9mZ/ktJWgw==", + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/chai/-/chai-6.2.2.tgz", + "integrity": "sha512-NUPRluOfOiTKBKvWPtSD4PhFvWCqOi0BGStNWs57X9js7XGTprSmFoz5F0tWhR4WPjNeR9jXqdC7/UpSJTnlRg==", "license": "MIT", - "dependencies": { - "assertion-error": "^2.0.1", - "check-error": "^2.1.1", - "deep-eql": "^5.0.1", - "loupe": "^3.1.0", - "pathval": "^2.0.0" - }, "engines": { "node": ">=18" } @@ -6744,53 +8310,6 @@ "node": "*" } }, - "node_modules/check-error": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/check-error/-/check-error-2.1.3.tgz", - "integrity": "sha512-PAJdDJusoxnwm1VwW07VWwUN1sl7smmC3OKggvndJFadxxDRyFJBX/ggnu/KE4kQAB7a3Dp8f/YXC1FlUprWmA==", - "license": "MIT", - "engines": { - "node": ">= 16" - } - }, - "node_modules/cheerio": { - "version": "1.0.0-rc.12", - "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.0.0-rc.12.tgz", - "integrity": "sha512-VqR8m68vM46BNnuZ5NtnGBKIE/DfN0cRIzg9n40EIq9NOv90ayxLBXA8fXC5gquFRGJSTRqBq25Jt2ECLR431Q==", - "license": "MIT", - "dependencies": { - "cheerio-select": "^2.1.0", - "dom-serializer": "^2.0.0", - "domhandler": "^5.0.3", - "domutils": "^3.0.1", - "htmlparser2": "^8.0.1", - "parse5": "^7.0.0", - "parse5-htmlparser2-tree-adapter": "^7.0.0" - }, - "engines": { - "node": ">= 6" - }, - "funding": { - "url": "https://github.com/cheeriojs/cheerio?sponsor=1" - } - }, - "node_modules/cheerio-select": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/cheerio-select/-/cheerio-select-2.1.0.tgz", - "integrity": "sha512-9v9kG0LvzrlcungtnJtpGNxY+fzECQKhK4EGJX2vByejiMX84MFNQw4UxPJl3bFbTMw+Dfs37XaIkCwTZfLh4g==", - "license": "BSD-2-Clause", - "dependencies": { - "boolbase": "^1.0.0", - "css-select": "^5.1.0", - "css-what": "^6.1.0", - "domelementtype": "^2.3.0", - "domhandler": "^5.0.3", - "domutils": "^3.0.1" - }, - "funding": { - "url": "https://github.com/sponsors/fb55" - } - }, "node_modules/chokidar": { "version": "3.6.0", "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz", @@ -6881,12 +8400,6 @@ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "license": "MIT" }, - "node_modules/colord": { - "version": "2.9.3", - "resolved": "https://registry.npmjs.org/colord/-/colord-2.9.3.tgz", - "integrity": "sha512-jeC1axXpnb0/2nn/Y1LPuLdgXBLH7aDcHu4KEKfqw3CUhX7ZpfBSlPKyqXE6btIgEzfWtrX3/tyBCaCvXvMkOw==", - "license": "MIT" - }, "node_modules/colorette": { "version": "2.0.20", "resolved": "https://registry.npmjs.org/colorette/-/colorette-2.0.20.tgz", @@ -6973,9 +8486,9 @@ "license": "MIT" }, "node_modules/core-js": { - "version": "3.48.0", - "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.48.0.tgz", - "integrity": "sha512-zpEHTy1fjTMZCKLHUZoVeylt9XrzaIN2rbPXEt0k+q7JE5CkCZdo6bNq55bn24a69CH7ErAVLKijxJja4fw+UQ==", + "version": "3.49.0", + "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.49.0.tgz", + "integrity": "sha512-es1U2+YTtzpwkxVLwAFdSpaIMyQaq0PBgm3YD1W3Qpsn1NAmO3KSgZfu+oGSWVu6NvLHoHCV/aYcsE5wiB7ALg==", "hasInstallScript": true, "license": "MIT", "funding": { @@ -6984,9 +8497,9 @@ } }, "node_modules/core-js-compat": { - "version": "3.48.0", - "resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.48.0.tgz", - "integrity": "sha512-OM4cAF3D6VtH/WkLtWvyNC56EZVXsZdU3iqaMG2B4WvYrlqU831pc4UtG5yp0sE9z8Y02wVN7PjW5Zf9Gt0f1Q==", + "version": "3.49.0", + "resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.49.0.tgz", + "integrity": "sha512-VQXt1jr9cBz03b331DFDCCP90b3fanciLkgiOoy8SBHy06gNf+vQ1A3WFLqG7I8TipYIKeYK9wxd0tUrvHcOZA==", "license": "MIT", "dependencies": { "browserslist": "^4.28.1" @@ -6997,9 +8510,9 @@ } }, "node_modules/cosmiconfig": { - "version": "9.0.1", - "resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-9.0.1.tgz", - "integrity": "sha512-hr4ihw+DBqcvrsEDioRO31Z17x71pUYoNe/4h6Z0wB72p7MU7/9gH8Q3s12NFhHPfYBBOV3qyfUxmr/Yn3shnQ==", + "version": "9.0.2", + "resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-9.0.2.tgz", + "integrity": "sha512-gtTZxTDau1wL7Y7zifc2dd8jHSK/k6BTx/2Xp/BpdlAdnlYWFVt7qhJqgwi7637yRwRQ3qL4ZidbB4I8tA5VOg==", "license": "MIT", "dependencies": { "env-paths": "^2.2.1", @@ -7023,21 +8536,20 @@ } }, "node_modules/cross-env": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/cross-env/-/cross-env-7.0.3.tgz", - "integrity": "sha512-+/HKd6EgcQCJGh2PSjZuUitQBQynKor4wrFbRg4DtAgS1aWO+gU52xpH7M9ScGgXSYmAVS9bIJ8EzuaGw0oNAw==", + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/cross-env/-/cross-env-10.1.0.tgz", + "integrity": "sha512-GsYosgnACZTADcmEyJctkJIoqAhHjttw7RsFrVoJNXbsWWqaq6Ym+7kZjq6mS45O0jij6vtiReppKQEtqWy6Dw==", "license": "MIT", "dependencies": { - "cross-spawn": "^7.0.1" + "@epic-web/invariant": "^1.0.0", + "cross-spawn": "^7.0.6" }, "bin": { - "cross-env": "src/bin/cross-env.js", - "cross-env-shell": "src/bin/cross-env-shell.js" + "cross-env": "dist/bin/cross-env.js", + "cross-env-shell": "dist/bin/cross-env-shell.js" }, "engines": { - "node": ">=10.14", - "npm": ">=6", - "yarn": ">=1" + "node": ">=20" } }, "node_modules/cross-spawn": { @@ -7098,9 +8610,9 @@ } }, "node_modules/css-declaration-sorter": { - "version": "7.3.1", - "resolved": "https://registry.npmjs.org/css-declaration-sorter/-/css-declaration-sorter-7.3.1.tgz", - "integrity": "sha512-gz6x+KkgNCjxq3Var03pRYLhyNfwhkKF1g/yoLgDNtFvVu0/fOLV9C8fFEZRjACp/XQLumjAYo7JVjzH3wLbxA==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/css-declaration-sorter/-/css-declaration-sorter-7.4.0.tgz", + "integrity": "sha512-LTuzjPoyA2vMGKKcaOqKSp7Ub2eGrNfKiZH4LpezxpNrsICGCSFvsQOI29psISxNZtaXibkC2CXzrQ5enMeGGw==", "license": "ISC", "engines": { "node": "^14 || ^16 || >=18" @@ -7172,9 +8684,9 @@ } }, "node_modules/css-loader/node_modules/semver": { - "version": "7.7.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", - "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", + "version": "7.8.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.5.tgz", + "integrity": "sha512-Y7/KDsb8LjooZpwaqGyulO6DQlksgCncchHGk+sZIY4SBvUocMBEFH5Ur1fI4dV+Jvl0w6cjvucaIi40puRioA==", "license": "ISC", "bin": { "semver": "bin/semver.js" @@ -7228,13 +8740,13 @@ "license": "MIT" }, "node_modules/css-tree": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/css-tree/-/css-tree-3.1.0.tgz", - "integrity": "sha512-0eW44TGN5SQXU1mWSkKwFstI/22X2bG1nYzZTYMAWjylYURhse752YgbE4Cx46AC+bAvI+/dYTPRk1LqSUnu6w==", + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/css-tree/-/css-tree-3.2.1.tgz", + "integrity": "sha512-X7sjQzceUhu1u7Y/ylrRZFU2FS6LRiFVp6rKLPg23y3x3c3DOKAwuXGDp+PAGjh6CSnCjYeAul8pcT8bAl+lSA==", "license": "MIT", "dependencies": { - "mdn-data": "2.12.2", - "source-map-js": "^1.0.1" + "mdn-data": "2.27.1", + "source-map-js": "^1.2.1" }, "engines": { "node": "^10 || ^12.20.0 || ^14.13.0 || >=15.0.0" @@ -7259,9 +8771,9 @@ "license": "MIT" }, "node_modules/cssdb": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/cssdb/-/cssdb-8.8.0.tgz", - "integrity": "sha512-QbLeyz2Bgso1iRlh7IpWk6OKa3lLNGXsujVjDMPl9rOZpxKeiG69icLpbLCFxeURwmcdIfZqQyhlooKJYM4f8Q==", + "version": "8.9.0", + "resolved": "https://registry.npmjs.org/cssdb/-/cssdb-8.9.0.tgz", + "integrity": "sha512-J8jOU/hLjaXcO1LldOLraJSQpfLXRKof0I7mtbRyOy2AAXgqst0x9rlgi2qXeD6d0ou3ZLqcPAMqYVbpCbrxEw==", "funding": [ { "type": "opencollective", @@ -7287,12 +8799,12 @@ } }, "node_modules/cssnano": { - "version": "7.1.2", - "resolved": "https://registry.npmjs.org/cssnano/-/cssnano-7.1.2.tgz", - "integrity": "sha512-HYOPBsNvoiFeR1eghKD5C3ASm64v9YVyJB4Ivnl2gqKoQYvjjN/G0rztvKQq8OxocUtC6sjqY8jwYngIB4AByA==", + "version": "7.1.9", + "resolved": "https://registry.npmjs.org/cssnano/-/cssnano-7.1.9.tgz", + "integrity": "sha512-uPR75+5Dk/WJ/YSPR1/YDHdwMM9c5FsaARljfKWgeCKLKOtJ0we21xy/RcCjn53fZnD/f6yYEIZ8pu18+GnbNQ==", "license": "MIT", "dependencies": { - "cssnano-preset-default": "^7.0.10", + "cssnano-preset-default": "^7.0.17", "lilconfig": "^3.1.3" }, "engines": { @@ -7303,63 +8815,63 @@ "url": "https://opencollective.com/cssnano" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/cssnano-preset-default": { - "version": "7.0.10", - "resolved": "https://registry.npmjs.org/cssnano-preset-default/-/cssnano-preset-default-7.0.10.tgz", - "integrity": "sha512-6ZBjW0Lf1K1Z+0OKUAUpEN62tSXmYChXWi2NAA0afxEVsj9a+MbcB1l5qel6BHJHmULai2fCGRthCeKSFbScpA==", + "version": "7.0.17", + "resolved": "https://registry.npmjs.org/cssnano-preset-default/-/cssnano-preset-default-7.0.17.tgz", + "integrity": "sha512-11qO63A+czwguQFJCaTdICvbaxn0pJzz/XghLlv+OT7WyToDxAMR0Xb3/26/l0y0hQJywwNbj/SLSQlGBHE1OA==", "license": "MIT", "dependencies": { - "browserslist": "^4.27.0", + "browserslist": "^4.28.2", "css-declaration-sorter": "^7.2.0", - "cssnano-utils": "^5.0.1", + "cssnano-utils": "^5.0.3", "postcss-calc": "^10.1.1", - "postcss-colormin": "^7.0.5", - "postcss-convert-values": "^7.0.8", - "postcss-discard-comments": "^7.0.5", - "postcss-discard-duplicates": "^7.0.2", - "postcss-discard-empty": "^7.0.1", - "postcss-discard-overridden": "^7.0.1", - "postcss-merge-longhand": "^7.0.5", - "postcss-merge-rules": "^7.0.7", - "postcss-minify-font-values": "^7.0.1", - "postcss-minify-gradients": "^7.0.1", - "postcss-minify-params": "^7.0.5", - "postcss-minify-selectors": "^7.0.5", - "postcss-normalize-charset": "^7.0.1", - "postcss-normalize-display-values": "^7.0.1", - "postcss-normalize-positions": "^7.0.1", - "postcss-normalize-repeat-style": "^7.0.1", - "postcss-normalize-string": "^7.0.1", - "postcss-normalize-timing-functions": "^7.0.1", - "postcss-normalize-unicode": "^7.0.5", - "postcss-normalize-url": "^7.0.1", - "postcss-normalize-whitespace": "^7.0.1", - "postcss-ordered-values": "^7.0.2", - "postcss-reduce-initial": "^7.0.5", - "postcss-reduce-transforms": "^7.0.1", - "postcss-svgo": "^7.1.0", - "postcss-unique-selectors": "^7.0.4" + "postcss-colormin": "^7.0.10", + "postcss-convert-values": "^7.0.12", + "postcss-discard-comments": "^7.0.8", + "postcss-discard-duplicates": "^7.0.4", + "postcss-discard-empty": "^7.0.3", + "postcss-discard-overridden": "^7.0.3", + "postcss-merge-longhand": "^7.0.7", + "postcss-merge-rules": "^7.0.11", + "postcss-minify-font-values": "^7.0.3", + "postcss-minify-gradients": "^7.0.5", + "postcss-minify-params": "^7.0.9", + "postcss-minify-selectors": "^7.1.2", + "postcss-normalize-charset": "^7.0.3", + "postcss-normalize-display-values": "^7.0.3", + "postcss-normalize-positions": "^7.0.4", + "postcss-normalize-repeat-style": "^7.0.4", + "postcss-normalize-string": "^7.0.3", + "postcss-normalize-timing-functions": "^7.0.3", + "postcss-normalize-unicode": "^7.0.9", + "postcss-normalize-url": "^7.0.3", + "postcss-normalize-whitespace": "^7.0.3", + "postcss-ordered-values": "^7.0.4", + "postcss-reduce-initial": "^7.0.9", + "postcss-reduce-transforms": "^7.0.3", + "postcss-svgo": "^7.1.3", + "postcss-unique-selectors": "^7.0.7" }, "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/cssnano-utils": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/cssnano-utils/-/cssnano-utils-5.0.1.tgz", - "integrity": "sha512-ZIP71eQgG9JwjVZsTPSqhc6GHgEr53uJ7tK5///VfyWj6Xp2DBmixWHqJgPno+PqATzn48pL42ww9x5SSGmhZg==", + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/cssnano-utils/-/cssnano-utils-5.0.3.tgz", + "integrity": "sha512-ynIREMICLxkxm7e9bCR9sh75s4Q5drICi0ua1yxo5jH2XPBqSKkl4dOh4EbFqtUmnTMhRffHgYL0EKKkMjtJTg==", "license": "MIT", "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/csso": { @@ -7395,42 +8907,23 @@ "integrity": "sha512-aylIc7Z9y4yzHYAJNuESG3hfhC+0Ibp/MAMiaOZgNv4pmEdFyfZhhhny4MNiAfWdBQ1RQ2mfDWmM1x8SvGyp8g==", "license": "CC0-1.0" }, - "node_modules/cssstyle": { - "version": "4.6.0", - "resolved": "https://registry.npmjs.org/cssstyle/-/cssstyle-4.6.0.tgz", - "integrity": "sha512-2z+rWdzbbSZv6/rhtvzvqeZQHrBaqgogqt85sqFNbabZOuFbCVFb8kPeEtZjiKkbrm395irpNKiYeFeLiQnFPg==", - "license": "MIT", - "dependencies": { - "@asamuzakjp/css-color": "^3.2.0", - "rrweb-cssom": "^0.8.0" - }, - "engines": { - "node": ">=18" - } - }, "node_modules/csstype": { "version": "3.2.3", "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.2.3.tgz", "integrity": "sha512-z1HGKcYy2xA8AGQfwrn0PAy+PB7X/GSj3UVJW9qKyn43xWa+gl5nXmU4qqLMRzWVLFC8KusUX8T/0kCiOYpAIQ==", "license": "MIT" }, - "node_modules/cuint": { - "version": "0.2.2", - "resolved": "https://registry.npmjs.org/cuint/-/cuint-0.2.2.tgz", - "integrity": "sha512-d4ZVpCW31eWwCMe1YT3ur7mUDnTXbgwyzaL320DrcRT45rfjYxkt5QWLrmOJ+/UEAI2+fQgKe/fCjR8l4TpRgw==", - "license": "MIT" - }, "node_modules/data-urls": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/data-urls/-/data-urls-5.0.0.tgz", - "integrity": "sha512-ZYP5VBHshaDAiVZxjbRVcFJpc+4xGgT0bK3vzy1HLN8jTO975HEbuYzZJcHoQEY5K1a0z8YayJkyVETa08eNTg==", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/data-urls/-/data-urls-7.0.0.tgz", + "integrity": "sha512-23XHcCF+coGYevirZceTVD7NdJOqVn+49IHyxgszm+JIiHLoB2TkmPtsYkNWT1pvRSGkc35L6NHs0yHkN2SumA==", "license": "MIT", "dependencies": { - "whatwg-mimetype": "^4.0.0", - "whatwg-url": "^14.0.0" + "whatwg-mimetype": "^5.0.0", + "whatwg-url": "^16.0.0" }, "engines": { - "node": ">=18" + "node": "^20.19.0 || ^22.12.0 || >=24.0.0" } }, "node_modules/data-view-buffer": { @@ -7484,10 +8977,10 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/debounce": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/debounce/-/debounce-1.2.1.tgz", - "integrity": "sha512-XRRe6Glud4rd/ZGQfiV1ruXSfbvfJedlV9Y6zOlP+2K04vBYiJEte6stfFkCP03aMnY5tsipamumUjL14fofug==", + "node_modules/dayjs": { + "version": "1.11.21", + "resolved": "https://registry.npmjs.org/dayjs/-/dayjs-1.11.21.tgz", + "integrity": "sha512-98IT+HOahAisibz/yjKbzuOBwYcjJ7BCLPzARyHiyEBmRz4fatF+KPJszEHXsGYjUG234aH/cOjW1wwTbKUZlA==", "license": "MIT" }, "node_modules/debug": { @@ -7522,15 +9015,6 @@ "integrity": "sha512-YpgQiITW3JXGntzdUmyUR1V812Hn8T1YVXhCu+wO3OpS4eU9l4YdD3qjyiKdV6mvV29zapkMeD390UVEf2lkUg==", "license": "MIT" }, - "node_modules/deep-eql": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-5.0.2.tgz", - "integrity": "sha512-h5k/5U50IJJFpzfL6nO9jaaumfjO/f2NjK/oYB2Djzm4p9L+3T9qWpZqZ2hAbLPuuYq9wrU08WQyBTL5GbPk5Q==", - "license": "MIT", - "engines": { - "node": ">=6" - } - }, "node_modules/deep-is": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", @@ -7589,21 +9073,11 @@ "node": ">=0.4.0" } }, - "node_modules/dequal": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/dequal/-/dequal-2.0.3.tgz", - "integrity": "sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==", - "license": "MIT", - "engines": { - "node": ">=6" - } - }, "node_modules/detect-libc": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-2.1.2.tgz", "integrity": "sha512-Btj2BOOO83o3WyH59e8MgXsxEQVcarkUOpEYrubB0urwnN10yQ364rsiByU11nZlqWYZm05i/of7io4mzihBtQ==", "license": "Apache-2.0", - "optional": true, "engines": { "node": ">=8" } @@ -7621,9 +9095,9 @@ } }, "node_modules/dom-accessibility-api": { - "version": "0.5.16", - "resolved": "https://registry.npmjs.org/dom-accessibility-api/-/dom-accessibility-api-0.5.16.tgz", - "integrity": "sha512-X7BJ2yElsnOJ30pZF4uIIDfBEVgF4XEBxL9Bxhy6dnrm5hkzqmsWHGTiHqRiITNhMyFLyAiWndIJP7Z1NTteDg==", + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/dom-accessibility-api/-/dom-accessibility-api-0.6.3.tgz", + "integrity": "sha512-7ZgogeTnjuHbo+ct10G9Ffp0mif17idi0IyWNVA/wcwcm7NPOD/WEHVP3n7n3MhXqxoIYm8d6MuZohYWIZ4T3w==", "license": "MIT" }, "node_modules/dom-serializer": { @@ -7707,16 +9181,10 @@ "node": ">= 0.4" } }, - "node_modules/duplexer": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/duplexer/-/duplexer-0.1.2.tgz", - "integrity": "sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg==", - "license": "MIT" - }, "node_modules/earcut": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/earcut/-/earcut-3.0.2.tgz", - "integrity": "sha512-X7hshQbLyMJ/3RPhyObLARM2sNxxmRALLKx1+NVFFnQ9gKzmCrxm9+uLIAdBcvc8FNLpctqlQ2V6AE92Ol9UDQ==", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/earcut/-/earcut-3.1.1.tgz", + "integrity": "sha512-zD5UNOQNJMiAERoZwDJsgVrngtBS7nnJwUHdVgiaqMAH5usYw4ig0p1nO1MhEfbNFNFFNPTCC5gqmdJ2yt7NvQ==", "license": "ISC" }, "node_modules/eastasianwidth": { @@ -7744,9 +9212,9 @@ } }, "node_modules/editorconfig/node_modules/brace-expansion": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", - "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.1.tgz", + "integrity": "sha512-WR1cURNjuvBLMZBMbqM0UoE+WAfdUcEV1ccD8PVBVOI+Z3ND4+SZbN8RsfT2bMuG1qwz5RFvPukSZm5fF2D5eA==", "license": "MIT", "dependencies": { "balanced-match": "^1.0.0" @@ -7777,9 +9245,9 @@ } }, "node_modules/editorconfig/node_modules/semver": { - "version": "7.7.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", - "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", + "version": "7.8.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.5.tgz", + "integrity": "sha512-Y7/KDsb8LjooZpwaqGyulO6DQlksgCncchHGk+sZIY4SBvUocMBEFH5Ur1fI4dV+Jvl0w6cjvucaIi40puRioA==", "license": "ISC", "bin": { "semver": "bin/semver.js" @@ -7804,9 +9272,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.5.307", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.307.tgz", - "integrity": "sha512-5z3uFKBWjiNR44nFcYdkcXjKMbg5KXNdciu7mhTPo9tB7NbqSNP2sSnGR+fqknZSCwKkBN+oxiiajWs4dT6ORg==", + "version": "1.5.389", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.389.tgz", + "integrity": "sha512-cEto7aeOqBfU1D+c5py5pE+ooscKE75JifxLBdFUZsqAxRS6y7kebtxAZvICszSl05gPjYHDTjY+lXpyGvpJbg==", "license": "ISC" }, "node_modules/emmet": { @@ -7841,13 +9309,13 @@ } }, "node_modules/enhanced-resolve": { - "version": "5.20.0", - "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.20.0.tgz", - "integrity": "sha512-/ce7+jQ1PQ6rVXwe+jKEg5hW5ciicHwIQUagZkp6IufBoY3YDgdTTY1azVs0qoRgVmvsNB+rbjLJxDAeHHtwsQ==", + "version": "5.24.1", + "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.24.1.tgz", + "integrity": "sha512-7DdUaTjmNwMcH2gLr1qycesKII3BK4RLy/mdAb7x10Lq7bR4aNKHt1BR1ZALSv0rPM/hF5wYF0PhGop/rJm8vw==", "license": "MIT", "dependencies": { "graceful-fs": "^4.2.4", - "tapable": "^2.3.0" + "tapable": "^2.3.3" }, "engines": { "node": ">=10.13.0" @@ -7896,9 +9364,9 @@ } }, "node_modules/es-abstract": { - "version": "1.24.1", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.24.1.tgz", - "integrity": "sha512-zHXBLhP+QehSSbsS9Pt23Gg964240DPd6QCf8WpkqEXxQ7fhdZzYsocOr5u7apWonsS5EjZDmTF+/slGMyasvw==", + "version": "1.24.2", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.24.2.tgz", + "integrity": "sha512-2FpH9Q5i2RRwyEP1AylXe6nYLR5OhaJTZwmlcP0dL/+JCbgg7yyEo/sEK6HeGZRf3dFpWwThaRHVApXSkW3xeg==", "license": "MIT", "dependencies": { "array-buffer-byte-length": "^1.0.2", @@ -7963,6 +9431,24 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/es-abstract-get": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-abstract-get/-/es-abstract-get-1.0.0.tgz", + "integrity": "sha512-6PMWXpdhshVvFp+FoWYs1EvG1Nj0tvk0dZM+XcK0xMEM1czRVcP6ohqPWHy6qPagSpC8j4+p89WXlT+xXJs/fg==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "es-object-atoms": "^1.1.2", + "is-callable": "^1.2.7", + "object-inspect": "^1.13.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/es-define-property": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", @@ -7982,15 +9468,15 @@ } }, "node_modules/es-module-lexer": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.7.0.tgz", - "integrity": "sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA==", + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-2.2.0.tgz", + "integrity": "sha512-3lGxdTXCLfe1MYfTz1y2ksAAUM4NAOP6rPEjxGJVKO7TZ5+tvHCaQWGpC4Y3IXvW3ece0Cz1cIP4FWBxOnGCTQ==", "license": "MIT" }, "node_modules/es-object-atoms": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", - "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.2.tgz", + "integrity": "sha512-HWcBoN6NileqtSydK2FqHbS/LoDd2pqrnQHLyJzBj4kOp/ky2MWMN694xOfkK8/SnUsW2DH7EfyVlydKCsm1Zw==", "license": "MIT", "dependencies": { "es-errors": "^1.3.0" @@ -8027,14 +9513,17 @@ } }, "node_modules/es-to-primitive": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.3.0.tgz", - "integrity": "sha512-w+5mJ3GuFL+NjVtJlvydShqE1eN3h3PbI7/5LAsYJP/2qtuMXjfL2LpHSRqo4b4eSF5K/DH1JXKUAHSB2UW50g==", + "version": "1.3.4", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.3.4.tgz", + "integrity": "sha512-yPDz7wqpg1/mmHLmS3tcfTfbw5f1eryXvyghYBffGdERwe+mV7ZcWzTR8LR17Kvqt3qfPurjlonmnq3MKXIOXw==", "license": "MIT", "dependencies": { + "es-abstract-get": "^1.0.0", + "es-define-property": "^1.0.1", + "es-errors": "^1.3.0", "is-callable": "^1.2.7", - "is-date-object": "^1.0.5", - "is-symbol": "^1.0.4" + "is-date-object": "^1.1.0", + "is-symbol": "^1.1.1" }, "engines": { "node": ">= 0.4" @@ -8043,47 +9532,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/esbuild": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.27.3.tgz", - "integrity": "sha512-8VwMnyGCONIs6cWue2IdpHxHnAjzxnw2Zr7MkVxB2vjmQ2ivqGFb4LEG3SMnv0Gb2F/G/2yA8zUaiL1gywDCCg==", - "hasInstallScript": true, - "license": "MIT", - "bin": { - "esbuild": "bin/esbuild" - }, - "engines": { - "node": ">=18" - }, - "optionalDependencies": { - "@esbuild/aix-ppc64": "0.27.3", - "@esbuild/android-arm": "0.27.3", - "@esbuild/android-arm64": "0.27.3", - "@esbuild/android-x64": "0.27.3", - "@esbuild/darwin-arm64": "0.27.3", - "@esbuild/darwin-x64": "0.27.3", - "@esbuild/freebsd-arm64": "0.27.3", - "@esbuild/freebsd-x64": "0.27.3", - "@esbuild/linux-arm": "0.27.3", - "@esbuild/linux-arm64": "0.27.3", - "@esbuild/linux-ia32": "0.27.3", - "@esbuild/linux-loong64": "0.27.3", - "@esbuild/linux-mips64el": "0.27.3", - "@esbuild/linux-ppc64": "0.27.3", - "@esbuild/linux-riscv64": "0.27.3", - "@esbuild/linux-s390x": "0.27.3", - "@esbuild/linux-x64": "0.27.3", - "@esbuild/netbsd-arm64": "0.27.3", - "@esbuild/netbsd-x64": "0.27.3", - "@esbuild/openbsd-arm64": "0.27.3", - "@esbuild/openbsd-x64": "0.27.3", - "@esbuild/openharmony-arm64": "0.27.3", - "@esbuild/sunos-x64": "0.27.3", - "@esbuild/win32-arm64": "0.27.3", - "@esbuild/win32-ia32": "0.27.3", - "@esbuild/win32-x64": "0.27.3" - } - }, "node_modules/escalade": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", @@ -8106,24 +9554,24 @@ } }, "node_modules/eslint": { - "version": "9.39.3", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.39.3.tgz", - "integrity": "sha512-VmQ+sifHUbI/IcSopBCF/HO3YiHQx/AVd3UVyYL6weuwW+HvON9VYn5l6Zl1WZzPWXPNZrSQpxwkkZ/VuvJZzg==", + "version": "9.39.4", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.39.4.tgz", + "integrity": "sha512-XoMjdBOwe/esVgEvLmNsD3IRHkm7fbKIUGvrleloJXUZgDHig2IPWNniv+GwjyJXzuNqVjlr5+4yVUZjycJwfQ==", "license": "MIT", "dependencies": { "@eslint-community/eslint-utils": "^4.8.0", "@eslint-community/regexpp": "^4.12.1", - "@eslint/config-array": "^0.21.1", + "@eslint/config-array": "^0.21.2", "@eslint/config-helpers": "^0.4.2", "@eslint/core": "^0.17.0", - "@eslint/eslintrc": "^3.3.1", - "@eslint/js": "9.39.3", + "@eslint/eslintrc": "^3.3.5", + "@eslint/js": "9.39.4", "@eslint/plugin-kit": "^0.4.1", "@humanfs/node": "^0.16.6", "@humanwhocodes/module-importer": "^1.0.1", "@humanwhocodes/retry": "^0.4.2", "@types/estree": "^1.0.6", - "ajv": "^6.12.4", + "ajv": "^6.14.0", "chalk": "^4.0.0", "cross-spawn": "^7.0.6", "debug": "^4.3.2", @@ -8142,7 +9590,7 @@ "is-glob": "^4.0.0", "json-stable-stringify-without-jsonify": "^1.0.1", "lodash.merge": "^4.6.2", - "minimatch": "^3.1.2", + "minimatch": "^3.1.5", "natural-compare": "^1.4.0", "optionator": "^0.9.3" }, @@ -8214,14 +9662,14 @@ } }, "node_modules/eslint-import-resolver-node": { - "version": "0.3.9", - "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.9.tgz", - "integrity": "sha512-WFj2isz22JahUv+B788TlO3N6zL3nNJGU8CcZbPZvVEkBPaJdCV4vy5wyghty5ROFbCRnm132v8BScu5/1BQ8g==", + "version": "0.3.10", + "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.10.tgz", + "integrity": "sha512-tRrKqFyCaKict5hOd244sL6EQFNycnMQnBe+j8uqGNXYzsImGbGUU4ibtoaBmv5FLwJwcFJNeg1GeVjQfbMrDQ==", "license": "MIT", "dependencies": { "debug": "^3.2.7", - "is-core-module": "^2.13.0", - "resolve": "^1.22.4" + "is-core-module": "^2.16.1", + "resolve": "^2.0.0-next.6" } }, "node_modules/eslint-import-resolver-node/node_modules/debug": { @@ -8233,10 +9681,33 @@ "ms": "^2.1.1" } }, + "node_modules/eslint-import-resolver-node/node_modules/resolve": { + "version": "2.0.0-next.7", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-2.0.0-next.7.tgz", + "integrity": "sha512-tqt+NBWwyaMgw3zDsnygx4CByWjQEJHOPMdslYhppaQSJUtL/D4JO9CcBBlhPoI8lz9oJIDXkwXfhF4aWqP8xQ==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "is-core-module": "^2.16.2", + "node-exports-info": "^1.6.0", + "object-keys": "^1.1.1", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/eslint-module-utils": { - "version": "2.12.1", - "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.12.1.tgz", - "integrity": "sha512-L8jSWTze7K2mTg0vos/RuLRS5soomksDPoJLXIslC7c8Wmut3bx7CPpJijDcBZtxQ5lrbUdM+s0OlNbz0DCDNw==", + "version": "2.13.0", + "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.13.0.tgz", + "integrity": "sha512-bLohSkT6469rRs8czj0tLTD8vaeIS/whvPRJVjDr7IuoTT1k5DYDERlNycjDj/HkOlvQdYurmfZ/g3fG5bgeLQ==", "license": "MIT", "dependencies": { "debug": "^3.2.7" @@ -8290,25 +9761,6 @@ "node": ">=16.0.0" } }, - "node_modules/eslint-plugin-html/node_modules/htmlparser2": { - "version": "10.1.0", - "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-10.1.0.tgz", - "integrity": "sha512-VTZkM9GWRAtEpveh7MSF6SjjrpNVNNVJfFup7xTY3UpFtm67foy9HDVXneLtFVt4pMz5kZtgNcvCniNFb1hlEQ==", - "funding": [ - "https://github.com/fb55/htmlparser2?sponsor=1", - { - "type": "github", - "url": "https://github.com/sponsors/fb55" - } - ], - "license": "MIT", - "dependencies": { - "domelementtype": "^2.3.0", - "domhandler": "^5.0.3", - "domutils": "^3.2.2", - "entities": "^7.0.1" - } - }, "node_modules/eslint-plugin-import": { "version": "2.32.0", "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.32.0.tgz", @@ -8371,40 +9823,10 @@ "eslint": ">=5.16.0" } }, - "node_modules/eslint-plugin-prettier": { - "version": "5.5.5", - "resolved": "https://registry.npmjs.org/eslint-plugin-prettier/-/eslint-plugin-prettier-5.5.5.tgz", - "integrity": "sha512-hscXkbqUZ2sPithAuLm5MXL+Wph+U7wHngPBv9OMWwlP8iaflyxpjTYZkmdgB4/vPIhemRlBEoLrH7UC1n7aUw==", - "license": "MIT", - "dependencies": { - "prettier-linter-helpers": "^1.0.1", - "synckit": "^0.11.12" - }, - "engines": { - "node": "^14.18.0 || >=16.0.0" - }, - "funding": { - "url": "https://opencollective.com/eslint-plugin-prettier" - }, - "peerDependencies": { - "@types/eslint": ">=8.0.0", - "eslint": ">=8.0.0", - "eslint-config-prettier": ">= 7.0.0 <10.0.0 || >=10.1.0", - "prettier": ">=3.0.0" - }, - "peerDependenciesMeta": { - "@types/eslint": { - "optional": true - }, - "eslint-config-prettier": { - "optional": true - } - } - }, "node_modules/eslint-plugin-vue": { - "version": "10.8.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-vue/-/eslint-plugin-vue-10.8.0.tgz", - "integrity": "sha512-f1J/tcbnrpgC8suPN5AtdJ5MQjuXbSU9pGRSSYAuF3SHoiYCOdEX6O22pLaRyLHXvDcOe+O5ENgc1owQ587agA==", + "version": "10.9.2", + "resolved": "https://registry.npmjs.org/eslint-plugin-vue/-/eslint-plugin-vue-10.9.2.tgz", + "integrity": "sha512-4g7ZP3pYcuqd7Zp0pzUKcos0W+RkjBz4EGdhJ92FcYk6v03Ti/GK5NwjgsjxHK+98eXDbHeK7VtX1az7/8doZA==", "license": "MIT", "dependencies": { "@eslint-community/eslint-utils": "^4.4.0", @@ -8421,7 +9843,7 @@ "@stylistic/eslint-plugin": "^2.0.0 || ^3.0.0 || ^4.0.0 || ^5.0.0", "@typescript-eslint/parser": "^7.0.0 || ^8.0.0", "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", - "vue-eslint-parser": "^10.0.0" + "vue-eslint-parser": "^10.3.0" }, "peerDependenciesMeta": { "@stylistic/eslint-plugin": { @@ -8433,9 +9855,9 @@ } }, "node_modules/eslint-plugin-vue/node_modules/semver": { - "version": "7.7.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", - "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", + "version": "7.8.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.5.tgz", + "integrity": "sha512-Y7/KDsb8LjooZpwaqGyulO6DQlksgCncchHGk+sZIY4SBvUocMBEFH5Ur1fI4dV+Jvl0w6cjvucaIi40puRioA==", "license": "ISC", "bin": { "semver": "bin/semver.js" @@ -8445,17 +9867,17 @@ } }, "node_modules/eslint-plugin-vuetify": { - "version": "2.5.3", - "resolved": "https://registry.npmjs.org/eslint-plugin-vuetify/-/eslint-plugin-vuetify-2.5.3.tgz", - "integrity": "sha512-HQQ3HSeg4lOQp+bImVuGsIQBgRexMGudZBZ8iK7ypQsNkKlVu2JSDDslOoTUGTj+QY/SE5PtXOwz0lMITuv8Rg==", + "version": "2.7.2", + "resolved": "https://registry.npmjs.org/eslint-plugin-vuetify/-/eslint-plugin-vuetify-2.7.2.tgz", + "integrity": "sha512-c8uKnb4DFJFBaqGTKT9Yv6SDhe+cVAQpRpey7nRlpXgXfHpMEe8u6yg5DEhn+Diam0bY05nEe3+T/t/d+cEinQ==", "license": "MIT", "dependencies": { - "eslint-plugin-vue": ">=9.6.0", + "eslint-plugin-vue": "^10.8.0", "requireindex": "^1.2.0" }, "peerDependencies": { - "eslint": "^8.0.0 || ^9.0.0", - "vuetify": "^3.0.0" + "eslint": "^8.0.0 || ^9.0.0 || ^10.0.0", + "vuetify": "^3.0.0 || ^4.0.0" } }, "node_modules/eslint-rule-docs": { @@ -8580,19 +10002,6 @@ "url": "https://opencollective.com/eslint" } }, - "node_modules/esprima": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", - "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", - "license": "BSD-2-Clause", - "bin": { - "esparse": "bin/esparse.js", - "esvalidate": "bin/esvalidate.js" - }, - "engines": { - "node": ">=4" - } - }, "node_modules/esquery": { "version": "1.7.0", "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.7.0.tgz", @@ -8627,13 +10036,10 @@ } }, "node_modules/estree-walker": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", - "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0" - } + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.2.tgz", + "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==", + "license": "MIT" }, "node_modules/esutils": { "version": "2.0.3", @@ -8644,6 +10050,18 @@ "node": ">=0.10.0" } }, + "node_modules/eta": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/eta/-/eta-4.6.0.tgz", + "integrity": "sha512-lW6is4T1NFOYnmqGZIfvixqj7A7sSvScF+DN8EK6K58xI5MZ5UvYe0GjopxOXQtZvUn4eDdVuZ8XSoYWTMEKwA==", + "license": "MIT", + "engines": { + "node": ">=20" + }, + "funding": { + "url": "https://github.com/bgub/eta?sponsor=1" + } + }, "node_modules/events": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz", @@ -8660,9 +10078,9 @@ "license": "MIT" }, "node_modules/expect-type": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.3.0.tgz", - "integrity": "sha512-knvyeauYhqjOYvQ66MznSMs83wmHrCycNEN6Ao+2AeYEfxUIkuiVxdEa1qlGEPK+We3n0THiDciYSsCcgW/DoA==", + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.4.0.tgz", + "integrity": "sha512-KfYbmpRm0VbLjEvVa9yGwCi9GI34xvi7A/HXYWQO65CSD2u3MczUJSuwXKFIxlGsgBQizV9q5J9NHj4VG0n+pA==", "license": "Apache-2.0", "engines": { "node": ">=12.0.0" @@ -8674,12 +10092,6 @@ "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", "license": "MIT" }, - "node_modules/fast-diff": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/fast-diff/-/fast-diff-1.3.0.tgz", - "integrity": "sha512-VxPP4NqbUjj6MaAOafWeUn2cXWLcCtljklUtZf0Ind4XQ+QPtmA0b18zZy0jIQx+ExRVCR/ZQpBmik5lXshNsw==", - "license": "Apache-2.0" - }, "node_modules/fast-json-stable-stringify": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", @@ -8693,9 +10105,9 @@ "license": "MIT" }, "node_modules/fast-uri": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.0.tgz", - "integrity": "sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA==", + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.3.tgz", + "integrity": "sha512-i70LwGWUduXqzicKXWshooq+sWL1K3WUU5rKZNG/0i3a1OSoX3HqhH5WbWwTmqWfor4urUakGPiRQcleRZTwOg==", "funding": [ { "type": "github", @@ -8734,12 +10146,6 @@ } } }, - "node_modules/fflate": { - "version": "0.8.2", - "resolved": "https://registry.npmjs.org/fflate/-/fflate-0.8.2.tgz", - "integrity": "sha512-cPJU47OaAoCbg0pBvzsgpTPhmhqI5eJjh/JIu8tPj5q+T7iLvW/JAYUqmE7KOB4R1ZyEhzBaIQpQpardBF5z8A==", - "license": "MIT" - }, "node_modules/file-entry-cache": { "version": "8.0.0", "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-8.0.0.tgz", @@ -8806,9 +10212,9 @@ } }, "node_modules/filelist/node_modules/brace-expansion": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", - "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.1.tgz", + "integrity": "sha512-WR1cURNjuvBLMZBMbqM0UoE+WAfdUcEV1ccD8PVBVOI+Z3ND4+SZbN8RsfT2bMuG1qwz5RFvPukSZm5fF2D5eA==", "license": "MIT", "dependencies": { "balanced-match": "^1.0.0" @@ -8903,34 +10309,15 @@ } }, "node_modules/flatted": { - "version": "3.3.4", - "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.3.4.tgz", - "integrity": "sha512-3+mMldrTAPdta5kjX2G2J7iX4zxtnwpdA8Tr2ZSjkyPSanvbZAcy6flmtnXbEybHrDcU9641lxrMfFuUxVz9vA==", + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.4.2.tgz", + "integrity": "sha512-PjDse7RzhcPkIJwy5t7KPWQSZ9cAbzQXcafsetQoD7sOJRQlGikNbx7yZp2OotDnJyrDcbyRq3Ttb18iYOqkxA==", "license": "ISC" }, - "node_modules/floating-vue": { - "version": "5.2.2", - "resolved": "https://registry.npmjs.org/floating-vue/-/floating-vue-5.2.2.tgz", - "integrity": "sha512-afW+h2CFafo+7Y9Lvw/xsqjaQlKLdJV7h1fCHfcYQ1C4SVMlu7OAekqWgu5d4SgvkBVU0pVpLlVsrSTBURFRkg==", - "license": "MIT", - "dependencies": { - "@floating-ui/dom": "~1.1.1", - "vue-resize": "^2.0.0-alpha.1" - }, - "peerDependencies": { - "@nuxt/kit": "^3.2.0", - "vue": "^3.2.0" - }, - "peerDependenciesMeta": { - "@nuxt/kit": { - "optional": true - } - } - }, "node_modules/follow-redirects": { - "version": "1.15.11", - "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.11.tgz", - "integrity": "sha512-deG2P0JfjrTxl50XGCDyfI97ZGVCxIpfKYmfyrQ54n5FO/0gfIES8C/Psl6kWVDolizcaaxZJnTS0QSMxvnsBQ==", + "version": "1.16.0", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.16.0.tgz", + "integrity": "sha512-y5rN/uOsadFT/JfYwhxRS5R7Qce+g3zG97+JrtFZlC9klX/W5hD7iiLzScI4nZqUS7DNUdhPgw4xI8W2LuXlUw==", "funding": [ { "type": "individual", @@ -8979,16 +10366,16 @@ } }, "node_modules/form-data": { - "version": "4.0.5", - "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.5.tgz", - "integrity": "sha512-8RipRLol37bNs2bhoV67fiTEvdTrbMUYcFTiy3+wuuOnUog2QBHCZWXDRijWQfAkhBj2Uf5UnVaiWwA5vdd82w==", + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.6.tgz", + "integrity": "sha512-vKatAh4SlVfgbv+YtmhiRjhEMJsYpsG1Y2rMQtR+SVSbytsSD1YGzDIcrAJmdFec88u/+VoGmxnl+80gL1tRCQ==", "license": "MIT", "dependencies": { "asynckit": "^0.4.0", "combined-stream": "^1.0.8", "es-set-tostringtag": "^2.1.0", - "hasown": "^2.0.2", - "mime-types": "^2.1.12" + "hasown": "^2.0.4", + "mime-types": "^2.1.35" }, "engines": { "node": ">= 6" @@ -9058,17 +10445,20 @@ } }, "node_modules/function.prototype.name": { - "version": "1.1.8", - "resolved": "https://registry.npmjs.org/function.prototype.name/-/function.prototype.name-1.1.8.tgz", - "integrity": "sha512-e5iwyodOHhbMr/yNrc7fDYG4qlbIvI5gajyzPnb5TCwyhjApznQh1BMFou9b30SevY43gCJKXycoCBjMbsuW0Q==", + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/function.prototype.name/-/function.prototype.name-1.2.0.tgz", + "integrity": "sha512-jObKIik1P2QjPHP5nz5BaOtUlfgS0fWo8IUByNXkM+o+02sJOi94em77GwJKQSJ3gfPHdgzLNrHc1uokV4P/ew==", "license": "MIT", "dependencies": { - "call-bind": "^1.0.8", - "call-bound": "^1.0.3", - "define-properties": "^1.2.1", + "call-bind": "^1.0.9", + "call-bound": "^1.0.4", + "es-define-property": "^1.0.1", + "es-errors": "^1.3.0", "functions-have-names": "^1.2.3", - "hasown": "^2.0.2", - "is-callable": "^1.2.7" + "has-property-descriptors": "^1.0.2", + "hasown": "^2.0.4", + "is-callable": "^1.2.7", + "is-document.all": "^1.0.0" }, "engines": { "node": ">= 0.4" @@ -9105,9 +10495,9 @@ } }, "node_modules/get-east-asian-width": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/get-east-asian-width/-/get-east-asian-width-1.5.0.tgz", - "integrity": "sha512-CQ+bEO+Tva/qlmw24dCejulK5pMzVnUOFOijVogd3KQs07HnRIgp8TGipvCCRT06xeYEbpbgwaCxglFyiuIcmA==", + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/get-east-asian-width/-/get-east-asian-width-1.6.0.tgz", + "integrity": "sha512-QRbvDIbx6YklUe6RxeTeleMR0yv3cYH6PsPZHcnVn7xv7zO1BHN8r0XETu8n6Ye3Q+ahtSarc3WgtNWmehIBfA==", "license": "MIT", "engines": { "node": ">=18" @@ -9146,15 +10536,6 @@ "integrity": "sha512-I0UBV/XOz1XkIJHEUDMZAbzCThU/H8DxmSfmdGcKPnVhu2VfFqr34jr9777IyaTYvxjedWhqVIilEDsCdP5G6g==", "license": "ISC" }, - "node_modules/get-package-type": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/get-package-type/-/get-package-type-0.1.0.tgz", - "integrity": "sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q==", - "license": "MIT", - "engines": { - "node": ">=8.0.0" - } - }, "node_modules/get-proto": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", @@ -9168,18 +10549,6 @@ "node": ">= 0.4" } }, - "node_modules/get-stream": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", - "integrity": "sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==", - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/get-symbol-description": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.1.0.tgz", @@ -9226,6 +10595,19 @@ "resolved": "https://registry.npmjs.org/pofile/-/pofile-1.0.11.tgz", "integrity": "sha512-Vy9eH1dRD9wHjYt/QqXcTz+RnX/zg53xK+KljFSX30PvdDMb2z+c6uDUeblUGqqJgz3QFsdlA0IJvHziPmWtQg==" }, + "node_modules/gettext-extractor/node_modules/typescript": { + "version": "5.9.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", + "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, "node_modules/gl-matrix": { "version": "3.4.4", "resolved": "https://registry.npmjs.org/gl-matrix/-/gl-matrix-3.4.4.tgz", @@ -9273,9 +10655,9 @@ "license": "BSD-2-Clause" }, "node_modules/globals": { - "version": "16.5.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-16.5.0.tgz", - "integrity": "sha512-c/c15i26VrJ4IRt5Z89DnIzCGDn9EcebibhAOjw5ibqEHsE1wLUgkPn9RDmNcUKyU87GeaL633nyJ+pplFR2ZQ==", + "version": "17.7.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-17.7.0.tgz", + "integrity": "sha512-Czmyns5dUsq4seFBR/Kdydhmo8y9kC79hiSkPn0YcGtNnYWnrgt0vjrSjx9tspoDGWm2CMarffRuLjM4xUz8xg==", "license": "MIT", "engines": { "node": ">=18" @@ -9300,12 +10682,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/globrex": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/globrex/-/globrex-0.1.2.tgz", - "integrity": "sha512-uHJgbwAMwNFf5mLst7IWLNg14x1CkeqglJb/K3doi4dw6q2IvAAmM/Y81kevy83wP+Sst+nutFTYOGg3d1lsxg==", - "license": "MIT" - }, "node_modules/gopd": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", @@ -9324,21 +10700,6 @@ "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", "license": "ISC" }, - "node_modules/gzip-size": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/gzip-size/-/gzip-size-6.0.0.tgz", - "integrity": "sha512-ax7ZYomf6jqPTQ4+XCpUGyXKHk5WweS+e05MBO4/y3WJ5RkmPXNKvX+bx1behVILVwr6JSQvZAku021CHPXG3Q==", - "license": "MIT", - "dependencies": { - "duplexer": "^0.1.2" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/has-bigints": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.1.0.tgz", @@ -9421,9 +10782,9 @@ "license": "MIT" }, "node_modules/hasown": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", - "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.4.tgz", + "integrity": "sha512-T2UbfbBEF32wiepXIsMlTW9+dDYC6wMh/t/vYA4tuOMKqWz/n3vr1NFSxQiyP+zk2mXsoMA/i/7qV6LKut1t1A==", "license": "MIT", "dependencies": { "function-bind": "^1.1.2" @@ -9433,21 +10794,21 @@ } }, "node_modules/hls.js": { - "version": "1.6.15", - "resolved": "https://registry.npmjs.org/hls.js/-/hls.js-1.6.15.tgz", - "integrity": "sha512-E3a5VwgXimGHwpRGV+WxRTKeSp2DW5DI5MWv34ulL3t5UNmyJWCQ1KmLEHbYzcfThfXG8amBL+fCYPneGHC4VA==", + "version": "1.6.16", + "resolved": "https://registry.npmjs.org/hls.js/-/hls.js-1.6.16.tgz", + "integrity": "sha512-VSIRpLfRwlAAdGL4wiTucx2ScRipo0ed1FBatWkyt832jC4CReKstga6yIhYVwGu9LOBjuX9wzmRMeQdBJtzEA==", "license": "Apache-2.0" }, "node_modules/html-encoding-sniffer": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/html-encoding-sniffer/-/html-encoding-sniffer-4.0.0.tgz", - "integrity": "sha512-Y22oTqIU4uuPgEemfz7NDJz6OeKf12Lsu+QC+s3BVpda64lTiMYCyGwg5ki4vFxkMwQdeZDl2adZoqUgdFuTgQ==", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/html-encoding-sniffer/-/html-encoding-sniffer-6.0.0.tgz", + "integrity": "sha512-CV9TW3Y3f8/wT0BRFc1/KAVQ3TUHiXmaAb6VW9vtiMFf7SLoMd1PdAc4W3KFOFETBJUb90KatHqlsZMWV+R9Gg==", "license": "MIT", "dependencies": { - "whatwg-encoding": "^3.1.1" + "@exodus/bytes": "^1.6.0" }, "engines": { - "node": ">=18" + "node": "^20.19.0 || ^22.12.0 || >=24.0.0" } }, "node_modules/html-entities": { @@ -9473,9 +10834,9 @@ "license": "MIT" }, "node_modules/htmlparser2": { - "version": "8.0.2", - "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-8.0.2.tgz", - "integrity": "sha512-GYdjWKDkbRLkZ5geuHs5NY1puJ+PXwP7+fHPRz06Eirsb9ugf6d8kkXav6ADhcODhFFPMIXyxkxSuMf3D6NCFA==", + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-10.1.0.tgz", + "integrity": "sha512-VTZkM9GWRAtEpveh7MSF6SjjrpNVNNVJfFup7xTY3UpFtm67foy9HDVXneLtFVt4pMz5kZtgNcvCniNFb1hlEQ==", "funding": [ "https://github.com/fb55/htmlparser2?sponsor=1", { @@ -9487,46 +10848,21 @@ "dependencies": { "domelementtype": "^2.3.0", "domhandler": "^5.0.3", - "domutils": "^3.0.1", - "entities": "^4.4.0" - } - }, - "node_modules/htmlparser2/node_modules/entities": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", - "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", - "license": "BSD-2-Clause", - "engines": { - "node": ">=0.12" - }, - "funding": { - "url": "https://github.com/fb55/entities?sponsor=1" - } - }, - "node_modules/http-proxy-agent": { - "version": "7.0.2", - "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-7.0.2.tgz", - "integrity": "sha512-T1gkAiYYDWYx3V5Bmyu7HcfcvL7mUrTWiM6yOfa3PIphViJ/gFPbvidQ+veqSOHci/PxBcDabeUNCzpOODJZig==", - "license": "MIT", - "dependencies": { - "agent-base": "^7.1.0", - "debug": "^4.3.4" - }, - "engines": { - "node": ">= 14" + "domutils": "^3.2.2", + "entities": "^7.0.1" } }, "node_modules/https-proxy-agent": { - "version": "7.0.6", - "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz", - "integrity": "sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw==", + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-5.0.1.tgz", + "integrity": "sha512-dFcAjpTQFgoLMzC2VwU+C/CbS7uRL0lWmxDITmqm7C+7F0Odmj6s9l6alZc6AELXhrnggM2CeWSXHGOdX2YtwA==", "license": "MIT", "dependencies": { - "agent-base": "^7.1.2", + "agent-base": "6", "debug": "4" }, "engines": { - "node": ">= 14" + "node": ">= 6" } }, "node_modules/i": { @@ -9537,18 +10873,6 @@ "node": ">=0.4" } }, - "node_modules/iconv-lite": { - "version": "0.6.3", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", - "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", - "license": "MIT", - "dependencies": { - "safer-buffer": ">= 2.1.2 < 3.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/icss-utils": { "version": "5.1.0", "resolved": "https://registry.npmjs.org/icss-utils/-/icss-utils-5.1.0.tgz", @@ -9577,9 +10901,9 @@ } }, "node_modules/immutable": { - "version": "5.1.4", - "resolved": "https://registry.npmjs.org/immutable/-/immutable-5.1.4.tgz", - "integrity": "sha512-p6u1bG3YSnINT5RQmx/yRZBpenIl30kVxkTLDyHLIMk0gict704Q9n+thfDI7lTRm9vXdDYutVzXhzcThxTnXA==", + "version": "5.1.9", + "resolved": "https://registry.npmjs.org/immutable/-/immutable-5.1.9.tgz", + "integrity": "sha512-m8nVez3rwrgmWxtLMt1ZYXB2Lv7OKYn/disyxAlSDYAlKSlFoPPfIAmAM/M5xqL4m4C/wAPw7S2/CNaUii1Hxg==", "license": "MIT" }, "node_modules/import-fresh": { @@ -9598,15 +10922,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/import-fresh/node_modules/resolve-from": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", - "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", - "license": "MIT", - "engines": { - "node": ">=4" - } - }, "node_modules/import-local": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/import-local/-/import-local-3.2.0.tgz", @@ -9901,12 +11216,12 @@ } }, "node_modules/is-core-module": { - "version": "2.16.1", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.16.1.tgz", - "integrity": "sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w==", + "version": "2.16.2", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.16.2.tgz", + "integrity": "sha512-evOr8xfXKxE6qSR0hSXL2r3sd7ALj8+7jQEUvPYcm5sgZFdJ+AYzT6yNmJenvIYQBgIGwfwz08sL8zoL7yq2BA==", "license": "MIT", "dependencies": { - "hasown": "^2.0.2" + "hasown": "^2.0.3" }, "engines": { "node": ">= 0.4" @@ -9948,6 +11263,21 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/is-document.all": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-document.all/-/is-document.all-1.0.0.tgz", + "integrity": "sha512-+XSoyS05OdBbhFuELhgTCpFNHkpBOJqtsZfUFFpe5QTw+9Sjbh8zitxhQkYAo6wV7e1Vb8cAPvpCk9jGam/82g==", + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-expression": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/is-expression/-/is-expression-4.0.0.tgz", @@ -10315,34 +11645,6 @@ "node": ">=8" } }, - "node_modules/istanbul-lib-instrument": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/istanbul-lib-instrument/-/istanbul-lib-instrument-6.0.3.tgz", - "integrity": "sha512-Vtgk7L/R2JHyyGW07spoFlB8/lpjiOLTjMdms6AFMraYt3BaJauod/NGrfnVG/y4Ix1JEuMRPDPEj2ua+zz1/Q==", - "license": "BSD-3-Clause", - "dependencies": { - "@babel/core": "^7.23.9", - "@babel/parser": "^7.23.9", - "@istanbuljs/schema": "^0.1.3", - "istanbul-lib-coverage": "^3.2.0", - "semver": "^7.5.4" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/istanbul-lib-instrument/node_modules/semver": { - "version": "7.7.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", - "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/istanbul-lib-report": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/istanbul-lib-report/-/istanbul-lib-report-3.0.1.tgz", @@ -10373,9 +11675,9 @@ } }, "node_modules/istanbul-lib-report/node_modules/semver": { - "version": "7.7.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", - "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", + "version": "7.8.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.5.tgz", + "integrity": "sha512-Y7/KDsb8LjooZpwaqGyulO6DQlksgCncchHGk+sZIY4SBvUocMBEFH5Ur1fI4dV+Jvl0w6cjvucaIi40puRioA==", "license": "ISC", "bin": { "semver": "bin/semver.js" @@ -10384,20 +11686,6 @@ "node": ">=10" } }, - "node_modules/istanbul-lib-source-maps": { - "version": "5.0.6", - "resolved": "https://registry.npmjs.org/istanbul-lib-source-maps/-/istanbul-lib-source-maps-5.0.6.tgz", - "integrity": "sha512-yg2d+Em4KizZC5niWhQaIomgf5WlL4vOOjZ5xGCmF8SnPE/mDWWXgvRExdcpCgh9lLRRa1/fSYp2ymmbJ1pI+A==", - "license": "BSD-3-Clause", - "dependencies": { - "@jridgewell/trace-mapping": "^0.3.23", - "debug": "^4.1.1", - "istanbul-lib-coverage": "^3.0.0" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/istanbul-reports": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-3.2.0.tgz", @@ -10461,9 +11749,9 @@ } }, "node_modules/jest-util/node_modules/picomatch": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.2.tgz", + "integrity": "sha512-V7+vQEJ06Z+c5tSye8S+nHUfI51xoXIXjHQ99cQtKUkQqqO1kO/KCJUfZXuB47h/YBlDhah2H3hdUGXn8ie0oA==", "license": "MIT", "engines": { "node": ">=8.6" @@ -10503,9 +11791,9 @@ } }, "node_modules/jiti": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/jiti/-/jiti-2.6.1.tgz", - "integrity": "sha512-ekilCSN1jwRvIbgeg/57YFh8qQDNbwDb9xT/qu2DAHbFFZUicIl4ygVaAvzveMhMVr3LnpSKTNnwt8PoOfmKhQ==", + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/jiti/-/jiti-2.7.0.tgz", + "integrity": "sha512-AC/7JofJvZGrrneWNaEnJeOLUx+JlGt7tNa0wZiRPT4MY1wmfKjt2+6O2p2uz2+skll8OZZmJMNqeke7kKbNgQ==", "license": "MIT", "bin": { "jiti": "lib/jiti-cli.mjs" @@ -10533,9 +11821,9 @@ } }, "node_modules/js-beautify/node_modules/brace-expansion": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", - "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.1.tgz", + "integrity": "sha512-WR1cURNjuvBLMZBMbqM0UoE+WAfdUcEV1ccD8PVBVOI+Z3ND4+SZbN8RsfT2bMuG1qwz5RFvPukSZm5fF2D5eA==", "license": "MIT", "dependencies": { "balanced-match": "^1.0.0" @@ -10578,13 +11866,10 @@ } }, "node_modules/js-cookie": { - "version": "3.0.5", - "resolved": "https://registry.npmjs.org/js-cookie/-/js-cookie-3.0.5.tgz", - "integrity": "sha512-cEiJEAEoIbWfCZYKWhVwFuvPX1gETRYPw6LlaTKoxD3s2AkXzkCjnp6h0V77ozyqj0jakteJ4YqDJT830+lVGw==", - "license": "MIT", - "engines": { - "node": ">=14" - } + "version": "3.0.8", + "resolved": "https://registry.npmjs.org/js-cookie/-/js-cookie-3.0.8.tgz", + "integrity": "sha512-yeJd4aNAdYZQjaon2bpD/Gb0B/omw7HQOsynXXcOiWVCacbBcPlgn8S/d1X6blFSaHao7ozqtW7NZW19xpCtIw==", + "license": "MIT" }, "node_modules/js-tokens": { "version": "4.0.0", @@ -10593,9 +11878,19 @@ "license": "MIT" }, "node_modules/js-yaml": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.1.tgz", - "integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==", + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.3.0.tgz", + "integrity": "sha512-1td788aAnnZ5qs7V2QIRl1owjtYpbKt749Y3xauqQgwIIGF/xXWz1wMTEBx5O3LK3lXLVuqXPdPxj2BoFHaW9Q==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/puzrin" + }, + { + "type": "github", + "url": "https://github.com/sponsors/nodeca" + } + ], "license": "MIT", "dependencies": { "argparse": "^2.0.1" @@ -10605,34 +11900,35 @@ } }, "node_modules/jsdom": { - "version": "26.1.0", - "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-26.1.0.tgz", - "integrity": "sha512-Cvc9WUhxSMEo4McES3P7oK3QaXldCfNWp7pl2NNeiIFlCoLr3kfq9kb1fxftiwk1FLV7CvpvDfonxtzUDeSOPg==", + "version": "29.1.1", + "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-29.1.1.tgz", + "integrity": "sha512-ECi4Fi2f7BdJtUKTflYRTiaMxIB0O6zfR1fX0GXpUrf6flp8QIYn1UT20YQqdSOfk2dfkCwS8LAFoJDEppNK5Q==", "license": "MIT", "dependencies": { - "cssstyle": "^4.2.1", - "data-urls": "^5.0.0", - "decimal.js": "^10.5.0", - "html-encoding-sniffer": "^4.0.0", - "http-proxy-agent": "^7.0.2", - "https-proxy-agent": "^7.0.6", + "@asamuzakjp/css-color": "^5.1.11", + "@asamuzakjp/dom-selector": "^7.1.1", + "@bramus/specificity": "^2.4.2", + "@csstools/css-syntax-patches-for-csstree": "^1.1.3", + "@exodus/bytes": "^1.15.0", + "css-tree": "^3.2.1", + "data-urls": "^7.0.0", + "decimal.js": "^10.6.0", + "html-encoding-sniffer": "^6.0.0", "is-potential-custom-element-name": "^1.0.1", - "nwsapi": "^2.2.16", - "parse5": "^7.2.1", - "rrweb-cssom": "^0.8.0", + "lru-cache": "^11.3.5", + "parse5": "^8.0.1", "saxes": "^6.0.0", "symbol-tree": "^3.2.4", - "tough-cookie": "^5.1.1", + "tough-cookie": "^6.0.1", + "undici": "^7.25.0", "w3c-xmlserializer": "^5.0.0", - "webidl-conversions": "^7.0.0", - "whatwg-encoding": "^3.1.1", - "whatwg-mimetype": "^4.0.0", - "whatwg-url": "^14.1.1", - "ws": "^8.18.0", + "webidl-conversions": "^8.0.1", + "whatwg-mimetype": "^5.0.0", + "whatwg-url": "^16.0.1", "xml-name-validator": "^5.0.0" }, "engines": { - "node": ">=18" + "node": "^20.19.0 || ^22.13.0 || >=24.0.0" }, "peerDependencies": { "canvas": "^3.0.0" @@ -10643,6 +11939,15 @@ } } }, + "node_modules/jsdom/node_modules/lru-cache": { + "version": "11.5.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-11.5.1.tgz", + "integrity": "sha512-RPimw/7aMdv2oqRrxKwvZXcPfwBrn/JZ2xYcY9Hus/6LaS3VOAKVWKWgNLCFSiOm1ESXinjsDlidVU7JlnCN2A==", + "license": "BlueOak-1.0.0", + "engines": { + "node": "20 || >=22" + } + }, "node_modules/jsdom/node_modules/xml-name-validator": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/xml-name-validator/-/xml-name-validator-5.0.0.tgz", @@ -10676,12 +11981,6 @@ "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", "license": "MIT" }, - "node_modules/json-schema": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.4.0.tgz", - "integrity": "sha512-es94M3nTIfsEPisRafak+HDLfHXnKBhV3vU5eqPcS3flIWqcxJWgXHXiey3YrpaNsanY5ei1VoYEbOzijuq9BA==", - "license": "(AFL-2.1 OR BSD-3-Clause)" - }, "node_modules/json-schema-traverse": { "version": "0.4.1", "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", @@ -10719,9 +12018,9 @@ "license": "MIT" }, "node_modules/jsonfile": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.0.tgz", - "integrity": "sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg==", + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.1.tgz", + "integrity": "sha512-zwOTdL3rFQ/lRdBnntKVOX6k5cKJwEc1HdilT71BWEu7J41gXIB2MRp+vxduPSwZJPWBxEzv4yH1wYLJGUHX4Q==", "license": "MIT", "dependencies": { "universalify": "^2.0.0" @@ -10740,9 +12039,9 @@ } }, "node_modules/kdbush": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/kdbush/-/kdbush-4.0.2.tgz", - "integrity": "sha512-WbCVYJ27Sz8zi9Q7Q0xHC+05iwkm3Znipc2XTlrnJbsHMYktW4hPhXUE8Ys1engBrvffoSCqbil1JQAa7clRpA==", + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/kdbush/-/kdbush-4.1.0.tgz", + "integrity": "sha512-e9vurzrXJQrFX6ckpHP3bvj5l+9CnYzkxDNnNQ1h2QTqdWsUAJgXiKdGNcOa1EY85dU8KbQ+z/FdQdB7P+9yfQ==", "license": "ISC" }, "node_modules/keyv": { @@ -10763,6 +12062,15 @@ "node": ">=0.10.0" } }, + "node_modules/launder": { + "version": "1.7.1", + "resolved": "https://registry.npmjs.org/launder/-/launder-1.7.1.tgz", + "integrity": "sha512-mU6WRz5EusL9ZZuiZ5SO4Y6C0P9PAUR9iwdb6bzj4KDihm28DiHFw+/yk9DBH4f+Pv1wuzQ4e2jV3oQ7mkIqvw==", + "license": "MIT", + "dependencies": { + "dayjs": "^1.11.7" + } + }, "node_modules/leven": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", @@ -10785,6 +12093,267 @@ "node": ">= 0.8.0" } }, + "node_modules/lightningcss": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss/-/lightningcss-1.32.0.tgz", + "integrity": "sha512-NXYBzinNrblfraPGyrbPoD19C1h9lfI/1mzgWYvXUTe414Gz/X1FD2XBZSZM7rRTrMA8JL3OtAaGifrIKhQ5yQ==", + "license": "MPL-2.0", + "dependencies": { + "detect-libc": "^2.0.3" + }, + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + }, + "optionalDependencies": { + "lightningcss-android-arm64": "1.32.0", + "lightningcss-darwin-arm64": "1.32.0", + "lightningcss-darwin-x64": "1.32.0", + "lightningcss-freebsd-x64": "1.32.0", + "lightningcss-linux-arm-gnueabihf": "1.32.0", + "lightningcss-linux-arm64-gnu": "1.32.0", + "lightningcss-linux-arm64-musl": "1.32.0", + "lightningcss-linux-x64-gnu": "1.32.0", + "lightningcss-linux-x64-musl": "1.32.0", + "lightningcss-win32-arm64-msvc": "1.32.0", + "lightningcss-win32-x64-msvc": "1.32.0" + } + }, + "node_modules/lightningcss-android-arm64": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-android-arm64/-/lightningcss-android-arm64-1.32.0.tgz", + "integrity": "sha512-YK7/ClTt4kAK0vo6w3X+Pnm0D2cf2vPHbhOXdoNti1Ga0al1P4TBZhwjATvjNwLEBCnKvjJc2jQgHXH0NEwlAg==", + "cpu": [ + "arm64" + ], + "license": "MPL-2.0", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-darwin-arm64": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-darwin-arm64/-/lightningcss-darwin-arm64-1.32.0.tgz", + "integrity": "sha512-RzeG9Ju5bag2Bv1/lwlVJvBE3q6TtXskdZLLCyfg5pt+HLz9BqlICO7LZM7VHNTTn/5PRhHFBSjk5lc4cmscPQ==", + "cpu": [ + "arm64" + ], + "license": "MPL-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-darwin-x64": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-darwin-x64/-/lightningcss-darwin-x64-1.32.0.tgz", + "integrity": "sha512-U+QsBp2m/s2wqpUYT/6wnlagdZbtZdndSmut/NJqlCcMLTWp5muCrID+K5UJ6jqD2BFshejCYXniPDbNh73V8w==", + "cpu": [ + "x64" + ], + "license": "MPL-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-freebsd-x64": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-freebsd-x64/-/lightningcss-freebsd-x64-1.32.0.tgz", + "integrity": "sha512-JCTigedEksZk3tHTTthnMdVfGf61Fky8Ji2E4YjUTEQX14xiy/lTzXnu1vwiZe3bYe0q+SpsSH/CTeDXK6WHig==", + "cpu": [ + "x64" + ], + "license": "MPL-2.0", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-arm-gnueabihf": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm-gnueabihf/-/lightningcss-linux-arm-gnueabihf-1.32.0.tgz", + "integrity": "sha512-x6rnnpRa2GL0zQOkt6rts3YDPzduLpWvwAF6EMhXFVZXD4tPrBkEFqzGowzCsIWsPjqSK+tyNEODUBXeeVHSkw==", + "cpu": [ + "arm" + ], + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-arm64-gnu": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm64-gnu/-/lightningcss-linux-arm64-gnu-1.32.0.tgz", + "integrity": "sha512-0nnMyoyOLRJXfbMOilaSRcLH3Jw5z9HDNGfT/gwCPgaDjnx0i8w7vBzFLFR1f6CMLKF8gVbebmkUN3fa/kQJpQ==", + "cpu": [ + "arm64" + ], + "libc": [ + "glibc" + ], + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-arm64-musl": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm64-musl/-/lightningcss-linux-arm64-musl-1.32.0.tgz", + "integrity": "sha512-UpQkoenr4UJEzgVIYpI80lDFvRmPVg6oqboNHfoH4CQIfNA+HOrZ7Mo7KZP02dC6LjghPQJeBsvXhJod/wnIBg==", + "cpu": [ + "arm64" + ], + "libc": [ + "musl" + ], + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-x64-gnu": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-x64-gnu/-/lightningcss-linux-x64-gnu-1.32.0.tgz", + "integrity": "sha512-V7Qr52IhZmdKPVr+Vtw8o+WLsQJYCTd8loIfpDaMRWGUZfBOYEJeyJIkqGIDMZPwPx24pUMfwSxxI8phr/MbOA==", + "cpu": [ + "x64" + ], + "libc": [ + "glibc" + ], + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-x64-musl": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-x64-musl/-/lightningcss-linux-x64-musl-1.32.0.tgz", + "integrity": "sha512-bYcLp+Vb0awsiXg/80uCRezCYHNg1/l3mt0gzHnWV9XP1W5sKa5/TCdGWaR/zBM2PeF/HbsQv/j2URNOiVuxWg==", + "cpu": [ + "x64" + ], + "libc": [ + "musl" + ], + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-win32-arm64-msvc": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-win32-arm64-msvc/-/lightningcss-win32-arm64-msvc-1.32.0.tgz", + "integrity": "sha512-8SbC8BR40pS6baCM8sbtYDSwEVQd4JlFTOlaD3gWGHfThTcABnNDBda6eTZeqbofalIJhFx0qKzgHJmcPTnGdw==", + "cpu": [ + "arm64" + ], + "license": "MPL-2.0", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-win32-x64-msvc": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-win32-x64-msvc/-/lightningcss-win32-x64-msvc-1.32.0.tgz", + "integrity": "sha512-Amq9B/SoZYdDi1kFrojnoqPLxYhQ4Wo5XiL8EVJrVsB8ARoC1PWW6VGtT0WKCemjy8aC+louJnjS7U18x3b06Q==", + "cpu": [ + "x64" + ], + "license": "MPL-2.0", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, "node_modules/lilconfig": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/lilconfig/-/lilconfig-3.1.3.tgz", @@ -10804,9 +12373,9 @@ "license": "MIT" }, "node_modules/loader-runner": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-4.3.1.tgz", - "integrity": "sha512-IWqP2SCPhyVFTBtRcgMHdzlf9ul25NwaFx4wCEH/KjAXuuHY4yNjvPXsBokp8jCB936PyWRaPKUNh8NvylLp2Q==", + "version": "4.3.2", + "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-4.3.2.tgz", + "integrity": "sha512-DFEqQ3ihfS9blba08cLfYf1NRAIEm+dDjic073DRDc3/JspI/8wYmtDsHwd3+4hwvdxSK7PGaElfTmm0awWJ4w==", "license": "MIT", "engines": { "node": ">=6.11.5" @@ -10845,12 +12414,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/lodash": { - "version": "4.17.23", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.23.tgz", - "integrity": "sha512-LgVTMpQtIopCi79SJeDiP0TfWi5CNEc/L/aRdTh3yIvmZXTnheWpKjSZhnvMl8iXbC1tFg9gdHHDMLoV7CnG+w==", - "license": "MIT" - }, "node_modules/lodash.camelcase": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/lodash.camelcase/-/lodash.camelcase-4.3.0.tgz", @@ -10915,12 +12478,6 @@ "url": "https://github.com/chalk/chalk?sponsor=1" } }, - "node_modules/loupe": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.2.1.tgz", - "integrity": "sha512-CdzqowRJCeLU72bHvWqwRBBlLcMEtIvGrlvef74kMnV2AolS9Y8xUv1I0U/MNAWMhBlKIoyuEgoJ0t/bbwHbLQ==", - "license": "MIT" - }, "node_modules/lru-cache": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", @@ -10939,15 +12496,6 @@ "node": ">=12" } }, - "node_modules/lz-string": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/lz-string/-/lz-string-1.5.0.tgz", - "integrity": "sha512-h5bgJWpxJNswbU7qCrV0tIKQCaS3blPDrqKWx+QxzuzL1zGUzij9XCWLrSLsJPu5t+eWA/ycetzYAO5IOMcWAQ==", - "license": "MIT", - "bin": { - "lz-string": "bin/bin.js" - } - }, "node_modules/magic-string": { "version": "0.30.21", "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.21.tgz", @@ -10958,14 +12506,14 @@ } }, "node_modules/magicast": { - "version": "0.3.5", - "resolved": "https://registry.npmjs.org/magicast/-/magicast-0.3.5.tgz", - "integrity": "sha512-L0WhttDl+2BOsybvEOLK7fW3UA0OQ0IQ2d6Zl2x/a6vVRs3bAY0ECOSHHeL5jD+SbOpOCUEi0y1DgHEn9Qn1AQ==", + "version": "0.5.3", + "resolved": "https://registry.npmjs.org/magicast/-/magicast-0.5.3.tgz", + "integrity": "sha512-pVKE4UdSQ7DvHzivsCIFx2BJn1mHG6KsyrFcaxFx6tONdneEuThrDx0Cj3AMg58KyN4pzYT+LHOotxDQDjNvkw==", "license": "MIT", "dependencies": { - "@babel/parser": "^7.25.4", - "@babel/types": "^7.25.4", - "source-map-js": "^1.2.0" + "@babel/parser": "^7.29.3", + "@babel/types": "^7.29.0", + "source-map-js": "^1.2.1" } }, "node_modules/make-dir": { @@ -10991,24 +12539,22 @@ } }, "node_modules/maplibre-gl": { - "version": "5.19.0", - "resolved": "https://registry.npmjs.org/maplibre-gl/-/maplibre-gl-5.19.0.tgz", - "integrity": "sha512-REhYUN8gNP3HlcIZS6QU2uy8iovl31cXsrNDkCcqWSQbCkcpdYLczqDz5PVIwNH42UQNyvukjes/RoHPDrOUmQ==", + "version": "5.24.0", + "resolved": "https://registry.npmjs.org/maplibre-gl/-/maplibre-gl-5.24.0.tgz", + "integrity": "sha512-ALyFxgtd5R+65UqZ/++lOqwWcC0SNho9c27fYSyLmG7AfnAul2o46F05aDJGPbFU57wos9dgcIySHs0Xe6ia3A==", "license": "BSD-3-Clause", "dependencies": { - "@mapbox/geojson-rewind": "^0.5.2", "@mapbox/jsonlint-lines-primitives": "^2.0.2", "@mapbox/point-geometry": "^1.1.0", - "@mapbox/tiny-sdf": "^2.0.7", + "@mapbox/tiny-sdf": "^2.1.0", "@mapbox/unitbezier": "^0.0.1", "@mapbox/vector-tile": "^2.0.4", "@mapbox/whoots-js": "^3.1.0", - "@maplibre/geojson-vt": "^5.0.4", - "@maplibre/maplibre-gl-style-spec": "^24.4.1", - "@maplibre/mlt": "^1.1.6", - "@maplibre/vt-pbf": "^4.2.1", + "@maplibre/geojson-vt": "^6.1.0", + "@maplibre/maplibre-gl-style-spec": "^24.8.1", + "@maplibre/mlt": "^1.1.8", + "@maplibre/vt-pbf": "^4.3.0", "@types/geojson": "^7946.0.16", - "@types/supercluster": "^7.1.3", "earcut": "^3.0.2", "gl-matrix": "^3.4.4", "kdbush": "^4.0.2", @@ -11016,7 +12562,6 @@ "pbf": "^4.0.1", "potpack": "^2.1.0", "quickselect": "^3.0.0", - "supercluster": "^8.0.1", "tinyqueue": "^3.0.0" }, "engines": { @@ -11054,9 +12599,9 @@ "license": "MIT" }, "node_modules/mdn-data": { - "version": "2.12.2", - "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.12.2.tgz", - "integrity": "sha512-IEn+pegP1aManZuckezWCO+XZQDplx1366JoVhTpMpBB1sPey/SbveZQUosKiKiGYjg1wH4pMlNgXbCiYgihQA==", + "version": "2.27.1", + "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.27.1.tgz", + "integrity": "sha512-9Yubnt3e8A0OKwxYSXyhLymGW4sCufcLG6VdiDdUGVkPhpqLxlvP5vl1983gQjJl3tqbrM731mjaZaP68AgosQ==", "license": "CC0-1.0" }, "node_modules/memoize-one": { @@ -11085,9 +12630,9 @@ } }, "node_modules/micromatch/node_modules/picomatch": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.2.tgz", + "integrity": "sha512-V7+vQEJ06Z+c5tSye8S+nHUfI51xoXIXjHQ99cQtKUkQqqO1kO/KCJUfZXuB47h/YBlDhah2H3hdUGXn8ie0oA==", "license": "MIT", "engines": { "node": ">=8.6" @@ -11096,18 +12641,6 @@ "url": "https://github.com/sponsors/jonschlinkert" } }, - "node_modules/mime": { - "version": "2.5.2", - "resolved": "https://registry.npmjs.org/mime/-/mime-2.5.2.tgz", - "integrity": "sha512-tqkh47FzKeCPD2PUiPB6pkbMzsCasjxAfC62/Wap5qrUWcb+sFasXUC5I3gYM5iBM8v/Qpn4UK0x+j0iHyFPDg==", - "license": "MIT", - "bin": { - "mime": "cli.js" - }, - "engines": { - "node": ">=4.0.0" - } - }, "node_modules/mime-db": { "version": "1.52.0", "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", @@ -11139,9 +12672,9 @@ } }, "node_modules/mini-css-extract-plugin": { - "version": "2.10.0", - "resolved": "https://registry.npmjs.org/mini-css-extract-plugin/-/mini-css-extract-plugin-2.10.0.tgz", - "integrity": "sha512-540P2c5dYnJlyJxTaSloliZexv8rji6rY8FhQN+WF/82iHQfA23j/xtJx97L+mXOML27EqksSek/g4eK7jaL3g==", + "version": "2.10.2", + "resolved": "https://registry.npmjs.org/mini-css-extract-plugin/-/mini-css-extract-plugin-2.10.2.tgz", + "integrity": "sha512-AOSS0IdEB95ayVkxn5oGzNQwqAi2J0Jb/kKm43t7H73s8+f5873g0yuj0PNvK4dO75mu5DHg4nlgp4k6Kga8eg==", "license": "MIT", "dependencies": { "schema-utils": "^4.0.0", @@ -11240,9 +12773,9 @@ "license": "MIT" }, "node_modules/nanoid": { - "version": "3.3.11", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", - "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", + "version": "3.3.15", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.15.tgz", + "integrity": "sha512-y7Wygv/7mEOvxTuEQDB8StXdMRBWf1kR/tlhAzBRUFkB2jfcLOAxO/SHmOO2zgz1pVgK29/kyupn059/bCHdjA==", "funding": [ { "type": "github", @@ -11276,11 +12809,32 @@ "license": "MIT", "optional": true }, + "node_modules/node-exports-info": { + "version": "1.6.2", + "resolved": "https://registry.npmjs.org/node-exports-info/-/node-exports-info-1.6.2.tgz", + "integrity": "sha512-kXs9Go0cah0qHVV2v389IXQLdLCeE1xfFtjOAF+iobu0OIoG1pje8At2vMHyaPMiPMnG/LWP50twML21eMcAag==", + "license": "MIT", + "dependencies": { + "array.prototype.flatmap": "^1.3.3", + "es-errors": "^1.3.0", + "object.entries": "^1.1.9", + "semver": "^6.3.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/node-releases": { - "version": "2.0.27", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.27.tgz", - "integrity": "sha512-nmh3lCkYZ3grZvqcCH+fjmQ7X+H0OeZgP40OierEaAptX4XofMh5kwNbWh7lBduUzCcV/8kZ+NDLCwm2iorIlA==", - "license": "MIT" + "version": "2.0.50", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.50.tgz", + "integrity": "sha512-J6l92tKHX6w8Jy5nO1Vuc01NoIiRGi/d6qBKVxh+IQ8Cr3b6HbVNfKiF8ZpFKufTwpwxMmce2W3iQZ861ZRyTg==", + "license": "MIT", + "engines": { + "node": ">=18" + } }, "node_modules/node-storage-shim": { "version": "2.0.1", @@ -11365,12 +12919,6 @@ "url": "https://opencollective.com/webpack" } }, - "node_modules/nwsapi": { - "version": "2.2.23", - "resolved": "https://registry.npmjs.org/nwsapi/-/nwsapi-2.2.23.tgz", - "integrity": "sha512-7wfH4sLbt4M0gCDzGE6vzQBo0bfTKjU7Sfpqy/7gs1qBfYz2vEJH6vXcBKpO3+6Yu1telwd0t9HpyOoLEQQbIQ==", - "license": "MIT" - }, "node_modules/object-assign": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", @@ -11421,6 +12969,21 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/object.entries": { + "version": "1.1.9", + "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.9.tgz", + "integrity": "sha512-8u/hfXFRBD1O0hPUjioLhoWFHRmt6tKA4/vZPyckBr18l1KE9uHrFaFaUi8MDRTpi4uak2goyPTSNJLXX2k2Hw==", + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.8", + "call-bound": "^1.0.4", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/object.fromentries": { "version": "2.0.8", "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.8.tgz", @@ -11471,6 +13034,19 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/obug": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/obug/-/obug-2.1.3.tgz", + "integrity": "sha512-9miFgM2OFba7hB+pRgvtV84pYTBaoTHohvmIgiRt6dRIzbwEOIaNaP+dIlGs2fNFoB0SeISs0Jz5WFVRid6Xyg==", + "funding": [ + "https://github.com/sponsors/sxzz", + "https://opencollective.com/debug" + ], + "license": "MIT", + "engines": { + "node": ">=12.20.0" + } + }, "node_modules/once": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", @@ -11605,37 +13181,39 @@ "license": "MIT" }, "node_modules/parse5": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.3.0.tgz", - "integrity": "sha512-IInvU7fabl34qmi9gY8XOVxhYyMyuH2xUNpb2q8/Y+7552KlejkRvqvD19nMoUW/uQGGbqNpA6Tufu5FL5BZgw==", + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-8.0.1.tgz", + "integrity": "sha512-z1e/HMG90obSGeidlli3hj7cbocou0/wa5HacvI3ASx34PecNjNQeaHNo5WIZpWofN9kgkqV1q5YvXe3F0FoPw==", "license": "MIT", "dependencies": { - "entities": "^6.0.0" + "entities": "^8.0.0" }, "funding": { "url": "https://github.com/inikulin/parse5?sponsor=1" } }, "node_modules/parse5-htmlparser2-tree-adapter": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-7.1.0.tgz", - "integrity": "sha512-ruw5xyKs6lrpo9x9rCZqZZnIUntICjQAd0Wsmp396Ul9lN/h+ifgVV1x1gZHi8euej6wTfpqX8j+BFQxF0NS/g==", + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-6.0.1.tgz", + "integrity": "sha512-qPuWvbLgvDGilKc5BoicRovlT4MtYT6JfJyBOMDsKoiT+GiuP5qyrPCnR9HcPECIJJmZh5jRndyNThnhhb/vlA==", "license": "MIT", "dependencies": { - "domhandler": "^5.0.3", - "parse5": "^7.0.0" - }, - "funding": { - "url": "https://github.com/inikulin/parse5?sponsor=1" + "parse5": "^6.0.1" } }, - "node_modules/parse5/node_modules/entities": { + "node_modules/parse5-htmlparser2-tree-adapter/node_modules/parse5": { "version": "6.0.1", - "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.1.tgz", - "integrity": "sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g==", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-6.0.1.tgz", + "integrity": "sha512-Ofn/CTFzRGTTxwpNEs9PP93gXShHcTq255nzRYSKe8AkVpZY7e1fpmTfOyoIvjP5HG7Z2ZM7VS9PPhQGW2pOpw==", + "license": "MIT" + }, + "node_modules/parse5/node_modules/entities": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-8.0.0.tgz", + "integrity": "sha512-zwfzJecQ/Uej6tusMqwAqU/6KL2XaB2VZ2Jg54Je6ahNBGNH6Ek6g3jjNCF0fG9EWQKGZNddNjU5F1ZQn/sBnA==", "license": "BSD-2-Clause", "engines": { - "node": ">=0.12" + "node": ">=20.19.0" }, "funding": { "url": "https://github.com/fb55/entities?sponsor=1" @@ -11723,19 +13301,10 @@ "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", "license": "MIT" }, - "node_modules/pathval": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/pathval/-/pathval-2.0.1.tgz", - "integrity": "sha512-//nshmD55c46FuFw26xV/xFAaB5HF9Xdap7HJBBnrKdAd6/GxDBaNA1870O79+9ueg61cZLSVc+OaFlfmObYVQ==", - "license": "MIT", - "engines": { - "node": ">= 14.16" - } - }, "node_modules/pbf": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/pbf/-/pbf-4.0.1.tgz", - "integrity": "sha512-SuLdBvS42z33m8ejRbInMapQe8n0D3vN/Xd5fmWM3tufNgRQFBpaW2YVJxQZV4iPNqb0vEFvssMEo5w9c6BTIA==", + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/pbf/-/pbf-4.0.2.tgz", + "integrity": "sha512-J0ajxARhZfpUEebxYs1vhMGMuLSXtBe1e+fFPDrf2uA2hgo+UshKfNUWOz92HJNz6/NFEXseQPddnHkTreWRqg==", "license": "BSD-3-Clause", "dependencies": { "resolve-protobuf-schema": "^2.1.0" @@ -11764,9 +13333,9 @@ "license": "ISC" }, "node_modules/picomatch": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", - "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.4.tgz", + "integrity": "sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==", "license": "MIT", "engines": { "node": ">=12" @@ -11867,12 +13436,12 @@ } }, "node_modules/playwright": { - "version": "1.58.2", - "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.58.2.tgz", - "integrity": "sha512-vA30H8Nvkq/cPBnNw4Q8TWz1EJyqgpuinBcHET0YVJVFldr8JDNiU9LaWAE1KqSkRYazuaBhTpB5ZzShOezQ6A==", + "version": "1.61.1", + "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.61.1.tgz", + "integrity": "sha512-DWnY5o3YbLWK4GovuAVwpqL+1VwGNdUGrRr++8j8PtQQzvAVZUIMjKQ90fY689sEJZJBbZVw1rXaOKSTitkzPQ==", "license": "Apache-2.0", "dependencies": { - "playwright-core": "1.58.2" + "playwright-core": "1.61.1" }, "bin": { "playwright": "cli.js" @@ -11885,9 +13454,9 @@ } }, "node_modules/playwright-core": { - "version": "1.58.2", - "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.58.2.tgz", - "integrity": "sha512-yZkEtftgwS8CsfYo7nm0KE8jsvm6i/PTgVtB8DL726wNf6H2IMsDuxCpJj59KDaxCtSnrWan2AeDqM7JBaultg==", + "version": "1.61.1", + "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.61.1.tgz", + "integrity": "sha512-h7Qlt6m4REp25qvIdvbDtVmD4LqVXfpRxhORv9L0jzETM05p4fuPJ3dKyuSXQxDSbXnmS79HAgi9589lGSpLkg==", "license": "Apache-2.0", "bin": { "playwright-core": "cli.js" @@ -11941,9 +13510,9 @@ } }, "node_modules/postcss": { - "version": "8.5.8", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.8.tgz", - "integrity": "sha512-OW/rX8O/jXnm82Ey1k44pObPtdblfiuWnrd8X7GJ7emImCOstunGbXUpp7HdBrFQX6rJzn3sPT397Wp5aCwCHg==", + "version": "8.5.16", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.16.tgz", + "integrity": "sha512-vuwillviilfKZsg0VGj5R/YwwcHx4SLsIOI/7K6mQkWx+l5cUHTjj5g0AasTBcyXsbfTgrwsUNmVUb5xVwyPwg==", "funding": [ { "type": "opencollective", @@ -11960,7 +13529,7 @@ ], "license": "MIT", "dependencies": { - "nanoid": "^3.3.11", + "nanoid": "^3.3.12", "picocolors": "^1.1.1", "source-map-js": "^1.2.1" }, @@ -12053,6 +13622,116 @@ "postcss": "^8.4" } }, + "node_modules/postcss-color-functional-notation/node_modules/@csstools/color-helpers": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", + "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + } + }, + "node_modules/postcss-color-functional-notation/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/postcss-color-functional-notation/node_modules/@csstools/css-color-parser": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", + "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/color-helpers": "^5.1.0", + "@csstools/css-calc": "^2.1.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/postcss-color-functional-notation/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/postcss-color-functional-notation/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/postcss-color-hex-alpha": { "version": "10.0.0", "resolved": "https://registry.npmjs.org/postcss-color-hex-alpha/-/postcss-color-hex-alpha-10.0.0.tgz", @@ -12106,37 +13785,37 @@ } }, "node_modules/postcss-colormin": { - "version": "7.0.5", - "resolved": "https://registry.npmjs.org/postcss-colormin/-/postcss-colormin-7.0.5.tgz", - "integrity": "sha512-ekIBP/nwzRWhEMmIxHHbXHcMdzd1HIUzBECaj5KEdLz9DVP2HzT065sEhvOx1dkLjYW7jyD0CngThx6bpFi2fA==", + "version": "7.0.10", + "resolved": "https://registry.npmjs.org/postcss-colormin/-/postcss-colormin-7.0.10.tgz", + "integrity": "sha512-yFr6JezOolHLta/buLE71VKPh2mXursp4saVe98/ol8ZnEWhL+racShqPKlvd/DKWLre/39B6HhcMXf7RZ3hxg==", "license": "MIT", "dependencies": { - "browserslist": "^4.27.0", + "@colordx/core": "^5.4.3", + "browserslist": "^4.28.2", "caniuse-api": "^3.0.0", - "colord": "^2.9.3", "postcss-value-parser": "^4.2.0" }, "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-convert-values": { - "version": "7.0.8", - "resolved": "https://registry.npmjs.org/postcss-convert-values/-/postcss-convert-values-7.0.8.tgz", - "integrity": "sha512-+XNKuPfkHTCEo499VzLMYn94TiL3r9YqRE3Ty+jP7UX4qjewUONey1t7CG21lrlTLN07GtGM8MqFVp86D4uKJg==", + "version": "7.0.12", + "resolved": "https://registry.npmjs.org/postcss-convert-values/-/postcss-convert-values-7.0.12.tgz", + "integrity": "sha512-xurKu5qqk4viR3Cp3p4xBR4KfnZm4w4ys6+UBwBmeuBSNkH7+DtLnYOYnOffgtE4yx8sH9S1VZ6RAAvROXzP2Q==", "license": "MIT", "dependencies": { - "browserslist": "^4.27.0", + "browserslist": "^4.28.2", "postcss-value-parser": "^4.2.0" }, "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-custom-media": { @@ -12167,6 +13846,93 @@ "postcss": "^8.4" } }, + "node_modules/postcss-custom-media/node_modules/@csstools/cascade-layer-name-parser": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@csstools/cascade-layer-name-parser/-/cascade-layer-name-parser-2.0.5.tgz", + "integrity": "sha512-p1ko5eHgV+MgXFVa4STPKpvPxr6ReS8oS2jzTukjR74i5zJNyWO1ZM1m8YKBXnzDKWfBN1ztLYlHxbVemDD88A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/postcss-custom-media/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/postcss-custom-media/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, + "node_modules/postcss-custom-media/node_modules/@csstools/media-query-list-parser": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/@csstools/media-query-list-parser/-/media-query-list-parser-4.0.3.tgz", + "integrity": "sha512-HAYH7d3TLRHDOUQK4mZKf9k9Ph/m8Akstg66ywKR4SFAigjs3yBiUeZtFxywiTm5moZMAp/5W/ZuFnNXXYLuuQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, "node_modules/postcss-custom-properties": { "version": "14.0.6", "resolved": "https://registry.npmjs.org/postcss-custom-properties/-/postcss-custom-properties-14.0.6.tgz", @@ -12196,6 +13962,70 @@ "postcss": "^8.4" } }, + "node_modules/postcss-custom-properties/node_modules/@csstools/cascade-layer-name-parser": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@csstools/cascade-layer-name-parser/-/cascade-layer-name-parser-2.0.5.tgz", + "integrity": "sha512-p1ko5eHgV+MgXFVa4STPKpvPxr6ReS8oS2jzTukjR74i5zJNyWO1ZM1m8YKBXnzDKWfBN1ztLYlHxbVemDD88A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/postcss-custom-properties/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/postcss-custom-properties/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/postcss-custom-selectors": { "version": "8.0.5", "resolved": "https://registry.npmjs.org/postcss-custom-selectors/-/postcss-custom-selectors-8.0.5.tgz", @@ -12224,6 +14054,70 @@ "postcss": "^8.4" } }, + "node_modules/postcss-custom-selectors/node_modules/@csstools/cascade-layer-name-parser": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@csstools/cascade-layer-name-parser/-/cascade-layer-name-parser-2.0.5.tgz", + "integrity": "sha512-p1ko5eHgV+MgXFVa4STPKpvPxr6ReS8oS2jzTukjR74i5zJNyWO1ZM1m8YKBXnzDKWfBN1ztLYlHxbVemDD88A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/postcss-custom-selectors/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/postcss-custom-selectors/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/postcss-dir-pseudo-class": { "version": "9.0.1", "resolved": "https://registry.npmjs.org/postcss-dir-pseudo-class/-/postcss-dir-pseudo-class-9.0.1.tgz", @@ -12250,54 +14144,54 @@ } }, "node_modules/postcss-discard-comments": { - "version": "7.0.5", - "resolved": "https://registry.npmjs.org/postcss-discard-comments/-/postcss-discard-comments-7.0.5.tgz", - "integrity": "sha512-IR2Eja8WfYgN5n32vEGSctVQ1+JARfu4UH8M7bgGh1bC+xI/obsPJXaBpQF7MAByvgwZinhpHpdrmXtvVVlKcQ==", + "version": "7.0.8", + "resolved": "https://registry.npmjs.org/postcss-discard-comments/-/postcss-discard-comments-7.0.8.tgz", + "integrity": "sha512-CvvS5S9WrXblFXCEJ9nVo+4z+eA7zSC7Z88V1HEJuwlQhlFnYTIjg1xJY+BCUiG2bvICap2tXii4mP22BD108Q==", "license": "MIT", "dependencies": { - "postcss-selector-parser": "^7.1.0" + "postcss-selector-parser": "^7.1.1" }, "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-discard-duplicates": { - "version": "7.0.2", - "resolved": "https://registry.npmjs.org/postcss-discard-duplicates/-/postcss-discard-duplicates-7.0.2.tgz", - "integrity": "sha512-eTonaQvPZ/3i1ASDHOKkYwAybiM45zFIc7KXils4mQmHLqIswXD9XNOKEVxtTFnsmwYzF66u4LMgSr0abDlh5w==", + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/postcss-discard-duplicates/-/postcss-discard-duplicates-7.0.4.tgz", + "integrity": "sha512-VBNn1+EuMZkeGVVtz0gRfbNGtx9IFgAsAV+E2pHtXPrp4qfGBkhTIiAuE/wrb+Y6Pakg9NewAlfTpYIFAWODtw==", "license": "MIT", "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-discard-empty": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/postcss-discard-empty/-/postcss-discard-empty-7.0.1.tgz", - "integrity": "sha512-cFrJKZvcg/uxB6Ijr4l6qmn3pXQBna9zyrPC+sK0zjbkDUZew+6xDltSF7OeB7rAtzaaMVYSdbod+sZOCWnMOg==", + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/postcss-discard-empty/-/postcss-discard-empty-7.0.3.tgz", + "integrity": "sha512-M2pyjQCU+/7cMHVtL6bKTHjv0lZnPLMpicgr67Dlth7AbuV9gjVTtUqaRwn6Pp6BwSDspUzhz8SaUrRykJU5Dw==", "license": "MIT", "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-discard-overridden": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/postcss-discard-overridden/-/postcss-discard-overridden-7.0.1.tgz", - "integrity": "sha512-7c3MMjjSZ/qYrx3uc1940GSOzN1Iqjtlqe8uoSg+qdVPYyRb0TILSqqmtlSFuE4mTDECwsm397Ya7iXGzfF7lg==", + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/postcss-discard-overridden/-/postcss-discard-overridden-7.0.3.tgz", + "integrity": "sha512-aNovXo9UsZuRNLzHJtp13lHIvinDPfiXBPePpXkSjCbgp++iU2FqE+YxvjIsg6EdyPZsASFbfu+JcBFVsErXIQ==", "license": "MIT", "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-double-position-gradients": { @@ -12480,6 +14374,116 @@ "postcss": "^8.4" } }, + "node_modules/postcss-lab-function/node_modules/@csstools/color-helpers": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", + "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + } + }, + "node_modules/postcss-lab-function/node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/postcss-lab-function/node_modules/@csstools/css-color-parser": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", + "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/color-helpers": "^5.1.0", + "@csstools/css-calc": "^2.1.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/postcss-lab-function/node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/postcss-lab-function/node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/postcss-loader": { "version": "8.2.1", "resolved": "https://registry.npmjs.org/postcss-loader/-/postcss-loader-8.2.1.tgz", @@ -12512,9 +14516,9 @@ } }, "node_modules/postcss-loader/node_modules/semver": { - "version": "7.7.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", - "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", + "version": "7.8.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.5.tgz", + "integrity": "sha512-Y7/KDsb8LjooZpwaqGyulO6DQlksgCncchHGk+sZIY4SBvUocMBEFH5Ur1fI4dV+Jvl0w6cjvucaIi40puRioA==", "license": "ISC", "bin": { "semver": "bin/semver.js" @@ -12549,43 +14553,43 @@ } }, "node_modules/postcss-merge-longhand": { - "version": "7.0.5", - "resolved": "https://registry.npmjs.org/postcss-merge-longhand/-/postcss-merge-longhand-7.0.5.tgz", - "integrity": "sha512-Kpu5v4Ys6QI59FxmxtNB/iHUVDn9Y9sYw66D6+SZoIk4QTz1prC4aYkhIESu+ieG1iylod1f8MILMs1Em3mmIw==", + "version": "7.0.7", + "resolved": "https://registry.npmjs.org/postcss-merge-longhand/-/postcss-merge-longhand-7.0.7.tgz", + "integrity": "sha512-b3mfYUxR388u5Pt0HPcVIUtUDn/k15UfTY9M+ORW+meCR6JLNxoZffiYvXyOYQoRYQNZyX/UFkMCM/mNHxe1qA==", "license": "MIT", "dependencies": { "postcss-value-parser": "^4.2.0", - "stylehacks": "^7.0.5" + "stylehacks": "^7.0.11" }, "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-merge-rules": { - "version": "7.0.7", - "resolved": "https://registry.npmjs.org/postcss-merge-rules/-/postcss-merge-rules-7.0.7.tgz", - "integrity": "sha512-njWJrd/Ms6XViwowaaCc+/vqhPG3SmXn725AGrnl+BgTuRPEacjiLEaGq16J6XirMJbtKkTwnt67SS+e2WGoew==", + "version": "7.0.11", + "resolved": "https://registry.npmjs.org/postcss-merge-rules/-/postcss-merge-rules-7.0.11.tgz", + "integrity": "sha512-SJUPM18g2BmPhf8BVlbwqWz4aK3pLu6u6xjfwEzra7xL6IBR10sUaiB++EzqcVfadPHrKBSMlNdP+XieykhI+Q==", "license": "MIT", "dependencies": { - "browserslist": "^4.27.0", + "browserslist": "^4.28.2", "caniuse-api": "^3.0.0", - "cssnano-utils": "^5.0.1", - "postcss-selector-parser": "^7.1.0" + "cssnano-utils": "^5.0.3", + "postcss-selector-parser": "^7.1.1" }, "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-minify-font-values": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/postcss-minify-font-values/-/postcss-minify-font-values-7.0.1.tgz", - "integrity": "sha512-2m1uiuJeTplll+tq4ENOQSzB8LRnSUChBv7oSyFLsJRtUgAAJGP6LLz0/8lkinTgxrmJSPOEhgY1bMXOQ4ZXhQ==", + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/postcss-minify-font-values/-/postcss-minify-font-values-7.0.3.tgz", + "integrity": "sha512-yilG/VOaNI74IylQvAQQxm3/wZVBkXyYUqNUAdxqwtbWUXPsbK1q8Ms0mL83v+f8YicgcyfYCRZtWACUdYajpA==", "license": "MIT", "dependencies": { "postcss-value-parser": "^4.2.0" @@ -12594,57 +14598,59 @@ "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-minify-gradients": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/postcss-minify-gradients/-/postcss-minify-gradients-7.0.1.tgz", - "integrity": "sha512-X9JjaysZJwlqNkJbUDgOclyG3jZEpAMOfof6PUZjPnPrePnPG62pS17CjdM32uT1Uq1jFvNSff9l7kNbmMSL2A==", + "version": "7.0.5", + "resolved": "https://registry.npmjs.org/postcss-minify-gradients/-/postcss-minify-gradients-7.0.5.tgz", + "integrity": "sha512-YraROyQRg3BI1+Hg8E05B/JPdnTm8EDSVu4P2BxdM+CRiOyfmou809+chGIqo6fQqwjPGQ947nbGncSjmTU1WQ==", "license": "MIT", "dependencies": { - "colord": "^2.9.3", - "cssnano-utils": "^5.0.1", + "@colordx/core": "^5.4.3", + "cssnano-utils": "^5.0.3", "postcss-value-parser": "^4.2.0" }, "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-minify-params": { - "version": "7.0.5", - "resolved": "https://registry.npmjs.org/postcss-minify-params/-/postcss-minify-params-7.0.5.tgz", - "integrity": "sha512-FGK9ky02h6Ighn3UihsyeAH5XmLEE2MSGH5Tc4tXMFtEDx7B+zTG6hD/+/cT+fbF7PbYojsmmWjyTwFwW1JKQQ==", + "version": "7.0.9", + "resolved": "https://registry.npmjs.org/postcss-minify-params/-/postcss-minify-params-7.0.9.tgz", + "integrity": "sha512-R8itbB8BhlpoYyBm1ou0dD+vJnQ3F6adQipR4UnkCHUwlo+S9WXJaDRg1RHjC8YVAtIdrQzSWvJl40HnGDTKjA==", "license": "MIT", "dependencies": { - "browserslist": "^4.27.0", - "cssnano-utils": "^5.0.1", + "browserslist": "^4.28.2", + "cssnano-utils": "^5.0.3", "postcss-value-parser": "^4.2.0" }, "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-minify-selectors": { - "version": "7.0.5", - "resolved": "https://registry.npmjs.org/postcss-minify-selectors/-/postcss-minify-selectors-7.0.5.tgz", - "integrity": "sha512-x2/IvofHcdIrAm9Q+p06ZD1h6FPcQ32WtCRVodJLDR+WMn8EVHI1kvLxZuGKz/9EY5nAmI6lIQIrpo4tBy5+ug==", + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/postcss-minify-selectors/-/postcss-minify-selectors-7.1.2.tgz", + "integrity": "sha512-aQtrEWKwqafNlExcKHQvPGsXR2+vlUqqJtf5XsCQcgsSb5PL4wlujWBYDJuWsP4UnQX1YHDHU8qRlD+1PzTQ+Q==", "license": "MIT", "dependencies": { + "browserslist": "^4.28.1", + "caniuse-api": "^3.0.0", "cssesc": "^3.0.0", - "postcss-selector-parser": "^7.1.0" + "postcss-selector-parser": "^7.1.1" }, "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-modules-extract-imports": { @@ -12734,21 +14740,21 @@ } }, "node_modules/postcss-normalize-charset": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/postcss-normalize-charset/-/postcss-normalize-charset-7.0.1.tgz", - "integrity": "sha512-sn413ofhSQHlZFae//m9FTOfkmiZ+YQXsbosqOWRiVQncU2BA3daX3n0VF3cG6rGLSFVc5Di/yns0dFfh8NFgQ==", + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/postcss-normalize-charset/-/postcss-normalize-charset-7.0.3.tgz", + "integrity": "sha512-NoBfZu8PR4c2NlmjvrqQTzCzLY79hwcSRgNQ3ZiNK0ABzf9kYKloE/jNj+/8GQY1wsm8pRRgANk6ydLH8cwo0Q==", "license": "MIT", "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-normalize-display-values": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/postcss-normalize-display-values/-/postcss-normalize-display-values-7.0.1.tgz", - "integrity": "sha512-E5nnB26XjSYz/mGITm6JgiDpAbVuAkzXwLzRZtts19jHDUBFxZ0BkXAehy0uimrOjYJbocby4FVswA/5noOxrQ==", + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/postcss-normalize-display-values/-/postcss-normalize-display-values-7.0.3.tgz", + "integrity": "sha512-ldsCX0QIt05pKIOobZtVQ48wXJecr+czw4+e1/YjVhLMqslShgpVxgPtI2CefURR8oyVoYaU/l829MMwExDMLw==", "license": "MIT", "dependencies": { "postcss-value-parser": "^4.2.0" @@ -12757,13 +14763,13 @@ "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-normalize-positions": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/postcss-normalize-positions/-/postcss-normalize-positions-7.0.1.tgz", - "integrity": "sha512-pB/SzrIP2l50ZIYu+yQZyMNmnAcwyYb9R1fVWPRxm4zcUFCY2ign7rcntGFuMXDdd9L2pPNUgoODDk91PzRZuQ==", + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/postcss-normalize-positions/-/postcss-normalize-positions-7.0.4.tgz", + "integrity": "sha512-VEvlpeGd3Ju1Hqa/oN4jaP3+ms4laYwkEL9N9u+B6k54PZjXbW1n6wI+aVprf1BQXlCYpS5+1pl/7/vHiKgARg==", "license": "MIT", "dependencies": { "postcss-value-parser": "^4.2.0" @@ -12772,13 +14778,13 @@ "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-normalize-repeat-style": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/postcss-normalize-repeat-style/-/postcss-normalize-repeat-style-7.0.1.tgz", - "integrity": "sha512-NsSQJ8zj8TIDiF0ig44Byo3Jk9e4gNt9x2VIlJudnQQ5DhWAHJPF4Tr1ITwyHio2BUi/I6Iv0HRO7beHYOloYQ==", + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/postcss-normalize-repeat-style/-/postcss-normalize-repeat-style-7.0.4.tgz", + "integrity": "sha512-6mPKlY/8cSaDHxX502wERADarJsccwlky6yIrOapHH2ZgfoKAV94SbiTKfKEs4EEpdazuc3J72WsqeYk7hp9+Q==", "license": "MIT", "dependencies": { "postcss-value-parser": "^4.2.0" @@ -12787,13 +14793,13 @@ "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-normalize-string": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/postcss-normalize-string/-/postcss-normalize-string-7.0.1.tgz", - "integrity": "sha512-QByrI7hAhsoze992kpbMlJSbZ8FuCEc1OT9EFbZ6HldXNpsdpZr+YXC5di3UEv0+jeZlHbZcoCADgb7a+lPmmQ==", + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/postcss-normalize-string/-/postcss-normalize-string-7.0.3.tgz", + "integrity": "sha512-HnEQPUchi1eznmDKEYrKUTqrprEq97SrpUYClgUkv7V2zRODD9DFoUsYU+m9ZOetmD5ku7fEMZB/lwy8IT6xVQ==", "license": "MIT", "dependencies": { "postcss-value-parser": "^4.2.0" @@ -12802,13 +14808,13 @@ "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-normalize-timing-functions": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/postcss-normalize-timing-functions/-/postcss-normalize-timing-functions-7.0.1.tgz", - "integrity": "sha512-bHifyuuSNdKKsnNJ0s8fmfLMlvsQwYVxIoUBnowIVl2ZAdrkYQNGVB4RxjfpvkMjipqvbz0u7feBZybkl/6NJg==", + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/postcss-normalize-timing-functions/-/postcss-normalize-timing-functions-7.0.3.tgz", + "integrity": "sha512-zmEzHdvpZBZu0OKlbJSfgASQvaayyAoVuWtvyr34IJ/LyS+DaOKvvR3EvFJ9RWWtNIx+CMvO125OVophaxNYew==", "license": "MIT", "dependencies": { "postcss-value-parser": "^4.2.0" @@ -12817,29 +14823,29 @@ "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-normalize-unicode": { - "version": "7.0.5", - "resolved": "https://registry.npmjs.org/postcss-normalize-unicode/-/postcss-normalize-unicode-7.0.5.tgz", - "integrity": "sha512-X6BBwiRxVaFHrb2WyBMddIeB5HBjJcAaUHyhLrM2FsxSq5TFqcHSsK7Zu1otag+o0ZphQGJewGH1tAyrD0zX1Q==", + "version": "7.0.9", + "resolved": "https://registry.npmjs.org/postcss-normalize-unicode/-/postcss-normalize-unicode-7.0.9.tgz", + "integrity": "sha512-DRAdWfeh/TjmhLJsw91vdiWCnUod9iwvM7xyS02/nF/sLsCR3A8l3pztrSUrWG8DSBqfX7yEk9FM0USaVJ2mSg==", "license": "MIT", "dependencies": { - "browserslist": "^4.27.0", + "browserslist": "^4.28.2", "postcss-value-parser": "^4.2.0" }, "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-normalize-url": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/postcss-normalize-url/-/postcss-normalize-url-7.0.1.tgz", - "integrity": "sha512-sUcD2cWtyK1AOL/82Fwy1aIVm/wwj5SdZkgZ3QiUzSzQQofrbq15jWJ3BA7Z+yVRwamCjJgZJN0I9IS7c6tgeQ==", + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/postcss-normalize-url/-/postcss-normalize-url-7.0.3.tgz", + "integrity": "sha512-CL93wmloq5qsffmFv+bw24MIRbmhHrp53qoh1LDAb/5TtjWEXI/np4xcP/Gw9oWCb2XyWnqHYLDUwiKRoJBA1Q==", "license": "MIT", "dependencies": { "postcss-value-parser": "^4.2.0" @@ -12848,13 +14854,13 @@ "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-normalize-whitespace": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/postcss-normalize-whitespace/-/postcss-normalize-whitespace-7.0.1.tgz", - "integrity": "sha512-vsbgFHMFQrJBJKrUFJNZ2pgBeBkC2IvvoHjz1to0/0Xk7sII24T0qFOiJzG6Fu3zJoq/0yI4rKWi7WhApW+EFA==", + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/postcss-normalize-whitespace/-/postcss-normalize-whitespace-7.0.3.tgz", + "integrity": "sha512-FdHjjn+Ht5Z2ZRjNOmeCbNq6lq09sUYKpmlF/Aq0XjVNSLTL6fmHlA/3swN2wP2caY9GV/tjSDcIIyS7aN7W0A==", "license": "MIT", "dependencies": { "postcss-value-parser": "^4.2.0" @@ -12863,7 +14869,7 @@ "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-opacity-percentage": { @@ -12889,19 +14895,19 @@ } }, "node_modules/postcss-ordered-values": { - "version": "7.0.2", - "resolved": "https://registry.npmjs.org/postcss-ordered-values/-/postcss-ordered-values-7.0.2.tgz", - "integrity": "sha512-AMJjt1ECBffF7CEON/Y0rekRLS6KsePU6PRP08UqYW4UGFRnTXNrByUzYK1h8AC7UWTZdQ9O3Oq9kFIhm0SFEw==", + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/postcss-ordered-values/-/postcss-ordered-values-7.0.4.tgz", + "integrity": "sha512-nubSi49hDHQk4E8KIj+IbLY8Bg+8OcSUEhgyolgM+atnOvXjV7EjaR6bac4YGZoFyPa9mWoAF3EaYbWdFkKqVg==", "license": "MIT", "dependencies": { - "cssnano-utils": "^5.0.1", + "cssnano-utils": "^5.0.3", "postcss-value-parser": "^4.2.0" }, "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-overflow-shorthand": { @@ -13084,25 +15090,25 @@ } }, "node_modules/postcss-reduce-initial": { - "version": "7.0.5", - "resolved": "https://registry.npmjs.org/postcss-reduce-initial/-/postcss-reduce-initial-7.0.5.tgz", - "integrity": "sha512-RHagHLidG8hTZcnr4FpyMB2jtgd/OcyAazjMhoy5qmWJOx1uxKh4ntk0Pb46ajKM0rkf32lRH4C8c9qQiPR6IA==", + "version": "7.0.9", + "resolved": "https://registry.npmjs.org/postcss-reduce-initial/-/postcss-reduce-initial-7.0.9.tgz", + "integrity": "sha512-ztTNPdIxXTxtBcG03E9u8v44M4ElXbMIRT7pf2onlquGula0Y83nKKxqM22FA/hMgkfCjN7ohevkVlaNwI8iOQ==", "license": "MIT", "dependencies": { - "browserslist": "^4.27.0", + "browserslist": "^4.28.2", "caniuse-api": "^3.0.0" }, "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-reduce-transforms": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/postcss-reduce-transforms/-/postcss-reduce-transforms-7.0.1.tgz", - "integrity": "sha512-MhyEbfrm+Mlp/36hvZ9mT9DaO7dbncU0CvWI8V93LRkY6IYlu38OPg3FObnuKTUxJ4qA8HpurdQOo5CyqqO76g==", + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/postcss-reduce-transforms/-/postcss-reduce-transforms-7.0.3.tgz", + "integrity": "sha512-FXsnN9ZwcZTT8Yf8cAHA8qIGUXcX6WfLd9JoYhrdDfmvsVhhfqkkv7m4AC3rwFOfz+GzkUa87OCKF9dUcicd+g==", "license": "MIT", "dependencies": { "postcss-value-parser": "^4.2.0" @@ -13111,7 +15117,7 @@ "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-replace-overflow-wrap": { @@ -13175,9 +15181,9 @@ } }, "node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "version": "7.1.4", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.4.tgz", + "integrity": "sha512-HeP7D2wyhkR+XaK6v4W8oRF62Dsz4flyuczALJp61GckGm42u1saSSJ/0auvcBqxs3jMRFEcPK34At/0JBKdOg==", "license": "MIT", "dependencies": { "cssesc": "^3.0.0", @@ -13188,79 +15194,34 @@ } }, "node_modules/postcss-svgo": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/postcss-svgo/-/postcss-svgo-7.1.0.tgz", - "integrity": "sha512-KnAlfmhtoLz6IuU3Sij2ycusNs4jPW+QoFE5kuuUOK8awR6tMxZQrs5Ey3BUz7nFCzT3eqyFgqkyrHiaU2xx3w==", + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/postcss-svgo/-/postcss-svgo-7.1.3.tgz", + "integrity": "sha512-2QfoFOYMcj8lwcVEf9WeTlkVIAm7u2QvOEhMzkQU3KUhhGX/l8hVV9EtjMv4iq3E9iI3OeeMN0YoMLbGusuigw==", "license": "MIT", "dependencies": { "postcss-value-parser": "^4.2.0", - "svgo": "^4.0.0" + "svgo": "^4.0.1" }, "engines": { "node": "^18.12.0 || ^20.9.0 || >= 18" }, "peerDependencies": { - "postcss": "^8.4.32" + "postcss": "^8.5.13" } }, "node_modules/postcss-unique-selectors": { - "version": "7.0.4", - "resolved": "https://registry.npmjs.org/postcss-unique-selectors/-/postcss-unique-selectors-7.0.4.tgz", - "integrity": "sha512-pmlZjsmEAG7cHd7uK3ZiNSW6otSZ13RHuZ/4cDN/bVglS5EpF2r2oxY99SuOHa8m7AWoBCelTS3JPpzsIs8skQ==", + "version": "7.0.7", + "resolved": "https://registry.npmjs.org/postcss-unique-selectors/-/postcss-unique-selectors-7.0.7.tgz", + "integrity": "sha512-d+sCkaRnSefghOUdH8CMJZV9yUQhj2ojpe8Nw/lA+LV1UOfeleGkLTl6XdCFFSai9UJ+DJPb69FFuqthXYsY8w==", "license": "MIT", "dependencies": { - "postcss-selector-parser": "^7.1.0" + "postcss-selector-parser": "^7.1.1" }, "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" - } - }, - "node_modules/postcss-url": { - "version": "10.1.3", - "resolved": "https://registry.npmjs.org/postcss-url/-/postcss-url-10.1.3.tgz", - "integrity": "sha512-FUzyxfI5l2tKmXdYc6VTu3TWZsInayEKPbiyW+P6vmmIrrb4I6CGX0BFoewgYHLK+oIL5FECEK02REYRpBvUCw==", - "license": "MIT", - "dependencies": { - "make-dir": "~3.1.0", - "mime": "~2.5.2", - "minimatch": "~3.0.4", - "xxhashjs": "~0.2.2" - }, - "engines": { - "node": ">=10" - }, - "peerDependencies": { - "postcss": "^8.0.0" - } - }, - "node_modules/postcss-url/node_modules/make-dir": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz", - "integrity": "sha512-g3FeP20LNwhALb/6Cz6Dd4F2ngze0jz7tbzrD2wAV+o9FeNHe4rL+yK2md0J/fiSf1sa1ADhXqi5+oVwOM/eGw==", - "license": "MIT", - "dependencies": { - "semver": "^6.0.0" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/postcss-url/node_modules/minimatch": { - "version": "3.0.8", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.8.tgz", - "integrity": "sha512-6FsRAQsxQ61mw+qP1ZzbL9Bc78x2p5OqNgNpnoAFLTrX8n5Kxph0CsnhmKKNXTWjXqU5L0pGPR7hYk+XWZr60Q==", - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" + "postcss": "^8.5.13" } }, "node_modules/postcss-value-parser": { @@ -13285,9 +15246,9 @@ } }, "node_modules/prettier": { - "version": "3.8.1", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.8.1.tgz", - "integrity": "sha512-UOnG6LftzbdaHZcKoPFtOcCKztrQ57WkHDeRD9t/PTQtmT0NHSeWWepj6pS0z/N7+08BHFDQVUrfmfMRcZwbMg==", + "version": "3.9.3", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.9.3.tgz", + "integrity": "sha512-HWmu+K+zvHNpaMfSnYeqdqrDbR16cuIXaPx8WoHaviQkDJh1/0BNtOZmHVQI5jc3wXv0H1yXc9wjvFdXh+n3hQ==", "license": "MIT", "bin": { "prettier": "bin/prettier.cjs" @@ -13299,18 +15260,6 @@ "url": "https://github.com/prettier/prettier?sponsor=1" } }, - "node_modules/prettier-linter-helpers": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/prettier-linter-helpers/-/prettier-linter-helpers-1.0.1.tgz", - "integrity": "sha512-SxToR7P8Y2lWmv/kTzVLC1t/GDI2WGjMwNhLLE9qtH8Q13C+aEmuRlzDst4Up4s0Wc8sF2M+J57iB3cMLqftfg==", - "license": "MIT", - "dependencies": { - "fast-diff": "^1.1.2" - }, - "engines": { - "node": ">=6.0.0" - } - }, "node_modules/pretty-bytes": { "version": "5.6.0", "resolved": "https://registry.npmjs.org/pretty-bytes/-/pretty-bytes-5.6.0.tgz", @@ -13323,32 +15272,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/pretty-format": { - "version": "27.5.1", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-27.5.1.tgz", - "integrity": "sha512-Qb1gy5OrP5+zDf2Bvnzdl3jsTf1qXVMazbvCoKhtKqVs4/YK4ozX4gKQJJVyNe+cajNPn0KoC0MC3FUmaHWEmQ==", - "license": "MIT", - "dependencies": { - "ansi-regex": "^5.0.1", - "ansi-styles": "^5.0.0", - "react-is": "^17.0.1" - }, - "engines": { - "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" - } - }, - "node_modules/pretty-format/node_modules/ansi-styles": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz", - "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==", - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, "node_modules/proto-list": { "version": "1.2.4", "resolved": "https://registry.npmjs.org/proto-list/-/proto-list-1.2.4.tgz", @@ -13356,16 +15279,19 @@ "license": "ISC" }, "node_modules/protocol-buffers-schema": { - "version": "3.6.0", - "resolved": "https://registry.npmjs.org/protocol-buffers-schema/-/protocol-buffers-schema-3.6.0.tgz", - "integrity": "sha512-TdDRD+/QNdrCGCE7v8340QyuXd4kIWIgapsE2+n/SaGiSSbomYl4TjHlvIoCWRpE7wFt02EpB35VVA2ImcBVqw==", + "version": "3.6.1", + "resolved": "https://registry.npmjs.org/protocol-buffers-schema/-/protocol-buffers-schema-3.6.1.tgz", + "integrity": "sha512-VG2K63Igkiv9p76tk1lilczEK1cT+kCjKtkdhw1dQZV3k3IXJbd3o6Ho8b9zJZaHSnT2hKe4I+ObmX9w6m5SmQ==", "license": "MIT" }, "node_modules/proxy-from-env": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.1.0.tgz", - "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==", - "license": "MIT" + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-2.1.0.tgz", + "integrity": "sha512-cJ+oHTW1VAEa8cJslgmUZrc+sjRKgAKl3Zyse6+PV38hZe/V6Z14TbCuXcan9F9ghlz4QrFr2c92TNF82UkYHA==", + "license": "MIT", + "engines": { + "node": ">=10" + } }, "node_modules/pubsub-js": { "version": "1.9.5", @@ -13415,53 +15341,6 @@ "integrity": "sha512-XdjUArbK4Bm5fLLvlm5KpTFOiOThgfWWI4axAZDWg4E/0mKdZyI9tNEfds27qCi1ze/vwTR16kvmmGhRra3c2g==", "license": "ISC" }, - "node_modules/randombytes": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/randombytes/-/randombytes-2.1.0.tgz", - "integrity": "sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ==", - "license": "MIT", - "dependencies": { - "safe-buffer": "^5.1.0" - } - }, - "node_modules/react": { - "version": "19.2.4", - "resolved": "https://registry.npmjs.org/react/-/react-19.2.4.tgz", - "integrity": "sha512-9nfp2hYpCwOjAN+8TZFGhtWEwgvWHXqESH8qT89AT/lWklpLON22Lc8pEtnpsZz7VmawabSU0gCjnj8aC0euHQ==", - "license": "MIT", - "peer": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/react-dom": { - "version": "19.2.4", - "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-19.2.4.tgz", - "integrity": "sha512-AXJdLo8kgMbimY95O2aKQqsz2iWi9jMgKJhRBAxECE4IFxfcazB2LmzloIoibJI3C12IlY20+KFaLv+71bUJeQ==", - "license": "MIT", - "peer": true, - "dependencies": { - "scheduler": "^0.27.0" - }, - "peerDependencies": { - "react": "^19.2.4" - } - }, - "node_modules/react-is": { - "version": "17.0.2", - "resolved": "https://registry.npmjs.org/react-is/-/react-is-17.0.2.tgz", - "integrity": "sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==", - "license": "MIT" - }, - "node_modules/react-refresh": { - "version": "0.18.0", - "resolved": "https://registry.npmjs.org/react-refresh/-/react-refresh-0.18.0.tgz", - "integrity": "sha512-QgT5//D3jfjJb6Gsjxv0Slpj23ip+HtOpnNgnb2S5zU3CB26G/IDPGoy4RJB42wzFE46DRsstbW6tKHoKbhAxw==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/read-cache": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/read-cache/-/read-cache-1.0.0.tgz", @@ -13494,9 +15373,9 @@ } }, "node_modules/readdirp/node_modules/picomatch": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.2.tgz", + "integrity": "sha512-V7+vQEJ06Z+c5tSye8S+nHUfI51xoXIXjHQ99cQtKUkQqqO1kO/KCJUfZXuB47h/YBlDhah2H3hdUGXn8ie0oA==", "license": "MIT", "optional": true, "engines": { @@ -13639,9 +15518,9 @@ "license": "MIT" }, "node_modules/regjsparser": { - "version": "0.13.0", - "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.13.0.tgz", - "integrity": "sha512-NZQZdC5wOE/H3UT28fVGL+ikOZcEzfMGk/c3iN9UGxzWHMa1op7274oyiUVrAG4B2EuFhus8SvkaYnhvW92p9Q==", + "version": "0.13.2", + "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.13.2.tgz", + "integrity": "sha512-NgRBy2Nx/bE+9F27nVHnqcN5HjyLmecqsqx2PJHu3/IEtADD4WuxuXIVExD5PoSDFVrl78dOonfcOe5O+5nbzQ==", "license": "BSD-2-Clause", "dependencies": { "jsesc": "~3.1.0" @@ -13675,11 +15554,12 @@ } }, "node_modules/resolve": { - "version": "1.22.11", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.11.tgz", - "integrity": "sha512-RfqAvLnMl313r7c9oclB1HhUEAezcpLjz95wFH4LVuhk9JF/r22qmVP9AMmOU4vMX7Q8pN8jwNg/CSpdFnMjTQ==", + "version": "1.22.12", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.12.tgz", + "integrity": "sha512-TyeJ1zif53BPfHootBGwPRYT1RUt6oGWsaQr8UyZW/eAm9bKoijtvruSDEmZHm92CwS9nj7/fWttqPCgzep8CA==", "license": "MIT", "dependencies": { + "es-errors": "^1.3.0", "is-core-module": "^2.16.1", "path-parse": "^1.0.7", "supports-preserve-symlinks-flag": "^1.0.0" @@ -13706,7 +15586,7 @@ "node": ">=8" } }, - "node_modules/resolve-from": { + "node_modules/resolve-cwd/node_modules/resolve-from": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-5.0.0.tgz", "integrity": "sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw==", @@ -13715,6 +15595,15 @@ "node": ">=8" } }, + "node_modules/resolve-from": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", + "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, "node_modules/resolve-protobuf-schema": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/resolve-protobuf-schema/-/resolve-protobuf-schema-2.1.0.tgz", @@ -13746,13 +15635,46 @@ "integrity": "sha512-ASFBup0Mz1uyiIjANan1jzLQami9z1PoYSZCiiYW2FczPbenXc45FZdBZLzOT+r6+iciuEModtmCti+hjaAk0A==", "license": "MIT" }, - "node_modules/rollup": { - "version": "4.59.0", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.59.0.tgz", - "integrity": "sha512-2oMpl67a3zCH9H79LeMcbDhXW/UmWG/y2zuqnF2jQq5uq9TbM9TVyXvA4+t+ne2IIkBdrLpAaRQAvo7YI/Yyeg==", + "node_modules/rolldown": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/rolldown/-/rolldown-1.1.3.tgz", + "integrity": "sha512-1F1eEtUBtFvcGm1HQ9TiUIUHPQG7mSAODrhIzjxoUEFuo8OcbrGLiVLkevNgj84TE4lnHvnumwFjhJO5Eu135g==", "license": "MIT", "dependencies": { - "@types/estree": "1.0.8" + "@oxc-project/types": "=0.137.0", + "@rolldown/pluginutils": "^1.0.0" + }, + "bin": { + "rolldown": "bin/cli.mjs" + }, + "engines": { + "node": "^20.19.0 || >=22.12.0" + }, + "optionalDependencies": { + "@rolldown/binding-android-arm64": "1.1.3", + "@rolldown/binding-darwin-arm64": "1.1.3", + "@rolldown/binding-darwin-x64": "1.1.3", + "@rolldown/binding-freebsd-x64": "1.1.3", + "@rolldown/binding-linux-arm-gnueabihf": "1.1.3", + "@rolldown/binding-linux-arm64-gnu": "1.1.3", + "@rolldown/binding-linux-arm64-musl": "1.1.3", + "@rolldown/binding-linux-ppc64-gnu": "1.1.3", + "@rolldown/binding-linux-s390x-gnu": "1.1.3", + "@rolldown/binding-linux-x64-gnu": "1.1.3", + "@rolldown/binding-linux-x64-musl": "1.1.3", + "@rolldown/binding-openharmony-arm64": "1.1.3", + "@rolldown/binding-wasm32-wasi": "1.1.3", + "@rolldown/binding-win32-arm64-msvc": "1.1.3", + "@rolldown/binding-win32-x64-msvc": "1.1.3" + } + }, + "node_modules/rollup": { + "version": "4.62.2", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.62.2.tgz", + "integrity": "sha512-RFnrW4lhXA3s3eqHDZvN654g8OTjzRfqpIRJYczCGB6HzphckVAi/Qh4tbPUbRuDi7s1Llv8g/NspLkttY3gTA==", + "license": "MIT", + "dependencies": { + "@types/estree": "1.0.9" }, "bin": { "rollup": "dist/bin/rollup" @@ -13762,55 +15684,43 @@ "npm": ">=8.0.0" }, "optionalDependencies": { - "@rollup/rollup-android-arm-eabi": "4.59.0", - "@rollup/rollup-android-arm64": "4.59.0", - "@rollup/rollup-darwin-arm64": "4.59.0", - "@rollup/rollup-darwin-x64": "4.59.0", - "@rollup/rollup-freebsd-arm64": "4.59.0", - "@rollup/rollup-freebsd-x64": "4.59.0", - "@rollup/rollup-linux-arm-gnueabihf": "4.59.0", - "@rollup/rollup-linux-arm-musleabihf": "4.59.0", - "@rollup/rollup-linux-arm64-gnu": "4.59.0", - "@rollup/rollup-linux-arm64-musl": "4.59.0", - "@rollup/rollup-linux-loong64-gnu": "4.59.0", - "@rollup/rollup-linux-loong64-musl": "4.59.0", - "@rollup/rollup-linux-ppc64-gnu": "4.59.0", - "@rollup/rollup-linux-ppc64-musl": "4.59.0", - "@rollup/rollup-linux-riscv64-gnu": "4.59.0", - "@rollup/rollup-linux-riscv64-musl": "4.59.0", - "@rollup/rollup-linux-s390x-gnu": "4.59.0", - "@rollup/rollup-linux-x64-gnu": "4.59.0", - "@rollup/rollup-linux-x64-musl": "4.59.0", - "@rollup/rollup-openbsd-x64": "4.59.0", - "@rollup/rollup-openharmony-arm64": "4.59.0", - "@rollup/rollup-win32-arm64-msvc": "4.59.0", - "@rollup/rollup-win32-ia32-msvc": "4.59.0", - "@rollup/rollup-win32-x64-gnu": "4.59.0", - "@rollup/rollup-win32-x64-msvc": "4.59.0", + "@rollup/rollup-android-arm-eabi": "4.62.2", + "@rollup/rollup-android-arm64": "4.62.2", + "@rollup/rollup-darwin-arm64": "4.62.2", + "@rollup/rollup-darwin-x64": "4.62.2", + "@rollup/rollup-freebsd-arm64": "4.62.2", + "@rollup/rollup-freebsd-x64": "4.62.2", + "@rollup/rollup-linux-arm-gnueabihf": "4.62.2", + "@rollup/rollup-linux-arm-musleabihf": "4.62.2", + "@rollup/rollup-linux-arm64-gnu": "4.62.2", + "@rollup/rollup-linux-arm64-musl": "4.62.2", + "@rollup/rollup-linux-loong64-gnu": "4.62.2", + "@rollup/rollup-linux-loong64-musl": "4.62.2", + "@rollup/rollup-linux-ppc64-gnu": "4.62.2", + "@rollup/rollup-linux-ppc64-musl": "4.62.2", + "@rollup/rollup-linux-riscv64-gnu": "4.62.2", + "@rollup/rollup-linux-riscv64-musl": "4.62.2", + "@rollup/rollup-linux-s390x-gnu": "4.62.2", + "@rollup/rollup-linux-x64-gnu": "4.62.2", + "@rollup/rollup-linux-x64-musl": "4.62.2", + "@rollup/rollup-openbsd-x64": "4.62.2", + "@rollup/rollup-openharmony-arm64": "4.62.2", + "@rollup/rollup-win32-arm64-msvc": "4.62.2", + "@rollup/rollup-win32-ia32-msvc": "4.62.2", + "@rollup/rollup-win32-x64-gnu": "4.62.2", + "@rollup/rollup-win32-x64-msvc": "4.62.2", "fsevents": "~2.3.2" } }, - "node_modules/rrweb-cssom": { - "version": "0.8.0", - "resolved": "https://registry.npmjs.org/rrweb-cssom/-/rrweb-cssom-0.8.0.tgz", - "integrity": "sha512-guoltQEx+9aMf2gDZ0s62EcV8lsXR+0w8915TC3ITdn2YueuNjdAYh/levpU9nFaoChh9RUS5ZdQMrKfVEN9tw==", - "license": "MIT" - }, - "node_modules/rw": { - "version": "1.3.3", - "resolved": "https://registry.npmjs.org/rw/-/rw-1.3.3.tgz", - "integrity": "sha512-PdhdWy89SiZogBLaw42zdeqtRJ//zFd2PgQavcICDUgJT5oW10QCRKbJ6bg4r0/UY2M6BWd5tkxuGFRvCkgfHQ==", - "license": "BSD-3-Clause" - }, "node_modules/safe-array-concat": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.1.3.tgz", - "integrity": "sha512-AURm5f0jYEOydBj7VQlVvDrjeFgthDdEF5H1dP+6mNpoXOMo1quQqJ4wvJDyRZ9+pO3kGWoOdmV08cSv2aJV6Q==", + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.1.4.tgz", + "integrity": "sha512-wtZlHyOje6OZTGqAoaDKxFkgRtkF9CnHAVnCHKfuj200wAgL+bSJhdsCD2l0Qx/2ekEXjPWcyKkfGb5CPboslg==", "license": "MIT", "dependencies": { - "call-bind": "^1.0.8", - "call-bound": "^1.0.2", - "get-intrinsic": "^1.2.6", + "call-bind": "^1.0.9", + "call-bound": "^1.0.4", + "get-intrinsic": "^1.3.0", "has-symbols": "^1.1.0", "isarray": "^2.0.5" }, @@ -13821,26 +15731,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/safe-buffer": { - "version": "5.2.1", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", - "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT" - }, "node_modules/safe-push-apply": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/safe-push-apply/-/safe-push-apply-1.0.0.tgz", @@ -13874,22 +15764,17 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/safer-buffer": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", - "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", - "license": "MIT" - }, "node_modules/sanitize-html": { - "version": "2.17.1", - "resolved": "https://registry.npmjs.org/sanitize-html/-/sanitize-html-2.17.1.tgz", - "integrity": "sha512-ehFCW+q1a4CSOWRAdX97BX/6/PDEkCqw7/0JXZAGQV57FQB3YOkTa/rrzHPeJ+Aghy4vZAFfWMYyfxIiB7F/gw==", + "version": "2.17.5", + "resolved": "https://registry.npmjs.org/sanitize-html/-/sanitize-html-2.17.5.tgz", + "integrity": "sha512-ZmU1joGRrvoyctKIiuwUxqR6moLoU2Wk+2bMccN6f7UwhAmwYDvWziqPxRDDN2Qip62NqnIrVrT9akbL6Wretg==", "license": "MIT", "dependencies": { "deepmerge": "^4.2.2", "escape-string-regexp": "^4.0.0", - "htmlparser2": "^8.0.0", + "htmlparser2": "^10.1.0", "is-plain-object": "^5.0.0", + "launder": "^1.7.1", "parse-srcset": "^1.0.2", "postcss": "^8.3.11" } @@ -13904,29 +15789,29 @@ } }, "node_modules/sass": { - "version": "1.97.3", - "resolved": "https://registry.npmjs.org/sass/-/sass-1.97.3.tgz", - "integrity": "sha512-fDz1zJpd5GycprAbu4Q2PV/RprsRtKC/0z82z0JLgdytmcq0+ujJbJ/09bPGDxCLkKY3Np5cRAOcWiVkLXJURg==", + "version": "1.101.0", + "resolved": "https://registry.npmjs.org/sass/-/sass-1.101.0.tgz", + "integrity": "sha512-OL3GoQyoUdDt843DpVmDO6y2k1sc5IhUDSpu8XucEI+35neq5QivZ1iuegnpraEVTJXlQGK1gl27zKcTLEPbQw==", "license": "MIT", "dependencies": { - "chokidar": "^4.0.0", - "immutable": "^5.0.2", + "chokidar": "^5.0.0", + "immutable": "^5.1.5", "source-map-js": ">=0.6.2 <2.0.0" }, "bin": { "sass": "sass.js" }, "engines": { - "node": ">=14.0.0" + "node": ">=20.19.0" }, "optionalDependencies": { "@parcel/watcher": "^2.4.1" } }, "node_modules/sass-loader": { - "version": "16.0.7", - "resolved": "https://registry.npmjs.org/sass-loader/-/sass-loader-16.0.7.tgz", - "integrity": "sha512-w6q+fRHourZ+e+xA1kcsF27iGM6jdB8teexYCfdUw0sYgcDNeZESnDNT9sUmmPm3ooziwUJXGwZJSTF3kOdBfA==", + "version": "16.0.8", + "resolved": "https://registry.npmjs.org/sass-loader/-/sass-loader-16.0.8.tgz", + "integrity": "sha512-hcov4ZwZJIGbEuyNr9EmiTmZueyrxSToE6GOzoZnq5JM7ecRO7ttyvilPn+VmRsqiP16+VYZzVnGZj/hzZgKBA==", "license": "MIT", "dependencies": { "neo-async": "^2.6.2" @@ -13964,27 +15849,27 @@ } }, "node_modules/sass/node_modules/chokidar": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-4.0.3.tgz", - "integrity": "sha512-Qgzu8kfBvo+cA4962jnP1KkS6Dop5NS6g7R5LFYJr4b8Ub94PPQXUksCw9PvXoeXPRRddRNC5C1JQUR2SMGtnA==", + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-5.0.0.tgz", + "integrity": "sha512-TQMmc3w+5AxjpL8iIiwebF73dRDF4fBIieAqGn9RGCWaEVwQ6Fb2cGe31Yns0RRIzii5goJ1Y7xbMwo1TxMplw==", "license": "MIT", "dependencies": { - "readdirp": "^4.0.1" + "readdirp": "^5.0.0" }, "engines": { - "node": ">= 14.16.0" + "node": ">= 20.19.0" }, "funding": { "url": "https://paulmillr.com/funding/" } }, "node_modules/sass/node_modules/readdirp": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-4.1.2.tgz", - "integrity": "sha512-GDhwkLfywWL2s6vEjyhri+eXmfH6j1L7JE27WhqLeYzoh/A3DBaYGEj2H/HFZCn/kMfim73FXxEJTw06WtxQwg==", + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-5.0.0.tgz", + "integrity": "sha512-9u/XQ1pvrQtYyMpZe7DXKv2p5CNvyVwzUB6uhLAnQwHMSgKMBR62lc7AHljaeteeHXn11XTAaLLUVZYVZyuRBQ==", "license": "MIT", "engines": { - "node": ">= 14.18.0" + "node": ">= 20.19.0" }, "funding": { "type": "individual", @@ -13992,9 +15877,9 @@ } }, "node_modules/sax": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/sax/-/sax-1.5.0.tgz", - "integrity": "sha512-21IYA3Q5cQf089Z6tgaUTr7lDAyzoTPx5HRtbhsME8Udispad8dC/+sziTNugOEx54ilvatQ9YCzl4KQLPcRHA==", + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/sax/-/sax-1.6.0.tgz", + "integrity": "sha512-6R3J5M4AcbtLUdZmRv2SygeVaM7IhrLXu9BmnOGmmACak8fiUtOsYNWUS4uK7upbmHIBbLBeFeI//477BKLBzA==", "license": "BlueOak-1.0.0", "engines": { "node": ">=11.0.0" @@ -14012,13 +15897,6 @@ "node": ">=v12.22.7" } }, - "node_modules/scheduler": { - "version": "0.27.0", - "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.27.0.tgz", - "integrity": "sha512-eNv+WrVbKu1f3vbYJT/xtiF5syA5HPIMtf9IgY/nKg0sWqzAUEvqY/xm7OcZc/qafLx/iO9FgOmeSAp4v5ti/Q==", - "license": "MIT", - "peer": true - }, "node_modules/schema-utils": { "version": "4.3.3", "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-4.3.3.tgz", @@ -14039,9 +15917,9 @@ } }, "node_modules/schema-utils/node_modules/ajv": { - "version": "8.18.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.18.0.tgz", - "integrity": "sha512-PlXPeEWMXMZ7sPYOHqmDyCJzcfNrUr3fGNKtezX14ykXOEIvyK81d+qydx89KY5O71FKMPaQ2vBfBFI5NHR63A==", + "version": "8.20.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.20.0.tgz", + "integrity": "sha512-Thbli+OlOj+iMPYFBVBfJ3OmCAnaSyNn4M1vz9T6Gka5Jt9ba/HIR56joy65tY6kx/FCF5VXNB819Y7/GUrBGA==", "license": "MIT", "dependencies": { "fast-deep-equal": "^3.1.3", @@ -14082,12 +15960,12 @@ } }, "node_modules/serialize-javascript": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-6.0.2.tgz", - "integrity": "sha512-Saa1xPByTTq2gdeFZYLLo+RFE35NHZkAbqZeWNd3BpzppeVisAqpDjcp8dyf6uIvEqJRd46jemmyA4iFIeVk8g==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-7.0.6.tgz", + "integrity": "sha512-ATTK5Q4gFVg0YDp1my2vqygyvhcklD/UV5GIlYHooGTn/NogJqIzpetkD6E5kmuVULqz/S9inUL25XcAgDRJQg==", "license": "BSD-3-Clause", - "dependencies": { - "randombytes": "^2.1.0" + "engines": { + "node": ">=20.0.0" } }, "node_modules/set-function-length": { @@ -14170,14 +16048,14 @@ } }, "node_modules/side-channel": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", - "integrity": "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.1.tgz", + "integrity": "sha512-6x6dK6zJdpTzF4sQeNYxwtvBzf6Eg4GtlesS94HOvTudUeyK2WXAaIfmDgsyslYrRBeFIlsi54AYsFGUuhmvrQ==", "license": "MIT", "dependencies": { "es-errors": "^1.3.0", - "object-inspect": "^1.13.3", - "side-channel-list": "^1.0.0", + "object-inspect": "^1.13.4", + "side-channel-list": "^1.0.1", "side-channel-map": "^1.0.1", "side-channel-weakmap": "^1.0.2" }, @@ -14189,13 +16067,13 @@ } }, "node_modules/side-channel-list": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.0.tgz", - "integrity": "sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA==", + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.1.tgz", + "integrity": "sha512-mjn/0bi/oUURjc5Xl7IaWi/OJJJumuoJFQJfDDyO46+hBWsfaVM65TBHq2eoZBhzl9EchxOijpkbRC8SVBQU0w==", "license": "MIT", "dependencies": { "es-errors": "^1.3.0", - "object-inspect": "^1.13.3" + "object-inspect": "^1.13.4" }, "engines": { "node": ">= 0.4" @@ -14283,9 +16161,9 @@ } }, "node_modules/smob": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/smob/-/smob-1.6.1.tgz", - "integrity": "sha512-KAkBqZl3c2GvNgNhcoyJae1aKldDW0LO279wF9bk1PnluRTETKBq0WyzRXxEhoQLk56yHaOY4JCBEKDuJIET5g==", + "version": "1.6.2", + "resolved": "https://registry.npmjs.org/smob/-/smob-1.6.2.tgz", + "integrity": "sha512-RQsvleCbF8cVHEv+xuDGaA4pOizFqJ0GgjtMSRo6oP8pnN7WsigHgVGey6aILRBKv4W2YOMHLqbKdnB6hpB9fw==", "license": "MIT", "engines": { "node": ">=20.0.0" @@ -14331,19 +16209,6 @@ "source-map": "^0.6.0" } }, - "node_modules/sourcemap-codec": { - "version": "1.4.8", - "resolved": "https://registry.npmjs.org/sourcemap-codec/-/sourcemap-codec-1.4.8.tgz", - "integrity": "sha512-9NykojV5Uih4lgo5So5dtw+f0JgJX30KCNI8gwhz2J9A15wD0Ml6tjHKwf6fTSa6fAdVBdZeNOs9eJ71qCk8vA==", - "deprecated": "Please use @jridgewell/sourcemap-codec instead", - "license": "MIT" - }, - "node_modules/sprintf-js": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", - "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==", - "license": "BSD-3-Clause" - }, "node_modules/stackback": { "version": "0.0.2", "resolved": "https://registry.npmjs.org/stackback/-/stackback-0.0.2.tgz", @@ -14351,9 +16216,9 @@ "license": "MIT" }, "node_modules/std-env": { - "version": "3.10.0", - "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.10.0.tgz", - "integrity": "sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg==", + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/std-env/-/std-env-4.2.0.tgz", + "integrity": "sha512-oCUKSupKTHX53EyjDtuZQ64pjLJ6yYCtpmEw0goYxtjG9KpbRe8KAsl2tBUGU9DyMcJ0RwJ8GqJAFzMXcXW1Rw==", "license": "MIT" }, "node_modules/stop-iteration-iterator": { @@ -14401,6 +16266,15 @@ "node": ">=8" } }, + "node_modules/string-width-cjs/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, "node_modules/string-width-cjs/node_modules/emoji-regex": { "version": "8.0.0", "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", @@ -14447,18 +16321,19 @@ } }, "node_modules/string.prototype.trim": { - "version": "1.2.10", - "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.2.10.tgz", - "integrity": "sha512-Rs66F0P/1kedk5lyYyH9uBzuiI/kNRmwJAR9quK6VOtIpZ2G+hMZd+HQbbv25MgCA6gEffoMZYxlTod4WcdrKA==", + "version": "1.2.11", + "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.2.11.tgz", + "integrity": "sha512-PwvK7BU+CMTJGYQCTZb5RWXIML92lftJLhQz1tBzgKiqGxJaMlBAa48POXaNAC2s4y8jr3EFqrkF9+44neS46w==", "license": "MIT", "dependencies": { - "call-bind": "^1.0.8", - "call-bound": "^1.0.2", + "call-bind": "^1.0.9", + "call-bound": "^1.0.4", "define-data-property": "^1.1.4", "define-properties": "^1.2.1", - "es-abstract": "^1.23.5", - "es-object-atoms": "^1.0.0", - "has-property-descriptors": "^1.0.2" + "es-abstract": "^1.24.2", + "es-object-atoms": "^1.1.2", + "has-property-descriptors": "^1.0.2", + "safe-regex-test": "^1.1.0" }, "engines": { "node": ">= 0.4" @@ -14468,15 +16343,15 @@ } }, "node_modules/string.prototype.trimend": { - "version": "1.0.9", - "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.9.tgz", - "integrity": "sha512-G7Ok5C6E/j4SGfyLCloXTrngQIQU3PWtXGst3yM7Bea9FRURf1S42ZHlZZtsNque2FN2PoUhfZXYLNWwEr4dLQ==", + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.10.tgz", + "integrity": "sha512-2+3aDAOmPTmuFwjDnmJG2ctEkQKVki7vOSqaxkv42Mowj1V6PnvuwFCRrR5lChUux1TBskPjfkeTOhqczDMxTw==", "license": "MIT", "dependencies": { - "call-bind": "^1.0.8", - "call-bound": "^1.0.2", + "call-bind": "^1.0.9", + "call-bound": "^1.0.4", "define-properties": "^1.2.1", - "es-object-atoms": "^1.0.0" + "es-object-atoms": "^1.1.2" }, "engines": { "node": ">= 0.4" @@ -14544,16 +16419,13 @@ "node": ">=8" } }, - "node_modules/strip-ansi/node_modules/ansi-regex": { - "version": "6.2.2", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", - "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", + "node_modules/strip-ansi-cjs/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", "license": "MIT", "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-regex?sponsor=1" + "node": ">=8" } }, "node_modules/strip-bom": { @@ -14598,24 +16470,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/strip-literal": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/strip-literal/-/strip-literal-3.1.0.tgz", - "integrity": "sha512-8r3mkIM/2+PpjHoOtiAW8Rg3jJLHaV7xPwG+YRGrv6FP0wwk/toTpATxWYOW0BKdWwl82VT2tFYi5DlROa0Mxg==", - "license": "MIT", - "dependencies": { - "js-tokens": "^9.0.1" - }, - "funding": { - "url": "https://github.com/sponsors/antfu" - } - }, - "node_modules/strip-literal/node_modules/js-tokens": { - "version": "9.0.1", - "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-9.0.1.tgz", - "integrity": "sha512-mxa9E9ITFOt0ban3j6L5MpjwegGz6lBQmM1IJkWeBZGcMxto50+eWdjC/52xDbS2vy0k7vIMK0Fe2wfL9OQSpQ==", - "license": "MIT" - }, "node_modules/style-loader": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/style-loader/-/style-loader-4.0.0.tgz", @@ -14633,28 +16487,19 @@ } }, "node_modules/stylehacks": { - "version": "7.0.7", - "resolved": "https://registry.npmjs.org/stylehacks/-/stylehacks-7.0.7.tgz", - "integrity": "sha512-bJkD0JkEtbRrMFtwgpJyBbFIwfDDONQ1Ov3sDLZQP8HuJ73kBOyx66H4bOcAbVWmnfLdvQ0AJwXxOMkpujcO6g==", + "version": "7.0.11", + "resolved": "https://registry.npmjs.org/stylehacks/-/stylehacks-7.0.11.tgz", + "integrity": "sha512-iODNfhXVLqc5LADs+Y6Oh5wJuK5ZcHbVng8aiK3y9pjMQdc5hLrBW0eFU6FtnpNrE6PoEg/MmFTU4waotj5WNg==", "license": "MIT", "dependencies": { - "browserslist": "^4.27.0", - "postcss-selector-parser": "^7.1.0" + "browserslist": "^4.28.2", + "postcss-selector-parser": "^7.1.1" }, "engines": { "node": "^18.12.0 || ^20.9.0 || >=22.0" }, "peerDependencies": { - "postcss": "^8.4.32" - } - }, - "node_modules/supercluster": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/supercluster/-/supercluster-8.0.1.tgz", - "integrity": "sha512-IiOea5kJ9iqzD2t7QJq/cREyLHTtSmUT6gQsweojg9WH2sYJqZK9SswTu6jrscO6D1G5v5vYZ9ru/eq85lXeZQ==", - "license": "ISC", - "dependencies": { - "kdbush": "^4.0.2" + "postcss": "^8.5.13" } }, "node_modules/supports-color": { @@ -14698,9 +16543,9 @@ } }, "node_modules/svg-url-loader": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/svg-url-loader/-/svg-url-loader-8.0.0.tgz", - "integrity": "sha512-5doSXvl18hY1fGsRLdhWAU5jgzgxJ06/gc/26cpuDnN0xOz1HmmfhkpL29SSrdIvhtxQ1UwGzmk7wTT/l48mKw==", + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/svg-url-loader/-/svg-url-loader-8.1.0.tgz", + "integrity": "sha512-8Mf5g0R44VSiTQnSXT6qCSHwCO3VwZAOcm+o0FB80wGGeZNDzKBPKc8gtfIbSfNPmnE8SHv/+e49vO2NVHEmKA==", "license": "MIT", "dependencies": { "file-loader": "~6.2.0" @@ -14713,9 +16558,9 @@ } }, "node_modules/svgo": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/svgo/-/svgo-4.0.0.tgz", - "integrity": "sha512-VvrHQ+9uniE+Mvx3+C9IEe/lWasXCU0nXMY2kZeLrHNICuRiC8uMPyM14UEaMOFA5mhyQqEkB02VoQ16n3DLaw==", + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/svgo/-/svgo-4.0.1.tgz", + "integrity": "sha512-XDpWUOPC6FEibaLzjfe0ucaV0YrOjYotGJO1WpF0Zd+n6ZGEQUsSugaoLq9QkEZtAfQIxT42UChcssDVPP3+/w==", "license": "MIT", "dependencies": { "commander": "^11.1.0", @@ -14724,7 +16569,7 @@ "css-what": "^6.1.0", "csso": "^5.0.5", "picocolors": "^1.1.1", - "sax": "^1.4.1" + "sax": "^1.5.0" }, "bin": { "svgo": "bin/svgo.js" @@ -14752,25 +16597,10 @@ "integrity": "sha512-9QNk5KwDF+Bvz+PyObkmSYjI5ksVUYtjW7AU22r2NKcfLJcXp96hkDWU3+XndOsUb+AQ9QhfzfCT2O+CNWT5Tw==", "license": "MIT" }, - "node_modules/synckit": { - "version": "0.11.12", - "resolved": "https://registry.npmjs.org/synckit/-/synckit-0.11.12.tgz", - "integrity": "sha512-Bh7QjT8/SuKUIfObSXNHNSK6WHo6J1tHCqJsuaFDP7gP0fkzSfTxI8y85JrppZ0h8l0maIgc2tfuZQ6/t3GtnQ==", - "license": "MIT", - "dependencies": { - "@pkgr/core": "^0.2.9" - }, - "engines": { - "node": "^14.18.0 || >=16.0.0" - }, - "funding": { - "url": "https://opencollective.com/synckit" - } - }, "node_modules/tapable": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.3.0.tgz", - "integrity": "sha512-g9ljZiwki/LfxmQADO3dEY1CbpmXT5Hm2fJ+QaGKwSXUylMybePR7/67YW7jOrrvjEgL1Fmz5kzyAjWVWLlucg==", + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.3.3.tgz", + "integrity": "sha512-uxc/zpqFg6x7C8vOE7lh6Lbda8eEL9zmVm/PLeTPBRhh1xCgdWaQ+J1CUieGpIfm2HdtsUpRv+HshiasBMcc6A==", "license": "MIT", "engines": { "node": ">=6" @@ -14781,9 +16611,9 @@ } }, "node_modules/tar": { - "version": "7.5.9", - "resolved": "https://registry.npmjs.org/tar/-/tar-7.5.9.tgz", - "integrity": "sha512-BTLcK0xsDh2+PUe9F6c2TlRp4zOOBMTkoQHQIWSIzI0R7KG46uEwq4OPk2W7bZcprBMsuaeFsqwYr7pjh6CuHg==", + "version": "7.5.19", + "resolved": "https://registry.npmjs.org/tar/-/tar-7.5.19.tgz", + "integrity": "sha512-4LeEWl96twnS2Q7Bz4MGqgazLqO+hJN63GZxXoIqh1T3VweYD997gbU1ItNsQafqqXTXd5WFyFdReLtwvRBNiw==", "license": "BlueOak-1.0.0", "dependencies": { "@isaacs/fs-minipass": "^4.0.0", @@ -14833,9 +16663,9 @@ } }, "node_modules/terser": { - "version": "5.46.0", - "resolved": "https://registry.npmjs.org/terser/-/terser-5.46.0.tgz", - "integrity": "sha512-jTwoImyr/QbOWFFso3YoU3ik0jBBDJ6JTOQiy/J2YxVJdZCc+5u7skhNwiOR3FQIygFqVUPHl7qbbxtjW2K3Qg==", + "version": "5.48.0", + "resolved": "https://registry.npmjs.org/terser/-/terser-5.48.0.tgz", + "integrity": "sha512-J/9An6vs9Us6wKRriSFXBWdRZapREHqFzdNUKk0pmu804EMR6dr6winwo7e5JDxN4xahxQsuysyYFwlwj4XN/Q==", "license": "BSD-2-Clause", "dependencies": { "@jridgewell/source-map": "^0.3.3", @@ -14851,15 +16681,14 @@ } }, "node_modules/terser-webpack-plugin": { - "version": "5.3.16", - "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.3.16.tgz", - "integrity": "sha512-h9oBFCWrq78NyWWVcSwZarJkZ01c2AyGrzs1crmHZO3QUg9D61Wu4NPjBy69n7JqylFF5y+CsUZYmYEIZ3mR+Q==", + "version": "5.6.1", + "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.6.1.tgz", + "integrity": "sha512-201R5j+sJpK8nFWwKVyNfZot8FaJbLZDq5evriVzbV1wDtSXDjRUDRfJzHpAaxFDMEhsZL1QkeqM61wgsS3KaQ==", "license": "MIT", "dependencies": { "@jridgewell/trace-mapping": "^0.3.25", "jest-worker": "^27.4.5", "schema-utils": "^4.3.0", - "serialize-javascript": "^6.0.2", "terser": "^5.31.1" }, "engines": { @@ -14873,12 +16702,39 @@ "webpack": "^5.1.0" }, "peerDependenciesMeta": { + "@minify-html/node": { + "optional": true + }, "@swc/core": { "optional": true }, + "@swc/css": { + "optional": true + }, + "@swc/html": { + "optional": true + }, + "clean-css": { + "optional": true + }, + "cssnano": { + "optional": true + }, + "csso": { + "optional": true + }, "esbuild": { "optional": true }, + "html-minifier-terser": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "postcss": { + "optional": true + }, "uglify-js": { "optional": true } @@ -14919,113 +16775,18 @@ "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", "license": "MIT" }, - "node_modules/test-exclude": { - "version": "7.0.2", - "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-7.0.2.tgz", - "integrity": "sha512-u9E6A+ZDYdp7a4WnarkXPZOx8Ilz46+kby6p1yZ8zsGTz9gYa6FIS7lj2oezzNKmtdyyJNNmmXDppga5GB7kSw==", - "license": "ISC", - "dependencies": { - "@istanbuljs/schema": "^0.1.2", - "glob": "^10.4.1", - "minimatch": "^10.2.2" - }, - "engines": { - "node": ">=18" - } - }, - "node_modules/test-exclude/node_modules/balanced-match": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-4.0.4.tgz", - "integrity": "sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA==", - "license": "MIT", - "engines": { - "node": "18 || 20 || >=22" - } - }, - "node_modules/test-exclude/node_modules/brace-expansion": { - "version": "5.0.4", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.4.tgz", - "integrity": "sha512-h+DEnpVvxmfVefa4jFbCf5HdH5YMDXRsmKflpf1pILZWRFlTbJpxeU55nJl4Smt5HQaGzg1o6RHFPJaOqnmBDg==", - "license": "MIT", - "dependencies": { - "balanced-match": "^4.0.2" - }, - "engines": { - "node": "18 || 20 || >=22" - } - }, - "node_modules/test-exclude/node_modules/glob": { - "version": "10.5.0", - "resolved": "https://registry.npmjs.org/glob/-/glob-10.5.0.tgz", - "integrity": "sha512-DfXN8DfhJ7NH3Oe7cFmu3NCu1wKbkReJ8TorzSAFbSKrlNaQSKfIzqYqVY8zlbs2NLBbWpRiU52GX2PbaBVNkg==", - "deprecated": "Old versions of glob are not supported, and contain widely publicized security vulnerabilities, which have been fixed in the current version. Please update. Support for old versions may be purchased (at exorbitant rates) by contacting i@izs.me", - "license": "ISC", - "dependencies": { - "foreground-child": "^3.1.0", - "jackspeak": "^3.1.2", - "minimatch": "^9.0.4", - "minipass": "^7.1.2", - "package-json-from-dist": "^1.0.0", - "path-scurry": "^1.11.1" - }, - "bin": { - "glob": "dist/esm/bin.mjs" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/test-exclude/node_modules/glob/node_modules/balanced-match": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", - "license": "MIT" - }, - "node_modules/test-exclude/node_modules/glob/node_modules/brace-expansion": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", - "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0" - } - }, - "node_modules/test-exclude/node_modules/glob/node_modules/minimatch": { - "version": "9.0.9", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.9.tgz", - "integrity": "sha512-OBwBN9AL4dqmETlpS2zasx+vTeWclWzkblfZk7KTA5j3jeOONz/tRCnZomUyvNg83wL5Zv9Ss6HMJXAgL8R2Yg==", - "license": "ISC", - "dependencies": { - "brace-expansion": "^2.0.2" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/test-exclude/node_modules/minimatch": { - "version": "10.2.4", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.2.4.tgz", - "integrity": "sha512-oRjTw/97aTBN0RHbYCdtF1MQfvusSIBQM0IZEgzl6426+8jSC0nF1a/GmnVLpfB9yyr6g6FTqWqiZVbxrtaCIg==", - "license": "BlueOak-1.0.0", - "dependencies": { - "brace-expansion": "^5.0.2" - }, - "engines": { - "node": "18 || 20 || >=22" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, "node_modules/thenby": { - "version": "1.3.4", - "resolved": "https://registry.npmjs.org/thenby/-/thenby-1.3.4.tgz", - "integrity": "sha512-89Gi5raiWA3QZ4b2ePcEwswC3me9JIg+ToSgtE0JWeCynLnLxNr/f9G+xfo9K+Oj4AFdom8YNJjibIARTJmapQ==", + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/thenby/-/thenby-1.4.1.tgz", + "integrity": "sha512-D5a/bO0KdalOE3q8MlrRmSxjbKZHT3MQmXkJP+r97Vw8MMwOZKOwUSEyTtK7eSMj2y0kyAjpYMRMZmmLw1FtNQ==", "license": "Apache-2.0" }, + "node_modules/three": { + "version": "0.184.0", + "resolved": "https://registry.npmjs.org/three/-/three-0.184.0.tgz", + "integrity": "sha512-wtTRjG92pM5eUg/KuUnHsqSAlPM296brTOcLgMRqEeylYTh/CdtvKUvCyyCQTzFuStieWxvZb8mVTMvdPyUpxg==", + "license": "MIT" + }, "node_modules/tinybench": { "version": "2.9.0", "resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.9.0.tgz", @@ -15033,19 +16794,22 @@ "license": "MIT" }, "node_modules/tinyexec": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-0.3.2.tgz", - "integrity": "sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==", - "license": "MIT" + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-1.2.4.tgz", + "integrity": "sha512-SHf/r48b7vOrjve9PxJo3MN5v5yuyjHvdUcrQffT3WXMUfnGmHDVbC4k3sHJaJTgZCwpUplIaAo5ANtMyp3YHg==", + "license": "MIT", + "engines": { + "node": ">=18" + } }, "node_modules/tinyglobby": { - "version": "0.2.15", - "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.15.tgz", - "integrity": "sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ==", + "version": "0.2.17", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.17.tgz", + "integrity": "sha512-wXR/dYpcqKmfWpEdZjiKJOwCNFndD0DMnrW/cYjVGttEkBfVgcLFHoNrlj47mjOVic9yyNu65alsgF4NQyTa2g==", "license": "MIT", "dependencies": { "fdir": "^6.5.0", - "picomatch": "^4.0.3" + "picomatch": "^4.0.4" }, "engines": { "node": ">=12.0.0" @@ -15054,15 +16818,6 @@ "url": "https://github.com/sponsors/SuperchupuDev" } }, - "node_modules/tinypool": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.1.1.tgz", - "integrity": "sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg==", - "license": "MIT", - "engines": { - "node": "^18.0.0 || >=20.0.0" - } - }, "node_modules/tinyqueue": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/tinyqueue/-/tinyqueue-3.0.0.tgz", @@ -15070,39 +16825,30 @@ "license": "ISC" }, "node_modules/tinyrainbow": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-2.0.0.tgz", - "integrity": "sha512-op4nsTR47R6p0vMUUoYl/a+ljLFVtlfaXkLQmqfLR1qHma1h/ysYk4hEXZ880bf2CYgTskvTa/e196Vd5dDQXw==", - "license": "MIT", - "engines": { - "node": ">=14.0.0" - } - }, - "node_modules/tinyspy": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/tinyspy/-/tinyspy-4.0.4.tgz", - "integrity": "sha512-azl+t0z7pw/z958Gy9svOTuzqIk6xq+NSheJzn5MMWtWTFywIacg2wUlzKFGtt3cthx0r2SxMK0yzJOR0IES7Q==", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-3.1.0.tgz", + "integrity": "sha512-Bf+ILmBgretUrdJxzXM0SgXLZ3XfiaUuOj/IKQHuTXip+05Xn+uyEYdVg0kYDipTBcLrCVyUzAPz7QmArb0mmw==", "license": "MIT", "engines": { "node": ">=14.0.0" } }, "node_modules/tldts": { - "version": "6.1.86", - "resolved": "https://registry.npmjs.org/tldts/-/tldts-6.1.86.tgz", - "integrity": "sha512-WMi/OQ2axVTf/ykqCQgXiIct+mSQDFdH2fkwhPwgEwvJ1kSzZRiinb0zF2Xb8u4+OqPChmyI6MEu4EezNJz+FQ==", + "version": "7.4.5", + "resolved": "https://registry.npmjs.org/tldts/-/tldts-7.4.5.tgz", + "integrity": "sha512-RfEzKWcq5fHUOFq7J3rl3Oz6ylKGtcHqUznzj4EcXsxLSIjJcvpbXAQtWGeJQ0xKnimR5e0Cn+cn9TssfMzm+g==", "license": "MIT", "dependencies": { - "tldts-core": "^6.1.86" + "tldts-core": "^7.4.5" }, "bin": { "tldts": "bin/cli.js" } }, "node_modules/tldts-core": { - "version": "6.1.86", - "resolved": "https://registry.npmjs.org/tldts-core/-/tldts-core-6.1.86.tgz", - "integrity": "sha512-Je6p7pkk+KMzMv2XXKmAE3McmolOQFdxkKw0R8EYNr7sELW46JqnNeTX8ybPiQgvg1ymCoF8LXs5fzFaZvJPTA==", + "version": "7.4.5", + "resolved": "https://registry.npmjs.org/tldts-core/-/tldts-core-7.4.5.tgz", + "integrity": "sha512-pGrwzZDvPwKe+7NNUqAunb6rqTfynr0VOUhCMdqbu5xlvNiszsAJygRzwvpVycdzejlbpY+SWJOn+s75Og7FEA==", "license": "MIT" }, "node_modules/to-regex-range": { @@ -15133,47 +16879,27 @@ } }, "node_modules/tough-cookie": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-5.1.2.tgz", - "integrity": "sha512-FVDYdxtnj0G6Qm/DhNPSb8Ju59ULcup3tuJxkFb5K8Bv2pUXILbf0xZWU8PX8Ov19OXljbUyveOFwRMwkXzO+A==", + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-6.0.1.tgz", + "integrity": "sha512-LktZQb3IeoUWB9lqR5EWTHgW/VTITCXg4D21M+lvybRVdylLrRMnqaIONLVb5mav8vM19m44HIcGq4qASeu2Qw==", "license": "BSD-3-Clause", "dependencies": { - "tldts": "^6.1.32" + "tldts": "^7.0.5" }, "engines": { "node": ">=16" } }, "node_modules/tr46": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/tr46/-/tr46-5.1.1.tgz", - "integrity": "sha512-hdF5ZgjTqgAntKkklYw0R03MG2x/bSzTtkxmIRw/sTNV8YXsCJ1tfLAX23lhxhHJlEf3CRCOCGGWw3vI3GaSPw==", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/tr46/-/tr46-6.0.0.tgz", + "integrity": "sha512-bLVMLPtstlZ4iMQHpFHTR7GAGj2jxi8Dg0s2h2MafAE4uSWF98FC/3MomU51iQAMf8/qDUbKWf5GxuvvVcXEhw==", "license": "MIT", "dependencies": { "punycode": "^2.3.1" }, "engines": { - "node": ">=18" - } - }, - "node_modules/tsconfck": { - "version": "3.1.6", - "resolved": "https://registry.npmjs.org/tsconfck/-/tsconfck-3.1.6.tgz", - "integrity": "sha512-ks6Vjr/jEw0P1gmOVwutM3B7fWxoWBL2KRDb1JfqGVawBmO5UsvmWOQFGHBPl5yxYz4eERr19E6L7NMv+Fej4w==", - "license": "MIT", - "bin": { - "tsconfck": "bin/tsconfck.js" - }, - "engines": { - "node": "^18 || >=20" - }, - "peerDependencies": { - "typescript": "^5.0.0" - }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } + "node": ">=20" } }, "node_modules/tsconfig-paths": { @@ -15285,17 +17011,17 @@ } }, "node_modules/typed-array-length": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/typed-array-length/-/typed-array-length-1.0.7.tgz", - "integrity": "sha512-3KS2b+kL7fsuk/eJZ7EQdnEmQoaho/r6KUef7hxvltNA5DR8NAUM+8wJMbJyZ4G9/7i3v5zPBIMN5aybAh2/Jg==", + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/typed-array-length/-/typed-array-length-1.0.8.tgz", + "integrity": "sha512-phPGCwqr2+Qo0fwniCE8e4pKnGu/yFb5nD5Y8bf0EEeiI5GklnACYA9GFy/DrAeRrKHXvHn+1SUsOWgJp6RO+g==", "license": "MIT", "dependencies": { - "call-bind": "^1.0.7", - "for-each": "^0.3.3", - "gopd": "^1.0.1", - "is-typed-array": "^1.1.13", - "possible-typed-array-names": "^1.0.0", - "reflect.getprototypeof": "^1.0.6" + "call-bind": "^1.0.9", + "for-each": "^0.3.5", + "gopd": "^1.2.0", + "is-typed-array": "^1.1.15", + "possible-typed-array-names": "^1.1.0", + "reflect.getprototypeof": "^1.0.10" }, "engines": { "node": ">= 0.4" @@ -15305,10 +17031,11 @@ } }, "node_modules/typescript": { - "version": "5.9.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", - "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-6.0.3.tgz", + "integrity": "sha512-y2TvuxSZPDyQakkFRPZHKFm+KKVqIisdg9/CZwm9ftvKXLP8NRWj38/ODjNbr43SsoXqNuAisEf1GdCxqWcdBw==", "license": "Apache-2.0", + "peer": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -15327,9 +17054,9 @@ } }, "node_modules/typescript-auto-import-cache/node_modules/semver": { - "version": "7.7.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", - "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", + "version": "7.8.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.5.tgz", + "integrity": "sha512-Y7/KDsb8LjooZpwaqGyulO6DQlksgCncchHGk+sZIY4SBvUocMBEFH5Ur1fI4dV+Jvl0w6cjvucaIi40puRioA==", "license": "ISC", "bin": { "semver": "bin/semver.js" @@ -15365,10 +17092,19 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/undici": { + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/undici/-/undici-7.28.0.tgz", + "integrity": "sha512-cRZYrTDwWznlnRiPjggAGxZXanty6M8RV1ff8Wm4LWXBp7/IG8v5DnOm74DtUBp9OONpK75YlPnIjQqX0dBDtA==", + "license": "MIT", + "engines": { + "node": ">=20.18.1" + } + }, "node_modules/undici-types": { - "version": "7.18.2", - "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.18.2.tgz", - "integrity": "sha512-AsuCzffGHJybSaRrmr5eHr81mwJU3kjw6M+uprWvCXiNeN9SOGwQ3Jn8jb8m3Z6izVgknn1R0FTCEAP2QrLY/w==", + "version": "8.3.0", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-8.3.0.tgz", + "integrity": "sha512-j375ScV60dom+YkPFIfTLcOiPxkN/buHz5GobjLhixFuANaNs3C9l4GmrWqejgXWJ7BbJcFYpTEUkS1Ge8bpZQ==", "license": "MIT" }, "node_modules/unicode-canonical-property-names-ecmascript": { @@ -15546,17 +17282,16 @@ "license": "MIT" }, "node_modules/vite": { - "version": "7.3.1", - "resolved": "https://registry.npmjs.org/vite/-/vite-7.3.1.tgz", - "integrity": "sha512-w+N7Hifpc3gRjZ63vYBXA56dvvRlNWRczTdmCBBa+CotUzAPf5b7YMdMR/8CQoeYE5LX3W4wj6RYTgonm1b9DA==", + "version": "8.1.3", + "resolved": "https://registry.npmjs.org/vite/-/vite-8.1.3.tgz", + "integrity": "sha512-Ds+gBRbj0lwRO2Y5hwnUBdxSwlAve9LeRyU4sNnAr0ewW0gWF0n5bgXgUzbgZ49MV9BVUAQUFYVcDUcilUExMA==", "license": "MIT", "dependencies": { - "esbuild": "^0.27.0", - "fdir": "^6.5.0", - "picomatch": "^4.0.3", - "postcss": "^8.5.6", - "rollup": "^4.43.0", - "tinyglobby": "^0.2.15" + "lightningcss": "^1.32.0", + "picomatch": "^4.0.4", + "postcss": "^8.5.16", + "rolldown": "~1.1.3", + "tinyglobby": "^0.2.17" }, "bin": { "vite": "bin/vite.js" @@ -15572,9 +17307,10 @@ }, "peerDependencies": { "@types/node": "^20.19.0 || >=22.12.0", + "@vitejs/devtools": "^0.3.0", + "esbuild": "^0.27.0 || ^0.28.0", "jiti": ">=1.21.0", "less": "^4.0.0", - "lightningcss": "^1.21.0", "sass": "^1.70.0", "sass-embedded": "^1.70.0", "stylus": ">=0.54.8", @@ -15587,15 +17323,18 @@ "@types/node": { "optional": true }, + "@vitejs/devtools": { + "optional": true + }, + "esbuild": { + "optional": true + }, "jiti": { "optional": true }, "less": { "optional": true }, - "lightningcss": { - "optional": true - }, "sass": { "optional": true }, @@ -15619,106 +17358,79 @@ } } }, - "node_modules/vite-node": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-3.2.4.tgz", - "integrity": "sha512-EbKSKh+bh1E1IFxeO0pg1n4dvoOTt0UDiXMd/qn++r98+jPO1xtJilvXldeuQ8giIB5IkpjCgMleHMNEsGH6pg==", - "license": "MIT", - "dependencies": { - "cac": "^6.7.14", - "debug": "^4.4.1", - "es-module-lexer": "^1.7.0", - "pathe": "^2.0.3", - "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" - }, - "bin": { - "vite-node": "vite-node.mjs" - }, - "engines": { - "node": "^18.0.0 || ^20.0.0 || >=22.0.0" - }, - "funding": { - "url": "https://opencollective.com/vitest" - } - }, - "node_modules/vite-tsconfig-paths": { - "version": "5.1.4", - "resolved": "https://registry.npmjs.org/vite-tsconfig-paths/-/vite-tsconfig-paths-5.1.4.tgz", - "integrity": "sha512-cYj0LRuLV2c2sMqhqhGpaO3LretdtMn/BVX4cPLanIZuwwrkVl+lK84E/miEXkCHWXuq65rhNN4rXsBcOB3S4w==", - "license": "MIT", - "dependencies": { - "debug": "^4.1.1", - "globrex": "^0.1.2", - "tsconfck": "^3.0.3" - }, - "peerDependencies": { - "vite": "*" - }, - "peerDependenciesMeta": { - "vite": { - "optional": true - } - } - }, "node_modules/vitest": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.2.4.tgz", - "integrity": "sha512-LUCP5ev3GURDysTWiP47wRRUpLKMOfPh+yKTx3kVIEiu5KOMeqzpnYNsKyOoVrULivR8tLcks4+lga33Whn90A==", + "version": "4.1.10", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-4.1.10.tgz", + "integrity": "sha512-R9jUTe5S4Qb0HCd4TNqpC7oGcrMssMRGXLW80ubjWsW9VH5GF8y1Y0SFLY9AbqSk6nt0PnOx4H4WNJYZ13GUPw==", "license": "MIT", "dependencies": { - "@types/chai": "^5.2.2", - "@vitest/expect": "3.2.4", - "@vitest/mocker": "3.2.4", - "@vitest/pretty-format": "^3.2.4", - "@vitest/runner": "3.2.4", - "@vitest/snapshot": "3.2.4", - "@vitest/spy": "3.2.4", - "@vitest/utils": "3.2.4", - "chai": "^5.2.0", - "debug": "^4.4.1", - "expect-type": "^1.2.1", - "magic-string": "^0.30.17", + "@vitest/expect": "4.1.10", + "@vitest/mocker": "4.1.10", + "@vitest/pretty-format": "4.1.10", + "@vitest/runner": "4.1.10", + "@vitest/snapshot": "4.1.10", + "@vitest/spy": "4.1.10", + "@vitest/utils": "4.1.10", + "es-module-lexer": "^2.0.0", + "expect-type": "^1.3.0", + "magic-string": "^0.30.21", + "obug": "^2.1.1", "pathe": "^2.0.3", - "picomatch": "^4.0.2", - "std-env": "^3.9.0", + "picomatch": "^4.0.3", + "std-env": "^4.0.0-rc.1", "tinybench": "^2.9.0", - "tinyexec": "^0.3.2", - "tinyglobby": "^0.2.14", - "tinypool": "^1.1.1", - "tinyrainbow": "^2.0.0", - "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0", - "vite-node": "3.2.4", + "tinyexec": "^1.0.2", + "tinyglobby": "^0.2.15", + "tinyrainbow": "^3.1.0", + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0", "why-is-node-running": "^2.3.0" }, "bin": { "vitest": "vitest.mjs" }, "engines": { - "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + "node": "^20.0.0 || ^22.0.0 || >=24.0.0" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { "@edge-runtime/vm": "*", - "@types/debug": "^4.1.12", - "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", - "@vitest/browser": "3.2.4", - "@vitest/ui": "3.2.4", + "@opentelemetry/api": "^1.9.0", + "@types/node": "^20.0.0 || ^22.0.0 || >=24.0.0", + "@vitest/browser-playwright": "4.1.10", + "@vitest/browser-preview": "4.1.10", + "@vitest/browser-webdriverio": "4.1.10", + "@vitest/coverage-istanbul": "4.1.10", + "@vitest/coverage-v8": "4.1.10", + "@vitest/ui": "4.1.10", "happy-dom": "*", - "jsdom": "*" + "jsdom": "*", + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0" }, "peerDependenciesMeta": { "@edge-runtime/vm": { "optional": true }, - "@types/debug": { + "@opentelemetry/api": { "optional": true }, "@types/node": { "optional": true }, - "@vitest/browser": { + "@vitest/browser-playwright": { + "optional": true + }, + "@vitest/browser-preview": { + "optional": true + }, + "@vitest/browser-webdriverio": { + "optional": true + }, + "@vitest/coverage-istanbul": { + "optional": true + }, + "@vitest/coverage-v8": { "optional": true }, "@vitest/ui": { @@ -15729,13 +17441,16 @@ }, "jsdom": { "optional": true + }, + "vite": { + "optional": false } } }, "node_modules/volar-service-css": { - "version": "0.0.68", - "resolved": "https://registry.npmjs.org/volar-service-css/-/volar-service-css-0.0.68.tgz", - "integrity": "sha512-lJSMh6f3QzZ1tdLOZOzovLX0xzAadPhx8EKwraDLPxBndLCYfoTvnNuiFFV8FARrpAlW5C0WkH+TstPaCxr00Q==", + "version": "0.0.71", + "resolved": "https://registry.npmjs.org/volar-service-css/-/volar-service-css-0.0.71.tgz", + "integrity": "sha512-wRRFt9BpjMKCazcgOh67MSjUjiWUCAh99DyYSDIOTuxaRjEtDC7PpB0k1Y1wbJIW/pVtMUSVbpPo3UGSm0Byxw==", "license": "MIT", "dependencies": { "vscode-css-languageservice": "^6.3.0", @@ -15752,9 +17467,9 @@ } }, "node_modules/volar-service-emmet": { - "version": "0.0.68", - "resolved": "https://registry.npmjs.org/volar-service-emmet/-/volar-service-emmet-0.0.68.tgz", - "integrity": "sha512-nHvixrRQ83EzkQ4G/jFxu9Y4eSsXS/X2cltEPDM+K9qZmIv+Ey1w0tg1+6caSe8TU5Hgw4oSTwNMf/6cQb3LzQ==", + "version": "0.0.71", + "resolved": "https://registry.npmjs.org/volar-service-emmet/-/volar-service-emmet-0.0.71.tgz", + "integrity": "sha512-zqjzt6bN95e3CUstBm0PBFAJnrfz0ZAARka87fart46/gNCLLuP3Vujy8V/J8HEziTFLnfkgIASLFYPUhonJcA==", "license": "MIT", "dependencies": { "@emmetio/css-parser": "^0.4.1", @@ -15772,9 +17487,9 @@ } }, "node_modules/volar-service-html": { - "version": "0.0.68", - "resolved": "https://registry.npmjs.org/volar-service-html/-/volar-service-html-0.0.68.tgz", - "integrity": "sha512-fru9gsLJxy33xAltXOh4TEdi312HP80hpuKhpYQD4O5hDnkNPEBdcQkpB+gcX0oK0VxRv1UOzcGQEUzWCVHLfA==", + "version": "0.0.71", + "resolved": "https://registry.npmjs.org/volar-service-html/-/volar-service-html-0.0.71.tgz", + "integrity": "sha512-e8tHPhgQ7ooLfudAEIku+kgd9pWkq3SSz8RbnQDI1+Eb8wbenkLGHqoirLqz5ORLV6wIMr2Iv08RWBG5eOcgpw==", "license": "MIT", "dependencies": { "vscode-html-languageservice": "^5.3.0", @@ -15791,9 +17506,9 @@ } }, "node_modules/volar-service-json": { - "version": "0.0.68", - "resolved": "https://registry.npmjs.org/volar-service-json/-/volar-service-json-0.0.68.tgz", - "integrity": "sha512-2d73Khlffwa0o6B6nA4vCyvqqTBuik1aj1i+EPC8a2UdmjMBAvHhGUcUiF3EscGhenv42UxL7f3tWbsITBNGZg==", + "version": "0.0.71", + "resolved": "https://registry.npmjs.org/volar-service-json/-/volar-service-json-0.0.71.tgz", + "integrity": "sha512-behyNhAG5UEXfvbIOWdE62XsPkp/e5W0V3sz3AW6zy7vgWLzgvElR77YSlcu708GwKu7OOFl5m9sUGVfqLIriQ==", "license": "MIT", "dependencies": { "vscode-json-languageservice": "^5.4.0", @@ -15809,24 +17524,22 @@ } }, "node_modules/volar-service-pug": { - "version": "0.0.68", - "resolved": "https://registry.npmjs.org/volar-service-pug/-/volar-service-pug-0.0.68.tgz", - "integrity": "sha512-/nZ8fYKDDrV/fqlBoMACWaghFfaIFZMH+qO9YiRsdGbekAvSZqjQAKl1DSJwWqAkabA68Md51mRIdzYzqleipQ==", + "version": "0.0.71", + "resolved": "https://registry.npmjs.org/volar-service-pug/-/volar-service-pug-0.0.71.tgz", + "integrity": "sha512-vG4nkQxRfRTCwJsA1CbQ2hSsZjzsrsLDBGeJTDjIaymtOBfML5UMOROTB3ClVuEZVrtg1rquVzVlGTjhvc2ysg==", "license": "MIT", "dependencies": { "@volar/language-service": "~2.4.0", - "muggle-string": "^0.4.1", - "pug-lexer": "^5.0.1", - "pug-parser": "^6.0.0", - "volar-service-html": "0.0.68", + "@vue/language-plugin-pug": "~3.2.2", + "volar-service-html": "0.0.71", "vscode-html-languageservice": "^5.3.0", "vscode-languageserver-textdocument": "^1.0.11" } }, "node_modules/volar-service-pug-beautify": { - "version": "0.0.68", - "resolved": "https://registry.npmjs.org/volar-service-pug-beautify/-/volar-service-pug-beautify-0.0.68.tgz", - "integrity": "sha512-CUKfD2l9aPam7jeZT0bQtAOfSWm6XmOmTXOfYDMILuK6+5uYiMKbPW2y+OdK2FnHjcAC53GnHpUrIbfxojRoFQ==", + "version": "0.0.71", + "resolved": "https://registry.npmjs.org/volar-service-pug-beautify/-/volar-service-pug-beautify-0.0.71.tgz", + "integrity": "sha512-4oxv7xGwT6TxxuFZdXj9EdqUUUWSd1oz9H47z4s/shT9YVLKwrty+9ACbdQsjyWZTp6ES/EtcuSqKuPhz3Uhaw==", "license": "MIT", "dependencies": { "@johnsoncodehk/pug-beautify": "^0.2.2" @@ -15841,9 +17554,9 @@ } }, "node_modules/volar-service-typescript": { - "version": "0.0.68", - "resolved": "https://registry.npmjs.org/volar-service-typescript/-/volar-service-typescript-0.0.68.tgz", - "integrity": "sha512-z7B/7CnJ0+TWWFp/gh2r5/QwMObHNDiQiv4C9pTBNI2Wxuwymd4bjEORzrJ/hJ5Yd5+OzeYK+nFCKevoGEEeKw==", + "version": "0.0.71", + "resolved": "https://registry.npmjs.org/volar-service-typescript/-/volar-service-typescript-0.0.71.tgz", + "integrity": "sha512-yTtM/BVT6hoyEYnDtaCyAtNhdNeS/mhTTABlBOdw3NNiRBUin3IznFJpgfjer4c6RYopiPjjQjc9VFhxVl1mLw==", "license": "MIT", "dependencies": { "path-browserify": "^1.0.1", @@ -15863,9 +17576,9 @@ } }, "node_modules/volar-service-typescript/node_modules/semver": { - "version": "7.7.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", - "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", + "version": "7.8.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.5.tgz", + "integrity": "sha512-Y7/KDsb8LjooZpwaqGyulO6DQlksgCncchHGk+sZIY4SBvUocMBEFH5Ur1fI4dV+Jvl0w6cjvucaIi40puRioA==", "license": "ISC", "bin": { "semver": "bin/semver.js" @@ -15886,6 +17599,12 @@ "vscode-uri": "^3.1.0" } }, + "node_modules/vscode-css-languageservice/node_modules/vscode-languageserver-types": { + "version": "3.17.5", + "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.17.5.tgz", + "integrity": "sha512-Ld1VelNuX9pdF39h2Hgaeb5hEZM2Z3jUrrMgWQAu82jMtZp7p3vJT3BzToKtZI7NgQssZje5o0zryOrhQvzQAg==", + "license": "MIT" + }, "node_modules/vscode-html-languageservice": { "version": "5.6.2", "resolved": "https://registry.npmjs.org/vscode-html-languageservice/-/vscode-html-languageservice-5.6.2.tgz", @@ -15918,9 +17637,9 @@ "license": "MIT" }, "node_modules/vscode-jsonrpc": { - "version": "8.2.0", - "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-8.2.0.tgz", - "integrity": "sha512-C+r0eKJUIfiDIfwJhria30+TYWPtuHJXHtI7J0YlOmKAo7ogxP20T0zxB7HZQIFhIyvoBPwWskjxrvAtfjyZfA==", + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-9.0.0.tgz", + "integrity": "sha512-+VvMmQPJhtvJ+8O+zu2JKIRiLxXF8NW7krWgyMGeOHrp4Cn23T5hc0v2LknNeopDOB70wghHAds7mKtcZ0I4Sg==", "license": "MIT", "engines": { "node": ">=14.0.0" @@ -15939,13 +17658,13 @@ } }, "node_modules/vscode-languageserver-protocol": { - "version": "3.17.5", - "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.17.5.tgz", - "integrity": "sha512-mb1bvRJN8SVznADSGWM9u/b07H7Ecg0I3OgXDuLdn307rl/J3A9YD6/eYOssqhecL27hK1IPZAsaqh00i/Jljg==", + "version": "3.18.1", + "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.18.1.tgz", + "integrity": "sha512-RTiiVHdpxpYcJVI5sq6S5TLjQ4WDR/rBrIWru+kPXe6sGQ9PFQ3GamrTKLvPqbR4ylr1SoodhmcqbFII0WXVuw==", "license": "MIT", "dependencies": { - "vscode-jsonrpc": "8.2.0", - "vscode-languageserver-types": "3.17.5" + "vscode-jsonrpc": "9.0.0", + "vscode-languageserver-types": "3.18.0" } }, "node_modules/vscode-languageserver-textdocument": { @@ -15955,6 +17674,31 @@ "license": "MIT" }, "node_modules/vscode-languageserver-types": { + "version": "3.18.0", + "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.18.0.tgz", + "integrity": "sha512-8TsGPNMIMiiBdkORgRSvLjuiEIiAFtO+KssmYWxQ+uSVvlf7RjK8YKCOjPzZ+YA04jXEV7+7LvkSmHkhpNS99g==", + "license": "MIT" + }, + "node_modules/vscode-languageserver/node_modules/vscode-jsonrpc": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-8.2.0.tgz", + "integrity": "sha512-C+r0eKJUIfiDIfwJhria30+TYWPtuHJXHtI7J0YlOmKAo7ogxP20T0zxB7HZQIFhIyvoBPwWskjxrvAtfjyZfA==", + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/vscode-languageserver/node_modules/vscode-languageserver-protocol": { + "version": "3.17.5", + "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.17.5.tgz", + "integrity": "sha512-mb1bvRJN8SVznADSGWM9u/b07H7Ecg0I3OgXDuLdn307rl/J3A9YD6/eYOssqhecL27hK1IPZAsaqh00i/Jljg==", + "license": "MIT", + "dependencies": { + "vscode-jsonrpc": "8.2.0", + "vscode-languageserver-types": "3.17.5" + } + }, + "node_modules/vscode-languageserver/node_modules/vscode-languageserver-types": { "version": "3.17.5", "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.17.5.tgz", "integrity": "sha512-Ld1VelNuX9pdF39h2Hgaeb5hEZM2Z3jUrrMgWQAu82jMtZp7p3vJT3BzToKtZI7NgQssZje5o0zryOrhQvzQAg==", @@ -15973,16 +17717,16 @@ "license": "MIT" }, "node_modules/vue": { - "version": "3.5.29", - "resolved": "https://registry.npmjs.org/vue/-/vue-3.5.29.tgz", - "integrity": "sha512-BZqN4Ze6mDQVNAni0IHeMJ5mwr8VAJ3MQC9FmprRhcBYENw+wOAAjRj8jfmN6FLl0j96OXbR+CjWhmAmM+QGnA==", + "version": "3.5.39", + "resolved": "https://registry.npmjs.org/vue/-/vue-3.5.39.tgz", + "integrity": "sha512-xmZCYabFGcirU8r0fTuvl/LICc1OU620rnqepaJDL/a141ZigkG7AyaxQLdqJ02ZRYzWe6YPaDHeQx7MfknQfA==", "license": "MIT", "dependencies": { - "@vue/compiler-dom": "3.5.29", - "@vue/compiler-sfc": "3.5.29", - "@vue/runtime-dom": "3.5.29", - "@vue/server-renderer": "3.5.29", - "@vue/shared": "3.5.29" + "@vue/compiler-dom": "3.5.39", + "@vue/compiler-sfc": "3.5.39", + "@vue/runtime-dom": "3.5.39", + "@vue/server-renderer": "3.5.39", + "@vue/shared": "3.5.39" }, "peerDependencies": { "typescript": "*" @@ -16003,13 +17747,13 @@ } }, "node_modules/vue-component-meta": { - "version": "3.2.5", - "resolved": "https://registry.npmjs.org/vue-component-meta/-/vue-component-meta-3.2.5.tgz", - "integrity": "sha512-i7v7S6atD9aZZPouwceJoqcmBzjI4uRIxOj5dDcBPiIhFoY+U5kmy7PnEaAOh/iilJQI7I8F3lKdyZmRdplUpA==", + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/vue-component-meta/-/vue-component-meta-3.3.6.tgz", + "integrity": "sha512-kPNTwuLzqYDvsE2CiDPSbt89aypZwYoCRxtbUfbkfOgy3DV130G3Z1jJuRBct64vxB2Lii6fcih8FJba8dLoXQ==", "license": "MIT", "dependencies": { "@volar/typescript": "2.4.28", - "@vue/language-core": "3.2.5", + "@vue/language-core": "3.3.6", "path-browserify": "^1.0.1" }, "peerDependencies": { @@ -16022,15 +17766,15 @@ } }, "node_modules/vue-component-type-helpers": { - "version": "2.2.12", - "resolved": "https://registry.npmjs.org/vue-component-type-helpers/-/vue-component-type-helpers-2.2.12.tgz", - "integrity": "sha512-YbGqHZ5/eW4SnkPNR44mKVc6ZKQoRs/Rux1sxC6rdwXb4qpbOSYfDr9DsTHolOTGmIKgM9j141mZbBeg05R1pw==", + "version": "3.3.5", + "resolved": "https://registry.npmjs.org/vue-component-type-helpers/-/vue-component-type-helpers-3.3.5.tgz", + "integrity": "sha512-Fe1jyPJoUGpJOYKOri44jduR7My4yYINOMJISuMAbmrs+L5LbIDUc8NTWZYY3EJLK0yPLuCmcd5zoCsE4k2/KA==", "license": "MIT" }, "node_modules/vue-eslint-parser": { - "version": "10.4.0", - "resolved": "https://registry.npmjs.org/vue-eslint-parser/-/vue-eslint-parser-10.4.0.tgz", - "integrity": "sha512-Vxi9pJdbN3ZnVGLODVtZ7y4Y2kzAAE2Cm0CZ3ZDRvydVYxZ6VrnBhLikBsRS+dpwj4Jv4UCv21PTEwF5rQ9WXg==", + "version": "10.4.1", + "resolved": "https://registry.npmjs.org/vue-eslint-parser/-/vue-eslint-parser-10.4.1.tgz", + "integrity": "sha512-Gk6gRDj0n/fkRa3C3l0bBheoBckUq/Rs0F/TvMWIS6nzzx67amAViMe9CkNgsP2tXyQONvGiHQESHwFtZ3aYDA==", "license": "MIT", "peer": true, "dependencies": { @@ -16052,9 +17796,9 @@ } }, "node_modules/vue-eslint-parser/node_modules/semver": { - "version": "7.7.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", - "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", + "version": "7.8.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.5.tgz", + "integrity": "sha512-Y7/KDsb8LjooZpwaqGyulO6DQlksgCncchHGk+sZIY4SBvUocMBEFH5Ur1fI4dV+Jvl0w6cjvucaIi40puRioA==", "license": "ISC", "peer": true, "bin": { @@ -16110,15 +17854,6 @@ "node": "*" } }, - "node_modules/vue-resize": { - "version": "2.0.0-alpha.1", - "resolved": "https://registry.npmjs.org/vue-resize/-/vue-resize-2.0.0-alpha.1.tgz", - "integrity": "sha512-7+iqOueLU7uc9NrMfrzbG8hwMqchfVfSzpVlCMeJQe4pyibqyoifDNbKTZvwxZKDvGkB+PdFeKvnGZMoEb8esg==", - "license": "MIT", - "peerDependencies": { - "vue": "^3.0.0" - } - }, "node_modules/vue-router": { "version": "4.6.4", "resolved": "https://registry.npmjs.org/vue-router/-/vue-router-4.6.4.tgz", @@ -16235,28 +17970,19 @@ "integrity": "sha512-Ofn/CTFzRGTTxwpNEs9PP93gXShHcTq255nzRYSKe8AkVpZY7e1fpmTfOyoIvjP5HG7Z2ZM7VS9PPhQGW2pOpw==", "license": "MIT" }, - "node_modules/vue3-gettext/node_modules/parse5-htmlparser2-tree-adapter": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-6.0.1.tgz", - "integrity": "sha512-qPuWvbLgvDGilKc5BoicRovlT4MtYT6JfJyBOMDsKoiT+GiuP5qyrPCnR9HcPECIJJmZh5jRndyNThnhhb/vlA==", - "license": "MIT", - "dependencies": { - "parse5": "^6.0.1" - } - }, "node_modules/vue3-gettext/node_modules/yaml": { - "version": "1.10.2", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz", - "integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==", + "version": "1.10.3", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.3.tgz", + "integrity": "sha512-vIYeF1u3CjlhAFekPPAk2h/Kv4T3mAkMox5OymRiJQB0spDP10LHvt+K7G9Ny6NuuMAb25/6n1qyUjAcGNf/AA==", "license": "ISC", "engines": { "node": ">= 6" } }, "node_modules/vuetify": { - "version": "3.11.9", - "resolved": "https://registry.npmjs.org/vuetify/-/vuetify-3.11.9.tgz", - "integrity": "sha512-XKcaQU+y/ZURLWII4rOX26LgU/wYRjskDVQFQ35OQuTt81wkruyle9sM9RDkFXCYI5zFApaRpBnTzS8uIN6Yog==", + "version": "3.12.2", + "resolved": "https://registry.npmjs.org/vuetify/-/vuetify-3.12.2.tgz", + "integrity": "sha512-cVQa4+5iQpDs00ToMUnWRHlMdv1d5tEH2wcZIthqSCmBipQAG4rQKE55zFwZFYlPyiDhUVY1RcAFtXCuHNcCww==", "license": "MIT", "funding": { "type": "github", @@ -16302,12 +18028,11 @@ } }, "node_modules/watchpack": { - "version": "2.5.1", - "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.5.1.tgz", - "integrity": "sha512-Zn5uXdcFNIA1+1Ei5McRd+iRzfhENPCe7LeABkJtNulSxjma+l7ltNx55BWZkRlwRnpOgHqxnjyaDgJnNXnqzg==", + "version": "2.5.2", + "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.5.2.tgz", + "integrity": "sha512-6i/00NBjP4yGPs+caKSyRfpTF/8Torsu0MOW3mMzIbhgISFder8i7xbqgHlLMwJrdiN8ndBV3UA1/AfzPSr+jg==", "license": "MIT", "dependencies": { - "glob-to-regexp": "^0.4.1", "graceful-fs": "^4.1.2" }, "engines": { @@ -16315,21 +18040,20 @@ } }, "node_modules/webidl-conversions": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-7.0.0.tgz", - "integrity": "sha512-VwddBukDzu71offAQR975unBIGqfKZpM+8ZX6ySk8nYhVoo5CYaZyzt3YBvYtRtO+aoGlqxPg/B87NGVZ/fu6g==", + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-8.0.1.tgz", + "integrity": "sha512-BMhLD/Sw+GbJC21C/UgyaZX41nPt8bUTg+jWyDeg7e7YN4xOM05YPSIXceACnXVtqyEw/LMClUQMtMZ+PGGpqQ==", "license": "BSD-2-Clause", "engines": { - "node": ">=12" + "node": ">=20" } }, "node_modules/webpack": { - "version": "5.105.3", - "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.105.3.tgz", - "integrity": "sha512-LLBBA4oLmT7sZdHiYE/PeVuifOxYyE2uL/V+9VQP7YSYdJU7bSf7H8bZRRxW8kEPMkmVjnrXmoR3oejIdX0xbg==", + "version": "5.107.2", + "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.107.2.tgz", + "integrity": "sha512-v7RhXaJbpMlV0D7hC7lb2EbnxkoeUqf9qhKr6lozx3Q48pmFrqqNRmZFUEGmi7pSwm6fCQ2H1IjvCkHqdpVdjQ==", "license": "MIT", "dependencies": { - "@types/eslint-scope": "^3.7.7", "@types/estree": "^1.0.8", "@types/json-schema": "^7.0.15", "@webassemblyjs/ast": "^1.14.1", @@ -16339,21 +18063,20 @@ "acorn-import-phases": "^1.0.3", "browserslist": "^4.28.1", "chrome-trace-event": "^1.0.2", - "enhanced-resolve": "^5.19.0", - "es-module-lexer": "^2.0.0", + "enhanced-resolve": "^5.22.0", + "es-module-lexer": "^2.1.0", "eslint-scope": "5.1.1", "events": "^3.2.0", "glob-to-regexp": "^0.4.1", "graceful-fs": "^4.2.11", - "json-parse-even-better-errors": "^2.3.1", - "loader-runner": "^4.3.1", - "mime-types": "^2.1.27", + "loader-runner": "^4.3.2", + "mime-db": "^1.54.0", "neo-async": "^2.6.2", "schema-utils": "^4.3.3", "tapable": "^2.3.0", - "terser-webpack-plugin": "^5.3.16", + "terser-webpack-plugin": "^5.5.0", "watchpack": "^2.5.1", - "webpack-sources": "^3.3.4" + "webpack-sources": "^3.5.0" }, "bin": { "webpack": "bin/webpack.js" @@ -16372,74 +18095,55 @@ } }, "node_modules/webpack-bundle-analyzer": { - "version": "4.10.2", - "resolved": "https://registry.npmjs.org/webpack-bundle-analyzer/-/webpack-bundle-analyzer-4.10.2.tgz", - "integrity": "sha512-vJptkMm9pk5si4Bv922ZbKLV8UTT4zib4FPgXMhgzUny0bfDDkLXAVQs3ly3fS4/TN9ROFtb0NFrm04UXFE/Vw==", + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/webpack-bundle-analyzer/-/webpack-bundle-analyzer-5.3.0.tgz", + "integrity": "sha512-PEhAoqiJ+47d0uLMx/+zo5XOvaU+Vk6N2ZLht7H3n09QLy/fhyvqGNwjdRUHJDgMN8crBR2ZwVHkIswT3Xuawg==", "license": "MIT", "dependencies": { - "@discoveryjs/json-ext": "0.5.7", + "@discoveryjs/json-ext": "^0.6.3", "acorn": "^8.0.4", "acorn-walk": "^8.0.0", - "commander": "^7.2.0", - "debounce": "^1.2.1", - "escape-string-regexp": "^4.0.0", - "gzip-size": "^6.0.0", - "html-escaper": "^2.0.2", + "commander": "^14.0.2", + "escape-string-regexp": "^5.0.0", + "html-escaper": "^3.0.3", "opener": "^1.5.2", "picocolors": "^1.0.0", - "sirv": "^2.0.3", - "ws": "^7.3.1" + "sirv": "^3.0.2", + "ws": "^8.19.0" }, "bin": { "webpack-bundle-analyzer": "lib/bin/analyzer.js" }, "engines": { - "node": ">= 10.13.0" + "node": ">= 20.9.0" } }, "node_modules/webpack-bundle-analyzer/node_modules/commander": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-7.2.0.tgz", - "integrity": "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==", + "version": "14.0.3", + "resolved": "https://registry.npmjs.org/commander/-/commander-14.0.3.tgz", + "integrity": "sha512-H+y0Jo/T1RZ9qPP4Eh1pkcQcLRglraJaSLoyOtHxu6AapkjWVCy2Sit1QQ4x3Dng8qDlSsZEet7g5Pq06MvTgw==", "license": "MIT", "engines": { - "node": ">= 10" + "node": ">=20" } }, - "node_modules/webpack-bundle-analyzer/node_modules/sirv": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/sirv/-/sirv-2.0.4.tgz", - "integrity": "sha512-94Bdh3cC2PKrbgSOUqTiGPWVZeSiXfKOVZNJniWoqrWrRkB1CJzBU3NEbiTsPcYy1lDsANA/THzS+9WBiy5nfQ==", + "node_modules/webpack-bundle-analyzer/node_modules/escape-string-regexp": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-5.0.0.tgz", + "integrity": "sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==", "license": "MIT", - "dependencies": { - "@polka/url": "^1.0.0-next.24", - "mrmime": "^2.0.0", - "totalist": "^3.0.0" - }, "engines": { - "node": ">= 10" + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/webpack-bundle-analyzer/node_modules/ws": { - "version": "7.5.10", - "resolved": "https://registry.npmjs.org/ws/-/ws-7.5.10.tgz", - "integrity": "sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ==", - "license": "MIT", - "engines": { - "node": ">=8.3.0" - }, - "peerDependencies": { - "bufferutil": "^4.0.1", - "utf-8-validate": "^5.0.2" - }, - "peerDependenciesMeta": { - "bufferutil": { - "optional": true - }, - "utf-8-validate": { - "optional": true - } - } + "node_modules/webpack-bundle-analyzer/node_modules/html-escaper": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-3.0.3.tgz", + "integrity": "sha512-RuMffC89BOWQoY0WKGpIhn5gX3iI54O6nRA0yC124NYVtzjmFWBIiFd8M0x+ZdX0P9R4lADg1mgP8C7PxGOWuQ==", + "license": "MIT" }, "node_modules/webpack-cli": { "version": "6.0.1", @@ -16483,15 +18187,6 @@ } } }, - "node_modules/webpack-cli/node_modules/@discoveryjs/json-ext": { - "version": "0.6.3", - "resolved": "https://registry.npmjs.org/@discoveryjs/json-ext/-/json-ext-0.6.3.tgz", - "integrity": "sha512-4B4OijXeVNOPZlYA2oEwWOTkzyltLao+xbotHQeqN++Rv27Y6s818+n2Qkp8q+Fxhn0t/5lA5X1Mxktud8eayQ==", - "license": "MIT", - "engines": { - "node": ">=14.17.0" - } - }, "node_modules/webpack-cli/node_modules/commander": { "version": "12.1.0", "resolved": "https://registry.npmjs.org/commander/-/commander-12.1.0.tgz", @@ -16512,6 +18207,15 @@ "strip-ansi": "^6.0.0" } }, + "node_modules/webpack-hot-middleware/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, "node_modules/webpack-hot-middleware/node_modules/strip-ansi": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", @@ -16715,20 +18419,14 @@ } }, "node_modules/webpack-sources": { - "version": "3.3.4", - "resolved": "https://registry.npmjs.org/webpack-sources/-/webpack-sources-3.3.4.tgz", - "integrity": "sha512-7tP1PdV4vF+lYPnkMR0jMY5/la2ub5Fc/8VQrrU+lXkiM6C4TjVfGw7iKfyhnTQOsD+6Q/iKw0eFciziRgD58Q==", + "version": "3.5.0", + "resolved": "https://registry.npmjs.org/webpack-sources/-/webpack-sources-3.5.0.tgz", + "integrity": "sha512-HPuy+uuoTCaaoEoI1LQ3JN9+vrPBvEesnnX1jADHy728cHSMlq4wUc4afYqahq2B1mhQVZxCXOkNTnXltr+2vQ==", "license": "MIT", "engines": { "node": ">=10.13.0" } }, - "node_modules/webpack/node_modules/es-module-lexer": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-2.0.0.tgz", - "integrity": "sha512-5POEcUuZybH7IdmGsD8wlf0AI55wMecM9rVBTI/qEAy2c1kTOm3DjFYjrBdI2K3BaJjJYfYFeRtM0t9ssnRuxw==", - "license": "MIT" - }, "node_modules/webpack/node_modules/eslint-scope": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", @@ -16751,39 +18449,36 @@ "node": ">=4.0" } }, - "node_modules/whatwg-encoding": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/whatwg-encoding/-/whatwg-encoding-3.1.1.tgz", - "integrity": "sha512-6qN4hJdMwfYBtE3YBTTHhoeuUrDBPZmbQaxWAqSALV/MeEnR5z1xd8UKud2RAkFoPkmB+hli1TZSnyi84xz1vQ==", - "deprecated": "Use @exodus/bytes instead for a more spec-conformant and faster implementation", + "node_modules/webpack/node_modules/mime-db": { + "version": "1.54.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.54.0.tgz", + "integrity": "sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ==", "license": "MIT", - "dependencies": { - "iconv-lite": "0.6.3" - }, "engines": { - "node": ">=18" + "node": ">= 0.6" } }, "node_modules/whatwg-mimetype": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-4.0.0.tgz", - "integrity": "sha512-QaKxh0eNIi2mE9p2vEdzfagOKHCcj1pJ56EEHGQOVxp8r9/iszLUUV7v89x9O1p/T+NlTM5W7jW6+cz4Fq1YVg==", + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-5.0.0.tgz", + "integrity": "sha512-sXcNcHOC51uPGF0P/D4NVtrkjSU2fNsm9iog4ZvZJsL3rjoDAzXZhkm2MWt1y+PUdggKAYVoMAIYcs78wJ51Cw==", "license": "MIT", "engines": { - "node": ">=18" + "node": ">=20" } }, "node_modules/whatwg-url": { - "version": "14.2.0", - "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-14.2.0.tgz", - "integrity": "sha512-De72GdQZzNTUBBChsXueQUnPKDkg/5A5zp7pFDuQAj5UFoENpiACU0wlCvzpAGnTkj++ihpKwKyYewn/XNUbKw==", + "version": "16.0.1", + "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-16.0.1.tgz", + "integrity": "sha512-1to4zXBxmXHV3IiSSEInrreIlu02vUOvrhxJJH5vcxYTBDAx51cqZiKdyTxlecdKNSjj8EcxGBxNf6Vg+945gw==", "license": "MIT", "dependencies": { - "tr46": "^5.1.0", - "webidl-conversions": "^7.0.0" + "@exodus/bytes": "^1.11.0", + "tr46": "^6.0.0", + "webidl-conversions": "^8.0.1" }, "engines": { - "node": ">=18" + "node": "^20.19.0 || ^22.12.0 || >=24.0.0" } }, "node_modules/which": { @@ -16866,13 +18561,13 @@ } }, "node_modules/which-typed-array": { - "version": "1.1.20", - "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.20.tgz", - "integrity": "sha512-LYfpUkmqwl0h9A2HL09Mms427Q1RZWuOHsukfVcKRq9q95iQxdw0ix1JQrqbcDR9PH1QDwf5Qo8OZb5lksZ8Xg==", + "version": "1.1.22", + "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.22.tgz", + "integrity": "sha512-fvO4ExWMFsqyhG3AiPAObMuY1lxaqgYcxbc49CNdWDDECOJNgQyvsOWVwbZc+qf3rzRtxojBK+CMEv0Ld5CYpw==", "license": "MIT", "dependencies": { "available-typed-arrays": "^1.0.7", - "call-bind": "^1.0.8", + "call-bind": "^1.0.9", "call-bound": "^1.0.4", "for-each": "^0.3.5", "get-proto": "^1.0.1", @@ -16918,80 +18613,79 @@ } }, "node_modules/workbox-background-sync": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/workbox-background-sync/-/workbox-background-sync-7.4.0.tgz", - "integrity": "sha512-8CB9OxKAgKZKyNMwfGZ1XESx89GryWTfI+V5yEj8sHjFH8MFelUwYXEyldEK6M6oKMmn807GoJFUEA1sC4XS9w==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/workbox-background-sync/-/workbox-background-sync-7.4.1.tgz", + "integrity": "sha512-HhT7KE8tOWDm02wRNshXUnUPofMlhenF2DBdUnDPOubhizzPeItkYTmAB6td1Z2cjYPa98vzEiPLEuzn5hN66g==", "license": "MIT", "dependencies": { "idb": "^7.0.1", - "workbox-core": "7.4.0" + "workbox-core": "7.4.1" } }, "node_modules/workbox-broadcast-update": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/workbox-broadcast-update/-/workbox-broadcast-update-7.4.0.tgz", - "integrity": "sha512-+eZQwoktlvo62cI0b+QBr40v5XjighxPq3Fzo9AWMiAosmpG5gxRHgTbGGhaJv/q/MFVxwFNGh/UwHZ/8K88lA==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/workbox-broadcast-update/-/workbox-broadcast-update-7.4.1.tgz", + "integrity": "sha512-uAlgslKLvbQY+suirIdnBCSYrcgBhjp81Nj4l1lj/Jmj0MJO2CJERnCJjT0GFVwmReV0N+zs78K6gqd5gr9/+A==", "license": "MIT", "dependencies": { - "workbox-core": "7.4.0" + "workbox-core": "7.4.1" } }, "node_modules/workbox-build": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/workbox-build/-/workbox-build-7.4.0.tgz", - "integrity": "sha512-Ntk1pWb0caOFIvwz/hfgrov/OJ45wPEhI5PbTywQcYjyZiVhT3UrwwUPl6TRYbTm4moaFYithYnl1lvZ8UjxcA==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/workbox-build/-/workbox-build-7.4.1.tgz", + "integrity": "sha512-SDhxIvEAde9Gy/5w4Yo1Jh/M49Z0qE3q0oteyE8zGq0DScxFqVBcCtIXFuLtmtxRQZCMbf0prco4VyEu3KBQuw==", "license": "MIT", "dependencies": { "@apideck/better-ajv-errors": "^0.3.1", "@babel/core": "^7.24.4", "@babel/preset-env": "^7.11.0", "@babel/runtime": "^7.11.2", - "@rollup/plugin-babel": "^5.2.0", - "@rollup/plugin-node-resolve": "^15.2.3", - "@rollup/plugin-replace": "^2.4.1", - "@rollup/plugin-terser": "^0.4.3", - "@surma/rollup-plugin-off-main-thread": "^2.2.3", + "@rollup/plugin-babel": "^6.1.0", + "@rollup/plugin-node-resolve": "^16.0.3", + "@rollup/plugin-replace": "^6.0.3", + "@rollup/plugin-terser": "^1.0.0", + "@trickfilm400/rollup-plugin-off-main-thread": "^3.0.0-pre1", "ajv": "^8.6.0", "common-tags": "^1.8.0", + "eta": "^4.5.1", "fast-json-stable-stringify": "^2.1.0", "fs-extra": "^9.0.1", "glob": "^11.0.1", - "lodash": "^4.17.20", "pretty-bytes": "^5.3.0", - "rollup": "^2.79.2", + "rollup": "^4.53.3", "source-map": "^0.8.0-beta.0", "stringify-object": "^3.3.0", "strip-comments": "^2.0.1", "tempy": "^0.6.0", "upath": "^1.2.0", - "workbox-background-sync": "7.4.0", - "workbox-broadcast-update": "7.4.0", - "workbox-cacheable-response": "7.4.0", - "workbox-core": "7.4.0", - "workbox-expiration": "7.4.0", - "workbox-google-analytics": "7.4.0", - "workbox-navigation-preload": "7.4.0", - "workbox-precaching": "7.4.0", - "workbox-range-requests": "7.4.0", - "workbox-recipes": "7.4.0", - "workbox-routing": "7.4.0", - "workbox-strategies": "7.4.0", - "workbox-streams": "7.4.0", - "workbox-sw": "7.4.0", - "workbox-window": "7.4.0" + "workbox-background-sync": "7.4.1", + "workbox-broadcast-update": "7.4.1", + "workbox-cacheable-response": "7.4.1", + "workbox-core": "7.4.1", + "workbox-expiration": "7.4.1", + "workbox-google-analytics": "7.4.1", + "workbox-navigation-preload": "7.4.1", + "workbox-precaching": "7.4.1", + "workbox-range-requests": "7.4.1", + "workbox-recipes": "7.4.1", + "workbox-routing": "7.4.1", + "workbox-strategies": "7.4.1", + "workbox-streams": "7.4.1", + "workbox-sw": "7.4.1", + "workbox-window": "7.4.1" }, "engines": { "node": ">=20.0.0" } }, "node_modules/workbox-build/node_modules/@apideck/better-ajv-errors": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/@apideck/better-ajv-errors/-/better-ajv-errors-0.3.6.tgz", - "integrity": "sha512-P+ZygBLZtkp0qqOAJJVX4oX/sFo5JR3eBWwwuqHHhK0GIgQOKWrAfiAaWX0aArHkRWHMuggFEgAZNxVPwPZYaA==", + "version": "0.3.7", + "resolved": "https://registry.npmjs.org/@apideck/better-ajv-errors/-/better-ajv-errors-0.3.7.tgz", + "integrity": "sha512-TajUJwGWbDwkCx/CZi7tRE8PVB7simCvKJfHUsSdvps+aTM/PDPP4gkLmKnc+x3CE//y9i/nj74GqdL/hwk7Iw==", "license": "MIT", "dependencies": { - "json-schema": "^0.4.0", - "jsonpointer": "^5.0.0", + "jsonpointer": "^5.0.1", "leven": "^3.1.0" }, "engines": { @@ -17010,69 +18704,10 @@ "node": ">=18" } }, - "node_modules/workbox-build/node_modules/@rollup/plugin-babel": { - "version": "5.3.1", - "resolved": "https://registry.npmjs.org/@rollup/plugin-babel/-/plugin-babel-5.3.1.tgz", - "integrity": "sha512-WFfdLWU/xVWKeRQnKmIAQULUI7Il0gZnBIH/ZFO069wYIfPu+8zrfp/KMW0atmELoRDq8FbiP3VCss9MhCut7Q==", - "license": "MIT", - "dependencies": { - "@babel/helper-module-imports": "^7.10.4", - "@rollup/pluginutils": "^3.1.0" - }, - "engines": { - "node": ">= 10.0.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0", - "@types/babel__core": "^7.1.9", - "rollup": "^1.20.0||^2.0.0" - }, - "peerDependenciesMeta": { - "@types/babel__core": { - "optional": true - } - } - }, - "node_modules/workbox-build/node_modules/@rollup/plugin-replace": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/@rollup/plugin-replace/-/plugin-replace-2.4.2.tgz", - "integrity": "sha512-IGcu+cydlUMZ5En85jxHH4qj2hta/11BHq95iHEyb2sbgiN0eCdzvUcHw5gt9pBL5lTi4JDYJ1acCoMGpTvEZg==", - "license": "MIT", - "dependencies": { - "@rollup/pluginutils": "^3.1.0", - "magic-string": "^0.25.7" - }, - "peerDependencies": { - "rollup": "^1.20.0 || ^2.0.0" - } - }, - "node_modules/workbox-build/node_modules/@rollup/pluginutils": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/@rollup/pluginutils/-/pluginutils-3.1.0.tgz", - "integrity": "sha512-GksZ6pr6TpIjHm8h9lSQ8pi8BE9VeubNT0OMJ3B5uZJ8pz73NPiqOtCog/x2/QzM1ENChPKxMDhiQuRHsqc+lg==", - "license": "MIT", - "dependencies": { - "@types/estree": "0.0.39", - "estree-walker": "^1.0.1", - "picomatch": "^2.2.2" - }, - "engines": { - "node": ">= 8.0.0" - }, - "peerDependencies": { - "rollup": "^1.20.0||^2.0.0" - } - }, - "node_modules/workbox-build/node_modules/@types/estree": { - "version": "0.0.39", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-0.0.39.tgz", - "integrity": "sha512-EYNwp3bU+98cpU4lAWYYL7Zz+2gryWH1qbdDTidVd6hkiR6weksdbMadyXKXNPEkQFhXM+hVO9ZygomHXp+AIw==", - "license": "MIT" - }, "node_modules/workbox-build/node_modules/ajv": { - "version": "8.18.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.18.0.tgz", - "integrity": "sha512-PlXPeEWMXMZ7sPYOHqmDyCJzcfNrUr3fGNKtezX14ykXOEIvyK81d+qydx89KY5O71FKMPaQ2vBfBFI5NHR63A==", + "version": "8.20.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.20.0.tgz", + "integrity": "sha512-Thbli+OlOj+iMPYFBVBfJ3OmCAnaSyNn4M1vz9T6Gka5Jt9ba/HIR56joy65tY6kx/FCF5VXNB819Y7/GUrBGA==", "license": "MIT", "dependencies": { "fast-deep-equal": "^3.1.3", @@ -17095,9 +18730,9 @@ } }, "node_modules/workbox-build/node_modules/brace-expansion": { - "version": "5.0.4", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.4.tgz", - "integrity": "sha512-h+DEnpVvxmfVefa4jFbCf5HdH5YMDXRsmKflpf1pILZWRFlTbJpxeU55nJl4Smt5HQaGzg1o6RHFPJaOqnmBDg==", + "version": "5.0.7", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.7.tgz", + "integrity": "sha512-7oFy703dxfY3/NLxC1fh2SUCQ0H9rmAY+5EpDVfXjUTTs+HEwR2nYaqLv+GWcTsumwxPfiz6CzCNkwXwBUwqCA==", "license": "MIT", "dependencies": { "balanced-match": "^4.0.2" @@ -17106,12 +18741,6 @@ "node": "18 || 20 || >=22" } }, - "node_modules/workbox-build/node_modules/estree-walker": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-1.0.1.tgz", - "integrity": "sha512-1fMXF3YP4pZZVozF8j/ZLfvnR8NSIljt56UhbZ5PeeDmmGHpgpdwQt7ITlGvYaQukCvuBRMLEiKiYC+oeIg4cg==", - "license": "MIT" - }, "node_modules/workbox-build/node_modules/glob": { "version": "11.1.0", "resolved": "https://registry.npmjs.org/glob/-/glob-11.1.0.tgz", @@ -17158,30 +18787,21 @@ "license": "MIT" }, "node_modules/workbox-build/node_modules/lru-cache": { - "version": "11.2.6", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-11.2.6.tgz", - "integrity": "sha512-ESL2CrkS/2wTPfuend7Zhkzo2u0daGJ/A2VucJOgQ/C48S/zB8MMeMHSGKYpXhIjbPxfuezITkaBH1wqv00DDQ==", + "version": "11.5.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-11.5.1.tgz", + "integrity": "sha512-RPimw/7aMdv2oqRrxKwvZXcPfwBrn/JZ2xYcY9Hus/6LaS3VOAKVWKWgNLCFSiOm1ESXinjsDlidVU7JlnCN2A==", "license": "BlueOak-1.0.0", "engines": { "node": "20 || >=22" } }, - "node_modules/workbox-build/node_modules/magic-string": { - "version": "0.25.9", - "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.25.9.tgz", - "integrity": "sha512-RmF0AsMzgt25qzqqLc1+MbHmhdx0ojF2Fvs4XnOqz2ZOBXzzkEwc/dJQZCYHAn7v1jbVOjAZfK8msRn4BxO4VQ==", - "license": "MIT", - "dependencies": { - "sourcemap-codec": "^1.4.8" - } - }, "node_modules/workbox-build/node_modules/minimatch": { - "version": "10.2.4", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.2.4.tgz", - "integrity": "sha512-oRjTw/97aTBN0RHbYCdtF1MQfvusSIBQM0IZEgzl6426+8jSC0nF1a/GmnVLpfB9yyr6g6FTqWqiZVbxrtaCIg==", + "version": "10.2.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.2.5.tgz", + "integrity": "sha512-MULkVLfKGYDFYejP07QOurDLLQpcjk7Fw+7jXS2R2czRQzR56yHRveU5NDJEOviH+hETZKSkIk5c+T23GjFUMg==", "license": "BlueOak-1.0.0", "dependencies": { - "brace-expansion": "^5.0.2" + "brace-expansion": "^5.0.5" }, "engines": { "node": "18 || 20 || >=22" @@ -17206,33 +18826,6 @@ "url": "https://github.com/sponsors/isaacs" } }, - "node_modules/workbox-build/node_modules/picomatch": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", - "license": "MIT", - "engines": { - "node": ">=8.6" - }, - "funding": { - "url": "https://github.com/sponsors/jonschlinkert" - } - }, - "node_modules/workbox-build/node_modules/rollup": { - "version": "2.80.0", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.80.0.tgz", - "integrity": "sha512-cIFJOD1DESzpjOBl763Kp1AH7UE/0fcdHe6rZXUdQ9c50uvgigvW97u3IcSeBwOkgqL/PXPBktBCh0KEu5L8XQ==", - "license": "MIT", - "bin": { - "rollup": "dist/bin/rollup" - }, - "engines": { - "node": ">=10.0.0" - }, - "optionalDependencies": { - "fsevents": "~2.3.2" - } - }, "node_modules/workbox-build/node_modules/source-map": { "version": "0.8.0-beta.0", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.8.0-beta.0.tgz", @@ -17283,130 +18876,130 @@ } }, "node_modules/workbox-cacheable-response": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/workbox-cacheable-response/-/workbox-cacheable-response-7.4.0.tgz", - "integrity": "sha512-0Fb8795zg/x23ISFkAc7lbWes6vbw34DGFIMw31cwuHPgDEC/5EYm6m/ZkylLX0EnEbbOyOCLjKgFS/Z5g0HeQ==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/workbox-cacheable-response/-/workbox-cacheable-response-7.4.1.tgz", + "integrity": "sha512-8xaFoJdDc2OjrlbbL3gEeBO1WKcMwRqwLRupgqahYXu75yXajPLuwrbXMrIGZuWYXrQwk0xDjOxZ/ujCy/oJYw==", "license": "MIT", "dependencies": { - "workbox-core": "7.4.0" + "workbox-core": "7.4.1" } }, "node_modules/workbox-core": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/workbox-core/-/workbox-core-7.4.0.tgz", - "integrity": "sha512-6BMfd8tYEnN4baG4emG9U0hdXM4gGuDU3ectXuVHnj71vwxTFI7WOpQJC4siTOlVtGqCUtj0ZQNsrvi6kZZTAQ==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/workbox-core/-/workbox-core-7.4.1.tgz", + "integrity": "sha512-DT+vu46eh/2vRsSHTY4Xmc32Z1rr9PRlQUXr1Dx30ZuXRWwOsvZgGgcwxcasubQLQmbTNYZjv44LkBAQ4tT5tQ==", "license": "MIT" }, "node_modules/workbox-expiration": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/workbox-expiration/-/workbox-expiration-7.4.0.tgz", - "integrity": "sha512-V50p4BxYhtA80eOvulu8xVfPBgZbkxJ1Jr8UUn0rvqjGhLDqKNtfrDfjJKnLz2U8fO2xGQJTx/SKXNTzHOjnHw==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/workbox-expiration/-/workbox-expiration-7.4.1.tgz", + "integrity": "sha512-lRKUF7b+OGbeXkQk1s6MHXOa3d7Xxf7Of31W6c6hCfipfIyrtdWZ89stq21AHZMaoG7VNFoHply4Ox+rU31TWg==", "license": "MIT", "dependencies": { "idb": "^7.0.1", - "workbox-core": "7.4.0" + "workbox-core": "7.4.1" } }, "node_modules/workbox-google-analytics": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/workbox-google-analytics/-/workbox-google-analytics-7.4.0.tgz", - "integrity": "sha512-MVPXQslRF6YHkzGoFw1A4GIB8GrKym/A5+jYDUSL+AeJw4ytQGrozYdiZqUW1TPQHW8isBCBtyFJergUXyNoWQ==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/workbox-google-analytics/-/workbox-google-analytics-7.4.1.tgz", + "integrity": "sha512-Mks1JwLEt++ZAkF6sS1OpSh9RtAMIsiDgRpK+codiHGIPXeaUOgi4cPc3GFadUl8V5QPeypEk8Oxgl3HlwVzHw==", "license": "MIT", "dependencies": { - "workbox-background-sync": "7.4.0", - "workbox-core": "7.4.0", - "workbox-routing": "7.4.0", - "workbox-strategies": "7.4.0" + "workbox-background-sync": "7.4.1", + "workbox-core": "7.4.1", + "workbox-routing": "7.4.1", + "workbox-strategies": "7.4.1" } }, "node_modules/workbox-navigation-preload": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/workbox-navigation-preload/-/workbox-navigation-preload-7.4.0.tgz", - "integrity": "sha512-etzftSgdQfjMcfPgbfaZCfM2QuR1P+4o8uCA2s4rf3chtKTq/Om7g/qvEOcZkG6v7JZOSOxVYQiOu6PbAZgU6w==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/workbox-navigation-preload/-/workbox-navigation-preload-7.4.1.tgz", + "integrity": "sha512-C4KVsjPcYKJOhr631AxR9XoG2rLF3QiTk5aMv36MXOjtWvm8axwNFAtKUPGsWUwLXXAMgYM1En7fsvndaXeXRQ==", "license": "MIT", "dependencies": { - "workbox-core": "7.4.0" + "workbox-core": "7.4.1" } }, "node_modules/workbox-precaching": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/workbox-precaching/-/workbox-precaching-7.4.0.tgz", - "integrity": "sha512-VQs37T6jDqf1rTxUJZXRl3yjZMf5JX/vDPhmx2CPgDDKXATzEoqyRqhYnRoxl6Kr0rqaQlp32i9rtG5zTzIlNg==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/workbox-precaching/-/workbox-precaching-7.4.1.tgz", + "integrity": "sha512-cdr/9qByww7yzEp7zg/qI4ukUrrNjQLgN+ONQRpjy/VqGQXwkgHwr00KksGJK8v0VifwDXBb8a4cWNZH71jn3Q==", "license": "MIT", "dependencies": { - "workbox-core": "7.4.0", - "workbox-routing": "7.4.0", - "workbox-strategies": "7.4.0" + "workbox-core": "7.4.1", + "workbox-routing": "7.4.1", + "workbox-strategies": "7.4.1" } }, "node_modules/workbox-range-requests": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/workbox-range-requests/-/workbox-range-requests-7.4.0.tgz", - "integrity": "sha512-3Vq854ZNuP6Y0KZOQWLaLC9FfM7ZaE+iuQl4VhADXybwzr4z/sMmnLgTeUZLq5PaDlcJBxYXQ3U91V7dwAIfvw==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/workbox-range-requests/-/workbox-range-requests-7.4.1.tgz", + "integrity": "sha512-7i2oxAUE82gHdAJBCAQ04JzNOdRPqzuOzGfoUyJpFSmeqBNYGPrAH8GPoPjUQTfp+NycwrD2H68VtuF8qxv0vQ==", "license": "MIT", "dependencies": { - "workbox-core": "7.4.0" + "workbox-core": "7.4.1" } }, "node_modules/workbox-recipes": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/workbox-recipes/-/workbox-recipes-7.4.0.tgz", - "integrity": "sha512-kOkWvsAn4H8GvAkwfJTbwINdv4voFoiE9hbezgB1sb/0NLyTG4rE7l6LvS8lLk5QIRIto+DjXLuAuG3Vmt3cxQ==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/workbox-recipes/-/workbox-recipes-7.4.1.tgz", + "integrity": "sha512-gnbVfmV4/TtmQaM4x9AtuXhcdstJsep3XMVeztOrQVPT+R6+6DeBjGTCQ7fFCXm+4GEHUA5VEBTyi5+4gWGeog==", "license": "MIT", "dependencies": { - "workbox-cacheable-response": "7.4.0", - "workbox-core": "7.4.0", - "workbox-expiration": "7.4.0", - "workbox-precaching": "7.4.0", - "workbox-routing": "7.4.0", - "workbox-strategies": "7.4.0" + "workbox-cacheable-response": "7.4.1", + "workbox-core": "7.4.1", + "workbox-expiration": "7.4.1", + "workbox-precaching": "7.4.1", + "workbox-routing": "7.4.1", + "workbox-strategies": "7.4.1" } }, "node_modules/workbox-routing": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/workbox-routing/-/workbox-routing-7.4.0.tgz", - "integrity": "sha512-C/ooj5uBWYAhAqwmU8HYQJdOjjDKBp9MzTQ+otpMmd+q0eF59K+NuXUek34wbL0RFrIXe/KKT+tUWcZcBqxbHQ==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/workbox-routing/-/workbox-routing-7.4.1.tgz", + "integrity": "sha512-yubJGErZOusuidAenaL5ypfhQOa7urxP/f8E0ws7FPb4039RiWXUWBAyUkmUoOL/BcQGen3h0J8872d51IYxtA==", "license": "MIT", "dependencies": { - "workbox-core": "7.4.0" + "workbox-core": "7.4.1" } }, "node_modules/workbox-strategies": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/workbox-strategies/-/workbox-strategies-7.4.0.tgz", - "integrity": "sha512-T4hVqIi5A4mHi92+5EppMX3cLaVywDp8nsyUgJhOZxcfSV/eQofcOA6/EMo5rnTNmNTpw0rUgjAI6LaVullPpg==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/workbox-strategies/-/workbox-strategies-7.4.1.tgz", + "integrity": "sha512-GZxpaw9NbmOelj7667uZ2kpk5BFpOGbO4X0qjwh5ls8XQ8C+Lha5LQchTiUzsTFSS+NlUpftYAyOVXvQUrcqOQ==", "license": "MIT", "dependencies": { - "workbox-core": "7.4.0" + "workbox-core": "7.4.1" } }, "node_modules/workbox-streams": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/workbox-streams/-/workbox-streams-7.4.0.tgz", - "integrity": "sha512-QHPBQrey7hQbnTs5GrEVoWz7RhHJXnPT+12qqWM378orDMo5VMJLCkCM1cnCk+8Eq92lccx/VgRZ7WAzZWbSLg==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/workbox-streams/-/workbox-streams-7.4.1.tgz", + "integrity": "sha512-HWWtraKUbJknd9kgqGcpQ3G114HOPYvqs8HaJMDs2ebLNAimDkVDaWfAXE6Ybl+m8U6KsCE6pWyLYuigWmnAXw==", "license": "MIT", "dependencies": { - "workbox-core": "7.4.0", - "workbox-routing": "7.4.0" + "workbox-core": "7.4.1", + "workbox-routing": "7.4.1" } }, "node_modules/workbox-sw": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/workbox-sw/-/workbox-sw-7.4.0.tgz", - "integrity": "sha512-ltU+Kr3qWR6BtbdlMnCjobZKzeV1hN+S6UvDywBrwM19TTyqA03X66dzw1tEIdJvQ4lYKkBFox6IAEhoSEZ8Xw==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/workbox-sw/-/workbox-sw-7.4.1.tgz", + "integrity": "sha512-fez5f2DUlDJWTFYkCWQpY10N8gtztd849NswCbVFk0QlcSM4HT5A8x4g4ii650yem4I8tHY0R7JZahwp3ltIPw==", "license": "MIT" }, "node_modules/workbox-webpack-plugin": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/workbox-webpack-plugin/-/workbox-webpack-plugin-7.4.0.tgz", - "integrity": "sha512-NRgx4lYe4JP5I8qqiROmngbc38WyyN3BZh48lUir2XYJ63EuHWN0KpDxgcYQ/fJtQQIBoswwUPmpqwQmaupnxQ==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/workbox-webpack-plugin/-/workbox-webpack-plugin-7.4.1.tgz", + "integrity": "sha512-Gf8th+7jJbzjABMeZxJDDeKyxmHcsWjXos4vQQRD+6KIk0vtv1k9c6Yf9aletamS3liN3HGojzxbrXuNc+wu4Q==", "license": "MIT", "dependencies": { "fast-json-stable-stringify": "^2.1.0", "pretty-bytes": "^5.4.1", "upath": "^1.2.0", "webpack-sources": "^1.4.3", - "workbox-build": "7.4.0" + "workbox-build": "7.4.1" }, "engines": { "node": ">=20.0.0" @@ -17436,13 +19029,13 @@ } }, "node_modules/workbox-window": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/workbox-window/-/workbox-window-7.4.0.tgz", - "integrity": "sha512-/bIYdBLAVsNR3v7gYGaV4pQW3M3kEPx5E8vDxGvxo6khTrGtSSCS7QiFKv9ogzBgZiy0OXLP9zO28U/1nF1mfw==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/workbox-window/-/workbox-window-7.4.1.tgz", + "integrity": "sha512-notZDH2u8VXaqyuD7xaqIfEFi6SRM4SUSd7ewe9PDsVqADuepxX2ZMY3uvuZGxzY5ZOsGC/vD3A/3smFtJt4/A==", "license": "MIT", "dependencies": { "@types/trusted-types": "^2.0.2", - "workbox-core": "7.4.0" + "workbox-core": "7.4.1" } }, "node_modules/wrap-ansi": { @@ -17480,6 +19073,15 @@ "url": "https://github.com/chalk/wrap-ansi?sponsor=1" } }, + "node_modules/wrap-ansi-cjs/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, "node_modules/wrap-ansi-cjs/node_modules/emoji-regex": { "version": "8.0.0", "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", @@ -17554,9 +19156,9 @@ "license": "ISC" }, "node_modules/ws": { - "version": "8.19.0", - "resolved": "https://registry.npmjs.org/ws/-/ws-8.19.0.tgz", - "integrity": "sha512-blAT2mjOEIi0ZzruJfIhb3nps74PRWTCz1IjglWEEpQl5XS/UNama6u2/rjFkDDouqr4L67ry+1aGIALViWjDg==", + "version": "8.21.0", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.21.0.tgz", + "integrity": "sha512-Vsp28b7DRcimFQvrqu2Wek3z1iYxDCWqHYB8Qsnk/S4RfaCQzPGPyBNuVjJV3cd6UiKtUtp6sNM77gWvzcCH+g==", "license": "MIT", "engines": { "node": ">=10.0.0" @@ -17589,15 +19191,6 @@ "integrity": "sha512-JZnDKK8B0RCDw84FNdDAIpZK+JuJw+s7Lz8nksI7SIuU3UXJJslUthsi+uWBUYOwPFwW7W7PRLRfUKpxjtjFCw==", "license": "MIT" }, - "node_modules/xxhashjs": { - "version": "0.2.2", - "resolved": "https://registry.npmjs.org/xxhashjs/-/xxhashjs-0.2.2.tgz", - "integrity": "sha512-AkTuIuVTET12tpsVIQo+ZU6f/qDmKuRUcjaqR+OIvm+aCBsZ95i7UVY5WJ9TMsSaZ0DA2WxoZ4acu0sPH+OKAw==", - "license": "MIT", - "dependencies": { - "cuint": "^0.2.2" - } - }, "node_modules/yallist": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", diff --git a/package.json b/package.json index 106b14efb..24afcd56e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,9 @@ { "name": "photoprism", "private": true, + "overrides": { + "serialize-javascript": "^7.0.5" + }, "workspaces": [ "frontend" ] diff --git a/pkg/AGENTS.md b/pkg/AGENTS.md new file mode 100644 index 000000000..739389d0f --- /dev/null +++ b/pkg/AGENTS.md @@ -0,0 +1,31 @@ +# Package Security & Test Guidelines + +**Last Updated:** April 9, 2026 + +## Archive Extraction Security + +- Always validate ZIP entry names with a safe join. Reject absolute paths, Windows drive or volume paths, and any entry that escapes the target directory after cleaning. +- ZIP entry names use slash semantics, not host OS semantics: validate with `path.Clean` and `path.IsAbs`, reject backslashes, and use `path.Base` for hidden-name checks. +- Convert ZIP names to OS paths only at write time with `filepath.FromSlash(...)`. +- Enforce destination containment with `filepath.Rel(...)` rather than string-prefix checks. +- Enforce per-file and total-size budgets to prevent resource exhaustion. +- Skip OS metadata directories such as `__MACOSX` and reject suspicious names. +- Keep tests for absolute and volume path rejection, traversal skipping, `__MACOSX` skipping, size limits, directory creation, and safe nested extraction. +- The current implementation lives in `pkg/fs/zip.go` via `Unzip`, `UnzipFile`, and `safeJoin`. + +## HTTP Download Security + +- Use `pkg/http/safe` and `safe.Download(destPath, url, *safe.Options)` instead of ad-hoc `net/http` download code. +- Default policy allows only `http` and `https`, enforces timeouts and max size, writes to a `0600` temp file, then renames into place. +- For SSRF protection, set `AllowPrivate=false` unless a test explicitly needs private or loopback addresses. +- Validate redirect targets and the final connected peer IP. +- Prefer an image-focused `Accept` header for image downloads: `"image/jpeg, image/png, */*;q=0.1"`. +- Use `internal/thumb/avatar.SafeDownload` for avatars and other small images; it applies a 15-second timeout, a 10 MiB cap, and `AllowPrivate=false`. +- Tests using `httptest.Server` on `127.0.0.1` must set `AllowPrivate=true`. +- Keep size budgets small and rely on `io.LimitReader` plus `Content-Length` prechecks. + +## Focused Package Test Runs + +- Filesystem copy, move, and unzip helpers: `go test ./pkg/fs -run 'Copy|Move|Unzip' -count=1` +- Media helpers: `go test ./pkg/media/... -count=1` + diff --git a/pkg/authn/authn.go b/pkg/authn/authn.go index 0bb2ecda9..17ef8bae7 100644 --- a/pkg/authn/authn.go +++ b/pkg/authn/authn.go @@ -1,7 +1,7 @@ /* Package authn helps integrate and abstract authentication providers. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/authn/revoke.go b/pkg/authn/revoke.go new file mode 100644 index 000000000..73fe2ae92 --- /dev/null +++ b/pkg/authn/revoke.go @@ -0,0 +1,16 @@ +package authn + +// SessionScope represents a session revocation target. +type SessionScope uint8 + +const ( + // RevokeLoginSessions removes interactive login sessions while keeping app + // passwords, client access tokens, and sessions derived from app passwords. + RevokeLoginSessions SessionScope = iota + // RevokeDerivedSessions additionally removes sessions derived from an app + // password while keeping the app passwords themselves, so configured devices keep working. + RevokeDerivedSessions + // RevokeAllSessions removes every session, including app password records, + // client access tokens, and sessions derived from them. + RevokeAllSessions +) diff --git a/pkg/capture/capture.go b/pkg/capture/capture.go index 273c204f5..2ea46d45d 100644 --- a/pkg/capture/capture.go +++ b/pkg/capture/capture.go @@ -1,7 +1,7 @@ /* Package capture provides profiling functions for testing and debugging. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/checksum/checksum.go b/pkg/checksum/checksum.go index 25d83fcd3..9e511a17b 100644 --- a/pkg/checksum/checksum.go +++ b/pkg/checksum/checksum.go @@ -1,7 +1,7 @@ /* Package checksum provides functions and abstractions to generate data checksums. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/clean/clean.go b/pkg/clean/clean.go index 49c018d6b..1d3746737 100644 --- a/pkg/clean/clean.go +++ b/pkg/clean/clean.go @@ -1,7 +1,7 @@ /* Package clean provides validation, sanitation, and normalization of input values. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/clean/format.go b/pkg/clean/format.go new file mode 100644 index 000000000..ecf6576d6 --- /dev/null +++ b/pkg/clean/format.go @@ -0,0 +1,15 @@ +package clean + +import ( + "strings" +) + +// FormatSep defines the string separating multiple format identifiers in a list. +const FormatSep = "," + +// Format lowercases and strips the surrounding whitespace and punctuation +// from format identifiers so that inputs like `"mp4"`, ` .avi `, or `magicyuv,` +// normalize to canonical short names suitable for map lookups. +func Format(s string) string { + return strings.ToLower(strings.Trim(s, " .,;:\"'`")) +} diff --git a/pkg/clean/format_test.go b/pkg/clean/format_test.go new file mode 100644 index 000000000..ed3bf6c62 --- /dev/null +++ b/pkg/clean/format_test.go @@ -0,0 +1,51 @@ +package clean + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestFormat(t *testing.T) { + t.Run("Empty", func(t *testing.T) { + assert.Equal(t, "", Format("")) + }) + t.Run("AlreadyClean", func(t *testing.T) { + assert.Equal(t, "mp4", Format("mp4")) + }) + t.Run("MixedCase", func(t *testing.T) { + assert.Equal(t, "magicyuv", Format("MagicYUV")) + assert.Equal(t, "m8rg", Format("M8RG")) + }) + t.Run("LeadingDot", func(t *testing.T) { + assert.Equal(t, "avi", Format(".avi")) + }) + t.Run("TrailingPunctuation", func(t *testing.T) { + assert.Equal(t, "avi", Format("avi,")) + assert.Equal(t, "avi", Format("avi;")) + assert.Equal(t, "avi", Format("avi.")) + }) + t.Run("Whitespace", func(t *testing.T) { + assert.Equal(t, "magicyuv", Format(" magicyuv ")) + // Only space is trimmed; tabs and newlines stay as-is. + assert.Equal(t, "\tmagicyuv", Format("\tmagicyuv ")) + }) + t.Run("Quoted", func(t *testing.T) { + assert.Equal(t, "mp4", Format(`"mp4"`)) + assert.Equal(t, "mp4", Format("'mp4'")) + assert.Equal(t, "mp4", Format("`mp4`")) + }) + t.Run("PunctuationOnly", func(t *testing.T) { + assert.Equal(t, "", Format(".,;:")) + assert.Equal(t, "", Format(" ")) + }) + t.Run("PreservesInnerPunctuation", func(t *testing.T) { + // Only leading/trailing characters are trimmed. + assert.Equal(t, "h.264", Format("H.264")) + assert.Equal(t, "video/mp4", Format("Video/MP4")) + }) +} + +func TestFormatSep(t *testing.T) { + assert.Equal(t, ",", FormatSep) +} diff --git a/pkg/clean/locale.go b/pkg/clean/locale.go index 3db2a2d69..e42222078 100644 --- a/pkg/clean/locale.go +++ b/pkg/clean/locale.go @@ -43,3 +43,28 @@ func WebLocale(locale, defaultLocale string) string { return defaultLocale } + +// rtlLocales contains the ISO 639 primary language subtags rendered right-to-left. +var rtlLocales = map[string]bool{ + "ar": true, // Arabic + "fa": true, // Persian + "he": true, // Hebrew + "ku": true, // Kurdish (Sorani) +} + +// TextDir returns the user interface text direction ("rtl" or "ltr") for the specified locale, +// falling back to defaultLocale when locale is empty or invalid, and to "ltr" otherwise. +func TextDir(locale, defaultLocale string) string { + for _, l := range []string{locale, defaultLocale} { + // WebLocale normalizes the language subtag to lowercase, so no extra ToLower is needed. + if l = WebLocale(l, ""); l == "" { + continue + } else if lang, _, _ := strings.Cut(l, "-"); rtlLocales[lang] { + return "rtl" + } else { + return "ltr" + } + } + + return "ltr" +} diff --git a/pkg/clean/locale_test.go b/pkg/clean/locale_test.go index c7c9ce8be..d6af87747 100644 --- a/pkg/clean/locale_test.go +++ b/pkg/clean/locale_test.go @@ -94,3 +94,24 @@ func TestWebLocale(t *testing.T) { assert.Equal(t, "und", WebLocale("cs_CZX", "und")) }) } + +func TestTextDir(t *testing.T) { + t.Run("LeftToRight", func(t *testing.T) { + assert.Equal(t, "ltr", TextDir("en", "en")) + assert.Equal(t, "ltr", TextDir("de", "en")) + assert.Equal(t, "ltr", TextDir("pt_BR", "en")) + assert.Equal(t, "ltr", TextDir("zh_TW", "en")) + }) + t.Run("RightToLeft", func(t *testing.T) { + assert.Equal(t, "rtl", TextDir("ar", "en")) + assert.Equal(t, "rtl", TextDir("he", "en")) + assert.Equal(t, "rtl", TextDir("fa-IR", "en")) + assert.Equal(t, "rtl", TextDir("KU", "en")) + }) + t.Run("Fallback", func(t *testing.T) { + assert.Equal(t, "ltr", TextDir("", "en")) + assert.Equal(t, "rtl", TextDir("", "ar")) + assert.Equal(t, "ltr", TextDir("und", "de")) + assert.Equal(t, "ltr", TextDir("", "")) + }) +} diff --git a/pkg/clean/name.go b/pkg/clean/name.go index 54f4f78a3..c78333f52 100644 --- a/pkg/clean/name.go +++ b/pkg/clean/name.go @@ -6,16 +6,17 @@ import ( "github.com/photoprism/photoprism/pkg/txt" ) -// Name sanitizes a name string. +// Name sanitizes a name string and clips it to at most txt.ClipDefault +// runes; injection patterns (`${`, `ldap://`) drop the value entirely. +// The cap is character-counted — callers that store the result in a +// byte-counted column must apply their own byte clip. func Name(name string) string { - // Empty or too long? - if name == "" || reject(name, txt.ClipDefault) { + if name == "" || reject(name, 0) { return "" } var prev rune - // Remove unwanted characters. name = strings.Map(func(r rune) rune { if r == ' ' && (prev == 0 || prev == ' ') { return -1 @@ -34,12 +35,6 @@ func Name(name string) string { return r }, name) - // OK? - if name = strings.TrimSpace(name); name == "" { - return "" - } - - // Make sure name isn't too long. return txt.Clip(name, txt.ClipDefault) } diff --git a/pkg/clean/name_test.go b/pkg/clean/name_test.go index 817bdac9f..4f3c2e680 100644 --- a/pkg/clean/name_test.go +++ b/pkg/clean/name_test.go @@ -1,9 +1,12 @@ package clean import ( + "strings" "testing" "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/pkg/txt" ) func TestName(t *testing.T) { @@ -34,6 +37,24 @@ func TestName(t *testing.T) { t.Run("Space", func(t *testing.T) { assert.Equal(t, "", Name(" ")) }) + t.Run("LongName", func(t *testing.T) { + got := Name(strings.Repeat("a", txt.ClipDefault+50)) + assert.Equal(t, txt.ClipDefault, len(got)) + assert.Equal(t, strings.Repeat("a", txt.ClipDefault), got) + }) + t.Run("LongMultiByte", func(t *testing.T) { + // CJK characters are 3 bytes each in UTF-8. The output is capped + // by rune count (so it fits a character-counted VARCHAR(160)); + // callers that need a byte cap must clip on their own side. + got := Name(strings.Repeat("陈", txt.ClipDefault+50)) + assert.Equal(t, txt.ClipDefault, len([]rune(got))) + // Result is valid UTF-8 (no broken trailing rune). + assert.Equal(t, got, string([]rune(got))) + }) + t.Run("Injection", func(t *testing.T) { + assert.Equal(t, "", Name("hello ${jndi:ldap://example.com/x}")) + assert.Equal(t, "", Name("ldap://attacker.example/")) + }) } func TestNameCapitalized(t *testing.T) { diff --git a/pkg/clean/search.go b/pkg/clean/search.go index b5529fb2a..bea20b03d 100644 --- a/pkg/clean/search.go +++ b/pkg/clean/search.go @@ -80,8 +80,8 @@ func SearchString(s string) string { s = strings.ReplaceAll(s, "%", "*") s = strings.ReplaceAll(s, "**", "*") - // Trim. - return strings.Trim(s, "|\\<>\n\r\t") + // Trim — keep '\' so downstream filters can honor escape sequences. + return strings.Trim(s, "|<>\n\r\t") } // SearchQuery replaces search operator with default symbols. diff --git a/pkg/clean/sql.go b/pkg/clean/sql.go index ba41876a6..b61555763 100644 --- a/pkg/clean/sql.go +++ b/pkg/clean/sql.go @@ -51,3 +51,37 @@ func SqlString(s string) string { return string(b[:j]) } + +// SqlClean strips bytes that must be omitted from an SQL parameter value +// (currently control characters below 0x20). Quote characters are preserved +// unchanged because the caller is expected to pass the result through a +// parameterized query, where escaping is the driver's responsibility. +func SqlClean(s string) string { + var i int + for i = 0; i < len(s); i++ { + if _, omit := SqlSpecial(s[i]); omit { + break + } + } + + // Return unchanged if no omittable characters were found. + if i >= len(s) { + return s + } + + b := make([]byte, len(s)) + + copy(b, s[:i]) + + j := i + + for ; i < len(s); i++ { + if _, omit := SqlSpecial(s[i]); omit { + continue + } + b[j] = s[i] + j++ + } + + return string(b[:j]) +} diff --git a/pkg/clean/sql_test.go b/pkg/clean/sql_test.go index 5da499d28..be53c09e7 100644 --- a/pkg/clean/sql_test.go +++ b/pkg/clean/sql_test.go @@ -82,3 +82,31 @@ func TestSqlString(t *testing.T) { assert.Equal(t, "123ABCabc", SqlString("123ABCabc")) }) } + +func TestSqlClean(t *testing.T) { + t.Run("Empty", func(t *testing.T) { + assert.Equal(t, "", SqlClean("")) + }) + t.Run("Alnum", func(t *testing.T) { + assert.Equal(t, "123ABCabc", SqlClean("123ABCabc")) + }) + t.Run("Special", func(t *testing.T) { + // Quotes, backslashes and wildcards are kept; control characters are stripped. + s := "' \" \t \n %_'\\'" + exp := "' \" %_'\\'" + assert.Equal(t, exp, SqlClean(s)) + }) + t.Run("OmitOnly", func(t *testing.T) { + assert.Equal(t, "", SqlClean("\x00\x01\x02\x1f")) + }) + t.Run("EarlyExit", func(t *testing.T) { + // First byte is omittable, so the fast-path early-exit branch is skipped. + assert.Equal(t, "abc", SqlClean("\tabc")) + }) + t.Run("Unicode", func(t *testing.T) { + assert.Equal(t, "Clean《MeUp✀☒ちュس", SqlClean("Clean《MeUp✀☒ちュس")) + }) + t.Run("TrailingControl", func(t *testing.T) { + assert.Equal(t, "abc", SqlClean("abc\n")) + }) +} diff --git a/pkg/clean/state.go b/pkg/clean/state.go index e89607b6b..1a2218866 100644 --- a/pkg/clean/state.go +++ b/pkg/clean/state.go @@ -7,9 +7,10 @@ import ( "github.com/photoprism/photoprism/pkg/txt" ) -// State returns the full, normalized state name. +// State returns the normalized state name clipped to at most txt.ClipName +// runes; injection patterns (`${`, `ldap://`) drop the value entirely. func State(s, countryCode string) string { - if s == "" || reject(s, txt.ClipName) { + if s == "" || reject(s, 0) { return Empty } @@ -49,6 +50,5 @@ func State(s, countryCode string) string { s = normalized } - // Return normalized state name. - return s + return txt.Clip(s, txt.ClipName) } diff --git a/pkg/clean/state_test.go b/pkg/clean/state_test.go index 4f2e0182e..a6024514d 100644 --- a/pkg/clean/state_test.go +++ b/pkg/clean/state_test.go @@ -1,9 +1,12 @@ package clean import ( + "strings" "testing" "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/pkg/txt" ) func TestState(t *testing.T) { @@ -59,5 +62,19 @@ func TestState(t *testing.T) { result := State("Wa?shing*ton"+string(rune(127)), "us") assert.Equal(t, "Washington", result) }) + t.Run("LongName", func(t *testing.T) { + got := State(strings.Repeat("a", txt.ClipName+50), "") + assert.Equal(t, txt.ClipName, len(got)) + assert.Equal(t, strings.Repeat("a", txt.ClipName), got) + }) + t.Run("LongMultiByte", func(t *testing.T) { + got := State(strings.Repeat("陈", txt.ClipName+50), "") + assert.Equal(t, txt.ClipName, len([]rune(got))) + assert.Equal(t, got, string([]rune(got))) + }) + t.Run("Injection", func(t *testing.T) { + assert.Equal(t, "", State("hello ${jndi:ldap://example.com/x}", "")) + assert.Equal(t, "", State("ldap://attacker.example/", "")) + }) } diff --git a/pkg/clean/time.go b/pkg/clean/time.go new file mode 100644 index 000000000..62735239c --- /dev/null +++ b/pkg/clean/time.go @@ -0,0 +1,10 @@ +package clean + +import "time" + +// TimeSet reports whether t points to a meaningful timestamp, i.e. it is non-nil +// and not the zero time. Useful for nullable *time.Time values where both nil and +// a zero value mean "unset". +func TimeSet(t *time.Time) bool { + return t != nil && !t.IsZero() +} diff --git a/pkg/clean/time_test.go b/pkg/clean/time_test.go new file mode 100644 index 000000000..babedde74 --- /dev/null +++ b/pkg/clean/time_test.go @@ -0,0 +1,22 @@ +package clean + +import ( + "testing" + "time" + + "github.com/stretchr/testify/assert" +) + +func TestTimeSet(t *testing.T) { + t.Run("Nil", func(t *testing.T) { + assert.False(t, TimeSet(nil)) + }) + t.Run("Zero", func(t *testing.T) { + zero := time.Time{} + assert.False(t, TimeSet(&zero)) + }) + t.Run("Set", func(t *testing.T) { + now := time.Now() + assert.True(t, TimeSet(&now)) + }) +} diff --git a/pkg/dsn/driver.go b/pkg/dsn/driver.go index 70c0bedac..05615fd75 100644 --- a/pkg/dsn/driver.go +++ b/pkg/dsn/driver.go @@ -1,19 +1,43 @@ package dsn +import "strings" + // SQL database drivers. const ( - DriverMySQL = "mysql" - DriverMariaDB = "mariadb" - DriverPostgres = "postgres" - DriverSQLite3 = "sqlite3" + DriverNone = "" // Unknown or unsupported database driver. + DriverAuto = "auto" // Automatic database driver selection. + DriverMySQL = "mysql" // GORM dialect for MySQL/MariaDB; the canonical driver name PhotoPrism stores. + DriverMariaDB = "mariadb" // Accepted as user input; ParseDriver collapses it to DriverMySQL since the dialect is shared. + DriverPostgres = "postgres" // Reserved identifier; PostgreSQL is not a supported runtime target yet (requires a GORM upgrade). + DriverSQLite3 = "sqlite3" // GORM dialect for SQLite; the default when no driver is configured. + DriverTiDB = "tidb" // Deprecated; recognized so callers can warn and fall back to SQLite. ) // SQLite default DSNs. const ( - SQLiteTestDB = ".test.db" - SQLiteMemory = ":memory:" + SQLiteTestDB = ".test.db" // Default on-disk DSN for tests that need a fresh SQLite database. + SQLiteMemory = ":memory:" // Bare in-memory DSN; each connection gets a separate database (rarely what tests want). + SQLiteMemoryShared = ":memory:?cache=shared" // In-memory DSN with shared page cache; multiple connections share one database. ) +// ParseDriver canonicalizes a user-supplied driver identifier. +func ParseDriver(s string) string { + switch strings.ToLower(strings.TrimSpace(s)) { + case DriverMySQL, DriverMariaDB: + return DriverMySQL + case DriverPostgres, "postgresql": + return DriverPostgres + case DriverSQLite3, "sqlite", "test", "file": + return DriverSQLite3 + case DriverTiDB: + return DriverTiDB + case DriverAuto: + return DriverAuto + default: + return DriverNone + } +} + // Params maps required DSN parameters by driver type. var Params = Values{ DriverMySQL: "charset=utf8mb4,utf8&collation=utf8mb4_unicode_ci&parseTime=true", diff --git a/pkg/dsn/driver_test.go b/pkg/dsn/driver_test.go new file mode 100644 index 000000000..44fa2ba42 --- /dev/null +++ b/pkg/dsn/driver_test.go @@ -0,0 +1,57 @@ +package dsn + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestParseDriver(t *testing.T) { + t.Run("Empty", func(t *testing.T) { + // Empty defaults to SQLite, matching the legacy config switch. + assert.Equal(t, DriverNone, ParseDriver("")) + assert.Equal(t, DriverNone, ParseDriver(" ")) + }) + t.Run("Auto", func(t *testing.T) { + // Empty defaults to SQLite, matching the legacy config switch. + assert.Equal(t, DriverAuto, ParseDriver("auto")) + assert.Equal(t, DriverAuto, ParseDriver(" AUTO ")) + }) + t.Run("MySQL", func(t *testing.T) { + assert.Equal(t, DriverMySQL, ParseDriver("mysql")) + assert.Equal(t, DriverMySQL, ParseDriver("MySQL")) + assert.Equal(t, DriverMySQL, ParseDriver(" mysql ")) + }) + t.Run("MariaDB", func(t *testing.T) { + // MariaDB and MySQL share a wire protocol and GORM dialect, so the + // parser collapses both onto DriverMySQL. + assert.Equal(t, DriverMySQL, ParseDriver("mariadb")) + assert.Equal(t, DriverMySQL, ParseDriver("MariaDB")) + }) + t.Run("Postgres", func(t *testing.T) { + assert.Equal(t, DriverPostgres, ParseDriver("postgres")) + // URI-style DSNs spell the driver "postgresql"; accept it as a Postgres alias. + assert.Equal(t, DriverPostgres, ParseDriver("postgresql")) + assert.Equal(t, DriverPostgres, ParseDriver("PostgreSQL")) + }) + t.Run("SQLite3", func(t *testing.T) { + assert.Equal(t, DriverSQLite3, ParseDriver("sqlite3")) + assert.Equal(t, DriverSQLite3, ParseDriver("SQLite3")) + }) + t.Run("SQLiteAliases", func(t *testing.T) { + // Aliases that have historically resolved to the SQLite driver. + assert.Equal(t, DriverSQLite3, ParseDriver("sqlite")) + assert.Equal(t, DriverSQLite3, ParseDriver("test")) + assert.Equal(t, DriverSQLite3, ParseDriver("file")) + }) + t.Run("TiDB", func(t *testing.T) { + // Recognized so callers can treat it as deprecated; not a supported driver. + assert.Equal(t, DriverTiDB, ParseDriver("tidb")) + assert.Equal(t, DriverTiDB, ParseDriver("TiDB")) + }) + t.Run("Unknown", func(t *testing.T) { + // Unknown inputs return an empty string so the caller's `default` arm fires. + assert.Equal(t, "", ParseDriver("oracle")) + assert.Equal(t, "", ParseDriver("garbage")) + }) +} diff --git a/pkg/dsn/dsn.go b/pkg/dsn/dsn.go index aaf4754b3..6427c0437 100644 --- a/pkg/dsn/dsn.go +++ b/pkg/dsn/dsn.go @@ -2,7 +2,7 @@ Package dsn provides helpers for parsing database data source names, masking credentials, and sharing driver-specific defaults used throughout PhotoPrism. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -15,7 +15,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. @@ -365,24 +365,17 @@ func (d *DSN) splitKeyValue(input string) ([]string, bool) { return tokens, true } -// detectDriver infers the driver name from DSN contents when it is not explicitly specified. +// detectDriver infers the driver name from DSN contents. Explicit driver names +// flow through ParseDriver so both helpers share an alias set; unknown but +// non-empty names are kept (lowercased) rather than misclassified by the +// DSN-string heuristics below. func (d *DSN) detectDriver() { - driver := strings.ToLower(d.Driver) - - switch driver { - case "postgres", "postgresql": - d.Driver = DriverPostgres - return - case "mysql", "mariadb": - d.Driver = DriverMySQL - return - case "sqlite", "sqlite3", "file": - d.Driver = DriverSQLite3 - return - } - - if driver != "" { - d.Driver = driver + if d.Driver != "" { + if normalized := ParseDriver(d.Driver); normalized != "" { + d.Driver = normalized + return + } + d.Driver = strings.ToLower(d.Driver) return } diff --git a/pkg/dsn/parse_test.go b/pkg/dsn/parse_test.go index db8032567..d62e24651 100644 --- a/pkg/dsn/parse_test.go +++ b/pkg/dsn/parse_test.go @@ -105,3 +105,33 @@ func TestParse(t *testing.T) { }) } } + +// TestParse_DriverDetection exercises detectDriver via Parse: alias unification +// with ParseDriver and the preserve-unknown contract. +func TestParse_DriverDetection(t *testing.T) { + t.Run("PostgresqlAliasNormalizes", func(t *testing.T) { + got := Parse("postgresql://alice:s3cr3t@db.local:5432/app") + assert.Equal(t, DriverPostgres, got.Driver) + }) + t.Run("PostgresqlAliasCaseInsensitive", func(t *testing.T) { + got := Parse("POSTGRESQL://alice:s3cr3t@db.local:5432/app") + assert.Equal(t, DriverPostgres, got.Driver) + }) + t.Run("MariaDBAliasCollapsesToMySQL", func(t *testing.T) { + got := Parse("mariadb://user:secret@db.local:3306/app") + assert.Equal(t, DriverMySQL, got.Driver) + }) + t.Run("SqliteAliasNormalizes", func(t *testing.T) { + got := Parse("sqlite:///data/index.db") + assert.Equal(t, DriverSQLite3, got.Driver) + }) + t.Run("UnknownDriverPreserved", func(t *testing.T) { + // Unknown explicit drivers are kept instead of falling through to heuristics. + got := Parse("oracle://user:secret@db.local:1521/app") + assert.Equal(t, "oracle", got.Driver) + }) + t.Run("UnknownDriverPreservedLowercased", func(t *testing.T) { + got := Parse("Snowflake://user:secret@account.region/db") + assert.Equal(t, "snowflake", got.Driver) + }) +} diff --git a/pkg/enum/enum.go b/pkg/enum/enum.go index d0b20a92c..b29686f12 100644 --- a/pkg/enum/enum.go +++ b/pkg/enum/enum.go @@ -2,7 +2,7 @@ Package enum centralizes canonical string constants and lookup tables that we use when interpreting enumerations throughout PhotoPrism. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -15,7 +15,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/env/env.go b/pkg/env/env.go index 736abb510..260d3ec43 100644 --- a/pkg/env/env.go +++ b/pkg/env/env.go @@ -1,7 +1,7 @@ /* Package env provides runtime environment information. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/fs/README.md b/pkg/fs/README.md index 63daba69d..2bdd655ae 100644 --- a/pkg/fs/README.md +++ b/pkg/fs/README.md @@ -1,16 +1,17 @@ ## PhotoPrism — pkg/fs -**Last Updated:** November 25, 2025 +**Last Updated:** April 1, 2026 ### Overview -`pkg/fs` provides safe, cross-platform filesystem helpers used across PhotoPrism. It supplies permission constants, copy/move utilities with force-aware semantics, safe path joins, archive extraction with size limits, MIME and extension lookups, hashing, canonical path casing, and fast directory walking with ignore lists. +`pkg/fs` provides safe, cross-platform filesystem helpers used across PhotoPrism. It supplies permission constants, copy/move utilities with force-aware semantics, safe path joins, archive extraction with size limits, bounded image decode helpers, MIME and extension lookups, hashing, canonical path casing, and fast directory walking with ignore lists. #### Goals - Offer reusable, side-effect-safe filesystem helpers that other packages can call without importing `internal/*`. - Enforce shared permission defaults (`ModeDir`, `ModeFile`, `ModeConfigFile`, `ModeSecretFile`, `ModeBackupFile`). - Protect against common filesystem attacks (path traversal, overwrite of non-empty files without `force`, unsafe zip extraction). +- Provide bounded image decode helpers that do not route TIFF through generic `image.Decode()` dispatch. - Provide consistent file-type detection (extensions/MIME), hashing, and fast walkers with skip logic for caches and `.ppstorage` markers. #### Non-Goals @@ -23,6 +24,7 @@ - Permissions & paths: `mode.go`, `filepath.go`, `canonical.go`, `case.go`. - Copy/Move & write helpers: `copy_move.go`, `write.go`, `cache.go`, `purge.go`. - Archive extraction: `zip.go` (size limits, safe join), tests in `zip_test.go`. +- Bounded image decode helpers: `image_decode.go` (direct JPEG/PNG/GIF/BMP/TIFF/WEBP dispatch with TIFF offset validation). - File info & types: `file_type*.go`, `mime.go`, `file_ext*.go`, `name.go`. - Hashing & IDs: `hash.go`, `id.go`. - Walkers & ignore rules: `walk.go`, `ignore.go`, `done.go`. @@ -33,6 +35,7 @@ - Overwrite semantics: pass `force=true` only when the caller explicitly confirmed replacement; empty files may be replaced without `force`. - Permissions: use provided mode constants; do not mix with stdlib `io/fs` bits. - Zip extraction: always set `fileSizeLimit` / `totalSizeLimit` in `Unzip` for untrusted inputs; ensure tests cover path traversal and size caps (see `zip_test.go`). +- Image decode helpers: use `DecodeImageFile`, `DecodeImageConfigFile`, `DecodeImageData`, or `DecodeImageConfigData` instead of generic `image.Decode()` / `image.DecodeConfig()` for user media. TIFF headers are validated against the bounded reader size before decode. - Focused tests: `go test ./pkg/fs -run 'Copy|Move|Unzip|Write' -count=1` keeps feedback quick; full package: `go test ./pkg/fs -count=1`. ### Recent Changes & Improvements diff --git a/pkg/fs/cache_test.go b/pkg/fs/cache_test.go index 383313273..5b413eb3a 100644 --- a/pkg/fs/cache_test.go +++ b/pkg/fs/cache_test.go @@ -43,6 +43,6 @@ func TestCachePath(t *testing.T) { assert.Equal(t, expected, result) assert.DirExists(t, expected) - _ = os.Remove(expected) + _ = os.RemoveAll(filepath.Join(os.TempDir(), ns)) }) } diff --git a/pkg/fs/const.go b/pkg/fs/const.go index 9602073c4..294dcc900 100644 --- a/pkg/fs/const.go +++ b/pkg/fs/const.go @@ -21,13 +21,13 @@ const ( SecretsDir = "secrets" CmdDir = "cmd" ConfigDir = "config" - ExamplesDir = "examples" IconsDir = "icons" ImgDir = "img" LocalesDir = "locales" MediaDir = "media" ModelsDir = "models" ProfilesDir = "profiles" + SamplesDir = "samples" SettingsDir = "settings" SidecarDir = "sidecar" StaticDir = "static" diff --git a/pkg/fs/directories.go b/pkg/fs/directories.go index 2b5b0f0e7..cebbba094 100644 --- a/pkg/fs/directories.go +++ b/pkg/fs/directories.go @@ -12,18 +12,6 @@ import ( // OriginalPaths lists default Originals search paths. var OriginalPaths = []string{ - "/photoprism/storage/media/originals", - "/photoprism/media/originals", - "/photoprism/originals", - "/srv/photoprism/storage/media/originals", - "/srv/photoprism/media/originals", - "/srv/photoprism/originals", - "/opt/photoprism/storage/media/originals", - "/opt/photoprism/media/originals", - "/opt/photoprism/originals", - "/media/originals", - "/storage/originals", - "/originals", "media/originals", "storage/originals", "photoprism/originals", @@ -74,23 +62,23 @@ var OriginalPaths = []string{ "~/Bilder", "~/fotos", "~/Fotos", + "/photoprism/storage/media/originals", + "/photoprism/media/originals", + "/photoprism/originals", + "/srv/photoprism/storage/media/originals", + "/srv/photoprism/media/originals", + "/srv/photoprism/originals", + "/opt/photoprism/storage/media/originals", + "/opt/photoprism/media/originals", + "/opt/photoprism/originals", + "/media/originals", + "/storage/originals", + "/originals", "/var/lib/photoprism/originals", } // ImportPaths lists default Import search paths. var ImportPaths = []string{ - "/photoprism/storage/media/import", - "/photoprism/media/import", - "/photoprism/import", - "/srv/photoprism/storage/media/import", - "/srv/photoprism/media/import", - "/srv/photoprism/import", - "/opt/photoprism/storage/media/import", - "/opt/photoprism/media/import", - "/opt/photoprism/import", - "/media/import", - "/storage/import", - "/import", "media/import", "storage/import", "photoprism/import", @@ -109,6 +97,18 @@ var ImportPaths = []string{ "~/Photos/Import", "~/import", "~/Import", + "/photoprism/storage/media/import", + "/photoprism/media/import", + "/photoprism/import", + "/srv/photoprism/storage/media/import", + "/srv/photoprism/media/import", + "/srv/photoprism/import", + "/opt/photoprism/storage/media/import", + "/opt/photoprism/media/import", + "/opt/photoprism/import", + "/media/import", + "/storage/import", + "/import", "/var/lib/photoprism/import", } diff --git a/pkg/fs/disk/disk.go b/pkg/fs/disk/disk.go new file mode 100644 index 000000000..9b5d1778f --- /dev/null +++ b/pkg/fs/disk/disk.go @@ -0,0 +1,25 @@ +/* +Package disk provides cached helpers for filesystem free-space checks. + +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. + + This program is free software: you can redistribute it and/or modify + it under Version 3 of the GNU Affero General Public License (the "AGPL"): + <https://docs.photoprism.app/license/agpl> + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + The AGPL is supplemented by our Trademark and Brand Guidelines, + which describe how our Brand Assets may be used: + <https://www.photoprism.app/trademark/> + +Feel free to send an email to hello@photoprism.app if you have questions, +want to support our work, or just want to say hello. + +Additional information can be found in our Developer Guide: +<https://docs.photoprism.app/developer-guide/> +*/ +package disk diff --git a/pkg/fs/disk/free.go b/pkg/fs/disk/free.go new file mode 100644 index 000000000..430c8a229 --- /dev/null +++ b/pkg/fs/disk/free.go @@ -0,0 +1,75 @@ +package disk + +import ( + "sync" + "time" + + "github.com/photoprism/photoprism/pkg/fs/duf" +) + +// DefaultCacheTTL specifies the cache TTL default. +const DefaultCacheTTL = 5 * time.Minute + +// CacheTTL controls how long Free results are cached per path. +// Read on every lookup so callers may retune it at runtime. +var CacheTTL = DefaultCacheTTL + +// freeEntry caches a single Free probe with its expiry time. +type freeEntry struct { + free uint64 + total uint64 + expiresAt time.Time +} + +var ( + freeMu sync.RWMutex + freeCache = map[string]freeEntry{} +) + +// Free returns the cached free and total bytes for the filesystem that owns path. +func Free(path string) (free, total uint64, err error) { + now := time.Now() + + freeMu.RLock() + entry, ok := freeCache[path] + freeMu.RUnlock() + + if ok && now.Before(entry.expiresAt) { + return entry.free, entry.total, nil + } + + mount, err := duf.PathInfo(path) + if err != nil { + return 0, 0, err + } + + freeMu.Lock() + freeCache[path] = freeEntry{ + free: mount.Free, + total: mount.Total, + expiresAt: now.Add(CacheTTL), + } + freeMu.Unlock() + + return mount.Free, mount.Total, nil +} + +// FlushFree clears the cache so a freshly freed disk is detected immediately +// without waiting for CacheTTL to expire. +func FlushFree() { + freeMu.Lock() + freeCache = map[string]freeEntry{} + freeMu.Unlock() +} + +// SetFree stores a free/total entry for path in the cache, expiring after CacheTTL. +// Allows tests and external probes to inject known values without hitting the filesystem. +func SetFree(path string, free, total uint64) { + freeMu.Lock() + freeCache[path] = freeEntry{ + free: free, + total: total, + expiresAt: time.Now().Add(CacheTTL), + } + freeMu.Unlock() +} diff --git a/pkg/fs/disk/free_test.go b/pkg/fs/disk/free_test.go new file mode 100644 index 000000000..c9c826e30 --- /dev/null +++ b/pkg/fs/disk/free_test.go @@ -0,0 +1,146 @@ +package disk + +import ( + "sync" + "testing" + "time" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +// reset clears state mutated by individual tests so they cannot leak into one another. +func reset(t *testing.T) { + t.Helper() + FlushFree() + t.Cleanup(func() { + CacheTTL = DefaultCacheTTL + StorageLowPct = DefaultStorageLowPct + StorageLowBytes = DefaultStorageLowBytes + FlushFree() + }) +} + +func TestFree(t *testing.T) { + t.Run("Success", func(t *testing.T) { + reset(t) + + free, total, err := Free("/") + require.NoError(t, err) + assert.NotZero(t, total) + assert.LessOrEqual(t, free, total) + }) + t.Run("Cached", func(t *testing.T) { + reset(t) + + free1, total1, err := Free("/") + require.NoError(t, err) + + free2, total2, err := Free("/") + require.NoError(t, err) + + // Repeated calls within the TTL must return the cached values + // even if the underlying filesystem has changed in the meantime. + assert.Equal(t, free1, free2) + assert.Equal(t, total1, total2) + + freeMu.RLock() + _, hit := freeCache["/"] + freeMu.RUnlock() + assert.True(t, hit, "expected cache entry for /") + }) + t.Run("Expires", func(t *testing.T) { + reset(t) + CacheTTL = time.Nanosecond + + _, _, err := Free("/") + require.NoError(t, err) + + // Sleep long enough for the TTL to have elapsed. + time.Sleep(10 * time.Millisecond) + + freeMu.RLock() + stale := freeCache["/"] + freeMu.RUnlock() + assert.True(t, time.Now().After(stale.expiresAt), "cached entry should be expired") + + // Restore a meaningful TTL so the refresh produces a future expiry we can assert on. + CacheTTL = time.Hour + + _, _, err = Free("/") + require.NoError(t, err) + + freeMu.RLock() + refreshed := freeCache["/"] + freeMu.RUnlock() + assert.True(t, refreshed.expiresAt.After(stale.expiresAt), "cached entry should have been refreshed") + assert.True(t, time.Now().Before(refreshed.expiresAt), "refreshed entry must expire in the future") + }) + t.Run("InvalidPath", func(t *testing.T) { + reset(t) + + _, _, err := Free("") + assert.Error(t, err) + + freeMu.RLock() + _, hit := freeCache[""] + freeMu.RUnlock() + assert.False(t, hit, "errored probe must not populate the cache") + }) +} + +func TestFlushFree(t *testing.T) { + reset(t) + + _, _, err := Free("/") + require.NoError(t, err) + + freeMu.RLock() + assert.NotEmpty(t, freeCache) + freeMu.RUnlock() + + FlushFree() + + freeMu.RLock() + assert.Empty(t, freeCache) + freeMu.RUnlock() +} + +func TestSetFree(t *testing.T) { + reset(t) + + SetFree("/seeded", 42*MB, 100*MB) + + free, total, err := Free("/seeded") + require.NoError(t, err) + assert.Equal(t, 42*MB, free) + assert.Equal(t, 100*MB, total) + + // Subsequent SetFree calls must overwrite the prior entry. + SetFree("/seeded", 7*MB, 100*MB) + + free, _, err = Free("/seeded") + require.NoError(t, err) + assert.Equal(t, 7*MB, free) +} + +func TestFree_Concurrent(t *testing.T) { + reset(t) + + // Hammer the cache from many goroutines to confirm the RWMutex layout is correct. + var wg sync.WaitGroup + for range 50 { + wg.Add(1) + go func() { + defer wg.Done() + _, _, err := Free("/") + assert.NoError(t, err) + }() + wg.Add(1) + go func() { + defer wg.Done() + FlushFree() + }() + } + wg.Wait() +} diff --git a/pkg/fs/disk/nospace.go b/pkg/fs/disk/nospace.go new file mode 100644 index 000000000..4cd6ea3cb --- /dev/null +++ b/pkg/fs/disk/nospace.go @@ -0,0 +1,37 @@ +package disk + +import ( + "errors" + "strings" + "syscall" + + "github.com/photoprism/photoprism/pkg/log/status" +) + +// IsNoSpace reports whether err indicates the filesystem is out of space. +// It matches both the ENOSPC errno returned by direct file writes and the +// "no space left on device" text that external converters surface via stderr, +// since their errors reach us as plain strings without the original errno. +func IsNoSpace(err error) bool { + if err == nil { + return false + } + + if errors.Is(err, syscall.ENOSPC) { + return true + } + + return strings.Contains(strings.ToLower(err.Error()), "no space left on device") +} + +// AsInsufficientStorage maps an out-of-space write error to status.ErrInsufficientStorage +// and flushes the cached free-space probe so the next check reflects the full disk; +// nil and unrelated errors are returned unchanged. +func AsInsufficientStorage(err error) error { + if IsNoSpace(err) { + FlushFree() + return status.ErrInsufficientStorage + } + + return err +} diff --git a/pkg/fs/disk/nospace_test.go b/pkg/fs/disk/nospace_test.go new file mode 100644 index 000000000..0a39a170e --- /dev/null +++ b/pkg/fs/disk/nospace_test.go @@ -0,0 +1,51 @@ +package disk + +import ( + "errors" + "fmt" + "syscall" + "testing" + + "github.com/stretchr/testify/assert" + + "github.com/photoprism/photoprism/pkg/log/status" +) + +func TestIsNoSpace(t *testing.T) { + t.Run("Nil", func(t *testing.T) { + assert.False(t, IsNoSpace(nil)) + }) + t.Run("Errno", func(t *testing.T) { + assert.True(t, IsNoSpace(syscall.ENOSPC)) + }) + t.Run("WrappedErrno", func(t *testing.T) { + assert.True(t, IsNoSpace(fmt.Errorf("convert: failed (%w)", syscall.ENOSPC))) + }) + t.Run("StringMatch", func(t *testing.T) { + assert.True(t, IsNoSpace(errors.New("vips2png: unable to write to target: No space left on device"))) + }) + t.Run("Unrelated", func(t *testing.T) { + assert.False(t, IsNoSpace(errors.New("permission denied"))) + }) +} + +func TestAsInsufficientStorage(t *testing.T) { + t.Run("Nil", func(t *testing.T) { + assert.Nil(t, AsInsufficientStorage(nil)) + }) + t.Run("NoSpaceMapsToSentinel", func(t *testing.T) { + // Seed the cache so we can confirm the flush. + SetFree("/tmp/disk-nospace-test", 1<<30, 1<<40) + err := AsInsufficientStorage(syscall.ENOSPC) + assert.ErrorIs(t, err, status.ErrInsufficientStorage) + + freeMu.RLock() + _, cached := freeCache["/tmp/disk-nospace-test"] + freeMu.RUnlock() + assert.False(t, cached, "free-space cache should be flushed after an out-of-space error") + }) + t.Run("Unrelated", func(t *testing.T) { + orig := errors.New("permission denied") + assert.Equal(t, orig, AsInsufficientStorage(orig)) + }) +} diff --git a/pkg/fs/disk/storage.go b/pkg/fs/disk/storage.go new file mode 100644 index 000000000..dd7731894 --- /dev/null +++ b/pkg/fs/disk/storage.go @@ -0,0 +1,36 @@ +package disk + +const ( + MB uint64 = 1024 * 1024 // MB defines one megabyte. + DefaultStorageLowPct = 1.0 // DefaultStorageLowPct defines free storage percent default. + DefaultStorageLowBytes = 100 * MB // DefaultStorageLowBytes defines free storage bytes default. +) + +// StorageLowPct is the percentage of total storage space below which it is considered critically low. +var StorageLowPct = DefaultStorageLowPct + +// StorageLowBytes is the number of free bytes below which storage is considered critically low. +var StorageLowBytes = DefaultStorageLowBytes + +// StorageLow reports free bytes on path and whether free space is critically low, +// i.e. below the StorageLowBytes floor or below StorageLowPct percent of total capacity. +// Setting StorageLowPct outside the open range (0, 100) disables the check entirely, +// including the StorageLowBytes floor. +func StorageLow(path string) (free uint64, low bool, err error) { + if StorageLowPct <= 0 || StorageLowPct >= 100 { + free, _, err = Free(path) + return free, false, err + } + + free, total, err := Free(path) + + if err != nil { + return 0, false, err + } else if total == 0 { + return free, false, nil + } + + low = free < StorageLowBytes || float64(free)*100 < StorageLowPct*float64(total) + + return free, low, nil +} diff --git a/pkg/fs/disk/storage_test.go b/pkg/fs/disk/storage_test.go new file mode 100644 index 000000000..362ba2f2d --- /dev/null +++ b/pkg/fs/disk/storage_test.go @@ -0,0 +1,112 @@ +package disk + +import ( + "testing" + "time" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func TestStorageLow(t *testing.T) { + t.Run("AboveThreshold", func(t *testing.T) { + reset(t) + StorageLowPct = 0.0001 + + // A 0.0001% threshold on a real filesystem is effectively never low. + free, low, err := StorageLow("/") + require.NoError(t, err) + assert.False(t, low) + assert.NotZero(t, free) + }) + t.Run("BelowThreshold", func(t *testing.T) { + reset(t) + StorageLowPct = 1.0 + + // Seed the cache so the verdict does not depend on the host filesystem's actual fill level. + freeMu.Lock() + freeCache["/below"] = freeEntry{free: 5 * MB, total: 1000 * MB, expiresAt: time.Now().Add(time.Hour)} + freeMu.Unlock() + + free, low, err := StorageLow("/below") + require.NoError(t, err) + assert.True(t, low) + assert.Equal(t, 5*MB, free) + }) + t.Run("ExactlyAtThreshold", func(t *testing.T) { + reset(t) + StorageLowPct = 1.0 + StorageLowBytes = 5 * MB + + // Seed the cache with a known free / total split so the threshold math is deterministic. + freeMu.Lock() + freeCache["/synthetic"] = freeEntry{free: 10 * MB, total: 1000 * MB, expiresAt: time.Now().Add(time.Hour)} + freeMu.Unlock() + // free*100 == StorageLowPct*total is the boundary and must not count as low (strict less-than). + _, low, err := StorageLow("/synthetic") + require.NoError(t, err) + assert.False(t, low, "boundary value must not be flagged as low") + + // One byte less than the boundary must flip the verdict. + freeMu.Lock() + freeCache["/synthetic"] = freeEntry{free: 9 * MB, total: 1000 * MB, expiresAt: time.Now().Add(time.Hour)} + freeMu.Unlock() + + _, low, err = StorageLow("/synthetic") + require.NoError(t, err) + assert.True(t, low) + }) + t.Run("BytesFloorOnly", func(t *testing.T) { + reset(t) + StorageLowPct = 1.0 + StorageLowBytes = 100 * MB + + // On a small volume the 1% percentage threshold (10 MB of 1000 MB) sits below the + // absolute floor, so free space above the percentage but below the floor is still low. + freeMu.Lock() + freeCache["/smalldisk"] = freeEntry{free: 50 * MB, total: 1000 * MB, expiresAt: time.Now().Add(time.Hour)} + freeMu.Unlock() + + free, low, err := StorageLow("/smalldisk") + require.NoError(t, err) + assert.True(t, low, "free below the byte floor must be flagged even when the percentage is fine") + assert.Equal(t, 50*MB, free) + }) + t.Run("ZeroTotal", func(t *testing.T) { + reset(t) + StorageLowPct = 50 + + // A zero-total filesystem must never be reported as low so unmounted or unreadable + // paths do not trigger a spurious abort. + freeMu.Lock() + freeCache["/empty"] = freeEntry{free: 0, total: 0, expiresAt: time.Now().Add(time.Hour)} + freeMu.Unlock() + + _, low, err := StorageLow("/empty") + require.NoError(t, err) + assert.False(t, low) + }) + t.Run("ThresholdOutOfRange", func(t *testing.T) { + reset(t) + StorageLowBytes = 0 + + freeMu.Lock() + freeCache["/out"] = freeEntry{free: 1 * MB, total: 1000 * MB, expiresAt: time.Now().Add(time.Hour)} + freeMu.Unlock() + + for _, pct := range []float64{-1, 0, 100, 250} { + StorageLowPct = pct + _, low, err := StorageLow("/out") + require.NoError(t, err) + assert.False(t, low, "out-of-range threshold %v must never be low", pct) + } + }) + t.Run("InvalidPath", func(t *testing.T) { + reset(t) + StorageLowPct = 1.0 + + _, low, err := StorageLow("") + assert.Error(t, err) + assert.False(t, low) + }) +} diff --git a/pkg/fs/duf/duf.go b/pkg/fs/duf/duf.go index f0ecdcd5a..3510d7cc2 100644 --- a/pkg/fs/duf/duf.go +++ b/pkg/fs/duf/duf.go @@ -1,7 +1,7 @@ /* Package duf provides file system usage information. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> This code is copied and modified in part from: @@ -64,22 +64,22 @@ func FindByPath(dir string) (m []Mount, warnings []string, err error) { return m, warnings, fmt.Errorf("empty path name") } - folders := strings.Split(dir, "/") - - filter := FilterOptions{} - - if len(folders) <= 1 { - filter.OnlyMountPoints = NewFilterValues("/") - } else if parent := strings.TrimSpace(folders[1]); parent != "" { - filter.OnlyMountPoints = NewFilterValues("/", "/"+parent+"*") - } else if len(folders) > 2 { - filter.OnlyMountPoints = NewFilterValues("/") + // Resolve the filesystem that contains dir by longest-prefix match against all mounts, + // including any hidden from the df-style listing (e.g. an overlay root), so callers such as + // Free and StorageLow get the actual containing filesystem for any path. + allMounts, warnings, err := mounts() + if err != nil { + return nil, warnings, err } - m, warnings, err = Find(filter) + m, err = findMounts(allMounts, dir) + if err != nil { + return nil, warnings, err + } + // Order the closest (longest mountpoint) match first so m[0] is the containing filesystem. sort.SliceStable(m, func(i, j int) bool { - return strings.Compare(m[i].Mountpoint, m[j].Mountpoint) >= 0 + return len(m[i].Mountpoint) > len(m[j].Mountpoint) }) return m, warnings, err diff --git a/pkg/fs/duf/duf_test.go b/pkg/fs/duf/duf_test.go index 21e189a58..96859285f 100644 --- a/pkg/fs/duf/duf_test.go +++ b/pkg/fs/duf/duf_test.go @@ -49,7 +49,6 @@ func TestPathInfo(t *testing.T) { // Check result for plausibility. assert.NotEmpty(t, result.Device) - assert.Equal(t, "local", result.DeviceType) assert.Equal(t, "/photoprism", result.Mountpoint) assert.NotEmpty(t, result.Fstype) assert.NotEmpty(t, result.Opts) @@ -63,6 +62,15 @@ func TestPathInfo(t *testing.T) { assert.NotEmpty(t, result.BlockSize) assert.NotEmpty(t, result.Metadata) }) + t.Run("RootPath", func(t *testing.T) { + // Regression: "/" splits to ["", ""], so it must still resolve to the root mount + // rather than an arbitrary special filesystem such as a masked /sys/firmware tmpfs. + result, err := PathInfo("/") + + assert.NoError(t, err) + assert.Equal(t, "/", result.Mountpoint) + assert.Greater(t, result.Total, uint64(4096)) + }) t.Run("NotFound", func(t *testing.T) { // Get slice of mounted file systems. result, err := PathInfo("notfound") @@ -103,7 +111,6 @@ func TestFindByPath(t *testing.T) { // If so, check the first mount for plausibility. result := results[0] assert.NotEmpty(t, result.Device) - assert.Equal(t, "local", result.DeviceType) assert.Equal(t, "/photoprism", result.Mountpoint) assert.NotEmpty(t, result.Fstype) assert.NotEmpty(t, result.Opts) diff --git a/pkg/fs/duf/filesystems.go b/pkg/fs/duf/filesystems.go index bd7974e17..3403e1193 100644 --- a/pkg/fs/duf/filesystems.go +++ b/pkg/fs/duf/filesystems.go @@ -6,7 +6,7 @@ import ( "strings" ) -// nolint:unused // kept for potential platform-specific filesystem filtering +// findMounts returns the mounts that contain path, closest (longest mountpoint) first. func findMounts(mounts []Mount, path string) ([]Mount, error) { var err error path, err = filepath.Abs(path) diff --git a/pkg/fs/file_types.go b/pkg/fs/file_types.go index 76313c1df..a900bb42c 100644 --- a/pkg/fs/file_types.go +++ b/pkg/fs/file_types.go @@ -6,7 +6,6 @@ import ( _ "image/png" // register PNG decoder _ "golang.org/x/image/bmp" // register BMP decoder - _ "golang.org/x/image/tiff" // register TIFF decoder _ "golang.org/x/image/webp" // register WEBP decoder ) diff --git a/pkg/fs/file_types_ext.go b/pkg/fs/file_types_ext.go index b65001abb..19e596ed9 100644 --- a/pkg/fs/file_types_ext.go +++ b/pkg/fs/file_types_ext.go @@ -6,7 +6,6 @@ import ( _ "image/png" // register PNG decoder _ "golang.org/x/image/bmp" // register BMP decoder - _ "golang.org/x/image/tiff" // register TIFF decoder _ "golang.org/x/image/webp" // register WEBP decoder ) diff --git a/pkg/fs/fs.go b/pkg/fs/fs.go index 1a9321cb3..90bdde733 100644 --- a/pkg/fs/fs.go +++ b/pkg/fs/fs.go @@ -1,7 +1,7 @@ /* Package fs provides filesystem related constants and functions. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/fs/fs_test.go b/pkg/fs/fs_test.go index ae66ca507..4e30cdeac 100644 --- a/pkg/fs/fs_test.go +++ b/pkg/fs/fs_test.go @@ -13,16 +13,19 @@ import ( "github.com/stretchr/testify/assert" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) int { if insensitive, err := CaseInsensitive(os.TempDir()); err != nil { fmt.Println(err) } else if insensitive { IgnoreCase() } - code := m.Run() - - os.Exit(code) + return m.Run() } // newTestServer creates an HTTP test server and registers cleanup. diff --git a/pkg/fs/image_decode.go b/pkg/fs/image_decode.go new file mode 100644 index 000000000..df9a90fc6 --- /dev/null +++ b/pkg/fs/image_decode.go @@ -0,0 +1,238 @@ +package fs + +import ( + "bytes" + "encoding/binary" + "fmt" + "image" + "image/gif" + "image/jpeg" + "image/png" + "io" + "os" + + "golang.org/x/image/bmp" + "golang.org/x/image/tiff" + "golang.org/x/image/webp" +) + +type imageFormat int + +const ( + imageFormatUnknown imageFormat = iota + imageFormatJPEG + imageFormatPNG + imageFormatGIF + imageFormatBMP + imageFormatTIFF + imageFormatWEBP +) + +var errUnsupportedImageFormat = fmt.Errorf("unsupported image format") + +// openImageSection opens a file and returns a bounded reader spanning its current size. +func openImageSection(fileName string) (file *os.File, reader *io.SectionReader, err error) { + file, err = os.Open(fileName) //nolint:gosec // fileName is supplied by the caller and may point to user media + if err != nil { + return nil, nil, err + } + + info, err := file.Stat() + if err != nil { + _ = file.Close() + return nil, nil, err + } + + return file, io.NewSectionReader(file, 0, info.Size()), nil +} + +// DecodeImageFile opens and decodes a natively supported image file using direct format decoders. +func DecodeImageFile(fileName string) (_ image.Image, _ string, err error) { + file, reader, err := openImageSection(fileName) + if err != nil { + return nil, "", err + } + defer func() { + if closeErr := file.Close(); closeErr != nil && err == nil { + err = closeErr + } + }() + + return decodeImage(reader) +} + +// DecodeImageConfigFile opens a natively supported image file and decodes only its config. +func DecodeImageConfigFile(fileName string) (_ image.Config, _ string, err error) { + file, reader, err := openImageSection(fileName) + if err != nil { + return image.Config{}, "", err + } + defer func() { + if closeErr := file.Close(); closeErr != nil && err == nil { + err = closeErr + } + }() + + return decodeImageConfig(reader) +} + +// DecodeImageData decodes a natively supported image from a bounded in-memory buffer. +func DecodeImageData(data []byte) (image.Image, string, error) { + reader := bytes.NewReader(data) + return decodeImage(io.NewSectionReader(reader, 0, int64(len(data)))) +} + +// DecodeImageConfigData decodes the config for a natively supported in-memory image buffer. +func DecodeImageConfigData(data []byte) (image.Config, string, error) { + reader := bytes.NewReader(data) + return decodeImageConfig(io.NewSectionReader(reader, 0, int64(len(data)))) +} + +// decodeImage decodes a bounded image reader by dispatching to the matching direct decoder. +func decodeImage(reader *io.SectionReader) (image.Image, string, error) { + format, err := detectImageFormat(reader) + if err != nil { + return nil, "", err + } + + switch format { + case imageFormatJPEG: + img, err := jpeg.Decode(reader) + return img, "jpeg", err + case imageFormatPNG: + img, err := png.Decode(reader) + return img, "png", err + case imageFormatGIF: + img, err := gif.Decode(reader) + return img, "gif", err + case imageFormatBMP: + img, err := bmp.Decode(reader) + return img, "bmp", err + case imageFormatTIFF: + img, err := tiff.Decode(reader) + return img, "tiff", err + case imageFormatWEBP: + img, err := webp.Decode(reader) + return img, "webp", err + default: + return nil, "", errUnsupportedImageFormat + } +} + +// decodeImageConfig decodes only the image config from a bounded reader. +func decodeImageConfig(reader *io.SectionReader) (image.Config, string, error) { + format, err := detectImageFormat(reader) + if err != nil { + return image.Config{}, "", err + } + + switch format { + case imageFormatJPEG: + cfg, err := jpeg.DecodeConfig(reader) + return cfg, "jpeg", err + case imageFormatPNG: + cfg, err := png.DecodeConfig(reader) + return cfg, "png", err + case imageFormatGIF: + cfg, err := gif.DecodeConfig(reader) + return cfg, "gif", err + case imageFormatBMP: + cfg, err := bmp.DecodeConfig(reader) + return cfg, "bmp", err + case imageFormatTIFF: + cfg, err := tiff.DecodeConfig(reader) + return cfg, "tiff", err + case imageFormatWEBP: + cfg, err := webp.DecodeConfig(reader) + return cfg, "webp", err + default: + return image.Config{}, "", errUnsupportedImageFormat + } +} + +// detectImageFormat inspects the header bytes and validates TIFF offsets before decode. +func detectImageFormat(reader *io.SectionReader) (imageFormat, error) { + headerSize := reader.Size() + if headerSize <= 0 { + return imageFormatUnknown, io.ErrUnexpectedEOF + } + + header := make([]byte, min(16, int(headerSize))) + if _, err := reader.ReadAt(header, 0); err != nil && err != io.EOF { + return imageFormatUnknown, err + } + + switch { + case isJPEGHeader(header): + return imageFormatJPEG, nil + case isPNGHeader(header): + return imageFormatPNG, nil + case isGIFHeader(header): + return imageFormatGIF, nil + case isBMPHeader(header): + return imageFormatBMP, nil + case isWEBPHeader(header): + return imageFormatWEBP, nil + case isTIFFHeader(header): + if err := validateTIFFOffset(header, reader.Size()); err != nil { + return imageFormatUnknown, err + } + return imageFormatTIFF, nil + default: + return imageFormatUnknown, errUnsupportedImageFormat + } +} + +// isJPEGHeader reports whether the header matches the JPEG SOI marker. +func isJPEGHeader(header []byte) bool { + return len(header) >= 2 && header[0] == 0xff && header[1] == 0xd8 +} + +// isPNGHeader reports whether the header matches the PNG signature. +func isPNGHeader(header []byte) bool { + return len(header) >= 8 && bytes.Equal(header[:8], []byte{0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a}) +} + +// isGIFHeader reports whether the header matches a GIF signature. +func isGIFHeader(header []byte) bool { + return len(header) >= 6 && (bytes.Equal(header[:6], []byte("GIF87a")) || bytes.Equal(header[:6], []byte("GIF89a"))) +} + +// isBMPHeader reports whether the header matches a BMP signature. +func isBMPHeader(header []byte) bool { + return len(header) >= 2 && header[0] == 'B' && header[1] == 'M' +} + +// isWEBPHeader reports whether the header matches a RIFF WEBP container. +func isWEBPHeader(header []byte) bool { + return len(header) >= 12 && bytes.Equal(header[:4], []byte("RIFF")) && bytes.Equal(header[8:12], []byte("WEBP")) +} + +// isTIFFHeader reports whether the header matches a classic TIFF signature. +func isTIFFHeader(header []byte) bool { + return len(header) >= 8 && (bytes.Equal(header[:4], []byte{0x49, 0x49, 0x2a, 0x00}) || bytes.Equal(header[:4], []byte{0x4d, 0x4d, 0x00, 0x2a})) +} + +// validateTIFFOffset checks the initial TIFF IFD offset against the bounded reader size. +func validateTIFFOffset(header []byte, size int64) error { + if len(header) < 8 { + return io.ErrUnexpectedEOF + } + + var order binary.ByteOrder + switch { + case bytes.Equal(header[:4], []byte{0x49, 0x49, 0x2a, 0x00}): + order = binary.LittleEndian + case bytes.Equal(header[:4], []byte{0x4d, 0x4d, 0x00, 0x2a}): + order = binary.BigEndian + default: + return fmt.Errorf("invalid TIFF header") + } + + ifdOffset := int64(order.Uint32(header[4:8])) + if ifdOffset < 0 || ifdOffset >= size { + return fmt.Errorf("invalid TIFF: IFD offset %d exceeds file size %d", ifdOffset, size) + } + + return nil +} diff --git a/pkg/fs/image_decode_test.go b/pkg/fs/image_decode_test.go new file mode 100644 index 000000000..2f21bdf5c --- /dev/null +++ b/pkg/fs/image_decode_test.go @@ -0,0 +1,179 @@ +package fs + +import ( + "bytes" + "image" + "image/png" + "io" + "os" + "path/filepath" + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func malformedLittleEndianTIFFIfdOffset() []byte { + return []byte{0x49, 0x49, 0x2a, 0x00, 0xff, 0xff, 0xff, 0xff} +} + +func malformedBigEndianTIFFIfdOffset() []byte { + return []byte{0x4d, 0x4d, 0x00, 0x2a, 0xff, 0xff, 0xff, 0xff} +} + +func truncatedTIFFBody() []byte { + return []byte{0x49, 0x49, 0x2a, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00} +} + +func TestDecodeImageConfigFile(t *testing.T) { + t.Run("Png", func(t *testing.T) { + fileName := filepath.Join(t.TempDir(), "pixel.png") + buf := bytes.NewBuffer(nil) + require.NoError(t, png.Encode(buf, image.NewNRGBA(image.Rect(0, 0, 1, 1)))) + require.NoError(t, os.WriteFile(fileName, buf.Bytes(), ModeFile)) + + cfg, format, err := DecodeImageConfigFile(fileName) + + require.NoError(t, err) + assert.Equal(t, "png", format) + assert.Equal(t, 1, cfg.Width) + assert.Equal(t, 1, cfg.Height) + }) + t.Run("LayeredTiff", func(t *testing.T) { + fileName := Abs("../../assets/samples/layered-16bit-small.tif") + + cfg, format, err := DecodeImageConfigFile(fileName) + + require.NoError(t, err) + assert.Equal(t, "tiff", format) + assert.Equal(t, 236, cfg.Width) + assert.Equal(t, 158, cfg.Height) + }) + t.Run("MalformedTiffIfdOffset", func(t *testing.T) { + fileName := filepath.Join(t.TempDir(), "evil.tiff") + payload := malformedLittleEndianTIFFIfdOffset() + require.NoError(t, os.WriteFile(fileName, payload, ModeFile)) + + _, _, err := DecodeImageConfigFile(fileName) + + require.Error(t, err) + }) + t.Run("MalformedBigEndianTiffIfdOffset", func(t *testing.T) { + fileName := filepath.Join(t.TempDir(), "evil-mm.tiff") + require.NoError(t, os.WriteFile(fileName, malformedBigEndianTIFFIfdOffset(), ModeFile)) + + _, _, err := DecodeImageConfigFile(fileName) + + require.Error(t, err) + assert.Contains(t, err.Error(), "invalid TIFF: IFD offset") + }) + t.Run("TruncatedTiffBody", func(t *testing.T) { + fileName := filepath.Join(t.TempDir(), "truncated.tiff") + require.NoError(t, os.WriteFile(fileName, truncatedTIFFBody(), ModeFile)) + + _, _, err := DecodeImageConfigFile(fileName) + + require.Error(t, err) + assert.ErrorIs(t, err, io.EOF) + }) +} + +func TestDecodeImageFile(t *testing.T) { + t.Run("Png", func(t *testing.T) { + fileName := filepath.Join(t.TempDir(), "pixel.png") + buf := bytes.NewBuffer(nil) + require.NoError(t, png.Encode(buf, image.NewNRGBA(image.Rect(0, 0, 2, 3)))) + require.NoError(t, os.WriteFile(fileName, buf.Bytes(), ModeFile)) + + img, format, err := DecodeImageFile(fileName) + + require.NoError(t, err) + assert.Equal(t, "png", format) + assert.Equal(t, 2, img.Bounds().Dx()) + assert.Equal(t, 3, img.Bounds().Dy()) + }) + t.Run("LayeredTiff", func(t *testing.T) { + fileName := Abs("../../assets/samples/layered-16bit-small.tif") + + img, format, err := DecodeImageFile(fileName) + + require.NoError(t, err) + assert.Equal(t, "tiff", format) + assert.Equal(t, 236, img.Bounds().Dx()) + assert.Equal(t, 158, img.Bounds().Dy()) + }) + t.Run("MalformedTiffIfdOffset", func(t *testing.T) { + fileName := filepath.Join(t.TempDir(), "evil.tiff") + payload := malformedLittleEndianTIFFIfdOffset() + require.NoError(t, os.WriteFile(fileName, payload, ModeFile)) + + _, _, err := DecodeImageFile(fileName) + + require.Error(t, err) + }) + t.Run("MalformedBigEndianTiffIfdOffset", func(t *testing.T) { + fileName := filepath.Join(t.TempDir(), "evil-mm.tiff") + require.NoError(t, os.WriteFile(fileName, malformedBigEndianTIFFIfdOffset(), ModeFile)) + + _, _, err := DecodeImageFile(fileName) + + require.Error(t, err) + assert.Contains(t, err.Error(), "invalid TIFF: IFD offset") + }) + t.Run("TruncatedTiffBody", func(t *testing.T) { + fileName := filepath.Join(t.TempDir(), "truncated.tiff") + require.NoError(t, os.WriteFile(fileName, truncatedTIFFBody(), ModeFile)) + + _, _, err := DecodeImageFile(fileName) + + require.Error(t, err) + assert.ErrorIs(t, err, io.EOF) + }) +} + +func TestDecodeImageData(t *testing.T) { + t.Run("MalformedBigEndianTiffIfdOffset", func(t *testing.T) { + _, _, err := DecodeImageData(malformedBigEndianTIFFIfdOffset()) + + require.Error(t, err) + assert.Contains(t, err.Error(), "invalid TIFF: IFD offset") + }) + t.Run("TruncatedTiffBody", func(t *testing.T) { + _, _, err := DecodeImageData(truncatedTIFFBody()) + + require.Error(t, err) + assert.ErrorIs(t, err, io.EOF) + }) +} + +func TestDecodeImageConfigData(t *testing.T) { + t.Run("MalformedBigEndianTiffIfdOffset", func(t *testing.T) { + _, _, err := DecodeImageConfigData(malformedBigEndianTIFFIfdOffset()) + + require.Error(t, err) + assert.Contains(t, err.Error(), "invalid TIFF: IFD offset") + }) + t.Run("TruncatedTiffBody", func(t *testing.T) { + _, _, err := DecodeImageConfigData(truncatedTIFFBody()) + + require.Error(t, err) + assert.ErrorIs(t, err, io.EOF) + }) +} + +func TestValidateTIFFOffset(t *testing.T) { + t.Run("RejectsLittleEndianOffsetBeyondSize", func(t *testing.T) { + err := validateTIFFOffset(malformedLittleEndianTIFFIfdOffset(), 8) + require.Error(t, err) + assert.Contains(t, err.Error(), "invalid TIFF: IFD offset") + }) + t.Run("RejectsBigEndianOffsetBeyondSize", func(t *testing.T) { + err := validateTIFFOffset(malformedBigEndianTIFFIfdOffset(), 8) + require.Error(t, err) + assert.Contains(t, err.Error(), "invalid TIFF: IFD offset") + }) + t.Run("AcceptsTruncatedBodyOffsetWithinSize", func(t *testing.T) { + err := validateTIFFOffset(truncatedTIFFBody(), int64(len(truncatedTIFFBody()))) + require.NoError(t, err) + }) +} diff --git a/pkg/fs/mime.go b/pkg/fs/mime.go index a63335ace..c84494f16 100644 --- a/pkg/fs/mime.go +++ b/pkg/fs/mime.go @@ -51,6 +51,9 @@ func DetectMimeType(filename string) (mimeType string, err error) { // Adobe Digital Negative case ImageDng: return header.ContentTypeDng, nil + // Adobe Photoshop Document + case ImagePsd: + return header.ContentTypePsd, nil // Adobe Illustrator case VectorAI: return header.ContentTypeAI, nil diff --git a/pkg/fs/mime_test.go b/pkg/fs/mime_test.go index 9dd6604e9..c4f98f356 100644 --- a/pkg/fs/mime_test.go +++ b/pkg/fs/mime_test.go @@ -65,6 +65,12 @@ func TestDetectMimeType(t *testing.T) { mimeType, _ := DetectMimeType(filename) assert.Equal(t, "image/dng", mimeType) }) + t.Run("PSD", func(t *testing.T) { + filename := Abs("../../assets/samples/photoshop-standard-small.psd") + mimeType, _ := DetectMimeType(filename) + assert.Equal(t, header.ContentTypePsd, mimeType) + assert.Equal(t, header.ContentTypePsd, MimeType(filename)) + }) t.Run("SVG", func(t *testing.T) { filename := Abs("./testdata/test.svg") mimeType, _ := DetectMimeType(filename) diff --git a/pkg/fs/purge.go b/pkg/fs/purge.go index 858aa26ab..3d362f75c 100644 --- a/pkg/fs/purge.go +++ b/pkg/fs/purge.go @@ -7,19 +7,9 @@ import ( "strings" ) -// PurgeTestDbFiles removes temporary SQLite-related test files in dir. -// -// Patterns (case-insensitive), aligned with `make reset-sqlite`: -// - '.*.db' (hidden SQLite database files) -// - '.*.db-journal' (SQLite journal files) -// - '.test.*' (generic hidden test artifacts) -// -// If recursive is true, it traverses dir recursively. If false, it only checks -// files directly within dir so TestMain in a parent package won't affect -// sub-packages that may run in parallel. -// -// Errors from removing individual files are ignored; this is a best-effort -// cleanup helper for tests and local tooling. +// PurgeTestDbFiles removes hidden SQLite test artifacts (`.*.db`, +// `.*.db-journal`, `.test.*`) from dir, optionally recursively. Aligned with +// `make reset-sqlite`. Removal errors are ignored — best-effort cleanup. func PurgeTestDbFiles(dir string, recursive bool) { if dir == "" { return diff --git a/pkg/geo/geo.go b/pkg/geo/geo.go index 18ad287fd..33fbe7d80 100644 --- a/pkg/geo/geo.go +++ b/pkg/geo/geo.go @@ -1,7 +1,7 @@ /* Package geo provides earth geometry functions and constants. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/geo/latlng/latlng.go b/pkg/geo/latlng/latlng.go index 683e705c1..57434cd0e 100644 --- a/pkg/geo/latlng/latlng.go +++ b/pkg/geo/latlng/latlng.go @@ -1,7 +1,7 @@ /* Package latlng provides latitude and longitude functions and constants. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/geo/pluscode/pluscode.go b/pkg/geo/pluscode/pluscode.go index 947b75580..7ad056b55 100644 --- a/pkg/geo/pluscode/pluscode.go +++ b/pkg/geo/pluscode/pluscode.go @@ -1,7 +1,7 @@ /* Package pluscode provides an abstraction for Google's Open Location Code package. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/geo/s2/s2.go b/pkg/geo/s2/s2.go index 01c24a6d8..b0356483f 100644 --- a/pkg/geo/s2/s2.go +++ b/pkg/geo/s2/s2.go @@ -3,7 +3,7 @@ Package s2 provides a geolocation abstraction based on Google's S2 library. See https://s2geometry.io/ -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -16,7 +16,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/http/dns/dns.go b/pkg/http/dns/dns.go index b7bf58bca..de18a77e7 100644 --- a/pkg/http/dns/dns.go +++ b/pkg/http/dns/dns.go @@ -2,7 +2,7 @@ Package dns provides helpers for validating and classifying hostnames that are safe to use in cluster URLs, node identifiers, and other HTTP-facing settings. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -15,7 +15,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/http/dns/local.go b/pkg/http/dns/local.go index ed301e771..6f38fcf3d 100644 --- a/pkg/http/dns/local.go +++ b/pkg/http/dns/local.go @@ -23,7 +23,7 @@ func IsLocalSuffix(suffix string) bool { // IsLoopbackHost reports whether host refers to a loopback address that is safe // to contact over plain HTTP during bootstrap. It accepts hostnames (e.g. -// "localhost") as well as IPv4/IPv6 addresses and normalises case/whitespace. +// "localhost") as well as IPv4/IPv6 addresses and normalizes case/whitespace. func IsLoopbackHost(host string) bool { h := strings.TrimSpace(strings.ToLower(host)) if h == "" { diff --git a/pkg/http/header/content.go b/pkg/http/header/content.go index 3b396be22..a155d5c99 100644 --- a/pkg/http/header/content.go +++ b/pkg/http/header/content.go @@ -12,6 +12,7 @@ const ( ContentLanguage = "Content-Language" ContentLength = "Content-Length" ContentRange = "Content-Range" + Range = "Range" Location = "Location" Origin = "Origin" Vary = "Vary" diff --git a/pkg/http/header/content_test.go b/pkg/http/header/content_test.go index 034455216..1084ead54 100644 --- a/pkg/http/header/content_test.go +++ b/pkg/http/header/content_test.go @@ -19,6 +19,7 @@ func TestContent(t *testing.T) { assert.Equal(t, "Content-Language", ContentLanguage) assert.Equal(t, "Content-Length", ContentLength) assert.Equal(t, "Content-Range", ContentRange) + assert.Equal(t, "Range", Range) assert.Equal(t, "Location", Location) assert.Equal(t, "Origin", Origin) assert.Equal(t, "Vary", Vary) @@ -29,6 +30,7 @@ func TestContent(t *testing.T) { assert.Equal(t, "application/manifest+json", ContentTypeManifest) assert.Equal(t, "application/json", ContentTypeJson) assert.Equal(t, "application/json; charset=utf-8", ContentTypeJsonUtf8) + assert.Equal(t, "text/event-stream", ContentTypeEventStream) assert.Equal(t, "application/javascript", ContentTypeJavaScript) assert.Equal(t, "text/css", ContentTypeCSS) assert.Equal(t, "text/html; charset=utf-8", ContentTypeHtml) diff --git a/pkg/http/header/content_types.go b/pkg/http/header/content_types.go index fccb4d5a2..48796d8ca 100644 --- a/pkg/http/header/content_types.go +++ b/pkg/http/header/content_types.go @@ -82,6 +82,8 @@ const ( ContentTypeGif = "image/gif" ContentTypeBmp = "image/bmp" ContentTypeTiff = "image/tiff" + ContentTypePsd = "application/vnd.adobe.photoshop" + ContentTypePsdAlt = "image/vnd.adobe.photoshop" ContentTypeDng = "image/dng" ContentTypeAvif = "image/avif" ContentTypeAvifS = "image/avif-sequence" @@ -96,20 +98,21 @@ const ( // Standard ContentType strings for markup and sidecar files. const ( - ContentTypeBinary = "application/octet-stream" - ContentTypeForm = "application/x-www-form-urlencoded" - ContentTypeMultipart = "multipart/form-data" - ContentTypeManifest = "application/manifest+json" - ContentTypeJson = "application/json" - ContentTypeJsonUtf8 = "application/json; charset=utf-8" - ContentTypeJavaScript = "application/javascript" - ContentTypeCSS = "text/css" - ContentTypeXml = "text/xml" - ContentTypeHtml = "text/html; charset=utf-8" - ContentTypeText = "text/plain; charset=utf-8" - ContentTypePDF = "application/pdf" - ContentTypeZip = "application/zip" - ContentTypePrometheus = "text/plain; version=0.0.4" + ContentTypeBinary = "application/octet-stream" + ContentTypeForm = "application/x-www-form-urlencoded" + ContentTypeMultipart = "multipart/form-data" + ContentTypeManifest = "application/manifest+json" + ContentTypeJson = "application/json" + ContentTypeJsonUtf8 = "application/json; charset=utf-8" + ContentTypeJavaScript = "application/javascript" + ContentTypeCSS = "text/css" + ContentTypeXml = "text/xml" + ContentTypeHtml = "text/html; charset=utf-8" + ContentTypeText = "text/plain; charset=utf-8" + ContentTypePDF = "application/pdf" + ContentTypeZip = "application/zip" + ContentTypePrometheus = "text/plain; version=0.0.4" + ContentTypeEventStream = "text/event-stream" // Server-Sent Events (SSE), see https://html.spec.whatwg.org/multipage/server-sent-events.html ) // HasContentType checks weather the Content-Type header has the specified type. diff --git a/pkg/http/header/header.go b/pkg/http/header/header.go index 9cf74617a..c7555f8e6 100644 --- a/pkg/http/header/header.go +++ b/pkg/http/header/header.go @@ -1,7 +1,7 @@ /* Package header provides abstractions and naming constants for HTTP request and response headers. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/http/proxy/proxy.go b/pkg/http/proxy/proxy.go index 1eedb798c..c3f02fa33 100644 --- a/pkg/http/proxy/proxy.go +++ b/pkg/http/proxy/proxy.go @@ -1,7 +1,7 @@ /* Package proxy provides shared defaults and helpers for path-based HTTP proxy routing. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/http/proxy/rewrite.go b/pkg/http/proxy/rewrite.go index 4ad975c7d..dc139aa79 100644 --- a/pkg/http/proxy/rewrite.go +++ b/pkg/http/proxy/rewrite.go @@ -29,6 +29,32 @@ func ForwardedProto(req *http.Request) string { return "http" } +// portalRootPathPrefixes lists URL paths that are served by the Portal root, +// not by any proxied instance. Locations under these prefixes are deliberate +// instance-to-Portal redirects (for example the Pro OIDC RP redirecting to +// the Portal's authorize endpoint), and the per-instance path prefix must +// not be added to them. The OIDC OP endpoints live under "/api/v1/oauth/" +// specifically (not all of "/api/v1/", which is an instance surface too). +var portalRootPathPrefixes = []string{ + "/api/v1/oauth/", + "/.well-known/", + "/portal/", +} + +// isPortalRootPath reports whether a URL path targets a Portal-root surface. +func isPortalRootPath(p string) bool { + if p == "" { + return false + } + scoped := "/" + strings.TrimLeft(p, "/") + for _, prefix := range portalRootPathPrefixes { + if scoped == strings.TrimSuffix(prefix, "/") || strings.HasPrefix(scoped, prefix) { + return true + } + } + return false +} + // RewriteLocation prefixes redirect targets to keep clients within a proxy path scope. func RewriteLocation(location, pathPrefix, proxyHost string) string { if location == "" || pathPrefix == "" { @@ -36,7 +62,7 @@ func RewriteLocation(location, pathPrefix, proxyHost string) string { } if strings.HasPrefix(location, "/") { - if HasPathPrefix(location, pathPrefix) { + if HasPathPrefix(location, pathPrefix) || isPortalRootPath(location) { return location } return JoinPathPrefix(pathPrefix, location) @@ -52,7 +78,7 @@ func RewriteLocation(location, pathPrefix, proxyHost string) string { return location } - if HasPathPrefix(u.Path, pathPrefix) { + if HasPathPrefix(u.Path, pathPrefix) || isPortalRootPath(u.Path) { return location } diff --git a/pkg/http/proxy/rewrite_test.go b/pkg/http/proxy/rewrite_test.go index 7a46f4bed..7ed7637b6 100644 --- a/pkg/http/proxy/rewrite_test.go +++ b/pkg/http/proxy/rewrite_test.go @@ -43,6 +43,32 @@ func TestRewriteLocation(t *testing.T) { assert.Equal(t, "/i/acme/", RewriteLocation("/", prefix, host)) assert.Equal(t, "https://portal.example.com/i/acme/library", RewriteLocation("https://portal.example.com/library", prefix, host)) assert.Equal(t, "https://other.example.com/library", RewriteLocation("https://other.example.com/library", prefix, host)) + + // Portal-root paths are owned by the Portal itself (OIDC OP, discovery, + // admin UI). Instances that redirect to them — for example the Pro RP + // pointing at the Portal's authorize endpoint — must not be re-scoped + // under the instance path prefix. + assert.Equal(t, "/api/v1/oauth/authorize", RewriteLocation("/api/v1/oauth/authorize", prefix, host)) + assert.Equal(t, "/.well-known/openid-configuration", RewriteLocation("/.well-known/openid-configuration", prefix, host)) + assert.Equal(t, "/portal/login", RewriteLocation("/portal/login", prefix, host)) + assert.Equal(t, "https://portal.example.com/api/v1/oauth/authorize?x=1", RewriteLocation("https://portal.example.com/api/v1/oauth/authorize?x=1", prefix, host)) + + // Instance-owned API paths (everything under /api/v1/ that is not the OP) + // must still be re-scoped under the per-instance prefix. + assert.Equal(t, "/i/acme/api/v1/photos", RewriteLocation("/api/v1/photos", prefix, host)) +} + +func TestIsPortalRootPath(t *testing.T) { + assert.True(t, isPortalRootPath("/api/v1/oauth/authorize")) + assert.True(t, isPortalRootPath("/api/v1/oauth/token")) + assert.True(t, isPortalRootPath("/api/v1/oauth/userinfo")) + assert.True(t, isPortalRootPath("/.well-known/openid-configuration")) + assert.True(t, isPortalRootPath("/portal/login")) + assert.True(t, isPortalRootPath("api/v1/oauth/authorize")) + assert.False(t, isPortalRootPath("/oauth/authorize")) + assert.False(t, isPortalRootPath("/library")) + assert.False(t, isPortalRootPath("/api/v1/photos")) + assert.False(t, isPortalRootPath("")) } func TestRewriteSetCookiePath(t *testing.T) { diff --git a/pkg/http/safe/download.go b/pkg/http/safe/download.go index 42ca04a52..0db52e698 100644 --- a/pkg/http/safe/download.go +++ b/pkg/http/safe/download.go @@ -191,9 +191,15 @@ func isPrivateOrDisallowedIP(ip net.IP) bool { return true } if v4 := ip.To4(); v4 != nil { + if v4[0] == 0 { // 0.0.0.0/8 "this network" + return true + } if v4[0] == 10 { return true } + if v4[0] == 100 && v4[1] >= 64 && v4[1] <= 127 { // 100.64.0.0/10 CGNAT (RFC 6598) + return true + } if v4[0] == 172 && v4[1] >= 16 && v4[1] <= 31 { return true } diff --git a/pkg/http/safe/download_test.go b/pkg/http/safe/download_test.go index 79c91bfe5..1fa49bc5a 100644 --- a/pkg/http/safe/download_test.go +++ b/pkg/http/safe/download_test.go @@ -2,6 +2,7 @@ package safe import ( "io" + "net" "net/http" "os" "path/filepath" @@ -37,3 +38,51 @@ func TestSafeDownload_TooLarge(t *testing.T) { t.Fatalf("expected ErrSizeExceeded") } } + +func TestIsPrivateOrDisallowedIP(t *testing.T) { + disallowed := []string{ + "0.0.0.0", // 0.0.0.0/8 this network + "0.1.2.3", // 0.0.0.0/8 this network + "10.0.0.1", // RFC1918 + "100.64.0.1", // CGNAT RFC6598 + "100.127.255.254", // CGNAT upper bound + "172.16.0.1", // RFC1918 + "192.168.1.1", // RFC1918 + "169.254.169.254", // link-local / cloud metadata + "127.0.0.1", // loopback + "224.0.0.1", // multicast + "fc00::1", // IPv6 ULA + "::1", // IPv6 loopback + "fe80::1", // IPv6 link-local + } + for _, s := range disallowed { + ip := net.ParseIP(s) + if ip == nil { + t.Fatalf("failed to parse %q", s) + } + if !isPrivateOrDisallowedIP(ip) { + t.Errorf("expected %q to be disallowed", s) + } + } + + allowed := []string{ + "8.8.8.8", // public + "100.63.255.255", // just below CGNAT range + "100.128.0.1", // just above CGNAT range + "1.1.1.1", // public + "2606:4700:4700::1111", // public IPv6 + } + for _, s := range allowed { + ip := net.ParseIP(s) + if ip == nil { + t.Fatalf("failed to parse %q", s) + } + if isPrivateOrDisallowedIP(ip) { + t.Errorf("expected %q to be allowed", s) + } + } + + if !isPrivateOrDisallowedIP(nil) { + t.Error("expected nil IP to be disallowed") + } +} diff --git a/pkg/http/safe/safe.go b/pkg/http/safe/safe.go index 587afe93a..13c26cf07 100644 --- a/pkg/http/safe/safe.go +++ b/pkg/http/safe/safe.go @@ -1,7 +1,7 @@ /* Package safe provides a secure HTTP downloader with customizable settings. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/http/scheme/port.go b/pkg/http/scheme/port.go new file mode 100644 index 000000000..920d09978 --- /dev/null +++ b/pkg/http/scheme/port.go @@ -0,0 +1,34 @@ +package scheme + +import ( + "net/url" + "strings" +) + +// DefaultPort returns the IANA default port for a known URL scheme, or "" if unknown. +func DefaultPort(s string) string { + switch s { + case Http: + return "80" + case Https, Websocket: + return "443" + } + + return "" +} + +// StripDefaultPort removes the explicit port from u.Host when it equals the +// default for u.Scheme. IPv6 brackets are preserved. +func StripDefaultPort(u *url.URL) { + if u == nil { + return + } + + port := u.Port() + + if port == "" || port != DefaultPort(u.Scheme) { + return + } + + u.Host = strings.TrimSuffix(u.Host, ":"+port) +} diff --git a/pkg/http/scheme/port_test.go b/pkg/http/scheme/port_test.go new file mode 100644 index 000000000..08163f628 --- /dev/null +++ b/pkg/http/scheme/port_test.go @@ -0,0 +1,74 @@ +package scheme + +import ( + "net/url" + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestDefaultPort(t *testing.T) { + t.Run("Http", func(t *testing.T) { + assert.Equal(t, "80", DefaultPort(Http)) + }) + t.Run("Https", func(t *testing.T) { + assert.Equal(t, "443", DefaultPort(Https)) + }) + t.Run("Websocket", func(t *testing.T) { + assert.Equal(t, "443", DefaultPort(Websocket)) + }) + t.Run("Empty", func(t *testing.T) { + assert.Equal(t, "", DefaultPort("")) + }) + t.Run("Unknown", func(t *testing.T) { + assert.Equal(t, "", DefaultPort("ftp")) + }) +} + +func TestStripDefaultPort(t *testing.T) { + t.Run("HttpsDefault", func(t *testing.T) { + u, err := url.Parse("https://example.com:443/path") + assert.NoError(t, err) + StripDefaultPort(u) + assert.Equal(t, "https://example.com/path", u.String()) + }) + t.Run("HttpDefault", func(t *testing.T) { + u, err := url.Parse("http://example.com:80/") + assert.NoError(t, err) + StripDefaultPort(u) + assert.Equal(t, "http://example.com/", u.String()) + }) + t.Run("NonDefaultPortPreserved", func(t *testing.T) { + u, err := url.Parse("https://example.com:8443/") + assert.NoError(t, err) + StripDefaultPort(u) + assert.Equal(t, "https://example.com:8443/", u.String()) + }) + t.Run("MismatchedScheme", func(t *testing.T) { + u, err := url.Parse("http://example.com:443/") + assert.NoError(t, err) + StripDefaultPort(u) + assert.Equal(t, "http://example.com:443/", u.String()) + }) + t.Run("NoPort", func(t *testing.T) { + u, err := url.Parse("https://example.com/") + assert.NoError(t, err) + StripDefaultPort(u) + assert.Equal(t, "https://example.com/", u.String()) + }) + t.Run("IPv6Default", func(t *testing.T) { + u, err := url.Parse("https://[::1]:443/") + assert.NoError(t, err) + StripDefaultPort(u) + assert.Equal(t, "https://[::1]/", u.String()) + }) + t.Run("Nil", func(t *testing.T) { + assert.NotPanics(t, func() { StripDefaultPort(nil) }) + }) + t.Run("UnknownScheme", func(t *testing.T) { + u, err := url.Parse("ftp://example.com:21/") + assert.NoError(t, err) + StripDefaultPort(u) + assert.Equal(t, "ftp://example.com:21/", u.String()) + }) +} diff --git a/pkg/http/scheme/scheme.go b/pkg/http/scheme/scheme.go index 8d1a08289..18d88a1e7 100644 --- a/pkg/http/scheme/scheme.go +++ b/pkg/http/scheme/scheme.go @@ -1,7 +1,7 @@ /* Package scheme provides abstractions and naming constants for URI/URL resource strings. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/http/scheme/url.go b/pkg/http/scheme/url.go new file mode 100644 index 000000000..12e693aa8 --- /dev/null +++ b/pkg/http/scheme/url.go @@ -0,0 +1,130 @@ +package scheme + +import ( + "net/url" + "strings" + "sync" +) + +// NormalizeBaseURLMaxLen caps the input length eligible for caching; longer +// strings still normalize correctly but bypass the cache so a single oversized +// input cannot bloat the cache map. +const NormalizeBaseURLMaxLen = 2048 + +// NormalizeBaseURLCacheEntries bounds the in-memory cache. In practice only a +// handful of distinct base URLs (SiteUrl, CdnUrl, possibly an empty string) +// are normalized over the process lifetime; the cap is a safety net so a +// runaway caller cannot grow the map without limit. +const NormalizeBaseURLCacheEntries = 128 + +var ( + normalizeBaseURLCache = make(map[string]string, NormalizeBaseURLCacheEntries) + normalizeBaseURLCacheMu sync.RWMutex +) + +// NormalizeBaseURL returns a base URL with a trailing slash if s is not empty +// or does not contain only whitespace. The default port, query strings, +// and fragments are omitted, but Userinfo is preserved. +// If parsing fails, NormalizeBaseURL returns s with a trailing slash appended. +// +// Results are cached by raw input string. The output is a pure function of the +// input, so cache entries never need to be invalidated; the only bounds are +// the input length cap and the maximum number of cached entries. +func NormalizeBaseURL(s string) string { + if len(s) > NormalizeBaseURLMaxLen { + return normalizeBaseURL(s) + } + + normalizeBaseURLCacheMu.RLock() + if out, ok := normalizeBaseURLCache[s]; ok { + normalizeBaseURLCacheMu.RUnlock() + return out + } + normalizeBaseURLCacheMu.RUnlock() + + out := normalizeBaseURL(s) + + normalizeBaseURLCacheMu.Lock() + if len(normalizeBaseURLCache) < NormalizeBaseURLCacheEntries { + normalizeBaseURLCache[s] = out + } + normalizeBaseURLCacheMu.Unlock() + + return out +} + +// normalizeBaseURL implements the uncached normalization used by NormalizeBaseURL. +func normalizeBaseURL(s string) string { + s = strings.TrimSpace(s) + + if s == "" { + return "" + } + + u, err := url.Parse(s) + + if err != nil { + return strings.TrimRight(s, "/") + "/" + } + + StripDefaultPort(u) + u.RawQuery = "" + u.ForceQuery = false + u.Fragment = "" + u.RawFragment = "" + u.Path = strings.TrimRight(u.Path, "/") + "/" + + return u.String() +} + +// OriginURL returns the scheme://host/ origin of s (trailing slash; no path, +// query, fragment, or userinfo). A non-default port is preserved; the scheme's +// default port is stripped so the result matches a NormalizeBaseURL'd issuer. +// Returns "" when s is empty or has no scheme/host. +func OriginURL(s string) string { + u, err := url.Parse(strings.TrimSpace(s)) + if err != nil || u.Scheme == "" || u.Host == "" { + return "" + } + + StripDefaultPort(u) + + return u.Scheme + "://" + u.Host + "/" +} + +// ResolveAdvertiseURL returns the normalized base URL the Portal should +// use to reach a PhotoPrism instance, using siteURL's path as the source +// of truth. The result always carries a trailing slash so callers can +// concatenate an API path directly (e.g. `result + "api/v1/users/" + uid`). +func ResolveAdvertiseURL(advertiseURL, siteURL string) string { + advertiseURL = NormalizeBaseURL(advertiseURL) + siteURL = NormalizeBaseURL(siteURL) + + if advertiseURL == "" && siteURL == "" { + return "" + } + + if advertiseURL == "" || advertiseURL == siteURL { + return siteURL + } + + // If paths diverge, use the SiteURL's path as the authoritative source. + var sitePath string + if siteURL != "" { + if s, err := url.Parse(siteURL); err == nil { + sitePath = strings.TrimRight(s.Path, "/") + } + } + + a, err := url.Parse(advertiseURL) + if err != nil || a.Host == "" { + return advertiseURL + } + + if sitePath != "" { + a.Path = sitePath + "/" + a.RawPath = "" + } + + return a.String() +} diff --git a/pkg/http/scheme/url_test.go b/pkg/http/scheme/url_test.go new file mode 100644 index 000000000..3e6544b4f --- /dev/null +++ b/pkg/http/scheme/url_test.go @@ -0,0 +1,175 @@ +package scheme + +import ( + "strings" + "sync" + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestNormalizeBaseURL(t *testing.T) { + cases := []struct { + name string + in string + want string + }{ + // Empty values. + {"Empty", "", ""}, + {"Spaces", " ", ""}, + {"Tabs", "\t\t\t\t ", ""}, + + // Trailing-slash policy. + {"AlreadyNormalized", "https://example.com/", "https://example.com/"}, + {"NoTrailingSlash", "https://example.com", "https://example.com/"}, + {"ExtraTrailingSlashes", "https://example.com:443////", "https://example.com/"}, + + // Default-port stripping. + {"HttpsDefaultPort", "https://example.com:443/", "https://example.com/"}, + {"HttpDefaultPort", "http://example.com:80/sub", "http://example.com/sub/"}, + {"NonDefaultPortPreserved", "https://example.com:8443/", "https://example.com:8443/"}, + {"MismatchedScheme", "http://example.com:443/", "http://example.com:443/"}, + + // Uncommon but well-formed inputs. + {"IPv6DefaultPort", "https://[::1]:443/", "https://[::1]/"}, + {"IPv6NonDefaultPort", "https://[2001:db8::1]:8443/path", "https://[2001:db8::1]:8443/path/"}, + {"PathPreserved", "https://example.com:443/i/pro-1/", "https://example.com/i/pro-1/"}, + {"QueryStripped", "https://example.com:443/i/?lang=de&page=2", "https://example.com/i/"}, + {"ForceQueryStripped", "https://example.com/?", "https://example.com/"}, + {"FragmentStripped", "https://example.com/library/#photo123", "https://example.com/library/"}, + + // Policy: userinfo is preserved verbatim. + {"UserinfoPreserved", "https://user:secret@example.com:443/", "https://user:secret@example.com/"}, + + // Unix-socket schemes: port stripping must stay a no-op. + {"UnixScheme", "unix:///var/run/photoprism.sock", "unix:///var/run/photoprism.sock/"}, + {"HttpUnixScheme", "http+unix:///var/run/photoprism.sock", "http+unix:///var/run/photoprism.sock/"}, + + // Parse failure falls back to TrimRight + "/". + {"ParseError", ":foo", ":foo/"}, + } + + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + assert.Equal(t, tc.want, NormalizeBaseURL(tc.in)) + }) + } +} + +func TestNormalizeBaseURL_CacheHit(t *testing.T) { + in := "https://cache-hit.example.com:443/" + want := "https://cache-hit.example.com/" + + first := NormalizeBaseURL(in) + second := NormalizeBaseURL(in) + + assert.Equal(t, want, first) + assert.Equal(t, want, second) + + normalizeBaseURLCacheMu.RLock() + _, ok := normalizeBaseURLCache[in] + normalizeBaseURLCacheMu.RUnlock() + assert.True(t, ok, "cache must retain the entry after first call") +} + +func TestNormalizeBaseURL_OversizedBypassesCache(t *testing.T) { + in := "https://bypass.example.com/" + strings.Repeat("x", NormalizeBaseURLMaxLen) + out := NormalizeBaseURL(in) + + assert.True(t, strings.HasPrefix(out, "https://bypass.example.com/")) + + normalizeBaseURLCacheMu.RLock() + _, ok := normalizeBaseURLCache[in] + normalizeBaseURLCacheMu.RUnlock() + assert.False(t, ok, "inputs longer than NormalizeBaseURLMaxLen must not be cached") +} + +func BenchmarkNormalizeBaseURL_Cached(b *testing.B) { + in := "https://bench.example.com:443/library/" + NormalizeBaseURL(in) // warm the cache + b.ResetTimer() + for i := 0; i < b.N; i++ { + NormalizeBaseURL(in) + } +} + +func BenchmarkNormalizeBaseURL_Uncached(b *testing.B) { + in := "https://bench.example.com:443/library/" + b.ResetTimer() + for i := 0; i < b.N; i++ { + normalizeBaseURL(in) + } +} + +func TestResolveAdvertiseURL(t *testing.T) { + cases := []struct { + name string + advertise string + site string + want string + }{ + {"BothEmpty", "", "", ""}, + {"AdvertiseEmptyFallbackToSite", "", "https://app.localssl.dev/i/pro-1/", "https://app.localssl.dev/i/pro-1/"}, + {"SiteEmpty_AdvertiseAsIs", "http://127.0.0.1:3001/", "", "http://127.0.0.1:3001/"}, + {"SiteEmpty_AdvertiseWithPathPreserved", "http://127.0.0.1:3001/i/pro-1/", "", "http://127.0.0.1:3001/i/pro-1/"}, + {"AdvertiseMissingPath_PrefixGrafted", "http://127.0.0.1:3001/", "https://app.localssl.dev/i/pro-1/", "http://127.0.0.1:3001/i/pro-1/"}, + {"AdvertiseMatchingPath_Idempotent", "http://127.0.0.1:3001/i/pro-1/", "https://app.localssl.dev/i/pro-1/", "http://127.0.0.1:3001/i/pro-1/"}, + {"AdvertiseDivergentPath_Replaced", "http://127.0.0.1:3001/i/wrong-tenant/", "https://app.localssl.dev/i/pro-1/", "http://127.0.0.1:3001/i/pro-1/"}, + {"SiteRoot_AdvertiseUnchanged", "http://127.0.0.1:3001/", "https://app.example.com/", "http://127.0.0.1:3001/"}, + {"SiteRoot_AdvertiseDeepPathKept", "http://127.0.0.1:3001/legacy/", "https://app.example.com/", "http://127.0.0.1:3001/legacy/"}, + {"AdvertiseNoTrailingSlash", "http://127.0.0.1:3001", "https://app.example.com/i/pro-1/", "http://127.0.0.1:3001/i/pro-1/"}, + {"AdvertiseDefaultPortStripped", "http://127.0.0.1:80/", "https://app.example.com/i/pro-1/", "http://127.0.0.1/i/pro-1/"}, + {"AdvertiseSubpathOfSiteReplaced", "http://127.0.0.1:3001/i/pro-1/deep/", "https://app.example.com/i/pro-1/", "http://127.0.0.1:3001/i/pro-1/"}, + {"AdvertiseUnparseable", "://not-a-url", "https://app.example.com/i/pro-1/", "://not-a-url/"}, + {"AdvertiseEqualsSite_ReturnsSite", "https://app.example.com/i/pro-1/", "https://app.example.com/i/pro-1/", "https://app.example.com/i/pro-1/"}, + {"AdvertisePathFixedToMatchSite_ReturnsSite", "https://app.example.com/", "https://app.example.com/i/pro-1/", "https://app.example.com/i/pro-1/"}, + } + + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + got := ResolveAdvertiseURL(tc.advertise, tc.site) + assert.Equal(t, tc.want, got) + }) + } +} + +func TestOriginURL(t *testing.T) { + cases := []struct { + name string + in string + want string + }{ + {"SharedDomainSubPath", "https://app.localssl.dev/i/pro-1/", "https://app.localssl.dev/"}, + {"DropsPathQueryFragment", "https://app.localssl.dev/i/pro-1/library?x=1#top", "https://app.localssl.dev/"}, + {"StripsDefaultHttpsPort", "https://app.localssl.dev:443/i/pro-1/", "https://app.localssl.dev/"}, + {"PreservesNonStandardPort", "https://app.localssl.dev:8443/i/pro-1/", "https://app.localssl.dev:8443/"}, + {"PreservesHttpDevPort", "http://localhost:2342/", "http://localhost:2342/"}, + {"DropsUserinfo", "https://user:pass@app.localssl.dev/i/pro-1/", "https://app.localssl.dev/"}, + {"RootAlreadyOrigin", "https://app.localssl.dev/", "https://app.localssl.dev/"}, + {"Empty", "", ""}, + {"Whitespace", " ", ""}, + {"NoScheme", "app.localssl.dev/i/pro-1/", ""}, + } + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + assert.Equal(t, tc.want, OriginURL(tc.in)) + }) + } +} + +func TestNormalizeBaseURL_ConcurrentReaders(t *testing.T) { + in := "https://concurrent.example.com:443/path/" + want := "https://concurrent.example.com/path/" + + var wg sync.WaitGroup + for i := 0; i < 32; i++ { + wg.Add(1) + go func() { + defer wg.Done() + for j := 0; j < 256; j++ { + assert.Equal(t, want, NormalizeBaseURL(in)) + } + }() + } + wg.Wait() +} diff --git a/pkg/http/security/security.go b/pkg/http/security/security.go index f1705cf14..859d7e3f2 100644 --- a/pkg/http/security/security.go +++ b/pkg/http/security/security.go @@ -1,7 +1,7 @@ /* Package security provides shared HTTP security utilities. -Copyright © 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright © 2018 - 2026 PhotoPrism UG. All rights reserved. Questions? Email us at hello@photoprism.app or visit our website to learn more about our team, products and services: https://www.photoprism.app/ diff --git a/pkg/http/security/web_overlay.go b/pkg/http/security/web_overlay.go index 68b9972ce..8f6e975f2 100644 --- a/pkg/http/security/web_overlay.go +++ b/pkg/http/security/web_overlay.go @@ -77,7 +77,7 @@ func OverlayHasAmbiguousPath(requestPath, escapedPath string) bool { } if relPath := strings.Trim(cleanPath, "/"); relPath != "" { - for _, segment := range strings.Split(relPath, "/") { + for segment := range strings.SplitSeq(relPath, "/") { if segment == "" || segment == "." || segment == ".." || fs.FileNameHidden(segment) { return true } @@ -120,9 +120,9 @@ func OverlayPathBlocked(webPath string) bool { return false } - segments := strings.Split(relPath, "/") + segments := strings.SplitSeq(relPath, "/") - for _, segment := range segments { + for segment := range segments { if segment == "" || fs.FileNameHidden(segment) { return true } diff --git a/pkg/i18n/i18n.go b/pkg/i18n/i18n.go index c06ed44c1..ae2a9eb7c 100644 --- a/pkg/i18n/i18n.go +++ b/pkg/i18n/i18n.go @@ -1,7 +1,7 @@ /* Package i18n provides translatable notification and error messages. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. @@ -69,3 +69,9 @@ func Error(id Message, params ...any) error { func Lower(id Message, params ...any) string { return strings.ToLower(msgParams(Messages[id], params...)) } + +// Source returns the untranslated English source string (gettext msgid) for a message id. +// This is the stable key the frontend uses to render the message in the user's UI language. +func Source(id Message) string { + return Messages[id] +} diff --git a/pkg/i18n/i18n_test.go b/pkg/i18n/i18n_test.go index ba0a89ec0..73aba0c27 100644 --- a/pkg/i18n/i18n_test.go +++ b/pkg/i18n/i18n_test.go @@ -8,12 +8,15 @@ import ( "github.com/stretchr/testify/assert" ) +// TestMain executes runTestMain returning it's results. It is done this way so that defer can be used to cleanup. func TestMain(m *testing.M) { + os.Exit(runTestMain(m)) +} + +func runTestMain(m *testing.M) int { gotext.Configure(localeDir, string(locale), "default") - code := m.Run() - - os.Exit(code) + return m.Run() } func TestMsg(t *testing.T) { @@ -86,3 +89,22 @@ func TestLower(t *testing.T) { assert.Equal(t, "permission denied", msg) }) } + +func TestSource(t *testing.T) { + t.Run("WithPlaceholder", func(t *testing.T) { + assert.Equal(t, "%s already exists", Source(ErrAlreadyExists)) + }) + t.Run("WithoutPlaceholder", func(t *testing.T) { + assert.Equal(t, "Permission denied", Source(ErrForbidden)) + }) + t.Run("AuthErrorMessages", func(t *testing.T) { + assert.Equal(t, "Registration disabled", Source(ErrRegistrationDisabled)) + assert.Equal(t, "Verified email required", Source(ErrVerifiedEmailRequired)) + }) + t.Run("UntranslatedAfterSetLocale", func(t *testing.T) { + SetLocale("de") + assert.Equal(t, "%s already exists", Source(ErrAlreadyExists)) + SetLocale("") + assert.Equal(t, "%s already exists", Source(ErrAlreadyExists)) + }) +} diff --git a/pkg/i18n/messages.go b/pkg/i18n/messages.go index 5aa94acea..899c27ed1 100644 --- a/pkg/i18n/messages.go +++ b/pkg/i18n/messages.go @@ -21,6 +21,8 @@ const ( ErrAccountNotFound ErrUserNotFound ErrLabelNotFound + ErrCameraNotFound + ErrLensNotFound ErrAlbumNotFound ErrSubjectNotFound ErrPersonNotFound @@ -53,6 +55,8 @@ const ( ErrTooManyRequests ErrInsufficientStorage ErrQuotaExceeded + ErrRegistrationDisabled + ErrVerifiedEmailRequired MsgChangesSaved MsgAlbumCreated @@ -105,55 +109,59 @@ const ( // Messages holds default English message strings. var Messages = MessageMap{ // Error messages: - ErrUnexpected: gettext("Something went wrong, try again"), - ErrBadRequest: gettext("Unable to do that"), - ErrSaveFailed: gettext("Changes could not be saved"), - ErrDeleteFailed: gettext("Could not be deleted"), - ErrAlreadyExists: gettext("%s already exists"), - ErrNotFound: gettext("Not found"), - ErrFileNotFound: gettext("File not found"), - ErrFileTooLarge: gettext("File too large"), - ErrUnsupported: gettext("Unsupported"), - ErrUnsupportedType: gettext("Unsupported type"), - ErrUnsupportedFormat: gettext("Unsupported format"), - ErrOriginalsEmpty: gettext("Originals folder is empty"), - ErrSelectionNotFound: gettext("Selection not found"), - ErrEntityNotFound: gettext("Entity not found"), - ErrAccountNotFound: gettext("Account not found"), - ErrUserNotFound: gettext("User not found"), - ErrLabelNotFound: gettext("Label not found"), - ErrAlbumNotFound: gettext("Album not found"), - ErrSubjectNotFound: gettext("Subject not found"), - ErrPersonNotFound: gettext("Person not found"), - ErrFaceNotFound: gettext("Face not found"), - ErrPublic: gettext("Not available in public mode"), - ErrReadOnly: gettext("Not available in read-only mode"), - ErrUnauthorized: gettext("Please log in to your account"), - ErrForbidden: gettext("Permission denied"), - ErrPaymentRequired: gettext("Payment required"), - ErrOffensiveUpload: gettext("Upload might be offensive"), - ErrUploadFailed: gettext("Upload failed"), - ErrNoItemsSelected: gettext("No items selected"), - ErrCreateFile: gettext("Failed creating file, please check permissions"), - ErrCreateFolder: gettext("Failed creating folder, please check permissions"), - ErrConnectionFailed: gettext("Could not connect, please try again"), - ErrPasscodeRequired: gettext("Enter verification code"), - ErrInvalidPasscode: gettext("Invalid verification code, please try again"), - ErrInvalidPassword: gettext("Invalid password, please try again"), - ErrFeatureDisabled: gettext("Feature disabled"), - ErrNoLabelsSelected: gettext("No labels selected"), - ErrNoAlbumsSelected: gettext("No albums selected"), - ErrNoFilesForDownload: gettext("No files available for download"), - ErrZipFailed: gettext("Failed to create zip file"), - ErrInvalidCredentials: gettext("Invalid credentials"), - ErrInvalidLink: gettext("Invalid link"), - ErrInvalidName: gettext("Invalid name"), - ErrBusy: gettext("Busy, please try again later"), - ErrWakeupInterval: gettext("The wakeup interval is %s, but must be 1h or less"), - ErrAccountConnect: gettext("Your account could not be connected"), - ErrTooManyRequests: gettext("Too many requests"), - ErrInsufficientStorage: gettext("Insufficient storage"), - ErrQuotaExceeded: gettext("Quota exceeded"), + ErrUnexpected: gettext("Something went wrong, try again"), + ErrBadRequest: gettext("Unable to do that"), + ErrSaveFailed: gettext("Changes could not be saved"), + ErrDeleteFailed: gettext("Could not be deleted"), + ErrAlreadyExists: gettext("%s already exists"), + ErrNotFound: gettext("Not found"), + ErrFileNotFound: gettext("File not found"), + ErrFileTooLarge: gettext("File too large"), + ErrUnsupported: gettext("Unsupported"), + ErrUnsupportedType: gettext("Unsupported type"), + ErrUnsupportedFormat: gettext("Unsupported format"), + ErrOriginalsEmpty: gettext("Originals folder is empty"), + ErrSelectionNotFound: gettext("Selection not found"), + ErrEntityNotFound: gettext("Entity not found"), + ErrAccountNotFound: gettext("Account not found"), + ErrUserNotFound: gettext("User not found"), + ErrLabelNotFound: gettext("Label not found"), + ErrCameraNotFound: gettext("Camera not found"), + ErrLensNotFound: gettext("Lens not found"), + ErrAlbumNotFound: gettext("Album not found"), + ErrSubjectNotFound: gettext("Subject not found"), + ErrPersonNotFound: gettext("Person not found"), + ErrFaceNotFound: gettext("Face not found"), + ErrPublic: gettext("Not available in public mode"), + ErrReadOnly: gettext("Not available in read-only mode"), + ErrUnauthorized: gettext("Please log in to your account"), + ErrForbidden: gettext("Permission denied"), + ErrPaymentRequired: gettext("Payment required"), + ErrOffensiveUpload: gettext("Upload might be offensive"), + ErrUploadFailed: gettext("Upload failed"), + ErrNoItemsSelected: gettext("No items selected"), + ErrCreateFile: gettext("Failed creating file, please check permissions"), + ErrCreateFolder: gettext("Failed creating folder, please check permissions"), + ErrConnectionFailed: gettext("Could not connect, please try again"), + ErrPasscodeRequired: gettext("Enter verification code"), + ErrInvalidPasscode: gettext("Invalid verification code, please try again"), + ErrInvalidPassword: gettext("Invalid password, please try again"), + ErrFeatureDisabled: gettext("Feature disabled"), + ErrNoLabelsSelected: gettext("No labels selected"), + ErrNoAlbumsSelected: gettext("No albums selected"), + ErrNoFilesForDownload: gettext("No files available for download"), + ErrZipFailed: gettext("Failed to create zip file"), + ErrInvalidCredentials: gettext("Invalid credentials"), + ErrInvalidLink: gettext("Invalid link"), + ErrInvalidName: gettext("Invalid name"), + ErrBusy: gettext("Busy, please try again later"), + ErrWakeupInterval: gettext("The wakeup interval is %s, but must be 1h or less"), + ErrAccountConnect: gettext("Your account could not be connected"), + ErrTooManyRequests: gettext("Too many requests"), + ErrInsufficientStorage: gettext("Insufficient storage"), + ErrQuotaExceeded: gettext("Quota exceeded"), + ErrRegistrationDisabled: gettext("Registration disabled"), + ErrVerifiedEmailRequired: gettext("Verified email required"), // Info and confirmation messages: MsgChangesSaved: gettext("Changes successfully saved"), diff --git a/pkg/i18n/response.go b/pkg/i18n/response.go index 39f70208f..98c325080 100644 --- a/pkg/i18n/response.go +++ b/pkg/i18n/response.go @@ -3,19 +3,26 @@ package i18n import "strings" // Response represents an i18n-aware response payload. +// +// Error/Message carry the server-rendered string in the instance locale (a fallback for non-browser +// consumers); MessageID and MessageParams carry the untranslated source string and its parameters +// so the Web UI can render the message in each user's current UI locale. type Response struct { - Code int `json:"code"` - Err string `json:"error,omitempty"` - Msg string `json:"message,omitempty"` - Details string `json:"details,omitempty"` + Code int `json:"code"` + Error string `json:"error,omitempty"` + Message string `json:"message,omitempty"` + MessageID string `json:"messageId,omitempty"` + MessageParams []any `json:"messageParams,omitempty"` + Details string `json:"details,omitempty"` } +// String returns the response message as string. func (r Response) String() string { - if r.Err != "" { - return r.Err - } else { - return r.Msg + if r.Error != "" { + return r.Error } + + return r.Message } // LowerString returns the lowercased message string. @@ -23,20 +30,27 @@ func (r Response) LowerString() string { return strings.ToLower(r.String()) } -func (r Response) Error() string { - return r.Err +// ErrorString returns the error message as string. +func (r Response) ErrorString() string { + return r.Error } // Success reports whether the response code indicates success (2xx). func (r Response) Success() bool { - return r.Err == "" && r.Code < 400 + return r.Error == "" && r.Code < 400 } // NewResponse builds a Response with the given code, message ID, and optional parameters. +// It carries the untranslated source string (MessageID) and MessageParams so the frontend can render +// the message in the current UI locale, in addition to the server-rendered Error/Message fallback. func NewResponse(code int, id Message, params ...any) Response { + r := Response{Code: code, MessageID: Source(id), MessageParams: params} + if code < 400 { - return Response{Code: code, Msg: Msg(id, params...)} + r.Message = Msg(id, params...) } else { - return Response{Code: code, Err: Msg(id, params...)} + r.Error = Msg(id, params...) } + + return r } diff --git a/pkg/i18n/response_test.go b/pkg/i18n/response_test.go index bfddc686e..1543f63a5 100644 --- a/pkg/i18n/response_test.go +++ b/pkg/i18n/response_test.go @@ -12,37 +12,41 @@ func TestNewResponse(t *testing.T) { t.Run("AlreadyExists", func(t *testing.T) { resp := NewResponse(http.StatusConflict, ErrAlreadyExists, "A cat") assert.Equal(t, http.StatusConflict, resp.Code) - assert.Equal(t, "A cat already exists", resp.Err) - assert.Equal(t, "", resp.Msg) + assert.Equal(t, "A cat already exists", resp.Error) + assert.Equal(t, "", resp.Message) + assert.Equal(t, "%s already exists", resp.MessageID) + assert.Equal(t, []any{"A cat"}, resp.MessageParams) }) t.Run("UnexpectedError", func(t *testing.T) { resp := NewResponse(http.StatusInternalServerError, ErrUnexpected, "A cat") assert.Equal(t, http.StatusInternalServerError, resp.Code) - assert.Equal(t, "Something went wrong, try again", resp.Err) - assert.Equal(t, "", resp.Msg) + assert.Equal(t, "Something went wrong, try again", resp.Error) + assert.Equal(t, "", resp.Message) + assert.Equal(t, "Something went wrong, try again", resp.MessageID) }) t.Run("ChangesSaved", func(t *testing.T) { resp := NewResponse(http.StatusOK, MsgChangesSaved) assert.Equal(t, http.StatusOK, resp.Code) - assert.Equal(t, "", resp.Err) - assert.Equal(t, "Changes successfully saved", resp.Msg) + assert.Equal(t, "", resp.Error) + assert.Equal(t, "Changes successfully saved", resp.Message) + assert.Equal(t, "Changes successfully saved", resp.MessageID) if s, err := json.Marshal(resp); err != nil { t.Fatal(err) } else { - assert.Equal(t, `{"code":200,"message":"Changes successfully saved"}`, string(s)) + assert.Equal(t, `{"code":200,"message":"Changes successfully saved","messageId":"Changes successfully saved"}`, string(s)) } }) } func TestResponse_String(t *testing.T) { t.Run("Error", func(t *testing.T) { - resp := Response{404, "Not found", "page not found", "xyz"} + resp := Response{Code: 404, Error: "Not found", Message: "page not found", Details: "xyz"} assert.Equal(t, "Not found", resp.String()) }) t.Run("NoError", func(t *testing.T) { t.Run("Error", func(t *testing.T) { - resp := Response{200, "", "Ok", "xyz"} + resp := Response{Code: 200, Message: "Ok", Details: "xyz"} assert.Equal(t, "Ok", resp.String()) }) }) @@ -50,38 +54,38 @@ func TestResponse_String(t *testing.T) { func TestResponse_LowerString(t *testing.T) { t.Run("Error", func(t *testing.T) { - resp := Response{404, "Not found", "page not found", "xyz"} + resp := Response{Code: 404, Error: "Not found", Message: "page not found", Details: "xyz"} assert.Equal(t, "not found", resp.LowerString()) }) t.Run("NoError", func(t *testing.T) { t.Run("Error", func(t *testing.T) { - resp := Response{200, "", "Ok", "xyz"} + resp := Response{Code: 200, Message: "Ok", Details: "xyz"} assert.Equal(t, "ok", resp.LowerString()) }) }) } -func TestResponse_Error(t *testing.T) { +func TestResponse_ErrorString(t *testing.T) { t.Run("Error", func(t *testing.T) { - resp := Response{404, "Not found", "page not found", "xyz"} - assert.Equal(t, "Not found", resp.Error()) + resp := Response{Code: 404, Error: "Not found", Message: "page not found", Details: "xyz"} + assert.Equal(t, "Not found", resp.ErrorString()) }) t.Run("NoError", func(t *testing.T) { t.Run("Error", func(t *testing.T) { - resp := Response{200, "", "Ok", "xyz"} - assert.Equal(t, "", resp.Error()) + resp := Response{Code: 200, Message: "Ok", Details: "xyz"} + assert.Equal(t, "", resp.ErrorString()) }) }) } func TestResponse_Success(t *testing.T) { t.Run("Error", func(t *testing.T) { - resp := Response{404, "Not found", "page not found", "xyz"} + resp := Response{Code: 404, Error: "Not found", Message: "page not found", Details: "xyz"} assert.Equal(t, false, resp.Success()) }) t.Run("NoError", func(t *testing.T) { t.Run("Error", func(t *testing.T) { - resp := Response{200, "", "Ok", "xyz"} + resp := Response{Code: 200, Message: "Ok", Details: "xyz"} assert.Equal(t, true, resp.Success()) }) }) diff --git a/pkg/list/list.go b/pkg/list/list.go index 5c604ed1b..c9e768d1b 100644 --- a/pkg/list/list.go +++ b/pkg/list/list.go @@ -1,7 +1,7 @@ /* Package list provides a string slice abstraction. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/list/ordered/ordered.go b/pkg/list/ordered/ordered.go index a205864d1..72eb20b61 100644 --- a/pkg/list/ordered/ordered.go +++ b/pkg/list/ordered/ordered.go @@ -6,7 +6,7 @@ used wherever PhotoPrism needs to preserve the exact order of user selections while still addressing elements directly by key (for example, batch photo editing and ordered REST responses). -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -19,7 +19,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/log/dummy/dummy.go b/pkg/log/dummy/dummy.go index 7d75a0ad6..fd65a452b 100644 --- a/pkg/log/dummy/dummy.go +++ b/pkg/log/dummy/dummy.go @@ -1,7 +1,7 @@ /* Package dummy provides dummy implementations for logger interfaces. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/log/level/level.go b/pkg/log/level/level.go index b2c4c4e1d..4f29d4ba3 100644 --- a/pkg/log/level/level.go +++ b/pkg/log/level/level.go @@ -1,7 +1,7 @@ /* Package level provides constants and abstractions for log levels and severities. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/log/status/const.go b/pkg/log/status/const.go index b8160b4a5..bfe3d56c0 100644 --- a/pkg/log/status/const.go +++ b/pkg/log/status/const.go @@ -4,6 +4,7 @@ package status const ( Failed = "failed" Denied = "denied" + Disabled = "disabled" Granted = "granted" Added = "added" Updated = "updated" @@ -16,6 +17,7 @@ const ( Joined = "joined" Confirmed = "confirmed" Skipped = "skipped" + Canceled = "canceled" NotFound = "not found" Unsupported = "not supported" RateLimited = "rate limit exceeded" diff --git a/pkg/log/status/errors.go b/pkg/log/status/errors.go new file mode 100644 index 000000000..857ecff7e --- /dev/null +++ b/pkg/log/status/errors.go @@ -0,0 +1,10 @@ +package status + +import "errors" + +// ErrCanceled signals that a worker or walk callback was interrupted by Cancel(). +var ErrCanceled = errors.New(Canceled) + +// ErrInsufficientStorage signals that an operation cannot proceed because the +// configured quota is exhausted or the storage path is critically low on free disk space. +var ErrInsufficientStorage = errors.New(InsufficientStorage) diff --git a/pkg/log/status/errors_test.go b/pkg/log/status/errors_test.go new file mode 100644 index 000000000..5fb5daf99 --- /dev/null +++ b/pkg/log/status/errors_test.go @@ -0,0 +1,25 @@ +package status + +import ( + "errors" + "fmt" + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestErrCanceled(t *testing.T) { + assert.EqualError(t, ErrCanceled, Canceled) + + wrapped := fmt.Errorf("worker stopped: %w", ErrCanceled) + assert.True(t, errors.Is(wrapped, ErrCanceled)) + assert.False(t, errors.Is(wrapped, ErrInsufficientStorage)) +} + +func TestErrInsufficientStorage(t *testing.T) { + assert.EqualError(t, ErrInsufficientStorage, InsufficientStorage) + + wrapped := fmt.Errorf("scheduler: %w (backup)", ErrInsufficientStorage) + assert.True(t, errors.Is(wrapped, ErrInsufficientStorage)) + assert.False(t, errors.Is(wrapped, ErrCanceled)) +} diff --git a/pkg/log/status/status.go b/pkg/log/status/status.go index d4097b3eb..4c1f6866a 100644 --- a/pkg/log/status/status.go +++ b/pkg/log/status/status.go @@ -2,7 +2,7 @@ Package status defines canonical outcome tokens shared by audit and system logging helpers so events stay consistent across packages. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -15,7 +15,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/media/README.md b/pkg/media/README.md index dbd982e20..8ea92d1c0 100644 --- a/pkg/media/README.md +++ b/pkg/media/README.md @@ -1,6 +1,6 @@ ## PhotoPrism — Media Package -**Last Updated:** February 14, 2026 +**Last Updated:** June 1, 2026 ### Apple iPhone & iPad @@ -10,10 +10,12 @@ We recommend [using an app like PhotoSync](https://docs.photoprism.app/user-guid ### Android Devices -Some Samsung and Google Android devices support taking "Motion Photos" with the included Camera app. Motion Photos are JPEG/HEIC image with a short MP4 video embedded after the image data. +Some Samsung and Google Android devices support taking "Motion Photos" with the included Camera app. A Motion Photo is a JPEG/HEIC image with a short MP4 video embedded after the image data. The image part of these files can be opened in any image viewer that supports JPEG/HEIC, but the video part cannot. However, since the MP4 video is simply appended at the end of the image file, it can be easily read by our software and streamed through the API as needed. +How PhotoPrism locates the embedded video offset and detects its codec is described in the [`video` subpackage documentation](https://github.com/photoprism/photoprism/blob/develop/pkg/media/video/README.md#codec-detection). + ### Introductory Tutorials | Title | Date | URL | @@ -27,16 +29,16 @@ The image part of these files can be opened in any image viewer that supports JP ### Software Libraries & References -| Title | URL | -|:-----------------------------------------------------|:------------------------------------------------------------------------| -| Web Video Codec Guide | https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Video_codecs | -| Media Container Formats | https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Containers | -| MP4 Signature Format | https://www.file-recovery.com/mp4-signature-format.htm | -| List of file signatures (Wikipedia) | https://en.wikipedia.org/wiki/List_of_file_signatures | -| Go library for reading and writing MP4 files | https://github.com/abema/go-mp4 | -| Go library for buffered I/O with io.Seeker interface | https://github.com/sunfish-shogi/bufseekio | -| How to use the io.Reader interface | https://yourbasic.org/golang/io-reader-interface-explained/ | -| AV1 Codec ISO Media File Format | https://aomediacodec.github.io/av1-isobmff | +| Title | URL | +|:-----------------------------------------------------|:-------------------------------------------------------------------------------| +| Web Video Codec Guide | https://developer.mozilla.org/en-US/docs/Web/Media/Guides/Formats/Video_codecs | +| Media Container Formats | https://developer.mozilla.org/en-US/docs/Web/Media/Guides/Formats/Containers | +| MP4 Signature Format | https://www.file-recovery.com/mp4-signature-format.htm | +| List of file signatures (Wikipedia) | https://en.wikipedia.org/wiki/List_of_file_signatures | +| Go library for reading and writing MP4 files | https://github.com/abema/go-mp4 | +| Go library for buffered I/O with io.Seeker interface | https://github.com/sunfish-shogi/bufseekio | +| How to use the io.Reader interface | https://yourbasic.org/golang/io-reader-interface-explained/ | +| AV1 Codec ISO Media File Format | https://aomediacodec.github.io/av1-isobmff | ### Related GitHub Issues diff --git a/pkg/media/colors/chroma.go b/pkg/media/colors/chroma.go index 98af30a71..22c2e5fb2 100644 --- a/pkg/media/colors/chroma.go +++ b/pkg/media/colors/chroma.go @@ -5,7 +5,7 @@ import "fmt" // Chroma represents colorfulness. type Chroma int16 -// Percent returns the colourfulness in percent. +// Percent returns the colorfulness in percent. func (c Chroma) Percent() int16 { if c > 100 { return 100 @@ -16,17 +16,17 @@ func (c Chroma) Percent() int16 { return int16(c) } -// Hex returns the colourfulness in percent has hex string. +// Hex returns the colorfulness in percent has hex string. func (c Chroma) Hex() string { return fmt.Sprintf("%X", c.Percent()) } -// Uint returns the colourfulness in percent as unsigned integer. +// Uint returns the colorfulness in percent as unsigned integer. func (c Chroma) Uint() uint { return uint(c.Percent()) //nolint:gosec // Percent is bounded 0..100 } -// Int returns the colourfulness in percent as integer. +// Int returns the colorfulness in percent as integer. func (c Chroma) Int() int { return int(c.Percent()) } diff --git a/pkg/media/colors/colors.go b/pkg/media/colors/colors.go index bef2456dd..65c5cdd97 100644 --- a/pkg/media/colors/colors.go +++ b/pkg/media/colors/colors.go @@ -1,7 +1,7 @@ /* Package colors provides types and functions for color classification. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/media/media.go b/pkg/media/media.go index 0ccf5491e..a1e1c4131 100644 --- a/pkg/media/media.go +++ b/pkg/media/media.go @@ -1,7 +1,7 @@ /* Package media provides general content types and maps them to file formats. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/media/projection/projection.go b/pkg/media/projection/projection.go index e57ed9757..29179c871 100644 --- a/pkg/media/projection/projection.go +++ b/pkg/media/projection/projection.go @@ -1,7 +1,7 @@ /* Package projection provides visual projection types and methods. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/media/video/README.md b/pkg/media/video/README.md index b3e7c9832..8c5e9e3e7 100644 --- a/pkg/media/video/README.md +++ b/pkg/media/video/README.md @@ -1,4 +1,6 @@ -## Video File Support +## PhotoPrism — Video Package + +**Last Updated:** June 1, 2026 ### Codecs & Containers @@ -16,15 +18,34 @@ Please Note: 1. Not all [video and audio formats](https://caniuse.com/?search=video%20format) can be [played with every browser](https://docs.photoprism.app/getting-started/troubleshooting/browsers/). For example, [AAC](https://caniuse.com/aac "Advanced Audio Coding") - the default audio codec for [MPEG-4 AVC / H.264](https://caniuse.com/avc "Advanced Video Coding") - is supported natively in Chrome, Safari, and Edge, while it is only optionally supported by the OS in Firefox and Opera. 2. HEVC/H.265 video files can have a `.mp4` file extension too, which is often associated with AVC only. This is because MP4 is a *container* format, meaning that the actual video content may be compressed with H.264, H.265, or something else. The file extension doesn't really tell you anything other than that it's probably a video file. -3. In case [FFmpeg is disabled](https://docs.photoprism.app/user-guide/settings/advanced/#disable-ffmpeg) or not installed, videos cannot be indexed because still images cannot be created. You should also have [Exiftool enabled](https://docs.photoprism.app/getting-started/config-options/#feature-flags) to extract metadata such as duration, resolution, and codec. +3. In case [FFmpeg is disabled](https://docs.photoprism.app/user-guide/settings/advanced/#disable-ffmpeg) or not installed, videos cannot be indexed because still images cannot be created. You should also have [ExifTool enabled](https://docs.photoprism.app/getting-started/config-options/#feature-flags) to extract metadata such as duration, resolution, and codec. ### Hybrid Photo/Video Formats For more information on hybrid photo/video file formats, e.g. Apple Live Photos and Samsung/Google Motion Photos, see [github.com/photoprism/photoprism/tree/develop/pkg/media](https://github.com/photoprism/photoprism/tree/develop/pkg/media) and [docs.photoprism.app/developer-guide/media/live](https://docs.photoprism.app/developer-guide/media/live/). +### Codec Detection + +PhotoPrism probes MP4 and QuickTime (ISO base media) files with [`go-mp4`](https://github.com/abema/go-mp4) to read the container brand, track layout, and codec. A chunk scan first locates the `ftyp` box and a compatible brand (`Chunks.FileTypeOffset` in `chunks.go`); in hybrid photo/video files this also yields the embedded-video offset, so the leading still image is skipped before parsing. MPEG-4 AVC / H.264 is then reported directly by the parser and needs no further work. + +HEVC / H.265 and [MagicYUV](https://en.wikipedia.org/wiki/MagicYUV) sample entries are not yet surfaced by `go-mp4`, so PhotoPrism falls back to a chunk scan over the file head when the parser does not return a codec: + +- The scan looks for the four-byte ISO BMFF sample-entry codes that identify these codecs — `hvc1`, `hev1`, `dvh1`, … for HEVC and `M8RG`, `M8Y2`, … for MagicYUV — in a single buffered pass (see `Chunks.SampleEntryOffset` in `chunks.go`). +- Each candidate is validated as a genuine visual sample entry rather than a raw byte match: the four bytes that precede it must be a plausible big-endian box size, and the bytes that follow must be the six reserved zero bytes and the nonzero `data_reference_index` mandated by ISO/IEC 14496-12 (`isVisualSampleEntry`). This rejects four-byte codes that merely collide with payload bytes, which is common in raw elementary streams such as the DV data inside some QuickTime files. +- The scan reads at most `HeadScanLimit` (16 MiB) and stops as soon as a valid entry is found. Buffered reads carry a small overlap so a code straddling a block boundary, and its validation window, stay visible. + +The detected codec, together with the codec and container reported by ExifTool, drives the FFmpeg exclude list (default `magy`, `vfw`) that keeps known-problematic formats out of transcoding and thumbnail extraction. + +#### Possible Improvements + +- **Read the codec from the parsed `stsd` box.** Once `go-mp4` reports HEVC (a pending upstream contribution), the chunk scan and `HeadScanLimit` could be retired for parseable MP4/QuickTime files. Reading the sample entry directly would also detect codecs in large non-faststart files, where `moov` sits past the 16 MiB cap and the head scan cannot reach it today. +- **Anchor the scan at the video offset.** Hybrid photo/video files embed the video after the still image, so the scan currently reads through several megabytes of image data before reaching the video's sample entry. Starting at the already-known video offset would skip the image prefix without affecting plain video files. + +> `HeadScanLimit` cannot simply be lowered for speed: motion photos place the video's sample entry several megabytes into the file, and non-faststart MP4/QuickTime files keep `moov` near the end, so a smaller cap would silently miss valid HEVC and MagicYUV streams. + ### Standard Resolutions -The [`PHOTOPRISM_FFMPEG_SIZE`](../../getting-started/config-options.md#file-converters) config option allows to limit the resolution of [transcoded videos](../../getting-started/advanced/transcoding.md). It accepts the following standard sizes, while other values are automatically adjusted to the next supported size: +The [`PHOTOPRISM_FFMPEG_SIZE`](https://docs.photoprism.app/getting-started/config-options/#file-converters) config option allows to limit the resolution of [transcoded videos](https://docs.photoprism.app/getting-started/advanced/transcoding/). It accepts the following standard sizes, while other values are automatically adjusted to the next supported size: | Size | Usage | |:-----|:-------------------| @@ -39,16 +60,16 @@ The [`PHOTOPRISM_FFMPEG_SIZE`](../../getting-started/config-options.md#file-conv ### Technical References & Tutorials -| Title | URL | -|:------------------------------------|:----------------------------------------------------------------------------| -| Web Video Codec Guide | https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Video_codecs | -| Web Video Content-Type Headers | https://developer.mozilla.org/en-US/docs/Web/Media/Formats/codecs_parameter | -| Media Container Formats | https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Containers | -| MP4 Signature Format | https://www.file-recovery.com/mp4-signature-format.htm | -| List of file signatures (Wikipedia) | https://en.wikipedia.org/wiki/List_of_file_signatures | -| How to use the io.Reader interface | https://yourbasic.org/golang/io-reader-interface-explained/ | -| AV1 Codec ISO Media File Format | https://aomediacodec.github.io/av1-isobmff | +| Title | URL | +|:------------------------------------|:-----------------------------------------------------------------------------------| +| Web Video Codec Guide | https://developer.mozilla.org/en-US/docs/Web/Media/Guides/Formats/Video_codecs | +| Web Video Content-Type Headers | https://developer.mozilla.org/en-US/docs/Web/Media/Guides/Formats/codecs_parameter | +| Media Container Formats | https://developer.mozilla.org/en-US/docs/Web/Media/Guides/Formats/Containers | +| MP4 Signature Format | https://www.file-recovery.com/mp4-signature-format.htm | +| List of file signatures (Wikipedia) | https://en.wikipedia.org/wiki/List_of_file_signatures | +| How to use the io.Reader interface | https://yourbasic.org/golang/io-reader-interface-explained/ | +| AV1 Codec ISO Media File Format | https://aomediacodec.github.io/av1-isobmff | ---- -*PhotoPrism® is a [registered trademark](https://www.photoprism.app/trademark). By using the software and services we provide, you agree to our [Terms of Service](https://www.photoprism.app/terms), [Privacy Policy](https://www.photoprism.app/privacy), and [Code of Conduct](https://www.photoprism.app/code-of-conduct). Docs are [available](https://link.photoprism.app/github-docs) under the [CC BY-NC-SA 4.0 License](https://creativecommons.org/licenses/by-nc-sa/4.0/); [additional terms](https://github.com/photoprism/photoprism/blob/develop/assets/README.md) may apply.* +*PhotoPrism® is a [registered trademark](https://www.photoprism.app/trademark/). By using the software and services we provide, you agree to our [Terms of Service](https://www.photoprism.app/terms/), [Privacy Policy](https://www.photoprism.app/privacy/), and [Code of Conduct](https://www.photoprism.app/code-of-conduct/). Docs are [available](https://link.photoprism.app/github-docs) under the [CC BY-NC-SA 4.0 License](https://creativecommons.org/licenses/by-nc-sa/4.0/); [additional terms](https://github.com/photoprism/photoprism/blob/develop/assets/README.md) may apply.* diff --git a/pkg/media/video/brands.go b/pkg/media/video/brands.go index d43da26b3..1401bb8c8 100644 --- a/pkg/media/video/brands.go +++ b/pkg/media/video/brands.go @@ -47,8 +47,30 @@ var ( ChunkMP42 = Chunk{'m', 'p', '4', '2'} ChunkMP71 = Chunk{'m', 'p', '7', '1'} ChunkHEIC = Chunk{'h', 'e', 'i', 'c'} + ChunkM8RG = Chunk{'M', '8', 'R', 'G'} // MagicYUV RGB + ChunkM8RA = Chunk{'M', '8', 'R', 'A'} // MagicYUV RGBA + ChunkM8RB = Chunk{'M', '8', 'R', 'B'} // MagicYUV RGB (alt) + ChunkM8Y0 = Chunk{'M', '8', 'Y', '0'} // MagicYUV YUV 4:2:0 + ChunkM8Y2 = Chunk{'M', '8', 'Y', '2'} // MagicYUV YUV 4:2:2 + ChunkM8Y4 = Chunk{'M', '8', 'Y', '4'} // MagicYUV YUV 4:4:4 + ChunkM8YA = Chunk{'M', '8', 'Y', 'A'} // MagicYUV YUVA 4:4:4:4 + ChunkM8G0 = Chunk{'M', '8', 'G', '0'} // MagicYUV Grayscale ) +// HevcChunks lists the ISO BMFF sample entry codes that identify an HEVC +// (H.265) video stream, including Dolby Vision wrappers built on top of HEVC. +var HevcChunks = Chunks{ + ChunkHVC1, ChunkHVC2, ChunkHVC3, ChunkDVH1, + ChunkHEV1, ChunkHEV2, ChunkHEV3, ChunkDVHE, +} + +// MagicYuvChunks lists the ISO BMFF sample entry codes that identify a MagicYUV +// video stream, one per supported pixel format. +var MagicYuvChunks = Chunks{ + ChunkM8RG, ChunkM8RA, ChunkM8RB, ChunkM8Y0, + ChunkM8Y2, ChunkM8Y4, ChunkM8YA, ChunkM8G0, +} + // CompatibleBrands contains compatible subtypes chunks: // https://mp4ra.org/registered-types/codecs var CompatibleBrands = Chunks{ diff --git a/pkg/media/video/chunk.go b/pkg/media/video/chunk.go index 95bb7ca7d..78ffee1cc 100644 --- a/pkg/media/video/chunk.go +++ b/pkg/media/video/chunk.go @@ -8,8 +8,6 @@ import ( "io" "os" - "github.com/sunfish-shogi/bufseekio" - "github.com/photoprism/photoprism/pkg/fs" ) @@ -66,52 +64,9 @@ func (c Chunk) FileOffset(fileName string) (index int, err error) { } // DataOffset returns the index of the chunk in file, or -1 if it was not found. +// Delegates to Chunks.DataOffset so the single-needle and multi-needle scans +// share one buffered-read implementation. func (c Chunk) DataOffset(file io.ReadSeeker, offset, maxOffset int) (int, error) { - if file == nil { - return -1, errors.New("file is nil") - } - - data := c.Bytes() - dataSize := len(data) - blockSize := 128 * 1024 - buffer := make([]byte, blockSize) - - // Create buffered read seeker. - r := bufseekio.NewReadSeeker(file, blockSize, dataSize) - - if seekOffset, seekErr := r.Seek(int64(offset), io.SeekStart); seekErr != nil { - return -1, seekErr - } else { - offset = int(seekOffset) - } - - // Search in batches. - for { - n, err := r.Read(buffer) - buffer = buffer[:n] - - if err != nil { - if err != io.EOF { - return -1, err - } - - break - } else if n == 0 { - break - } - - // Return data index, if found. - if i := bytes.Index(buffer, data); i >= 0 { - return offset + i, nil - } - - offset += n - - // Return if the chunk was not found up to the maximum offset. - if maxOffset > 0 && maxOffset <= offset { - return -1, nil - } - } - - return -1, nil + pos, _, err := Chunks{c}.DataOffset(file, offset, maxOffset) + return pos, err } diff --git a/pkg/media/video/chunks.go b/pkg/media/video/chunks.go index 3729eca63..18c929d44 100644 --- a/pkg/media/video/chunks.go +++ b/pkg/media/video/chunks.go @@ -2,12 +2,26 @@ package video import ( "bytes" + "encoding/binary" "errors" "io" "github.com/sunfish-shogi/bufseekio" ) +const ( + // sampleEntryHeaderLen is the number of leading bytes of an ISO BMFF visual + // sample entry inspected during validation: box size (4) + coding name (4) + + // reserved (6) + data_reference_index (2). + sampleEntryHeaderLen = 16 + // minVisualSampleEntrySize is the smallest spec-compliant VisualSampleEntry + // box (8-byte box header + 8-byte SampleEntry base + 70-byte VisualSampleEntry + // fixed fields), and maxVisualSampleEntrySize caps the plausible size so a + // random four-byte value preceding a colliding coding name is rejected. + minVisualSampleEntrySize = 86 + maxVisualSampleEntrySize = 1 << 20 +) + // Chunks represents a list of file chunks. type Chunks []Chunk @@ -91,3 +105,186 @@ func (c Chunks) FileTypeOffset(file io.ReadSeeker) (int, error) { return -1, nil } + +// DataOffset scans file for the first occurrence of any chunk in c and returns +// the matching offset together with the chunk that matched. The search starts +// at offset and stops at maxOffset (or EOF when maxOffset < 0). A single pass +// is made: each buffered block is searched for every chunk at once and the +// earliest match within the block wins. Returns -1 and a zero Chunk if no +// chunk in c is found before the cap or EOF. +func (c Chunks) DataOffset(file io.ReadSeeker, offset, maxOffset int) (int, Chunk, error) { + if file == nil { + return -1, Chunk{}, errors.New("file is nil") + } else if len(c) == 0 { + return -1, Chunk{}, nil + } + + const blockSize = 128 * 1024 + const cachedBlocks = 4 // Number of blocks bufseekio keeps cached; reads do not overlap. + + buffer := make([]byte, blockSize) + r := bufseekio.NewReadSeeker(file, blockSize, cachedBlocks) + + if seekOffset, seekErr := r.Seek(int64(offset), io.SeekStart); seekErr != nil { + return -1, Chunk{}, seekErr + } else { + offset = int(seekOffset) + } + + // Search in batches. + for { + n, err := r.Read(buffer) + buffer = buffer[:n] + + if err != nil { + if err != io.EOF { + return -1, Chunk{}, err + } + + break + } else if n == 0 { + break + } + + // Pick the earliest match across all chunks within this buffer. + bestIdx := -1 + var bestChunk Chunk + for i := range c { + if idx := bytes.Index(buffer, c[i].Bytes()); idx >= 0 && (bestIdx < 0 || idx < bestIdx) { + bestIdx = idx + bestChunk = c[i] + } + } + + if bestIdx >= 0 { + return offset + bestIdx, bestChunk, nil + } + + offset += n + + // Return if the chunk was not found up to the maximum offset. + if maxOffset > 0 && maxOffset <= offset { + return -1, Chunk{}, nil + } + } + + return -1, Chunk{}, nil +} + +// isVisualSampleEntry reports whether box begins with a valid ISO BMFF visual +// sample entry header: a big-endian box size within plausible bounds, the +// four-byte coding name, six reserved zero bytes, and a nonzero +// data_reference_index. The reserved zero bytes and nonzero index are mandated +// by ISO/IEC 14496-12, so a coding name that merely collides with random +// payload bytes is rejected. box must hold at least sampleEntryHeaderLen bytes +// starting at the box size field; the coding name (box[4:8]) is matched by the +// caller. +func isVisualSampleEntry(box []byte) bool { + if len(box) < sampleEntryHeaderLen { + return false + } + + if size := binary.BigEndian.Uint32(box[0:4]); size < minVisualSampleEntrySize || size > maxVisualSampleEntrySize { + return false + } + + // The six bytes following the coding name are a const-zero reserved field. + for _, b := range box[8:14] { + if b != 0 { + return false + } + } + + // data_reference_index is a 1-based index and is never zero in practice. + return binary.BigEndian.Uint16(box[14:16]) != 0 +} + +// SampleEntryOffset scans the head of file (up to maxOffset, or to EOF when +// maxOffset <= 0) for the first chunk in c that is framed as a valid ISO BMFF +// visual sample entry, returning its offset and the matching chunk. Unlike a +// raw byte search, each candidate coding name is validated with +// isVisualSampleEntry so that a four-byte code colliding with random payload +// bytes — common in raw video elementary streams such as DV — is not mistaken +// for a codec. Returns -1 and a zero Chunk when no valid sample entry is found. +func (c Chunks) SampleEntryOffset(file io.ReadSeeker, maxOffset int) (int, Chunk, error) { + if file == nil { + return -1, Chunk{}, errors.New("file is nil") + } else if len(c) == 0 { + return -1, Chunk{}, nil + } + + if _, err := file.Seek(0, io.SeekStart); err != nil { + return -1, Chunk{}, err + } + + const blockSize = 128 * 1024 + // carry retains the trailing bytes of each block so a coding name straddling + // a block boundary, and the validation window of a candidate near the end of + // a block, stay visible within a single buffer on the next read. + const carry = sampleEntryHeaderLen + + buffer := make([]byte, carry+blockSize) + + base := 0 // Absolute file offset of buffer[0]. + have := 0 // Number of valid bytes currently in buffer. + + for { + n, err := io.ReadFull(file, buffer[have:]) + + if err != nil && err != io.EOF && err != io.ErrUnexpectedEOF { + return -1, Chunk{}, err + } + + have += n + atEOF := err == io.EOF || err == io.ErrUnexpectedEOF + + // A sample entry's coding name sits at box offset +4, so a candidate at + // index i needs the window buffer[i-4 : i+12]; i therefore starts at 4. + best, bestChunk := -1, Chunk{} + for _, chunk := range c { + needle := chunk.Bytes() + for from := 4; from+len(needle) <= have; { + rel := bytes.Index(buffer[from:have], needle) + if rel < 0 { + break + } + + i := from + rel + + // Defer candidates whose validation window is not fully buffered yet; + // the carry-over re-surfaces them with complete context next read. + if i-4+sampleEntryHeaderLen > have { + break + } + + if isVisualSampleEntry(buffer[i-4 : i-4+sampleEntryHeaderLen]) { + if best < 0 || i < best { + best, bestChunk = i, chunk + } + break + } + + from = i + 1 + } + } + + if best >= 0 { + return base + best, bestChunk, nil + } + + if atEOF { + return -1, Chunk{}, nil + } + + if maxOffset > 0 && base+have >= maxOffset { + return -1, Chunk{}, nil + } + + // Carry the trailing bytes to the front and refill the remainder. + if have > carry { + copy(buffer, buffer[have-carry:have]) + base += have - carry + have = carry + } + } +} diff --git a/pkg/media/video/chunks_test.go b/pkg/media/video/chunks_test.go index c5e531f24..9f6904932 100644 --- a/pkg/media/video/chunks_test.go +++ b/pkg/media/video/chunks_test.go @@ -1,6 +1,8 @@ package video import ( + "bytes" + "encoding/binary" "io" "testing" @@ -10,6 +12,24 @@ import ( "github.com/sunfish-shogi/bufseekio" ) +// sampleEntryHeader returns a valid 16-byte ISO BMFF visual sample entry header +// (box size, coding name, six reserved zero bytes, data_reference_index = 1) for +// use in SampleEntryOffset tests. +func sampleEntryHeader(code Chunk) []byte { + b := make([]byte, sampleEntryHeaderLen) + binary.BigEndian.PutUint32(b[0:4], minVisualSampleEntrySize) + copy(b[4:8], code.Bytes()) + binary.BigEndian.PutUint16(b[14:16], 1) + return b +} + +// placeSampleEntry writes a valid visual sample entry into buf so that the +// coding name begins at codingNameOffset, mirroring the on-disk layout where +// the four-byte box size precedes the coding name. +func placeSampleEntry(buf []byte, codingNameOffset int, code Chunk) { + copy(buf[codingNameOffset-4:], sampleEntryHeader(code)) +} + func TestChunk_TypeCast(t *testing.T) { t.Run("String", func(t *testing.T) { assert.Equal(t, "ftyp", ChunkFTYP.String()) @@ -112,6 +132,167 @@ func TestChunks(t *testing.T) { }) } +func TestChunks_DataOffset(t *testing.T) { + t.Run("FirstMatchWins", func(t *testing.T) { + f := openTestFile(t, "testdata/motion-photo.heif") + // ChunkHVC1 lives at 976016; ChunkHEIC lives at 8. With both as needles + // the earlier one (HEIC) must win the single-pass scan. + pos, hit, err := Chunks{ChunkHVC1, ChunkHEIC}.DataOffset(f, 0, -1) + require.NoError(t, err) + assert.Equal(t, 8, pos) + assert.Equal(t, ChunkHEIC, hit) + }) + t.Run("SingleChunkSamePosition", func(t *testing.T) { + f := openTestFile(t, "testdata/motion-photo.heif") + pos, hit, err := Chunks{ChunkHVC1}.DataOffset(f, 0, -1) + require.NoError(t, err) + assert.Equal(t, 976016, pos) + assert.Equal(t, ChunkHVC1, hit) + }) + t.Run("MaxOffsetCapsScan", func(t *testing.T) { + f := openTestFile(t, "testdata/motion-photo.heif") + // HVC1 sits at 976016; a cap below that must short-circuit before reading it. + pos, hit, err := Chunks{ChunkHVC1}.DataOffset(f, 0, 512*1024) + require.NoError(t, err) + assert.Equal(t, -1, pos) + assert.Equal(t, Chunk{}, hit) + }) + t.Run("NotFound", func(t *testing.T) { + f := openTestFile(t, "testdata/mp4v-avc1.mp4") + pos, hit, err := Chunks{ChunkHVC1, ChunkHEV1}.DataOffset(f, 0, -1) + require.NoError(t, err) + assert.Equal(t, -1, pos) + assert.Equal(t, Chunk{}, hit) + }) + t.Run("Empty", func(t *testing.T) { + f := openTestFile(t, "testdata/mp4v-avc1.mp4") + pos, hit, err := Chunks{}.DataOffset(f, 0, -1) + require.NoError(t, err) + assert.Equal(t, -1, pos) + assert.Equal(t, Chunk{}, hit) + }) + t.Run("NilFile", func(t *testing.T) { + pos, hit, err := Chunks{ChunkHVC1}.DataOffset(nil, 0, -1) + require.Error(t, err) + assert.Equal(t, -1, pos) + assert.Equal(t, Chunk{}, hit) + }) +} + +func TestIsVisualSampleEntry(t *testing.T) { + t.Run("Valid", func(t *testing.T) { + assert.True(t, isVisualSampleEntry(sampleEntryHeader(ChunkM8RG))) + }) + t.Run("TooShort", func(t *testing.T) { + assert.False(t, isVisualSampleEntry(sampleEntryHeader(ChunkM8RG)[:15])) + }) + t.Run("SizeTooSmall", func(t *testing.T) { + b := sampleEntryHeader(ChunkM8RG) + binary.BigEndian.PutUint32(b[0:4], minVisualSampleEntrySize-1) + assert.False(t, isVisualSampleEntry(b)) + }) + t.Run("SizeTooLarge", func(t *testing.T) { + b := sampleEntryHeader(ChunkM8RG) + binary.BigEndian.PutUint32(b[0:4], maxVisualSampleEntrySize+1) + assert.False(t, isVisualSampleEntry(b)) + }) + t.Run("ReservedNotZero", func(t *testing.T) { + b := sampleEntryHeader(ChunkM8RG) + b[10] = 0x01 // One of the six reserved bytes is nonzero. + assert.False(t, isVisualSampleEntry(b)) + }) + t.Run("ZeroDataReferenceIndex", func(t *testing.T) { + b := sampleEntryHeader(ChunkM8RG) + binary.BigEndian.PutUint16(b[14:16], 0) + assert.False(t, isVisualSampleEntry(b)) + }) +} + +func TestChunks_SampleEntryOffset(t *testing.T) { + t.Run("RealMagicYuvFile", func(t *testing.T) { + f := openTestFile(t, "testdata/magicyuv.mov") + pos, hit, err := MagicYuvChunks.SampleEntryOffset(f, HeadScanLimit) + require.NoError(t, err) + assert.Equal(t, 3537, pos) + assert.Equal(t, ChunkM8RG, hit) + }) + t.Run("RealHevcFile", func(t *testing.T) { + f := openTestFile(t, "testdata/quicktime-hvc1.mov") + pos, hit, err := HevcChunks.SampleEntryOffset(f, HeadScanLimit) + require.NoError(t, err) + assert.Greater(t, pos, 0) + assert.Equal(t, ChunkHVC1, hit) + }) + t.Run("RejectsStrayCollision", func(t *testing.T) { + // A four-byte MagicYUV code embedded in raw payload bytes, not framed as + // a sample entry, must not be reported as a codec (issue #5617). + buf := bytes.Repeat([]byte{0xAA}, 4096) + copy(buf[1000:], ChunkM8Y4.Bytes()) + pos, hit, err := MagicYuvChunks.SampleEntryOffset(bytes.NewReader(buf), HeadScanLimit) + require.NoError(t, err) + assert.Equal(t, -1, pos) + assert.Equal(t, Chunk{}, hit) + }) + t.Run("AcceptsFramedEntry", func(t *testing.T) { + buf := bytes.Repeat([]byte{0xAA}, 4096) + placeSampleEntry(buf, 2000, ChunkM8Y2) + pos, hit, err := MagicYuvChunks.SampleEntryOffset(bytes.NewReader(buf), HeadScanLimit) + require.NoError(t, err) + assert.Equal(t, 2000, pos) + assert.Equal(t, ChunkM8Y2, hit) + }) + t.Run("StrayBeforeRealEntry", func(t *testing.T) { + // An earlier stray collision must not shadow a later valid sample entry; + // the scan continues past invalid candidates. + buf := bytes.Repeat([]byte{0xAA}, 4096) + copy(buf[500:], ChunkM8Y4.Bytes()) + placeSampleEntry(buf, 2000, ChunkM8RG) + pos, hit, err := MagicYuvChunks.SampleEntryOffset(bytes.NewReader(buf), HeadScanLimit) + require.NoError(t, err) + assert.Equal(t, 2000, pos) + assert.Equal(t, ChunkM8RG, hit) + }) + t.Run("BoundarySpanning", func(t *testing.T) { + // A valid entry whose coding name straddles the internal 128 KiB block + // boundary must still be found via the carry-over between reads. + const codingNameOffset = 128*1024 - 1 + buf := bytes.Repeat([]byte{0xAA}, 200000) + placeSampleEntry(buf, codingNameOffset, ChunkM8YA) + pos, hit, err := MagicYuvChunks.SampleEntryOffset(bytes.NewReader(buf), HeadScanLimit) + require.NoError(t, err) + assert.Equal(t, codingNameOffset, pos) + assert.Equal(t, ChunkM8YA, hit) + }) + t.Run("MaxOffsetCapsScan", func(t *testing.T) { + buf := bytes.Repeat([]byte{0xAA}, 200000) + placeSampleEntry(buf, 150000, ChunkM8RG) + pos, hit, err := MagicYuvChunks.SampleEntryOffset(bytes.NewReader(buf), 64*1024) + require.NoError(t, err) + assert.Equal(t, -1, pos) + assert.Equal(t, Chunk{}, hit) + }) + t.Run("NotFound", func(t *testing.T) { + f := openTestFile(t, "testdata/mp4v-avc1.mp4") + pos, hit, err := HevcChunks.SampleEntryOffset(f, HeadScanLimit) + require.NoError(t, err) + assert.Equal(t, -1, pos) + assert.Equal(t, Chunk{}, hit) + }) + t.Run("Empty", func(t *testing.T) { + f := openTestFile(t, "testdata/mp4v-avc1.mp4") + pos, hit, err := Chunks{}.SampleEntryOffset(f, HeadScanLimit) + require.NoError(t, err) + assert.Equal(t, -1, pos) + assert.Equal(t, Chunk{}, hit) + }) + t.Run("NilFile", func(t *testing.T) { + pos, hit, err := MagicYuvChunks.SampleEntryOffset(nil, HeadScanLimit) + require.Error(t, err) + assert.Equal(t, -1, pos) + assert.Equal(t, Chunk{}, hit) + }) +} + func TestChunks_Contains(t *testing.T) { t.Run("Found", func(t *testing.T) { assert.True(t, CompatibleBrands.Contains(ChunkMP41)) diff --git a/pkg/media/video/codecs.go b/pkg/media/video/codecs.go index e15791a90..7d1696f2f 100644 --- a/pkg/media/video/codecs.go +++ b/pkg/media/video/codecs.go @@ -13,29 +13,31 @@ type Codec = string // - https://cconcolato.github.io/media-mime-support/ // - https://thorium.rocks/misc/h265-tester.html const ( - CodecUnknown Codec = "" - CodecAvc1 Codec = "avc1" // Advanced Video Coding (AVC), also known as H.264 - CodecDva1 Codec = "dva1" // AVC-based Dolby Vision derived from avc1 - CodecAvc2 Codec = "avc2" // Advanced Video Coding (AVC), might not be fully supported on macOS - CodecAvc3 Codec = "avc3" // Advanced Video Coding (AVC), might not be fully supported on macOS - CodecAvc4 Codec = "avc4" // Advanced Video Coding (AVC), might not be fully supported on macOS - CodecDvav Codec = "dvav" // AVC-based Dolby Vision derived from avc3 - CodecHvc1 Codec = "hvc1" // High Efficiency Video Coding (HEVC), also known as H.265 - CodecDvh1 Codec = "dvh1" // HEVC-based Dolby Vision derived from hvc1 - CodecHvc2 Codec = "hvc2" // HEVC video with constrained extractors and/or aggregators and parameter sets only in the Sample Entry - CodecHvc3 Codec = "hvc3" // HEVC video with extractors and/or aggregators and parameter sets only in the Sample Entry - CodecHev1 Codec = "hev1" // HEVC video with parameter sets also in the Samples, not supported on macOS - CodecDvhe Codec = "dvhe" // HEVC-based Dolby Vision derived from hev1 - CodecHev2 Codec = "hev2" // HEVC video with constrained extractors and/or aggregators and parameter sets in the Sample Entry or samples - CodecHev3 Codec = "hev3" // HEVC video with extractors and/or aggregators and parameter sets in the Sample Entry or samples - CodecVvc1 Codec = "vvc1" // Versatile Video Coding (VVC), also known as H.266 - CodecEvc1 Codec = "evc1" // MPEG-5 Essential Video Coding (EVC), also known as ISO/IEC 23094-1 - CodecAv01 Codec = "av01" // AOMedia Video 1 (AV1) - CodecVp08 Codec = "vp08" // Google VP8 - CodecVp09 Codec = "vp09" // Google VP9 - CodecTheora Codec = "ogv" // Ogg Vorbis Video - CodecM2TS Codec = "m2t" // MPEG-2 Transport Stream - CodecWebm Codec = "webm" // Google WebM + CodecUnknown Codec = "" + CodecAvc1 Codec = "avc1" // Advanced Video Coding (AVC), also known as H.264 + CodecDva1 Codec = "dva1" // AVC-based Dolby Vision derived from avc1 + CodecAvc2 Codec = "avc2" // Advanced Video Coding (AVC), might not be fully supported on macOS + CodecAvc3 Codec = "avc3" // Advanced Video Coding (AVC), might not be fully supported on macOS + CodecAvc4 Codec = "avc4" // Advanced Video Coding (AVC), might not be fully supported on macOS + CodecDvav Codec = "dvav" // AVC-based Dolby Vision derived from avc3 + CodecHvc1 Codec = "hvc1" // High Efficiency Video Coding (HEVC), also known as H.265 + CodecDvh1 Codec = "dvh1" // HEVC-based Dolby Vision derived from hvc1 + CodecHvc2 Codec = "hvc2" // HEVC video with constrained extractors and/or aggregators and parameter sets only in the Sample Entry + CodecHvc3 Codec = "hvc3" // HEVC video with extractors and/or aggregators and parameter sets only in the Sample Entry + CodecHev1 Codec = "hev1" // HEVC video with parameter sets also in the Samples, not supported on macOS + CodecDvhe Codec = "dvhe" // HEVC-based Dolby Vision derived from hev1 + CodecHev2 Codec = "hev2" // HEVC video with constrained extractors and/or aggregators and parameter sets in the Sample Entry or samples + CodecHev3 Codec = "hev3" // HEVC video with extractors and/or aggregators and parameter sets in the Sample Entry or samples + CodecVvc1 Codec = "vvc1" // Versatile Video Coding (VVC), also known as H.266 + CodecEvc1 Codec = "evc1" // MPEG-5 Essential Video Coding (EVC), also known as ISO/IEC 23094-1 + CodecAv01 Codec = "av01" // AOMedia Video 1 (AV1) + CodecVp08 Codec = "vp08" // Google VP8 + CodecVp09 Codec = "vp09" // Google VP9 + CodecTheora Codec = "ogv" // Ogg Vorbis Video + CodecM2TS Codec = "m2t" // MPEG-2 Transport Stream + CodecWebm Codec = "webm" // Google WebM + CodecMagicYUV Codec = "magy" // MagicYUV lossless video (FourCC) + CodecVFW Codec = "vfw" // Video for Windows wrapper; the actual codec is not exposed by metadata ) // Codecs maps supported string identifiers to standard Codec types. @@ -51,6 +53,7 @@ var Codecs = StandardCodecs{ CodecAvc2: CodecAvc1, CodecAvc4: CodecAvc1, "avc": CodecAvc1, + "h264": CodecAvc1, "v_avc": CodecAvc1, "v_avc1": CodecAvc1, "v_avc2": CodecAvc1, @@ -71,6 +74,7 @@ var Codecs = StandardCodecs{ CodecHvc2: CodecHvc1, CodecHvc3: CodecHvc1, "hevc": CodecHvc1, + "h265": CodecHvc1, "v_hevc": CodecHvc1, "hevC": CodecHvc1, "hvc": CodecHvc1, @@ -122,6 +126,32 @@ var Codecs = StandardCodecs{ "theora": CodecTheora, "v_theora": CodecTheora, CodecWebm: CodecWebm, + CodecMagicYUV: CodecMagicYUV, + "magicyuv": CodecMagicYUV, // Human-readable name + "m8rg": CodecMagicYUV, // RGB + "m8ra": CodecMagicYUV, // RGBA + "m8rb": CodecMagicYUV, // RGB (alt) + "m8y0": CodecMagicYUV, // YUV 4:2:0 + "m8y2": CodecMagicYUV, // YUV 4:2:2 + "m8y4": CodecMagicYUV, // YUV 4:4:4 + "m8ya": CodecMagicYUV, // YUVA 4:4:4:4 + "m8g0": CodecMagicYUV, // Grayscale + CodecVFW: CodecVFW, + "v_ms": CodecVFW, + "v_ms/vfw/fourcc": CodecVFW, // Matroska wrapper for a Video for Windows FourCC codec +} + +// Canonical returns the standard codec name for the given identifier, or the +// identifier unchanged if it is not a recognized codec alias. Callers should +// pass a normalized (lowercase) name. This lets the original name reported by +// a metadata tool (e.g. "m8ra") and its mapped name (e.g. "magy") be treated +// as equivalent. +func Canonical(name string) Codec { + if c, ok := Codecs[name]; ok && c != CodecUnknown { + return c + } + + return name } // StandardCodecs maps strings to codec types. diff --git a/pkg/media/video/codecs_test.go b/pkg/media/video/codecs_test.go index 40f3e802f..ece1c202d 100644 --- a/pkg/media/video/codecs_test.go +++ b/pkg/media/video/codecs_test.go @@ -22,4 +22,50 @@ func TestCodecs(t *testing.T) { if val := Codecs["vvcC"]; val != CodecVvc1 { t.Fatal("codec should be CodecVVC") } + + if val := Codecs["magicyuv"]; val != CodecMagicYUV { + t.Fatal("codec should be CodecMagicYUV") + } + + if val := Codecs["h264"]; val != CodecAvc1 { + t.Fatal("codec 'h264' should map to CodecAvc1") + } + + if val := Codecs["h265"]; val != CodecHvc1 { + t.Fatal("codec 'h265' should map to CodecHvc1") + } + + for _, fourcc := range []string{"magy", "m8rg", "m8ra", "m8rb", "m8y0", "m8y2", "m8y4", "m8ya", "m8g0"} { + if val := Codecs[fourcc]; val != CodecMagicYUV { + t.Fatalf("FourCC %q should map to CodecMagicYUV, got %q", fourcc, val) + } + } + + for _, id := range []string{"vfw", "v_ms", "v_ms/vfw/fourcc"} { + if val := Codecs[id]; val != CodecVFW { + t.Fatalf("identifier %q should map to CodecVFW, got %q", id, val) + } + } +} + +func TestCanonical(t *testing.T) { + cases := map[string]Codec{ + "magy": CodecMagicYUV, + "magicyuv": CodecMagicYUV, // Human-readable alias. + "m8ra": CodecMagicYUV, // FourCC reported by ExifTool. + "h264": CodecAvc1, + "avc": CodecAvc1, + "h265": CodecHvc1, + "v_ms/vfw/fourcc": CodecVFW, // Matroska VFW wrapper. + "v_ms": CodecVFW, + "mkv": "mkv", // Not a codec alias, returned unchanged. + "a_opus": "a_opus", // Maps to CodecUnknown, returned unchanged. + "": "", + } + + for in, want := range cases { + if got := Canonical(in); got != want { + t.Fatalf("Canonical(%q) = %q, want %q", in, got, want) + } + } } diff --git a/pkg/media/video/formats.go b/pkg/media/video/formats.go new file mode 100644 index 000000000..2005ac2cd --- /dev/null +++ b/pkg/media/video/formats.go @@ -0,0 +1,97 @@ +package video + +import ( + "sort" + "strings" + + "github.com/photoprism/photoprism/pkg/clean" +) + +// Formats represents a set of video container and codec names for allow/exclude +// lookups. Keys are stored lowercased and matched case-insensitively. +type Formats map[string]bool + +// NewFormats creates a Formats set from a comma-separated string of container +// and/or codec names. Returns an empty set when the input is empty. +func NewFormats(formats ...string) Formats { + n := strings.Count(strings.Join(formats, clean.FormatSep), clean.FormatSep) + list := make(Formats, n+8) + + for i := range formats { + list.Set(formats[i]) + } + + return list +} + +// Match returns the first of the given format names that is in the list, +// reported as its canonical codec alias, or "" if none match. Empty values are +// skipped so callers can pass both a codec and a container even when only one +// is known. Use it to name the matched entry when reporting why a file was +// excluded. +func (b Formats) Match(formats ...string) string { + if len(b) == 0 { + return "" + } + + for _, format := range formats { + if format = clean.Format(format); format == "" { + continue + } else if canonical := Canonical(format); b[canonical] { + return canonical + } + } + + return "" +} + +// Contains reports whether any of the given format names is in the list. +// Empty values are skipped so callers can pass both a codec and a container +// even when only one is known. Names are matched by their canonical codec +// alias, so the original name (e.g. "m8ra") and its mapped name (e.g. "magy") +// are treated as equivalent. +func (b Formats) Contains(formats ...string) bool { + return b.Match(formats...) != "" +} + +// Allow reports whether the given format is NOT in the list. +func (b Formats) Allow(format string) bool { + return !b.Contains(format) +} + +// Set adds a comma-separated list of format names to the list. +func (b Formats) Set(formats string) { + if formats == "" { + return + } + + for c := range strings.SplitSeq(formats, clean.FormatSep) { + b.Add(c) + } +} + +// Add adds a format name to the list after normalizing it to its canonical +// codec alias, so different names for the same codec collapse to one entry. +func (b Formats) Add(format string) { + format = clean.Format(format) + if format == "" { + return + } + + b[Canonical(format)] = true +} + +// String returns the list as a comma-separated string in alphabetical order. +func (b Formats) String() string { + if len(b) == 0 { + return "" + } + + list := make([]string, 0, len(b)) + for s := range b { + list = append(list, s) + } + + sort.Strings(list) + return strings.Join(list, ", ") +} diff --git a/pkg/media/video/formats_test.go b/pkg/media/video/formats_test.go new file mode 100644 index 000000000..6cbc71cde --- /dev/null +++ b/pkg/media/video/formats_test.go @@ -0,0 +1,201 @@ +package video + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestNewFormats(t *testing.T) { + t.Run("Empty", func(t *testing.T) { + list := NewFormats("") + assert.Empty(t, list) + }) + t.Run("Single", func(t *testing.T) { + list := NewFormats("magicyuv") + assert.Len(t, list, 1) + assert.True(t, list.Contains("magicyuv")) + }) + t.Run("CommaSeparated", func(t *testing.T) { + list := NewFormats("magicyuv, hap, avi") + assert.Len(t, list, 3) + assert.True(t, list.Contains("magicyuv")) + assert.True(t, list.Contains("hap")) + assert.True(t, list.Contains("avi")) + }) + t.Run("AliasesCollapse", func(t *testing.T) { + // Different names for the same codec map to a single canonical entry. + list := NewFormats("magicyuv, m8rg ,M8RA") + assert.Len(t, list, 1) + assert.True(t, list.Contains("magy")) + assert.True(t, list.Contains("magicyuv")) + assert.True(t, list.Contains("m8rg")) + assert.True(t, list.Contains("m8ra")) + }) + t.Run("MixedContainerAndCodec", func(t *testing.T) { + list := NewFormats("avi, magicyuv") + assert.Len(t, list, 2) + assert.True(t, list.Contains("avi")) + assert.True(t, list.Contains("magicyuv")) + }) +} + +func TestFormats_Contains(t *testing.T) { + list := NewFormats("magicyuv, m8rg") + + t.Run("Match", func(t *testing.T) { + assert.True(t, list.Contains("magicyuv")) + }) + t.Run("CaseInsensitive", func(t *testing.T) { + assert.True(t, list.Contains("MagicYUV")) + assert.True(t, list.Contains("M8RG")) + }) + t.Run("Trimmed", func(t *testing.T) { + assert.True(t, list.Contains(" magicyuv ")) + assert.True(t, list.Contains(`"magicyuv"`)) + assert.True(t, list.Contains(".magicyuv")) + }) + t.Run("NoMatch", func(t *testing.T) { + assert.False(t, list.Contains("avc1")) + }) + t.Run("Empty", func(t *testing.T) { + assert.False(t, list.Contains("")) + }) + t.Run("EmptyList", func(t *testing.T) { + empty := NewFormats("") + assert.False(t, empty.Contains("magicyuv")) + }) + t.Run("NoArgs", func(t *testing.T) { + assert.False(t, list.Contains()) + }) + t.Run("MultipleArgsFirstMatches", func(t *testing.T) { + assert.True(t, list.Contains("magicyuv", "avi")) + }) + t.Run("MultipleArgsSecondMatches", func(t *testing.T) { + assert.True(t, list.Contains("avc1", "magicyuv")) + }) + t.Run("MultipleArgsWithEmpty", func(t *testing.T) { + assert.True(t, list.Contains("", "magicyuv")) + assert.False(t, list.Contains("", "avc1")) + }) + t.Run("MultipleArgsNoMatch", func(t *testing.T) { + assert.False(t, list.Contains("avc1", "hevc", "mp4")) + }) + t.Run("CodecAliasOriginalAndMapped", func(t *testing.T) { + // A list built from the canonical name matches the original FourCC and + // the human-readable alias reported for the same codec. + excl := NewFormats("magy") + assert.True(t, excl.Contains("magy")) // Canonical name. + assert.True(t, excl.Contains("magicyuv")) // Human-readable alias. + assert.True(t, excl.Contains("m8ra")) // FourCC reported by ExifTool. + assert.True(t, excl.Contains("M8RG")) // FourCC, case-insensitive. + assert.False(t, excl.Contains("avc1")) + }) + t.Run("CodecAliasReverse", func(t *testing.T) { + // A list built from an alias still matches the canonical name and other + // aliases for the same codec. + excl := NewFormats("magicyuv") + assert.True(t, excl.Contains("magy")) + assert.True(t, excl.Contains("m8ra")) + }) + t.Run("H264Alias", func(t *testing.T) { + excl := NewFormats("h264") + assert.True(t, excl.Contains("avc1")) + assert.True(t, excl.Contains("avc")) + }) + t.Run("VFWWrapper", func(t *testing.T) { + // Excluding the VFW wrapper matches the Matroska codec ID reported for it. + excl := NewFormats("vfw") + assert.True(t, excl.Contains("V_MS/VFW/FOURCC")) + assert.True(t, excl.Contains("v_ms")) + assert.False(t, excl.Contains("avc1")) + }) +} + +func TestFormats_Allow(t *testing.T) { + list := NewFormats("magicyuv") + + assert.False(t, list.Allow("magicyuv")) + assert.True(t, list.Allow("avc1")) + assert.True(t, list.Allow("")) +} + +func TestFormats_Match(t *testing.T) { + list := NewFormats("magy, mov") + + t.Run("ReturnsCanonicalEntry", func(t *testing.T) { + // The matched entry is reported, not the first argument. + assert.Equal(t, "mov", list.Match("avc1", "mov")) + assert.Equal(t, "magy", list.Match("m8ra", "avi")) + }) + t.Run("SkipsEmptyArgs", func(t *testing.T) { + assert.Equal(t, "magy", list.Match("", "magicyuv")) + }) + t.Run("NoMatch", func(t *testing.T) { + assert.Equal(t, "", list.Match("avc1", "mp4")) + assert.Equal(t, "", list.Match()) + assert.Equal(t, "", list.Match("")) + }) + t.Run("EmptyList", func(t *testing.T) { + assert.Equal(t, "", NewFormats("").Match("magy")) + }) +} + +func TestFormats_Set(t *testing.T) { + t.Run("Empty", func(t *testing.T) { + list := make(Formats) + list.Set("") + assert.Empty(t, list) + }) + t.Run("AddsToExisting", func(t *testing.T) { + list := NewFormats("magicyuv") + list.Set("m8rg, AVI") + assert.Len(t, list, 2) // m8rg collapses into the existing magy entry. + assert.True(t, list.Contains("magicyuv")) + assert.True(t, list.Contains("m8rg")) + assert.True(t, list.Contains("avi")) + }) + t.Run("Duplicate", func(t *testing.T) { + list := NewFormats("magicyuv") + list.Set("MAGICYUV, magicyuv") + assert.Len(t, list, 1) + }) +} + +func TestFormats_Add(t *testing.T) { + t.Run("Single", func(t *testing.T) { + list := make(Formats) + list.Add("MagicYUV") + assert.Len(t, list, 1) + assert.True(t, list.Contains("magicyuv")) + }) + t.Run("Empty", func(t *testing.T) { + list := make(Formats) + list.Add("") + list.Add(" ") + list.Add(".") + assert.Empty(t, list) + }) + t.Run("Idempotent", func(t *testing.T) { + list := make(Formats) + list.Add("avi") + list.Add("avi") + assert.Len(t, list, 1) + }) +} + +func TestFormats_String(t *testing.T) { + t.Run("Empty", func(t *testing.T) { + list := NewFormats("") + assert.Equal(t, "", list.String()) + }) + t.Run("Sorted", func(t *testing.T) { + list := NewFormats("magy, hap, avi") + assert.Equal(t, "avi, hap, magy", list.String()) + }) + t.Run("CanonicalForm", func(t *testing.T) { + // Codec aliases are stored and reported in their canonical form. + list := NewFormats("magicyuv, m8ra") + assert.Equal(t, "magy", list.String()) + }) +} diff --git a/pkg/media/video/probe.go b/pkg/media/video/probe.go index cabfc3e13..1d6640dec 100644 --- a/pkg/media/video/probe.go +++ b/pkg/media/video/probe.go @@ -5,6 +5,7 @@ import ( "io" "math" "os" + "strings" "time" "github.com/abema/go-mp4" @@ -14,6 +15,16 @@ import ( "github.com/photoprism/photoprism/pkg/media" ) +// HeadScanLimit caps how far sample-entry chunk scans read into the file. +// The sample entry sits in the stsd box inside moov; faststart videos place +// moov at the head, and Motion Photos put it just past the JPEG (a few MB +// at most), so 16 MiB comfortably covers both layouts. +const HeadScanLimit = 16 * 1024 * 1024 + +// HeadScanChunks lists every video sample-entry code searched for in a single +// pass over the file head when go-mp4 does not report the codec directly. +var HeadScanChunks = append(append(Chunks{}, HevcChunks...), MagicYuvChunks...) + // ProbeFile returns information for the given filename. func ProbeFile(fileName string) (info Info, err error) { if fileName == "" { @@ -150,11 +161,15 @@ func Probe(file io.ReadSeeker) (info Info, err error) { } } - // If no AVC video was found, search the video data for High Efficiency Video Coding (HEVC) chunks, - // see https://stackoverflow.com/questions/63468587/what-hevc-codec-tag-to-use-with-fmp4-hvc1-or-hev1. + // If no AVC video was found, search the file head for other recognizable sample-entry + // codes (HEVC, see https://stackoverflow.com/questions/63468587, and MagicYUV) in a single + // pass. Each hit is validated as a real visual sample entry so a four-byte code colliding + // with raw payload bytes (e.g. DV streams in a QuickTime container) is not misread as a + // codec. The Codecs lookup normalizes each hit, e.g. HVC1/HVC2/HVC3/DVH1 → CodecHvc1 and + // M8RG/M8Y2/… → CodecMagicYUV; the lookup is lowercased because MagicYUV codes are uppercase. if info.VideoCodec == "" { - if fileOffset, fileErr := ChunkHVC1.DataOffset(file, 0, -1); fileOffset > 0 && fileErr == nil { - info.VideoCodec = CodecHvc1 + if pos, hit, fileErr := HeadScanChunks.SampleEntryOffset(file, HeadScanLimit); pos > 0 && fileErr == nil { + info.VideoCodec = Codecs[strings.ToLower(hit.String())] } } diff --git a/pkg/media/video/probe_hevc.go b/pkg/media/video/probe_hevc.go new file mode 100644 index 000000000..902091e38 --- /dev/null +++ b/pkg/media/video/probe_hevc.go @@ -0,0 +1,39 @@ +package video + +import ( + "io" + "os" + + "github.com/photoprism/photoprism/pkg/fs" +) + +// IsHEVC reports whether the reader contains an HEVC video stream by scanning +// the head of the file (up to HeadScanLimit) for a valid HEVC sample entry in +// a single pass. Candidates are validated as real visual sample entries so a +// four-byte code colliding with random payload bytes is not mistaken for HEVC. +// Returns false on read errors or empty input. +func IsHEVC(file io.ReadSeeker) bool { + if file == nil { + return false + } + + pos, _, err := HevcChunks.SampleEntryOffset(file, HeadScanLimit) + + return err == nil && pos > 0 +} + +// IsHEVCFile reports whether the named file contains an HEVC video stream. +// Returns false if the file is missing, unreadable, or contains no HEVC chunk. +func IsHEVCFile(fileName string) bool { + if fileName == "" || !fs.FileExists(fileName) { + return false + } + + file, err := os.Open(fileName) //nolint:gosec // fileName validated by caller + if err != nil { + return false + } + defer func() { _ = file.Close() }() + + return IsHEVC(file) +} diff --git a/pkg/media/video/probe_hevc_test.go b/pkg/media/video/probe_hevc_test.go new file mode 100644 index 000000000..b81597656 --- /dev/null +++ b/pkg/media/video/probe_hevc_test.go @@ -0,0 +1,43 @@ +package video + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestIsHEVCFile(t *testing.T) { + t.Run("Hvc1Mov", func(t *testing.T) { + assert.True(t, IsHEVCFile("testdata/quicktime-hvc1.mov")) + }) + t.Run("Hvc1Heif", func(t *testing.T) { + assert.True(t, IsHEVCFile("testdata/motion-photo.heif")) + }) + t.Run("Avc1Mp4", func(t *testing.T) { + assert.False(t, IsHEVCFile("testdata/mp4v-avc1.mp4")) + }) + t.Run("Mp42Hvc1Mp4_AvcOnly", func(t *testing.T) { + // Despite the filename, this sample carries an avc1 track only. + assert.False(t, IsHEVCFile("testdata/mp42-hvc1.mp4")) + }) + t.Run("NotFound", func(t *testing.T) { + assert.False(t, IsHEVCFile("testdata/does-not-exist.mp4")) + }) + t.Run("Empty", func(t *testing.T) { + assert.False(t, IsHEVCFile("")) + }) +} + +func TestIsHEVC(t *testing.T) { + t.Run("Hvc1Mov", func(t *testing.T) { + f := openTestFile(t, "testdata/quicktime-hvc1.mov") + assert.True(t, IsHEVC(f)) + }) + t.Run("Avc1Mp4", func(t *testing.T) { + f := openTestFile(t, "testdata/mp4v-avc1.mp4") + assert.False(t, IsHEVC(f)) + }) + t.Run("Nil", func(t *testing.T) { + assert.False(t, IsHEVC(nil)) + }) +} diff --git a/pkg/media/video/probe_test.go b/pkg/media/video/probe_test.go index bcb6f4153..cff51054e 100644 --- a/pkg/media/video/probe_test.go +++ b/pkg/media/video/probe_test.go @@ -105,6 +105,16 @@ func TestProbeFile(t *testing.T) { assert.Equal(t, false, info.FastStart) assert.Equal(t, true, info.Compatible) }) + t.Run("MagicYuvMov", func(t *testing.T) { + fileName := "testdata/magicyuv.mov" + info, err := ProbeFile(fileName) + require.NoError(t, err) + require.NotNil(t, info) + + // The MagicYUV sample entry is recognized by the head scan. + assert.Equal(t, fs.VideoMov, info.FileType) + assert.Equal(t, CodecMagicYUV, info.VideoCodec) + }) t.Run("QuicktimeJpegMov", func(t *testing.T) { fileName := "testdata/quicktime-jpeg.mov" info, err := ProbeFile(fileName) diff --git a/pkg/media/video/testdata/magicyuv.mov b/pkg/media/video/testdata/magicyuv.mov new file mode 100644 index 000000000..94047bb2e Binary files /dev/null and b/pkg/media/video/testdata/magicyuv.mov differ diff --git a/pkg/media/video/video.go b/pkg/media/video/video.go index 690e13030..98960113a 100644 --- a/pkg/media/video/video.go +++ b/pkg/media/video/video.go @@ -1,7 +1,7 @@ /* Package video provides video file related types and abstractions. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/react/react.go b/pkg/react/react.go index 41ba61b26..3ed143fb4 100644 --- a/pkg/react/react.go +++ b/pkg/react/react.go @@ -1,7 +1,7 @@ /* Package react facilitates the processing of user feedback expressed by an emoji. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/rnd/rnd.go b/pkg/rnd/rnd.go index b8c1558b3..2d3c0663e 100644 --- a/pkg/rnd/rnd.go +++ b/pkg/rnd/rnd.go @@ -1,7 +1,7 @@ /* Package rnd provides random token generation and validation. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/time/tz/zone.go b/pkg/time/tz/zone.go index 8284e24c0..343bf00f7 100644 --- a/pkg/time/tz/zone.go +++ b/pkg/time/tz/zone.go @@ -1,7 +1,7 @@ /* Package tz provides time zone constants and functions. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/time/unix/unix.go b/pkg/time/unix/unix.go index ff1c9d791..b653a356d 100644 --- a/pkg/time/unix/unix.go +++ b/pkg/time/unix/unix.go @@ -1,7 +1,7 @@ /* Package unix provides constants and functions for Unix timestamps. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/txt/clip/bytes.go b/pkg/txt/clip/bytes.go new file mode 100644 index 000000000..0bf9e3a15 --- /dev/null +++ b/pkg/txt/clip/bytes.go @@ -0,0 +1,34 @@ +package clip + +import "strings" + +// Bytes limits a string to at most maxBytes bytes without splitting a UTF-8 +// rune, and removes all leading and trailing spaces. It is intended for columns +// whose limit is measured in bytes rather than characters (e.g. VARBINARY), so a +// multi-byte value cannot overflow the column and trigger a write error. +func Bytes(s string, maxBytes int) string { + s = strings.TrimSpace(s) + + if s == "" || maxBytes <= 0 { + return "" + } + + // Already within budget (also the only path that can return a string ending + // at len(s) rather than at an interior rune boundary). + if len(s) <= maxBytes { + return s + } + + // Keep the longest prefix that ends on a rune boundary at or below maxBytes. + // Ranging over a string yields the byte index at the start of each rune, so + // cut always lands on a complete-rune boundary. + cut := 0 + for i := range s { + if i > maxBytes { + break + } + cut = i + } + + return strings.TrimSpace(s[:cut]) +} diff --git a/pkg/txt/clip/bytes_test.go b/pkg/txt/clip/bytes_test.go new file mode 100644 index 000000000..8cc3f9fa0 --- /dev/null +++ b/pkg/txt/clip/bytes_test.go @@ -0,0 +1,58 @@ +package clip + +import ( + "testing" + "unicode/utf8" + + "github.com/stretchr/testify/assert" +) + +func TestBytes(t *testing.T) { + t.Run("ASCIIShortEnough", func(t *testing.T) { + result := Bytes("Foo", 16) + assert.Equal(t, "Foo", result) + }) + t.Run("ASCIITooLong", func(t *testing.T) { + result := Bytes("abcdefghij", 4) + assert.Equal(t, "abcd", result) + assert.Len(t, result, 4) + }) + t.Run("TrimSpace", func(t *testing.T) { + assert.Equal(t, "abc", Bytes(" abc ", 16)) + }) + t.Run("DoesNotSplitRune", func(t *testing.T) { + // "äöü" is three 2-byte runes (6 bytes). A 3-byte budget must keep + // only the first whole rune (2 bytes), never a partial one. + result := Bytes("äöü", 3) + assert.Equal(t, "ä", result) + assert.Len(t, result, 2) + assert.True(t, utf8.ValidString(result)) + }) + t.Run("ExactRuneBoundary", func(t *testing.T) { + result := Bytes("äöü", 4) + assert.Equal(t, "äö", result) + assert.Len(t, result, 4) + assert.True(t, utf8.ValidString(result)) + }) + t.Run("EmojiNeverPartial", func(t *testing.T) { + // Each emoji is 4 bytes; a 1024-byte budget keeps 256 whole emoji. + s := "" + for i := 0; i < 400; i++ { + s += "😀" + } + result := Bytes(s, 1024) + assert.LessOrEqual(t, len(result), 1024) + assert.True(t, utf8.ValidString(result)) + assert.Equal(t, 256, utf8.RuneCountInString(result)) + }) + t.Run("SingleRuneLargerThanBudget", func(t *testing.T) { + assert.Equal(t, "", Bytes("😀", 3)) + }) + t.Run("Empty", func(t *testing.T) { + assert.Equal(t, "", Bytes("", 16)) + }) + t.Run("NonPositiveBudget", func(t *testing.T) { + assert.Equal(t, "", Bytes("abc", 0)) + assert.Equal(t, "", Bytes("abc", -1)) + }) +} diff --git a/pkg/txt/clip/clip.go b/pkg/txt/clip/clip.go index 827bda765..172a54360 100644 --- a/pkg/txt/clip/clip.go +++ b/pkg/txt/clip/clip.go @@ -1,7 +1,7 @@ /* Package clip provides functions for limiting the length of character strings. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/txt/list.go b/pkg/txt/list.go index e79ec4f4a..6fce1ad55 100644 --- a/pkg/txt/list.go +++ b/pkg/txt/list.go @@ -1,6 +1,6 @@ package txt -// JoinAnd formats a slice of strings using commas and a localized "and" before the final element. +// JoinAnd formats a slice of strings as a list with commas and "and" before the final element. // Examples: // // []string{} => "" @@ -8,6 +8,23 @@ package txt // []string{"a","b"} => "a and b" // []string{"a","b","c"} => "a, b, and c" func JoinAnd(values []string) string { + return joinConjunction(values, "and") +} + +// JoinOr formats a slice of strings using commas and "or" before the final element. +// Examples: +// +// []string{} => "" +// []string{"a"} => "a" +// []string{"a","b"} => "a or b" +// []string{"a","b","c"} => "a, b, or c" +func JoinOr(values []string) string { + return joinConjunction(values, "or") +} + +// joinConjunction joins values into a grammatical list, placing conj before the +// final element and an Oxford comma after the penultimate one for three or more. +func joinConjunction(values []string, conj string) string { length := len(values) switch length { @@ -16,7 +33,7 @@ func JoinAnd(values []string) string { case 1: return values[0] case 2: - return values[0] + " and " + values[1] + return values[0] + " " + conj + " " + values[1] } // length >= 3 @@ -26,7 +43,7 @@ func JoinAnd(values []string) string { case 0: result = values[i] case length - 1: - result += ", and " + values[i] + result += ", " + conj + " " + values[i] default: result += ", " + values[i] } diff --git a/pkg/txt/list_test.go b/pkg/txt/list_test.go index 6bb1747c5..258098eb5 100644 --- a/pkg/txt/list_test.go +++ b/pkg/txt/list_test.go @@ -21,3 +21,23 @@ func TestJoinAnd(t *testing.T) { } } } + +func TestJoinOr(t *testing.T) { + tests := []struct { + name string + input []string + expect string + }{ + {"empty", []string{}, ""}, + {"single", []string{"admin"}, "admin"}, + {"two", []string{"admin", "guest"}, "admin or guest"}, + {"three", []string{"admin", "guest", "user"}, "admin, guest, or user"}, + {"many", []string{"admin", "manager", "user", "viewer"}, "admin, manager, user, or viewer"}, + } + + for _, tc := range tests { + if got := JoinOr(tc.input); got != tc.expect { + t.Fatalf("%s: expected %q, got %q", tc.name, tc.expect, got) + } + } +} diff --git a/pkg/txt/report/markdown.go b/pkg/txt/report/markdown.go index 137394687..1a1351dfe 100644 --- a/pkg/txt/report/markdown.go +++ b/pkg/txt/report/markdown.go @@ -9,19 +9,40 @@ import ( "github.com/olekukonko/tablewriter/tw" ) +// escapeMarkdownCell escapes Markdown table-significant runes (`|`, the +// horizontal-rule sequence `* * *`) and angle brackets in a single cell. +// Angle brackets are backslash-escaped so a value that happens to look +// like an HTML tag renders as plain text in both the Markdown source +// and any HTML produced from it (e.g. on docs.photoprism.app). CommonMark +// guarantees that `\<` renders as the literal `<` (entity `<`) in +// HTML, so the escaped form is safe in both pipelines. +func escapeMarkdownCell(cell string) string { + if strings.ContainsRune(cell, '|') { + cell = strings.ReplaceAll(cell, "|", "\\|") + } + if strings.Contains(cell, "* * *") { + cell = strings.ReplaceAll(cell, "* * *", "\\* \\* \\*") + } + if strings.ContainsRune(cell, '<') { + cell = strings.ReplaceAll(cell, "<", "\\<") + } + if strings.ContainsRune(cell, '>') { + cell = strings.ReplaceAll(cell, ">", "\\>") + } + return cell +} + // MarkdownTable returns a text-formatted table with caption, optionally as valid Markdown, // so the output can be pasted into the docs. func MarkdownTable(rows [][]string, cols []string, opt Options) string { // Escape Markdown. if opt.Valid { + for i := range cols { + cols[i] = escapeMarkdownCell(cols[i]) + } for i := range rows { for j := range rows[i] { - if strings.ContainsRune(rows[i][j], '|') { - rows[i][j] = strings.ReplaceAll(rows[i][j], "|", "\\|") - } - if strings.ContainsRune(rows[i][j], '*') { - rows[i][j] = strings.ReplaceAll(rows[i][j], "* * *", "\\* \\* \\*") - } + rows[i][j] = escapeMarkdownCell(rows[i][j]) } } } diff --git a/pkg/txt/report/render_test.go b/pkg/txt/report/render_test.go index b029ba8f2..7398b166f 100644 --- a/pkg/txt/report/render_test.go +++ b/pkg/txt/report/render_test.go @@ -58,3 +58,27 @@ func TestTable(t *testing.T) { } }) } + +// TestMarkdownTableEscapesAngleBrackets verifies that the Markdown +// renderer backslash-escapes '<' and '>' in row and header cells so a +// flag default, env-var name, or description that happens to contain +// HTML-looking text cannot be interpreted as raw inline HTML by any +// CommonMark renderer downstream (e.g. docs.photoprism.app). +func TestMarkdownTableEscapesAngleBrackets(t *testing.T) { + cols := []string{"Default", "Description <Notes>"} + rows := [][]string{ + {"<auto>", "fallback <script>alert(1)</script>"}, + {"plain", "no markup"}, + } + + result, err := RenderFormat(rows, cols, Markdown) + if err != nil { + t.Fatal(err) + } + + assert.Contains(t, result, "\\<auto\\>", "row angle brackets must be escaped") + assert.Contains(t, result, "\\<script\\>alert(1)\\</script\\>", "inline-HTML payloads must be escaped") + assert.Contains(t, result, "Description \\<Notes\\>", "header angle brackets must be escaped") + assert.NotContains(t, result, "<auto>", "raw '<auto>' must not survive in the Markdown output") + assert.NotContains(t, result, "<script>", "raw '<script>' must not survive in the Markdown output") +} diff --git a/pkg/txt/report/report.go b/pkg/txt/report/report.go index 55f572d36..7433ce259 100644 --- a/pkg/txt/report/report.go +++ b/pkg/txt/report/report.go @@ -1,7 +1,7 @@ /* Package report provides rendering of report results, for example as Markdown. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/txt/slug.go b/pkg/txt/slug.go index 6aefa2225..c1229de61 100644 --- a/pkg/txt/slug.go +++ b/pkg/txt/slug.go @@ -1,8 +1,12 @@ package txt import ( + "crypto/sha256" "encoding/base32" + "fmt" "strings" + "unicode" + "unicode/utf8" "github.com/gosimple/slug" ) @@ -32,11 +36,91 @@ func Slug(s string) string { if result == "" { result = string(SlugEncoded) + SlugEncoding.EncodeToString([]byte(s)) + } else if tokens := slugRuneTokens(s); tokens != "" { + result += "-" + tokens + result = clipSlugWithHash(result, s) } return Clip(result, ClipSlug) } +// SlugUnique converts a string to a slug like Slug, but always uses a stable +// hash suffix instead of plain truncation when the result would exceed +// ClipSlug runes. Use it where two distinct long inputs sharing a common +// prefix would otherwise collide on the truncated slug (e.g. deeply nested +// folder album paths with identical ancestor segments). +func SlugUnique(s string) string { + s = strings.TrimSpace(s) + + if s == "" || s == "-" { + return s + } + + if s[0] == SlugEncoded && ContainsAlnumLower(s[1:]) { + return Clip(s, ClipSlug) + } + + result := slug.Make(s) + + if result == "" { + result = string(SlugEncoded) + SlugEncoding.EncodeToString([]byte(s)) + return Clip(result, ClipSlug) + } + + if tokens := slugRuneTokens(s); tokens != "" { + result += "-" + tokens + } + + return clipSlugWithHash(result, s) +} + +// slugRuneTokens returns stable rune tokens for non-ASCII symbols that slug.Make would drop. +func slugRuneTokens(s string) string { + tokens := make([]string, 0, 4) + + for _, r := range s { + if r <= unicode.MaxASCII || slug.Make(string(r)) != "" { + continue + } + + switch { + case unicode.IsSymbol(r): + case r == '\u200d': + case r >= '\ufe00' && r <= '\ufe0f': + case r >= '\U0001f3fb' && r <= '\U0001f3ff': + default: + continue + } + + tokens = append(tokens, fmt.Sprintf("u%x", r)) + } + + return strings.Join(tokens, "-") +} + +// clipSlugWithHash clips long slugs and appends a deterministic hash suffix to avoid collisions. +func clipSlugWithHash(result, source string) string { + if utf8.RuneCountInString(result) <= ClipSlug { + return result + } + + hash := sha256.Sum256([]byte(source)) + suffix := fmt.Sprintf("%x", hash[:4]) + prefixLen := ClipSlug - len(suffix) - 1 + + if prefixLen <= 0 { + return Clip(result, ClipSlug) + } + + prefix := strings.TrimRight(Clip(result, prefixLen), "-") + + if prefix == "" { + return Clip(result, ClipSlug) + } + + return prefix + "-" + suffix +} + // SlugToTitle converts a slug back to a title func SlugToTitle(s string) string { if s == "" { diff --git a/pkg/txt/slug_test.go b/pkg/txt/slug_test.go index 3f91c6155..b394a2c73 100644 --- a/pkg/txt/slug_test.go +++ b/pkg/txt/slug_test.go @@ -1,7 +1,9 @@ package txt import ( + "strings" "testing" + "unicode/utf8" "github.com/stretchr/testify/assert" ) @@ -24,7 +26,9 @@ func TestSlug(t *testing.T) { assert.Equal(t, "_5cpzfea", Slug("💐")) assert.Equal(t, "_5cpzfea", Slug(" 💐 ")) assert.Equal(t, "_5cpzfdxqt5jja", Slug("💎💐")) - assert.Equal(t, "photoprism", Slug("PhotoPrism 💎")) + assert.Equal(t, "photoprism-u1f48e", Slug("PhotoPrism 💎")) + assert.Equal(t, "ins-u1f377", Slug("ins/🍷")) + assert.Equal(t, "work-u1f618", Slug("Work 😘")) assert.Equal(t, "_3kmib24yr3", Slug("_3kmib24yr3")) assert.Equal(t, "-", Slug("-")) assert.Equal(t, "_", Slug("_")) @@ -32,6 +36,54 @@ func TestSlug(t *testing.T) { assert.Equal(t, "_5cpzfea", Slug("_5cpzfea")) assert.Equal(t, "_5cpzfdxqt5jja", Slug("_5cpzfdxqt5jja")) }) + t.Run("LongInputUsesHashSuffix", func(t *testing.T) { + base := strings.Repeat("Very Long Prefix 💎 ", 8) + slugA := Slug(base + "Alpha") + slugB := Slug(base + "Beta") + + assert.NotEqual(t, slugA, slugB) + assert.Equal(t, ClipSlug, utf8.RuneCountInString(slugA)) + assert.Equal(t, ClipSlug, utf8.RuneCountInString(slugB)) + }) + t.Run("LongAsciiInputCollides", func(t *testing.T) { + base := "pictures/Ferie 2008 Mellomeuropa/Galleri-konvertert/bilder/ferie 2008 mellomeuropa/galleri/" + slugA := Slug(base + "01 Praha, Dresden, Wroclaw") + slugB := Slug(base + "02 Wroclaw, Auschwitz") + + assert.Equal(t, slugA, slugB) + assert.Equal(t, ClipSlug, utf8.RuneCountInString(slugA)) + }) +} + +func TestSlugUnique(t *testing.T) { + t.Run("Empty", func(t *testing.T) { + assert.Equal(t, "", SlugUnique("")) + }) + t.Run("ShortMatchesSlug", func(t *testing.T) { + assert.Equal(t, Slug("William Henry Gates III"), SlugUnique("William Henry Gates III")) + assert.Equal(t, Slug("PhotoPrism 💎"), SlugUnique("PhotoPrism 💎")) + }) + t.Run("EmojiMatchesSlug", func(t *testing.T) { + assert.Equal(t, Slug("ins/🍷"), SlugUnique("ins/🍷")) + }) + t.Run("LongAsciiInputUsesHashSuffix", func(t *testing.T) { + base := "pictures/Ferie 2008 Mellomeuropa/Galleri-konvertert/bilder/ferie 2008 mellomeuropa/galleri/" + slugA := SlugUnique(base + "01 Praha, Dresden, Wroclaw") + slugB := SlugUnique(base + "02 Wroclaw, Auschwitz") + + assert.NotEqual(t, slugA, slugB) + assert.Equal(t, ClipSlug, utf8.RuneCountInString(slugA)) + assert.Equal(t, ClipSlug, utf8.RuneCountInString(slugB)) + }) + t.Run("LongUnicodeInputUsesHashSuffix", func(t *testing.T) { + base := strings.Repeat("Very Long Prefix 💎 ", 8) + slugA := SlugUnique(base + "Alpha") + slugB := SlugUnique(base + "Beta") + + assert.NotEqual(t, slugA, slugB) + assert.Equal(t, ClipSlug, utf8.RuneCountInString(slugA)) + assert.Equal(t, ClipSlug, utf8.RuneCountInString(slugB)) + }) } func TestSlugToTitle(t *testing.T) { diff --git a/pkg/txt/txt.go b/pkg/txt/txt.go index c612cde15..f6fe79dda 100644 --- a/pkg/txt/txt.go +++ b/pkg/txt/txt.go @@ -1,7 +1,7 @@ /* Package txt provides text and linguistics related functionality. -Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. This program is free software: you can redistribute it and/or modify it under Version 3 of the GNU Affero General Public License (the "AGPL"): @@ -14,7 +14,7 @@ Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved. The AGPL is supplemented by our Trademark and Brand Guidelines, which describe how our Brand Assets may be used: - <https://www.photoprism.app/trademark> + <https://www.photoprism.app/trademark/> Feel free to send an email to hello@photoprism.app if you have questions, want to support our work, or just want to say hello. diff --git a/pkg/vector/alg/README.md b/pkg/vector/alg/README.md index 581486349..9ae8bfdf7 100644 --- a/pkg/vector/alg/README.md +++ b/pkg/vector/alg/README.md @@ -4,7 +4,6 @@ Implements the following clustering algorithms: - k-means++ - DBSCAN -- OPTICS It was forked from the following repositories, which don't seem to be maintained anymore: @@ -54,7 +53,7 @@ for index, number := range c.Guesses() { } ``` -Algorithms currently supported are KMeans++, DBSCAN and OPTICS. +Algorithms currently supported are KMeans++ and DBSCAN. Algorithms which support online learning can be trained this way using Online() function, which relies on channel communication to coordinate the process: diff --git a/pkg/vector/alg/common.go b/pkg/vector/alg/common.go index 5f7562696..ace126199 100644 --- a/pkg/vector/alg/common.go +++ b/pkg/vector/alg/common.go @@ -8,7 +8,7 @@ import ( "sync" ) -// struct denoting start and end indices of database portion to be scanned for nearest neighbors by workers in DBSCAN and OPTICS +// struct denoting start and end indices of database portion to be scanned for nearest neighbors by workers in DBSCAN type rangeJob struct { a, b int } diff --git a/pkg/vector/alg/dbscan.go b/pkg/vector/alg/dbscan.go index 3fe1d6d57..d7323bba8 100644 --- a/pkg/vector/alg/dbscan.go +++ b/pkg/vector/alg/dbscan.go @@ -3,6 +3,7 @@ package alg import ( "sync" + "time" ) type dbscanClusterer struct { @@ -10,6 +11,9 @@ type dbscanClusterer struct { eps float64 distance DistFunc + now func() time.Time + logAfter time.Duration + logf func(done, total int) // slices holding the cluster mapping and sizes. Access is synchronized to avoid read during computation. mu sync.RWMutex @@ -37,11 +41,23 @@ type dbscanClusterer struct { // dataset d [][]float64 + + loggedAt time.Time } // DBSCAN implements density-based clustering with concurrent nearest neighbor computation. // The number of goroutines is controlled via workers (0 picks a default). func DBSCAN(minpts int, eps float64, workers int, distance DistFunc) (HardClusterer, error) { + return newDBSCANClusterer(minpts, eps, workers, distance, 0, nil) +} + +// DBSCANWithProgress implements DBSCAN with optional time-based progress reporting. +func DBSCANWithProgress(minpts int, eps float64, workers int, distance DistFunc, interval time.Duration, progressf func(done, total int)) (HardClusterer, error) { + return newDBSCANClusterer(minpts, eps, workers, distance, interval, progressf) +} + +// newDBSCANClusterer validates the options and creates a DBSCAN clusterer instance. +func newDBSCANClusterer(minpts int, eps float64, workers int, distance DistFunc, interval time.Duration, progressf func(done, total int)) (HardClusterer, error) { if minpts < 1 { return nil, errZeroMinpts } @@ -68,6 +84,9 @@ func DBSCAN(minpts int, eps float64, workers int, distance DistFunc) (HardCluste workers: workers, eps: eps, distance: d, + now: time.Now, + logAfter: interval, + logf: progressf, }, nil } @@ -88,7 +107,7 @@ func (c *dbscanClusterer) Learn(data [][]float64) error { c.l = len(data) c.s = c.numWorkers() - c.f = c.l / c.s + c.f = partitionSize(c.l, c.s) c.d = data @@ -96,6 +115,7 @@ func (c *dbscanClusterer) Learn(data [][]float64) error { c.a = make([]int, c.l) c.b = make([]int, 0) + c.loggedAt = time.Time{} c.startNearestWorkers() @@ -155,6 +175,8 @@ func (c *dbscanClusterer) run() { ) for i := 0; i < c.l; i++ { + c.logProgress(i) + if c.v[i] { continue } @@ -195,6 +217,29 @@ func (c *dbscanClusterer) run() { } } +// logProgress emits an optional progress update when the reporting interval has elapsed. +func (c *dbscanClusterer) logProgress(done int) { + if c.logf == nil || c.logAfter <= 0 { + return + } + + now := c.now + if now == nil { + now = time.Now + } + + current := now() + if c.loggedAt.IsZero() { + c.loggedAt = current + return + } + + if current.Sub(c.loggedAt) >= c.logAfter { + c.logf(done, c.l) + c.loggedAt = current + } +} + /* Divide work among c.s workers, where c.s is determined * by the size of the data. This is based on an assumption that neighbor points of p * are located in relatively small subsection of the input data, so the dataset can be scanned @@ -260,6 +305,19 @@ func (c *dbscanClusterer) nearestWorker() { } } +// partitionSize returns the per-worker scan range size, floored at 1 so the +// nearest() dispatch loop (which advances the start index by this value) always +// makes progress and terminates, even if the worker count exceeds the number of +// data points. The size-based numWorkers buckets keep points >= workers today, +// so the floor is a defensive guard against future tuning of those buckets. +func partitionSize(points, workers int) int { + if workers < 1 { + workers = 1 + } + + return max(1, points/workers) +} + func (c *dbscanClusterer) numWorkers() int { var b int diff --git a/pkg/vector/alg/dbscan_test.go b/pkg/vector/alg/dbscan_test.go index f40d1cd79..dfb9c3723 100644 --- a/pkg/vector/alg/dbscan_test.go +++ b/pkg/vector/alg/dbscan_test.go @@ -3,6 +3,7 @@ package alg import ( "reflect" "testing" + "time" ) func TestDBSCANCluster(t *testing.T) { @@ -70,3 +71,86 @@ func TestDBSCANCluster(t *testing.T) { } } } + +func TestPartitionSize(t *testing.T) { + tests := []struct { + Points int + Workers int + Expected int + }{ + {Points: 1000, Workers: 10, Expected: 100}, + {Points: 10, Workers: 2, Expected: 5}, + {Points: 5, Workers: 1, Expected: 5}, + {Points: 3, Workers: 64, Expected: 1}, + {Points: 1, Workers: 1, Expected: 1}, + {Points: 0, Workers: 1, Expected: 1}, + {Points: 4, Workers: 0, Expected: 4}, + {Points: 4, Workers: -3, Expected: 4}, + } + for _, test := range tests { + if got := partitionSize(test.Points, test.Workers); got != test.Expected { + t.Errorf("partitionSize(%d, %d) = %d, want %d", test.Points, test.Workers, got, test.Expected) + } + } +} + +func TestDBSCANMoreWorkersThanPoints(t *testing.T) { + // Requesting far more workers than data points must still terminate and + // cluster correctly; the partition size is floored at 1. + c, err := DBSCAN(1, 1, 64, EuclideanDist) + if err != nil { + t.Fatalf("unexpected constructor error: %s", err) + } + + points := [][]float64{{1}, {1.5}, {5}} + + if err = c.Learn(points); err != nil { + t.Fatalf("unexpected learn error: %s", err) + } + + if expected := []int{1, 1, 2}; !reflect.DeepEqual(c.Guesses(), expected) { + t.Errorf("guesses do not match: %d vs %d", c.Guesses(), expected) + } +} + +func TestDBSCANWithProgress(t *testing.T) { + progress := make([][2]int, 0) + + clusterer, err := DBSCANWithProgress(1, 1, 0, EuclideanDist, time.Second, func(done, total int) { + progress = append(progress, [2]int{done, total}) + }) + if err != nil { + t.Fatalf("unexpected constructor error: %s", err) + } + + c, ok := clusterer.(*dbscanClusterer) + if !ok { + t.Fatalf("unexpected clusterer type %T", clusterer) + } + + current := time.Unix(0, 0) + c.now = func() time.Time { + value := current + current = current.Add(600 * time.Millisecond) + return value + } + + points := [][]float64{{1}, {1}, {1}, {1}, {1}} + + if err = c.Learn(points); err != nil { + t.Fatalf("unexpected learn error: %s", err) + } + + if len(progress) == 0 { + t.Fatal("expected at least one progress update") + } + + for _, entry := range progress { + if entry[0] <= 0 { + t.Fatalf("expected a positive processed count, got %d", entry[0]) + } + if entry[1] != len(points) { + t.Fatalf("expected total %d, got %d", len(points), entry[1]) + } + } +} diff --git a/pkg/vector/alg/errors.go b/pkg/vector/alg/errors.go index f6c7f2e60..4c36c9aee 100644 --- a/pkg/vector/alg/errors.go +++ b/pkg/vector/alg/errors.go @@ -9,6 +9,5 @@ var ( errZeroEpsilon = errors.New("epsilon cannot be 0") errZeroMinpts = errors.New("minpts cannot be 0") errZeroWorkers = errors.New("number of workers cannot be less than 0") - errZeroXi = errors.New("xi cannot be 0") errInvalidRange = errors.New("range is invalid") ) diff --git a/pkg/vector/alg/optics.go b/pkg/vector/alg/optics.go deleted file mode 100644 index 345991eac..000000000 --- a/pkg/vector/alg/optics.go +++ /dev/null @@ -1,560 +0,0 @@ -//nolint:revive,staticcheck,gocritic,gosec // legacy optics implementation kept as-is for correctness -package alg - -import ( - "math" - "sync" -) - -type steepDownArea struct { - start, end int - mib float64 -} - -type clusterJob struct { - a, b, n int -} - -type opticsClusterer struct { - minpts, workers int - eps, xi, x float64 - - distance DistFunc - - // slices holding the cluster mapping and sizes. Access is synchronized to avoid read during computation. - mu sync.RWMutex - a, b []int - - // variables used for concurrent computation of nearest neighbors and producing final mapping - l, s, o, f, g int - j chan *rangeJob - c chan *clusterJob - m *sync.Mutex - w *sync.WaitGroup - r *[]int - p []float64 - - // visited points - v []bool - - // reachability distances - re []*pItem - - // ordered list of points wrt. reachability distance - so []int - - // dataset - d [][]float64 -} - -// OPTICS implements clustering with concurrent nearest neighbor computation. The number of goroutines acting concurrently -// is controlled via workers argument. Passing 0 will result in this number being chosen arbitrarily. -func OPTICS(minpts int, eps, xi float64, workers int, distance DistFunc) (HardClusterer, error) { - if minpts < 1 { - return nil, errZeroMinpts - } - - if workers < 0 { - return nil, errZeroWorkers - } - - if eps <= 0 { - return nil, errZeroEpsilon - } - - if xi <= 0 { - return nil, errZeroXi - } - - var d DistFunc - { - if distance != nil { - d = distance - } else { - d = EuclideanDist - } - } - - return &opticsClusterer{ - minpts: minpts, - workers: workers, - eps: eps, - xi: xi, - x: 1 - xi, - distance: d, - }, nil -} - -func (c *opticsClusterer) IsOnline() bool { - return false -} - -func (c *opticsClusterer) WithOnline(o Online) HardClusterer { - return c -} - -func (c *opticsClusterer) Learn(data [][]float64) error { - if len(data) == 0 { - return errEmptySet - } - - c.mu.Lock() - - c.l = len(data) - c.s = c.numWorkers() - c.o = c.s - 1 - c.f = c.l / c.s - - c.d = data - - c.v = make([]bool, c.l) - c.re = make([]*pItem, c.l) - c.so = make([]int, 0, c.l) - c.a = make([]int, c.l) - c.b = make([]int, 0) - - c.startNearestWorkers() - - c.run() - - c.endNearestWorkers() - - c.v = nil - c.p = nil - c.r = nil - - c.startClusterWorkers() - - c.extract() - - c.endClusterWorkers() - - c.re = nil - c.so = nil - - c.mu.Unlock() - - return nil -} - -func (c *opticsClusterer) Sizes() []int { - c.mu.RLock() - defer c.mu.RUnlock() - - return c.b -} - -func (c *opticsClusterer) Guesses() []int { - c.mu.RLock() - defer c.mu.RUnlock() - - return c.a -} - -func (c *opticsClusterer) Predict(p []float64) int { - var ( - l int - d float64 - m float64 = c.distance(p, c.d[0]) - ) - - for i := 1; i < len(c.d); i++ { - if d = c.distance(p, c.d[i]); d < m { - m = d - l = i - } - } - - return c.a[l] -} - -func (c *opticsClusterer) Online(observations chan []float64, done chan struct{}) chan *HCEvent { - return nil -} - -func (c *opticsClusterer) run() { - var ( - l int - d float64 - ns, nss []int = make([]int, 0), make([]int, 0) - q priorityQueue - p *pItem - ) - - for i := 0; i < c.l; i++ { - if c.v[i] { - continue - } - - c.nearest(i, &l, &ns) - - c.v[i] = true - - c.so = append(c.so, i) - - if d = c.coreDist(i, l, ns); d != 0 { - q = newPriorityQueue(l) - - c.update(i, d, l, ns, &q) - - for q.NotEmpty() { - p = q.Pop().(*pItem) - - c.nearest(p.v, &l, &nss) - - c.v[p.v] = true - - c.so = append(c.so, p.v) - - if d = c.coreDist(p.v, l, nss); d != 0 { - c.update(p.v, d, l, nss, &q) - } - } - } - } -} - -func (c *opticsClusterer) coreDist(p int, l int, r []int) float64 { - if l < c.minpts { - return 0 - } - - var d, m float64 = 0, c.distance(c.d[p], c.d[r[0]]) - - for i := 1; i < l; i++ { - if d = c.distance(c.d[p], c.d[r[i]]); d > m { - m = d - } - } - - return m -} - -func (c *opticsClusterer) update(p int, d float64, l int, r []int, q *priorityQueue) { - for i := range l { - if !c.v[r[i]] { - m := math.Max(d, c.distance(c.d[p], c.d[r[i]])) - - if c.re[r[i]] == nil { - item := &pItem{ - v: r[i], - p: m, - } - - c.re[r[i]] = item - - q.Push(item) - } else if m < c.re[r[i]].p { - q.Update(c.re[r[i]], c.re[r[i]].v, m) - } - } - } -} - -func (c *opticsClusterer) extract() { - var ( - i, k, e, ue, cs, ce, s, p int = 0, 1, 0, 0, 0, 0, 0, 0 - mib, d float64 - areas []*steepDownArea = make([]*steepDownArea, 0) - clusters map[int]bool = make(map[int]bool) - ) - - // first and last points are not assigned the reachability distance, so exclude them from calculations - c.so = c.so[1 : len(c.so)-2] - c.g = len(c.so) - 2 - - for i < len(c.so)-1 { - mib = math.Max(mib, c.re[c.so[i]].p) - - switch { - case c.isSteepDown(i, &e): - as := areas[:0] - for j := 0; j < len(areas); j++ { - if c.re[c.so[areas[j].start]].p*c.x < mib { - continue - } - - as = append(as, &steepDownArea{ - start: areas[j].start, - end: areas[j].end, - mib: math.Max(areas[j].mib, mib), - }) - } - areas = as - - areas = append(areas, &steepDownArea{ - start: i, - end: e, - }) - - i = e + 1 - mib = c.re[c.so[i]].p - case c.isSteepUp(i, &e): - ue = e + 1 - - as := areas[:0] - for j := 0; j < len(areas); j++ { - if c.re[c.so[areas[j].start]].p*c.x < mib { - continue - } - - as = append(as, &steepDownArea{ - start: areas[j].start, - end: areas[j].end, - mib: math.Max(areas[j].mib, mib), - }) - } - areas = as - - for j := 0; j < len(areas); j++ { - if c.re[c.so[ue]].p*c.x < areas[j].mib { - continue - } - - d = (c.re[c.so[areas[j].start]].p - c.re[c.so[ue]].p) / c.re[c.so[areas[j].start]].p - - switch { - case math.Abs(d) <= c.xi: - cs = areas[j].start - ce = ue - case d > c.xi: - for k := areas[j].end; k > areas[j].end; k-- { - if math.Abs((c.re[c.so[k]].p-c.re[c.so[ue]].p)/c.re[c.so[k]].p) <= c.xi { - cs = k - break - } - } - ce = ue - default: - cs = areas[j].start - for k := i; k < e; k++ { - if math.Abs((c.re[c.so[k]].p-c.re[c.so[i]].p)/c.re[c.so[k]].p) <= c.xi { - ce = k - break - } - } - } - - p = ce - cs - - if p < c.minpts { - continue - } - - s = ce + cs - - if !clusters[s] { - clusters[s] = true - - c.b = append(c.b, 0) - c.b[k] = p - - c.w.Add(1) - - c.c <- &clusterJob{ - a: cs, - b: ce, - n: k, - } - - k++ - } - } - - i = ue - mib = c.re[c.so[i]].p - default: - i++ - } - } - - c.w.Wait() -} - -func (c *opticsClusterer) isSteepDown(i int, e *int) bool { - if c.re[c.so[i]].p*c.x > c.re[c.so[i+1]].p { - return false - } - - var counter, j int = 0, i - - *e = j - - for { - if j > c.g { - break - } - - if c.re[c.so[j]].p < c.re[c.so[j+1]].p { - break - } - - if c.re[c.so[j]].p*c.x <= c.re[c.so[j+1]].p { - *e = j - counter = 0 - } else { - counter++ - } - - if counter > c.minpts { - break - } - - j++ - } - - return *e != i -} - -func (c *opticsClusterer) isSteepUp(i int, e *int) bool { - if c.re[c.so[i]].p > c.re[c.so[i+1]].p*c.x { - return false - } - - var counter, j int = 0, i - - *e = j - - for { - if j > c.g { - break - } - - if c.re[c.so[j]].p > c.re[c.so[j+1]].p { - break - } - - if c.re[c.so[j]].p <= c.re[c.so[j+1]].p*c.x { - *e = j - counter = 0 - } else { - counter++ - } - - if counter > c.minpts { - break - } - - j++ - } - - return *e != i -} - -func (c *opticsClusterer) startClusterWorkers() { - c.c = make(chan *clusterJob, c.l) - - c.w = &sync.WaitGroup{} - - for i := 0; i < c.s; i++ { - go c.clusterWorker() - } -} - -func (c *opticsClusterer) endClusterWorkers() { - close(c.c) - - c.c = nil - - c.w = nil -} - -func (c *opticsClusterer) clusterWorker() { - for j := range c.c { - for i := j.a; i < j.b; i++ { - c.a[i] = j.n - } - - c.w.Done() - } -} - -/* Divide work among c.s workers, where c.s is determined - * by the size of the data. This is based on an assumption that neighbor points of p - * are located in relatively small subsection of the input data, so the dataset can be scanned - * concurrently without blocking a big number of goroutines trying to write to r */ -func (c *opticsClusterer) nearest(p int, l *int, r *[]int) { - var b int - - *r = (*r)[:0] - - c.p = c.d[p] - c.r = r - - c.w.Add(c.s) - - for i := 0; i < c.l; i += c.f { - if c.l-i <= c.f { - b = c.l - 1 - } else { - b = i + c.f - } - - c.j <- &rangeJob{ - a: i, - b: b, - } - } - - c.w.Wait() - - *l = len(*r) -} - -func (c *opticsClusterer) startNearestWorkers() { - c.j = make(chan *rangeJob, c.l) - - c.m = &sync.Mutex{} - c.w = &sync.WaitGroup{} - - for i := 0; i < c.s; i++ { - go c.nearestWorker() - } -} - -func (c *opticsClusterer) endNearestWorkers() { - close(c.j) - - c.j = nil - - c.m = nil - c.w = nil -} - -func (c *opticsClusterer) nearestWorker() { - for j := range c.j { - for i := j.a; i < j.b; i++ { - if c.distance(c.p, c.d[i]) < c.eps { - c.m.Lock() - *c.r = append(*c.r, i) - c.m.Unlock() - } - } - - c.w.Done() - } -} - -func (c *opticsClusterer) numWorkers() int { - var b int - - if c.l < 1000 { - b = 1 - } else if c.l < 10000 { - b = 10 - } else if c.l < 100000 { - b = 100 - } else { - b = 1000 - } - - if c.workers == 0 { - return b - } - - if c.workers < b { - return c.workers - } - - return b -} diff --git a/pkg/vector/centroid.go b/pkg/vector/centroid.go new file mode 100644 index 000000000..774c3a3ca --- /dev/null +++ b/pkg/vector/centroid.go @@ -0,0 +1,40 @@ +package vector + +// Centroid returns the element-wise mean (centroid) of the given vectors as a +// new, independent vector. Vectors whose length differs from the first vector +// are ignored, and the mean is taken over the vectors actually included. It +// returns nil when vs is empty or the first vector has no elements. +func Centroid(vs Vectors) Vector { + if len(vs) == 0 { + return nil + } + + dim := len(vs[0]) + + if dim == 0 { + return nil + } + + result := make(Vector, dim) + n := 0 + + for _, v := range vs { + if len(v) != dim { + continue + } + + for j := range dim { + result[j] += v[j] + } + + n++ + } + + inv := 1 / float64(n) + + for j := range result { + result[j] *= inv + } + + return result +} diff --git a/pkg/vector/centroid_test.go b/pkg/vector/centroid_test.go new file mode 100644 index 000000000..66b8868a8 --- /dev/null +++ b/pkg/vector/centroid_test.go @@ -0,0 +1,39 @@ +package vector + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestCentroid(t *testing.T) { + t.Run("Mean", func(t *testing.T) { + got := Centroid(Vectors{{1, 2}, {3, 4}}) + assert.Equal(t, Vector{2, 3}, got) + }) + t.Run("Single", func(t *testing.T) { + got := Centroid(Vectors{{2, 4, 6}}) + assert.Equal(t, Vector{2, 4, 6}, got) + }) + t.Run("SkipsMismatchedDimensions", func(t *testing.T) { + // The 3-D vector is ignored; the mean is taken over the two 2-D vectors. + got := Centroid(Vectors{{1, 2}, {1, 2, 3}, {3, 4}}) + assert.Equal(t, Vector{2, 3}, got) + }) + t.Run("Empty", func(t *testing.T) { + assert.Nil(t, Centroid(Vectors{})) + assert.Nil(t, Centroid(nil)) + }) + t.Run("FirstVectorEmpty", func(t *testing.T) { + assert.Nil(t, Centroid(Vectors{{}, {1, 2}})) + }) + t.Run("Independent", func(t *testing.T) { + a := Vector{1, 2} + b := Vector{3, 4} + got := Centroid(Vectors{a, b}) + got[0] = 100 + // Mutating the result must not change the inputs. + assert.Equal(t, Vector{1, 2}, a) + assert.Equal(t, Vector{3, 4}, b) + }) +} diff --git a/pkg/vector/distance.go b/pkg/vector/distance.go new file mode 100644 index 000000000..9c15a19ab --- /dev/null +++ b/pkg/vector/distance.go @@ -0,0 +1,82 @@ +package vector + +import "math" + +// EuclideanDist returns the Euclidean distance between the vectors, +func (v Vector) EuclideanDist(w Vector) float64 { + return EuclideanDist(v, w) +} + +// CosineSimilarity returns the cosine similarity between two vectors, +// ranging from -1 (opposite) to 1 (identical). +func (v Vector) CosineSimilarity(w Vector) float64 { + return CosineSimilarity(v, w) +} + +// CosineDist returns the cosine distance between two vectors (1 - cosine similarity). +func (v Vector) CosineDist(w Vector) float64 { + return CosineDist(v, w) +} + +// EuclideanDist returns the Euclidean distance between multiple vectors. +func EuclideanDist(a, b Vector) float64 { + if a.Dim() != b.Dim() { + return NaN() + } + + var ( + s, t float64 + ) + + for i := range a { + t = a[i] - b[i] + s += t * t + } + + return math.Sqrt(s) +} + +// CosineSimilarity returns the cosine similarity between two vectors, ranging +// from -1 (opposite) to 1 (identical). It returns NaN when the dimensions +// differ and 0 when either operand is a zero vector. +func CosineSimilarity(a, b Vector) float64 { + if a.Dim() != b.Dim() { + return NaN() + } + + var sum, s1, s2 float64 + + for i := range a { + sum += a[i] * b[i] + s1 += a[i] * a[i] + s2 += b[i] * b[i] + } + + if s1 == 0 || s2 == 0 { + return 0.0 + } + + return sum / (math.Sqrt(s1) * math.Sqrt(s2)) +} + +// CosineDist returns the cosine distance between two vectors, defined as +// 1 - CosineSimilarity. Identical vectors yield 0; it returns NaN when the +// dimensions differ. +func CosineDist(a, b Vector) float64 { + return 1.0 - CosineSimilarity(a, b) +} + +// CosineDists returns the cosine distances between two sets of vectors. +func CosineDists(x, y Vectors) Vectors { + result := make(Vectors, len(x)) + + for i, a := range x { + result[i] = make([]float64, len(y)) + + for j, b := range y { + result[i][j] = CosineDist(a, b) + } + } + + return result +} diff --git a/pkg/vector/distance_test.go b/pkg/vector/distance_test.go new file mode 100644 index 000000000..1c47d5924 --- /dev/null +++ b/pkg/vector/distance_test.go @@ -0,0 +1,116 @@ +package vector + +import ( + "math" + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestEuclideanDist(t *testing.T) { + a := Vector{1, 2, 3, 4, 6, 5} + b := Vector{2, 1, 3, 4, 5, 6} + d := Vector{0, 0, 0, 0, 0, 0} + e := Vector{} + n := make(Vector, 512) + + t.Run("Method", func(t *testing.T) { + assert.InDelta(t, 2, a.EuclideanDist(b), 0.01) + assert.InDelta(t, a.EuclideanDist(b), b.EuclideanDist(a), 0.01) + assert.True(t, math.IsNaN(faceEmbeddingB.EuclideanDist(d))) + assert.InDelta(t, 0, d.EuclideanDist(d), 0.01) + assert.True(t, math.IsNaN(e.EuclideanDist(d))) + assert.InDelta(t, 0.9999999779072661, faceEmbeddingB.EuclideanDist(n), 0.01) + }) + t.Run("Func", func(t *testing.T) { + assert.InDelta(t, 2.0, EuclideanDist(a, b), 0.01) + }) +} + +func TestCosineSimilarity(t *testing.T) { + a := Vector{1, 2, 3, 4, 6, 5} + b := Vector{2, 1, 3, 4, 5, 6} + d := Vector{0, 0, 0, 0, 0, 0} + e := Vector{} + n := make(Vector, 512) + + t.Run("Values", func(t *testing.T) { + assert.InDelta(t, 0.978021978021978, a.CosineSimilarity(b), 0.01) + assert.True(t, math.IsNaN(faceEmbeddingB.CosineSimilarity(d))) + assert.InDelta(t, 0, d.CosineSimilarity(d), 0.01) + assert.True(t, math.IsNaN(e.CosineSimilarity(d))) + assert.InDelta(t, 0, faceEmbeddingB.CosineSimilarity(n), 0.01) + assert.InDelta(t, 0, n.CosineSimilarity(n), 0.01) + assert.InDelta(t, 1.0, faceEmbeddingB.CosineSimilarity(faceEmbeddingB), 0.01) + assert.InDelta(t, 1.0, a.CosineSimilarity(a), 0.01) + assert.InDelta(t, 1.0, b.CosineSimilarity(b), 0.01) + }) + t.Run("Func", func(t *testing.T) { + assert.InDelta(t, 0.978021978021978, CosineSimilarity(a, b), 0.01) + }) + t.Run("Orthogonal", func(t *testing.T) { + assert.InDelta(t, 0.0, CosineSimilarity(Vector{1, 0}, Vector{0, 1}), 0.00001) + assert.InDelta(t, 1.0, CosineDist(Vector{1, 0}, Vector{0, 1}), 0.00001) + }) + t.Run("Opposite", func(t *testing.T) { + assert.InDelta(t, -1.0, CosineSimilarity(Vector{1, 0}, Vector{-1, 0}), 0.00001) + assert.InDelta(t, 2.0, CosineDist(Vector{1, 0}, Vector{-1, 0}), 0.00001) + }) + t.Run("DimensionMismatch", func(t *testing.T) { + assert.True(t, math.IsNaN(CosineSimilarity(Vector{1, 0}, Vector{1, 0, 0}))) + assert.True(t, math.IsNaN(CosineDist(Vector{1, 0}, Vector{1, 0, 0}))) + }) +} + +func TestCosineDist(t *testing.T) { + a := Vector{1, 2, 3, 4, 6, 5} + b := Vector{2, 1, 3, 4, 5, 6} + d := Vector{0, 0, 0, 0, 0, 0} + e := Vector{} + n := make(Vector, 512) + + t.Run("Values", func(t *testing.T) { + // Distance is 1 - similarity: 0 for identical, 1 for a zero vector, NaN on dim mismatch. + assert.InDelta(t, 0.021978021978022, a.CosineDist(b), 0.01) + assert.True(t, math.IsNaN(faceEmbeddingB.CosineDist(d))) + assert.InDelta(t, 1.0, d.CosineDist(d), 0.01) + assert.True(t, math.IsNaN(e.CosineDist(d))) + assert.InDelta(t, 1.0, faceEmbeddingB.CosineDist(n), 0.01) + assert.InDelta(t, 1.0, n.CosineDist(n), 0.01) + assert.InDelta(t, 0, faceEmbeddingB.CosineDist(faceEmbeddingB), 0.01) + assert.InDelta(t, 0, a.CosineDist(a), 0.01) + assert.InDelta(t, 0, b.CosineDist(b), 0.01) + }) + t.Run("Func", func(t *testing.T) { + assert.InDelta(t, 0.021978021978022, CosineDist(a, b), 0.01) + }) + t.Run("Equal", func(t *testing.T) { + x := Vector{1, 0, 0, 1, 0, 0} + y := Vector{1, 0, 0, 1, 0, 0} + // Identical vectors: similarity 1, distance 0. + assert.InDelta(t, 1.0, CosineSimilarity(x, y), 0.00001) + assert.InDelta(t, 0.0, CosineDist(x, y), 0.00001) + }) + t.Run("Faces", func(t *testing.T) { + // Real face embeddings: near-orthogonal, so distance is ~1. + assert.InDelta(t, -0.003275301858301365, CosineSimilarity(faceEmbeddingA, faceEmbeddingB), 0.00001) + assert.InDelta(t, 1.003275301858301365, CosineDist(faceEmbeddingA, faceEmbeddingB), 0.00001) + }) +} + +func TestCosineDists(t *testing.T) { + x := Vectors{{1, 0}, {0, 1}} + y := Vectors{{1, 0}, {-1, 0}} + got := CosineDists(x, y) + assert.Len(t, got, 2) + assert.InDelta(t, 0.0, got[0][0], 0.00001) // identical + assert.InDelta(t, 2.0, got[0][1], 0.00001) // opposite + assert.InDelta(t, 1.0, got[1][0], 0.00001) // orthogonal + assert.InDelta(t, 1.0, got[1][1], 0.00001) // orthogonal +} + +func BenchmarkCosineDist(b *testing.B) { + for b.Loop() { + CosineDist(faceEmbeddingA, faceEmbeddingB) + } +} diff --git a/pkg/vector/fixtures_test.go b/pkg/vector/fixtures_test.go new file mode 100644 index 000000000..d0bf4160d --- /dev/null +++ b/pkg/vector/fixtures_test.go @@ -0,0 +1,8 @@ +package vector + +// Shared test fixtures: two real, already L2-normalized 512-dimensional face +// embeddings reused by the distance, norm, and cosine tests and benchmarks. + +var faceEmbeddingA = Vector{0.09050429612398148, -0.034165557473897934, 0.04864225909113884, -0.0072485702112317085, -0.023092104122042656, 0.027721818536520004, -0.054512765258550644, -0.011073374189436436, -0.10611298680305481, -0.09373591840267181, 0.05169020965695381, 0.022325381636619568, 0.0660574808716774, 0.0745176374912262, 0.033539049327373505, -0.05087396129965782, 0.03592195361852646, 0.048213306814432144, -0.022667650133371353, 0.03860087692737579, 0.05497220903635025, -0.07314137369394302, 0.0407942458987236, 0.007624434307217598, 0.026637494564056396, -0.02921448089182377, 0.0562191866338253, 0.0022813105024397373, 0.06954964995384216, 0.011513718403875828, 0.051686715334653854, -0.06144102290272713, -0.06638970226049423, 0.017356356605887413, -0.037446312606334686, 0.011931972578167915, -0.09081587195396423, 0.007885996252298355, 0.004822328686714172, 0.07497039437294006, -0.0758754089474678, 0.01736759953200817, -0.03094332665205002, -0.028449613600969315, 0.04941004887223244, 0.043144915252923965, 0.020656095817685127, 0.00013218115782365203, 0.010540441609919071, -0.005086455028504133, -0.045420411974191666, -0.012117994017899036, 0.027115555480122566, 0.09600701183080673, 0.024567779153585434, -0.036064546555280685, 0.047646667808294296, 0.010342034511268139, 0.042122356593608856, 0.011761351488530636, 0.02835131250321865, -0.04516693949699402, 0.04595448076725006, 0.03437191620469093, 0.11455260962247849, 0.03494664281606674, 0.004416515585035086, -0.07535701245069504, -0.012427383102476597, -0.0013752385275438428, -0.026557253673672676, 0.029679754748940468, 0.014478369615972042, -0.010105332359671593, -0.012286004610359669, 0.008126290515065193, 0.029303785413503647, -0.057241108268499374, 0.0033099683932960033, 0.01164975669234991, -0.007513932418078184, 0.0242016538977623, 0.05745712295174599, 0.028663545846939087, 0.03970225155353546, -0.023029271513223648, 0.02981036901473999, 0.03829219192266464, 0.03987501189112663, 0.017537616193294525, 0.02726835384964943, -0.013689219951629639, -0.04987820237874985, -0.040511664003133774, -0.021752934902906418, -0.07194412499666214, -0.051058970391750336, 0.023398589342832565, 0.03610694780945778, 0.00046719887177459896, 0.037188317626714706, -0.02566867135465145, 0.01604439504444599, -0.003634978784248233, 0.023078899830579758, 0.04129897058010101, -0.014649354852735996, 0.005342431832104921, -0.05193427577614784, -0.0388319157063961, -0.04907385632395744, 0.07699707895517349, -0.025095880031585693, 0.008442633785307407, 0.02021537348628044, 0.001264346414245665, -0.07380999624729156, -0.048401474952697754, -0.01882218010723591, -0.03912215307354927, -0.019224153831601143, 0.04983046278357506, -0.02566423825919628, -0.04404774308204651, 0.026545586064457893, -0.011196354404091835, -0.07557094842195511, -0.01379274670034647, 0.05286092683672905, 0.0013972970191389322, 0.006785087287425995, 0.011092058382928371, -0.05664386600255966, 0.08189822733402252, 0.01435012836009264, 0.0044399346224963665, -0.010694965720176697, 0.040221404284238815, -0.027927834540605545, -0.07454574108123779, 0.0553150437772274, 0.05394366756081581, -0.0033581850584596395, -0.024510426446795464, 0.008418681100010872, 0.03598837926983833, 0.01587156392633915, 0.0038127924781292677, 0.01119104865938425, 0.04693349450826645, 0.006098508834838867, -0.0017983769066631794, -0.04955652356147766, 0.09051105380058289, 0.0073089939542114735, -0.019370773807168007, 0.007884875871241093, -0.06199871003627777, -0.01850189082324505, -0.05228694528341293, -0.05400950461626053, -0.005632052198052406, 0.0020052779000252485, 0.03451100364327431, 0.036398425698280334, 0.05265820398926735, -0.011337222531437874, 0.013296777382493019, -0.0591934509575367, -0.06284786015748978, -0.0047112139873206615, -0.05348097160458565, 0.01298768911510706, -0.0456625372171402, -0.006065149325877428, -0.025567762553691864, -0.02817298099398613, -0.05127967894077301, -0.038833457976579666, 0.06326121836900711, 0.03279256448149681, -0.06116756424307823, -0.00897540058940649, -0.06233922019600868, 0.009809938259422779, -0.005387857090681791, -0.036401160061359406, -0.04316997900605202, -0.05489049851894379, -0.09730759263038635, -0.07952211797237396, 0.02321644127368927, 0.02643345668911934, -0.029610754922032356, -0.0429108701646328, 0.015382878482341766, -0.05127616599202156, -0.06552313268184662, 0.03043435700237751, -0.004739899653941393, -0.013985950499773026, 0.03178086504340172, -0.04262787476181984, 0.050286486744880676, 0.024078307673335075, -0.02595296874642372, -0.09277850389480591, -0.02931750938296318, 0.02375088632106781, -0.0027845173608511686, -0.007097273599356413, 0.013409079983830452, -0.037381891161203384, 0.030457323417067528, -0.05184711143374443, -0.008799600414931774, 0.02957642823457718, 0.05132228881120682, 0.060836631804704666, -0.000043339907279005274, -0.04915972426533699, -0.0038748879451304674, 0.008784785866737366, -0.020982224494218826, 0.06149329990148544, 0.02837146446108818, -0.044175948947668076, 0.06567257642745972, -0.03963049501180649, -0.07002358138561249, 0.006709821987897158, 0.05959227308630943, 0.03949318826198578, -0.014092321507632732, 0.09836959093809128, -0.07943648844957352, -0.009000610560178757, 0.0030425817240029573, 0.06436953693628311, -0.026696493849158287, 0.00682637095451355, -0.01507520116865635, 0.04695310816168785, 0.029429970309138298, 0.023842934519052505, -0.020885659381747246, -0.09611587971448898, -0.07405658066272736, -0.04233424365520477, -0.0011613338720053434, 0.057546716183423996, 0.03273669630289078, -0.048568133264780045, 0.0012128526577726007, 0.053861137479543686, -0.0350908562541008, 0.022841928526759148, 0.0620933435857296, -0.009771752171218395, 0.0021118440199643373, -0.028183909133076668, -0.0776321291923523, 0.018880240619182587, -0.028937598690390587, -0.04704895243048668, -0.041743259876966476, 0.07385464012622833, -0.05170309543609619, -0.028290364891290665, 0.02530353143811226, 0.01889736019074917, 0.026071889325976372, 0.035946063697338104, -0.05380414053797722, -0.04859302192926407, 0.0003545390209183097, 0.030886799097061157, -0.022649751976132393, 0.022308727726340294, -0.027548562735319138, 0.033452969044446945, -0.05277237668633461, -0.052690643817186356, 0.04759489372372627, 0.031058967113494873, 0.04526153579354286, 0.028865164145827293, -0.07438746839761734, 0.0024590680841356516, -0.028084587305784225, 0.02709362842142582, 0.013910548761487007, 0.03424328565597534, -0.02858562208712101, 0.0588177889585495, 0.01846511848270893, -0.037898849695920944, 0.042697105556726456, -0.013334364630281925, -0.0257448498159647, 0.12665124237537384, -0.019745446741580963, -0.002844252623617649, -0.03478461131453514, 0.014344505965709686, -0.02670290693640709, 0.011817696504294872, 0.048732347786426544, -0.0477047935128212, 0.06578560918569565, -0.06530530750751495, -0.09535658359527588, 0.02058124914765358, 0.0795418918132782, -0.011797895655035973, 0.03838758170604706, -0.03237924724817276, -0.10276861488819122, -0.030437085777521133, 0.12717247009277344, -0.011626948602497578, 0.015079738572239876, -0.011959588155150414, -0.05451022833585739, 0.009935147128999233, -0.02114112488925457, 0.02175278402864933, 0.03643997013568878, 0.0015244412934407592, 0.008756493218243122, 0.028317170217633247, -0.030474519357085228, -0.00388348544947803, -0.05619083344936371, 0.06022652983665466, -0.05782870203256607, -0.02699786052107811, 0.023685157299041748, -0.038485050201416016, 0.05153445899486542, -0.060548875480890274, -0.01506721694022417, -0.007553438656032085, 0.039509836584329605, 0.03681030124425888, 0.1338905692100525, -0.0035669414792209864, -0.012824718840420246, 0.08026544004678726, 0.0007068145787343383, 0.05609028413891792, -0.09387584030628204, 0.053474973887205124, -0.02244669944047928, -0.03398754075169563, 0.03549772873520851, -0.034875307232141495, -0.0047780852764844894, -0.0516449399292469, 0.061801642179489136, 0.019724003970623016, -0.05515078082680702, -0.039201926440000534, 0.06470708549022675, 0.04355214163661003, -0.033806391060352325, 0.0747586265206337, 0.008061372675001621, -0.031078290194272995, 0.02051386795938015, -0.010661521926522255, 0.007028735242784023, 0.052813757210969925, -0.014618860557675362, 0.010391696356236935, 0.01685873605310917, 0.005331454332917929, -0.05162535980343819, -0.014504718594253063, -0.026801610365509987, -0.00626059714704752, -0.06905800849199295, -0.10446352511644363, -0.05261509492993355, -0.04950559511780739, 0.013261653482913971, -0.025283565744757652, -0.03371249884366989, -0.009910509921610355, 0.05506015568971634, -0.0032501542009413242, 0.06410012394189835, -0.02705288864672184, 0.03838157281279564, -0.0028722372371703386, 0.10523688048124313, -0.005469444673508406, 0.0006657811463810503, -0.022171825170516968, 0.007440139539539814, -0.009108834899961948, 0.09758798778057098, 0.07208772003650665, -0.03589840233325958, 0.01901053451001644, 0.01944487728178501, -0.03779883682727814, -0.005568244960159063, -0.04835351184010506, 0.028863374143838882, 0.013382171280682087, 0.01990400068461895, -0.02292671613395214, 0.033316295593976974, 0.0007049285341054201, -0.08170327544212341, 0.005303904879838228, 0.017129195854067802, 0.048035942018032074, 0.0177064910531044, -0.07409890741109848, 0.002690644469112158, -0.09358572959899902, -0.02494824305176735, 0.005160054191946983, 0.01309937983751297, 0.01733747310936451, -0.028727075085043907, 0.07431124895811081, 0.019230933859944344, 0.044469334185123444, 0.07735494524240494, 0.014045624993741512, 0.02358667366206646, -0.029009323567152023, 0.011838157661259174, -0.03148479387164116, -0.02401883713901043, 0.07134886831045151, 0.03462617099285126, 0.09141889214515686, -0.032590366899967194, -0.017935005947947502, 0.01033404003828764, 0.021358856931328773, 0.052892062813043594, -0.016272393986582756, -0.0021813628263771534, -0.014650222845375538, 0.02733163721859455, 0.012284406460821629, -0.00011409903527237475, -0.0019222642295062542, 0.011368582025170326, 0.08538514375686646, 0.07764560729265213, -0.00016646491712890565, -0.021158777177333832, -0.003685612231492996, 0.0027680168859660625, -0.07727153599262238, -0.045435767620801926, 0.027570463716983795, 0.004876504186540842, -0.023479128256440163, -0.05900833383202553, 0.021972816437482834, 0.08244964480400085, -0.04722096025943756, 0.09820368885993958, -0.03607189655303955, 0.024602027609944344, 0.09130720794200897, 0.0060490816831588745, 0.003609518986195326, -0.05344478040933609, -0.013851549476385117, -0.0840664803981781, -0.07599852979183197, -0.04853493720293045, 0.02409926988184452, 0.007712183985859156, 0.047192711383104324, -0.02735353447496891, -0.0286621805280447, 0.051183052361011505, 0.026429185643792152, 0.047100841999053955, 0.07225227355957031, 0.05775126442313194, -0.07109982520341873, -0.019554149359464645, 0.004804393742233515, 0.07182382047176361, -0.05714774131774902, -0.03718779981136322, 0.010022906586527824, 0.040755949914455414, 0.035538796335458755, 0.0547688826918602, 0.018436597660183907, -0.009496998973190784, -0.034701500087976456, -0.07542424649000168, -0.024086780846118927, 0.03786386549472809, 0.08617071062326431, 0.061641909182071686, -0.10206557810306549, 0.008707753382623196, 0.07315801829099655, 0.017708826810121536} + +var faceEmbeddingB = Vector{-0.008137415163218975, -0.08006370067596436, 0.07025300711393356, 0.05047300457954407, -0.048540644347667694, 0.02255844883620739, -0.032381802797317505, -0.030422719195485115, -0.002007395029067993, 0.02374134585261345, 0.06882382184267044, -0.0014070027973502874, 0.0016334111569449306, -0.0006230792496353388, 0.024960000067949295, 0.05986246466636658, -0.024349741637706757, 0.04618404060602188, -0.08673757314682007, 0.05276675894856453, 0.0027138087898492813, 0.008117659948766232, -0.0037429891526699066, -0.01570519059896469, -0.13779018819332123, 0.06322789937257767, -0.058197781443595886, 0.04746529087424278, -0.08711255341768265, 0.019238201901316643, -0.05508963391184807, 0.017365770414471626, 0.02562207169830799, -0.002929446753114462, -0.07081708312034607, 0.03103666938841343, 0.0022698792163282633, 0.051838476210832596, 0.01691291667521, 0.005320006050169468, 0.030585378408432007, 0.06941074877977371, 0.008247891440987587, -0.03533969074487686, 0.05122591182589531, 0.04988280311226845, 0.08505327254533768, 0.04561468958854675, -0.062374748289585114, 0.022638529539108276, -0.022780820727348328, 0.0775931254029274, 0.02398429997265339, 0.03495755046606064, -0.012407658621668816, -0.03283195570111275, 0.06503018736839294, -0.03657644987106323, -0.029164006933569908, 0.058266233652830124, -0.019877741113305092, -0.04159046709537506, 0.0050654299557209015, -0.015958501026034355, -0.0295542161911726, 0.02208816446363926, 0.017241189256310463, -0.00469202920794487, -0.016516422852873802, 0.018105173483490944, 0.04346457123756409, 0.04661091789603233, 0.0091007174924016, -0.02539660967886448, -0.05948945879936218, 0.008711921982467175, -0.05822482705116272, 0.06004893407225609, -0.04515865445137024, -0.07707851380109787, 0.0032580809202045202, 0.006324823014438152, 0.02883482724428177, -0.01455928385257721, -0.03203008323907852, 0.010120648890733719, 0.02116110734641552, -0.028596824035048485, -0.06669415533542633, -0.03394141048192978, -0.021578358486294746, -0.0029677071142941713, -0.07965116947889328, -0.0005286909872666001, 0.048941437155008316, 0.05800784006714821, 0.042431481182575226, -0.03241220489144325, 0.0220502782613039, -0.03481437265872955, -0.04674076661467552, -0.004196728114038706, -0.07022743672132492, 0.07238440960645676, 0.04464253410696983, -0.04207949340343475, 0.021947475150227547, 0.013727233745157719, -0.06659548729658127, -0.00480034900829196, -0.010313994251191616, 0.02640429139137268, -0.0018985014175996184, -0.017516719177365303, 0.05424032732844353, 0.03034326806664467, -0.009059063158929348, -0.014670928940176964, 0.03108176961541176, -0.06324155628681183, 0.009439341723918915, -0.03230450302362442, 0.03011772409081459, -0.08903207629919052, 0.049357179552316666, -0.018093667924404144, -0.09150006622076035, 0.03277801349759102, -0.020068803802132607, -0.12405339628458023, 0.039792630821466446, -0.01258617639541626, -0.050734683871269226, 0.01388365589082241, -0.020610308274626732, -0.01117456890642643, -0.047699980437755585, 0.00904754176735878, -0.009436380118131638, 0.03356689587235451, 0.05179798603057861, -0.003932574763894081, 0.004325704649090767, 0.013883235864341259, -0.01672312431037426, -0.009120902046561241, 0.02865191549062729, -0.00018901238217949867, -0.14957121014595032, 0.06165143474936485, -0.010900797322392464, -0.04367987439036369, -0.08651748299598694, -0.04971740022301674, -0.012035397812724113, 0.05332765355706215, -0.03252051770687103, 0.027909329161047935, -0.043622151017189026, -0.03164845332503319, -0.03198356553912163, 0.05128004029393196, -0.040155746042728424, -0.0056242248974740505, -0.047345563769340515, 0.012517815455794334, -0.04241799935698509, -0.05661820247769356, 0.025342857465147972, -0.03272772207856178, -0.020752016454935074, 0.02841475047171116, 0.026285288855433464, -0.023260189220309258, 0.10821936279535294, 0.042671091854572296, 0.02412649802863598, -0.04032492637634277, 0.02996264584362507, -0.04249041527509689, -0.06933289021253586, 0.027393169701099396, 0.05308475345373154, -0.02078690193593502, -0.0067361886613070965, -0.0238595362752676, 0.01484128087759018, 0.021988647058606148, 0.06511303037405014, -0.08086460083723068, 0.03650467097759247, -0.021279210224747658, 0.045867037028074265, 0.06642837822437286, -0.003237910568714142, -0.01581430248916149, -0.02993408963084221, -0.0012522733304649591, -0.10658521205186844, -0.004413484595716, 0.014794287271797657, 0.04928160458803177, -0.029931025579571724, -0.0077111730352044106, -0.0732073038816452, 0.04210418090224266, -0.02385932393372059, 0.010084617882966995, -0.03800346329808235, -0.0682244822382927, 0.05564611777663231, 0.03370542451739311, 0.03176405653357506, -0.03024214692413807, 0.06749926507472992, -0.04842272028326988, 0.024823250249028206, 0.03411858156323433, 0.012186306528747082, 0.000344925036188215, 0.008661405183374882, -0.06331458687782288, -0.06190492585301399, -0.08768630772829056, 0.00041797355515882373, -0.018540306016802788, 0.04823239892721176, 0.06846356391906738, -0.03144964575767517, 0.03312361240386963, 0.023701541125774384, 0.06020048260688782, -0.018800485879182816, -0.01420025434345007, -0.01672394946217537, -0.016691889613866806, 0.011016116477549076, 0.013350298628211021, 0.01238208170980215, 0.01691477745771408, -0.0010262437863275409, 0.053074032068252563, 0.018735406920313835, 0.035321593284606934, -0.022181423380970955, -0.017033280804753304, 0.032775890082120895, 0.05400064215064049, -0.019599098712205887, -0.014503749087452888, -0.021623743698000908, -0.020413488149642944, 0.033719275146722794, 0.015080427750945091, 0.044618159532547, 0.10514744371175766, -0.07683298736810684, -0.04230527579784393, -0.04676186293363571, 0.1221809908747673, 0.018557196483016014, -0.10948510468006134, -0.007052143104374409, 0.03444751724600792, -0.12690776586532593, 0.01613660342991352, 0.026724737137556076, -0.01689913682639599, 0.032920803874731064, 0.0033084892202168703, -0.008477253839373589, 0.005826534237712622, 0.05720831826329231, -0.01001140009611845, 0.06672288477420807, -0.03293010592460632, -0.008007185533642769, 0.03565505892038345, -0.045379389077425, -0.01783432625234127, -0.06628750264644623, -0.0027283544186502695, 0.03038688562810421, -0.020332351326942444, -0.06984596699476242, 0.07357253134250641, 0.10730107873678207, -0.015427534468472004, -0.0743771567940712, -0.043926578015089035, 0.04178789258003235, 0.011173141188919544, 0.025277631357312202, 0.07788840681314468, 0.004462982527911663, -0.05092375725507736, -0.008599985390901566, -0.011293918825685978, -0.027740459889173508, -0.08115565031766891, -0.009694007225334644, -0.07026723772287369, 0.02862926386296749, 0.01975271850824356, 0.00902275275439024, 0.05126506835222244, -0.07478014379739761, 0.021499518305063248, 0.055629830807447433, 0.031052052974700928, 0.05949579179286957, -0.028020750731229782, -0.02862796001136303, 0.056453678756952286, -0.031041307374835014, 0.02422715350985527, -0.07100068032741547, 0.032912544906139374, 0.009702234528958797, 0.06579262763261795, -0.08040975034236908, 0.06385798007249832, -0.009425429627299309, 0.0210894588381052, 0.018046097829937935, 0.005574067123234272, -0.04380524903535843, 0.022144699469208717, 0.025359811261296272, 0.04807835817337036, 0.0006021010922268033, -0.07143598049879074, 0.020978737622499466, -0.05171458050608635, 0.0382511243224144, 0.025260137394070625, 0.09952495992183685, 0.014374740421772003, -0.03502845764160156, 0.008830498903989792, -0.06433495879173279, -0.07015430927276611, 0.0705648809671402, 0.010429518297314644, 0.01585286110639572, -0.056704264134168625, 0.00618960103020072, 0.03986428678035736, 0.003704571630805731, -0.015225011855363846, 0.008472353219985962, 0.07302212715148926, -0.020373830571770668, 0.003514211857691407, 0.013997740112245083, -0.0038872845470905304, -0.03703470155596733, -0.03875543549656868, -0.012492465786635876, 0.059783436357975006, 0.014407767914235592, 0.032212793827056885, 0.03943135216832161, -0.04783743992447853, -0.08073361217975616, 0.025175172835588455, -0.07072967290878296, 0.06343924254179001, 0.041898149996995926, -0.056953541934490204, 0.029663341119885445, 0.04826335236430168, 0.010070821270346642, -0.037220172584056854, 0.01026119664311409, 0.061207421123981476, 0.0938570499420166, -0.037144023925065994, 0.04894149303436279, -0.011274874210357666, -0.0167219378054142, -0.06375480443239212, 0.022223835811018944, -0.05070881545543671, 0.01647593080997467, -0.022871576249599457, 0.06493012607097626, -0.10572224110364914, -0.042038556188344955, -0.026631822809576988, 0.04876351356506348, 0.03300929814577103, 0.010545262135565281, -0.011176304891705513, -0.034550394862890244, 0.019394656643271446, -0.033105626702308655, -0.01746574230492115, 0.04380633309483528, 0.021436357870697975, -0.01687694527208805, 0.009079670533537865, -0.0019935970194637775, 0.02397148869931698, 0.020745644345879555, -0.021921435371041298, 0.013043859973549843, -0.001916338107548654, -0.04032173752784729, 0.010448900051414967, -0.01346014253795147, -0.048173755407333374, 0.0696289911866188, 0.0027435971423983574, -0.020373817533254623, 0.03318791463971138, -0.05028868094086647, -0.06621105223894119, 0.08377863466739655, -0.06662183254957199, 0.040066834539175034, -0.031038448214530945, -0.0012645371025428176, -0.08046844601631165, -0.07508288323879242, -0.011627450585365295, 0.05332736670970917, -0.050804637372493744, -0.02298901602625847, 0.017321497201919556, 0.04411279037594795, 0.02128334902226925, 0.026375887915492058, -0.006951047573238611, 0.026754219084978104, 0.04742620140314102, -0.01177502702921629, 0.060023725032806396, 0.005484475754201412, -0.00279219844378531, -0.09506803750991821, 0.08349333703517914, -0.02932984009385109, -0.0005634548142552376, -0.009349865838885307, -0.04879671335220337, 0.021670177578926086, -0.03875391557812691, -0.028711730614304543, -0.03708324581384659, -0.11263322830200195, -0.033891621977090836, 0.04228183254599571, 0.045042142271995544, 0.028116095811128616, 0.005323487799614668, 0.10822916775941849, -0.011182534508407116, -0.060331087559461594, -0.027081234380602837, -0.030490467324852943, -0.050583478063344955, 0.013974534347653389, -0.006292127538472414, 0.05019136518239975, 0.044325292110443115, 0.008860588073730469, 0.0005901191616430879, -0.04545517638325691, 0.028188807889819145, 0.02233756333589554, -0.07275871932506561, -0.04000203683972359, 0.05174611508846283, -0.050140008330345154, 0.017476622015237808, 0.0713571161031723, 0.042271941900253296, -0.004472524859011173, 0.0516694039106369, 0.07247994840145111, -0.027353506535291672, -0.024733062833547592, -0.049786582589149475, -0.01696055382490158, 0.06537499278783798, 0.04510447010397911, -0.04963269829750061, 0.018454866483807564, 0.03766272962093353, -0.08027862757444382, 0.06390812247991562, 0.009653930552303791, -0.017673317342996597, 0.008882815018296242, 0.001341609749943018, -0.0008363581146113575, 0.005991082638502121, 0.030882244929671288, -0.0010816589929163456, -0.043741147965192795, -0.02244267612695694, 0.020251808688044548, -0.008073689416050911, 0.0008555973181501031, -0.025090467184782028, 0.014763036742806435, 0.008378133177757263, 0.06943207234144211, 0.04518865421414375, -0.051252108067274094, 0.004460426978766918} diff --git a/pkg/vector/mean.go b/pkg/vector/mean.go index 9d042eef5..a8085e584 100644 --- a/pkg/vector/mean.go +++ b/pkg/vector/mean.go @@ -1,6 +1,9 @@ package vector -import "math" +import ( + "fmt" + "math" +) // Mean gets the average of a slice of numbers func Mean(v Vector) float64 { @@ -11,7 +14,9 @@ func Mean(v Vector) float64 { return s / n } -// GeometricMean gets the geometric mean for a slice of numbers +// GeometricMean gets the geometric mean for a slice of numbers. +// It is undefined for negative values (returns NaN) and yields 0 if any +// value is 0, since the product of all values is then 0. func GeometricMean(v Vector) float64 { l := v.Dim() @@ -19,17 +24,16 @@ func GeometricMean(v Vector) float64 { return NaN() } - // Get the product of all the numbers - var p float64 + // Multiply all values; a zero element correctly drives the product to 0. + p := 1.0 for _, n := range v { - if p == 0 { - p = n - } else { - p *= n + if n < 0 { + return NaN() } + p *= n } - // Calculate the geometric mean + // Calculate the geometric mean. return math.Pow(p, 1/float64(l)) } @@ -55,3 +59,47 @@ func HarmonicMean(v Vector) float64 { return float64(l) / p } + +// Mean returns the vector's mean value. +func (v Vector) Mean() float64 { + return Mean(v) +} + +// GeometricMean returns the vector's geometric mean value. +func (v Vector) GeometricMean() float64 { + return GeometricMean(v) +} + +// HarmonicMean returns the vector's harmonic mean value. +func (v Vector) HarmonicMean() float64 { + return HarmonicMean(v) +} + +// weightedSum returns the weighted sum of the vector. This is really only useful in +// calculating the weighted mean. +func (v Vector) weightedSum(w Vector) (float64, error) { + if len(v) != len(w) { + return NaN(), fmt.Errorf("length of weights unequal to vector length") + } + + ws := 0.0 + + for i := range v { + ws += v[i] * w[i] + } + + return ws, nil +} + +// WeightedMean returns the vector's weighted mean value based of the specified weights. +func (v Vector) WeightedMean(w Vector) (float64, error) { + ws, err := v.weightedSum(w) + + if err != nil { + return NaN(), err + } + + sw := w.Sum() + + return ws / sw, nil +} diff --git a/pkg/vector/mean_test.go b/pkg/vector/mean_test.go new file mode 100644 index 000000000..ae345bc36 --- /dev/null +++ b/pkg/vector/mean_test.go @@ -0,0 +1,79 @@ +package vector + +import ( + "math" + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestMean(t *testing.T) { + t.Run("Values", func(t *testing.T) { + assert.InDelta(t, 2.5, Mean(Vector{1, 2, 3, 4}), 0.00001) + }) + t.Run("Single", func(t *testing.T) { + assert.InDelta(t, 7.0, Mean(Vector{7}), 0.00001) + }) + t.Run("Empty", func(t *testing.T) { + assert.True(t, math.IsNaN(Mean(Vector{}))) + }) +} + +func TestGeometricMean(t *testing.T) { + t.Run("Values", func(t *testing.T) { + assert.InDelta(t, 4.0, GeometricMean(Vector{2, 8}), 0.00001) + }) + t.Run("PowersOfThree", func(t *testing.T) { + assert.InDelta(t, math.Pow(3, 1.5), GeometricMean(Vector{1, 3, 9, 27}), 0.00001) + }) + t.Run("Method", func(t *testing.T) { + assert.InDelta(t, 4.0, Vector{2, 8}.GeometricMean(), 0.00001) + }) + t.Run("ContainsZero", func(t *testing.T) { + // A zero element drives the product to 0, so the geometric mean is 0. + assert.InDelta(t, 0.0, GeometricMean(Vector{2, 0, 8}), 0.00001) + }) + t.Run("LeadingZero", func(t *testing.T) { + assert.InDelta(t, 0.0, GeometricMean(Vector{0, 4, 9}), 0.00001) + }) + t.Run("Negative", func(t *testing.T) { + assert.True(t, math.IsNaN(GeometricMean(Vector{-1, 2}))) + }) + t.Run("Empty", func(t *testing.T) { + assert.True(t, math.IsNaN(GeometricMean(Vector{}))) + }) +} + +func TestHarmonicMean(t *testing.T) { + t.Run("Values", func(t *testing.T) { + assert.InDelta(t, 3.0/1.75, HarmonicMean(Vector{1, 2, 4}), 0.00001) + }) + t.Run("Equal", func(t *testing.T) { + assert.InDelta(t, 2.0, HarmonicMean(Vector{2, 2}), 0.00001) + }) + t.Run("Method", func(t *testing.T) { + assert.InDelta(t, 3.0/1.75, Vector{1, 2, 4}.HarmonicMean(), 0.00001) + }) + t.Run("ContainsZero", func(t *testing.T) { + assert.True(t, math.IsNaN(HarmonicMean(Vector{1, 0, 2}))) + }) + t.Run("Negative", func(t *testing.T) { + assert.True(t, math.IsNaN(HarmonicMean(Vector{1, -2}))) + }) + t.Run("Empty", func(t *testing.T) { + assert.True(t, math.IsNaN(HarmonicMean(Vector{}))) + }) +} + +func TestVector_WeightedMean(t *testing.T) { + t.Run("Values", func(t *testing.T) { + r, err := Vector{1, 2, 4}.WeightedMean(Vector{1, 0, 1}) + assert.NoError(t, err) + assert.InDelta(t, 2.5, r, 0.00001) + }) + t.Run("LengthMismatch", func(t *testing.T) { + r, err := Vector{1, 2, 4}.WeightedMean(Vector{1, 1}) + assert.Error(t, err) + assert.True(t, math.IsNaN(r)) + }) +} diff --git a/pkg/vector/norm.go b/pkg/vector/norm.go new file mode 100644 index 000000000..8aae516e3 --- /dev/null +++ b/pkg/vector/norm.go @@ -0,0 +1,28 @@ +package vector + +import "math" + +// Norm returns the vector size (magnitude), +// see https://builtin.com/data-science/vector-norms. +func (v Vector) Norm(pow float64) float64 { + return Norm(v, pow) +} + +// EuclideanNorm returns the Euclidean vector size (magnitude), +// see https://builtin.com/data-science/vector-norms. +func (v Vector) EuclideanNorm() float64 { + return v.Norm(2.0) +} + +// Norm returns the size of the vector (use pow = 2.0 for the Euclidean distance), +// see https://builtin.com/data-science/vector-norms. Absolute values are used so +// that odd powers (e.g. the L1 norm) stay well-defined for negative components. +func Norm(v Vector, pow float64) float64 { + s := 0.0 + + for _, f := range v { + s += math.Pow(math.Abs(f), pow) + } + + return math.Pow(s, 1/pow) +} diff --git a/pkg/vector/norm_test.go b/pkg/vector/norm_test.go new file mode 100644 index 000000000..42a3a5f01 --- /dev/null +++ b/pkg/vector/norm_test.go @@ -0,0 +1,32 @@ +package vector + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestVector_EuclideanNorm(t *testing.T) { + a := Vector{1, 2, 3, 4, 6, 5} + b := Vector{2, 1, 3, 4, 5, 6} + d := Vector{0, 0, 0, 0, 0, 0} + e := Vector{} + + assert.InDelta(t, 9.539392014169456, a.EuclideanNorm(), 0.01) + assert.InDelta(t, 9.539392014169456, b.EuclideanNorm(), 0.01) + assert.Equal(t, a.EuclideanNorm(), b.EuclideanNorm()) + assert.InDelta(t, 0.9999999779072661, faceEmbeddingB.EuclideanNorm(), 0.01) + assert.InDelta(t, 0, d.EuclideanNorm(), 0.01) + assert.InDelta(t, 0, e.EuclideanNorm(), 0.01) + assert.Equal(t, d.EuclideanNorm(), e.EuclideanNorm()) +} + +func TestNorm(t *testing.T) { + t.Run("Euclidean", func(t *testing.T) { + assert.InDelta(t, 5.0, Norm(Vector{3, -4}, 2.0), 0.00001) + }) + t.Run("Manhattan", func(t *testing.T) { + // L1 norm uses absolute values, so negatives contribute their magnitude. + assert.InDelta(t, 5.0, Norm(Vector{1, -2, 2}, 1.0), 0.00001) + }) +} diff --git a/pkg/vector/normalize.go b/pkg/vector/normalize.go new file mode 100644 index 000000000..42ee1d171 --- /dev/null +++ b/pkg/vector/normalize.go @@ -0,0 +1,32 @@ +package vector + +import "math" + +// Normalize scales the vector to unit length (L2 norm) in place. +// A zero vector (including an empty one) is left unchanged to avoid +// a division by zero. +func (v Vector) Normalize() { + var sum float64 + + for _, f := range v { + sum += f * f + } + + if sum == 0 { + return + } + + inv := 1 / math.Sqrt(sum) + + for i := range v { + v[i] *= inv + } +} + +// Normalized returns an L2-normalized copy of the vector, +// leaving the receiver unchanged. +func (v Vector) Normalized() Vector { + c := v.Copy() + c.Normalize() + return c +} diff --git a/pkg/vector/normalize_test.go b/pkg/vector/normalize_test.go new file mode 100644 index 000000000..b12305237 --- /dev/null +++ b/pkg/vector/normalize_test.go @@ -0,0 +1,60 @@ +package vector + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestVector_Normalize(t *testing.T) { + t.Run("UnitLength", func(t *testing.T) { + v := Vector{3, 4} + v.Normalize() + assert.InDelta(t, 0.6, v[0], 1e-9) + assert.InDelta(t, 0.8, v[1], 1e-9) + assert.InDelta(t, 1.0, v.EuclideanNorm(), 1e-9) + }) + t.Run("Negative", func(t *testing.T) { + v := Vector{-3, 4} + v.Normalize() + assert.InDelta(t, -0.6, v[0], 1e-9) + assert.InDelta(t, 0.8, v[1], 1e-9) + }) + t.Run("Single", func(t *testing.T) { + v := Vector{5} + v.Normalize() + assert.InDelta(t, 1.0, v[0], 1e-9) + }) + t.Run("ZeroVector", func(t *testing.T) { + v := Vector{0, 0} + v.Normalize() + assert.Equal(t, Vector{0, 0}, v, "a zero vector must be left unchanged") + }) + t.Run("Empty", func(t *testing.T) { + v := Vector{} + v.Normalize() + assert.Equal(t, Vector{}, v) + }) +} + +func TestVector_Normalized(t *testing.T) { + t.Run("ReturnsCopy", func(t *testing.T) { + orig := Vector{3, 4} + got := orig.Normalized() + // Receiver stays unchanged. + assert.InDelta(t, 3.0, orig[0], 1e-9) + assert.InDelta(t, 4.0, orig[1], 1e-9) + // Returned vector is normalized. + assert.InDelta(t, 0.6, got[0], 1e-9) + assert.InDelta(t, 0.8, got[1], 1e-9) + }) + t.Run("ZeroVector", func(t *testing.T) { + orig := Vector{0, 0} + got := orig.Normalized() + assert.Equal(t, Vector{0, 0}, got) + assert.Equal(t, Vector{0, 0}, orig) + }) + t.Run("Empty", func(t *testing.T) { + assert.Equal(t, Vector{}, Vector{}.Normalized()) + }) +} diff --git a/pkg/vector/product.go b/pkg/vector/product.go new file mode 100644 index 000000000..bba7f4c7b --- /dev/null +++ b/pkg/vector/product.go @@ -0,0 +1,29 @@ +package vector + +import "fmt" + +// Product returns a vector of element-wise products of two input vectors. +func Product(a, b Vector) (Vector, error) { + if len(a) != len(b) { + return nil, fmt.Errorf("vector dimensions do not match (%d, %d)", len(a), len(b)) + } + + p := make(Vector, len(a)) + + for i := range a { + p[i] = a[i] * b[i] + } + + return p, nil +} + +// DotProduct returns the dot product of two vectors. +func DotProduct(a, b Vector) (float64, error) { + p, err := Product(a, b) + + if err != nil { + return NaN(), err + } + + return p.Sum(), nil +} diff --git a/pkg/vector/product_test.go b/pkg/vector/product_test.go new file mode 100644 index 000000000..bab826a4a --- /dev/null +++ b/pkg/vector/product_test.go @@ -0,0 +1,34 @@ +package vector + +import ( + "math" + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestProduct(t *testing.T) { + t.Run("Values", func(t *testing.T) { + p, err := Product(Vector{1, 2, 3}, Vector{4, 5, 6}) + assert.NoError(t, err) + assert.Equal(t, Vector{4, 10, 18}, p) + }) + t.Run("LengthMismatch", func(t *testing.T) { + p, err := Product(Vector{1, 2, 3}, Vector{4, 5}) + assert.Error(t, err) + assert.Nil(t, p) + }) +} + +func TestDotProduct(t *testing.T) { + t.Run("Values", func(t *testing.T) { + r, err := DotProduct(Vector{1, 2, 3}, Vector{4, 5, 6}) + assert.NoError(t, err) + assert.InDelta(t, 32.0, r, 0.00001) + }) + t.Run("LengthMismatch", func(t *testing.T) { + r, err := DotProduct(Vector{1, 2, 3}, Vector{4, 5}) + assert.Error(t, err) + assert.True(t, math.IsNaN(r)) + }) +} diff --git a/pkg/vector/stats.go b/pkg/vector/stats.go new file mode 100644 index 000000000..9778de4ef --- /dev/null +++ b/pkg/vector/stats.go @@ -0,0 +1,53 @@ +package vector + +import "math" + +// Sd calculates the vector's standard deviation. +func (v Vector) Sd() float64 { + return math.Sqrt(v.Variance()) +} + +// Variance calculates the vector's variance. +func (v Vector) Variance() float64 { + return v.variance(v.Mean()) +} + +// variance returns the sample variance around the given mean. +// Empty and single-element vectors have zero variance by convention, +// which also avoids a division by zero in the n-1 denominator. +func (v Vector) variance(mean float64) float64 { + n := float64(len(v)) + + if n < 2 { + return 0 + } + + ss := 0.0 + + for _, f := range v { + d := f - mean + ss += d * d + } + + return ss / (n - 1) +} + +// Cor returns the Pearson correlation between two vectors. +func Cor(a, b Vector) (float64, error) { + n := float64(len(a)) + xy, err := Product(a, b) + + if err != nil { + return NaN(), err + } + + sx := a.Sd() + sy := b.Sd() + + mx := a.Mean() + my := b.Mean() + + r := (xy.Sum() - n*mx*my) / ((n - 1) * sx * sy) + + return r, nil +} diff --git a/pkg/vector/stats_test.go b/pkg/vector/stats_test.go new file mode 100644 index 000000000..3df5b9931 --- /dev/null +++ b/pkg/vector/stats_test.go @@ -0,0 +1,38 @@ +package vector + +import ( + "math" + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestVector_Variance(t *testing.T) { + t.Run("Values", func(t *testing.T) { + assert.InDelta(t, 32.0/7.0, Vector{2, 4, 4, 4, 5, 5, 7, 9}.Variance(), 0.00001) + }) + t.Run("Single", func(t *testing.T) { + assert.InDelta(t, 0.0, Vector{5}.Variance(), 0.00001) + }) + t.Run("Empty", func(t *testing.T) { + assert.InDelta(t, 0.0, Vector{}.Variance(), 0.00001) + }) +} + +func TestVector_Sd(t *testing.T) { + assert.InDelta(t, math.Sqrt(32.0/7.0), Vector{2, 4, 4, 4, 5, 5, 7, 9}.Sd(), 0.00001) + assert.InDelta(t, 0.0, Vector{5}.Sd(), 0.00001) +} + +func TestCor(t *testing.T) { + t.Run("PerfectPositive", func(t *testing.T) { + r, err := Cor(Vector{1, 2, 3}, Vector{2, 4, 6}) + assert.NoError(t, err) + assert.InDelta(t, 1.0, r, 0.00001) + }) + t.Run("LengthMismatch", func(t *testing.T) { + r, err := Cor(Vector{1, 2, 3}, Vector{1, 2}) + assert.Error(t, err) + assert.True(t, math.IsNaN(r)) + }) +} diff --git a/pkg/vector/values.go b/pkg/vector/values.go deleted file mode 100644 index 3f7b864d8..000000000 --- a/pkg/vector/values.go +++ /dev/null @@ -1,235 +0,0 @@ -package vector - -import ( - "fmt" - "math" -) - -// Copy returns a copy of the vector. -func (v Vector) Copy() Vector { - y := make(Vector, len(v)) - copy(y, v) - return y -} - -// Dim returns the number of values (dimension). -func (v Vector) Dim() int { - return len(v) -} - -// Sum returns the sum of the vector values. -func (v Vector) Sum() float64 { - s := 0.0 - - for _, f := range v { - s += f - } - - return s -} - -// weightedSum returns the weighted sum of the vector. This is really only useful in -// calculating the weighted mean. -func (v Vector) weightedSum(w Vector) (float64, error) { - if len(v) != len(w) { - return Epsilon, fmt.Errorf("length of weights unequal to vector length") - } - - ws := 0.0 - - for i := range v { - ws += v[i] * w[i] - } - - return ws, nil -} - -// Mean returns the vector's mean value. -func (v Vector) Mean() float64 { - return Mean(v) -} - -// GeometricMean returns the vector's geometric mean value. -func (v Vector) GeometricMean() float64 { - return GeometricMean(v) -} - -// HarmonicMean returns the vector's harmonic mean value. -func (v Vector) HarmonicMean() float64 { - return HarmonicMean(v) -} - -// WeightedMean returns the vector's weighted mean value based of the specified weights. -func (v Vector) WeightedMean(w Vector) (float64, error) { - ws, err := v.weightedSum(w) - - if err != nil { - return Epsilon, err - } - - sw := w.Sum() - - return ws / sw, nil -} - -// Sd calculates the vector's standard deviation. -func (v Vector) Sd() float64 { - return math.Sqrt(v.Variance()) -} - -// Variance calculates the vector's variance. -func (v Vector) Variance() float64 { - return v.variance(v.Mean()) -} - -// EuclideanDist returns the Euclidean distance between the vectors, -func (v Vector) EuclideanDist(w Vector) float64 { - return EuclideanDist(v, w) -} - -// CosineDist returns the cosine distance between two vectors. -func (v Vector) CosineDist(w Vector) float64 { - return CosineDist(v, w) -} - -// Norm returns the vector size (magnitude), -// see https://builtin.com/data-science/vector-norms. -func (v Vector) Norm(pow float64) float64 { - return Norm(v, pow) -} - -// EuclideanNorm returns the Euclidean vector size (magnitude), -// see https://builtin.com/data-science/vector-norms. -func (v Vector) EuclideanNorm() float64 { - return v.Norm(2.0) -} - -func (v Vector) variance(mean float64) float64 { - n := float64(len(v)) - - if n == 1 { - return 0 - } else if n < 2 { - n = 2 - } - - ss := 0.0 - - for _, f := range v { - ss += math.Pow(f-mean, 2.0) - } - - return ss / (n - 1) -} - -// Product returns a vector of element-wise products of two input vectors. -func Product(a, b Vector) (Vector, error) { - if len(a) != len(b) { - return nil, fmt.Errorf("vector dimensions do not match (%d, %d)", len(a), len(b)) - } - - p := make(Vector, len(a)) - - for i := range a { - p[i] = a[i] * b[i] - } - - return p, nil -} - -// DotProduct returns the dot product of two vectors. -func DotProduct(a, b Vector) (float64, error) { - p, err := Product(a, b) - - if err != nil { - return Epsilon, err - } - - return p.Sum(), nil -} - -// Norm returns the size of the vector (use pow = 2.0 for the Euclidean distance), -// see https://builtin.com/data-science/vector-norms. -func Norm(v Vector, pow float64) float64 { - s := 0.0 - - for _, f := range v { - s += math.Pow(f, pow) - } - - return math.Pow(s, 1/pow) -} - -// EuclideanDist returns the Euclidean distance between multiple vectors. -func EuclideanDist(a, b Vector) float64 { - if a.Dim() != b.Dim() { - return NaN() - } - - var ( - s, t float64 - ) - - for i := range a { - t = a[i] - b[i] - s += t * t - } - - return math.Sqrt(s) -} - -// CosineDist returns the CosineDist distance between two vectors. -func CosineDist(a, b Vector) float64 { - if a.Dim() != b.Dim() { - return NaN() - } - - var sum, s1, s2 float64 - - for i := range a { - sum += a[i] * b[i] - s1 += a[i] * a[i] - s2 += b[i] * b[i] - } - - if s1 == 0 || s2 == 0 { - return 0.0 - } - - return sum / (math.Sqrt(s1) * math.Sqrt(s2)) -} - -// CosineDists returns the cosine distances between two sets of vectors. -func CosineDists(x, y Vectors) Vectors { - result := make(Vectors, len(x)) - - for i, a := range x { - result[i] = make([]float64, len(y)) - - for j, b := range y { - result[i][j] = CosineDist(a, b) - } - } - - return result -} - -// Cor returns the Pearson correlation between two vectors. -func Cor(a, b Vector) (float64, error) { - n := float64(len(a)) - xy, err := Product(a, b) - - if err != nil { - return Epsilon, err - } - - sx := a.Sd() - sy := b.Sd() - - mx := a.Mean() - my := b.Mean() - - r := (xy.Sum() - n*mx*my) / ((n - 1) * sx * sy) - - return r, nil -} diff --git a/pkg/vector/values_test.go b/pkg/vector/values_test.go deleted file mode 100644 index 2e5442d97..000000000 --- a/pkg/vector/values_test.go +++ /dev/null @@ -1,100 +0,0 @@ -package vector - -import ( - "math" - "testing" - - "github.com/stretchr/testify/assert" -) - -func TestVector(t *testing.T) { - // Create test vectors. - a, err := NewVector([]int{1, 2, 3, 4, 6, 5}) - assert.NoError(t, err) - b, err := NewVector([]int{2, 1, 3, 4, 5, 6}) - assert.NoError(t, err) - c := Vector([]float64{-0.008137415163218975, -0.08006370067596436, 0.07025300711393356, 0.05047300457954407, -0.048540644347667694, 0.02255844883620739, -0.032381802797317505, -0.030422719195485115, -0.002007395029067993, 0.02374134585261345, 0.06882382184267044, -0.0014070027973502874, 0.0016334111569449306, -0.0006230792496353388, 0.024960000067949295, 0.05986246466636658, -0.024349741637706757, 0.04618404060602188, -0.08673757314682007, 0.05276675894856453, 0.0027138087898492813, 0.008117659948766232, -0.0037429891526699066, -0.01570519059896469, -0.13779018819332123, 0.06322789937257767, -0.058197781443595886, 0.04746529087424278, -0.08711255341768265, 0.019238201901316643, -0.05508963391184807, 0.017365770414471626, 0.02562207169830799, -0.002929446753114462, -0.07081708312034607, 0.03103666938841343, 0.0022698792163282633, 0.051838476210832596, 0.01691291667521, 0.005320006050169468, 0.030585378408432007, 0.06941074877977371, 0.008247891440987587, -0.03533969074487686, 0.05122591182589531, 0.04988280311226845, 0.08505327254533768, 0.04561468958854675, -0.062374748289585114, 0.022638529539108276, -0.022780820727348328, 0.0775931254029274, 0.02398429997265339, 0.03495755046606064, -0.012407658621668816, -0.03283195570111275, 0.06503018736839294, -0.03657644987106323, -0.029164006933569908, 0.058266233652830124, -0.019877741113305092, -0.04159046709537506, 0.0050654299557209015, -0.015958501026034355, -0.0295542161911726, 0.02208816446363926, 0.017241189256310463, -0.00469202920794487, -0.016516422852873802, 0.018105173483490944, 0.04346457123756409, 0.04661091789603233, 0.0091007174924016, -0.02539660967886448, -0.05948945879936218, 0.008711921982467175, -0.05822482705116272, 0.06004893407225609, -0.04515865445137024, -0.07707851380109787, 0.0032580809202045202, 0.006324823014438152, 0.02883482724428177, -0.01455928385257721, -0.03203008323907852, 0.010120648890733719, 0.02116110734641552, -0.028596824035048485, -0.06669415533542633, -0.03394141048192978, -0.021578358486294746, -0.0029677071142941713, -0.07965116947889328, -0.0005286909872666001, 0.048941437155008316, 0.05800784006714821, 0.042431481182575226, -0.03241220489144325, 0.0220502782613039, -0.03481437265872955, -0.04674076661467552, -0.004196728114038706, -0.07022743672132492, 0.07238440960645676, 0.04464253410696983, -0.04207949340343475, 0.021947475150227547, 0.013727233745157719, -0.06659548729658127, -0.00480034900829196, -0.010313994251191616, 0.02640429139137268, -0.0018985014175996184, -0.017516719177365303, 0.05424032732844353, 0.03034326806664467, -0.009059063158929348, -0.014670928940176964, 0.03108176961541176, -0.06324155628681183, 0.009439341723918915, -0.03230450302362442, 0.03011772409081459, -0.08903207629919052, 0.049357179552316666, -0.018093667924404144, -0.09150006622076035, 0.03277801349759102, -0.020068803802132607, -0.12405339628458023, 0.039792630821466446, -0.01258617639541626, -0.050734683871269226, 0.01388365589082241, -0.020610308274626732, -0.01117456890642643, -0.047699980437755585, 0.00904754176735878, -0.009436380118131638, 0.03356689587235451, 0.05179798603057861, -0.003932574763894081, 0.004325704649090767, 0.013883235864341259, -0.01672312431037426, -0.009120902046561241, 0.02865191549062729, -0.00018901238217949867, -0.14957121014595032, 0.06165143474936485, -0.010900797322392464, -0.04367987439036369, -0.08651748299598694, -0.04971740022301674, -0.012035397812724113, 0.05332765355706215, -0.03252051770687103, 0.027909329161047935, -0.043622151017189026, -0.03164845332503319, -0.03198356553912163, 0.05128004029393196, -0.040155746042728424, -0.0056242248974740505, -0.047345563769340515, 0.012517815455794334, -0.04241799935698509, -0.05661820247769356, 0.025342857465147972, -0.03272772207856178, -0.020752016454935074, 0.02841475047171116, 0.026285288855433464, -0.023260189220309258, 0.10821936279535294, 0.042671091854572296, 0.02412649802863598, -0.04032492637634277, 0.02996264584362507, -0.04249041527509689, -0.06933289021253586, 0.027393169701099396, 0.05308475345373154, -0.02078690193593502, -0.0067361886613070965, -0.0238595362752676, 0.01484128087759018, 0.021988647058606148, 0.06511303037405014, -0.08086460083723068, 0.03650467097759247, -0.021279210224747658, 0.045867037028074265, 0.06642837822437286, -0.003237910568714142, -0.01581430248916149, -0.02993408963084221, -0.0012522733304649591, -0.10658521205186844, -0.004413484595716, 0.014794287271797657, 0.04928160458803177, -0.029931025579571724, -0.0077111730352044106, -0.0732073038816452, 0.04210418090224266, -0.02385932393372059, 0.010084617882966995, -0.03800346329808235, -0.0682244822382927, 0.05564611777663231, 0.03370542451739311, 0.03176405653357506, -0.03024214692413807, 0.06749926507472992, -0.04842272028326988, 0.024823250249028206, 0.03411858156323433, 0.012186306528747082, 0.000344925036188215, 0.008661405183374882, -0.06331458687782288, -0.06190492585301399, -0.08768630772829056, 0.00041797355515882373, -0.018540306016802788, 0.04823239892721176, 0.06846356391906738, -0.03144964575767517, 0.03312361240386963, 0.023701541125774384, 0.06020048260688782, -0.018800485879182816, -0.01420025434345007, -0.01672394946217537, -0.016691889613866806, 0.011016116477549076, 0.013350298628211021, 0.01238208170980215, 0.01691477745771408, -0.0010262437863275409, 0.053074032068252563, 0.018735406920313835, 0.035321593284606934, -0.022181423380970955, -0.017033280804753304, 0.032775890082120895, 0.05400064215064049, -0.019599098712205887, -0.014503749087452888, -0.021623743698000908, -0.020413488149642944, 0.033719275146722794, 0.015080427750945091, 0.044618159532547, 0.10514744371175766, -0.07683298736810684, -0.04230527579784393, -0.04676186293363571, 0.1221809908747673, 0.018557196483016014, -0.10948510468006134, -0.007052143104374409, 0.03444751724600792, -0.12690776586532593, 0.01613660342991352, 0.026724737137556076, -0.01689913682639599, 0.032920803874731064, 0.0033084892202168703, -0.008477253839373589, 0.005826534237712622, 0.05720831826329231, -0.01001140009611845, 0.06672288477420807, -0.03293010592460632, -0.008007185533642769, 0.03565505892038345, -0.045379389077425, -0.01783432625234127, -0.06628750264644623, -0.0027283544186502695, 0.03038688562810421, -0.020332351326942444, -0.06984596699476242, 0.07357253134250641, 0.10730107873678207, -0.015427534468472004, -0.0743771567940712, -0.043926578015089035, 0.04178789258003235, 0.011173141188919544, 0.025277631357312202, 0.07788840681314468, 0.004462982527911663, -0.05092375725507736, -0.008599985390901566, -0.011293918825685978, -0.027740459889173508, -0.08115565031766891, -0.009694007225334644, -0.07026723772287369, 0.02862926386296749, 0.01975271850824356, 0.00902275275439024, 0.05126506835222244, -0.07478014379739761, 0.021499518305063248, 0.055629830807447433, 0.031052052974700928, 0.05949579179286957, -0.028020750731229782, -0.02862796001136303, 0.056453678756952286, -0.031041307374835014, 0.02422715350985527, -0.07100068032741547, 0.032912544906139374, 0.009702234528958797, 0.06579262763261795, -0.08040975034236908, 0.06385798007249832, -0.009425429627299309, 0.0210894588381052, 0.018046097829937935, 0.005574067123234272, -0.04380524903535843, 0.022144699469208717, 0.025359811261296272, 0.04807835817337036, 0.0006021010922268033, -0.07143598049879074, 0.020978737622499466, -0.05171458050608635, 0.0382511243224144, 0.025260137394070625, 0.09952495992183685, 0.014374740421772003, -0.03502845764160156, 0.008830498903989792, -0.06433495879173279, -0.07015430927276611, 0.0705648809671402, 0.010429518297314644, 0.01585286110639572, -0.056704264134168625, 0.00618960103020072, 0.03986428678035736, 0.003704571630805731, -0.015225011855363846, 0.008472353219985962, 0.07302212715148926, -0.020373830571770668, 0.003514211857691407, 0.013997740112245083, -0.0038872845470905304, -0.03703470155596733, -0.03875543549656868, -0.012492465786635876, 0.059783436357975006, 0.014407767914235592, 0.032212793827056885, 0.03943135216832161, -0.04783743992447853, -0.08073361217975616, 0.025175172835588455, -0.07072967290878296, 0.06343924254179001, 0.041898149996995926, -0.056953541934490204, 0.029663341119885445, 0.04826335236430168, 0.010070821270346642, -0.037220172584056854, 0.01026119664311409, 0.061207421123981476, 0.0938570499420166, -0.037144023925065994, 0.04894149303436279, -0.011274874210357666, -0.0167219378054142, -0.06375480443239212, 0.022223835811018944, -0.05070881545543671, 0.01647593080997467, -0.022871576249599457, 0.06493012607097626, -0.10572224110364914, -0.042038556188344955, -0.026631822809576988, 0.04876351356506348, 0.03300929814577103, 0.010545262135565281, -0.011176304891705513, -0.034550394862890244, 0.019394656643271446, -0.033105626702308655, -0.01746574230492115, 0.04380633309483528, 0.021436357870697975, -0.01687694527208805, 0.009079670533537865, -0.0019935970194637775, 0.02397148869931698, 0.020745644345879555, -0.021921435371041298, 0.013043859973549843, -0.001916338107548654, -0.04032173752784729, 0.010448900051414967, -0.01346014253795147, -0.048173755407333374, 0.0696289911866188, 0.0027435971423983574, -0.020373817533254623, 0.03318791463971138, -0.05028868094086647, -0.06621105223894119, 0.08377863466739655, -0.06662183254957199, 0.040066834539175034, -0.031038448214530945, -0.0012645371025428176, -0.08046844601631165, -0.07508288323879242, -0.011627450585365295, 0.05332736670970917, -0.050804637372493744, -0.02298901602625847, 0.017321497201919556, 0.04411279037594795, 0.02128334902226925, 0.026375887915492058, -0.006951047573238611, 0.026754219084978104, 0.04742620140314102, -0.01177502702921629, 0.060023725032806396, 0.005484475754201412, -0.00279219844378531, -0.09506803750991821, 0.08349333703517914, -0.02932984009385109, -0.0005634548142552376, -0.009349865838885307, -0.04879671335220337, 0.021670177578926086, -0.03875391557812691, -0.028711730614304543, -0.03708324581384659, -0.11263322830200195, -0.033891621977090836, 0.04228183254599571, 0.045042142271995544, 0.028116095811128616, 0.005323487799614668, 0.10822916775941849, -0.011182534508407116, -0.060331087559461594, -0.027081234380602837, -0.030490467324852943, -0.050583478063344955, 0.013974534347653389, -0.006292127538472414, 0.05019136518239975, 0.044325292110443115, 0.008860588073730469, 0.0005901191616430879, -0.04545517638325691, 0.028188807889819145, 0.02233756333589554, -0.07275871932506561, -0.04000203683972359, 0.05174611508846283, -0.050140008330345154, 0.017476622015237808, 0.0713571161031723, 0.042271941900253296, -0.004472524859011173, 0.0516694039106369, 0.07247994840145111, -0.027353506535291672, -0.024733062833547592, -0.049786582589149475, -0.01696055382490158, 0.06537499278783798, 0.04510447010397911, -0.04963269829750061, 0.018454866483807564, 0.03766272962093353, -0.08027862757444382, 0.06390812247991562, 0.009653930552303791, -0.017673317342996597, 0.008882815018296242, 0.001341609749943018, -0.0008363581146113575, 0.005991082638502121, 0.030882244929671288, -0.0010816589929163456, -0.043741147965192795, -0.02244267612695694, 0.020251808688044548, -0.008073689416050911, 0.0008555973181501031, -0.025090467184782028, 0.014763036742806435, 0.008378133177757263, 0.06943207234144211, 0.04518865421414375, -0.051252108067274094, 0.004460426978766918}) - d := Vector([]float64{0, 0, 0, 0, 0, 0}) - e := Vector([]float64{}) - n := make(Vector, 512) - - t.Run("Norm", func(t *testing.T) { - assert.InDelta(t, 9.539392014169456, a.EuclideanNorm(), 0.01) - assert.InDelta(t, 9.539392014169456, b.EuclideanNorm(), 0.01) - assert.Equal(t, a.EuclideanNorm(), b.EuclideanNorm()) - assert.InDelta(t, 0.9999999779072661, c.EuclideanNorm(), 0.01) - assert.InDelta(t, 0, d.EuclideanNorm(), 0.01) - assert.InDelta(t, 0, e.EuclideanNorm(), 0.01) - assert.Equal(t, d.EuclideanNorm(), e.EuclideanNorm()) - }) - t.Run("EuclideanDist", func(t *testing.T) { - assert.InDelta(t, 2, a.EuclideanDist(b), 0.01) - assert.InDelta(t, a.EuclideanDist(b), b.EuclideanDist(a), 0.01) - assert.True(t, math.IsNaN(c.EuclideanDist(d))) - assert.InDelta(t, 0, d.EuclideanDist(d), 0.01) - assert.True(t, math.IsNaN(e.EuclideanDist(d))) - assert.InDelta(t, 0.9999999779072661, c.EuclideanDist(n), 0.01) - }) - t.Run("CosineDist", func(t *testing.T) { - assert.InDelta(t, 0.978021978021978, a.CosineDist(b), 0.01) - assert.True(t, math.IsNaN(c.CosineDist(d))) - assert.InDelta(t, 0, d.CosineDist(d), 0.01) - assert.True(t, math.IsNaN(e.CosineDist(d))) - assert.InDelta(t, 0, c.CosineDist(n), 0.01) - assert.InDelta(t, 0, n.CosineDist(n), 0.01) - assert.InDelta(t, 1.0, c.CosineDist(c), 0.01) - assert.InDelta(t, 1.0, a.CosineDist(a), 0.01) - assert.InDelta(t, 1.0, b.CosineDist(b), 0.01) - }) - t.Run("Product", func(t *testing.T) { - _, err = Product(a, b) - assert.Equal(t, nil, err, "failed to calculate vector product") - }) - t.Run("DotProduct", func(t *testing.T) { - _, err = DotProduct(a, b) - assert.Equal(t, nil, err, "failed to calculate dot product") - }) - t.Run("EuclideanDist", func(t *testing.T) { - result := EuclideanDist(a, b) - assert.InDelta(t, 2.0, result, 0.01) - }) - t.Run("CosineDist", func(t *testing.T) { - result := CosineDist(a, b) - assert.InDelta(t, 0.978021978021978, result, 0.01) - }) - t.Run("Cor", func(t *testing.T) { - _, err = Cor(a, b) - assert.Equal(t, nil, err, "failed to calculate vector correlation") - }) -} - -func TestVector_CosineDist(t *testing.T) { - t.Run("Equal", func(t *testing.T) { - a := Vector([]float64{1, 0, 0, 1, 0, 0}) - b := Vector([]float64{1, 0, 0, 1, 0, 0}) - - result := CosineDist(a, b) - - t.Logf("cosine dist: %f", result) - - assert.InDelta(t, 1.000000, result, 0.00001) - }) - t.Run("Faces", func(t *testing.T) { - a := Vector([]float64{0.09050429612398148, -0.034165557473897934, 0.04864225909113884, -0.0072485702112317085, -0.023092104122042656, 0.027721818536520004, -0.054512765258550644, -0.011073374189436436, -0.10611298680305481, -0.09373591840267181, 0.05169020965695381, 0.022325381636619568, 0.0660574808716774, 0.0745176374912262, 0.033539049327373505, -0.05087396129965782, 0.03592195361852646, 0.048213306814432144, -0.022667650133371353, 0.03860087692737579, 0.05497220903635025, -0.07314137369394302, 0.0407942458987236, 0.007624434307217598, 0.026637494564056396, -0.02921448089182377, 0.0562191866338253, 0.0022813105024397373, 0.06954964995384216, 0.011513718403875828, 0.051686715334653854, -0.06144102290272713, -0.06638970226049423, 0.017356356605887413, -0.037446312606334686, 0.011931972578167915, -0.09081587195396423, 0.007885996252298355, 0.004822328686714172, 0.07497039437294006, -0.0758754089474678, 0.01736759953200817, -0.03094332665205002, -0.028449613600969315, 0.04941004887223244, 0.043144915252923965, 0.020656095817685127, 0.00013218115782365203, 0.010540441609919071, -0.005086455028504133, -0.045420411974191666, -0.012117994017899036, 0.027115555480122566, 0.09600701183080673, 0.024567779153585434, -0.036064546555280685, 0.047646667808294296, 0.010342034511268139, 0.042122356593608856, 0.011761351488530636, 0.02835131250321865, -0.04516693949699402, 0.04595448076725006, 0.03437191620469093, 0.11455260962247849, 0.03494664281606674, 0.004416515585035086, -0.07535701245069504, -0.012427383102476597, -0.0013752385275438428, -0.026557253673672676, 0.029679754748940468, 0.014478369615972042, -0.010105332359671593, -0.012286004610359669, 0.008126290515065193, 0.029303785413503647, -0.057241108268499374, 0.0033099683932960033, 0.01164975669234991, -0.007513932418078184, 0.0242016538977623, 0.05745712295174599, 0.028663545846939087, 0.03970225155353546, -0.023029271513223648, 0.02981036901473999, 0.03829219192266464, 0.03987501189112663, 0.017537616193294525, 0.02726835384964943, -0.013689219951629639, -0.04987820237874985, -0.040511664003133774, -0.021752934902906418, -0.07194412499666214, -0.051058970391750336, 0.023398589342832565, 0.03610694780945778, 0.00046719887177459896, 0.037188317626714706, -0.02566867135465145, 0.01604439504444599, -0.003634978784248233, 0.023078899830579758, 0.04129897058010101, -0.014649354852735996, 0.005342431832104921, -0.05193427577614784, -0.0388319157063961, -0.04907385632395744, 0.07699707895517349, -0.025095880031585693, 0.008442633785307407, 0.02021537348628044, 0.001264346414245665, -0.07380999624729156, -0.048401474952697754, -0.01882218010723591, -0.03912215307354927, -0.019224153831601143, 0.04983046278357506, -0.02566423825919628, -0.04404774308204651, 0.026545586064457893, -0.011196354404091835, -0.07557094842195511, -0.01379274670034647, 0.05286092683672905, 0.0013972970191389322, 0.006785087287425995, 0.011092058382928371, -0.05664386600255966, 0.08189822733402252, 0.01435012836009264, 0.0044399346224963665, -0.010694965720176697, 0.040221404284238815, -0.027927834540605545, -0.07454574108123779, 0.0553150437772274, 0.05394366756081581, -0.0033581850584596395, -0.024510426446795464, 0.008418681100010872, 0.03598837926983833, 0.01587156392633915, 0.0038127924781292677, 0.01119104865938425, 0.04693349450826645, 0.006098508834838867, -0.0017983769066631794, -0.04955652356147766, 0.09051105380058289, 0.0073089939542114735, -0.019370773807168007, 0.007884875871241093, -0.06199871003627777, -0.01850189082324505, -0.05228694528341293, -0.05400950461626053, -0.005632052198052406, 0.0020052779000252485, 0.03451100364327431, 0.036398425698280334, 0.05265820398926735, -0.011337222531437874, 0.013296777382493019, -0.0591934509575367, -0.06284786015748978, -0.0047112139873206615, -0.05348097160458565, 0.01298768911510706, -0.0456625372171402, -0.006065149325877428, -0.025567762553691864, -0.02817298099398613, -0.05127967894077301, -0.038833457976579666, 0.06326121836900711, 0.03279256448149681, -0.06116756424307823, -0.00897540058940649, -0.06233922019600868, 0.009809938259422779, -0.005387857090681791, -0.036401160061359406, -0.04316997900605202, -0.05489049851894379, -0.09730759263038635, -0.07952211797237396, 0.02321644127368927, 0.02643345668911934, -0.029610754922032356, -0.0429108701646328, 0.015382878482341766, -0.05127616599202156, -0.06552313268184662, 0.03043435700237751, -0.004739899653941393, -0.013985950499773026, 0.03178086504340172, -0.04262787476181984, 0.050286486744880676, 0.024078307673335075, -0.02595296874642372, -0.09277850389480591, -0.02931750938296318, 0.02375088632106781, -0.0027845173608511686, -0.007097273599356413, 0.013409079983830452, -0.037381891161203384, 0.030457323417067528, -0.05184711143374443, -0.008799600414931774, 0.02957642823457718, 0.05132228881120682, 0.060836631804704666, -0.000043339907279005274, -0.04915972426533699, -0.0038748879451304674, 0.008784785866737366, -0.020982224494218826, 0.06149329990148544, 0.02837146446108818, -0.044175948947668076, 0.06567257642745972, -0.03963049501180649, -0.07002358138561249, 0.006709821987897158, 0.05959227308630943, 0.03949318826198578, -0.014092321507632732, 0.09836959093809128, -0.07943648844957352, -0.009000610560178757, 0.0030425817240029573, 0.06436953693628311, -0.026696493849158287, 0.00682637095451355, -0.01507520116865635, 0.04695310816168785, 0.029429970309138298, 0.023842934519052505, -0.020885659381747246, -0.09611587971448898, -0.07405658066272736, -0.04233424365520477, -0.0011613338720053434, 0.057546716183423996, 0.03273669630289078, -0.048568133264780045, 0.0012128526577726007, 0.053861137479543686, -0.0350908562541008, 0.022841928526759148, 0.0620933435857296, -0.009771752171218395, 0.0021118440199643373, -0.028183909133076668, -0.0776321291923523, 0.018880240619182587, -0.028937598690390587, -0.04704895243048668, -0.041743259876966476, 0.07385464012622833, -0.05170309543609619, -0.028290364891290665, 0.02530353143811226, 0.01889736019074917, 0.026071889325976372, 0.035946063697338104, -0.05380414053797722, -0.04859302192926407, 0.0003545390209183097, 0.030886799097061157, -0.022649751976132393, 0.022308727726340294, -0.027548562735319138, 0.033452969044446945, -0.05277237668633461, -0.052690643817186356, 0.04759489372372627, 0.031058967113494873, 0.04526153579354286, 0.028865164145827293, -0.07438746839761734, 0.0024590680841356516, -0.028084587305784225, 0.02709362842142582, 0.013910548761487007, 0.03424328565597534, -0.02858562208712101, 0.0588177889585495, 0.01846511848270893, -0.037898849695920944, 0.042697105556726456, -0.013334364630281925, -0.0257448498159647, 0.12665124237537384, -0.019745446741580963, -0.002844252623617649, -0.03478461131453514, 0.014344505965709686, -0.02670290693640709, 0.011817696504294872, 0.048732347786426544, -0.0477047935128212, 0.06578560918569565, -0.06530530750751495, -0.09535658359527588, 0.02058124914765358, 0.0795418918132782, -0.011797895655035973, 0.03838758170604706, -0.03237924724817276, -0.10276861488819122, -0.030437085777521133, 0.12717247009277344, -0.011626948602497578, 0.015079738572239876, -0.011959588155150414, -0.05451022833585739, 0.009935147128999233, -0.02114112488925457, 0.02175278402864933, 0.03643997013568878, 0.0015244412934407592, 0.008756493218243122, 0.028317170217633247, -0.030474519357085228, -0.00388348544947803, -0.05619083344936371, 0.06022652983665466, -0.05782870203256607, -0.02699786052107811, 0.023685157299041748, -0.038485050201416016, 0.05153445899486542, -0.060548875480890274, -0.01506721694022417, -0.007553438656032085, 0.039509836584329605, 0.03681030124425888, 0.1338905692100525, -0.0035669414792209864, -0.012824718840420246, 0.08026544004678726, 0.0007068145787343383, 0.05609028413891792, -0.09387584030628204, 0.053474973887205124, -0.02244669944047928, -0.03398754075169563, 0.03549772873520851, -0.034875307232141495, -0.0047780852764844894, -0.0516449399292469, 0.061801642179489136, 0.019724003970623016, -0.05515078082680702, -0.039201926440000534, 0.06470708549022675, 0.04355214163661003, -0.033806391060352325, 0.0747586265206337, 0.008061372675001621, -0.031078290194272995, 0.02051386795938015, -0.010661521926522255, 0.007028735242784023, 0.052813757210969925, -0.014618860557675362, 0.010391696356236935, 0.01685873605310917, 0.005331454332917929, -0.05162535980343819, -0.014504718594253063, -0.026801610365509987, -0.00626059714704752, -0.06905800849199295, -0.10446352511644363, -0.05261509492993355, -0.04950559511780739, 0.013261653482913971, -0.025283565744757652, -0.03371249884366989, -0.009910509921610355, 0.05506015568971634, -0.0032501542009413242, 0.06410012394189835, -0.02705288864672184, 0.03838157281279564, -0.0028722372371703386, 0.10523688048124313, -0.005469444673508406, 0.0006657811463810503, -0.022171825170516968, 0.007440139539539814, -0.009108834899961948, 0.09758798778057098, 0.07208772003650665, -0.03589840233325958, 0.01901053451001644, 0.01944487728178501, -0.03779883682727814, -0.005568244960159063, -0.04835351184010506, 0.028863374143838882, 0.013382171280682087, 0.01990400068461895, -0.02292671613395214, 0.033316295593976974, 0.0007049285341054201, -0.08170327544212341, 0.005303904879838228, 0.017129195854067802, 0.048035942018032074, 0.0177064910531044, -0.07409890741109848, 0.002690644469112158, -0.09358572959899902, -0.02494824305176735, 0.005160054191946983, 0.01309937983751297, 0.01733747310936451, -0.028727075085043907, 0.07431124895811081, 0.019230933859944344, 0.044469334185123444, 0.07735494524240494, 0.014045624993741512, 0.02358667366206646, -0.029009323567152023, 0.011838157661259174, -0.03148479387164116, -0.02401883713901043, 0.07134886831045151, 0.03462617099285126, 0.09141889214515686, -0.032590366899967194, -0.017935005947947502, 0.01033404003828764, 0.021358856931328773, 0.052892062813043594, -0.016272393986582756, -0.0021813628263771534, -0.014650222845375538, 0.02733163721859455, 0.012284406460821629, -0.00011409903527237475, -0.0019222642295062542, 0.011368582025170326, 0.08538514375686646, 0.07764560729265213, -0.00016646491712890565, -0.021158777177333832, -0.003685612231492996, 0.0027680168859660625, -0.07727153599262238, -0.045435767620801926, 0.027570463716983795, 0.004876504186540842, -0.023479128256440163, -0.05900833383202553, 0.021972816437482834, 0.08244964480400085, -0.04722096025943756, 0.09820368885993958, -0.03607189655303955, 0.024602027609944344, 0.09130720794200897, 0.0060490816831588745, 0.003609518986195326, -0.05344478040933609, -0.013851549476385117, -0.0840664803981781, -0.07599852979183197, -0.04853493720293045, 0.02409926988184452, 0.007712183985859156, 0.047192711383104324, -0.02735353447496891, -0.0286621805280447, 0.051183052361011505, 0.026429185643792152, 0.047100841999053955, 0.07225227355957031, 0.05775126442313194, -0.07109982520341873, -0.019554149359464645, 0.004804393742233515, 0.07182382047176361, -0.05714774131774902, -0.03718779981136322, 0.010022906586527824, 0.040755949914455414, 0.035538796335458755, 0.0547688826918602, 0.018436597660183907, -0.009496998973190784, -0.034701500087976456, -0.07542424649000168, -0.024086780846118927, 0.03786386549472809, 0.08617071062326431, 0.061641909182071686, -0.10206557810306549, 0.008707753382623196, 0.07315801829099655, 0.017708826810121536}) - b := Vector([]float64{-0.008137415163218975, -0.08006370067596436, 0.07025300711393356, 0.05047300457954407, -0.048540644347667694, 0.02255844883620739, -0.032381802797317505, -0.030422719195485115, -0.002007395029067993, 0.02374134585261345, 0.06882382184267044, -0.0014070027973502874, 0.0016334111569449306, -0.0006230792496353388, 0.024960000067949295, 0.05986246466636658, -0.024349741637706757, 0.04618404060602188, -0.08673757314682007, 0.05276675894856453, 0.0027138087898492813, 0.008117659948766232, -0.0037429891526699066, -0.01570519059896469, -0.13779018819332123, 0.06322789937257767, -0.058197781443595886, 0.04746529087424278, -0.08711255341768265, 0.019238201901316643, -0.05508963391184807, 0.017365770414471626, 0.02562207169830799, -0.002929446753114462, -0.07081708312034607, 0.03103666938841343, 0.0022698792163282633, 0.051838476210832596, 0.01691291667521, 0.005320006050169468, 0.030585378408432007, 0.06941074877977371, 0.008247891440987587, -0.03533969074487686, 0.05122591182589531, 0.04988280311226845, 0.08505327254533768, 0.04561468958854675, -0.062374748289585114, 0.022638529539108276, -0.022780820727348328, 0.0775931254029274, 0.02398429997265339, 0.03495755046606064, -0.012407658621668816, -0.03283195570111275, 0.06503018736839294, -0.03657644987106323, -0.029164006933569908, 0.058266233652830124, -0.019877741113305092, -0.04159046709537506, 0.0050654299557209015, -0.015958501026034355, -0.0295542161911726, 0.02208816446363926, 0.017241189256310463, -0.00469202920794487, -0.016516422852873802, 0.018105173483490944, 0.04346457123756409, 0.04661091789603233, 0.0091007174924016, -0.02539660967886448, -0.05948945879936218, 0.008711921982467175, -0.05822482705116272, 0.06004893407225609, -0.04515865445137024, -0.07707851380109787, 0.0032580809202045202, 0.006324823014438152, 0.02883482724428177, -0.01455928385257721, -0.03203008323907852, 0.010120648890733719, 0.02116110734641552, -0.028596824035048485, -0.06669415533542633, -0.03394141048192978, -0.021578358486294746, -0.0029677071142941713, -0.07965116947889328, -0.0005286909872666001, 0.048941437155008316, 0.05800784006714821, 0.042431481182575226, -0.03241220489144325, 0.0220502782613039, -0.03481437265872955, -0.04674076661467552, -0.004196728114038706, -0.07022743672132492, 0.07238440960645676, 0.04464253410696983, -0.04207949340343475, 0.021947475150227547, 0.013727233745157719, -0.06659548729658127, -0.00480034900829196, -0.010313994251191616, 0.02640429139137268, -0.0018985014175996184, -0.017516719177365303, 0.05424032732844353, 0.03034326806664467, -0.009059063158929348, -0.014670928940176964, 0.03108176961541176, -0.06324155628681183, 0.009439341723918915, -0.03230450302362442, 0.03011772409081459, -0.08903207629919052, 0.049357179552316666, -0.018093667924404144, -0.09150006622076035, 0.03277801349759102, -0.020068803802132607, -0.12405339628458023, 0.039792630821466446, -0.01258617639541626, -0.050734683871269226, 0.01388365589082241, -0.020610308274626732, -0.01117456890642643, -0.047699980437755585, 0.00904754176735878, -0.009436380118131638, 0.03356689587235451, 0.05179798603057861, -0.003932574763894081, 0.004325704649090767, 0.013883235864341259, -0.01672312431037426, -0.009120902046561241, 0.02865191549062729, -0.00018901238217949867, -0.14957121014595032, 0.06165143474936485, -0.010900797322392464, -0.04367987439036369, -0.08651748299598694, -0.04971740022301674, -0.012035397812724113, 0.05332765355706215, -0.03252051770687103, 0.027909329161047935, -0.043622151017189026, -0.03164845332503319, -0.03198356553912163, 0.05128004029393196, -0.040155746042728424, -0.0056242248974740505, -0.047345563769340515, 0.012517815455794334, -0.04241799935698509, -0.05661820247769356, 0.025342857465147972, -0.03272772207856178, -0.020752016454935074, 0.02841475047171116, 0.026285288855433464, -0.023260189220309258, 0.10821936279535294, 0.042671091854572296, 0.02412649802863598, -0.04032492637634277, 0.02996264584362507, -0.04249041527509689, -0.06933289021253586, 0.027393169701099396, 0.05308475345373154, -0.02078690193593502, -0.0067361886613070965, -0.0238595362752676, 0.01484128087759018, 0.021988647058606148, 0.06511303037405014, -0.08086460083723068, 0.03650467097759247, -0.021279210224747658, 0.045867037028074265, 0.06642837822437286, -0.003237910568714142, -0.01581430248916149, -0.02993408963084221, -0.0012522733304649591, -0.10658521205186844, -0.004413484595716, 0.014794287271797657, 0.04928160458803177, -0.029931025579571724, -0.0077111730352044106, -0.0732073038816452, 0.04210418090224266, -0.02385932393372059, 0.010084617882966995, -0.03800346329808235, -0.0682244822382927, 0.05564611777663231, 0.03370542451739311, 0.03176405653357506, -0.03024214692413807, 0.06749926507472992, -0.04842272028326988, 0.024823250249028206, 0.03411858156323433, 0.012186306528747082, 0.000344925036188215, 0.008661405183374882, -0.06331458687782288, -0.06190492585301399, -0.08768630772829056, 0.00041797355515882373, -0.018540306016802788, 0.04823239892721176, 0.06846356391906738, -0.03144964575767517, 0.03312361240386963, 0.023701541125774384, 0.06020048260688782, -0.018800485879182816, -0.01420025434345007, -0.01672394946217537, -0.016691889613866806, 0.011016116477549076, 0.013350298628211021, 0.01238208170980215, 0.01691477745771408, -0.0010262437863275409, 0.053074032068252563, 0.018735406920313835, 0.035321593284606934, -0.022181423380970955, -0.017033280804753304, 0.032775890082120895, 0.05400064215064049, -0.019599098712205887, -0.014503749087452888, -0.021623743698000908, -0.020413488149642944, 0.033719275146722794, 0.015080427750945091, 0.044618159532547, 0.10514744371175766, -0.07683298736810684, -0.04230527579784393, -0.04676186293363571, 0.1221809908747673, 0.018557196483016014, -0.10948510468006134, -0.007052143104374409, 0.03444751724600792, -0.12690776586532593, 0.01613660342991352, 0.026724737137556076, -0.01689913682639599, 0.032920803874731064, 0.0033084892202168703, -0.008477253839373589, 0.005826534237712622, 0.05720831826329231, -0.01001140009611845, 0.06672288477420807, -0.03293010592460632, -0.008007185533642769, 0.03565505892038345, -0.045379389077425, -0.01783432625234127, -0.06628750264644623, -0.0027283544186502695, 0.03038688562810421, -0.020332351326942444, -0.06984596699476242, 0.07357253134250641, 0.10730107873678207, -0.015427534468472004, -0.0743771567940712, -0.043926578015089035, 0.04178789258003235, 0.011173141188919544, 0.025277631357312202, 0.07788840681314468, 0.004462982527911663, -0.05092375725507736, -0.008599985390901566, -0.011293918825685978, -0.027740459889173508, -0.08115565031766891, -0.009694007225334644, -0.07026723772287369, 0.02862926386296749, 0.01975271850824356, 0.00902275275439024, 0.05126506835222244, -0.07478014379739761, 0.021499518305063248, 0.055629830807447433, 0.031052052974700928, 0.05949579179286957, -0.028020750731229782, -0.02862796001136303, 0.056453678756952286, -0.031041307374835014, 0.02422715350985527, -0.07100068032741547, 0.032912544906139374, 0.009702234528958797, 0.06579262763261795, -0.08040975034236908, 0.06385798007249832, -0.009425429627299309, 0.0210894588381052, 0.018046097829937935, 0.005574067123234272, -0.04380524903535843, 0.022144699469208717, 0.025359811261296272, 0.04807835817337036, 0.0006021010922268033, -0.07143598049879074, 0.020978737622499466, -0.05171458050608635, 0.0382511243224144, 0.025260137394070625, 0.09952495992183685, 0.014374740421772003, -0.03502845764160156, 0.008830498903989792, -0.06433495879173279, -0.07015430927276611, 0.0705648809671402, 0.010429518297314644, 0.01585286110639572, -0.056704264134168625, 0.00618960103020072, 0.03986428678035736, 0.003704571630805731, -0.015225011855363846, 0.008472353219985962, 0.07302212715148926, -0.020373830571770668, 0.003514211857691407, 0.013997740112245083, -0.0038872845470905304, -0.03703470155596733, -0.03875543549656868, -0.012492465786635876, 0.059783436357975006, 0.014407767914235592, 0.032212793827056885, 0.03943135216832161, -0.04783743992447853, -0.08073361217975616, 0.025175172835588455, -0.07072967290878296, 0.06343924254179001, 0.041898149996995926, -0.056953541934490204, 0.029663341119885445, 0.04826335236430168, 0.010070821270346642, -0.037220172584056854, 0.01026119664311409, 0.061207421123981476, 0.0938570499420166, -0.037144023925065994, 0.04894149303436279, -0.011274874210357666, -0.0167219378054142, -0.06375480443239212, 0.022223835811018944, -0.05070881545543671, 0.01647593080997467, -0.022871576249599457, 0.06493012607097626, -0.10572224110364914, -0.042038556188344955, -0.026631822809576988, 0.04876351356506348, 0.03300929814577103, 0.010545262135565281, -0.011176304891705513, -0.034550394862890244, 0.019394656643271446, -0.033105626702308655, -0.01746574230492115, 0.04380633309483528, 0.021436357870697975, -0.01687694527208805, 0.009079670533537865, -0.0019935970194637775, 0.02397148869931698, 0.020745644345879555, -0.021921435371041298, 0.013043859973549843, -0.001916338107548654, -0.04032173752784729, 0.010448900051414967, -0.01346014253795147, -0.048173755407333374, 0.0696289911866188, 0.0027435971423983574, -0.020373817533254623, 0.03318791463971138, -0.05028868094086647, -0.06621105223894119, 0.08377863466739655, -0.06662183254957199, 0.040066834539175034, -0.031038448214530945, -0.0012645371025428176, -0.08046844601631165, -0.07508288323879242, -0.011627450585365295, 0.05332736670970917, -0.050804637372493744, -0.02298901602625847, 0.017321497201919556, 0.04411279037594795, 0.02128334902226925, 0.026375887915492058, -0.006951047573238611, 0.026754219084978104, 0.04742620140314102, -0.01177502702921629, 0.060023725032806396, 0.005484475754201412, -0.00279219844378531, -0.09506803750991821, 0.08349333703517914, -0.02932984009385109, -0.0005634548142552376, -0.009349865838885307, -0.04879671335220337, 0.021670177578926086, -0.03875391557812691, -0.028711730614304543, -0.03708324581384659, -0.11263322830200195, -0.033891621977090836, 0.04228183254599571, 0.045042142271995544, 0.028116095811128616, 0.005323487799614668, 0.10822916775941849, -0.011182534508407116, -0.060331087559461594, -0.027081234380602837, -0.030490467324852943, -0.050583478063344955, 0.013974534347653389, -0.006292127538472414, 0.05019136518239975, 0.044325292110443115, 0.008860588073730469, 0.0005901191616430879, -0.04545517638325691, 0.028188807889819145, 0.02233756333589554, -0.07275871932506561, -0.04000203683972359, 0.05174611508846283, -0.050140008330345154, 0.017476622015237808, 0.0713571161031723, 0.042271941900253296, -0.004472524859011173, 0.0516694039106369, 0.07247994840145111, -0.027353506535291672, -0.024733062833547592, -0.049786582589149475, -0.01696055382490158, 0.06537499278783798, 0.04510447010397911, -0.04963269829750061, 0.018454866483807564, 0.03766272962093353, -0.08027862757444382, 0.06390812247991562, 0.009653930552303791, -0.017673317342996597, 0.008882815018296242, 0.001341609749943018, -0.0008363581146113575, 0.005991082638502121, 0.030882244929671288, -0.0010816589929163456, -0.043741147965192795, -0.02244267612695694, 0.020251808688044548, -0.008073689416050911, 0.0008555973181501031, -0.025090467184782028, 0.014763036742806435, 0.008378133177757263, 0.06943207234144211, 0.04518865421414375, -0.051252108067274094, 0.004460426978766918}) - - result := CosineDist(a, b) - - t.Logf("cosine dist: %f", result) - assert.InDelta(t, -0.003275301858301365, result, 0.00001) - }) -} - -func BenchmarkCosineDist(b *testing.B) { - v1 := Vector([]float64{0.09050429612398148, -0.034165557473897934, 0.04864225909113884, -0.0072485702112317085, -0.023092104122042656, 0.027721818536520004, -0.054512765258550644, -0.011073374189436436, -0.10611298680305481, -0.09373591840267181, 0.05169020965695381, 0.022325381636619568, 0.0660574808716774, 0.0745176374912262, 0.033539049327373505, -0.05087396129965782, 0.03592195361852646, 0.048213306814432144, -0.022667650133371353, 0.03860087692737579, 0.05497220903635025, -0.07314137369394302, 0.0407942458987236, 0.007624434307217598, 0.026637494564056396, -0.02921448089182377, 0.0562191866338253, 0.0022813105024397373, 0.06954964995384216, 0.011513718403875828, 0.051686715334653854, -0.06144102290272713, -0.06638970226049423, 0.017356356605887413, -0.037446312606334686, 0.011931972578167915, -0.09081587195396423, 0.007885996252298355, 0.004822328686714172, 0.07497039437294006, -0.0758754089474678, 0.01736759953200817, -0.03094332665205002, -0.028449613600969315, 0.04941004887223244, 0.043144915252923965, 0.020656095817685127, 0.00013218115782365203, 0.010540441609919071, -0.005086455028504133, -0.045420411974191666, -0.012117994017899036, 0.027115555480122566, 0.09600701183080673, 0.024567779153585434, -0.036064546555280685, 0.047646667808294296, 0.010342034511268139, 0.042122356593608856, 0.011761351488530636, 0.02835131250321865, -0.04516693949699402, 0.04595448076725006, 0.03437191620469093, 0.11455260962247849, 0.03494664281606674, 0.004416515585035086, -0.07535701245069504, -0.012427383102476597, -0.0013752385275438428, -0.026557253673672676, 0.029679754748940468, 0.014478369615972042, -0.010105332359671593, -0.012286004610359669, 0.008126290515065193, 0.029303785413503647, -0.057241108268499374, 0.0033099683932960033, 0.01164975669234991, -0.007513932418078184, 0.0242016538977623, 0.05745712295174599, 0.028663545846939087, 0.03970225155353546, -0.023029271513223648, 0.02981036901473999, 0.03829219192266464, 0.03987501189112663, 0.017537616193294525, 0.02726835384964943, -0.013689219951629639, -0.04987820237874985, -0.040511664003133774, -0.021752934902906418, -0.07194412499666214, -0.051058970391750336, 0.023398589342832565, 0.03610694780945778, 0.00046719887177459896, 0.037188317626714706, -0.02566867135465145, 0.01604439504444599, -0.003634978784248233, 0.023078899830579758, 0.04129897058010101, -0.014649354852735996, 0.005342431832104921, -0.05193427577614784, -0.0388319157063961, -0.04907385632395744, 0.07699707895517349, -0.025095880031585693, 0.008442633785307407, 0.02021537348628044, 0.001264346414245665, -0.07380999624729156, -0.048401474952697754, -0.01882218010723591, -0.03912215307354927, -0.019224153831601143, 0.04983046278357506, -0.02566423825919628, -0.04404774308204651, 0.026545586064457893, -0.011196354404091835, -0.07557094842195511, -0.01379274670034647, 0.05286092683672905, 0.0013972970191389322, 0.006785087287425995, 0.011092058382928371, -0.05664386600255966, 0.08189822733402252, 0.01435012836009264, 0.0044399346224963665, -0.010694965720176697, 0.040221404284238815, -0.027927834540605545, -0.07454574108123779, 0.0553150437772274, 0.05394366756081581, -0.0033581850584596395, -0.024510426446795464, 0.008418681100010872, 0.03598837926983833, 0.01587156392633915, 0.0038127924781292677, 0.01119104865938425, 0.04693349450826645, 0.006098508834838867, -0.0017983769066631794, -0.04955652356147766, 0.09051105380058289, 0.0073089939542114735, -0.019370773807168007, 0.007884875871241093, -0.06199871003627777, -0.01850189082324505, -0.05228694528341293, -0.05400950461626053, -0.005632052198052406, 0.0020052779000252485, 0.03451100364327431, 0.036398425698280334, 0.05265820398926735, -0.011337222531437874, 0.013296777382493019, -0.0591934509575367, -0.06284786015748978, -0.0047112139873206615, -0.05348097160458565, 0.01298768911510706, -0.0456625372171402, -0.006065149325877428, -0.025567762553691864, -0.02817298099398613, -0.05127967894077301, -0.038833457976579666, 0.06326121836900711, 0.03279256448149681, -0.06116756424307823, -0.00897540058940649, -0.06233922019600868, 0.009809938259422779, -0.005387857090681791, -0.036401160061359406, -0.04316997900605202, -0.05489049851894379, -0.09730759263038635, -0.07952211797237396, 0.02321644127368927, 0.02643345668911934, -0.029610754922032356, -0.0429108701646328, 0.015382878482341766, -0.05127616599202156, -0.06552313268184662, 0.03043435700237751, -0.004739899653941393, -0.013985950499773026, 0.03178086504340172, -0.04262787476181984, 0.050286486744880676, 0.024078307673335075, -0.02595296874642372, -0.09277850389480591, -0.02931750938296318, 0.02375088632106781, -0.0027845173608511686, -0.007097273599356413, 0.013409079983830452, -0.037381891161203384, 0.030457323417067528, -0.05184711143374443, -0.008799600414931774, 0.02957642823457718, 0.05132228881120682, 0.060836631804704666, -0.000043339907279005274, -0.04915972426533699, -0.0038748879451304674, 0.008784785866737366, -0.020982224494218826, 0.06149329990148544, 0.02837146446108818, -0.044175948947668076, 0.06567257642745972, -0.03963049501180649, -0.07002358138561249, 0.006709821987897158, 0.05959227308630943, 0.03949318826198578, -0.014092321507632732, 0.09836959093809128, -0.07943648844957352, -0.009000610560178757, 0.0030425817240029573, 0.06436953693628311, -0.026696493849158287, 0.00682637095451355, -0.01507520116865635, 0.04695310816168785, 0.029429970309138298, 0.023842934519052505, -0.020885659381747246, -0.09611587971448898, -0.07405658066272736, -0.04233424365520477, -0.0011613338720053434, 0.057546716183423996, 0.03273669630289078, -0.048568133264780045, 0.0012128526577726007, 0.053861137479543686, -0.0350908562541008, 0.022841928526759148, 0.0620933435857296, -0.009771752171218395, 0.0021118440199643373, -0.028183909133076668, -0.0776321291923523, 0.018880240619182587, -0.028937598690390587, -0.04704895243048668, -0.041743259876966476, 0.07385464012622833, -0.05170309543609619, -0.028290364891290665, 0.02530353143811226, 0.01889736019074917, 0.026071889325976372, 0.035946063697338104, -0.05380414053797722, -0.04859302192926407, 0.0003545390209183097, 0.030886799097061157, -0.022649751976132393, 0.022308727726340294, -0.027548562735319138, 0.033452969044446945, -0.05277237668633461, -0.052690643817186356, 0.04759489372372627, 0.031058967113494873, 0.04526153579354286, 0.028865164145827293, -0.07438746839761734, 0.0024590680841356516, -0.028084587305784225, 0.02709362842142582, 0.013910548761487007, 0.03424328565597534, -0.02858562208712101, 0.0588177889585495, 0.01846511848270893, -0.037898849695920944, 0.042697105556726456, -0.013334364630281925, -0.0257448498159647, 0.12665124237537384, -0.019745446741580963, -0.002844252623617649, -0.03478461131453514, 0.014344505965709686, -0.02670290693640709, 0.011817696504294872, 0.048732347786426544, -0.0477047935128212, 0.06578560918569565, -0.06530530750751495, -0.09535658359527588, 0.02058124914765358, 0.0795418918132782, -0.011797895655035973, 0.03838758170604706, -0.03237924724817276, -0.10276861488819122, -0.030437085777521133, 0.12717247009277344, -0.011626948602497578, 0.015079738572239876, -0.011959588155150414, -0.05451022833585739, 0.009935147128999233, -0.02114112488925457, 0.02175278402864933, 0.03643997013568878, 0.0015244412934407592, 0.008756493218243122, 0.028317170217633247, -0.030474519357085228, -0.00388348544947803, -0.05619083344936371, 0.06022652983665466, -0.05782870203256607, -0.02699786052107811, 0.023685157299041748, -0.038485050201416016, 0.05153445899486542, -0.060548875480890274, -0.01506721694022417, -0.007553438656032085, 0.039509836584329605, 0.03681030124425888, 0.1338905692100525, -0.0035669414792209864, -0.012824718840420246, 0.08026544004678726, 0.0007068145787343383, 0.05609028413891792, -0.09387584030628204, 0.053474973887205124, -0.02244669944047928, -0.03398754075169563, 0.03549772873520851, -0.034875307232141495, -0.0047780852764844894, -0.0516449399292469, 0.061801642179489136, 0.019724003970623016, -0.05515078082680702, -0.039201926440000534, 0.06470708549022675, 0.04355214163661003, -0.033806391060352325, 0.0747586265206337, 0.008061372675001621, -0.031078290194272995, 0.02051386795938015, -0.010661521926522255, 0.007028735242784023, 0.052813757210969925, -0.014618860557675362, 0.010391696356236935, 0.01685873605310917, 0.005331454332917929, -0.05162535980343819, -0.014504718594253063, -0.026801610365509987, -0.00626059714704752, -0.06905800849199295, -0.10446352511644363, -0.05261509492993355, -0.04950559511780739, 0.013261653482913971, -0.025283565744757652, -0.03371249884366989, -0.009910509921610355, 0.05506015568971634, -0.0032501542009413242, 0.06410012394189835, -0.02705288864672184, 0.03838157281279564, -0.0028722372371703386, 0.10523688048124313, -0.005469444673508406, 0.0006657811463810503, -0.022171825170516968, 0.007440139539539814, -0.009108834899961948, 0.09758798778057098, 0.07208772003650665, -0.03589840233325958, 0.01901053451001644, 0.01944487728178501, -0.03779883682727814, -0.005568244960159063, -0.04835351184010506, 0.028863374143838882, 0.013382171280682087, 0.01990400068461895, -0.02292671613395214, 0.033316295593976974, 0.0007049285341054201, -0.08170327544212341, 0.005303904879838228, 0.017129195854067802, 0.048035942018032074, 0.0177064910531044, -0.07409890741109848, 0.002690644469112158, -0.09358572959899902, -0.02494824305176735, 0.005160054191946983, 0.01309937983751297, 0.01733747310936451, -0.028727075085043907, 0.07431124895811081, 0.019230933859944344, 0.044469334185123444, 0.07735494524240494, 0.014045624993741512, 0.02358667366206646, -0.029009323567152023, 0.011838157661259174, -0.03148479387164116, -0.02401883713901043, 0.07134886831045151, 0.03462617099285126, 0.09141889214515686, -0.032590366899967194, -0.017935005947947502, 0.01033404003828764, 0.021358856931328773, 0.052892062813043594, -0.016272393986582756, -0.0021813628263771534, -0.014650222845375538, 0.02733163721859455, 0.012284406460821629, -0.00011409903527237475, -0.0019222642295062542, 0.011368582025170326, 0.08538514375686646, 0.07764560729265213, -0.00016646491712890565, -0.021158777177333832, -0.003685612231492996, 0.0027680168859660625, -0.07727153599262238, -0.045435767620801926, 0.027570463716983795, 0.004876504186540842, -0.023479128256440163, -0.05900833383202553, 0.021972816437482834, 0.08244964480400085, -0.04722096025943756, 0.09820368885993958, -0.03607189655303955, 0.024602027609944344, 0.09130720794200897, 0.0060490816831588745, 0.003609518986195326, -0.05344478040933609, -0.013851549476385117, -0.0840664803981781, -0.07599852979183197, -0.04853493720293045, 0.02409926988184452, 0.007712183985859156, 0.047192711383104324, -0.02735353447496891, -0.0286621805280447, 0.051183052361011505, 0.026429185643792152, 0.047100841999053955, 0.07225227355957031, 0.05775126442313194, -0.07109982520341873, -0.019554149359464645, 0.004804393742233515, 0.07182382047176361, -0.05714774131774902, -0.03718779981136322, 0.010022906586527824, 0.040755949914455414, 0.035538796335458755, 0.0547688826918602, 0.018436597660183907, -0.009496998973190784, -0.034701500087976456, -0.07542424649000168, -0.024086780846118927, 0.03786386549472809, 0.08617071062326431, 0.061641909182071686, -0.10206557810306549, 0.008707753382623196, 0.07315801829099655, 0.017708826810121536}) - v2 := Vector([]float64{-0.008137415163218975, -0.08006370067596436, 0.07025300711393356, 0.05047300457954407, -0.048540644347667694, 0.02255844883620739, -0.032381802797317505, -0.030422719195485115, -0.002007395029067993, 0.02374134585261345, 0.06882382184267044, -0.0014070027973502874, 0.0016334111569449306, -0.0006230792496353388, 0.024960000067949295, 0.05986246466636658, -0.024349741637706757, 0.04618404060602188, -0.08673757314682007, 0.05276675894856453, 0.0027138087898492813, 0.008117659948766232, -0.0037429891526699066, -0.01570519059896469, -0.13779018819332123, 0.06322789937257767, -0.058197781443595886, 0.04746529087424278, -0.08711255341768265, 0.019238201901316643, -0.05508963391184807, 0.017365770414471626, 0.02562207169830799, -0.002929446753114462, -0.07081708312034607, 0.03103666938841343, 0.0022698792163282633, 0.051838476210832596, 0.01691291667521, 0.005320006050169468, 0.030585378408432007, 0.06941074877977371, 0.008247891440987587, -0.03533969074487686, 0.05122591182589531, 0.04988280311226845, 0.08505327254533768, 0.04561468958854675, -0.062374748289585114, 0.022638529539108276, -0.022780820727348328, 0.0775931254029274, 0.02398429997265339, 0.03495755046606064, -0.012407658621668816, -0.03283195570111275, 0.06503018736839294, -0.03657644987106323, -0.029164006933569908, 0.058266233652830124, -0.019877741113305092, -0.04159046709537506, 0.0050654299557209015, -0.015958501026034355, -0.0295542161911726, 0.02208816446363926, 0.017241189256310463, -0.00469202920794487, -0.016516422852873802, 0.018105173483490944, 0.04346457123756409, 0.04661091789603233, 0.0091007174924016, -0.02539660967886448, -0.05948945879936218, 0.008711921982467175, -0.05822482705116272, 0.06004893407225609, -0.04515865445137024, -0.07707851380109787, 0.0032580809202045202, 0.006324823014438152, 0.02883482724428177, -0.01455928385257721, -0.03203008323907852, 0.010120648890733719, 0.02116110734641552, -0.028596824035048485, -0.06669415533542633, -0.03394141048192978, -0.021578358486294746, -0.0029677071142941713, -0.07965116947889328, -0.0005286909872666001, 0.048941437155008316, 0.05800784006714821, 0.042431481182575226, -0.03241220489144325, 0.0220502782613039, -0.03481437265872955, -0.04674076661467552, -0.004196728114038706, -0.07022743672132492, 0.07238440960645676, 0.04464253410696983, -0.04207949340343475, 0.021947475150227547, 0.013727233745157719, -0.06659548729658127, -0.00480034900829196, -0.010313994251191616, 0.02640429139137268, -0.0018985014175996184, -0.017516719177365303, 0.05424032732844353, 0.03034326806664467, -0.009059063158929348, -0.014670928940176964, 0.03108176961541176, -0.06324155628681183, 0.009439341723918915, -0.03230450302362442, 0.03011772409081459, -0.08903207629919052, 0.049357179552316666, -0.018093667924404144, -0.09150006622076035, 0.03277801349759102, -0.020068803802132607, -0.12405339628458023, 0.039792630821466446, -0.01258617639541626, -0.050734683871269226, 0.01388365589082241, -0.020610308274626732, -0.01117456890642643, -0.047699980437755585, 0.00904754176735878, -0.009436380118131638, 0.03356689587235451, 0.05179798603057861, -0.003932574763894081, 0.004325704649090767, 0.013883235864341259, -0.01672312431037426, -0.009120902046561241, 0.02865191549062729, -0.00018901238217949867, -0.14957121014595032, 0.06165143474936485, -0.010900797322392464, -0.04367987439036369, -0.08651748299598694, -0.04971740022301674, -0.012035397812724113, 0.05332765355706215, -0.03252051770687103, 0.027909329161047935, -0.043622151017189026, -0.03164845332503319, -0.03198356553912163, 0.05128004029393196, -0.040155746042728424, -0.0056242248974740505, -0.047345563769340515, 0.012517815455794334, -0.04241799935698509, -0.05661820247769356, 0.025342857465147972, -0.03272772207856178, -0.020752016454935074, 0.02841475047171116, 0.026285288855433464, -0.023260189220309258, 0.10821936279535294, 0.042671091854572296, 0.02412649802863598, -0.04032492637634277, 0.02996264584362507, -0.04249041527509689, -0.06933289021253586, 0.027393169701099396, 0.05308475345373154, -0.02078690193593502, -0.0067361886613070965, -0.0238595362752676, 0.01484128087759018, 0.021988647058606148, 0.06511303037405014, -0.08086460083723068, 0.03650467097759247, -0.021279210224747658, 0.045867037028074265, 0.06642837822437286, -0.003237910568714142, -0.01581430248916149, -0.02993408963084221, -0.0012522733304649591, -0.10658521205186844, -0.004413484595716, 0.014794287271797657, 0.04928160458803177, -0.029931025579571724, -0.0077111730352044106, -0.0732073038816452, 0.04210418090224266, -0.02385932393372059, 0.010084617882966995, -0.03800346329808235, -0.0682244822382927, 0.05564611777663231, 0.03370542451739311, 0.03176405653357506, -0.03024214692413807, 0.06749926507472992, -0.04842272028326988, 0.024823250249028206, 0.03411858156323433, 0.012186306528747082, 0.000344925036188215, 0.008661405183374882, -0.06331458687782288, -0.06190492585301399, -0.08768630772829056, 0.00041797355515882373, -0.018540306016802788, 0.04823239892721176, 0.06846356391906738, -0.03144964575767517, 0.03312361240386963, 0.023701541125774384, 0.06020048260688782, -0.018800485879182816, -0.01420025434345007, -0.01672394946217537, -0.016691889613866806, 0.011016116477549076, 0.013350298628211021, 0.01238208170980215, 0.01691477745771408, -0.0010262437863275409, 0.053074032068252563, 0.018735406920313835, 0.035321593284606934, -0.022181423380970955, -0.017033280804753304, 0.032775890082120895, 0.05400064215064049, -0.019599098712205887, -0.014503749087452888, -0.021623743698000908, -0.020413488149642944, 0.033719275146722794, 0.015080427750945091, 0.044618159532547, 0.10514744371175766, -0.07683298736810684, -0.04230527579784393, -0.04676186293363571, 0.1221809908747673, 0.018557196483016014, -0.10948510468006134, -0.007052143104374409, 0.03444751724600792, -0.12690776586532593, 0.01613660342991352, 0.026724737137556076, -0.01689913682639599, 0.032920803874731064, 0.0033084892202168703, -0.008477253839373589, 0.005826534237712622, 0.05720831826329231, -0.01001140009611845, 0.06672288477420807, -0.03293010592460632, -0.008007185533642769, 0.03565505892038345, -0.045379389077425, -0.01783432625234127, -0.06628750264644623, -0.0027283544186502695, 0.03038688562810421, -0.020332351326942444, -0.06984596699476242, 0.07357253134250641, 0.10730107873678207, -0.015427534468472004, -0.0743771567940712, -0.043926578015089035, 0.04178789258003235, 0.011173141188919544, 0.025277631357312202, 0.07788840681314468, 0.004462982527911663, -0.05092375725507736, -0.008599985390901566, -0.011293918825685978, -0.027740459889173508, -0.08115565031766891, -0.009694007225334644, -0.07026723772287369, 0.02862926386296749, 0.01975271850824356, 0.00902275275439024, 0.05126506835222244, -0.07478014379739761, 0.021499518305063248, 0.055629830807447433, 0.031052052974700928, 0.05949579179286957, -0.028020750731229782, -0.02862796001136303, 0.056453678756952286, -0.031041307374835014, 0.02422715350985527, -0.07100068032741547, 0.032912544906139374, 0.009702234528958797, 0.06579262763261795, -0.08040975034236908, 0.06385798007249832, -0.009425429627299309, 0.0210894588381052, 0.018046097829937935, 0.005574067123234272, -0.04380524903535843, 0.022144699469208717, 0.025359811261296272, 0.04807835817337036, 0.0006021010922268033, -0.07143598049879074, 0.020978737622499466, -0.05171458050608635, 0.0382511243224144, 0.025260137394070625, 0.09952495992183685, 0.014374740421772003, -0.03502845764160156, 0.008830498903989792, -0.06433495879173279, -0.07015430927276611, 0.0705648809671402, 0.010429518297314644, 0.01585286110639572, -0.056704264134168625, 0.00618960103020072, 0.03986428678035736, 0.003704571630805731, -0.015225011855363846, 0.008472353219985962, 0.07302212715148926, -0.020373830571770668, 0.003514211857691407, 0.013997740112245083, -0.0038872845470905304, -0.03703470155596733, -0.03875543549656868, -0.012492465786635876, 0.059783436357975006, 0.014407767914235592, 0.032212793827056885, 0.03943135216832161, -0.04783743992447853, -0.08073361217975616, 0.025175172835588455, -0.07072967290878296, 0.06343924254179001, 0.041898149996995926, -0.056953541934490204, 0.029663341119885445, 0.04826335236430168, 0.010070821270346642, -0.037220172584056854, 0.01026119664311409, 0.061207421123981476, 0.0938570499420166, -0.037144023925065994, 0.04894149303436279, -0.011274874210357666, -0.0167219378054142, -0.06375480443239212, 0.022223835811018944, -0.05070881545543671, 0.01647593080997467, -0.022871576249599457, 0.06493012607097626, -0.10572224110364914, -0.042038556188344955, -0.026631822809576988, 0.04876351356506348, 0.03300929814577103, 0.010545262135565281, -0.011176304891705513, -0.034550394862890244, 0.019394656643271446, -0.033105626702308655, -0.01746574230492115, 0.04380633309483528, 0.021436357870697975, -0.01687694527208805, 0.009079670533537865, -0.0019935970194637775, 0.02397148869931698, 0.020745644345879555, -0.021921435371041298, 0.013043859973549843, -0.001916338107548654, -0.04032173752784729, 0.010448900051414967, -0.01346014253795147, -0.048173755407333374, 0.0696289911866188, 0.0027435971423983574, -0.020373817533254623, 0.03318791463971138, -0.05028868094086647, -0.06621105223894119, 0.08377863466739655, -0.06662183254957199, 0.040066834539175034, -0.031038448214530945, -0.0012645371025428176, -0.08046844601631165, -0.07508288323879242, -0.011627450585365295, 0.05332736670970917, -0.050804637372493744, -0.02298901602625847, 0.017321497201919556, 0.04411279037594795, 0.02128334902226925, 0.026375887915492058, -0.006951047573238611, 0.026754219084978104, 0.04742620140314102, -0.01177502702921629, 0.060023725032806396, 0.005484475754201412, -0.00279219844378531, -0.09506803750991821, 0.08349333703517914, -0.02932984009385109, -0.0005634548142552376, -0.009349865838885307, -0.04879671335220337, 0.021670177578926086, -0.03875391557812691, -0.028711730614304543, -0.03708324581384659, -0.11263322830200195, -0.033891621977090836, 0.04228183254599571, 0.045042142271995544, 0.028116095811128616, 0.005323487799614668, 0.10822916775941849, -0.011182534508407116, -0.060331087559461594, -0.027081234380602837, -0.030490467324852943, -0.050583478063344955, 0.013974534347653389, -0.006292127538472414, 0.05019136518239975, 0.044325292110443115, 0.008860588073730469, 0.0005901191616430879, -0.04545517638325691, 0.028188807889819145, 0.02233756333589554, -0.07275871932506561, -0.04000203683972359, 0.05174611508846283, -0.050140008330345154, 0.017476622015237808, 0.0713571161031723, 0.042271941900253296, -0.004472524859011173, 0.0516694039106369, 0.07247994840145111, -0.027353506535291672, -0.024733062833547592, -0.049786582589149475, -0.01696055382490158, 0.06537499278783798, 0.04510447010397911, -0.04963269829750061, 0.018454866483807564, 0.03766272962093353, -0.08027862757444382, 0.06390812247991562, 0.009653930552303791, -0.017673317342996597, 0.008882815018296242, 0.001341609749943018, -0.0008363581146113575, 0.005991082638502121, 0.030882244929671288, -0.0010816589929163456, -0.043741147965192795, -0.02244267612695694, 0.020251808688044548, -0.008073689416050911, 0.0008555973181501031, -0.025090467184782028, 0.014763036742806435, 0.008378133177757263, 0.06943207234144211, 0.04518865421414375, -0.051252108067274094, 0.004460426978766918}) - - for b.Loop() { - CosineDist(v1, v2) - } -} diff --git a/pkg/vector/vector.go b/pkg/vector/vector.go index 11cf4bf05..8c34a4291 100644 --- a/pkg/vector/vector.go +++ b/pkg/vector/vector.go @@ -1,3 +1,28 @@ +/* +Package vector provides floating-point vector types and math, including +distances, norms, means, and correlation. + +Copyright (c) 2018 - 2026 PhotoPrism UG. All rights reserved. + + This program is free software: you can redistribute it and/or modify + it under Version 3 of the GNU Affero General Public License (the "AGPL"): + <https://docs.photoprism.app/license/agpl> + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + The AGPL is supplemented by our Trademark and Brand Guidelines, + which describe how our Brand Assets may be used: + <https://www.photoprism.app/trademark/> + +Feel free to send an email to hello@photoprism.app if you have questions, +want to support our work, or just want to say hello. + +Additional information can be found in our Developer Guide: +<https://docs.photoprism.app/developer-guide/> +*/ package vector import ( @@ -36,7 +61,7 @@ func NewVector(values any) (Vector, error) { case []float64: return float64ToVector(v), nil case Vector: - return v, nil + return v.Copy(), nil default: return nil, fmt.Errorf("cannot create vector from type %T", values) } @@ -47,7 +72,30 @@ func NullVector(dim int) Vector { return make(Vector, dim) } -// uint8ToVector creates a new vector from a non-empty uint8 slice. +// Copy returns a copy of the vector. +func (v Vector) Copy() Vector { + y := make(Vector, len(v)) + copy(y, v) + return y +} + +// Dim returns the number of values (dimension). +func (v Vector) Dim() int { + return len(v) +} + +// Sum returns the sum of the vector values. +func (v Vector) Sum() float64 { + s := 0.0 + + for _, f := range v { + s += f + } + + return s +} + +// uint8ToVector creates a new vector from a uint8 slice. func uint8ToVector(values []uint8) Vector { v := make(Vector, len(values)) @@ -58,7 +106,7 @@ func uint8ToVector(values []uint8) Vector { return v } -// uint16ToVector creates a new vector from a non-empty uint16 slice. +// uint16ToVector creates a new vector from a uint16 slice. func uint16ToVector(values []uint16) Vector { v := make(Vector, len(values)) @@ -69,7 +117,7 @@ func uint16ToVector(values []uint16) Vector { return v } -// uint32ToVector creates a new vector from a non-empty uint32 slice. +// uint32ToVector creates a new vector from a uint32 slice. func uint32ToVector(values []uint32) Vector { v := make(Vector, len(values)) @@ -80,7 +128,7 @@ func uint32ToVector(values []uint32) Vector { return v } -// uint64ToVector creates a new vector from a non-empty uint64 slice. +// uint64ToVector creates a new vector from a uint64 slice. func uint64ToVector(values []uint64) Vector { v := make(Vector, len(values)) @@ -91,7 +139,7 @@ func uint64ToVector(values []uint64) Vector { return v } -// intToVector creates a new vector from a non-empty int slice. +// intToVector creates a new vector from a int slice. func intToVector(values []int) Vector { v := make(Vector, len(values)) @@ -102,7 +150,7 @@ func intToVector(values []int) Vector { return v } -// int8ToVector creates a new vector from a non-empty int8 slice. +// int8ToVector creates a new vector from a int8 slice. func int8ToVector(values []int8) Vector { v := make(Vector, len(values)) @@ -113,7 +161,7 @@ func int8ToVector(values []int8) Vector { return v } -// int16ToVector creates a new vector from a non-empty int16 slice. +// int16ToVector creates a new vector from a int16 slice. func int16ToVector(values []int16) Vector { v := make(Vector, len(values)) @@ -124,7 +172,7 @@ func int16ToVector(values []int16) Vector { return v } -// int32ToVector creates a new vector from a non-empty int32 slice. +// int32ToVector creates a new vector from a int32 slice. func int32ToVector(values []int32) Vector { v := make(Vector, len(values)) @@ -135,7 +183,7 @@ func int32ToVector(values []int32) Vector { return v } -// int64ToVector creates a new vector from a non-empty int64 slice. +// int64ToVector creates a new vector from a int64 slice. func int64ToVector(values []int64) Vector { v := make(Vector, len(values)) @@ -146,7 +194,7 @@ func int64ToVector(values []int64) Vector { return v } -// float32ToVector creates a new vector from a non-empty float32 slice. +// float32ToVector creates a new vector from a float32 slice. func float32ToVector(values []float32) Vector { v := make(Vector, len(values)) @@ -157,7 +205,11 @@ func float32ToVector(values []float32) Vector { return v } -// float64ToVector creates a new vector from a non-empty float64 slice. +// float64ToVector creates a new vector from a float64 slice. +// The values are copied so the result is independent of the input slice, +// consistent with the other type-specific converters. func float64ToVector(values []float64) Vector { - return Vector(values) + v := make(Vector, len(values)) + copy(v, values) + return v } diff --git a/pkg/vector/vector_test.go b/pkg/vector/vector_test.go index 047aefdaa..6b0aee921 100644 --- a/pkg/vector/vector_test.go +++ b/pkg/vector/vector_test.go @@ -22,9 +22,88 @@ func TestNewVector(t *testing.T) { assert.IsType(t, Vector{}, v) assert.NoError(t, err) }) + t.Run("Uint8", func(t *testing.T) { + v, err := NewVector([]uint8{1, 2, 3}) + assert.NoError(t, err) + assert.Equal(t, Vector{1, 2, 3}, v) + }) + t.Run("Uint16", func(t *testing.T) { + v, err := NewVector([]uint16{1, 2, 3}) + assert.NoError(t, err) + assert.Equal(t, Vector{1, 2, 3}, v) + }) + t.Run("Uint32", func(t *testing.T) { + v, err := NewVector([]uint32{1, 2, 3}) + assert.NoError(t, err) + assert.Equal(t, Vector{1, 2, 3}, v) + }) + t.Run("Uint64", func(t *testing.T) { + v, err := NewVector([]uint64{1, 2, 3}) + assert.NoError(t, err) + assert.Equal(t, Vector{1, 2, 3}, v) + }) + t.Run("Int8", func(t *testing.T) { + v, err := NewVector([]int8{-1, 2, 3}) + assert.NoError(t, err) + assert.Equal(t, Vector{-1, 2, 3}, v) + }) + t.Run("Int16", func(t *testing.T) { + v, err := NewVector([]int16{-1, 2, 3}) + assert.NoError(t, err) + assert.Equal(t, Vector{-1, 2, 3}, v) + }) + t.Run("Int32", func(t *testing.T) { + v, err := NewVector([]int32{-1, 2, 3}) + assert.NoError(t, err) + assert.Equal(t, Vector{-1, 2, 3}, v) + }) + t.Run("Int64", func(t *testing.T) { + v, err := NewVector([]int64{-1, 2, 3}) + assert.NoError(t, err) + assert.Equal(t, Vector{-1, 2, 3}, v) + }) + t.Run("Vector", func(t *testing.T) { + src := Vector{1, 2, 3} + v, err := NewVector(src) + assert.NoError(t, err) + assert.Equal(t, src, v) + }) t.Run("String", func(t *testing.T) { v, err := NewVector([]string{"a", "b", "c"}) assert.IsType(t, Vector{}, v) assert.Error(t, err) }) } + +func TestNewVector_Float64Copy(t *testing.T) { + // NewVector must return a vector independent of the source slice. + src := []float64{1, 2, 3} + v, err := NewVector(src) + assert.NoError(t, err) + src[0] = 99 + assert.Equal(t, Vector{1, 2, 3}, v) +} + +func TestNullVector(t *testing.T) { + v := NullVector(3) + assert.Equal(t, 3, v.Dim()) + assert.Equal(t, Vector{0, 0, 0}, v) +} + +func TestVector_Copy(t *testing.T) { + a := Vector{1, 2, 3} + b := a.Copy() + b[0] = 99 + assert.Equal(t, Vector{1, 2, 3}, a, "modifying the copy must not change the original") + assert.Equal(t, Vector{99, 2, 3}, b) +} + +func TestVector_Dim(t *testing.T) { + assert.Equal(t, 3, Vector{1, 2, 3}.Dim()) + assert.Equal(t, 0, Vector{}.Dim()) +} + +func TestVector_Sum(t *testing.T) { + assert.InDelta(t, 6.0, Vector{1, 2, 3}.Sum(), 0.00001) + assert.InDelta(t, 0.0, Vector{}.Sum(), 0.00001) +} diff --git a/scripts/check-api-request-limits.sh b/scripts/check-api-request-limits.sh new file mode 100755 index 000000000..dcc3358f8 --- /dev/null +++ b/scripts/check-api-request-limits.sh @@ -0,0 +1,83 @@ +#!/usr/bin/env bash + +set -euo pipefail + +ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" +WINDOW_LINES=15 +API_DIRS=( + "internal/api" + "plus/internal/api" + "pro/internal/api" + "portal/internal/api" +) + +violations=() + +# check_file flags request-body sinks not preceded within WINDOW_LINES by a +# LimitRequestBodyBytes call. Covered sinks: c.BindJSON / c.ShouldBindJSON, +# <name>.ServeHTTP(<writer>, c.Request), and direct io.ReadAll / +# json.NewDecoder / xml.NewDecoder / yaml.NewDecoder on c.Request.Body. +check_file() { + local file="$1" + local rel="${file#"$ROOT_DIR"/}" + local output + + output="$( + awk -v window="$WINDOW_LINES" ' + /^[[:space:]]*\/\// { next } + /^[[:space:]]*func[[:space:]]/ { last_limit = 0 } + /LimitRequestBodyBytes[[:space:]]*\(/ { last_limit = NR } + /c\.(BindJSON|ShouldBindJSON)\(/ { + if (last_limit == 0 || NR - last_limit > window) { + printf "%d:%s\n", NR, $0 + } + } + /[A-Za-z_][A-Za-z0-9_]*\.ServeHTTP[[:space:]]*\([^,]*,[[:space:]]*c\.Request[[:space:]]*\)/ { + if (last_limit == 0 || NR - last_limit > window) { + printf "%d:%s\n", NR, $0 + } + } + /(io\.ReadAll|io\.LimitReader|json\.NewDecoder|xml\.NewDecoder|yaml\.NewDecoder)[[:space:]]*\([[:space:]]*c\.Request\.Body[[:space:]]*\)/ { + if (last_limit == 0 || NR - last_limit > window) { + printf "%d:%s\n", NR, $0 + } + } + ' "$file" + )" + + if [ -z "$output" ]; then + return + fi + + while IFS= read -r line; do + violations+=("${rel}:${line}") + done <<< "$output" +} + +for dir in "${API_DIRS[@]}"; do + if [ ! -d "$ROOT_DIR/$dir" ]; then + continue + fi + + while IFS= read -r -d '' file; do + check_file "$file" + done < <(find "$ROOT_DIR/$dir" -type f -name '*.go' ! -name '*_test.go' -print0) +done + +if [ "${#violations[@]}" -gt 0 ]; then + echo "ERROR: API request-body sink without nearby LimitRequestBodyBytes detected:" + printf ' %s\n' "${violations[@]}" + echo + echo "Add LimitRequestBodyBytes(...) before one of:" + echo " * c.BindJSON(...) / c.ShouldBindJSON(...)" + echo " * <handler>.ServeHTTP(<writer>, c.Request)" + echo " * io.ReadAll(c.Request.Body) / json.NewDecoder(c.Request.Body) / ..." + echo + echo "On the BindJSON path, handle IsRequestBodyTooLarge(err) and" + echo "AbortRequestTooLarge(...). For SDK-delegated or direct-read paths," + echo "wrap the response writer to rewrite the upstream 400 -> 413 so the" + echo "response stays consistent with the rest of the JSON API." + exit 1 +fi + +echo "OK: All reviewed API request-body sinks have nearby LimitRequestBodyBytes calls." diff --git a/scripts/dav-probe.sh b/scripts/dav-probe.sh index 2076f3b2b..bffdb893a 100755 --- a/scripts/dav-probe.sh +++ b/scripts/dav-probe.sh @@ -139,7 +139,7 @@ main() { local http_mode local depth for http_mode in "--http2" "--http1.1"; do - for depth in 0 1; do + for depth in 0 1 infinity; do local label mode_name file mode_name="${http_mode#--}" label="propfind_${mode_name}_depth${depth}" diff --git a/scripts/dist/Makefile b/scripts/dist/Makefile index ba1d711a2..7442d10b0 100755 --- a/scripts/dist/Makefile +++ b/scripts/dist/Makefile @@ -59,6 +59,11 @@ amd: update install-amd install-amd: @echo "Installing AMD VA-API GPU Drivers..." apt-get -qq install mesa-va-drivers vainfo libva2 +vulkan: update install-vulkan +vulkan-drivers: vulkan +install-vulkan: + @echo "Installing Mesa Vulkan Drivers and Tools..." + apt-get -qq install mesa-vulkan-drivers vulkan-tools libvulkan1 clitools: update install-clitools cli-tools: clitools nano: clitools diff --git a/scripts/dist/build-libheif-deb.sh b/scripts/dist/build-libheif-deb.sh new file mode 100755 index 000000000..202f0e969 --- /dev/null +++ b/scripts/dist/build-libheif-deb.sh @@ -0,0 +1,217 @@ +#!/usr/bin/env bash + +# Builds a libheif Debian package (photoprism-libheif) from source. +# +# Produces a single .deb that ships the libheif shared library, headers, CLI +# tools (heif-dec, heif-enc, heif-info, heif-convert, heif-thumbnailer), and +# all codec plugins (aomdec/aomenc/dav1d/ffmpegdec/j2kdec/j2kenc/jpegdec/ +# jpegenc/libde265/rav1e/x265). Declares Provides:/Replaces:/Conflicts: for +# the distro-packaged libheif1, libheif-dev, libheif-examples, and +# libheif-plugin-* so apt's dependency solver treats the in-image install as +# a complete substitute and never pulls Canonical's older 1.21.2 alongside. +# +# Run inside a photoprism/develop:<codename> container that matches the +# target distro's libc / libstdc++ / codec ABI. Currently exercised against +# photoprism/develop:resolute (Ubuntu 26.04 LTS, libc 2.38, libstdc++ 13); +# other codenames need their own .deb because runtime soname pinning differs. +# +# docker run --rm --platform=amd64 --pull=always \ +# -v ".:/go/src/github.com/photoprism/photoprism" \ +# -e BUILD_ARCH=amd64 -e SYSTEM_ARCH=amd64 \ +# photoprism/develop:resolute ./scripts/dist/build-libheif-deb.sh v1.22.2 + +set -e + +if [[ ${1} == "--help" ]]; then + echo "Usage: ${0##*/} [version]" 1>&2 + exit 0 +fi + +CURRENT_DIR=$(pwd) + +# Determine target architecture. +if [[ $PHOTOPRISM_ARCH ]]; then + SYSTEM_ARCH=$PHOTOPRISM_ARCH +else + SYSTEM_ARCH=$(uname -m) +fi + +DESTARCH=${BUILD_ARCH:-$SYSTEM_ARCH} + +case $DESTARCH in + amd64 | AMD64 | x86_64 | x86-64) + DESTARCH=amd64 + MULTIARCH_TRIPLE=x86_64-linux-gnu + ;; + + arm64 | ARM64 | aarch64) + DESTARCH=arm64 + MULTIARCH_TRIPLE=aarch64-linux-gnu + ;; + + *) + echo "Unsupported Machine Architecture: \"$DESTARCH\"" 1>&2 + echo "Only amd64 and arm64 are supported for .deb packaging." 1>&2 + exit 1 + ;; +esac + +# shellcheck source=/dev/null +. /etc/os-release + +# Only Resolute (Ubuntu 26.04) is currently in the .deb matrix; abort early +# on other codenames to avoid silently producing a .deb that would dpkg -i +# onto a host with mismatched libc/libstdc++ sonames. +if [[ $VERSION_CODENAME != "resolute" ]]; then + echo "Error: ${0##*/} currently supports only VERSION_CODENAME=resolute," 1>&2 + echo " this container reports VERSION_CODENAME=$VERSION_CODENAME." 1>&2 + exit 1 +fi + +LATEST=$(curl --silent "https://api.github.com/repos/strukturag/libheif/releases/latest" | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/') +LIBHEIF_VERSION=${1:-$LATEST} +UPSTREAM_VERSION=${LIBHEIF_VERSION#v} +DEB_VERSION="${UPSTREAM_VERSION}-photoprism1" + +BUILD="libheif-${VERSION_CODENAME}-${DESTARCH}-${LIBHEIF_VERSION}" + +# Build tree (cmake/make scratch space) and Debian staging root. +WORK_DIR="${CURRENT_DIR}/build/${BUILD}-deb" +PKG_ROOT="${WORK_DIR}/pkg" +DEB_FILE="${CURRENT_DIR}/build/${BUILD}.deb" + +rm -rf "$WORK_DIR" +mkdir -p "$PKG_ROOT" + +echo "--------------------------------------------------------------------------------" +echo "VERSION : $LIBHEIF_VERSION" +echo "LATEST : $LATEST" +echo "CODENAME : $VERSION_CODENAME" +echo "ARCH : $DESTARCH ($MULTIARCH_TRIPLE)" +echo "DEB PACKAGE : photoprism-libheif $DEB_VERSION" +echo "DEB FILE : $DEB_FILE" +echo "--------------------------------------------------------------------------------" + +echo "Installing build dependencies..." + +sudo apt-get -qq update +sudo apt-get -qq install build-essential gcc g++ gettext git autoconf automake cmake libtool \ + libjpeg-dev libpng-dev libwebp-dev libde265-dev libaom-dev aom-tools libyuv-dev libavcodec-dev \ + libsharpyuv-dev librav1e-dev libdav1d-dev libx265-dev libbrotli-dev zlib1g-dev \ + dpkg-dev fakeroot + +cd "/tmp" || exit +rm -rf "/tmp/libheif" + +echo "Cloning libheif source..." +git clone -c advice.detachedHead=false -b "$LIBHEIF_VERSION" --depth 1 https://github.com/strukturag/libheif.git libheif +cd libheif || exit + +# Configure cmake with multiarch-aware install paths so the resulting .deb +# lands files where Debian/Ubuntu expect them and the embedded plugin loader +# search path (CMAKE_INSTALL_LIBDIR/libheif) matches the package layout. +mkdir build && cd build +cmake --preset=release \ + -DCMAKE_INSTALL_PREFIX=/usr \ + -DCMAKE_INSTALL_LIBDIR="lib/${MULTIARCH_TRIPLE}" \ + -DCMAKE_INSTALL_INCLUDEDIR=include \ + .. || exit 1 +make -j"$(nproc)" || exit 1 + +echo "Staging install tree at $PKG_ROOT..." +DESTDIR="$PKG_ROOT" make install +cd "$CURRENT_DIR" || exit +rm -rf "/tmp/libheif" + +# Replace any /usr/local prefix that may have leaked into .pc / .cmake files +# (CMAKE_INSTALL_PREFIX should have prevented this, but cheap defense). +find "$PKG_ROOT/usr/lib/${MULTIARCH_TRIPLE}/pkgconfig" "$PKG_ROOT/usr/lib/${MULTIARCH_TRIPLE}/cmake" \ + -type f \( -name "*.pc" -o -name "*.cmake" \) -exec \ + sed -i "s|/usr/local|/usr|g" {} \; 2>/dev/null || true + +# Compute the runtime libc / libstdc++ minimums from the build container so +# the Depends line matches what the binaries actually need. +LIBC_MIN=$(dpkg-query -W -f='${Version}' libc6 | sed -E 's/^([0-9]+\.[0-9]+).*/\1/') +LIBSTDCPP_MIN=$(dpkg-query -W -f='${Version}' libstdc++6 | sed -E 's/^([0-9]+).*/\1/') + +mkdir -p "$PKG_ROOT/DEBIAN" +mkdir -p "$PKG_ROOT/usr/share/doc/photoprism-libheif" + +cat > "$PKG_ROOT/DEBIAN/control" <<EOF +Package: photoprism-libheif +Source: libheif +Version: $DEB_VERSION +Architecture: $DESTARCH +Multi-Arch: same +Maintainer: PhotoPrism UG <hello@photoprism.app> +Section: libs +Priority: optional +Depends: libc6 (>= ${LIBC_MIN}), libgcc-s1, libstdc++6 (>= ${LIBSTDCPP_MIN}), zlib1g, libbrotli1, libsharpyuv0 +Recommends: libde265-0, libaom3, libdav1d7, libavcodec-extra +Provides: libheif1 (= ${UPSTREAM_VERSION}), libheif-dev (= ${UPSTREAM_VERSION}), libheif-examples (= ${UPSTREAM_VERSION}), libheif-plugin-aomdec (= ${UPSTREAM_VERSION}), libheif-plugin-aomenc (= ${UPSTREAM_VERSION}), libheif-plugin-libde265 (= ${UPSTREAM_VERSION}), libheif-plugin-x265 (= ${UPSTREAM_VERSION}), libheif-plugin-dav1d (= ${UPSTREAM_VERSION}) +Replaces: libheif1, libheif-dev, libheif-examples, libheif-plugin-aomdec, libheif-plugin-aomenc, libheif-plugin-libde265, libheif-plugin-x265, libheif-plugin-dav1d +Conflicts: libheif1, libheif-dev, libheif-examples, libheif-plugin-aomdec, libheif-plugin-aomenc, libheif-plugin-libde265, libheif-plugin-x265, libheif-plugin-dav1d +Homepage: https://github.com/strukturag/libheif +Description: HEIF and AVIF file format decoder/encoder (PhotoPrism build) + Built from upstream strukturag/libheif $LIBHEIF_VERSION by PhotoPrism's + build-libheif-deb.sh script. Includes the heif-dec, heif-enc, heif-info, + heif-convert, and heif-thumbnailer CLI tools, the libheif shared library, + the development headers, the pkg-config and CMake integration files, and + all codec plugins (aomdec, aomenc, dav1d, ffmpegdec, j2kdec, j2kenc, + jpegdec, jpegenc, libde265, rav1e, x265). + . + Supersedes the distribution-packaged libheif1, libheif-dev, libheif-examples, + and libheif-plugin-* packages. Provides those virtual package names so apt's + dependency solver treats the in-image install as a complete substitute. +EOF + +cat > "$PKG_ROOT/usr/share/doc/photoprism-libheif/copyright" <<EOF +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: libheif +Upstream-Contact: Dirk Farin <dirk.farin@gmail.com> +Source: https://github.com/strukturag/libheif + +Files: * +Copyright: 2017-2026 struktur AG +License: LGPL-3.0+ + libheif is free software: you can redistribute it and/or modify it under the + terms of the GNU Lesser General Public License as published by the Free + Software Foundation, either version 3 of the License, or (at your option) + any later version. See /usr/share/common-licenses/LGPL-3 for the full text. +EOF + +# Minimal Debian changelog (lintian wants this; we keep it terse since the +# package is rebuilt 1:1 per upstream release rather than carrying its own +# revision history). +cat > "${WORK_DIR}/changelog.Debian" <<EOF +photoprism-libheif (${DEB_VERSION}) unstable; urgency=medium + + * Repackaged upstream libheif ${LIBHEIF_VERSION} for PhotoPrism's + Resolute (Ubuntu 26.04) base image. Provides/Replaces/Conflicts + against distro libheif1, libheif-dev, libheif-examples, and + libheif-plugin-* so the apt solver picks this build as the single + libheif provider. + + -- PhotoPrism UG <hello@photoprism.app> $(date -R) +EOF +gzip -9n -c "${WORK_DIR}/changelog.Debian" > "$PKG_ROOT/usr/share/doc/photoprism-libheif/changelog.Debian.gz" + +# Set conservative ownership and permissions on the staged tree before dpkg-deb +# walks it; fakeroot keeps dpkg-deb happy without needing real root. +chmod -R u+rwX,go+rX,go-w "$PKG_ROOT" +find "$PKG_ROOT" -type d -exec chmod 755 {} \; +find "$PKG_ROOT/usr/share/doc" -type f -exec chmod 644 {} \; +find "$PKG_ROOT/DEBIAN" -type f -exec chmod 644 {} \; + +echo "Building $DEB_FILE..." +mkdir -p "${CURRENT_DIR}/build" +fakeroot dpkg-deb --build --root-owner-group "$PKG_ROOT" "$DEB_FILE" + +echo "--------------------------------------------------------------------------------" +dpkg-deb --info "$DEB_FILE" +echo "--------------------------------------------------------------------------------" +dpkg-deb --contents "$DEB_FILE" | head -40 +echo "..." +echo "--------------------------------------------------------------------------------" + +echo "Done. .deb at $DEB_FILE" diff --git a/scripts/dist/build-libheif.sh b/scripts/dist/build-libheif.sh index 94e6b1bb4..e75aae2f8 100755 --- a/scripts/dist/build-libheif.sh +++ b/scripts/dist/build-libheif.sh @@ -1,6 +1,7 @@ #!/usr/bin/env bash -# This builds the heif-convert, heif-enc, heif-info and heif-thumbnailer binaries from source. +# This builds the heif-dec, heif-enc, and heif-info binaries from source. +# On libheif 1.21+, heif-convert is a symlink to heif-dec and heif-thumbnailer is no longer shipped. # # To create ARMv7 binaries with Docker on Ubuntu 22.04 LTS, you can e.g. run the following: # @@ -66,7 +67,7 @@ echo "-------------------------------------------------------------------------- echo "Installing build dependencies..." sudo apt-get -qq update -sudo apt-get -qq install build-essential gcc g++ gettext git autoconf automake cmake libtool libjpeg-dev libpng-dev libwebp-dev libde265-dev libaom-dev libavcodec-dev +sudo apt-get -qq install build-essential gcc g++ gettext git autoconf automake cmake libtool libjpeg-dev libpng-dev libwebp-dev libde265-dev libaom-dev aom-tools libyuv-dev libavcodec-dev if [[ $VERSION_CODENAME == "noble" ]]; then sudo apt-get -qq install libsharpyuv-dev librav1e-dev @@ -78,10 +79,19 @@ rm -rf "/tmp/libheif" echo "Cloning git repository..." git clone -c advice.detachedHead=false -b "$LIBHEIF_VERSION" --depth 1 https://github.com/strukturag/libheif.git libheif cd libheif || exit -(mkdir build && cd build && cmake --preset=release ..) -make -C build -# Install heif-convert, heif-enc, heif-info, and heif-thumbnailer in "/usr/local". +EXTRA_CMAKE=() +if [[ $VERSION_CODENAME == "jammy" ]]; then + # Ubuntu 22.04 (Jammy) ships libdav1d 0.9.x, which predates the Dav1dSettings::n_threads + # field that libheif 1.21+ writes. Skip the dav1d plugin on Jammy; AV1 decode still works + # via the aomdec plugin. + EXTRA_CMAKE+=("-DWITH_DAV1D=OFF") +fi + +(mkdir build && cd build && cmake --preset=release "${EXTRA_CMAKE[@]}" ..) || exit 1 +make -C build || exit 1 + +# Install heif-dec, heif-enc, and heif-info in "/usr/local" (heif-convert is a symlink to heif-dec on 1.21+). echo "Installing binaries..." DESTDIR=$DESTDIR make -C build install cd "$CURRENT_DIR" || exit diff --git a/scripts/dist/create-users.sh b/scripts/dist/create-users.sh index af215f2f6..18f1547fc 100755 --- a/scripts/dist/create-users.sh +++ b/scripts/dist/create-users.sh @@ -39,16 +39,25 @@ echo "✅ Added group photoprism (1000)." # add existing www-data user to groups usermod -a -G photoprism,video,davfs2,renderd,render,ssl-cert,videodriver www-data +# a directory that will be used as a custom skeleton when creating users +SKELETON="/tmp/custom-skeleton" +mkdir --parents "${SKELETON}" + +# copy the .config/ directory from the default skeleton, if it exists +if [ -d /etc/skel/.config ]; then + cp -r /etc/skel/.config/ "${SKELETON}/.config/" +fi + # create user 'videodriver' userdel -r -f videodriver >/dev/null 2>&1 -useradd -u 937 -r -N -g 937 -G photoprism,www-data,video,davfs2,renderd,render,ssl-cert -s /bin/bash -m -d "/home/videodriver" videodriver +useradd -u 937 -r -N -g 937 -G photoprism,www-data,video,davfs2,renderd,render,ssl-cert -s /bin/bash -m -d "/home/videodriver" --skel "${SKELETON}" videodriver echo "✅ Added user videodriver (937)." # create user 'photoprism' userdel -r -f ubuntu >/dev/null 2>&1 userdel -r -f photoprism >/dev/null 2>&1 userdel -r -f 1000 >/dev/null 2>&1 -useradd -u 1000 -N -g photoprism -G www-data,video,davfs2,renderd,render,ssl-cert,videodriver -s /bin/bash -m -d "/home/photoprism" photoprism +useradd -u 1000 -N -g photoprism -G www-data,video,davfs2,renderd,render,ssl-cert,videodriver -s /bin/bash -m -d "/home/photoprism" --skel "${SKELETON}" photoprism echo "✅ Added user photoprism (1000)." add_user() @@ -56,7 +65,7 @@ add_user() userdel -r -f "user-$1" >/dev/null 2>&1 groupdel -f "group-$1" >/dev/null 2>&1 groupadd -f -g "$1" "group-$1" - useradd -u "$1" -g "$1" -G photoprism,www-data,video,davfs2,renderd,render,ssl-cert,videodriver -s /bin/bash -m -d "/home/user-$1" "user-$1" 2>/dev/null + useradd -u "$1" -g "$1" -G photoprism,www-data,video,davfs2,renderd,render,ssl-cert,videodriver -s /bin/bash -m -d "/home/user-$1" --skel "${SKELETON}" "user-$1" 2>/dev/null printf "." } @@ -73,4 +82,7 @@ printf " ✔\n" chgrp -f -R 1000 /home +# remove the custom skeleton +rm -rf "${SKELETON}" + echo "Done." diff --git a/scripts/dist/install-bashrc.sh b/scripts/dist/install-bashrc.sh new file mode 100755 index 000000000..3ed4df3ec --- /dev/null +++ b/scripts/dist/install-bashrc.sh @@ -0,0 +1,29 @@ +#!/usr/bin/env bash + +# Adds shell aliases and a custom prompt to /etc/bash.bashrc: +# bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-bashrc.sh) + +# Abort if not executed as root. +if [[ $(id -u) != "0" ]]; then + echo "Usage: run ${0##*/} as root" 1>&2 + exit 1 +fi + +set -e + +echo "Add ll alias and custom prompt in /etc/bash.bashrc" + +echo 'alias ll="ls -alh"' >> /etc/bash.bashrc +# shellcheck disable=SC2016 # $DOCKER_TAG is expanded at shell runtime, not here. +echo 'export PS1="\u@$DOCKER_TAG:\w\$ "' >> /etc/bash.bashrc + +echo "Add alias of go to richgo if it's available" + +# Source: https://stackoverflow.com/questions/592620/how-can-i-check-if-a-program-exists-from-a-bash-script/677212#677212 +if command -v richgo >/dev/null 2>&1; then + echo 'alias go=richgo' >> /etc/bash.bashrc +fi + +echo "Remove the unnecessary custom .bashrc for the root user" + +rm -f /root/.bashrc diff --git a/scripts/dist/install-chrome.sh b/scripts/dist/install-chrome.sh index 4e8b9fa48..6b9dbedb0 100755 --- a/scripts/dist/install-chrome.sh +++ b/scripts/dist/install-chrome.sh @@ -1,13 +1,76 @@ #!/usr/bin/env bash -# Installs Google Chrome on Linux. -# bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-chrome.sh) +# Installs a Chromium-based browser on Linux: +# - AMD64: Google Chrome stable (apt repo at dl.google.com). +# - ARM64: Chromium (native apt package; no snap). +# - Debian hosts: native apt chromium. +# - Ubuntu hosts: chromium from PhotoPrism's internal mirror at +# https://dl.photoprism.app/dist/chromium/. The mirror is a small +# reprepro tree of the XtraDeb PPA's chromium / chromium-driver / +# chromium-sandbox .debs (BSD-1-Clause); we mirror them so CI builds +# survive Launchpad outages. Ubuntu's own chromium-browser is a +# snap-shim transitional package and unusable in Docker. +# Upstream PPA: https://launchpad.net/~xtradeb/+archive/ubuntu/apps +# +# Override the ARM64 Ubuntu chromium source via env var: +# CHROMIUM_SOURCE=internal (default) — https://dl.photoprism.app/dist/chromium/ +# CHROMIUM_SOURCE=xtradeb — https://ppa.launchpadcontent.net/xtradeb/apps/ubuntu +# Use 'xtradeb' only when our mirror has fallen behind a chromium update +# (e.g. CVE patch landed at XtraDeb but cron hasn't refreshed yet). +# +# Distribution package set installed (named explicitly on the apt-get install +# line so a missing piece fails fast and visibly): +# - chromium — the browser binary +# - chromium-common — shared resources (strict-version Depends of chromium) +# - chromium-driver — chromedriver for headless / Selenium / TestCafe +# - chromium-sandbox — setuid sandbox helper +# +# Runtime library dependencies (transitively pulled in by apt). The exact +# package names drift between Ubuntu releases (jammy/noble/questing/resolute); +# the categories below stay stable. Confirm against +# `dpkg-deb -f chromium_*.deb Depends` +# on the relevant codename before bumping a base image. +# - GTK / GUI: libgtk-3-0[t64], libxnvctrl0, libxrandr2, libxkbcommon0, +# libxcomposite1, libxdamage1, libxfixes3, libxext6, +# libxcb1, libx11-6, libpango-1.0-0, libcairo2 +# - Accessibility: libatk1.0-0[t64], libatk-bridge2.0-0[t64], libatspi2.0-0[t64] +# - GPU / EGL: libgbm1 (>= 21.1.0), mesa-libgallium (transitive) +# - Crypto / TLS: libnss3 (>= 2:3.30), libnspr4 +# - Audio: libasound2[t64], libpulse0, libopus0, libflac8|12|14 +# - Codecs / images: libdav1d5|7, libopenh264-6|7|8, libopenjp2-7, +# liblcms2-2, libjpeg8, libfreetype6 +# - Compression: libzstd1 (>= 1.4 / 1.5.5), zlib1g, libminizip1[t64] +# - DBus / udev: libdbus-1-3, libudev1 +# - System: libc6, libgcc-s1, libcups2[t64], libfontconfig1, +# libdouble-conversion3, libexpat1, libgraphite2-3, +# libglib2.0-0[t64], libharfbuzz0b, libharfbuzz-subset0 +# +# In our build images these come from the standard Ubuntu archive; the slim +# variants of `photoprism/develop:*` deliberately exclude many of them, which +# is why chromium installs there fail with "libbsd0:arm64 is selected for +# removal" or similar dep-resolver errors. Install chromium only into the +# full (non-slim) develop images. +# +# This script must run as root. Use one of these invocations: +# +# # Pipe via stdin (recommended one-liner — works everywhere, incl. SSH): +# curl -fsSL https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-chrome.sh | sudo bash +# +# # Or download first and run: +# curl -fsSL https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-chrome.sh -o /tmp/install-chrome.sh +# sudo bash /tmp/install-chrome.sh +# +# Do NOT use process substitution under sudo (`sudo bash <(curl …)`): the +# substitution opens /dev/fd/63 in the *parent* (unprivileged) shell, which +# the elevated bash cannot read once sudo re-execs — the script aborts +# immediately with `bash: /dev/fd/63: No such file or directory`. PATH="/usr/local/sbin:/usr/sbin:/sbin:/usr/local/bin:/usr/bin:/bin:/scripts:$PATH" # Abort if not executed as root. if [[ $(id -u) != "0" ]]; then - echo "Usage: run ${0##*/} as root" 1>&2 + echo "Usage: ${0##*/} must run as root. Try:" 1>&2 + echo " curl -fsSL <url-to-this-script> | sudo bash" 1>&2 exit 1 fi @@ -23,16 +86,99 @@ DESTARCH=${BUILD_ARCH:-$SYSTEM_ARCH} # shellcheck source=/dev/null . /etc/os-release +# Adds PhotoPrism's internal chromium mirror as an apt source and installs +# chromium from it. Mirror is rebuilt from XtraDeb upstream weekly via +# `make -C services/downloads chromium` on web2 (services/downloads/scripts/). +install_chromium_from_internal_mirror() { + local keyring=/etc/apt/keyrings/photoprism-apt.gpg + local src=/etc/apt/sources.list.d/photoprism-chromium.sources + + install -m 0755 -d /etc/apt/keyrings + # PhotoPrism APT signing key (master): 99F2 9643 6E34 A5DD 1782 A5C9 7FE2 4EBF 235B EBF9 + curl -fsSL "https://dl.photoprism.app/dist/chromium/photoprism-apt.gpg.asc" \ + | gpg --no-tty --batch --yes --dearmor -o "$keyring" + + cat > "$src" <<EOF +Types: deb +URIs: https://dl.photoprism.app/dist/chromium +Suites: ${VERSION_CODENAME} +Components: main +Signed-By: ${keyring} +EOF + + apt-get update + apt-get -qq install -y --no-install-recommends \ + chromium chromium-common chromium-driver chromium-sandbox +} + +# Adds the XtraDeb PPA apt source and installs chromium from it. Fallback +# path used only when CHROMIUM_SOURCE=xtradeb. +install_chromium_from_xtradeb_ppa() { + local keyring=/etc/apt/keyrings/xtradeb-apps.gpg + local src=/etc/apt/sources.list.d/xtradeb-apps.sources + + install -m 0755 -d /etc/apt/keyrings + # PPA signing key fingerprint: 5301FA4FD93244FBC6F6149982BB6851C64F6880 + curl -fsSL "https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x5301FA4FD93244FBC6F6149982BB6851C64F6880" \ + | gpg --no-tty --batch --yes --dearmor -o "$keyring" + + cat > "$src" <<EOF +Types: deb +URIs: https://ppa.launchpadcontent.net/xtradeb/apps/ubuntu +Suites: ${VERSION_CODENAME} +Components: main +Signed-By: ${keyring} +EOF + + apt-get update + apt-get -qq install -y --no-install-recommends \ + chromium chromium-common chromium-driver chromium-sandbox +} + case $DESTARCH in amd64 | AMD64 | x86_64 | x86-64) echo "Installing Google Chrome (stable) on ${ID} for ${DESTARCH^^}..." set -e - curl -fsSL https://dl-ssl.google.com/linux/linux_signing_key.pub | gpg --dearmor -o /etc/apt/trusted.gpg.d/dl-ssl.google.com.gpg + curl -fsSL https://dl-ssl.google.com/linux/linux_signing_key.pub | gpg --no-tty --batch --yes --dearmor -o /etc/apt/trusted.gpg.d/dl-ssl.google.com.gpg sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google-chrome.list' apt-get update apt-get -qq install google-chrome-stable ;; + arm64 | ARM64 | aarch64) + set -e + case $ID in + debian) + echo "Installing Chromium on ${ID} for ${DESTARCH^^}..." + apt-get update + apt-get -qq install chromium chromium-common chromium-driver chromium-sandbox + ;; + + ubuntu) + apt-get -qq install -y --no-install-recommends ca-certificates curl gnupg + case "${CHROMIUM_SOURCE:-internal}" in + internal) + echo "Installing Chromium (via PhotoPrism internal mirror) on ${ID} ${VERSION_CODENAME:-} for ${DESTARCH^^}..." + install_chromium_from_internal_mirror + ;; + xtradeb) + echo "Installing Chromium (via XtraDeb PPA — fallback) on ${ID} ${VERSION_CODENAME:-} for ${DESTARCH^^}..." + install_chromium_from_xtradeb_ppa + ;; + *) + echo "Unknown CHROMIUM_SOURCE='${CHROMIUM_SOURCE}' (expected 'internal' or 'xtradeb')" 1>&2 + exit 1 + ;; + esac + ;; + + *) + echo "Unsupported distribution \"${ID}\" for ARM64 Chromium install" 1>&2 + exit 1 + ;; + esac + ;; + *) echo "Unsupported Machine Architecture: \"$DESTARCH\"" 1>&2 exit 0 diff --git a/scripts/dist/install-codex.sh b/scripts/dist/install-codex.sh index 5567dad2c..aafb4801d 100755 --- a/scripts/dist/install-codex.sh +++ b/scripts/dist/install-codex.sh @@ -30,9 +30,9 @@ fi # Some npm versions don’t support --location=global; detect and adapt if npm help install 2>/dev/null | grep -q -- '--location'; then - NPM_GLOBAL_OPTS=(install -g --location=global --no-fund --no-audit) + NPM_GLOBAL_OPTS=(install -g --location=global --ignore-scripts --no-fund --no-audit --no-update-notifier) else - NPM_GLOBAL_OPTS=(install -g --no-fund --no-audit) + NPM_GLOBAL_OPTS=(install -g --ignore-scripts --no-fund --no-audit --no-update-notifier) fi # Install / update Codex CLI diff --git a/scripts/dist/install-dircolors.sh b/scripts/dist/install-dircolors.sh index 3485a2cea..a12fe3025 100755 --- a/scripts/dist/install-dircolors.sh +++ b/scripts/dist/install-dircolors.sh @@ -298,13 +298,13 @@ EOF # Make sure file only writable by root, but readable by everyone chmod 644 /etc/dir_colors -# Activate colors in /etc/skel/.bashrc, if not done yet -if ! grep -q 'export SHELL=/bin/bash' /etc/skel/.bashrc; then - echo 'export SHELL=/bin/bash' >> /etc/skel/.bashrc +# Activate colors in /etc/bash.bashrc, if not done yet +if ! grep -q 'export SHELL=/bin/bash' /etc/bash.bashrc; then + echo 'export SHELL=/bin/bash' >> /etc/bash.bashrc fi # shellcheck disable=SC2016 -if ! grep -q 'eval "$(dircolors /etc/dir_colors)"' /etc/skel/.bashrc; then - echo 'eval "$(dircolors /etc/dir_colors)"' >> /etc/skel/.bashrc +if ! grep -q 'eval "$(dircolors /etc/dir_colors)"' /etc/bash.bashrc; then + echo 'eval "$(dircolors /etc/dir_colors)"' >> /etc/bash.bashrc fi echo "Done." diff --git a/scripts/dist/install-docker.sh b/scripts/dist/install-docker.sh index 0296dde01..e3b6b2a9f 100755 --- a/scripts/dist/install-docker.sh +++ b/scripts/dist/install-docker.sh @@ -20,7 +20,19 @@ echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker. # Install Docker with Compose Plugin. sudo apt-get update -sudo apt-get -qq install docker-ce docker-ce-cli docker-ce-rootless-extras containerd.io docker-buildx-plugin docker-compose-plugin cgroupfs-mount libltdl7 pigz + +# "cgroupfs-mount" was retired upstream once systemd took over cgroup v2 setup +# and is no longer shipped on Ubuntu 26.04 (resolute) / Debian trixie+. Include +# it only when apt has an installation candidate; "apt-cache show" is not enough +# because a phantom package record can linger with no installable version (seen +# on resolute), which makes the install line abort with "E: Package +# 'cgroupfs-mount' has no installation candidate" before Docker is installed. +EXTRA_PKGS="" +if apt-cache policy cgroupfs-mount 2>/dev/null | grep -q 'Candidate: [^(]'; then + EXTRA_PKGS="cgroupfs-mount" +fi + +sudo apt-get -qq install docker-ce docker-ce-cli docker-ce-rootless-extras containerd.io docker-buildx-plugin docker-compose-plugin $EXTRA_PKGS libltdl7 pigz # Add docker-compose alias for Compose Plugin. if [ ! -f "/bin/docker-compose" ]; then diff --git a/scripts/dist/install-doctl.sh b/scripts/dist/install-doctl.sh new file mode 100755 index 000000000..7e5887b4e --- /dev/null +++ b/scripts/dist/install-doctl.sh @@ -0,0 +1,105 @@ +#!/usr/bin/env bash + +# Downloads and installs the DigitalOcean CLI (doctl) on Linux. +# bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-doctl.sh) + +PATH="/usr/local/sbin:/usr/sbin:/sbin:/usr/local/bin:/usr/bin:/bin:/scripts:$PATH" + +# Show usage information? +if [[ ${1:-} == "--help" ]]; then + echo "${0##*/} [version] [destdir] downloads and installs doctl on Linux, for example:" 1>&2 + echo "${0##*/}" 1>&2 + echo "${0##*/} latest" 1>&2 + echo "${0##*/} 1.158.0 /usr/local" 1>&2 + exit 0 +fi + +set -Eeuo pipefail + +# Determine version to install (default: latest): +DOCTL_VERSION=${1:-latest} + +if [[ $DOCTL_VERSION == "latest" ]]; then + # Resolve "latest" via the releases/latest redirect (avoids GitHub API rate limit). + LATEST_URL=$(curl -fsSL -o /dev/null -w '%{url_effective}' https://github.com/digitalocean/doctl/releases/latest) + DOCTL_VERSION=${LATEST_URL##*/v} +fi + +# Strip leading "v" if user passed e.g. "v1.158.0": +DOCTL_VERSION=${DOCTL_VERSION#v} + +if [[ -z $DOCTL_VERSION ]]; then + echo "doctl version must be passed as first argument, e.g. 1.158.0" 1>&2 + exit 1 +fi + +# Determine destination directory: +DESTDIR=$(realpath "${2:-/usr/local}") + +# Determine the system architecture: +if [[ ${PHOTOPRISM_ARCH:-} ]]; then + SYSTEM_ARCH=$PHOTOPRISM_ARCH +else + SYSTEM_ARCH=$(uname -m) +fi + +DESTARCH=${BUILD_ARCH:-$SYSTEM_ARCH} + +case $DESTARCH in + amd64 | AMD64 | x86_64 | x86-64) + DESTARCH=amd64 + ;; + + arm64 | ARM64 | aarch64) + DESTARCH=arm64 + ;; + + arm | ARM | aarch | armv7l | armhf | armv6l | armel) + echo "doctl is not currently published for 32-bit ARM (armv6/armv7/armhf)." 1>&2 + echo "Use a 64-bit OS (arm64/aarch64) instead." 1>&2 + exit 1 + ;; + + *) + echo "Unsupported Machine Architecture: \"$DESTARCH\"" 1>&2 + exit 1 + ;; +esac + +# Sudo only if not already root: +SUDO="" +if [[ $(id -u) -ne 0 ]]; then + if command -v sudo >/dev/null 2>&1; then + SUDO="sudo" + else + echo "Run ${0##*/} as root or install sudo!" 1>&2 + exit 1 + fi +fi + +ARCHIVE="doctl-${DOCTL_VERSION}-linux-${DESTARCH}.tar.gz" +URL="https://github.com/digitalocean/doctl/releases/download/v${DOCTL_VERSION}/${ARCHIVE}" + +echo "Installing doctl ${DOCTL_VERSION} for ${DESTARCH^^} in \"${DESTDIR}/bin\". Please wait." +echo "URL: $URL" + +$SUDO mkdir -p "$DESTDIR/bin" + +# doctl tarball contains the doctl binary at the archive root. +TMPDIR=$(mktemp -d) +trap 'rm -rf "$TMPDIR"' EXIT + +curl -fsSL "$URL" | tar -xz -C "$TMPDIR" + +if [[ ! -f "$TMPDIR/doctl" ]]; then + echo "doctl binary not found in archive" 1>&2 + exit 1 +fi + +$SUDO install -m 755 "$TMPDIR/doctl" "$DESTDIR/bin/doctl" + +# Test doctl by showing installed version: +echo "Installed doctl version:" +"$DESTDIR/bin/doctl" version | head -n 1 + +echo "Done." diff --git a/scripts/dist/install-gh.sh b/scripts/dist/install-gh.sh index de660e32d..b96a2fa7d 100755 --- a/scripts/dist/install-gh.sh +++ b/scripts/dist/install-gh.sh @@ -37,6 +37,8 @@ if [[ "$(id -u)" -ne 0 ]]; then fi export DEBIAN_FRONTEND="noninteractive" +export DO_NOT_TRACK="true" +export GH_TELEMETRY="false" if ! command -v wget >/dev/null 2>&1; then ${SUDO} apt-get update diff --git a/scripts/dist/install-gitleaks.sh b/scripts/dist/install-gitleaks.sh new file mode 100755 index 000000000..c4664a832 --- /dev/null +++ b/scripts/dist/install-gitleaks.sh @@ -0,0 +1,160 @@ +#!/usr/bin/env bash + +# Installs the Gitleaks credential leak scanner on Linux. +# bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-gitleaks.sh) +# bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-gitleaks.sh) -- --version v8.30.1 +# bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-gitleaks.sh) -- /opt/photoprism + +set -euo pipefail + +REPO="gitleaks/gitleaks" +TOOL="gitleaks" + +if ! command -v jq >/dev/null 2>&1; then + echo "Error: jq is required but not installed." 1>&2 + exit 1 +fi + +if [[ ${1:-} == "--help" ]]; then + echo "Usage: ${0##*/} [--version <tag>] [destdir]" 1>&2 + echo "" 1>&2 + echo "Environment:" 1>&2 + echo " PHOTOPRISM_ARCH=amd64|arm64" 1>&2 + exit 0 +fi + +VERSION="latest" + +while [[ $# -gt 0 ]]; do + case $1 in + --version) + VERSION=${2:-} + if [[ -z $VERSION ]]; then + echo "Error: --version requires a tag (e.g. v8.30.1)." 1>&2 + exit 1 + fi + shift 2 + ;; + --help) + echo "Usage: ${0##*/} [--version <tag>] [destdir]" 1>&2 + exit 0 + ;; + --) + shift + break + ;; + -*) + echo "Error: Unknown option: $1" 1>&2 + exit 1 + ;; + *) + break + ;; + esac +done + +DESTDIR=$(realpath "${1:-/usr/local}") + +if [[ -n ${PHOTOPRISM_ARCH:-} ]]; then + SYSTEM_ARCH=$PHOTOPRISM_ARCH +else + SYSTEM_ARCH=$(uname -m) +fi +DESTARCH=${BUILD_ARCH:-$SYSTEM_ARCH} + +# Gitleaks tarball asset names embed the architecture but NOT (always) "linux"; +# resolve them via the GitHub API so we don't have to hardcode version tags. +case $DESTARCH in + amd64 | AMD64 | x86_64 | x86-64) + ASSET_ARCH="x64" + ;; + arm64 | ARM64 | aarch64) + ASSET_ARCH="arm64" + ;; + *) + echo "Unsupported Machine Architecture: \"$DESTARCH\"" 1>&2 + exit 1 + ;; +esac + +if [[ $(id -u) != "0" ]] && [[ $DESTDIR == "/usr" || $DESTDIR == "/usr/local" ]]; then + echo "Error: Run ${0##*/} as root to install in a system directory!" 1>&2 + exit 1 +fi + +if [[ $VERSION == "latest" ]]; then + RELEASE_API="https://api.github.com/repos/${REPO}/releases/latest" +else + RELEASE_API="https://api.github.com/repos/${REPO}/releases/tags/${VERSION}" +fi + +RELEASE_JSON=$(curl --fail --silent --show-error "${RELEASE_API}" || true) +if [[ -z $RELEASE_JSON ]]; then + echo "Error: Unable to fetch release metadata from ${RELEASE_API}." 1>&2 + exit 1 +fi + +TAG_NAME=$(echo "${RELEASE_JSON}" | jq -r '.tag_name // empty') +ASSET_NAME=$(echo "${RELEASE_JSON}" | jq -r --arg arch "linux_${ASSET_ARCH}.tar.gz" \ + '.assets[]? | select(.name | endswith($arch)) | .name' | head -n1) +ASSET_URL=$(echo "${RELEASE_JSON}" | jq -r --arg name "${ASSET_NAME}" \ + '.assets[]? | select(.name == $name) | .browser_download_url' | head -n1) +CHECKSUM_NAME=$(echo "${RELEASE_JSON}" | jq -r \ + '.assets[]? | select(.name | test("checksums.txt$")) | .name' | head -n1) +CHECKSUM_URL=$(echo "${RELEASE_JSON}" | jq -r --arg name "${CHECKSUM_NAME}" \ + '.assets[]? | select(.name == $name) | .browser_download_url' | head -n1) + +if [[ -z ${TAG_NAME} || -z ${ASSET_URL} ]]; then + echo "Error: Could not resolve a downloadable asset for architecture ${DESTARCH}." 1>&2 + exit 1 +fi + +DESTBIN="${DESTDIR}/bin/${TOOL}" + +echo "--------------------------------------------------------------------------------" +echo "VERSION : ${TAG_NAME}" +echo "ASSET : ${ASSET_NAME}" +echo "DOWNLOAD : ${ASSET_URL}" +echo "DESTBIN : ${DESTBIN}" +echo "--------------------------------------------------------------------------------" + +echo "Downloading ${TOOL} to \"${DESTBIN}\"..." +mkdir -p "${DESTDIR}/bin" +tmp_dir=$(mktemp -d) +trap 'rm -rf "${tmp_dir}"' EXIT + +curl --fail --silent --show-error --location "${ASSET_URL}" -o "${tmp_dir}/${ASSET_NAME}" + +if [[ -n "${CHECKSUM_URL}" ]]; then + curl --fail --silent --show-error --location "${CHECKSUM_URL}" -o "${tmp_dir}/checksums.txt" + expected=$(awk -v want="${ASSET_NAME}" '$2 == want {print $1; exit}' "${tmp_dir}/checksums.txt") + if [[ -z "${expected}" ]]; then + echo "Warning: ${ASSET_NAME} not listed in ${CHECKSUM_NAME}; skipping verification." 1>&2 + else + actual=$(sha256sum "${tmp_dir}/${ASSET_NAME}" | awk '{print $1}') + if [[ "${expected}" != "${actual}" ]]; then + echo "Error: SHA-256 mismatch for ${TOOL} (${ASSET_NAME})." 1>&2 + echo " expected: ${expected}" 1>&2 + echo " actual: ${actual}" 1>&2 + exit 1 + fi + echo "Checksum OK (${actual})." + fi +else + echo "Warning: no published checksums file found for ${TAG_NAME}; skipping verification." 1>&2 +fi + +tar -xzf "${tmp_dir}/${ASSET_NAME}" -C "${tmp_dir}" + +if [[ ! -f "${tmp_dir}/${TOOL}" ]]; then + echo "Error: ${TOOL} binary not found inside ${ASSET_NAME}." 1>&2 + exit 1 +fi + +install -m 755 "${tmp_dir}/${TOOL}" "${DESTBIN}" + +if command -v "${TOOL}" >/dev/null 2>&1; then + "${TOOL}" version | head -n 1 +fi + +echo "Done." diff --git a/scripts/dist/install-gpu.sh b/scripts/dist/install-gpu.sh index c4b531b8f..cc83c17bb 100755 --- a/scripts/dist/install-gpu.sh +++ b/scripts/dist/install-gpu.sh @@ -52,16 +52,23 @@ for t in ${GPU_DETECTED[@]}; do case $t in i915 | i965 | intel | opencl | icd) echo "Installing Intel GPU Drivers..." - apt-get -qq install intel-opencl-icd intel-media-va-driver-non-free i965-va-driver-shaders mesa-va-drivers libmfx-gen1.2 va-driver-all vainfo libva2 libvpl2 + # VA-API/QSV (h264_vaapi, h264_qsv) plus the Mesa ANV Vulkan driver and tools (h264_vulkan). + apt-get -qq install intel-opencl-icd intel-media-va-driver-non-free i965-va-driver-shaders mesa-va-drivers libmfx-gen1.2 va-driver-all vainfo libva2 libvpl2 mesa-vulkan-drivers vulkan-tools ;; nvidia) - echo "NVIDIA Container Toolkit must be installed: https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html" + # The NVIDIA driver and its Vulkan ICD are provided by the NVIDIA Container Toolkit, not apt; + # we only add the Vulkan loader and tools so h264_vulkan can run and be verified with vulkaninfo. + echo "Installing NVIDIA Vulkan loader and tools..." + apt-get -qq install libvulkan1 vulkan-tools + echo "NVIDIA Container Toolkit must be installed on the host: https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html" + echo "For Vulkan transcoding (h264_vulkan), the container's NVIDIA_DRIVER_CAPABILITIES must include \"graphics\" (or \"all\") in addition to \"video\"/\"compute\"." ;; - + amdgpu) - echo "Installing AMD VA-API GPU Drivers..." - apt-get -qq install mesa-va-drivers vainfo libva2 + echo "Installing AMD VA-API and Vulkan GPU Drivers..." + # VA-API (h264_vaapi) plus the Mesa RADV Vulkan driver and tools (h264_vulkan). + apt-get -qq install mesa-va-drivers mesa-vulkan-drivers vainfo vulkan-tools libva2 ;; "null") diff --git a/scripts/dist/install-hadolint.sh b/scripts/dist/install-hadolint.sh new file mode 100755 index 000000000..74390eb43 --- /dev/null +++ b/scripts/dist/install-hadolint.sh @@ -0,0 +1,127 @@ +#!/usr/bin/env bash + +# Installs the hadolint Dockerfile linter on Linux. +# bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-hadolint.sh) +# bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-hadolint.sh) -- --version v2.14.0 +# bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-hadolint.sh) -- /opt/photoprism + +set -euo pipefail + +REPO="hadolint/hadolint" +TOOL="hadolint" + +# Show usage information if first argument is --help. +if [[ ${1:-} == "--help" ]]; then + echo "Usage: ${0##*/} [--version <tag>] [destdir]" 1>&2 + echo "" 1>&2 + echo "Environment:" 1>&2 + echo " PHOTOPRISM_ARCH=amd64|arm64" 1>&2 + exit 0 +fi + +VERSION="latest" + +while [[ $# -gt 0 ]]; do + case $1 in + --version) + VERSION=${2:-} + if [[ -z $VERSION ]]; then + echo "Error: --version requires a tag (e.g. v2.14.0)." 1>&2 + exit 1 + fi + shift 2 + ;; + --help) + echo "Usage: ${0##*/} [--version <tag>] [destdir]" 1>&2 + exit 0 + ;; + --) + shift + break + ;; + -*) + echo "Error: Unknown option: $1" 1>&2 + exit 1 + ;; + *) + break + ;; + esac +done + +# You can provide a custom installation directory as the first argument. +DESTDIR=$(realpath "${1:-/usr/local}") + +# Determine target architecture. +if [[ -n ${PHOTOPRISM_ARCH:-} ]]; then + SYSTEM_ARCH=$PHOTOPRISM_ARCH +else + SYSTEM_ARCH=$(uname -m) +fi +DESTARCH=${BUILD_ARCH:-$SYSTEM_ARCH} + +case $DESTARCH in + amd64 | AMD64 | x86_64 | x86-64) + ASSET="hadolint-linux-x86_64" + ;; + arm64 | ARM64 | aarch64) + ASSET="hadolint-linux-arm64" + ;; + *) + echo "Unsupported Machine Architecture: \"$DESTARCH\"" 1>&2 + exit 1 + ;; +esac + +# Abort if not executed as root when installing into a system directory. +if [[ $(id -u) != "0" ]] && [[ $DESTDIR == "/usr" || $DESTDIR == "/usr/local" ]]; then + echo "Error: Run ${0##*/} as root to install in a system directory!" 1>&2 + exit 1 +fi + +if [[ $VERSION == "latest" ]]; then + RELEASE_URL="https://github.com/${REPO}/releases/latest/download/${ASSET}" + CHECKSUM_URL="${RELEASE_URL}.sha256" +else + RELEASE_URL="https://github.com/${REPO}/releases/download/${VERSION}/${ASSET}" + CHECKSUM_URL="${RELEASE_URL}.sha256" +fi + +DESTBIN="${DESTDIR}/bin/${TOOL}" + +echo "--------------------------------------------------------------------------------" +echo "VERSION : ${VERSION}" +echo "ASSET : ${ASSET}" +echo "DOWNLOAD : ${RELEASE_URL}" +echo "DESTBIN : ${DESTBIN}" +echo "--------------------------------------------------------------------------------" + +echo "Downloading ${TOOL} to \"${DESTBIN}\"..." +mkdir -p "${DESTDIR}/bin" +tmp_bin=$(mktemp) +trap 'rm -f "${tmp_bin}" "${tmp_bin}.sha256"' EXIT + +curl --fail --silent --show-error --location "${RELEASE_URL}" -o "${tmp_bin}" + +# Verify the SHA-256 checksum when the upstream releases publish one. +if curl --fail --silent --show-error --location "${CHECKSUM_URL}" -o "${tmp_bin}.sha256" 2>/dev/null; then + expected=$(awk '{print $1}' "${tmp_bin}.sha256") + actual=$(sha256sum "${tmp_bin}" | awk '{print $1}') + if [[ "${expected}" != "${actual}" ]]; then + echo "Error: SHA-256 mismatch for ${TOOL} (${ASSET})." 1>&2 + echo " expected: ${expected}" 1>&2 + echo " actual: ${actual}" 1>&2 + exit 1 + fi + echo "Checksum OK (${actual})." +else + echo "Warning: no published checksum found at ${CHECKSUM_URL}; skipping verification." 1>&2 +fi + +install -m 755 "${tmp_bin}" "${DESTBIN}" + +if command -v "${TOOL}" >/dev/null 2>&1; then + "${TOOL}" --version | head -n 1 +fi + +echo "Done." diff --git a/scripts/dist/install-hcloud.sh b/scripts/dist/install-hcloud.sh new file mode 100755 index 000000000..7a633edb5 --- /dev/null +++ b/scripts/dist/install-hcloud.sh @@ -0,0 +1,107 @@ +#!/usr/bin/env bash + +# Downloads and installs the Hetzner Cloud CLI (hcloud) on Linux. +# bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-hcloud.sh) + +PATH="/usr/local/sbin:/usr/sbin:/sbin:/usr/local/bin:/usr/bin:/bin:/scripts:$PATH" + +# Show usage information? +if [[ ${1:-} == "--help" ]]; then + echo "${0##*/} [version] [destdir] downloads and installs hcloud on Linux, for example:" 1>&2 + echo "${0##*/}" 1>&2 + echo "${0##*/} latest" 1>&2 + echo "${0##*/} 1.55.0 /usr/local" 1>&2 + exit 0 +fi + +set -Eeuo pipefail + +# Determine version to install (default: latest): +HCLOUD_VERSION=${1:-latest} + +if [[ $HCLOUD_VERSION == "latest" ]]; then + # Resolve "latest" via the releases/latest redirect (avoids GitHub API rate limit). + LATEST_URL=$(curl -fsSL -o /dev/null -w '%{url_effective}' https://github.com/hetznercloud/cli/releases/latest) + HCLOUD_VERSION=${LATEST_URL##*/v} +fi + +# Strip leading "v" if user passed e.g. "v1.55.0": +HCLOUD_VERSION=${HCLOUD_VERSION#v} + +if [[ -z $HCLOUD_VERSION ]]; then + echo "hcloud version must be passed as first argument, e.g. 1.55.0" 1>&2 + exit 1 +fi + +# Determine destination directory: +DESTDIR=$(realpath "${2:-/usr/local}") + +# Determine the system architecture: +if [[ ${PHOTOPRISM_ARCH:-} ]]; then + SYSTEM_ARCH=$PHOTOPRISM_ARCH +else + SYSTEM_ARCH=$(uname -m) +fi + +DESTARCH=${BUILD_ARCH:-$SYSTEM_ARCH} + +case $DESTARCH in + amd64 | AMD64 | x86_64 | x86-64) + DESTARCH=amd64 + ;; + + arm64 | ARM64 | aarch64) + DESTARCH=arm64 + ;; + + arm | ARM | aarch | armv7l | armhf) + DESTARCH=armv7 + ;; + + armv6l | armel) + DESTARCH=armv6 + ;; + + *) + echo "Unsupported Machine Architecture: \"$DESTARCH\"" 1>&2 + exit 1 + ;; +esac + +# Sudo only if not already root: +SUDO="" +if [[ $(id -u) -ne 0 ]]; then + if command -v sudo >/dev/null 2>&1; then + SUDO="sudo" + else + echo "Run ${0##*/} as root or install sudo!" 1>&2 + exit 1 + fi +fi + +ARCHIVE="hcloud-linux-${DESTARCH}.tar.gz" +URL="https://github.com/hetznercloud/cli/releases/download/v${HCLOUD_VERSION}/${ARCHIVE}" + +echo "Installing hcloud ${HCLOUD_VERSION} for ${DESTARCH^^} in \"${DESTDIR}/bin\". Please wait." +echo "URL: $URL" + +$SUDO mkdir -p "$DESTDIR/bin" + +# hcloud tarball contains the hcloud binary at the archive root. +TMPDIR=$(mktemp -d) +trap 'rm -rf "$TMPDIR"' EXIT + +curl -fsSL "$URL" | tar -xz -C "$TMPDIR" + +if [[ ! -f "$TMPDIR/hcloud" ]]; then + echo "hcloud binary not found in archive" 1>&2 + exit 1 +fi + +$SUDO install -m 755 "$TMPDIR/hcloud" "$DESTDIR/bin/hcloud" + +# Test hcloud by showing installed version: +echo "Installed hcloud version:" +"$DESTDIR/bin/hcloud" version | head -n 1 + +echo "Done." diff --git a/scripts/dist/install-libheif.sh b/scripts/dist/install-libheif.sh index 68a3ed08d..b33d78dd0 100755 --- a/scripts/dist/install-libheif.sh +++ b/scripts/dist/install-libheif.sh @@ -1,7 +1,16 @@ #!/usr/bin/env bash -# Installs the heif-convert, heif-enc, heif-info, and heif-thumbnailer binaries on Linux. +# Installs the heif-dec, heif-enc, and heif-info binaries on Linux. +# On libheif 1.21+, heif-convert is a symlink to heif-dec and heif-thumbnailer is no longer shipped. # bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-libheif.sh) +# +# Resolute installs photoprism-libheif via a real .deb that Provides/Replaces/Conflicts +# apt's libheif1, libheif-dev, libheif-examples, and libheif-plugin-* names. Other Debian +# distros get a contentless stub with the same metadata after the tarball extract. Either +# way, the package is apt-mark held so dist-upgrade leaves it alone — but an explicit +# `apt install libheif1` would still trigger the Conflicts: relation and replace +# photoprism-libheif, silently breaking the from-source HEIC pipeline. Don't do that; +# upgrade by bumping LIBHEIF_VERSION and rerunning this script instead. set -e @@ -15,7 +24,7 @@ fi DESTDIR=$(realpath "${1:-/usr/local}") # In addition, you can specify a custom version to be installed as the second argument. -LIBHEIF_VERSION=${2:-v1.20.2} +LIBHEIF_VERSION=${2:-v1.23.1} # Determine target architecture. if [[ $PHOTOPRISM_ARCH ]]; then @@ -65,6 +74,40 @@ esac echo "Installing libheif..." +# On Ubuntu 26.04 LTS (Resolute) we ship a real .deb (photoprism-libheif) so +# apt's libheif1 / libheif-dev / libheif-plugin-* don't coexist with the +# from-source build. The .deb only exists when DESTDIR is left at the default +# /usr or /usr/local — dpkg paths are absolute and ignore custom prefixes. +if [[ $VERSION_CODENAME == "resolute" ]] && [[ $DESTDIR == "/usr" || $DESTDIR == "/usr/local" ]] && command -v apt-get > /dev/null; then + ARCHIVE="libheif-${VERSION_CODENAME}-${DESTARCH}-${LIBHEIF_VERSION}.deb" + URL="https://dl.photoprism.app/dist/libheif/${ARCHIVE}" + TMPDEB="/tmp/${ARCHIVE}" + + echo "--------------------------------------------------------------------------------" + echo "VERSION: $LIBHEIF_VERSION" + echo "PACKAGE: $ARCHIVE (photoprism-libheif Debian package)" + echo "--------------------------------------------------------------------------------" + + if ! curl -fsSL "$URL" -o "$TMPDEB"; then + echo "❌ Failed to download \"$URL\"." + exit 1 + fi + + # photoprism-libheif is apt-mark held after install, so an explicit version bump + # must pass --allow-change-held-packages or apt refuses to upgrade the held package. + export DEBIAN_FRONTEND=noninteractive + if apt-get install -y --allow-change-held-packages --no-install-recommends "$TMPDEB"; then + apt-mark hold photoprism-libheif > /dev/null + rm -f "$TMPDEB" + echo "✅ Installed photoprism-libheif from \"$URL\"." + echo "Done." + exit 0 + fi + + echo "⚠️ apt-get install of \"$TMPDEB\" failed; falling back to tarball path." + rm -f "$TMPDEB" +fi + ARCHIVE="libheif-${VERSION_CODENAME}-${DESTARCH}-${LIBHEIF_VERSION}.tar.gz" URL="https://dl.photoprism.app/dist/libheif/${ARCHIVE}" @@ -89,4 +132,78 @@ else ldconfig -n "$DESTDIR/lib" fi +# Replace any distro-shipped libheif* packages with a contentless photoprism-libheif +# stub that Provides/Replaces/Conflicts them. Apt's solver then accepts the in-image +# install as a substitute and won't pull the older distro library back in on the next +# dist-upgrade. The actual binaries live under $DESTDIR (typically /usr/local/lib), +# and ldconfig already orders /usr/local/lib ahead of /usr/lib so consumers resolve +# to the from-source build. Resolute exits earlier through the real .deb path above. +if [[ $DESTDIR == "/usr" || $DESTDIR == "/usr/local" ]] && command -v apt-get > /dev/null && command -v dpkg-deb > /dev/null; then + INSTALLED_LIBHEIF_PKGS=$(dpkg-query -W -f='${Package}\n' 'libheif*' 2>/dev/null | grep -v '^photoprism-libheif$' | sort -u || true) + if [[ -n $INSTALLED_LIBHEIF_PKGS ]]; then + UPSTREAM_VERSION=${LIBHEIF_VERSION#v} + STUB_VERSION="${UPSTREAM_VERSION}-photoprism1" + STUB_ARCH=$(dpkg --print-architecture) + STUB_DIR=$(mktemp -d) + trap 'rm -rf "$STUB_DIR"' EXIT + + # Build comma-separated Provides:/Replaces:/Conflicts: from the actually-installed + # set, so per-distro naming (libheif1 vs libheif1t64, plugin variants) is handled + # without hard-coded per-codename branches. + STUB_PROVIDES=$(printf '%s\n' "$INSTALLED_LIBHEIF_PKGS" | sed "s/\$/ (= $UPSTREAM_VERSION)/" | paste -sd ',' | sed 's/,/, /g') + STUB_REPLACES=$(printf '%s\n' "$INSTALLED_LIBHEIF_PKGS" | paste -sd ',' | sed 's/,/, /g') + + echo "--------------------------------------------------------------------------------" + echo "Generating photoprism-libheif stub for apt-installed packages:" + # shellcheck disable=SC2001 + echo "$INSTALLED_LIBHEIF_PKGS" | sed 's/^/ /' + echo "--------------------------------------------------------------------------------" + + mkdir -p "$STUB_DIR/DEBIAN" "$STUB_DIR/usr/share/doc/photoprism-libheif" + cat > "$STUB_DIR/DEBIAN/control" <<STUBEOF +Package: photoprism-libheif +Version: $STUB_VERSION +Architecture: $STUB_ARCH +Multi-Arch: foreign +Maintainer: PhotoPrism UG <hello@photoprism.app> +Section: libs +Priority: optional +Provides: $STUB_PROVIDES +Replaces: $STUB_REPLACES +Conflicts: $STUB_REPLACES +Description: libheif ${LIBHEIF_VERSION} stub for PhotoPrism's from-source install + Contentless package that satisfies apt's libheif* dependencies after + install-libheif.sh has placed the real binaries under $DESTDIR. Apt's + solver treats this as the libheif provider so the distro libheif1 and + libheif-plugin-* packages are not pulled back in on the next dist-upgrade. + . + Real binaries: $DESTDIR/bin/heif-* and $DESTDIR/lib/libheif.so.* +STUBEOF + cat > "$STUB_DIR/usr/share/doc/photoprism-libheif/copyright" <<STUBEOF +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: libheif +Source: https://github.com/strukturag/libheif + +Files: * +Copyright: 2017-2026 struktur AG +License: LGPL-3.0+ + See /usr/share/common-licenses/LGPL-3 for the full text. +STUBEOF + + STUB_DEB="$STUB_DIR/photoprism-libheif_${STUB_VERSION}_${STUB_ARCH}.deb" + dpkg-deb --build --root-owner-group "$STUB_DIR" "$STUB_DEB" > /dev/null + + export DEBIAN_FRONTEND=noninteractive + if apt-get install -y --allow-change-held-packages --no-install-recommends "$STUB_DEB"; then + apt-mark hold photoprism-libheif > /dev/null + echo "✅ Installed photoprism-libheif stub (apt's libheif1/libheif-plugin-* superseded)." + else + echo "⚠️ Failed to install photoprism-libheif stub; apt's libheif packages remain alongside the from-source binaries." + fi + + rm -rf "$STUB_DIR" + trap - EXIT + fi +fi + echo "Done." diff --git a/scripts/dist/install-libvips.sh b/scripts/dist/install-libvips.sh index 05a3ab893..b58f2089b 100755 --- a/scripts/dist/install-libvips.sh +++ b/scripts/dist/install-libvips.sh @@ -1,6 +1,10 @@ #!/usr/bin/env bash -# Installs libvips from a Jammy backport PPA. +# Installs libvips-dev, preferring the distribution package and only falling +# back to a backport PPA when the distribution's own libvips is too old +# (originally Ubuntu 22.04 "jammy", which ships 8.12.x). Newer releases already +# provide a current libvips, so adding the PPA there is unnecessary and breaks +# "apt-get update" with a 404 because the PPA has no build for that codename. # bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-libvips.sh) set -Eeuo pipefail @@ -44,10 +48,31 @@ PPA_CODENAME="${VERSION_CODENAME:-jammy}" KEYRING_PATH="/etc/apt/keyrings/libvips-archive-keyring.gpg" SOURCES_PATH="/etc/apt/sources.list.d/libvips-ppa.list" +LIBVIPS_MIN_VERSION="${LIBVIPS_MIN_VERSION:-8.13}" + export DEBIAN_FRONTEND="noninteractive" +# Prefer the distribution's own libvips-dev when it is recent enough; only the +# old releases that ship a pre-8.13 libvips need the backport PPA. This avoids +# adding a PPA for a codename it was never built for, which would 404 on the +# Release file and break every subsequent "apt-get update". +${SUDO} apt-get update + +distro_candidate="$(apt-cache policy libvips-dev 2>/dev/null | awk '/Candidate:/ { print $2 }')" + +if [[ -n "${distro_candidate}" && "${distro_candidate}" != "(none)" ]] && + dpkg --compare-versions "${distro_candidate}" ge "${LIBVIPS_MIN_VERSION}"; then + echo "Installing distribution libvips-dev ${distro_candidate} (>= ${LIBVIPS_MIN_VERSION}); skipping the backport PPA." + ${SUDO} apt-get install -y libvips-dev + if command -v vips >/dev/null 2>&1; then + vips --version + fi + exit 0 +fi + +echo "Distribution libvips-dev (${distro_candidate:-not available}) is older than ${LIBVIPS_MIN_VERSION}; using the ${PPA_USER}/${PPA_NAME} backport PPA." + if ! command -v curl >/dev/null 2>&1 || ! command -v gpg >/dev/null 2>&1; then - ${SUDO} apt-get update ${SUDO} apt-get install -y curl gnupg ca-certificates fi diff --git a/scripts/dist/install-llamacpp.sh b/scripts/dist/install-llamacpp.sh new file mode 100755 index 000000000..b020b1132 --- /dev/null +++ b/scripts/dist/install-llamacpp.sh @@ -0,0 +1,301 @@ +#!/usr/bin/env bash + +# Installs llama.cpp prebuilt Linux binaries from GitHub on AMD64 and ARM64. +# bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-llamacpp.sh) +# bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-llamacpp.sh) -- --vulkan /usr/local b9948 +# +# The accelerator is auto-detected by default (the Vulkan build for any supported GPU, +# otherwise a plain CPU build). Vulkan covers NVIDIA, AMD, and Intel GPUs on Linux; +# upstream ships no CUDA build, and the ROCm build is intentionally not offered here +# because it is complex to provision and Vulkan matches or beats it in practice. + +set -euo pipefail + +if ! command -v jq >/dev/null 2>&1; then + echo "Error: jq is required but not installed." 1>&2 + exit 1 +fi + +REPO="ggml-org/llama.cpp" + +# usage prints the command-line synopsis and supported environment variables. +usage() { + echo "Usage: ${0##*/} [--auto|--cpu|--vulkan|--sycl] [destdir] [version]" 1>&2 + echo " ${0##*/} [--accel auto|cpu|vulkan|sycl] [destdir] [version]" 1>&2 + echo "" 1>&2 + echo "Arguments:" 1>&2 + echo " destdir Install prefix (default: /usr/local); binaries land in <destdir>/bin." 1>&2 + echo " version Release tag to install (e.g. b9948); defaults to the latest release." 1>&2 + echo "" 1>&2 + echo "Environment:" 1>&2 + echo " PHOTOPRISM_LLAMA_ACCEL=auto|cpu|vulkan|sycl Accelerator to install." 1>&2 + echo " PHOTOPRISM_ARCH / BUILD_ARCH Override target architecture." 1>&2 + echo " LLAMA_SHA256 Verify the download against this checksum." 1>&2 +} + +# ACCEL selects the hardware backend; "auto" resolves it from the detected GPU below. +ACCEL=${PHOTOPRISM_LLAMA_ACCEL:-auto} + +if [[ ${1:-} == "--help" || ${1:-} == "-h" ]]; then + usage + exit 0 +fi + +while [[ $# -gt 0 ]]; do + case $1 in + --auto) ACCEL=auto; shift ;; + --cpu) ACCEL=cpu; shift ;; + --vulkan) ACCEL=vulkan; shift ;; + --sycl) ACCEL=sycl; shift ;; + --accel) + ACCEL=${2:-} + if [[ -z $ACCEL ]]; then + echo "Error: --accel requires a value (auto, cpu, vulkan, or sycl)." 1>&2 + exit 1 + fi + shift 2 + ;; + --accel=*) ACCEL=${1#--accel=}; shift ;; + -h | --help) usage; exit 0 ;; + --) shift; break ;; + -*) echo "Error: Unknown option: $1" 1>&2; exit 1 ;; + *) break ;; + esac +done + +# Normalize the accelerator selection to a known keyword. +ACCEL=${ACCEL,,} +case $ACCEL in + auto | cpu | vulkan | sycl) ;; + gpu) ACCEL=auto ;; + *) echo "Error: Unsupported accelerator \"$ACCEL\" (use auto, cpu, vulkan, or sycl)." 1>&2; exit 1 ;; +esac + +# You can provide a custom installation directory as the first positional argument. +DESTDIR=$(realpath -m "${1:-/usr/local}") + +# Determine target architecture. +if [[ -n ${PHOTOPRISM_ARCH:-} ]]; then + SYSTEM_ARCH=$PHOTOPRISM_ARCH +else + SYSTEM_ARCH=$(uname -m) +fi + +DESTARCH=${BUILD_ARCH:-$SYSTEM_ARCH} + +# llama.cpp names its Linux assets "...-ubuntu-<accel>-x64" / "...-arm64". +case $DESTARCH in + amd64 | AMD64 | x86_64 | x86-64) DESTARCH=x64 ;; + arm64 | ARM64 | aarch64) DESTARCH=arm64 ;; + *) + echo "Error: Unsupported Machine Architecture: \"$DESTARCH\"" 1>&2 + exit 1 + ;; +esac + +# Abort if not executed as root when installing into a system directory. +if [[ $(id -u) != "0" ]] && [[ $DESTDIR == "/usr" || $DESTDIR == "/usr/local" ]]; then + echo "Error: Run ${0##*/} as root to install in a system directory!" 1>&2 + exit 1 +fi + +# detect_gpu_vendors populates GPU_VENDORS with the GPU makers found on this host. +# It reads PCI vendor IDs from sysfs first (no dependencies) and falls back to lspci. +GPU_VENDORS="" +detect_gpu_vendors() { + local f id out + for f in /sys/class/drm/card[0-9]*/device/vendor; do + [[ -r $f ]] || continue + id=$(cat "$f" 2>/dev/null || true) + case $id in + 0x10de) GPU_VENDORS+=" nvidia" ;; + 0x1002) GPU_VENDORS+=" amd" ;; + 0x8086) GPU_VENDORS+=" intel" ;; + esac + done + if [[ -z ${GPU_VENDORS// /} ]] && command -v lspci >/dev/null 2>&1; then + out=$(lspci 2>/dev/null | grep -iE 'vga|3d controller|display' || true) + grep -qi 'nvidia' <<<"$out" && GPU_VENDORS+=" nvidia" + grep -qiE 'amd|advanced micro|ati' <<<"$out" && GPU_VENDORS+=" amd" + grep -qi 'intel' <<<"$out" && GPU_VENDORS+=" intel" + fi + command -v nvidia-smi >/dev/null 2>&1 && GPU_VENDORS+=" nvidia" + # Deduplicate and trim. + GPU_VENDORS=$(tr ' ' '\n' <<<"$GPU_VENDORS" | sort -u | tr '\n' ' ' | sed 's/^ *//;s/ *$//') +} + +# has_gpu returns success if the given GPU vendor was detected. +has_gpu() { [[ " $GPU_VENDORS " == *" $1 "* ]]; } + +# vulkan_runtime_available returns success if the Vulkan loader is present on the host. +vulkan_runtime_available() { + command -v vulkaninfo >/dev/null 2>&1 && return 0 + ldconfig -p 2>/dev/null | grep -q 'libvulkan\.so\.1' && return 0 + return 1 +} + +# Resolve "auto" to a concrete accelerator based on the detected GPU: the Vulkan build +# for any supported GPU (NVIDIA, AMD, or Intel), otherwise a plain CPU build. +if [[ $ACCEL == auto ]]; then + detect_gpu_vendors + echo "GPU detected: ${GPU_VENDORS:-none}" + if [[ -n $GPU_VENDORS ]] && { has_gpu nvidia || has_gpu amd || has_gpu intel; }; then + ACCEL=vulkan + else + ACCEL=cpu + fi + echo "Selected accelerator: ${ACCEL} (override with --cpu/--vulkan/--sycl)." +fi + +echo "Installing llama.cpp (${ACCEL}) for ${DESTARCH^^}..." + +# Fetch release metadata: a specific tag when requested, otherwise the latest release. +if [[ -n ${2:-} ]]; then + VERSION=${2} + RELEASE_JSON=$(curl --fail --silent --show-error "https://api.github.com/repos/${REPO}/releases/tags/${VERSION}" || true) + if [[ -z $RELEASE_JSON ]]; then + echo "Error: Unable to fetch release metadata for tag ${VERSION}." 1>&2 + exit 1 + fi +else + RELEASE_JSON=$(curl --fail --silent --show-error "https://api.github.com/repos/${REPO}/releases/latest" || true) + if [[ -z $RELEASE_JSON ]]; then + echo "Error: Unable to fetch release metadata from GitHub." 1>&2 + exit 1 + fi +fi + +TAG_NAME=$(jq -r '.tag_name // empty' <<<"$RELEASE_JSON") +if [[ -z $TAG_NAME ]]; then + echo "Error: Release metadata did not include a tag name." 1>&2 + exit 1 +fi + +# asset_pattern returns the regex matching the ubuntu asset for the given accelerator. +asset_pattern() { + case $1 in + cpu) echo "bin-ubuntu-${DESTARCH}\\.tar\\.gz$" ;; + vulkan) echo "bin-ubuntu-vulkan-${DESTARCH}\\.tar\\.gz$" ;; + sycl) echo "bin-ubuntu-sycl-fp16-${DESTARCH}\\.tar\\.gz$" ;; + esac +} + +# asset_url prints the download URL of the first asset matching the given accelerator. +asset_url() { + local re + re=$(asset_pattern "$1") + [[ -z $re ]] && return 0 + jq -r --arg re "$re" '.assets[]? | select(.name | test($re)) | .browser_download_url' <<<"$RELEASE_JSON" | head -n1 +} + +# Build a fallback chain so an unavailable accelerator degrades to the plain CPU build +# (e.g. Vulkan or SYCL may be missing for a given arch in some releases). +case $ACCEL in + vulkan) CANDIDATES=(vulkan cpu) ;; + sycl) CANDIDATES=(sycl cpu) ;; + cpu) CANDIDATES=(cpu) ;; +esac + +RESOLVED_ACCEL="" +ASSET_URL="" +for candidate in "${CANDIDATES[@]}"; do + url=$(asset_url "$candidate") + if [[ -n $url && $url != "null" ]]; then + RESOLVED_ACCEL=$candidate + ASSET_URL=$url + break + fi +done + +if [[ -z $ASSET_URL ]]; then + echo "Error: No llama.cpp Linux asset found for ${ACCEL}/${DESTARCH} in release ${TAG_NAME}." 1>&2 + exit 1 +fi + +if [[ $RESOLVED_ACCEL != "$ACCEL" ]]; then + echo "Warning: No ${ACCEL} build for ${DESTARCH} in ${TAG_NAME}; falling back to ${RESOLVED_ACCEL}." 1>&2 +fi + +ASSET_NAME=${ASSET_URL##*/} +LLAMA_DIR="${DESTDIR}/lib/llama.cpp" + +echo "--------------------------------------------------------------------------------" +echo "VERSION : ${TAG_NAME}" +echo "ACCEL : ${RESOLVED_ACCEL}" +echo "ARCH : ${DESTARCH}" +echo "ASSET : ${ASSET_NAME}" +echo "DOWNLOAD: ${ASSET_URL}" +echo "DESTDIR : ${DESTDIR}" +echo "LIBDIR : ${LLAMA_DIR}" +echo "--------------------------------------------------------------------------------" + +tmp_tar=$(mktemp) +workdir=$(mktemp -d) +trap 'rm -rf "${tmp_tar}" "${workdir}"' EXIT + +echo "Downloading ${ASSET_NAME}..." +curl --fail --silent --show-error --location --retry 3 --retry-delay 2 "${ASSET_URL}" -o "${tmp_tar}" + +# Verify the download when a checksum was provided; upstream ships no checksum manifest. +if [[ -n ${LLAMA_SHA256:-} ]]; then + if command -v sha256sum >/dev/null 2>&1; then + actual=$(sha256sum "${tmp_tar}" | awk '{print $1}') + else + actual=$(shasum -a 256 "${tmp_tar}" | awk '{print $1}') + fi + if [[ ${LLAMA_SHA256} != "${actual}" ]]; then + echo "Error: SHA-256 mismatch for ${ASSET_NAME}." 1>&2 + echo " expected: ${LLAMA_SHA256}" 1>&2 + echo " actual: ${actual}" 1>&2 + exit 1 + fi + echo "Checksum OK (${actual})." +fi + +echo "Extracting ${ASSET_NAME}..." +tar xzf "${tmp_tar}" -C "${workdir}" + +# The archive extracts to a single top-level "llama-<tag>" directory. +srcdir=$(find "${workdir}" -mindepth 1 -maxdepth 1 -type d | head -n1) +if [[ -z ${srcdir} ]]; then + echo "Error: Unexpected archive layout in ${ASSET_NAME}." 1>&2 + exit 1 +fi + +# Replace any previous install so stale libraries don't linger next to the binaries. +echo "Installing binaries and libraries to ${LLAMA_DIR}..." +rm -rf "${LLAMA_DIR}" +mkdir -p "${LLAMA_DIR}" +cp -a "${srcdir}/." "${LLAMA_DIR}/" + +# Symlink the executables into <destdir>/bin. The binaries carry RUNPATH "$ORIGIN", +# so they resolve their co-located shared libraries through the symlink. +mkdir -p "${DESTDIR}/bin" +linked=0 +for f in "${LLAMA_DIR}"/llama* "${LLAMA_DIR}"/ggml-rpc-server; do + [[ -f $f ]] || continue + case $f in *.so | *.so.*) continue ;; esac + [[ -x $f ]] || continue + ln -sf "$f" "${DESTDIR}/bin/$(basename "$f")" + linked=$((linked + 1)) +done + +if [[ $linked -eq 0 ]]; then + echo "Error: No llama.cpp executables found in ${LLAMA_DIR}." 1>&2 + exit 1 +fi + +echo "Linked ${linked} executables into ${DESTDIR}/bin." + +# Warn when the selected backend needs a runtime that is not present on this host. +case $RESOLVED_ACCEL in + vulkan) + if ! vulkan_runtime_available; then + echo "Note: The Vulkan build needs the Vulkan loader (libvulkan.so.1) and a GPU driver ICD at runtime." 1>&2 + echo " On Debian/Ubuntu: apt-get install libvulkan1 mesa-vulkan-drivers (plus the NVIDIA driver for NVIDIA GPUs)." 1>&2 + fi + ;; +esac + +echo "Try: ${DESTDIR}/bin/llama-cli --version" +echo "Done." diff --git a/scripts/dist/install-nodejs.sh b/scripts/dist/install-nodejs.sh index 5e81821c1..70c52cefe 100755 --- a/scripts/dist/install-nodejs.sh +++ b/scripts/dist/install-nodejs.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash -# Installs NodeJS, NPM and TestCafe on Linux. +# Installs NodeJS, NPM, TestCafe, Vitest, Mermaid CLI and ESLint on Linux. # bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-nodejs.sh) PATH="/usr/local/sbin:/usr/sbin:/sbin:/usr/local/bin:/usr/bin:/bin:/scripts:$PATH" @@ -12,6 +12,9 @@ set -e # NodeJS major version to be installed (armhf still requires 22.x). NODE_MAJOR=24 +NPM_VERSION=latest +TESTCAFE_VERSION=3.7.4 +MERMAID_VERSION=latest if [ "$(dpkg --print-architecture)" = "armhf" ]; then NODE_MAJOR=22 @@ -45,13 +48,17 @@ fi # Upgrade NPM and install development dependencies. echo "Configuring NPM..." -sudo npm config set cache ~/.cache/npm +sudo npm config set cache /root/.cache/npm echo "Updating NPM..." -sudo npm install -g --no-fund npm@latest n@latest +sudo npm install -g --ignore-scripts --no-fund --no-audit --no-update-notifier "npm@$NPM_VERSION" n@latest echo "Installing npm-check-updates and license-report..." sudo npm install -g --ignore-scripts --no-fund --no-audit --no-update-notifier npm-check-updates@latest license-report@latest echo "Installing TestCafe..." -sudo npm install -g --ignore-scripts --no-fund --no-audit --no-update-notifier --loglevel=error testcafe@3.7.4 +sudo npm install -g --ignore-scripts --no-fund --no-audit --no-update-notifier --loglevel=error "testcafe@$TESTCAFE_VERSION" +# Installs Mermaid CLI for rendering diagrams; --ignore-scripts skips puppeteer's +# Chromium download since the dev image already ships system chromium via apt. +echo "Installing Mermaid CLI..." +sudo npm install -g --ignore-scripts --no-fund --no-audit --no-update-notifier --loglevel=error "@mermaid-js/mermaid-cli@$MERMAID_VERSION" echo "Installing Vitest..." sudo npm install -g --ignore-scripts --no-fund --no-audit --no-update-notifier vitest @vitest/browser @vitest/coverage-v8 @vitest/ui echo "Installing ESLint..." diff --git a/scripts/dist/install-onnx.sh b/scripts/dist/install-onnx.sh index 179748c7e..92dbc620b 100755 --- a/scripts/dist/install-onnx.sh +++ b/scripts/dist/install-onnx.sh @@ -2,12 +2,42 @@ set -euo pipefail -ONNX_VERSION=${ONNX_VERSION:-1.24.1} +ONNX_VERSION=${ONNX_VERSION:-1.26.0} TODAY=$(date -u +%Y%m%d) TMPDIR=${TMPDIR:-/tmp} SYSTEM=$(uname -s) ARCH=${PHOTOPRISM_ARCH:-$(uname -m)} -DESTDIR_ARG="${1:-/usr}" + +# ONNX_GPU selects a CUDA (GPU) build instead of the default CPU build. It can be +# set via the ONNX_GPU environment variable or a --gpu[=cuda12|cuda13] argument: +# unset / 0 / cpu -> CPU build (default) +# 1 / gpu / cuda13 -> CUDA 13 build (recommended; CUDA 12 is deprecated upstream) +# cuda12 -> CUDA 12 build (legacy) +# GPU builds are only published for Linux x64 and additionally require the NVIDIA +# driver plus a matching CUDA runtime and cuDNN to be present at runtime. +ONNX_GPU=${ONNX_GPU:-} + +# Parse optional flags; the first non-flag argument is the install prefix. +DESTDIR_ARG="/usr" +destdir_set=0 +for arg in "$@"; do + case "${arg}" in + --gpu) ONNX_GPU="cuda13" ;; + --gpu=*) ONNX_GPU="${arg#--gpu=}" ;; + --cpu) ONNX_GPU="" ;; + -*) echo "Error: unknown option '${arg}'." >&2; exit 2 ;; + *) if [[ "${destdir_set}" == 0 ]]; then DESTDIR_ARG="${arg}"; destdir_set=1; fi ;; + esac +done + +# Normalize the GPU selection to an empty (CPU) or "cudaNN" variant. +gpu_variant="" +case "${ONNX_GPU,,}" in + ""|0|cpu|false|no) gpu_variant="" ;; + 1|gpu|cuda13|cuda-13) gpu_variant="cuda13" ;; + cuda12|cuda-12) gpu_variant="cuda12" ;; + *) echo "Error: unsupported ONNX_GPU value '${ONNX_GPU}' (use cuda12 or cuda13)." >&2; exit 1 ;; +esac if [[ ! -d "${DESTDIR_ARG}" ]]; then mkdir -p "${DESTDIR_ARG}" @@ -22,6 +52,11 @@ fi mkdir -p "${DESTDIR}" "${TMPDIR}" +# version_lt returns success if $1 is a strictly lower semantic version than $2. +version_lt() { + [[ "$1" != "$2" ]] && [[ "$(printf '%s\n%s\n' "$1" "$2" | sort -V | head -n1)" == "$1" ]] +} + archive="" sha="" @@ -29,12 +64,29 @@ case "${SYSTEM}" in Linux) case "${ARCH}" in amd64|AMD64|x86_64|x86-64) - archive="onnxruntime-linux-x64-${ONNX_VERSION}.tgz" - sha="9142552248b735920f9390027e4512a2cacf8946a1ffcbe9071a5c210531026f" + if [[ -n "${gpu_variant}" ]]; then + # Upstream renamed the CUDA-12 archive from "-gpu-" to "-gpu_cuda12-" in v1.27.0. + if [[ "${gpu_variant}" == "cuda12" ]] && version_lt "${ONNX_VERSION}" "1.27.0"; then + archive="onnxruntime-linux-x64-gpu-${ONNX_VERSION}.tgz" + sha="cb7df7ee2ca0f962c7ce7c839aeae36223d146a91fb4646d62fb0046f297479f" + else + archive="onnxruntime-linux-x64-gpu_${gpu_variant}-${ONNX_VERSION}.tgz" + if [[ "${gpu_variant}" == "cuda13" ]]; then + sha="aa619d5701bbe58046cc998b21e692d5b2aefac1479f375c4b988526cb80befa" + fi + fi + else + archive="onnxruntime-linux-x64-${ONNX_VERSION}.tgz" + sha="1254da24fb389cf39dc0ff3451ab48301740ffbfcbaf646849df92f80ee92c57" + fi ;; arm64|ARM64|aarch64) + if [[ -n "${gpu_variant}" ]]; then + echo "Error: ONNX Runtime GPU/CUDA builds are only available for Linux x64." >&2 + exit 1 + fi archive="onnxruntime-linux-aarch64-${ONNX_VERSION}.tgz" - sha="0f56edd68f7602df790b68b874a46b115add037e88385c6c842bb763b39b9f89" + sha="34ff1c2d0f12e2cf3d33a0c5f82e39792e1d581fbd6968fd7c30d173654be01a" ;; *) echo "Warning: ONNX Runtime is not provided for Linux/${ARCH}; skipping install." >&2 @@ -43,10 +95,14 @@ case "${SYSTEM}" in esac ;; Darwin) + if [[ -n "${gpu_variant}" ]]; then + echo "Error: ONNX Runtime GPU/CUDA builds are only available for Linux x64." >&2 + exit 1 + fi case "${ARCH}" in arm64|ARM64|aarch64) archive="onnxruntime-osx-arm64-${ONNX_VERSION}.tgz" - sha="c2969315cd9ce0f5fa04f6b53ff72cb92f87f7dcf38e88cacfa40c8f983fbba9" + sha="7a1280bbb1701ea514f71828765237e7896e0f2e1cd332f1f70dbd5c3e33aca3" ;; x86_64|x86-64) echo "Warning: ONNX Runtime is not provided for macOS/${ARCH} in v${ONNX_VERSION}; skipping install." >&2 @@ -64,6 +120,10 @@ case "${SYSTEM}" in ;; esac +# Allow an explicit checksum override (e.g. when installing a non-default version +# or a GPU variant whose checksum is not pinned in this script). +sha="${ONNX_SHA256:-${sha}}" + verify_sha() { local expected="$1" local file="$2" @@ -79,6 +139,11 @@ if [[ -z "${archive}" ]]; then exit 1 fi +if [[ -z "${sha}" ]]; then + echo "Error: no checksum pinned for '${archive}'. Set ONNX_SHA256 to install it." >&2 + exit 1 +fi + primary_url="https://dl.photoprism.app/onnx/runtime/v${ONNX_VERSION}/${archive}?${TODAY}" fallback_url="https://github.com/microsoft/onnxruntime/releases/download/v${ONNX_VERSION}/${archive}" package_path="${TMPDIR}/${archive}" @@ -110,22 +175,28 @@ echo "Extracting to ${DESTDIR}..." tar --overwrite --mode=755 -C "${DESTDIR}" -xzf "${package_path}" # Normalize layout: copy libraries into ${DESTDIR}/lib and remove extracted tree. +# The archive extracts to a top directory named after itself (minus ".tgz"), +# which also covers the GPU builds and their extra provider libraries. output_lib_dir="${DESTDIR}/lib" mkdir -p "${output_lib_dir}" -for extracted in "${DESTDIR}/onnxruntime-linux-x64-${ONNX_VERSION}" "${DESTDIR}/onnxruntime-linux-aarch64-${ONNX_VERSION}" "${DESTDIR}/onnxruntime-osx-arm64-${ONNX_VERSION}" "${DESTDIR}/onnxruntime-osx-universal2-${ONNX_VERSION}"; do - if [[ -d "${extracted}/lib" ]]; then - find "${extracted}/lib" -maxdepth 1 -type f -name "libonnxruntime*.so*" -print0 | while IFS= read -r -d '' file; do - cp -af "${file}" "${output_lib_dir}/" - done - # copy any symlinks as well to preserve SONAME links - find "${extracted}/lib" -maxdepth 1 -type l -name "libonnxruntime*.so*" -print0 | while IFS= read -r -d '' link; do - target=$(readlink "${link}") - ln -sf "${target}" "${output_lib_dir}/$(basename "${link}")" - done - rm -rf "${extracted}" - fi -done +# Determine the extracted top-level directory from the archive itself: upstream's +# GPU archive filenames (e.g. "-gpu_cuda13-") do not match their internal +# directory name (e.g. "-gpu-"), so it cannot be derived from the file name. +# (|| true: head closes the pipe early, which SIGPIPEs tar under pipefail.) +extracted_name=$(tar tzf "${package_path}" 2>/dev/null | head -1 | cut -d/ -f1 || true) +extracted="${DESTDIR}/${extracted_name}" +if [[ -n "${extracted_name}" && -d "${extracted}/lib" ]]; then + find "${extracted}/lib" -maxdepth 1 -type f -name "libonnxruntime*.so*" -print0 | while IFS= read -r -d '' file; do + cp -af "${file}" "${output_lib_dir}/" + done + # copy any symlinks as well to preserve SONAME links + find "${extracted}/lib" -maxdepth 1 -type l -name "libonnxruntime*.so*" -print0 | while IFS= read -r -d '' link; do + target=$(readlink "${link}") + ln -sf "${target}" "${output_lib_dir}/$(basename "${link}")" + done + rm -rf "${extracted}" +fi if [[ "${SYSTEM}" == "Linux" ]]; then if [[ "${DESTDIR}" == "/usr" || "${DESTDIR}" == "/usr/local" ]]; then @@ -135,4 +206,4 @@ if [[ "${SYSTEM}" == "Linux" ]]; then fi fi -echo "ONNX Runtime ${ONNX_VERSION} installed in '${DESTDIR}'." +echo "ONNX Runtime ${ONNX_VERSION}${gpu_variant:+ (GPU/${gpu_variant})} installed in '${DESTDIR}'." diff --git a/scripts/dist/install-osv-scanner.sh b/scripts/dist/install-osv-scanner.sh new file mode 100755 index 000000000..3908095b4 --- /dev/null +++ b/scripts/dist/install-osv-scanner.sh @@ -0,0 +1,132 @@ +#!/usr/bin/env bash + +# Installs the OSV-Scanner cross-ecosystem CVE scanner on Linux. +# bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-osv-scanner.sh) +# bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-osv-scanner.sh) -- --version v2.3.5 +# bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-osv-scanner.sh) -- /opt/photoprism + +set -euo pipefail + +REPO="google/osv-scanner" +TOOL="osv-scanner" + +if [[ ${1:-} == "--help" ]]; then + echo "Usage: ${0##*/} [--version <tag>] [destdir]" 1>&2 + echo "" 1>&2 + echo "Environment:" 1>&2 + echo " PHOTOPRISM_ARCH=amd64|arm64" 1>&2 + exit 0 +fi + +VERSION="latest" + +while [[ $# -gt 0 ]]; do + case $1 in + --version) + VERSION=${2:-} + if [[ -z $VERSION ]]; then + echo "Error: --version requires a tag (e.g. v2.3.5)." 1>&2 + exit 1 + fi + shift 2 + ;; + --help) + echo "Usage: ${0##*/} [--version <tag>] [destdir]" 1>&2 + exit 0 + ;; + --) + shift + break + ;; + -*) + echo "Error: Unknown option: $1" 1>&2 + exit 1 + ;; + *) + break + ;; + esac +done + +DESTDIR=$(realpath "${1:-/usr/local}") + +if [[ -n ${PHOTOPRISM_ARCH:-} ]]; then + SYSTEM_ARCH=$PHOTOPRISM_ARCH +else + SYSTEM_ARCH=$(uname -m) +fi +DESTARCH=${BUILD_ARCH:-$SYSTEM_ARCH} + +case $DESTARCH in + amd64 | AMD64 | x86_64 | x86-64) + ASSET="osv-scanner_linux_amd64" + ;; + arm64 | ARM64 | aarch64) + ASSET="osv-scanner_linux_arm64" + ;; + *) + echo "Unsupported Machine Architecture: \"$DESTARCH\"" 1>&2 + exit 1 + ;; +esac + +if [[ $(id -u) != "0" ]] && [[ $DESTDIR == "/usr" || $DESTDIR == "/usr/local" ]]; then + echo "Error: Run ${0##*/} as root to install in a system directory!" 1>&2 + exit 1 +fi + +if [[ $VERSION == "latest" ]]; then + RELEASE_URL="https://github.com/${REPO}/releases/latest/download/${ASSET}" +else + RELEASE_URL="https://github.com/${REPO}/releases/download/${VERSION}/${ASSET}" +fi + +# OSV-Scanner releases ship a single osv-scanner_SHA256SUMS file covering every asset. +if [[ $VERSION == "latest" ]]; then + CHECKSUM_URL="https://github.com/${REPO}/releases/latest/download/osv-scanner_SHA256SUMS" +else + CHECKSUM_URL="https://github.com/${REPO}/releases/download/${VERSION}/osv-scanner_SHA256SUMS" +fi + +DESTBIN="${DESTDIR}/bin/${TOOL}" + +echo "--------------------------------------------------------------------------------" +echo "VERSION : ${VERSION}" +echo "ASSET : ${ASSET}" +echo "DOWNLOAD : ${RELEASE_URL}" +echo "DESTBIN : ${DESTBIN}" +echo "--------------------------------------------------------------------------------" + +echo "Downloading ${TOOL} to \"${DESTBIN}\"..." +mkdir -p "${DESTDIR}/bin" +tmp_bin=$(mktemp) +tmp_sums=$(mktemp) +trap 'rm -f "${tmp_bin}" "${tmp_sums}"' EXIT + +curl --fail --silent --show-error --location "${RELEASE_URL}" -o "${tmp_bin}" + +if curl --fail --silent --show-error --location "${CHECKSUM_URL}" -o "${tmp_sums}" 2>/dev/null; then + expected=$(awk -v want="${ASSET}" '$2 == want || $2 == "*"want {print $1; exit}' "${tmp_sums}") + if [[ -z "${expected}" ]]; then + echo "Warning: ${ASSET} not listed in SHA256SUMS; skipping verification." 1>&2 + else + actual=$(sha256sum "${tmp_bin}" | awk '{print $1}') + if [[ "${expected}" != "${actual}" ]]; then + echo "Error: SHA-256 mismatch for ${TOOL} (${ASSET})." 1>&2 + echo " expected: ${expected}" 1>&2 + echo " actual: ${actual}" 1>&2 + exit 1 + fi + echo "Checksum OK (${actual})." + fi +else + echo "Warning: no published SHA256SUMS found at ${CHECKSUM_URL}; skipping verification." 1>&2 +fi + +install -m 755 "${tmp_bin}" "${DESTBIN}" + +if command -v "${TOOL}" >/dev/null 2>&1; then + "${TOOL}" --version | head -n 1 +fi + +echo "Done." diff --git a/scripts/dist/install-s6.sh b/scripts/dist/install-s6.sh index 62a271dbb..54279eddb 100755 --- a/scripts/dist/install-s6.sh +++ b/scripts/dist/install-s6.sh @@ -77,11 +77,46 @@ echo "-------------------------------------------------------------------------- # Create the destination directory if it does not already exist. mkdir -p "${S6_OVERLAY_DESTDIR}" -# Download and install the s6-overlay release from GitHub. -echo "Extracting \"$S6_NOARCH_URL\" to \"$S6_OVERLAY_DESTDIR\"..." -curl -fsSL "$S6_NOARCH_URL" | tar -C "${S6_OVERLAY_DESTDIR}" -Jxp +# Stage downloads in a temporary directory that is removed on exit. +S6_TMPDIR=$(mktemp -d) +trap 'rm -rf "${S6_TMPDIR}"' EXIT -echo "Extracting \"$S6_BINARY_URL\" to \"$S6_OVERLAY_DESTDIR\"..." -curl -fsSL "$S6_BINARY_URL" | tar -C "${S6_OVERLAY_DESTDIR}" -Jxp +# verify_sha256 checks a file against the SHA-256 published next to the release +# asset (<url>.sha256), aborting on mismatch. It soft-fails when no checksum is +# published so pinned older tags without a manifest still install. +verify_sha256() { + local url="$1" file="$2" sumfile="$3" expected actual + if ! curl -fsSL "${url}.sha256" -o "${sumfile}" 2>/dev/null; then + echo "Warning: no published checksum at ${url}.sha256; skipping verification." 1>&2 + return 0 + fi + expected=$(awk '{print $1}' "${sumfile}") + if command -v sha256sum >/dev/null 2>&1; then + actual=$(sha256sum "${file}" | awk '{print $1}') + else + actual=$(shasum -a 256 "${file}" | awk '{print $1}') + fi + if [[ ${expected} != "${actual}" ]]; then + echo "Error: SHA-256 mismatch for $(basename "${file}")." 1>&2 + echo " expected: ${expected}" 1>&2 + echo " actual: ${actual}" 1>&2 + exit 1 + fi + echo "Checksum OK ($(basename "${file}"): ${actual})." +} + +# download_and_extract fetches a release tarball, verifies it, then extracts it. +download_and_extract() { + local url="$1" name="$2" archive="${S6_TMPDIR}/${2}" + echo "Downloading \"${url}\"..." + curl -fsSL "${url}" -o "${archive}" + verify_sha256 "${url}" "${archive}" "${archive}.sha256" + echo "Extracting \"${name}\" to \"${S6_OVERLAY_DESTDIR}\"..." + tar -C "${S6_OVERLAY_DESTDIR}" -Jxp -f "${archive}" +} + +# Download, verify, and install the s6-overlay release from GitHub. +download_and_extract "$S6_NOARCH_URL" "$ARCHIVE_NOARCH" +download_and_extract "$S6_BINARY_URL" "$ARCHIVE_BINARY" echo "Done." diff --git a/scripts/dist/install-yt-dlp.sh b/scripts/dist/install-yt-dlp.sh index 1448b62b4..6bea142bd 100755 --- a/scripts/dist/install-yt-dlp.sh +++ b/scripts/dist/install-yt-dlp.sh @@ -167,6 +167,7 @@ fi TAG_NAME="" ASSET_NAME="" ASSET_URL="" +CHECKSUM_URL="" while IFS= read -r release; do tag=$(echo "$release" | jq -r '.tag_name // empty') @@ -178,6 +179,8 @@ while IFS= read -r release; do TAG_NAME=$tag ASSET_NAME=$candidate ASSET_URL=$url + # yt-dlp publishes one SHA2-256SUMS manifest per release listing every asset. + CHECKSUM_URL=$(echo "$release" | jq -r '.assets[]? | select(.name == "SHA2-256SUMS") | .browser_download_url' | head -n1) break 2 fi done @@ -205,10 +208,37 @@ echo "DESTBIN : ${DESTBIN}" echo "--------------------------------------------------------------------------------" echo "Downloading the yt-dlp binary to \"${DESTBIN}\"..." -mkdir -p "${DESTDIR}" -curl --fail --silent --show-error --location "${GITHUB_URL}" -o "${DESTBIN}" +mkdir -p "${DESTDIR}/bin" +tmp_bin=$(mktemp) +trap 'rm -f "${tmp_bin}" "${tmp_bin}.sums"' EXIT +curl --fail --silent --show-error --location "${GITHUB_URL}" -o "${tmp_bin}" -echo "Changing permissions of \"${DESTBIN}\" to 755..." -chmod 755 "${DESTBIN}" +# Verify the binary against the release SHA2-256SUMS manifest before installing. +# Soft-fail when no manifest is published so older pinned tags still install. +if [[ -n ${CHECKSUM_URL} && ${CHECKSUM_URL} != "null" ]] && + curl --fail --silent --show-error --location "${CHECKSUM_URL}" -o "${tmp_bin}.sums" 2>/dev/null; then + expected=$(awk -v n="${ASSET_NAME}" '$2 == n {print $1}' "${tmp_bin}.sums") + if [[ -z ${expected} ]]; then + echo "Error: ${ASSET_NAME} not listed in SHA2-256SUMS; refusing to install." 1>&2 + exit 1 + fi + if command -v sha256sum >/dev/null 2>&1; then + actual=$(sha256sum "${tmp_bin}" | awk '{print $1}') + else + actual=$(shasum -a 256 "${tmp_bin}" | awk '{print $1}') + fi + if [[ ${expected} != "${actual}" ]]; then + echo "Error: SHA-256 mismatch for yt-dlp (${ASSET_NAME})." 1>&2 + echo " expected: ${expected}" 1>&2 + echo " actual: ${actual}" 1>&2 + exit 1 + fi + echo "Checksum OK (${actual})." +else + echo "Warning: no published checksum for ${ASSET_NAME}; skipping verification." 1>&2 +fi + +echo "Installing yt-dlp to \"${DESTBIN}\" with permissions 755..." +install -m 755 "${tmp_bin}" "${DESTBIN}" echo "Done." diff --git a/scripts/docker/buildx-multi.sh b/scripts/docker/buildx-multi.sh index eab99c8a8..c045be7ae 100755 --- a/scripts/docker/buildx-multi.sh +++ b/scripts/docker/buildx-multi.sh @@ -20,9 +20,17 @@ sleep 3 echo "Done." # Create new multibuilder and add remote host for native arm builds. +# BUILDKIT_STEP_LOG_MAX_SIZE raised from default 2 MiB → 5 MiB so long apt-get +# transcripts (especially on unstable Ubuntu releases) don't get truncated. echo "Creating new multibuilder..." -docker buildx create --name multibuilder --use 1>/dev/null || { echo 'buildx: failed to create multibuilder'; exit 1; } -docker buildx create --name multibuilder --append ssh://arm 2>/dev/null || echo 'buildx: failed to add remote host for native arm builds' +docker buildx create --name multibuilder \ + --driver-opt env.BUILDKIT_STEP_LOG_MAX_SIZE=5242880 \ + --driver-opt env.BUILDKIT_STEP_LOG_MAX_SPEED=10485760 \ + --use 1>/dev/null || { echo 'buildx: failed to create multibuilder'; exit 1; } +docker buildx create --name multibuilder --append \ + --driver-opt env.BUILDKIT_STEP_LOG_MAX_SIZE=5242880 \ + --driver-opt env.BUILDKIT_STEP_LOG_MAX_SPEED=10485760 \ + ssh://arm 2>/dev/null || echo 'buildx: failed to add remote host for native arm builds' echo "Done." echo "Starting 'photoprism/$1' multi-arch build based on docker/${1/-//}$4/Dockerfile..." @@ -103,7 +111,13 @@ else --push . fi +# Capture the buildx exit code so we can still run cleanup below +# and propagate the failure to make. Without this, a failed build +# would silently exit 0 because the trailing `echo` succeeds. +rc=$? + echo "Removing multibuilder..." docker buildx rm multibuilder echo "Done." +exit "$rc" diff --git a/scripts/gettext-lint.mjs b/scripts/gettext-lint.mjs new file mode 100644 index 000000000..91be306ba --- /dev/null +++ b/scripts/gettext-lint.mjs @@ -0,0 +1,248 @@ +#!/usr/bin/env node +// +// gettext-lint.mjs — validate PhotoPrism's gettext catalogs for objective, +// non-linguistic defects that break rendering at runtime: +// +// 1. Placeholder integrity — the set of substitution placeholders in a +// translation (msgstr) must match the source string (msgid). The frontend +// (vue3-gettext) uses named `%{name}` placeholders; the backend (gotext) +// uses printf verbs (`%s`, `%d`, `%.1f`, …). A translation that renames, +// drops, or corrupts a placeholder silently fails to interpolate. +// 2. Whitespace / newline edges — leading/trailing spaces and a trailing +// newline are structural; msgstr should mirror msgid at its edges. +// +// It also shells out to `msgfmt -c --check-format` to surface gettext's own +// c-format fatals. Human summary to stderr, JSONL findings to stdout, and a +// non-zero exit when any finding exists (so it can gate CI if desired). +// +// Dependency-free (Node stdlib only). Run from the repository root: +// +// node scripts/gettext-lint.mjs # lint everything +// node scripts/gettext-lint.mjs --json # JSONL findings only (no summary) +// +// Frontend catalogs: frontend/src/locales/*.po +// Backend catalogs: assets/locales/<locale>/default.po + +import { readFileSync, readdirSync, existsSync } from "node:fs"; +import { spawnSync } from "node:child_process"; +import { basename, join } from "node:path"; + +const FRONTEND_DIR = "frontend/src/locales"; +const BACKEND_DIR = "assets/locales"; +const jsonOnly = process.argv.includes("--json"); + +// --- Minimal, multiline-aware .po parser ----------------------------------- +// Returns [{ msgctxt, msgid, msgstr, plurals: [msgstr[0], msgstr[1], …] }, …], +// excluding the header entry (empty msgid). Escapes are kept verbatim, so an +// escaped newline reads as the two characters `\` + `n`. +function parsePo(path) { + const entries = []; + let cur = null; + let field = null; // "msgctxt" | "msgid" | "msgid_plural" | "msgstr" | "plural:N" + + const push = () => { + if (cur && (cur.msgid.length || cur.msgstr.length || cur.plurals.length)) { + entries.push(cur); + } + }; + + for (const raw of readFileSync(path, "utf8").split("\n")) { + const line = raw.replace(/\r$/, ""); + if (line === "" || line.startsWith("#")) { + continue; // blank lines and comments (incl. flags/refs) are not needed + } + const kw = line.match(/^(msgctxt|msgid|msgid_plural|msgstr(?:\[(\d+)\])?)\s+"(.*)"$/); + if (kw) { + const key = kw[1]; + const val = kw[3]; + if (key === "msgid") { + push(); + cur = { msgctxt: "", msgid: "", msgstr: "", plurals: [] }; + field = "msgid"; + cur.msgid += val; + } else if (key === "msgctxt") { + field = "msgctxt"; + cur.msgctxt += val; + } else if (key === "msgid_plural") { + field = "msgid_plural"; // ignored for placeholder checks (uses msgid) + } else { + // msgstr or msgstr[N] + const idx = kw[2]; + if (idx === undefined || idx === "0") { + field = "msgstr"; + cur.msgstr += val; + } else { + field = `plural:${idx}`; + } + if (idx !== undefined) { + cur.plurals[Number(idx)] = (cur.plurals[Number(idx)] || "") + val; + } + } + continue; + } + const cont = line.match(/^"(.*)"$/); + if (cont && cur && field) { + if (field === "msgid") cur.msgid += cont[1]; + else if (field === "msgctxt") cur.msgctxt += cont[1]; + else if (field === "msgstr") cur.msgstr += cont[1]; + else if (field.startsWith("plural:")) { + const n = Number(field.slice(7)); + cur.plurals[n] = (cur.plurals[n] || "") + cont[1]; + } + // msgid_plural continuations are intentionally dropped + } + } + push(); + return entries; +} + +// --- Placeholder extraction ------------------------------------------------- +// Named `%{name}` (frontend). Literal `%%` is not a placeholder. +function namedPlaceholders(s) { + return (s.replace(/%%/g, "").match(/%\{[^}]*\}/g) || []).sort(); +} +// printf verbs (backend). Matches Go fmt verbs incl. width/precision/index. +function printfVerbs(s) { + return (s.replace(/%%/g, "").match(/%(?:\d+\$)?[-+ #0]*\d*(?:\.\d+)?[bcdeEfFgGoqstTvxXsdp]/g) || []).sort(); +} + +function multisetEqual(a, b) { + if (a.length !== b.length) return false; + for (let i = 0; i < a.length; i++) if (a[i] !== b[i]) return false; + return true; +} + +// Edge-whitespace / trailing-newline signature. +function edgeSig(s) { + return { + lead: /^ /.test(s), + trail: / $/.test(s), + nl: s.endsWith("\\n"), + }; +} +function edgeEqual(a, b) { + const x = edgeSig(a); + const y = edgeSig(b); + return x.lead === y.lead && x.trail === y.trail && x.nl === y.nl; +} + +// --- msgfmt -c -------------------------------------------------------------- +function msgfmtCheck(path) { + const r = spawnSync("msgfmt", ["-c", "--check-format", "-o", "/dev/null", path], { + encoding: "utf8", + }); + if (r.error) return []; // msgfmt not installed → skip silently + const out = `${r.stdout || ""}${r.stderr || ""}`; + // Keep only fatal/error lines, drop header-field warnings (Weblate-owned). + return out + .split("\n") + .filter((l) => l.trim() && !/warning: header field/.test(l) && !/warning: /.test(l)) + .map((l) => l.trim()); +} + +// --- Lint one catalog ------------------------------------------------------- +function lintFile(path, side) { + const findings = []; + const getPlaceholders = side === "backend" ? printfVerbs : namedPlaceholders; + for (const e of parsePo(path)) { + if (!e.msgid) continue; // header + // Compare the primary msgstr and any plural forms that carry content. + const targets = [e.msgstr, ...e.plurals.filter(Boolean)]; + for (const str of targets) { + if (!str) continue; // untranslated → not a defect + const idP = getPlaceholders(e.msgid); + const strP = getPlaceholders(str); + if (!multisetEqual(idP, strP)) { + findings.push({ + file: path, + side, + check: "placeholder", + msgctxt: e.msgctxt || undefined, + msgid: e.msgid, + msgstr: str, + expected: idP, + found: strP, + }); + } + if (!edgeEqual(e.msgid, str)) { + const ie = edgeSig(e.msgid); + // A msgid that itself carries edge whitespace is a *source-string* smell: + // the stray space usually separates adjacent `{{ }}` interpolations and is + // rendering-sensitive, so it must be fixed at the source (and verified in a + // browser), not blindly trimmed from each translation. Reported separately + // from a genuine translation-only whitespace defect (clean msgid). + findings.push({ + file: path, + side, + check: ie.lead || ie.trail || ie.nl ? "source-whitespace" : "whitespace", + msgctxt: e.msgctxt || undefined, + msgid: e.msgid, + msgstr: str, + idEdges: ie, + strEdges: edgeSig(str), + }); + } + } + } + for (const err of msgfmtCheck(path)) { + findings.push({ file: path, side, check: "msgfmt", detail: err }); + } + return findings; +} + +// --- Collect catalogs ------------------------------------------------------- +function frontendFiles() { + if (!existsSync(FRONTEND_DIR)) return []; + return readdirSync(FRONTEND_DIR) + .filter((f) => f.endsWith(".po")) + .map((f) => join(FRONTEND_DIR, f)) + .sort(); +} +function backendFiles() { + if (!existsSync(BACKEND_DIR)) return []; + const out = []; + for (const d of readdirSync(BACKEND_DIR, { withFileTypes: true })) { + if (!d.isDirectory()) continue; + const p = join(BACKEND_DIR, d.name, "default.po"); + if (existsSync(p)) out.push(p); + } + return out.sort(); +} + +// --- Run -------------------------------------------------------------------- +const raw = []; +for (const f of frontendFiles()) raw.push(...lintFile(f, "frontend")); +for (const f of backendFiles()) raw.push(...lintFile(f, "backend")); + +// Collapse source-whitespace findings to one per (side, msgid): the same stray +// space in the source string surfaces once per locale, but it's a single defect. +const all = []; +const seenSource = new Set(); +for (const f of raw) { + if (f.check === "source-whitespace") { + const key = `${f.side}�${f.msgid}`; + if (seenSource.has(key)) continue; + seenSource.add(key); + } + all.push(f); +} + +for (const finding of all) process.stdout.write(`${JSON.stringify(finding)}\n`); + +if (!jsonOnly) { + const by = (side, check) => + all.filter((f) => f.side === side && f.check === check).length; + const files = (check) => new Set(all.filter((f) => f.check === check).map((f) => f.file)).size; + const w = (s) => process.stderr.write(`${s}\n`); + w(""); + w("gettext-lint summary"); + w("--------------------"); + w(` placeholder frontend=${by("frontend", "placeholder")} backend=${by("backend", "placeholder")} (files=${files("placeholder")})`); + w(` whitespace frontend=${by("frontend", "whitespace")} backend=${by("backend", "whitespace")} (translation-side defects, files=${files("whitespace")})`); + w(` source-whitespace frontend=${by("frontend", "source-whitespace")} backend=${by("backend", "source-whitespace")} (distinct source strings — fix in source, verify rendering)`); + w(` msgfmt frontend=${by("frontend", "msgfmt")} backend=${by("backend", "msgfmt")}`); + w(` TOTAL findings: ${all.length}`); + w(""); +} + +process.exit(all.length ? 1 : 0); diff --git a/scripts/render/maskable-icon.sh b/scripts/render/maskable-icon.sh new file mode 100755 index 000000000..e5786f08c --- /dev/null +++ b/scripts/render/maskable-icon.sh @@ -0,0 +1,52 @@ +#!/usr/bin/env bash + +# Renders safe-zone-padded "maskable" PWA icons from the theme icon SVGs, so Android fills the +# home-screen adaptive-icon mask shape instead of letterboxing the default icon. The logo is +# rendered at 80% of the target size (10% safe-zone padding per side) and centered on an opaque +# background. See https://web.dev/articles/maskable-icon for the safe-zone specification. + +if [[ -n $1 ]] && [[ $1 == "-h" || $1 == "--help" ]]; then + echo "Usage: (1) ${0##*/} (renders maskable icons for all assets/static/icons/*.svg themes)" 1>&2 + echo " (2) ${0##*/} [name] (renders maskable icons for assets/static/icons/[name].svg only)" 1>&2 + exit 1 +fi + +set -e + +sizes=(192 512) +safe_zone=80 # percentage of the icon that holds the visible logo (the rest is mask-safe padding) +background="white" + +# Collect the theme SVG sources to render. +sources=() +if [[ -n $1 ]]; then + sources=("assets/static/icons/${1}.svg") +else + for svg in assets/static/icons/*.svg; do + sources+=("$svg") + done +fi + +for svg in "${sources[@]}"; do + if [ ! -f "$svg" ]; then + echo "$svg not found" 1>&2 + exit 1 + fi + + name="$(basename "$svg" .svg)" + dest="assets/static/icons/${name}/maskable" + mkdir -p "$dest" + + echo "Creating maskable icons from ${svg}..." + + for size in "${sizes[@]}"; do + inner=$(( size * safe_zone / 100 )) + tmp="$(mktemp --suffix=.png)" + rsvg-convert -a -w "$inner" -h "$inner" "$svg" > "$tmp" + magick -size "${size}x${size}" "xc:${background}" "$tmp" -gravity center -composite -depth 8 -strip "$dest/$size.png" + rm -f "$tmp" + echo "$dest/$size.png" + done +done + +echo "Done." diff --git a/scripts/tag-release.sh b/scripts/tag-release.sh new file mode 100755 index 000000000..b510e6876 --- /dev/null +++ b/scripts/tag-release.sh @@ -0,0 +1,130 @@ +#!/usr/bin/env bash +# +# tag-release.sh — create an annotated PhotoPrism release tag with cross-repo +# provenance (main/pro/plus/portal commit SHAs + the pushed image digest in the +# tag message). One mechanism for every edition so release tags never drift. +# +# Tag convention: +# +# edition repo tag +# ---------- ------- -------------------------------- +# pro pro pro/<semver>-<abbrev> +# enterprise pro enterprise/<semver>-<abbrev> +# portal portal portal/<semver>-<abbrev> +# plus | ce (main) <YYMMDD>-<abbrev> (existing build-tag format) +# +# <semver> = 1.YYMM.DD (zero-padded day), override with --version +# <abbrev> = `git describe --always` in the MAIN repo — the build's +# BUILD_VERSION / BUILD_GIT. core.abbrev is "auto", so the length is +# dynamic; computing it the same way the build does keeps the tag +# suffix equal to the image version string ("1.YYMM.DD-<abbrev>"). +# +# The Docker tag and chart appVersion stay the clean <semver>; the -<abbrev> +# suffix is git-tag-only and prevents same-day collisions. +# +# Usage (run from the main repo root, with pro/ plus/ portal/ sub-repos present): +# scripts/tag-release.sh <edition> [options] +# --version <1.YYMM.DD> override the semver (default: today, UTC) +# --image <ref> image to read the digest from (default: per edition) +# --digest <sha256:...> use this digest instead of inspecting the image +# --ref <commit> tag this commit (default: the edition repo's HEAD) +# --remote <name> push remote (default: origin) +# --push push the tag after creating it (default: local only) +# --dry-run print the tag name + message, create nothing +# +set -euo pipefail + +die() { echo "tag-release: $*" >&2; exit 1; } + +EDITION="${1:-}"; [ -n "$EDITION" ] || die "usage: tag-release.sh <pro|enterprise|portal|plus|ce> [options]" +shift || true + +VERSION=""; IMAGE=""; DIGEST=""; REF=""; REMOTE="origin"; PUSH=0; DRY=0; SPECS_SHA="" +while [ $# -gt 0 ]; do + case "$1" in + --version) VERSION="${2:?}"; shift 2 ;; + --image) IMAGE="${2:?}"; shift 2 ;; + --digest) DIGEST="${2:?}"; shift 2 ;; + --ref) REF="${2:?}"; shift 2 ;; + --remote) REMOTE="${2:?}"; shift 2 ;; + --specs-sha) SPECS_SHA="${2:?}"; shift 2 ;; # for hosts where specs/ is absent (e.g. ci) + --push) PUSH=1; shift ;; + --dry-run) DRY=1; shift ;; + *) die "unknown option: $1" ;; + esac +done + +# Resolve the main repo root from this script's location (scripts/ is at the root). +ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" +[ -d "$ROOT/.git" ] || [ -f "$ROOT/.git" ] || die "not a git repo: $ROOT" +git -C "$ROOT" rev-parse --is-inside-work-tree >/dev/null 2>&1 || die "main repo not found at $ROOT" + +# <abbrev>: exactly what the build embeds (BUILD_VERSION/BUILD_GIT), computed in main. +ABBREV="$(git -C "$ROOT" describe --always)" +[ -n "$ABBREV" ] || die "git describe --always returned empty in $ROOT" + +# <semver>: 1.YYMM.DD (zero-padded day, UTC) unless overridden. +SEMVER="${VERSION:-1.$(date -u +%y%m).$(date -u +%d)}" +DATE_TAG="$(date -u +%y%m%d)" + +# Capture cross-repo SHAs (sub-repos may be absent on some hosts). +sha() { local d="$1"; [ -d "$ROOT/$d/.git" ] || [ -e "$ROOT/$d/.git" ] && git -C "$ROOT/$d" rev-parse HEAD 2>/dev/null || echo "(absent)"; } +MAIN_SHA="$(git -C "$ROOT" rev-parse HEAD)" +PRO_SHA="$(sha pro)"; PLUS_SHA="$(sha plus)"; PORTAL_SHA="$(sha portal)" +# specs/ is docs-only (no code dependency) and absent on build hosts like ci; +# record it when present, or accept it via --specs-sha. +[ -n "$SPECS_SHA" ] || SPECS_SHA="$(sha specs)" + +# Map edition -> repo dir, tag name, default image, human label, image-version string. +case "$EDITION" in + pro) REPO="pro"; TAG="pro/${SEMVER}-${ABBREV}"; DEF_IMAGE="photoprism/pro:${SEMVER}"; LABEL="Pro ${SEMVER}"; IMGVER="${SEMVER}-${ABBREV}" ;; + enterprise) REPO="pro"; TAG="enterprise/${SEMVER}-${ABBREV}"; DEF_IMAGE="photoprism/enterprise:${SEMVER}"; LABEL="Enterprise ${SEMVER} (SDD)"; IMGVER="${SEMVER}-${ABBREV}" ;; + portal) REPO="portal"; TAG="portal/${SEMVER}-${ABBREV}"; DEF_IMAGE="photoprism/portal:${SEMVER}"; LABEL="Portal ${SEMVER}"; IMGVER="${SEMVER}-${ABBREV}" ;; + plus|ce) REPO="."; TAG="${DATE_TAG}-${ABBREV}"; DEF_IMAGE="photoprism/photoprism:${DATE_TAG}"; LABEL="${EDITION^^} ${DATE_TAG}"; IMGVER="${DATE_TAG}-${ABBREV}" ;; + *) die "unknown edition: $EDITION (expected pro|enterprise|portal|plus|ce)" ;; +esac +[ -d "$ROOT/$REPO/.git" ] || [ -e "$ROOT/$REPO/.git" ] || [ "$REPO" = "." ] || die "target repo '$REPO' not present under $ROOT" + +# Resolve the image digest (best-effort) unless one was provided. +IMAGE="${IMAGE:-$DEF_IMAGE}" +if [ -z "$DIGEST" ]; then + if command -v docker >/dev/null 2>&1; then + DIGEST="$(docker buildx imagetools inspect "$IMAGE" --format '{{.Manifest.Digest}}' 2>/dev/null || true)" + fi +fi +[ -n "$DIGEST" ] || DIGEST="(not resolved — pass --digest)" + +TARGET_REF="${REF:-$(git -C "$ROOT/$REPO" rev-parse HEAD)}" + +read -r -d '' MESSAGE <<EOF || true +PhotoPrism ${LABEL} + +image: ${IMAGE}@${DIGEST} +main=${MAIN_SHA} (image version: ${IMGVER}) +pro=${PRO_SHA} +plus=${PLUS_SHA} +portal=${PORTAL_SHA} +specs=${SPECS_SHA} +EOF + +echo "edition: ${EDITION}" +echo "repo: ${REPO} ref: ${TARGET_REF}" +echo "tag: ${TAG}" +echo "---- message ----" +echo "${MESSAGE}" +echo "-----------------" + +if [ "$DRY" -eq 1 ]; then + echo "(dry-run: nothing created)" + exit 0 +fi + +git -C "$ROOT/$REPO" tag -a "$TAG" "$TARGET_REF" -m "${MESSAGE}" +echo "created annotated tag ${TAG} in ${REPO}" + +if [ "$PUSH" -eq 1 ]; then + git -C "$ROOT/$REPO" push "$REMOTE" "$TAG" + echo "pushed ${TAG} to ${REMOTE}" +else + echo "(local only — re-run with --push, or: git -C ${REPO} push ${REMOTE} ${TAG})" +fi diff --git a/setup/charts/plus/Chart.yaml b/setup/charts/plus/Chart.yaml new file mode 100644 index 000000000..c8d420e10 --- /dev/null +++ b/setup/charts/plus/Chart.yaml @@ -0,0 +1,43 @@ +apiVersion: v2 +name: photoprism-plus +type: application +description: >- + Deploys PhotoPrism® on Kubernetes with optional portal integration, + persistent storage, and configurable authentication backends. +version: "1.1.2" +appVersion: "260601" +home: https://www.photoprism.app/ +icon: https://dl.photoprism.app/icons/logo/256.png +maintainers: + - name: PhotoPrism UG + url: https://www.photoprism.app/contact/ +keywords: + - photos + - photoprism + - ai + - media + - dam + - webdav + - oidc +sources: + - https://docs.photoprism.app/ + - https://www.photoprism.app/kb/ + - https://www.photoprism.app/kb/getting-support/ + - https://github.com/photoprism/photoprism +annotations: + catalog.cattle.io/display-name: "PhotoPrism®" + catalog.cattle.io/type: "app" + catalog.cattle.io/category: "Digital Asset Management (DAM)" + catalog.cattle.io/requests-cpu: "1000m" + catalog.cattle.io/requests-memory: "1Gi" + catalog.cattle.io/os: "linux" + catalog.cattle.io/featured: "true" + artifacthub.io/license: "AGPL-3.0-or-later" + artifacthub.io/category: "storage" + artifacthub.io/links: | + - name: Documentation + url: https://docs.photoprism.app/ + - name: Knowledge Base + url: https://www.photoprism.app/kb/ + - name: Support + url: https://www.photoprism.app/kb/getting-support/ \ No newline at end of file diff --git a/setup/charts/plus/README.md b/setup/charts/plus/README.md new file mode 100644 index 000000000..3cb404440 --- /dev/null +++ b/setup/charts/plus/README.md @@ -0,0 +1,114 @@ +## Introduction + +This chart provides an easy way to run [PhotoPrism®](https://www.photoprism.app/editions/#compare) on a home lab or small business Kubernetes cluster while maintaining an approachable configuration. + +## Highlights + +- Runs the official `photoprism/photoprism` image with non-root defaults (UID/GID 1000). +- Ships with SQLite out of the box; switch to MariaDB/MySQL by filling in the database section. +- Creates lightweight PVCs for `/photoprism/storage` (5 GiB) and, optionally, `/photoprism/originals` (10 GiB) – the cluster’s default storage class is used unless you override it. +- Surfaces the most relevant customization settings (locale, themes, login footer, CORS/CDN, backup schedule) directly in Rancher’s UI or via `values.yaml`. + +## Quick Start + +```bash +helm repo add photoprism https://charts.photoprism.app/photoprism +helm repo update photoprism +helm upgrade --install photos photoprism/photoprism-plus \ + --namespace photos --create-namespace +``` + +This deploys PhotoPrism with SQLite storage. To use MariaDB (recommended for larger libraries): + +```bash +helm upgrade --install photos photoprism/photoprism-plus \ + --namespace photos \ + --set database.driver=mysql \ + --set database.server=mariadb.default.svc.cluster.local:3306 \ + --set database.name=photoprism \ + --set database.user=photoprism \ + --set database.password=changeme +``` + +## Storage & Backups + +- `persistence.storage` is always created and holds the application state. +- `persistence.originals` can be disabled or redirected to an NFS export when you manage originals elsewhere. +- Backup options (`PHOTOPRISM_BACKUP_*`) are exposed so you can point scheduled backups to another path or tweak retention. + +## Customization + +Key values you might want to adjust: + +- `config.PHOTOPRISM_SITE_TITLE`, `config.PHOTOPRISM_APP_NAME`, `config.PHOTOPRISM_DEFAULT_THEME` +- `config.PHOTOPRISM_AUTH_MODE`, `config.PHOTOPRISM_LOGIN_INFO`, `config.PHOTOPRISM_PASSWORD_LENGTH` +- `config.PHOTOPRISM_CDN_URL`, `config.PHOTOPRISM_CORS_ORIGIN` +- `config.PHOTOPRISM_FILES_QUOTA`, `config.PHOTOPRISM_UPLOAD_LIMIT` + +See [`values.yaml`](https://github.com/photoprism/photoprism/blob/develop/setup/charts/plus/values.yaml) for the full list. + +## Networking & TLS + +The chart exposes PhotoPrism on TCP 2342 through a ClusterIP service. You can override the service type or enable an Ingress resource when you terminate TLS in the cluster edge: + +```yaml +service: + type: ClusterIP + port: 2342 + +ingress: + enabled: true + className: traefik + hosts: + - host: photos.example.com + paths: + - path: / + pathType: Prefix + tls: + - hosts: + - photos.example.com + secretName: photos-tls +``` + +Because TLS typically terminates at the ingress or proxy layer, the chart keeps `PHOTOPRISM_DISABLE_TLS` set to `true`. Only enable PhotoPrism’s internal TLS if your cluster design requires end-to-end encryption and you manage the certificates yourself. + +## Database Password + +You can provide the database password in two ways: + +1. **External secret** – set `database.passwordSecretName` to reference a pre-existing Kubernetes Secret. By default the + chart looks for a `PHOTOPRISM_DATABASE_PASSWORD` key; set `database.passwordSecretKey` to use a different key name: + ```yaml + database: + passwordSecretName: my-db-credentials + # passwordSecretKey: DB_PASSWORD # optional, defaults to PHOTOPRISM_DATABASE_PASSWORD + ``` +2. **Inline** – set `database.password` directly (the chart stores it in its managed Secret and references it via + `secretKeyRef`): + ```yaml + database: + password: "changeme" + ``` + +If both are set, `database.passwordSecretName` takes precedence and the inline `database.password` is ignored (it is not +copied into the managed Secret). If neither is set, no password env var is injected (suitable for SQLite). + +## Security Tips + +- When `adminPassword` is left blank, a random password is generated and stored in `secret/<release>-photoprism-secrets`. +- Prefer MariaDB/MySQL for multi-user setups or large libraries, and back up both the database and storage PVCs regularly. +- If you expose PhotoPrism on the public internet, pair it with HTTPS termination (Ingress/TLS or an external proxy) and keep the container image up to date. + +## Getting Support + +Commercial support is available with our Starter, Business, and Enterprise team plans: + +- https://www.photoprism.app/teams/#compare +- https://www.photoprism.app/kb/getting-support/ + +## PhotoPrism® Documentation + +For more information on specific features, services and related resources, please refer to the other documentation available in our Knowledge Base and User Guide: + +- [PhotoPrism® User Guide](https://docs.photoprism.app/user-guide/) +- [PhotoPrism® Knowledge Base](https://www.photoprism.app/kb/) diff --git a/setup/charts/plus/questions.yaml b/setup/charts/plus/questions.yaml new file mode 100644 index 000000000..a53d4f787 --- /dev/null +++ b/setup/charts/plus/questions.yaml @@ -0,0 +1,432 @@ +questions: + - variable: image.tag + group: "Customization" + label: "Image Tag" + description: "Override the container tag; leave empty to use the chart appVersion." + type: string + - variable: config.PHOTOPRISM_SITE_NAME + group: "Customization" + label: "Site Name" + description: "Optional short name identifying this instance in cluster switchers and selectors. Example: Acme Media." + type: string + - variable: config.PHOTOPRISM_SITE_TITLE + group: "Customization" + label: "Site Title" + description: "Displayed title in the PhotoPrism UI. Example: Photo Library." + type: string + - variable: config.PHOTOPRISM_SITE_CAPTION + group: "Customization" + label: "Site Caption" + description: "Optional tagline shown beneath the title. Example: Explore Your Media." + type: string + - variable: config.PHOTOPRISM_SITE_DESCRIPTION + group: "Customization" + label: "Site Description" + description: "Short description used in metadata and link previews. Example: Private family archive." + type: string + - variable: config.PHOTOPRISM_SITE_AUTHOR + group: "Customization" + label: "Site Author" + description: "Owner or copyright notice displayed in metadata. Example: © 2025 The Smith Family." + type: string + - variable: config.PHOTOPRISM_SITE_FAVICON + group: "Customization" + label: "Site Favicon" + description: "Filename or URL of the favicon asset. Example: /photoprism/assets/favicon.ico." + type: string + - variable: config.PHOTOPRISM_SITE_PREVIEW + group: "Customization" + label: "Sharing Preview URL" + description: "Image URL used for social previews. Example: https://example.com/preview.jpg." + type: string + - variable: config.PHOTOPRISM_CDN_URL + group: "Customization" + label: "CDN URL" + description: "Base URL for serving static assets via CDN. Example: https://cdn.example.com." + type: string + - variable: config.PHOTOPRISM_CDN_VIDEO + group: "Customization" + label: "CDN Video URL" + description: "Optional CDN endpoint for streaming videos. Example: https://videos.example.com." + type: string + - variable: config.PHOTOPRISM_CORS_ORIGIN + group: "Customization" + label: "CORS Allowed Origin" + description: "Origin allowed to issue cross-origin requests. Example: https://app.example.com." + type: string + - variable: config.PHOTOPRISM_CORS_HEADERS + group: "Customization" + label: "CORS Headers" + description: "Comma-separated headers exposed for cross-origin requests." + type: string + default: "Accept, Accept-Ranges, Content-Disposition, Content-Encoding, Content-Range, Location" + - variable: config.PHOTOPRISM_CORS_METHODS + group: "Customization" + label: "CORS Methods" + description: "Allowed HTTP methods for cross-origin requests." + type: string + default: "GET, HEAD, OPTIONS" + - variable: config.PHOTOPRISM_APP_NAME + group: "Customization" + label: "App Name" + description: "Display name when PhotoPrism is installed as a PWA." + type: string + - variable: config.PHOTOPRISM_APP_ICON + group: "Customization" + label: "App Icon" + description: "Icon style for the PWA shortcut (logo, app, mint, square, etc.). Example: logo." + type: string + - variable: config.PHOTOPRISM_APP_COLOR + group: "Customization" + label: "App Color" + description: "Hex colour used for the PWA splash screen and tint. Example: #1d1d1e." + type: string + default: "#1d1d1e" + - variable: config.PHOTOPRISM_DEFAULT_TIMEZONE + group: "Customization" + label: "Default Timezone" + description: "Timezone name used for scheduling (e.g. Europe/Berlin)." + type: string + - variable: config.PHOTOPRISM_PLACES_LOCALE + group: "Customization" + label: "Places Locale" + description: "Language code for location details (en, de, local, etc.)." + type: string + default: "local" + - variable: config.PHOTOPRISM_DEFAULT_THEME + group: "Customization" + label: "Default Theme" + description: "Theme name applied to new users (leave blank for PhotoPrism default)." + type: string + - variable: config.PHOTOPRISM_DEFAULT_LOCALE + group: "Customization" + label: "Default Locale" + description: "Language code assigned to new users. Example: en or de." + type: string + default: "en" + - variable: config.PHOTOPRISM_AUTH_MODE + group: "Authentication" + label: "Authentication Mode" + description: "Select password-protected or public access." + type: enum + options: + - "password" + - "public" + default: "password" + - variable: config.PHOTOPRISM_LOG_LEVEL + group: "Customization" + label: "Log Level" + description: "Application log verbosity. Example: info." + type: enum + options: + - "trace" + - "debug" + - "info" + - "warning" + - "error" + default: "info" + - variable: adminUser + group: "Administration" + label: "Admin Username" + description: "Initial administrator account." + type: string + default: "admin" + required: true + - variable: adminPassword + group: "Administration" + label: "Admin Password" + description: "Leave empty to auto-generate and store the password in a secret." + type: string + - variable: config.PHOTOPRISM_PASSWORD_LENGTH + group: "Authentication" + label: "Minimum Password Length" + description: "Enforce a minimum password length for local users." + type: int + default: "8" + - variable: config.PHOTOPRISM_SESSION_MAXAGE + group: "Authentication" + label: "Session Max Age (Seconds)" + description: "Maximum session lifetime; doubled when 2FA is enabled." + type: int + default: "1209600" + - variable: config.PHOTOPRISM_SESSION_TIMEOUT + group: "Authentication" + label: "Session Idle Timeout (Seconds)" + description: "Maximum idle time before users are signed out." + type: int + default: "604800" + - variable: config.PHOTOPRISM_SESSION_CACHE + group: "Authentication" + label: "Session Cache TTL (Seconds)" + description: "Duration session data is cached in memory (60-3600)." + type: int + default: "900" + - variable: config.PHOTOPRISM_LOGIN_INFO + group: "Authentication" + label: "Login Footer Text" + description: "Optional message displayed below the login form." + type: string + - variable: config.PHOTOPRISM_LEGAL_INFO + group: "Customization" + label: "Legal Notice Text" + description: "Text displayed in the footer for legal notices." + type: string + - variable: config.PHOTOPRISM_LEGAL_URL + group: "Customization" + label: "Legal Notice URL" + description: "Link to full legal information." + type: string + - variable: config.PHOTOPRISM_WALLPAPER_URI + group: "Customization" + label: "Wallpaper URI" + description: "Background image URL for the login screen." + type: string + - variable: oidc.PHOTOPRISM_DISABLE_OIDC + group: "Authentication" + label: "Disable OpenID Connect" + description: "Set to false to enable OpenID Connect login with the settings below." + type: boolean + default: true + show_subquestion_if: false + subquestions: + - variable: oidc.PHOTOPRISM_OIDC_URI + label: "OIDC Issuer URI" + description: "Identity provider issuer URL." + type: string + - variable: oidc.PHOTOPRISM_OIDC_CLIENT + label: "OIDC Client ID" + description: "Client identifier issued by the identity provider. Example: photoprism-plus." + type: string + - variable: oidc.PHOTOPRISM_OIDC_SECRET + label: "OIDC Client Secret" + description: "Client secret stored in a Kubernetes Secret. Example: s3cr3t." + type: string + - variable: oidc.PHOTOPRISM_OIDC_SCOPES + label: "OIDC Scopes" + description: "Space-delimited scopes requested from the provider." + type: string + default: "openid email profile" + - variable: oidc.PHOTOPRISM_OIDC_PROMPT + label: "OIDC Authorization Prompt" + description: "Optional prompt forcing re-authentication or account selection: login, select_account, or consent." + type: string + - variable: oidc.PHOTOPRISM_OIDC_REGISTER + label: "Auto Register Users" + description: "Automatically create PhotoPrism accounts after successful OIDC login." + type: boolean + default: true + - variable: oidc.PHOTOPRISM_OIDC_REDIRECT + label: "Force OIDC Redirect" + description: "Always redirect to the OIDC provider instead of showing the local login form." + type: boolean + default: false + - variable: oidc.PHOTOPRISM_OIDC_USERNAME + label: "OIDC Username Claim" + description: "Claim name used as the PhotoPrism username. Example: email." + type: string + default: "email" + - variable: oidc.PHOTOPRISM_OIDC_PROVIDER + label: "OIDC Provider Name" + description: "Label displayed on the login button." + type: string + - variable: oidc.PHOTOPRISM_OIDC_ICON + label: "OIDC Provider Icon" + description: "Optional icon URL for the login button." + type: string + - variable: oidc.PHOTOPRISM_OIDC_WEBDAV + label: "Enable OIDC WebDAV" + description: "Allow OIDC users to authenticate against WebDAV endpoints." + type: boolean + default: false + - variable: database.driver + group: "Database" + label: "Driver" + description: "Set to mysql when connecting to MariaDB/MySQL." + type: enum + options: + - "sqlite" + - "mysql" + default: "sqlite" + - variable: database.server + group: "Database" + label: "Server" + description: "Host:port or socket path for the database server." + type: string + - variable: database.name + group: "Database" + label: "Database Name" + description: "Schema name when using MariaDB/MySQL." + type: string + - variable: database.user + group: "Database" + label: "Database Username" + description: "User account for the schema." + type: string + - variable: database.password + group: "Database" + label: "Database Password" + description: "Optional password stored in the chart-managed secret. Ignored when an external secret is referenced." + type: string + - variable: database.passwordSecretName + group: "Database" + label: "Password Secret Name" + description: "Reference an existing Kubernetes Secret for the password instead of the chart-managed secret." + type: string + - variable: database.passwordSecretKey + group: "Database" + label: "Password Secret Key" + description: "Key within the referenced secret (defaults to PHOTOPRISM_DATABASE_PASSWORD)." + type: string + - variable: database.timeout + group: "Database" + label: "Connection Timeout (Seconds)" + description: "Timeout when establishing a database connection." + type: int + default: "15" + - variable: database.conns + group: "Database" + label: "Max Open Connections" + description: "Maximum number of open connections (0 lets PhotoPrism decide)." + type: int + default: "0" + - variable: database.connsIdle + group: "Database" + label: "Max Idle Connections" + description: "Maximum number of idle connections (0 lets PhotoPrism decide)." + type: int + default: "0" + - variable: persistence.storage.size + group: "Storage" + label: "Storage Volume Size" + description: "PVC size for /photoprism/storage (can be expanded later)." + type: string + default: "5Gi" + - variable: config.PHOTOPRISM_FILES_QUOTA + group: "Storage" + label: "Total File Quota (GB)" + description: "Limit the total size of indexed originals (0 for unlimited)." + type: int + default: "0" + - variable: config.PHOTOPRISM_ORIGINALS_LIMIT + group: "Storage" + label: "Maximum Original Size (MB)" + description: "Largest allowed original file size." + type: int + default: "5000" + - variable: config.PHOTOPRISM_UPLOAD_LIMIT + group: "Storage" + label: "Maximum Upload Size (MB)" + description: "Largest allowed upload size." + type: int + default: "5000" + - variable: config.PHOTOPRISM_UPLOAD_ALLOW + group: "Storage" + label: "Allowed Upload Types" + description: "Comma-separated list of permitted upload extensions." + type: string + default: "zip,jpeg,jpg,png,gif,bmp,avif,webp,heic,heif,tiff,pdf,ai,svg,xmp" + - variable: config.PHOTOPRISM_IMPORT_ALLOW + group: "Storage" + label: "Allowed Import Types" + description: "Comma-separated list of permitted import extensions." + type: string + default: "zip,jpeg,jpg,png,gif,bmp,avif,webp,heic,heif,tiff,pdf,ai,svg,xmp" + - variable: persistence.originals.enabled + group: "Storage" + label: "Enable Originals PVC" + description: "Provision a PVC for originals; disable when mounting NFS manually." + type: boolean + default: true + show_subquestion_if: true + subquestions: + - variable: persistence.originals.size + label: "Originals Volume Size" + description: "PVC size for /photoprism/originals (can be expanded later)." + type: string + default: "10Gi" + - variable: persistence.originals.nfs.enabled + label: "Mount Originals via NFS" + description: "Use an existing NFS export instead of a dynamically provisioned PVC." + type: boolean + default: false + show_subquestion_if: true + subquestions: + - variable: persistence.originals.nfs.server + label: "NFS Server" + description: "Hostname or IP of the NFS server. Example: nfs.internal.local." + type: string + required: true + - variable: persistence.originals.nfs.path + label: "NFS Export Path" + description: "Export path on the NFS server. Example: /exports/photos." + type: string + required: true + - variable: config.PHOTOPRISM_BACKUP_SCHEDULE + group: "Backup" + label: "Backup Schedule" + description: "Cron schedule or keyword (daily/weekly) controlling automated backups. Example: 0 3 * * *." + type: string + default: "daily" + - variable: config.PHOTOPRISM_BACKUP_RETAIN + group: "Backup" + label: "Backups to Keep" + description: "Number of backup archives to retain (-1 keeps all). Example: 3." + type: int + default: "3" + - variable: config.PHOTOPRISM_BACKUP_PATH + group: "Backup" + label: "Backup Path" + description: "Custom base directory for backups. Example: /photoprism/backups." + type: string + - variable: config.PHOTOPRISM_BACKUP_DATABASE + group: "Backup" + label: "Backup Database" + description: "Enable scheduled database backups." + type: boolean + default: true + - variable: config.PHOTOPRISM_BACKUP_ALBUMS + group: "Backup" + label: "Backup Albums" + description: "Include YAML album metadata in backups." + type: boolean + default: true + - variable: cluster.integration.enabled + group: "Cluster Integration" + label: "Enable Portal Integration" + description: "Set to true when a PhotoPrism Portal is available." + type: boolean + default: false + show_subquestion_if: true + subquestions: + - variable: cluster.integration.secretName + label: "Portal Secret Name" + description: "Secret containing PHOTOPRISM_CLUSTER_* values (defaults to photoprism-cluster-secrets)." + type: string + - variable: cluster.integration.domain + label: "Cluster Domain Override" + description: "Optional domain suffix when not using the shared secret." + type: string + - variable: cluster.integration.portalURL + label: "Portal URL" + description: "Portal base URL if no secret is provided." + type: string + - variable: cluster.integration.joinToken + label: "Join Token" + description: "Portal-issued token used to register this node. Example: node_abc123." + type: string + - variable: cluster.integration.uuid + label: "Cluster UUID" + description: "Unique cluster identifier provided by the portal." + type: string + - variable: cluster.integration.cidr + label: "Cluster CIDR" + description: "Allowed IP range for trusted cluster traffic. Example: 10.42.0.0/16." + type: string + - variable: cluster.integration.trustedProxy + label: "Trusted Proxy" + description: "Reverse proxy address forwarded in X-Forwarded-For headers." + type: string + - variable: cluster.integration.jwtScope + label: "JWT Scope" + description: "Scope names allowed for issued cluster tokens." + type: string diff --git a/setup/charts/plus/templates/NOTES.txt b/setup/charts/plus/templates/NOTES.txt new file mode 100644 index 000000000..64029728c --- /dev/null +++ b/setup/charts/plus/templates/NOTES.txt @@ -0,0 +1,36 @@ +PhotoPrism® has been deployed as release "{{ .Release.Name }}" in namespace "{{ .Release.Namespace }}". + +1. Retrieve the admin password (auto-generated on first install unless adminPassword was set): + + kubectl --namespace {{ .Release.Namespace }} get secret \ + {{ include "photoprism-plus.fullname" . }}-secrets \ + -o jsonpath="{.data.PHOTOPRISM_ADMIN_PASSWORD}" | base64 -d ; echo + + Sign in as "{{ .Values.adminUser }}" with that password. + +2. Access PhotoPrism: + +{{- if .Values.ingress.enabled }} + An Ingress was created. Once your controller assigns an address, browse to one of the configured hosts: + {{- range .Values.ingress.hosts }} + - http(s)://{{ .host }}{{ (index .paths 0).path }} + {{- else }} + - http(s)://{{ include "photoprism-plus.name" $ }}/ + {{- end }} +{{- else if eq .Values.service.type "LoadBalancer" }} + The service is type LoadBalancer; once an external IP is assigned, browse to it on port {{ .Values.service.port }}: + + kubectl --namespace {{ .Release.Namespace }} get svc {{ include "photoprism-plus.fullname" . }} +{{- else }} + Forward the service port to your workstation: + + kubectl --namespace {{ .Release.Namespace }} port-forward svc/{{ include "photoprism-plus.fullname" . }} {{ .Values.service.port }}:{{ .Values.service.port }} + + Then open http://localhost:{{ .Values.service.port }}/ in your browser. +{{- end }} + +3. Documentation: + + - User Guide: https://docs.photoprism.app/user-guide/ + - Knowledge Base: https://www.photoprism.app/kb/ + - Support: https://www.photoprism.app/kb/getting-support/ diff --git a/setup/charts/plus/templates/_helpers.tpl b/setup/charts/plus/templates/_helpers.tpl new file mode 100644 index 000000000..fc7ed29f3 --- /dev/null +++ b/setup/charts/plus/templates/_helpers.tpl @@ -0,0 +1,63 @@ +{{/* +General helpers for the PhotoPrism Plus chart +*/}} +{{- define "photoprism-plus.name" -}} +{{- if .Values.nameOverride -}} +{{- .Values.nameOverride | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- "photoprism" -}} +{{- end -}} +{{- end -}} + +{{- define "photoprism-plus.fullname" -}} +{{- if .Values.fullnameOverride -}} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- printf "%s-photoprism" .Release.Name | trunc 63 | trimSuffix "-" -}} +{{- end -}} +{{- end -}} + +{{- define "photoprism-plus.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version -}} +{{- end -}} + +{{- define "photoprism-plus.labels" -}} +helm.sh/chart: {{ include "photoprism-plus.chart" . }} +app.kubernetes.io/name: {{ include "photoprism-plus.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end -}} + +{{- define "photoprism-plus.clusterSecretName" -}} +{{- if .Values.cluster.integration.secretName -}} +{{- .Values.cluster.integration.secretName -}} +{{- else -}} +photoprism-cluster-secrets +{{- end -}} +{{- end -}} + +{{- define "photoprism-plus.clusterDomain" -}} +{{- $domain := default "" .Values.cluster.integration.domain | trim -}} +{{- if and (eq $domain "") .Values.cluster.integration.enabled -}} + {{- $secret := lookup "v1" "Secret" .Release.Namespace (include "photoprism-plus.clusterSecretName" .) -}} + {{- if $secret -}} + {{- $encoded := index $secret.data "PHOTOPRISM_CLUSTER_DOMAIN" -}} + {{- if $encoded -}} + {{- $domain = b64dec $encoded | trim -}} + {{- end -}} + {{- end -}} +{{- end -}} +{{- $domain -}} +{{- end -}} + +{{- define "photoprism-plus.siteURL" -}} +{{- $site := default "" .Values.config.PHOTOPRISM_SITE_URL | trim -}} +{{- if and (eq $site "") .Values.cluster.integration.enabled -}} + {{- $domain := include "photoprism-plus.clusterDomain" . | trim -}} + {{- if ne $domain "" -}} + {{- printf "https://%s.%s/" .Release.Name $domain -}} + {{- end -}} +{{- else -}} + {{- $site -}} +{{- end -}} +{{- end -}} diff --git a/setup/charts/plus/templates/ingress.yaml b/setup/charts/plus/templates/ingress.yaml new file mode 100644 index 000000000..6e5a32d57 --- /dev/null +++ b/setup/charts/plus/templates/ingress.yaml @@ -0,0 +1,54 @@ +{{- if .Values.ingress.enabled }} +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: {{ include "photoprism-plus.fullname" . }} + labels: + {{- include "photoprism-plus.labels" . | nindent 4 }} + {{- if .Values.ingress.annotations }} + annotations: + {{- toYaml .Values.ingress.annotations | nindent 4 }} + {{- end }} +spec: + {{- if .Values.ingress.className }} + ingressClassName: {{ .Values.ingress.className }} + {{- end }} + rules: + {{- if not .Values.ingress.hosts }} + - host: {{ printf "%s" (include "photoprism-plus.name" .) | quote }} + http: + paths: + - path: / + pathType: Prefix + backend: + service: + name: {{ include "photoprism-plus.fullname" . }} + port: + number: {{ .Values.service.port }} + {{- else }} + {{- range .Values.ingress.hosts }} + - host: {{ tpl .host $ | quote }} + http: + paths: + {{- range .paths }} + - path: {{ .path }} + pathType: {{ .pathType | default "Prefix" }} + backend: + service: + name: {{ include "photoprism-plus.fullname" $ }} + port: + number: {{ $.Values.service.port }} + {{- end }} + {{- end }} + {{- end }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ tpl . $ | quote }} + {{- end }} + {{- if .secretName }} + secretName: {{ tpl .secretName $ | quote }} + {{- end }} + {{- end }} +{{- end }} diff --git a/setup/charts/plus/templates/photoprism-originals.yaml b/setup/charts/plus/templates/photoprism-originals.yaml new file mode 100644 index 000000000..033934f0b --- /dev/null +++ b/setup/charts/plus/templates/photoprism-originals.yaml @@ -0,0 +1,17 @@ +{{- $orig := .Values.persistence.originals -}} +{{- if and $orig.enabled (not $orig.nfs.enabled) }} +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: {{ include "photoprism-plus.fullname" . }}-originals + labels: + {{- include "photoprism-plus.labels" . | nindent 4 }} +spec: + accessModes: {{ toYaml $orig.accessModes | nindent 4 }} + resources: + requests: + storage: {{ $orig.size }} +{{- if .Values.persistence.storageClassName }} + storageClassName: {{ .Values.persistence.storageClassName }} +{{- end }} +{{- end }} diff --git a/setup/charts/plus/templates/photoprism-storage.yaml b/setup/charts/plus/templates/photoprism-storage.yaml new file mode 100644 index 000000000..e8e26a1ac --- /dev/null +++ b/setup/charts/plus/templates/photoprism-storage.yaml @@ -0,0 +1,17 @@ +{{- $store := .Values.persistence.storage -}} +{{- if $store.enabled }} +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: {{ include "photoprism-plus.fullname" . }}-storage + labels: + {{- include "photoprism-plus.labels" . | nindent 4 }} +spec: + accessModes: {{ toYaml $store.accessModes | nindent 4 }} + resources: + requests: + storage: {{ $store.size }} +{{- if .Values.persistence.storageClassName }} + storageClassName: {{ .Values.persistence.storageClassName }} +{{- end }} +{{- end }} diff --git a/setup/charts/plus/templates/secret.yaml b/setup/charts/plus/templates/secret.yaml new file mode 100644 index 000000000..77d07a1e7 --- /dev/null +++ b/setup/charts/plus/templates/secret.yaml @@ -0,0 +1,44 @@ +{{- /* + Recover existing passwords via lookup so upgrades keep the same values. + On first install, a random admin password is generated. Note that lookup + returns nil under `helm template` and `helm install --dry-run`, so those + invocations always print a fresh random — cosmetic only; real installs + preserve the stored value. +*/ -}} +{{- $secretName := printf "%s-secrets" (include "photoprism-plus.fullname" .) -}} +{{- $existing := lookup "v1" "Secret" .Release.Namespace $secretName -}} +{{- $existingAdmin := "" -}} +{{- $existingDb := "" -}} +{{- if $existing -}} + {{- $existingAdmin = default "" (index $existing.data "PHOTOPRISM_ADMIN_PASSWORD") | b64dec | trim -}} + {{- $existingDb = default "" (index $existing.data "PHOTOPRISM_DATABASE_PASSWORD") | b64dec | trim -}} +{{- end -}} +{{- $adminPassword := default "" (.Values.adminPassword | toString | trim) -}} +{{- if eq $adminPassword "" -}} + {{- if ne $existingAdmin "" -}} + {{- $adminPassword = $existingAdmin -}} + {{- else -}} + {{- $adminPassword = randAlphaNum 16 -}} + {{- end -}} +{{- end -}} +{{- /* + Skip the managed database password entirely when an external secret is + referenced, so a credential isn't duplicated into this Secret unused. +*/ -}} +{{- $dbPassword := "" -}} +{{- if not .Values.database.passwordSecretName -}} + {{- $dbPassword = default "" (.Values.database.password | toString | trim) -}} + {{- if and (eq $dbPassword "") (ne $existingDb "") -}} + {{- $dbPassword = $existingDb -}} + {{- end -}} +{{- end -}} +apiVersion: v1 +kind: Secret +metadata: + name: {{ $secretName }} +type: Opaque +stringData: + PHOTOPRISM_ADMIN_PASSWORD: {{ $adminPassword | quote }} + {{- if ne $dbPassword "" }} + PHOTOPRISM_DATABASE_PASSWORD: {{ $dbPassword | quote }} + {{- end }} diff --git a/setup/charts/plus/templates/service.yaml b/setup/charts/plus/templates/service.yaml new file mode 100644 index 000000000..2662e4dec --- /dev/null +++ b/setup/charts/plus/templates/service.yaml @@ -0,0 +1,20 @@ +{{- if hasKey .Values.service "enable" -}} +{{- fail "service.enable has been renamed to service.enabled — please update your values overrides." -}} +{{- end -}} +{{- if .Values.service.enabled }} +apiVersion: v1 +kind: Service +metadata: + name: {{ include "photoprism-plus.fullname" . }} + labels: + {{- include "photoprism-plus.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + selector: + app.kubernetes.io/name: {{ include "photoprism-plus.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + ports: + - name: http + port: {{ .Values.service.port }} + targetPort: 2342 +{{- end }} diff --git a/setup/charts/plus/templates/statefulset.yaml b/setup/charts/plus/templates/statefulset.yaml new file mode 100644 index 000000000..91ed64204 --- /dev/null +++ b/setup/charts/plus/templates/statefulset.yaml @@ -0,0 +1,159 @@ +apiVersion: apps/v1 +kind: StatefulSet +metadata: + name: {{ include "photoprism-plus.fullname" . }} + labels: + {{- include "photoprism-plus.labels" . | nindent 4 }} +spec: + replicas: {{ .Values.replicaCount }} + selector: + matchLabels: + app.kubernetes.io/name: {{ include "photoprism-plus.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + serviceName: {{ include "photoprism-plus.fullname" . }} + template: + metadata: + labels: + app.kubernetes.io/name: {{ include "photoprism-plus.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + spec: + {{- with .Values.podSecurityContext }} + securityContext: + {{- toYaml . | nindent 8 }} + {{- end }} + containers: + - name: {{ .Chart.Name }} + image: "{{ .Values.image.repository }}:{{ default .Chart.AppVersion .Values.image.tag }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + {{- with .Values.securityContext }} + securityContext: + {{- toYaml . | nindent 12 }} + {{- end }} + {{- if .Values.command }} + command: + {{- range .Values.command }} + - {{ . | quote }} + {{- end }} + {{- end }} + {{- if .Values.args }} + args: + {{- range .Values.args }} + - {{ . | quote }} + {{- end }} + {{- end }} + env: + {{- $siteURL := include "photoprism-plus.siteURL" . | trim -}} + {{- if ne $siteURL "" }} + - name: PHOTOPRISM_SITE_URL + value: {{ $siteURL | quote }} + {{- end }} + {{- if .Values.cluster.integration.enabled }} + {{- $integration := .Values.cluster.integration -}} + {{- $secretName := include "photoprism-plus.clusterSecretName" . | trim -}} + {{- $clusterFields := dict + "PHOTOPRISM_PORTAL_URL" $integration.portalURL + "PHOTOPRISM_CLUSTER_DOMAIN" $integration.domain + "PHOTOPRISM_CLUSTER_UUID" $integration.uuid + "PHOTOPRISM_CLUSTER_CIDR" $integration.cidr + "PHOTOPRISM_TRUSTED_PROXY" $integration.trustedProxy + "PHOTOPRISM_JOIN_TOKEN" $integration.joinToken + "PHOTOPRISM_JWT_SCOPE" $integration.jwtScope -}} + {{- range $key, $value := $clusterFields }} + {{- $inline := trim (default "" $value) -}} + {{- if ne $inline "" }} + - name: {{ $key }} + value: {{ $inline | quote }} + {{- else if ne $secretName "" }} + - name: {{ $key }} + valueFrom: + secretKeyRef: + name: {{ $secretName | quote }} + key: {{ $key }} + optional: true + {{- end }} + {{- end }} + {{- end }} + - name: PHOTOPRISM_ADMIN_USER + value: {{ .Values.adminUser | quote }} + - name: PHOTOPRISM_ADMIN_PASSWORD + valueFrom: + secretKeyRef: + name: {{ printf "%s-secrets" (include "photoprism-plus.fullname" .) }} + key: PHOTOPRISM_ADMIN_PASSWORD + - name: PHOTOPRISM_DATABASE_DRIVER + value: {{ .Values.database.driver | quote }} + {{- $dbServer := trim (default "" .Values.database.server) -}} + {{- if ne $dbServer "" }} + - name: PHOTOPRISM_DATABASE_SERVER + value: {{ $dbServer | quote }} + {{- end }} + {{- $dbName := trim (default "" .Values.database.name) -}} + {{- if ne $dbName "" }} + - name: PHOTOPRISM_DATABASE_NAME + value: {{ $dbName | quote }} + {{- end }} + {{- $dbUser := trim (default "" .Values.database.user) -}} + {{- if ne $dbUser "" }} + - name: PHOTOPRISM_DATABASE_USER + value: {{ $dbUser | quote }} + {{- end }} + {{- if .Values.database.passwordSecretName }} + - name: PHOTOPRISM_DATABASE_PASSWORD + valueFrom: + secretKeyRef: + name: {{ .Values.database.passwordSecretName | quote }} + key: {{ (default "PHOTOPRISM_DATABASE_PASSWORD" .Values.database.passwordSecretKey) | quote }} + {{- else if ne (trim (default "" .Values.database.password)) "" }} + - name: PHOTOPRISM_DATABASE_PASSWORD + valueFrom: + secretKeyRef: + name: {{ printf "%s-secrets" (include "photoprism-plus.fullname" .) }} + key: PHOTOPRISM_DATABASE_PASSWORD + {{- end }} + - name: PHOTOPRISM_DATABASE_TIMEOUT + value: {{ printf "%v" .Values.database.timeout | quote }} + - name: PHOTOPRISM_DATABASE_CONNS + value: {{ printf "%v" .Values.database.conns | quote }} + - name: PHOTOPRISM_DATABASE_CONNS_IDLE + value: {{ printf "%v" .Values.database.connsIdle | quote }} + {{- range $key, $value := .Values.oidc }} + {{- if ne (printf "%v" $value) "" }} + - name: {{ $key }} + value: {{ printf "%v" $value | quote }} + {{- end }} + {{- end }} + {{- range $key, $value := .Values.config }} + {{- if ne (printf "%v" $value) "" }} + - name: {{ $key }} + value: {{ printf "%v" $value | quote }} + {{- end }} + {{- end }} + ports: + - containerPort: 2342 + name: http + volumeMounts: + {{- if .Values.persistence.originals.enabled }} + - name: originals + mountPath: {{ .Values.persistence.originals.mountPath }} + {{- end }} + {{- if .Values.persistence.storage.enabled }} + - name: storage + mountPath: {{ .Values.persistence.storage.mountPath }} + {{- end }} + volumes: + {{- if .Values.persistence.originals.enabled }} + - name: originals + {{- if and .Values.persistence.originals.enabled .Values.persistence.originals.nfs.enabled }} + nfs: + server: {{ required "persistence.originals.nfs.server is required when NFS mode is enabled" .Values.persistence.originals.nfs.server | quote }} + path: {{ required "persistence.originals.nfs.path is required when NFS mode is enabled" .Values.persistence.originals.nfs.path | quote }} + {{- else }} + persistentVolumeClaim: + claimName: {{ include "photoprism-plus.fullname" . }}-originals + {{- end }} + {{- end }} + {{- if .Values.persistence.storage.enabled }} + - name: storage + persistentVolumeClaim: + claimName: {{ include "photoprism-plus.fullname" . }}-storage + {{- end }} diff --git a/setup/charts/plus/values.yaml b/setup/charts/plus/values.yaml new file mode 100644 index 000000000..ff9dccb1c --- /dev/null +++ b/setup/charts/plus/values.yaml @@ -0,0 +1,164 @@ +# Default values for the PhotoPrism® Helm chart. +# These defaults are tuned for home labs and small teams; enable the optional +# portal integration block only if a PhotoPrism Portal is available in your cluster. + +replicaCount: 1 + +image: + repository: docker.io/photoprism/photoprism + tag: "" + pullPolicy: IfNotPresent + +command: [] +args: [] + +securityContext: + allowPrivilegeEscalation: false + runAsNonRoot: true + capabilities: + drop: + - ALL + seccompProfile: + type: RuntimeDefault + runAsUser: 1000 + runAsGroup: 1000 + +podSecurityContext: + fsGroup: 1000 + fsGroupChangePolicy: OnRootMismatch + +nameOverride: "" +fullnameOverride: "" + +adminUser: "admin" +adminPassword: "" + +cluster: + integration: + enabled: false + secretName: "" + domain: "" + portalURL: "" + uuid: "" + cidr: "" + trustedProxy: "" + joinToken: "" + jwtScope: "" + +persistence: + storageClassName: "" + originals: + enabled: true + size: 10Gi + accessModes: + - ReadWriteOnce + mountPath: /photoprism/originals + nfs: + enabled: false + server: "" + path: "" + storage: + enabled: true + size: 5Gi + accessModes: + - ReadWriteOnce + mountPath: /photoprism/storage + +service: + enabled: true + type: ClusterIP + port: 2342 + +ingress: + enabled: false + className: "" + annotations: {} + hosts: [] + tls: [] + +resources: + limits: + cpu: 4000m + memory: 6Gi + requests: + cpu: 500m + memory: 1Gi + +nodeSelector: {} +tolerations: [] +affinity: {} + +oidc: + PHOTOPRISM_DISABLE_OIDC: true + PHOTOPRISM_OIDC_URI: "" + PHOTOPRISM_OIDC_CLIENT: "" + PHOTOPRISM_OIDC_SECRET: "" + PHOTOPRISM_OIDC_SCOPES: "openid email profile" + PHOTOPRISM_OIDC_PROMPT: "" + PHOTOPRISM_OIDC_REGISTER: true + PHOTOPRISM_OIDC_REDIRECT: false + PHOTOPRISM_OIDC_USERNAME: "email" + PHOTOPRISM_OIDC_PROVIDER: "" + PHOTOPRISM_OIDC_ICON: "" + PHOTOPRISM_OIDC_WEBDAV: false + +config: + PHOTOPRISM_SITE_URL: "" + PHOTOPRISM_SITE_NAME: "" + PHOTOPRISM_SITE_TITLE: "PhotoPrism" + PHOTOPRISM_SITE_CAPTION: "" + PHOTOPRISM_SITE_DESCRIPTION: "" + PHOTOPRISM_SITE_AUTHOR: "" + PHOTOPRISM_SITE_FAVICON: "" + PHOTOPRISM_SITE_PREVIEW: "" + PHOTOPRISM_APP_NAME: "PhotoPrism" + PHOTOPRISM_APP_ICON: "" + PHOTOPRISM_APP_COLOR: "#1d1d1e" + PHOTOPRISM_DEFAULT_THEME: "" + PHOTOPRISM_DEFAULT_LOCALE: "en" + PHOTOPRISM_DEFAULT_TIMEZONE: "" + PHOTOPRISM_PLACES_LOCALE: "local" + PHOTOPRISM_AUTH_MODE: "password" + PHOTOPRISM_PASSWORD_LENGTH: 8 + PHOTOPRISM_SESSION_MAXAGE: 1209600 + PHOTOPRISM_SESSION_TIMEOUT: 604800 + PHOTOPRISM_SESSION_CACHE: 900 + PHOTOPRISM_LOGIN_INFO: "" + PHOTOPRISM_LOG_LEVEL: "info" + PHOTOPRISM_HTTP_COMPRESSION: "zstd,gzip" + PHOTOPRISM_CDN_URL: "" + PHOTOPRISM_CDN_VIDEO: "" + PHOTOPRISM_CORS_ORIGIN: "" + PHOTOPRISM_CORS_HEADERS: "Accept, Accept-Ranges, Content-Disposition, Content-Encoding, Content-Range, Location" + PHOTOPRISM_CORS_METHODS: "GET, HEAD, OPTIONS" + PHOTOPRISM_LEGAL_INFO: "" + PHOTOPRISM_LEGAL_URL: "" + PHOTOPRISM_BACKUP_SCHEDULE: "daily" + PHOTOPRISM_BACKUP_RETAIN: "3" + PHOTOPRISM_BACKUP_DATABASE: true + PHOTOPRISM_BACKUP_ALBUMS: true + PHOTOPRISM_BACKUP_PATH: "" + PHOTOPRISM_FILES_QUOTA: 0 + PHOTOPRISM_ORIGINALS_LIMIT: 5000 + PHOTOPRISM_UPLOAD_LIMIT: 5000 + PHOTOPRISM_UPLOAD_ALLOW: "zip,jpeg,jpg,png,gif,bmp,avif,webp,heic,heif,tiff,pdf,ai,svg,xmp" + PHOTOPRISM_IMPORT_ALLOW: "zip,jpeg,jpg,png,gif,bmp,avif,webp,heic,heif,tiff,pdf,ai,svg,xmp" + PHOTOPRISM_UPLOAD_ARCHIVES: true + PHOTOPRISM_UPLOAD_NSFW: true + PHOTOPRISM_DISABLE_TLS: true + PHOTOPRISM_DISABLE_STS: true + PHOTOPRISM_DISABLE_MCP: false + PHOTOPRISM_WALLPAPER_URI: "" + +# Database connection overrides (blank defaults keep PhotoPrism's internal sqlite) +database: + driver: "sqlite" + server: "" + name: "photoprism" + user: "photoprism" + password: "" + passwordSecretName: "" + passwordSecretKey: "" + timeout: 15 + conns: 0 + connsIdle: 0 diff --git a/setup/cloud/digitalocean/compose.yaml b/setup/cloud/digitalocean/compose.yaml index 1a2e553db..b50eedc06 100644 --- a/setup/cloud/digitalocean/compose.yaml +++ b/setup/cloud/digitalocean/compose.yaml @@ -123,12 +123,13 @@ services: environment: ## !! CHANGE site url if your server has a public domain name e.g. "https://photos.yourdomain.com/" !! PHOTOPRISM_SITE_URL: "https://_public_ip_/" - PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" - PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description - PHOTOPRISM_SITE_AUTHOR: "" # meta site author + PHOTOPRISM_SITE_NAME: "" # short name for identifying this instance within a cluster + PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" # short caption or tagline shown alongside the title + PHOTOPRISM_SITE_DESCRIPTION: "" # longer description shown in SEO and social meta tags + PHOTOPRISM_SITE_AUTHOR: "" # site owner shown in the author meta tag PHOTOPRISM_ADMIN_PASSWORD: "_admin_password_" # YOUR INITIAL "admin" PASSWORD PHOTOPRISM_AUTH_MODE: "password" # authentication mode (public, password) - PHOTOPRISM_HTTP_COMPRESSION: "gzip" # improves transfer speed and bandwidth utilization (none or gzip) + PHOTOPRISM_HTTP_COMPRESSION: "zstd,gzip" # improves transfer speed and bandwidth utilization (none, gzip, zstd, or comma-separated list e.g. "zstd,gzip") PHOTOPRISM_LOG_LEVEL: "info" # log level: trace, debug, info, warning, or error PHOTOPRISM_READONLY: "false" # do not modify originals directory (reduced functionality) PHOTOPRISM_EXPERIMENTAL: "false" # enables experimental features @@ -136,6 +137,7 @@ services: PHOTOPRISM_DEFAULT_TLS: "true" # defaults to a self-signed HTTPS/TLS certificate if no other certificate is available PHOTOPRISM_DISABLE_CHOWN: "false" # disables updating storage permissions via chmod and chown on startup PHOTOPRISM_DISABLE_WEBDAV: "false" # disables built-in WebDAV server + PHOTOPRISM_DISABLE_MCP: "false" # disables Model Context Protocol (MCP) API endpoint for AI agent integrations PHOTOPRISM_DISABLE_SETTINGS: "false" # disables Settings in Web UI PHOTOPRISM_DISABLE_TENSORFLOW: "false" # disables all features depending on TensorFlow PHOTOPRISM_DISABLE_FACES: "false" # disables face detection and recognition (requires TensorFlow) @@ -158,7 +160,7 @@ services: ## Run/install on first startup, see https://github.com/photoprism/photoprism/blob/develop/scripts/dist/Makefile: PHOTOPRISM_INIT: "https tensorflow" # common options: update https tensorflow tensorflow-gpu intel gpu davfs yt-dlp ## Video Transcoding (https://docs.photoprism.app/getting-started/advanced/transcoding/): - # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) + # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, vaapi, or vulkan) # PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840) # PHOTOPRISM_FFMPEG_BITRATE: "32" # video bitrate limit in Mbps (default: 60) working_dir: "/photoprism" # do not change or remove @@ -190,7 +192,7 @@ services: ## MariaDB Database Server (recommended) ## see https://docs.photoprism.app/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql mariadb: - image: mariadb:11 + image: mariadb:12.3 container_name: mariadb restart: always stop_grace_period: 15s diff --git a/setup/cloud/digitalocean/init/check.sh b/setup/cloud/digitalocean/init/check.sh index 4988d3ef4..a55802ee7 100755 --- a/setup/cloud/digitalocean/init/check.sh +++ b/setup/cloud/digitalocean/init/check.sh @@ -360,12 +360,12 @@ function checkFirewall { elif [[ $OS == "CentOS Linux" ]] || [[ $OS == "CentOS Stream" ]] || [[ $OS == "Rocky Linux" ]] || [[ $OS == "AlmaLinux" ]]; then if [ -f /usr/lib/systemd/system/csf.service ]; then fw="csf" - if [[ $(systemctl status $fw >/dev/null 2>&1) ]]; then + if systemctl is-active --quiet "$fw"; then FW_VER="\e[32m[PASS]\e[0m Firewall service (${fw}) is active\n" ((PASS++)) elif cmdExists "firewall-cmd"; then - if [[ $(systemctl is-active firewalld >/dev/null 2>&1 && echo 1 || echo 0) ]]; then + if systemctl is-active --quiet firewalld; then FW_VER="\e[32m[PASS]\e[0m Firewall service (${fw}) is active\n" ((PASS++)) else @@ -378,7 +378,7 @@ function checkFirewall { fi else fw="firewalld" - if [[ $(systemctl is-active firewalld >/dev/null 2>&1 && echo 1 || echo 0) ]]; then + if systemctl is-active --quiet "$fw"; then FW_VER="\e[32m[PASS]\e[0m Firewall service (${fw}) is active\n" ((PASS++)) else @@ -401,7 +401,7 @@ function checkFirewall { fi elif cmdExists "firewall-cmd"; then fw="firewalld" - if [[ $(systemctl is-active --quiet $fw) ]]; then + if systemctl is-active --quiet "$fw"; then FW_VER="\e[32m[PASS]\e[0m Firewall service (${fw}) is active\n" ((PASS++)) else diff --git a/setup/docker/arm64/README b/setup/docker/arm64/README index 1bfde7d5a..a024cbf1f 100644 --- a/setup/docker/arm64/README +++ b/setup/docker/arm64/README @@ -12,7 +12,7 @@ single-arch ARM64 images (updated and tested less frequently): Stable Release : photoprism/photoprism:arm64 Development Preview: photoprism/photoprism:preview-arm64 - MariaDB : arm64v8/mariadb:11 + MariaDB : arm64v8/mariadb:12.3 If your device meets the system requirements, mostly the same installation instructions as for regular Linux servers apply: diff --git a/setup/docker/arm64/compose.yaml b/setup/docker/arm64/compose.yaml index 42e18b837..1fc9fcfc7 100644 --- a/setup/docker/arm64/compose.yaml +++ b/setup/docker/arm64/compose.yaml @@ -19,7 +19,7 @@ # Setup Guides: # - https://docs.photoprism.app/getting-started/docker-compose/ # - https://docs.photoprism.app/getting-started/raspberry-pi/ -# - https://www.photoprism.app/kb/activation +# - https://www.photoprism.app/kb/activation/ # # Troubleshooting Checklists: # - https://docs.photoprism.app/getting-started/troubleshooting/ @@ -62,15 +62,17 @@ services: PHOTOPRISM_DEFAULT_LOCALE: "en" # default user interface language, e.g. "en" or "de" PHOTOPRISM_PLACES_LOCALE: "local" # location details language, e.g. "local", "en", or "de" PHOTOPRISM_SITE_URL: "http://localhost:2342/" # server URL in the format "http(s)://domain.name(:port)/(path)" - PHOTOPRISM_SITE_TITLE: "PhotoPrism" - PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" - PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description - PHOTOPRISM_SITE_AUTHOR: "" # meta site author + PHOTOPRISM_SITE_NAME: "" # short name for identifying this instance within a cluster + PHOTOPRISM_SITE_TITLE: "PhotoPrism" # main title shown in the web interface and meta tags + PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" # short caption or tagline shown alongside the title + PHOTOPRISM_SITE_DESCRIPTION: "" # longer description shown in SEO and social meta tags + PHOTOPRISM_SITE_AUTHOR: "" # site owner shown in the author meta tag PHOTOPRISM_LOG_LEVEL: "info" # log level: trace, debug, info, warning, or error PHOTOPRISM_READONLY: "false" # do not modify originals directory (reduced functionality) PHOTOPRISM_EXPERIMENTAL: "false" # enables experimental features PHOTOPRISM_DISABLE_CHOWN: "false" # disables updating storage permissions via chmod and chown on startup PHOTOPRISM_DISABLE_WEBDAV: "false" # disables built-in WebDAV server + PHOTOPRISM_DISABLE_MCP: "false" # disables Model Context Protocol (MCP) API endpoint for AI agent integrations PHOTOPRISM_DISABLE_SETTINGS: "false" # disables settings UI and API PHOTOPRISM_DISABLE_TENSORFLOW: "false" # disables all features depending on TensorFlow PHOTOPRISM_DISABLE_FACES: "false" # disables face detection and recognition (requires TensorFlow) @@ -91,7 +93,7 @@ services: PHOTOPRISM_UPLOAD_ARCHIVES: "true" # allows upload of zip archives (will be extracted before import) PHOTOPRISM_UPLOAD_LIMIT: 5000 # maximum size of uploaded files and uncompressed archive contents in MB PHOTOPRISM_ORIGINALS_LIMIT: 5000 # maximum size of original media files in MB (larger files are skipped) - PHOTOPRISM_HTTP_COMPRESSION: "gzip" # improves transfer speed and bandwidth utilization (none or gzip) + PHOTOPRISM_HTTP_COMPRESSION: "zstd,gzip" # improves transfer speed and bandwidth utilization (none, gzip, zstd, or comma-separated list e.g. "zstd,gzip") PHOTOPRISM_WORKERS: 2 # maximum number of indexing workers (limits system load) # PHOTOPRISM_DATABASE_DRIVER: "sqlite" # SQLite is an embedded database that does not require a separate database server PHOTOPRISM_DATABASE_DRIVER: "mysql" # MariaDB 10.5.12+ (MySQL successor) offers significantly better performance compared to SQLite @@ -108,7 +110,7 @@ services: OLLAMA_BASE_URL: "http://ollama:11434" # use "https://ollama.com" for Ollama Cloud OLLAMA_API_KEY: "" # API key required to access Ollama (optional) ## Video Transcoding (https://docs.photoprism.app/getting-started/advanced/transcoding/): - # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) + # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, vaapi, or vulkan) # PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840) # PHOTOPRISM_FFMPEG_BITRATE: "64" # video bitrate limit in Mbps (default: 60) ## Run as a non-root user after initialization (supported: 0, 33, 50-99, 500-600, and 900-1200): @@ -132,7 +134,7 @@ services: ## MariaDB Database Server (recommended) ## see https://docs.photoprism.app/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql mariadb: - image: arm64v8/mariadb:11 # ARM64 IMAGE ONLY, DOES NOT WORK ON ARMv7, AMD or Intel + image: arm64v8/mariadb:12.3 # ARM64 IMAGE ONLY, DOES NOT WORK ON ARMv7, AMD or Intel platform: "linux/arm64" ## If MariaDB gets stuck in a restart loop, this points to a memory or filesystem issue: ## https://docs.photoprism.app/getting-started/troubleshooting/#fatal-server-errors @@ -162,7 +164,7 @@ services: image: ollama/ollama:latest restart: unless-stopped stop_grace_period: 15s - ## Only starts this service if the "all", "ollama", or "vision" profile is specified:: + ## Only starts if the "all", "ollama", or "vision" profile is specified: ## docker compose --profile ollama up -d profiles: ["all", "ollama", "vision"] ## Insecurely exposes the Ollama service on port 11434 @@ -182,12 +184,15 @@ services: OLLAMA_MULTIUSER_CACHE: "false" # optimize prompt caching for multi-user scenarios OLLAMA_NOPRUNE: "false" # disables pruning of model blobs at startup OLLAMA_NOHISTORY: "true" # disables readline history - OLLAMA_FLASH_ATTENTION: "false" # enables the experimental flash attention feature - OLLAMA_KV_CACHE_TYPE: "f16" # cache quantization (f16, q8_0, or q4_0) + OLLAMA_FLASH_ATTENTION: "true" # required for OLLAMA_KV_CACHE_TYPE quantization + OLLAMA_KV_CACHE_TYPE: "f16" # cache precision: f16 (default), q8_0, q4_0 OLLAMA_SCHED_SPREAD: "false" # allows scheduling models across all GPUs. - OLLAMA_NEW_ENGINE: "true" # enables the new Ollama engine # OLLAMA_DEBUG: "true" # shows additional debug information # OLLAMA_INTEL_GPU: "true" # enables experimental Intel GPU detection + ## Telemetry / privacy opt-outs (containers do not inherit /etc/environment): + DO_NOT_TRACK: "true" + HF_HUB_DISABLE_TELEMETRY: "1" + # OLLAMA_NO_CLOUD: "1" # uncomment to disable Ollama Cloud models/features volumes: - "./ollama:/root/.ollama" @@ -197,7 +202,7 @@ services: image: ghcr.io/open-webui/open-webui:main restart: unless-stopped stop_grace_period: 5s - ## Only starts this service if the "all", "ollama", "open-webui", or "vision" profile is specified:: + ## Only starts if the "all", "ollama", "open-webui", or "vision" profile is specified: ## docker compose --profile ollama up -d profiles: [ "all", "ollama", "open-webui", "vision" ] ## Exposes Open WebUI at http://localhost:8080 (use an HTTPS reverse proxy for remote access): @@ -219,7 +224,7 @@ services: watchtower: image: nickfedor/watchtower restart: unless-stopped - ## Only starts this service if the "update" profile is specified:: + ## Only starts if the "update" profile is specified: ## docker compose --profile update up -d profiles: [ "update" ] environment: diff --git a/setup/docker/armv7/compose.yaml b/setup/docker/armv7/compose.yaml index 00d4a2d02..7b5c7c12a 100644 --- a/setup/docker/armv7/compose.yaml +++ b/setup/docker/armv7/compose.yaml @@ -14,7 +14,7 @@ # Setup Guides: # - https://docs.photoprism.app/getting-started/docker-compose/ # - https://docs.photoprism.app/getting-started/raspberry-pi/ -# - https://www.photoprism.app/kb/activation +# - https://www.photoprism.app/kb/activation/ # # Troubleshooting Checklists: # - https://docs.photoprism.app/getting-started/troubleshooting/ @@ -57,13 +57,14 @@ services: PHOTOPRISM_SITE_URL: "http://localhost:2342/" # server URL in the format "http(s)://domain.name(:port)/(path)" PHOTOPRISM_DISABLE_TLS: "false" # disables HTTPS/TLS even if the site URL starts with https:// and a certificate is available PHOTOPRISM_DEFAULT_TLS: "true" # defaults to a self-signed HTTPS/TLS certificate if no other certificate is available - PHOTOPRISM_HTTP_COMPRESSION: "none" # improves transfer speed and bandwidth utilization (none or gzip) + PHOTOPRISM_HTTP_COMPRESSION: "none" # improves transfer speed and bandwidth utilization (none, gzip, zstd, or comma-separated list e.g. "zstd,gzip") PHOTOPRISM_WORKERS: 1 # maximum number of indexing workers (limits system load) PHOTOPRISM_LOG_LEVEL: "info" # log level: trace, debug, info, warning, or error PHOTOPRISM_READONLY: "false" # do not modify originals directory (reduced functionality) PHOTOPRISM_EXPERIMENTAL: "false" # enables experimental features PHOTOPRISM_DISABLE_CHOWN: "false" # disables updating storage permissions via chmod and chown on startup PHOTOPRISM_DISABLE_WEBDAV: "false" # disables built-in WebDAV server + PHOTOPRISM_DISABLE_MCP: "false" # disables Model Context Protocol (MCP) API endpoint for AI agent integrations PHOTOPRISM_DISABLE_SETTINGS: "false" # disables Settings in Web UI PHOTOPRISM_DISABLE_TENSORFLOW: "false" # disables all features depending on TensorFlow PHOTOPRISM_DISABLE_FACES: "true" # disables face detection and recognition (requires TensorFlow) diff --git a/setup/docker/compose.yaml b/setup/docker/compose.yaml index bdfe69e51..932877a58 100644 --- a/setup/docker/compose.yaml +++ b/setup/docker/compose.yaml @@ -11,7 +11,7 @@ # Setup Guides: # - https://docs.photoprism.app/getting-started/docker-compose/ # - https://docs.photoprism.app/getting-started/raspberry-pi/ -# - https://www.photoprism.app/kb/activation +# - https://www.photoprism.app/kb/activation/ # # Troubleshooting Checklists: # - https://docs.photoprism.app/getting-started/troubleshooting/ @@ -53,15 +53,17 @@ services: PHOTOPRISM_DEFAULT_LOCALE: "en" # default user interface language, e.g. "en" or "de" PHOTOPRISM_PLACES_LOCALE: "local" # location details language, e.g. "local", "en", or "de" PHOTOPRISM_SITE_URL: "http://localhost:2342/" # server URL in the format "http(s)://domain.name(:port)/(path)" - PHOTOPRISM_SITE_TITLE: "PhotoPrism" - PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" - PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description - PHOTOPRISM_SITE_AUTHOR: "" # meta site author + PHOTOPRISM_SITE_NAME: "" # short name for identifying this instance within a cluster + PHOTOPRISM_SITE_TITLE: "PhotoPrism" # main title shown in the web interface and meta tags + PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" # short caption or tagline shown alongside the title + PHOTOPRISM_SITE_DESCRIPTION: "" # longer description shown in SEO and social meta tags + PHOTOPRISM_SITE_AUTHOR: "" # site owner shown in the author meta tag PHOTOPRISM_LOG_LEVEL: "info" # log level: trace, debug, info, warning, or error PHOTOPRISM_READONLY: "false" # do not modify originals directory (reduced functionality) PHOTOPRISM_EXPERIMENTAL: "false" # enables experimental features PHOTOPRISM_DISABLE_CHOWN: "false" # disables updating storage permissions via chmod and chown on startup PHOTOPRISM_DISABLE_WEBDAV: "false" # disables built-in WebDAV server + PHOTOPRISM_DISABLE_MCP: "false" # disables Model Context Protocol (MCP) API endpoint for AI agent integrations PHOTOPRISM_DISABLE_SETTINGS: "false" # disables settings UI and API PHOTOPRISM_DISABLE_TENSORFLOW: "false" # disables all features depending on TensorFlow PHOTOPRISM_DISABLE_FACES: "false" # disables face detection and recognition (requires TensorFlow) @@ -82,7 +84,7 @@ services: PHOTOPRISM_UPLOAD_ARCHIVES: "true" # allows upload of zip archives (will be extracted before import) PHOTOPRISM_UPLOAD_LIMIT: 5000 # maximum size of uploaded files and uncompressed archive contents in MB PHOTOPRISM_ORIGINALS_LIMIT: 5000 # maximum size of original media files in MB (larger files are skipped) - PHOTOPRISM_HTTP_COMPRESSION: "gzip" # improves transfer speed and bandwidth utilization (none or gzip) + PHOTOPRISM_HTTP_COMPRESSION: "zstd,gzip" # improves transfer speed and bandwidth utilization (none, gzip, zstd, or comma-separated list e.g. "zstd,gzip") # PHOTOPRISM_DATABASE_DRIVER: "sqlite" # SQLite is an embedded database that does not require a separate database server PHOTOPRISM_DATABASE_DRIVER: "mysql" # MariaDB 10.5.12+ (MySQL successor) offers significantly better performance compared to SQLite PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB database server (hostname:port) @@ -98,7 +100,7 @@ services: OLLAMA_BASE_URL: "http://ollama:11434" # use "https://ollama.com" for Ollama Cloud OLLAMA_API_KEY: "" # API key required to access Ollama (optional) ## Video Transcoding (https://docs.photoprism.app/getting-started/advanced/transcoding/): - # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) + # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, vaapi, or vulkan) # PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840) # PHOTOPRISM_FFMPEG_BITRATE: "64" # video bitrate limit in Mbps (default: 60) ## NVIDIA GPU Hardware Acceleration (see https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html): @@ -134,7 +136,7 @@ services: ## MariaDB Database Server (recommended) ## see https://docs.photoprism.app/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql mariadb: - image: mariadb:11 + image: mariadb:12.3 ## If MariaDB gets stuck in a restart loop, this points to a memory or filesystem issue: ## https://docs.photoprism.app/getting-started/troubleshooting/#fatal-server-errors restart: unless-stopped @@ -167,7 +169,7 @@ services: image: ollama/ollama:latest restart: unless-stopped stop_grace_period: 15s - ## Only starts this service if the "all", "ollama", or "vision" profile is specified:: + ## Only starts if the "all", "ollama", or "vision" profile is specified: ## docker compose --profile ollama up -d profiles: ["all", "ollama", "vision"] ## Insecurely exposes the Ollama service on port 11434 @@ -187,12 +189,15 @@ services: OLLAMA_MULTIUSER_CACHE: "false" # optimize prompt caching for multi-user scenarios OLLAMA_NOPRUNE: "false" # disables pruning of model blobs at startup OLLAMA_NOHISTORY: "true" # disables readline history - OLLAMA_FLASH_ATTENTION: "false" # enables the experimental flash attention feature - OLLAMA_KV_CACHE_TYPE: "f16" # cache quantization (f16, q8_0, or q4_0) + OLLAMA_FLASH_ATTENTION: "true" # required for OLLAMA_KV_CACHE_TYPE quantization + OLLAMA_KV_CACHE_TYPE: "f16" # cache precision: f16 (default), q8_0, q4_0 OLLAMA_SCHED_SPREAD: "false" # allows scheduling models across all GPUs. - OLLAMA_NEW_ENGINE: "true" # enables the new Ollama engine # OLLAMA_DEBUG: "true" # shows additional debug information # OLLAMA_INTEL_GPU: "true" # enables experimental Intel GPU detection + ## Telemetry / privacy opt-outs (containers do not inherit /etc/environment): + DO_NOT_TRACK: "true" + HF_HUB_DISABLE_TELEMETRY: "1" + # OLLAMA_NO_CLOUD: "1" # uncomment to disable Ollama Cloud models/features ## NVIDIA GPU Hardware Acceleration (see https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html): # NVIDIA_VISIBLE_DEVICES: "all" # NVIDIA_DRIVER_CAPABILITIES: "compute,utility" @@ -213,7 +218,7 @@ services: image: ghcr.io/open-webui/open-webui:main restart: unless-stopped stop_grace_period: 5s - ## Only starts this service if the "all", "ollama", "open-webui", or "vision" profile is specified:: + ## Only starts if the "all", "ollama", "open-webui", or "vision" profile is specified: ## docker compose --profile ollama up -d profiles: [ "all", "ollama", "open-webui", "vision" ] ## Exposes Open WebUI at http://localhost:8080 (use an HTTPS reverse proxy for remote access): @@ -235,7 +240,7 @@ services: watchtower: image: nickfedor/watchtower restart: unless-stopped - ## Only starts this service if the "update" profile is specified:: + ## Only starts if the "update" profile is specified: ## docker compose --profile update up -d profiles: ["update"] environment: diff --git a/setup/docker/macos/compose.yaml b/setup/docker/macos/compose.yaml index ff4c21e8a..934016ca1 100644 --- a/setup/docker/macos/compose.yaml +++ b/setup/docker/macos/compose.yaml @@ -10,7 +10,7 @@ # # Setup Guide: # - https://docs.photoprism.app/getting-started/docker-compose/ -# - https://www.photoprism.app/kb/activation +# - https://www.photoprism.app/kb/activation/ # # Troubleshooting Checklists: # - https://docs.photoprism.app/getting-started/troubleshooting/ @@ -49,12 +49,13 @@ services: PHOTOPRISM_SITE_URL: "http://localhost:2342/" # server URL in the format "http(s)://domain.name(:port)/(path)" PHOTOPRISM_DISABLE_TLS: "false" # disables HTTPS/TLS even if the site URL starts with https:// and a certificate is available PHOTOPRISM_DEFAULT_TLS: "true" # defaults to a self-signed HTTPS/TLS certificate if no other certificate is available - PHOTOPRISM_HTTP_COMPRESSION: "gzip" # improves transfer speed and bandwidth utilization (none or gzip) + PHOTOPRISM_HTTP_COMPRESSION: "zstd,gzip" # improves transfer speed and bandwidth utilization (none, gzip, zstd, or comma-separated list e.g. "zstd,gzip") PHOTOPRISM_LOG_LEVEL: "info" # log level: trace, debug, info, warning, or error PHOTOPRISM_READONLY: "false" # do not modify originals directory (reduced functionality) PHOTOPRISM_EXPERIMENTAL: "false" # enables experimental features PHOTOPRISM_DISABLE_CHOWN: "false" # disables updating storage permissions via chmod and chown on startup PHOTOPRISM_DISABLE_WEBDAV: "false" # disables built-in WebDAV server + PHOTOPRISM_DISABLE_MCP: "false" # disables Model Context Protocol (MCP) API endpoint for AI agent integrations PHOTOPRISM_DISABLE_SETTINGS: "false" # disables settings UI and API PHOTOPRISM_DISABLE_TENSORFLOW: "false" # disables all features depending on TensorFlow PHOTOPRISM_DISABLE_FACES: "false" # disables face detection and recognition (requires TensorFlow) @@ -79,9 +80,10 @@ services: PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB database, see MARIADB_DATABASE in the mariadb service PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database username, must be the same as MARIADB_USER PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database password, must be the same as MARIADB_PASSWORD - PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" - PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description - PHOTOPRISM_SITE_AUTHOR: "" # meta site author + PHOTOPRISM_SITE_NAME: "" # short name for identifying this instance within a cluster + PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" # short caption or tagline shown alongside the title + PHOTOPRISM_SITE_DESCRIPTION: "" # longer description shown in SEO and social meta tags + PHOTOPRISM_SITE_AUTHOR: "" # site owner shown in the author meta tag ## Run/install on first startup, see https://github.com/photoprism/photoprism/blob/develop/scripts/dist/Makefile: PHOTOPRISM_INIT: "https tensorflow" # common options: update https tensorflow tensorflow-gpu intel gpu davfs yt-dlp ## Computer Vision (https://docs.photoprism.app/getting-started/config-options/#computer-vision): @@ -91,7 +93,7 @@ services: OLLAMA_BASE_URL: "http://ollama:11434" # use "https://ollama.com" for Ollama Cloud OLLAMA_API_KEY: "" # API key required to access Ollama (optional) ## Video Transcoding (https://docs.photoprism.app/getting-started/advanced/transcoding/): - # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) + # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, vaapi, or vulkan) # PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840) # PHOTOPRISM_FFMPEG_BITRATE: "32" # video bitrate limit in Mbps (default: 60) ## Storage Folders: "~" is a shortcut for your home directory, "." for the current directory @@ -105,7 +107,7 @@ services: ## MariaDB Database Server (recommended) ## see https://docs.photoprism.app/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql mariadb: - image: mariadb:11 + image: mariadb:12.3 restart: unless-stopped stop_grace_period: 15s security_opt: # see https://github.com/MariaDB/mariadb-docker/issues/434#issuecomment-1136151239 diff --git a/setup/docker/nvidia/compose.yaml b/setup/docker/nvidia/compose.yaml index edb6272da..d913ef749 100644 --- a/setup/docker/nvidia/compose.yaml +++ b/setup/docker/nvidia/compose.yaml @@ -15,7 +15,7 @@ # Setup Guides: # - https://docs.photoprism.app/getting-started/docker-compose/ # - https://docs.photoprism.app/getting-started/advanced/transcoding/#nvidia-container-toolkit -# - https://www.photoprism.app/kb/activation +# - https://www.photoprism.app/kb/activation/ # # Troubleshooting Checklists: # - https://docs.photoprism.app/getting-started/troubleshooting/ @@ -57,15 +57,17 @@ services: PHOTOPRISM_DEFAULT_LOCALE: "en" # default user interface language, e.g. "en" or "de" PHOTOPRISM_PLACES_LOCALE: "local" # location details language, e.g. "local", "en", or "de" PHOTOPRISM_SITE_URL: "http://localhost:2342/" # server URL in the format "http(s)://domain.name(:port)/(path)" - PHOTOPRISM_SITE_TITLE: "PhotoPrism" - PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" - PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description - PHOTOPRISM_SITE_AUTHOR: "" # meta site author + PHOTOPRISM_SITE_NAME: "" # short name for identifying this instance within a cluster + PHOTOPRISM_SITE_TITLE: "PhotoPrism" # main title shown in the web interface and meta tags + PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" # short caption or tagline shown alongside the title + PHOTOPRISM_SITE_DESCRIPTION: "" # longer description shown in SEO and social meta tags + PHOTOPRISM_SITE_AUTHOR: "" # site owner shown in the author meta tag PHOTOPRISM_LOG_LEVEL: "info" # log level: trace, debug, info, warning, or error PHOTOPRISM_READONLY: "false" # do not modify originals directory (reduced functionality) PHOTOPRISM_EXPERIMENTAL: "false" # enables experimental features PHOTOPRISM_DISABLE_CHOWN: "false" # disables updating storage permissions via chmod and chown on startup PHOTOPRISM_DISABLE_WEBDAV: "false" # disables built-in WebDAV server + PHOTOPRISM_DISABLE_MCP: "false" # disables Model Context Protocol (MCP) API endpoint for AI agent integrations PHOTOPRISM_DISABLE_SETTINGS: "false" # disables settings UI and API PHOTOPRISM_DISABLE_TENSORFLOW: "false" # disables all features depending on TensorFlow PHOTOPRISM_DISABLE_FACES: "false" # disables face detection and recognition (requires TensorFlow) @@ -86,7 +88,7 @@ services: PHOTOPRISM_UPLOAD_ARCHIVES: "true" # allows upload of zip archives (will be extracted before import) PHOTOPRISM_UPLOAD_LIMIT: 5000 # maximum size of uploaded files and uncompressed archive contents in MB PHOTOPRISM_ORIGINALS_LIMIT: 5000 # maximum size of original media files in MB (larger files are skipped) - PHOTOPRISM_HTTP_COMPRESSION: "gzip" # improves transfer speed and bandwidth utilization (none or gzip) + PHOTOPRISM_HTTP_COMPRESSION: "zstd,gzip" # improves transfer speed and bandwidth utilization (none, gzip, zstd, or comma-separated list e.g. "zstd,gzip") # PHOTOPRISM_DATABASE_DRIVER: "sqlite" # SQLite is an embedded database that does not require a separate database server PHOTOPRISM_DATABASE_DRIVER: "mysql" # MariaDB 10.5.12+ (MySQL successor) offers significantly better performance compared to SQLite PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB database server (hostname:port) @@ -102,7 +104,7 @@ services: OLLAMA_BASE_URL: "http://ollama:11434" # use "https://ollama.com" for Ollama Cloud OLLAMA_API_KEY: "" # API key required to access Ollama (optional) ## Video Transcoding (https://docs.photoprism.app/getting-started/advanced/transcoding/): - PHOTOPRISM_FFMPEG_ENCODER: "nvidia" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) + PHOTOPRISM_FFMPEG_ENCODER: "nvidia" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, vaapi, or vulkan) PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840) PHOTOPRISM_FFMPEG_BITRATE: "64" # video bitrate limit in Mbps (default: 60) ## NVIDIA GPU Hardware Acceleration (see https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html): @@ -134,7 +136,7 @@ services: ## MariaDB Database Server (recommended) ## see https://docs.photoprism.app/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql mariadb: - image: mariadb:11 + image: mariadb:12.3 ## If MariaDB gets stuck in a restart loop, this points to a memory or filesystem issue: ## https://docs.photoprism.app/getting-started/troubleshooting/#fatal-server-errors restart: unless-stopped @@ -167,7 +169,7 @@ services: image: ollama/ollama:latest restart: unless-stopped stop_grace_period: 15s - ## Only starts this service if the "all", "ollama", or "vision" profile is specified:: + ## Only starts if the "all", "ollama", or "vision" profile is specified: ## docker compose --profile ollama up -d profiles: ["all", "ollama", "vision"] ## Insecurely exposes the Ollama service on port 11434 @@ -187,12 +189,15 @@ services: OLLAMA_MULTIUSER_CACHE: "false" # optimize prompt caching for multi-user scenarios OLLAMA_NOPRUNE: "false" # disables pruning of model blobs at startup OLLAMA_NOHISTORY: "true" # disables readline history - OLLAMA_FLASH_ATTENTION: "false" # enables the experimental flash attention feature - OLLAMA_KV_CACHE_TYPE: "f16" # cache quantization (f16, q8_0, or q4_0) + OLLAMA_FLASH_ATTENTION: "true" # required for OLLAMA_KV_CACHE_TYPE quantization + OLLAMA_KV_CACHE_TYPE: "f16" # cache precision: f16 (default), q8_0, q4_0 OLLAMA_SCHED_SPREAD: "false" # allows scheduling models across all GPUs. - OLLAMA_NEW_ENGINE: "true" # enables the new Ollama engine # OLLAMA_DEBUG: "true" # shows additional debug information # OLLAMA_INTEL_GPU: "true" # enables experimental Intel GPU detection + ## Telemetry / privacy opt-outs (containers do not inherit /etc/environment): + DO_NOT_TRACK: "true" + HF_HUB_DISABLE_TELEMETRY: "1" + # OLLAMA_NO_CLOUD: "1" # uncomment to disable Ollama Cloud models/features ## NVIDIA GPU Hardware Acceleration (see https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html): NVIDIA_VISIBLE_DEVICES: "all" NVIDIA_DRIVER_CAPABILITIES: "compute,utility" @@ -213,7 +218,7 @@ services: image: ghcr.io/open-webui/open-webui:main restart: unless-stopped stop_grace_period: 5s - ## Only starts this service if the "all", "ollama", "open-webui", or "vision" profile is specified:: + ## Only starts if the "all", "ollama", "open-webui", or "vision" profile is specified: ## docker compose --profile ollama up -d profiles: [ "all", "ollama", "open-webui", "vision" ] ## Exposes Open WebUI at http://localhost:8080 (use an HTTPS reverse proxy for remote access): @@ -235,7 +240,7 @@ services: watchtower: image: nickfedor/watchtower restart: unless-stopped - ## Only starts this service if the "update" profile is specified:: + ## Only starts if the "update" profile is specified: ## docker compose --profile update up -d profiles: ["update"] environment: diff --git a/setup/docker/portainer/stack.env b/setup/docker/portainer/stack.env index b5105ab66..20fbf3c5f 100644 --- a/setup/docker/portainer/stack.env +++ b/setup/docker/portainer/stack.env @@ -29,8 +29,8 @@ PHOTOPRISM_DISABLE_TLS=false PHOTOPRISM_DEFAULT_TLS=true # file size limit for originals in MB (increase for high-res video) PHOTOPRISM_ORIGINALS_LIMIT=5000 -# improves transfer speed and bandwidth utilization (none or gzip) -PHOTOPRISM_HTTP_COMPRESSION=gzip +# improves transfer speed and bandwidth utilization (none, gzip, zstd, or comma-separated list e.g. "zstd,gzip") +PHOTOPRISM_HTTP_COMPRESSION=zstd,gzip # log level: trace, debug, info, warning, or error PHOTOPRISM_LOG_LEVEL=info # do not modify originals directory (reduced functionality) @@ -41,6 +41,8 @@ PHOTOPRISM_EXPERIMENTAL=false PHOTOPRISM_DISABLE_CHOWN=false # disables built-in WebDAV server PHOTOPRISM_DISABLE_WEBDAV=false +# disables Model Context Protocol (MCP) API endpoint for AI agent integrations +PHOTOPRISM_DISABLE_MCP=false # disables settings UI and API PHOTOPRISM_DISABLE_SETTINGS=false # disables all features depending on TensorFlow @@ -66,7 +68,7 @@ PHOTOPRISM_SITE_CAPTION=AI-Powered Photos App PHOTOPRISM_SITE_DESCRIPTION= PHOTOPRISM_SITE_AUTHOR= ## Video Transcoding (https://docs.photoprism.app/getting-started/advanced/transcoding/): -# PHOTOPRISM_FFMPEG_ENCODER=software # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) +# PHOTOPRISM_FFMPEG_ENCODER=software # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, vaapi, or vulkan) # PHOTOPRISM_FFMPEG_SIZE=1920 # video size limit in pixels (720-7680) (default: 3840) # PHOTOPRISM_FFMPEG_BITRATE=32 # video bitrate limit in Mbps (default: 60) ## Run/install on first startup, see https://github.com/photoprism/photoprism/blob/develop/scripts/dist/Makefile: diff --git a/setup/docker/portainer/stack.yml b/setup/docker/portainer/stack.yml index 7378ef109..e7ca170c4 100644 --- a/setup/docker/portainer/stack.yml +++ b/setup/docker/portainer/stack.yml @@ -27,7 +27,7 @@ services: - "./storage:/photoprism/storage" # *Writable* storage folder for cache, database, and sidecar files (DO NOT REMOVE) mariadb: - image: mariadb:11 + image: mariadb:12.3 ## If MariaDB gets stuck in a restart loop, this points to a memory or filesystem issue: ## https://docs.photoprism.app/getting-started/troubleshooting/#fatal-server-errors restart: unless-stopped diff --git a/setup/docker/scheduler/compose.yaml b/setup/docker/scheduler/compose.yaml index 87fb4514d..4c93e04ca 100644 --- a/setup/docker/scheduler/compose.yaml +++ b/setup/docker/scheduler/compose.yaml @@ -13,7 +13,7 @@ # - https://docs.photoprism.app/getting-started/docker-compose/ # - https://docs.photoprism.app/getting-started/raspberry-pi/ # - https://docs.photoprism.app/getting-started/troubleshooting/docker/ -# - https://www.photoprism.app/kb/activation +# - https://www.photoprism.app/kb/activation/ # # CLI Commands: # - https://docs.photoprism.app/getting-started/docker-compose/#command-line-interface @@ -51,12 +51,13 @@ services: PHOTOPRISM_SITE_URL: "http://localhost:2342/" # server URL in the format "http(s)://domain.name(:port)/(path)" PHOTOPRISM_DISABLE_TLS: "false" # disables HTTPS/TLS even if the site URL starts with https:// and a certificate is available PHOTOPRISM_DEFAULT_TLS: "true" # defaults to a self-signed HTTPS/TLS certificate if no other certificate is available - PHOTOPRISM_HTTP_COMPRESSION: "gzip" # improves transfer speed and bandwidth utilization (none or gzip) + PHOTOPRISM_HTTP_COMPRESSION: "zstd,gzip" # improves transfer speed and bandwidth utilization (none, gzip, zstd, or comma-separated list e.g. "zstd,gzip") PHOTOPRISM_LOG_LEVEL: "info" # log level: trace, debug, info, warning, or error PHOTOPRISM_READONLY: "false" # do not modify originals directory (reduced functionality) PHOTOPRISM_EXPERIMENTAL: "false" # enables experimental features PHOTOPRISM_DISABLE_CHOWN: "false" # disables updating storage permissions via chmod and chown on startup PHOTOPRISM_DISABLE_WEBDAV: "false" # disables built-in WebDAV server + PHOTOPRISM_DISABLE_MCP: "false" # disables Model Context Protocol (MCP) API endpoint for AI agent integrations PHOTOPRISM_DISABLE_SETTINGS: "false" # disables settings UI and API PHOTOPRISM_DISABLE_TENSORFLOW: "false" # disables all features depending on TensorFlow PHOTOPRISM_DISABLE_FACES: "false" # disables face detection and recognition (requires TensorFlow) @@ -83,9 +84,10 @@ services: PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB database, see MARIADB_DATABASE in the mariadb service PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database username, must be the same as MARIADB_USER PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database password, must be the same as MARIADB_PASSWORD - PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" - PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description - PHOTOPRISM_SITE_AUTHOR: "" # meta site author + PHOTOPRISM_SITE_NAME: "" # short name for identifying this instance within a cluster + PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" # short caption or tagline shown alongside the title + PHOTOPRISM_SITE_DESCRIPTION: "" # longer description shown in SEO and social meta tags + PHOTOPRISM_SITE_AUTHOR: "" # site owner shown in the author meta tag ## Run/install on first startup, see https://github.com/photoprism/photoprism/blob/develop/scripts/dist/Makefile: PHOTOPRISM_INIT: "https tensorflow" # common options: update https tensorflow tensorflow-gpu intel gpu davfs yt-dlp ## Computer Vision (https://docs.photoprism.app/getting-started/config-options/#computer-vision): @@ -95,7 +97,7 @@ services: OLLAMA_BASE_URL: "http://ollama:11434" # use "https://ollama.com" for Ollama Cloud OLLAMA_API_KEY: "" # API key required to access Ollama (optional) ## Video Transcoding (https://docs.photoprism.app/getting-started/advanced/transcoding/): - # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) + # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, vaapi, or vulkan) # PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840) # PHOTOPRISM_FFMPEG_BITRATE: "32" # video bitrate limit in Mbps (default: 60) ## Run as a non-root user after initialization (supported: 0, 33, 50-99, 500-600, and 900-1200): @@ -114,7 +116,7 @@ services: ## MariaDB Database Server (recommended) ## see https://docs.photoprism.app/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql mariadb: - image: mariadb:11 + image: mariadb:12.3 container_name: mariadb restart: unless-stopped stop_grace_period: 15s diff --git a/setup/docker/sqlite/compose.yaml b/setup/docker/sqlite/compose.yaml index 0ad7ad61e..32b38c9f2 100644 --- a/setup/docker/sqlite/compose.yaml +++ b/setup/docker/sqlite/compose.yaml @@ -14,7 +14,7 @@ # - https://docs.photoprism.app/getting-started/docker-compose/ # - https://docs.photoprism.app/getting-started/raspberry-pi/ # - https://docs.photoprism.app/getting-started/troubleshooting/docker/ -# - https://www.photoprism.app/kb/activation +# - https://www.photoprism.app/kb/activation/ # # CLI Commands: # - https://docs.photoprism.app/getting-started/docker-compose/#command-line-interface @@ -49,12 +49,13 @@ services: PHOTOPRISM_SITE_URL: "http://localhost:2342/" # server URL in the format "http(s)://domain.name(:port)/(path)" PHOTOPRISM_DISABLE_TLS: "false" # disables HTTPS/TLS even if the site URL starts with https:// and a certificate is available PHOTOPRISM_DEFAULT_TLS: "true" # defaults to a self-signed HTTPS/TLS certificate if no other certificate is available - PHOTOPRISM_HTTP_COMPRESSION: "gzip" # improves transfer speed and bandwidth utilization (none or gzip) + PHOTOPRISM_HTTP_COMPRESSION: "zstd,gzip" # improves transfer speed and bandwidth utilization (none, gzip, zstd, or comma-separated list e.g. "zstd,gzip") PHOTOPRISM_LOG_LEVEL: "info" # log level: trace, debug, info, warning, or error PHOTOPRISM_READONLY: "false" # do not modify originals directory (reduced functionality) PHOTOPRISM_EXPERIMENTAL: "false" # enables experimental features PHOTOPRISM_DISABLE_CHOWN: "false" # disables updating storage permissions via chmod and chown on startup PHOTOPRISM_DISABLE_WEBDAV: "false" # disables built-in WebDAV server + PHOTOPRISM_DISABLE_MCP: "false" # disables Model Context Protocol (MCP) API endpoint for AI agent integrations PHOTOPRISM_DISABLE_SETTINGS: "false" # disables settings UI and API PHOTOPRISM_DISABLE_TENSORFLOW: "false" # disables all features depending on TensorFlow PHOTOPRISM_DISABLE_FACES: "false" # disables face detection and recognition (requires TensorFlow) @@ -76,9 +77,10 @@ services: PHOTOPRISM_UPLOAD_LIMIT: 5000 # maximum size of uploaded files and uncompressed archive contents in MB PHOTOPRISM_ORIGINALS_LIMIT: 5000 # maximum size of original media files in MB (larger files are skipped) PHOTOPRISM_DATABASE_DRIVER: "sqlite" # SQLite is an embedded database that does not require a separate database server - PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" - PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description - PHOTOPRISM_SITE_AUTHOR: "" # meta site author + PHOTOPRISM_SITE_NAME: "" # short name for identifying this instance within a cluster + PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" # short caption or tagline shown alongside the title + PHOTOPRISM_SITE_DESCRIPTION: "" # longer description shown in SEO and social meta tags + PHOTOPRISM_SITE_AUTHOR: "" # site owner shown in the author meta tag ## Run/install on first startup, see https://github.com/photoprism/photoprism/blob/develop/scripts/dist/Makefile: PHOTOPRISM_INIT: "https tensorflow" # common options: update https tensorflow tensorflow-gpu intel gpu davfs yt-dlp ## Computer Vision (https://docs.photoprism.app/getting-started/config-options/#computer-vision): @@ -88,7 +90,7 @@ services: OLLAMA_BASE_URL: "http://ollama:11434" # use "https://ollama.com" for Ollama Cloud OLLAMA_API_KEY: "" # API key required to access Ollama (optional) ## Video Transcoding (https://docs.photoprism.app/getting-started/advanced/transcoding/): - # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) + # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, vaapi, or vulkan) # PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840) # PHOTOPRISM_FFMPEG_BITRATE: "32" # video bitrate limit in Mbps (default: 60) ## Run as a non-root user after initialization (supported: 0, 33, 50-99, 500-600, and 900-1200): diff --git a/setup/docker/windows/compose.yaml b/setup/docker/windows/compose.yaml index bbdea82c9..e644b43fa 100644 --- a/setup/docker/windows/compose.yaml +++ b/setup/docker/windows/compose.yaml @@ -15,7 +15,7 @@ # # Setup Guide: # - https://docs.photoprism.app/getting-started/docker-compose/ -# - https://www.photoprism.app/kb/activation +# - https://www.photoprism.app/kb/activation/ # # Troubleshooting Checklists: # - https://docs.photoprism.app/getting-started/troubleshooting/ @@ -55,12 +55,13 @@ services: PHOTOPRISM_SITE_URL: "http://localhost:2342/" # server URL in the format "http(s)://domain.name(:port)/(path)" PHOTOPRISM_DISABLE_TLS: "false" # disables HTTPS/TLS even if the site URL starts with https:// and a certificate is available PHOTOPRISM_DEFAULT_TLS: "true" # defaults to a self-signed HTTPS/TLS certificate if no other certificate is available - PHOTOPRISM_HTTP_COMPRESSION: "gzip" # improves transfer speed and bandwidth utilization (none or gzip) + PHOTOPRISM_HTTP_COMPRESSION: "zstd,gzip" # improves transfer speed and bandwidth utilization (none, gzip, zstd, or comma-separated list e.g. "zstd,gzip") PHOTOPRISM_DEBUG: "false" # run in debug mode, shows additional log messages PHOTOPRISM_READONLY: "false" # do not modify originals folder; disables import, upload, and delete PHOTOPRISM_EXPERIMENTAL: "false" # enables experimental features PHOTOPRISM_DISABLE_CHOWN: "false" # disables updating storage permissions via chmod and chown on startup PHOTOPRISM_DISABLE_WEBDAV: "false" # disables built-in WebDAV server + PHOTOPRISM_DISABLE_MCP: "false" # disables Model Context Protocol (MCP) API endpoint for AI agent integrations PHOTOPRISM_DISABLE_SETTINGS: "false" # disables settings UI and API PHOTOPRISM_DISABLE_TENSORFLOW: "false" # disables all features depending on TensorFlow PHOTOPRISM_DISABLE_FACES: "false" # disables face detection and recognition (requires TensorFlow) @@ -86,9 +87,10 @@ services: PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB database, see MARIADB_DATABASE in the mariadb service PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database username, must be the same as MARIADB_USER PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database password, must be the same as MARIADB_PASSWORD - PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" - PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description - PHOTOPRISM_SITE_AUTHOR: "" # meta site author + PHOTOPRISM_SITE_NAME: "" # short name for identifying this instance within a cluster + PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" # short caption or tagline shown alongside the title + PHOTOPRISM_SITE_DESCRIPTION: "" # longer description shown in SEO and social meta tags + PHOTOPRISM_SITE_AUTHOR: "" # site owner shown in the author meta tag ## Computer Vision (https://docs.photoprism.app/getting-started/config-options/#computer-vision): PHOTOPRISM_VISION_API: "false" # server: enables service API endpoints under /api/v1/vision (requires access token) PHOTOPRISM_VISION_URI: "" # client: service URI, e.g. http://hostname/api/v1/vision (leave blank to disable) @@ -96,7 +98,7 @@ services: OLLAMA_BASE_URL: "http://ollama:11434" # use "https://ollama.com" for Ollama Cloud OLLAMA_API_KEY: "" # API key required to access Ollama (optional) ## Video Transcoding (https://docs.photoprism.app/getting-started/advanced/transcoding/): - # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) + # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, vaapi, or vulkan) # PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840) # PHOTOPRISM_FFMPEG_BITRATE: "32" # video bitrate limit in Mbps (default: 60) working_dir: "/photoprism" # do not change or remove @@ -111,7 +113,7 @@ services: ## MariaDB Database Server (recommended) ## see https://docs.photoprism.app/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql mariadb: - image: mariadb:11 + image: mariadb:12.3 ## If MariaDB gets stuck in a restart loop, this points to a memory or filesystem issue: ## https://docs.photoprism.app/getting-started/troubleshooting/#fatal-server-errors restart: unless-stopped diff --git a/setup/nas/raspberry-pi/cloud-init/user-data b/setup/nas/raspberry-pi/cloud-init/user-data index 32ba96bf2..0b19ec0bc 100644 --- a/setup/nas/raspberry-pi/cloud-init/user-data +++ b/setup/nas/raspberry-pi/cloud-init/user-data @@ -253,6 +253,7 @@ write_files: PHOTOPRISM_EXPERIMENTAL: "false" PHOTOPRISM_DISABLE_CHOWN: "false" PHOTOPRISM_DISABLE_WEBDAV: "false" + PHOTOPRISM_DISABLE_MCP: "false" PHOTOPRISM_DISABLE_SETTINGS: "false" PHOTOPRISM_DISABLE_TENSORFLOW: "false" PHOTOPRISM_DISABLE_FACES: "false" @@ -290,7 +291,7 @@ write_files: mariadb: restart: always - image: mariadb:11 + image: mariadb:12.3 security_opt: - seccomp=unconfined - apparmor=unconfined diff --git a/setup/pkg/linux/README.html b/setup/pkg/linux/README.html deleted file mode 100644 index e27843e06..000000000 --- a/setup/pkg/linux/README.html +++ /dev/null @@ -1,703 +0,0 @@ -<!doctype html> -<html> -<head> -<meta charset='UTF-8'><meta name='viewport' content='width=device-width initial-scale=1'><style type='text/css'>html {overflow-x: initial !important;}</style> -<style type='text/css' id="style-base">:root { --bg-color: #ffffff; --text-color: #333333; --select-text-bg-color: #B5D6FC; --select-text-font-color: auto; --monospace: "Lucida Console",Consolas,"Courier",monospace; --title-bar-height: 20px; } -.mac-os-11 { --title-bar-height: 28px; } -html { font-size: 14px; background-color: var(--bg-color); color: var(--text-color); font-family: "Helvetica Neue", Helvetica, Arial, "Segoe UI Emoji", "SF Pro", sans-serif; -webkit-font-smoothing: antialiased; } -h1, h2, h3, h4, h5 { white-space: pre-wrap; } -body { margin: 0px; padding: 0px; height: auto; inset: 0px; font-size: 1rem; line-height: 1.42857; overflow-x: hidden; background: inherit; } -iframe { margin: auto; } -a.url { word-break: break-all; } -a:active, a:hover { outline: 0px; } -.in-text-selection, ::selection { text-shadow: none; background: var(--select-text-bg-color); color: var(--select-text-font-color); } -#write { margin: 0px auto; height: auto; width: inherit; word-break: normal; overflow-wrap: break-word; position: relative; white-space: normal; overflow-x: visible; padding-top: 36px; } -#write.first-line-indent p { text-indent: 2em; } -#write.first-line-indent li p, #write.first-line-indent p *, #write.first-line-indent svg * { text-indent: 0px; } -#write.first-line-indent li { margin-left: 2em; } -.for-image #write { padding-left: 8px; padding-right: 8px; } -body.typora-export { padding-left: 30px; padding-right: 30px; } -.typora-export .footnote-line, .typora-export li, .typora-export p { white-space: pre-wrap; } -.typora-export .task-list-item input { pointer-events: none; } -@media screen and (max-width: 500px) { - body.typora-export { padding-left: 0px; padding-right: 0px; } - #write { padding-left: 20px; padding-right: 20px; } -} -#write li > figure:last-child { margin-bottom: 0.5rem; } -#write ol, #write ul { position: relative; } -img { max-width: 100%; vertical-align: middle; image-orientation: from-image; } -button, input, select, textarea { color: inherit; font: inherit; } -input[type="checkbox"], input[type="radio"] { line-height: normal; padding: 0px; } -*, ::after, ::before { box-sizing: border-box; } -#write h1, #write h2, #write h3, #write h4, #write h5, #write h6, #write p, #write pre { width: inherit; position: relative; } -#write svg h1, #write svg h2, #write svg h3, #write svg h4, #write svg h5, #write svg h6, #write svg p { position: static; } -.nodeLabel p { padding-right: 2px; padding-left: 2px; } -.typora-export .nodeLabel p { padding-right: 0px; padding-left: 0px; } -foreignobject { overflow: visible; } -p { line-height: inherit; } -h1, h2, h3, h4, h5, h6 { break-after: avoid-page; break-inside: avoid; orphans: 4; } -p { orphans: 4; } -li p { orphans: 1; } -h1 { font-size: 2rem; } -h2 { font-size: 1.8rem; } -h3 { font-size: 1.6rem; } -h4 { font-size: 1.4rem; } -h5 { font-size: 1.2rem; } -h6 { font-size: 1rem; } -.md-math-block, .md-rawblock, h1, h2, h3, h4, h5, h6, p { margin-top: 1rem; margin-bottom: 1rem; } -.hidden { display: none; } -.md-blockmeta { color: rgb(204, 204, 204); font-weight: 700; font-style: italic; } -a { cursor: pointer; } -sup.md-footnote { padding: 2px 4px; background-color: rgba(238, 238, 238, 0.7); color: rgb(85, 85, 85); border-radius: 4px; cursor: pointer; } -sup.md-footnote a, sup.md-footnote a:hover { color: inherit; text-transform: inherit; text-decoration: inherit; } -#write input[type="checkbox"] { cursor: pointer; width: inherit; height: inherit; } -figure { overflow-x: auto; margin: 1.2em 0px; max-width: calc(100% + 16px); padding: 0px; } -figure > table { margin: 0px; } -thead, tr { break-inside: avoid; break-after: auto; } -thead { display: table-header-group; } -table { border-collapse: collapse; border-spacing: 0px; width: 100%; overflow: auto; break-inside: auto; text-align: left; } -table.md-table td { min-width: 32px; } -.CodeMirror-gutters { border-right: 0px; background-color: inherit; } -.CodeMirror-linenumber { user-select: none; } -.CodeMirror { text-align: left; } -.CodeMirror-placeholder { opacity: 0.3; } -.CodeMirror pre { padding: 0px 4px; } -.CodeMirror-lines { padding: 0px; } -div.hr:focus { cursor: none; } -#write pre { white-space: pre-wrap; } -#write.fences-no-line-wrapping pre { white-space: pre; } -#write pre.ty-contain-cm { white-space: normal; } -.CodeMirror-gutters { margin-right: 4px; } -.md-fences { font-size: 0.9rem; display: block; break-inside: avoid; text-align: left; overflow: visible; white-space: pre; background: inherit; position: relative !important; } -.md-fences-adv-panel { width: 100%; margin-top: 10px; text-align: center; padding-top: 0px; padding-bottom: 8px; overflow-x: auto; } -#write .md-fences.mock-cm { white-space: pre-wrap; } -.md-fences.md-fences-with-lineno { padding-left: 0px; } -#write.fences-no-line-wrapping .md-fences.mock-cm { white-space: pre; overflow-x: auto; } -.md-fences.mock-cm.md-fences-with-lineno { padding-left: 8px; } -.CodeMirror-line, twitterwidget { break-inside: avoid; } -svg { break-inside: avoid; } -.footnotes { opacity: 0.8; font-size: 0.9rem; margin-top: 1em; margin-bottom: 1em; } -.footnotes + .footnotes { margin-top: 0px; } -.md-reset { margin: 0px; padding: 0px; border: 0px; outline: 0px; vertical-align: top; background: 0px 0px; text-decoration: none; text-shadow: none; float: none; position: static; width: auto; height: auto; white-space: nowrap; cursor: inherit; -webkit-tap-highlight-color: transparent; line-height: normal; font-weight: 400; text-align: left; box-sizing: content-box; direction: ltr; } -li div { padding-top: 0px; } -blockquote { margin: 1rem 0px; } -li .mathjax-block, li p { margin: 0.5rem 0px; } -li blockquote { margin: 1rem 0px; } -li { margin: 0px; position: relative; } -blockquote > :last-child { margin-bottom: 0px; } -blockquote > :first-child, li > :first-child { margin-top: 0px; } -.footnotes-area { color: rgb(136, 136, 136); margin-top: 0.714rem; padding-bottom: 0.143rem; white-space: normal; } -#write .footnote-line { white-space: pre-wrap; } -@media print { - body, html { border: 1px solid transparent; height: 99%; break-after: avoid; break-before: avoid; font-variant-ligatures: no-common-ligatures; } - #write { margin-top: 0px; border-color: transparent !important; padding-top: 0px !important; padding-bottom: 0px !important; } - .typora-export * { -webkit-print-color-adjust: exact; } - .typora-export #write { break-after: avoid; } - .typora-export #write::after { height: 0px; } - .is-mac table { break-inside: avoid; } - #write > p:nth-child(1) { margin-top: 0px; } - .typora-export-show-outline .typora-export-sidebar { display: none; } - figure { overflow-x: visible; } -} -.footnote-line { margin-top: 0.714em; font-size: 0.7em; } -a img, img a { cursor: pointer; } -pre.md-meta-block { font-size: 0.8rem; min-height: 0.8rem; white-space: pre-wrap; background: rgb(204, 204, 204); display: block; overflow-x: hidden; } -p > .md-image:only-child:not(.md-img-error) img, p > img:only-child { display: block; margin: auto; } -#write.first-line-indent p > .md-image:only-child:not(.md-img-error) img { left: -2em; position: relative; } -p > .md-image:only-child { display: inline-block; width: 100%; } -#write .MathJax_Display { margin: 0.8em 0px 0px; } -.md-math-block { width: 100%; } -.md-math-block:not(:empty)::after { display: none; } -.MathJax_ref { fill: currentcolor; } -[contenteditable="true"]:active, [contenteditable="true"]:focus, [contenteditable="false"]:active, [contenteditable="false"]:focus { outline: 0px; box-shadow: none; } -.md-task-list-item { position: relative; list-style-type: none; } -.task-list-item.md-task-list-item { padding-left: 0px; } -.md-task-list-item > input { position: absolute; top: 0px; left: 0px; margin-left: -1.2em; margin-top: calc(1em - 10px); border: none; } -.math { font-size: 1rem; } -.md-toc { min-height: 3.58rem; position: relative; font-size: 0.9rem; border-radius: 10px; } -.md-toc-content { position: relative; margin-left: 0px; } -.md-toc-content::after, .md-toc::after { display: none; } -.md-toc-item { display: block; color: rgb(65, 131, 196); } -.md-toc-item a { text-decoration: none; } -.md-toc-inner:hover { text-decoration: underline; } -.md-toc-inner { display: inline-block; cursor: pointer; } -.md-toc-h1 .md-toc-inner { margin-left: 0px; font-weight: 700; } -.md-toc-h2 .md-toc-inner { margin-left: 2em; } -.md-toc-h3 .md-toc-inner { margin-left: 4em; } -.md-toc-h4 .md-toc-inner { margin-left: 6em; } -.md-toc-h5 .md-toc-inner { margin-left: 8em; } -.md-toc-h6 .md-toc-inner { margin-left: 10em; } -@media screen and (max-width: 48em) { - .md-toc-h3 .md-toc-inner { margin-left: 3.5em; } - .md-toc-h4 .md-toc-inner { margin-left: 5em; } - .md-toc-h5 .md-toc-inner { margin-left: 6.5em; } - .md-toc-h6 .md-toc-inner { margin-left: 8em; } -} -a.md-toc-inner { font-size: inherit; font-style: inherit; font-weight: inherit; line-height: inherit; } -.footnote-line a:not(.reversefootnote) { color: inherit; } -.reversefootnote { font-family: ui-monospace, sans-serif; } -.md-attr { display: none; } -.md-fn-count::after { content: "."; } -code, pre, samp, tt { font-family: var(--monospace); } -kbd { margin: 0px 0.1em; padding: 0.1em 0.6em; font-size: 0.8em; color: rgb(36, 39, 41); background: rgb(255, 255, 255); border: 1px solid rgb(173, 179, 185); border-radius: 3px; box-shadow: rgba(12, 13, 14, 0.2) 0px 1px 0px, rgb(255, 255, 255) 0px 0px 0px 2px inset; white-space: nowrap; vertical-align: middle; } -.md-comment { color: rgb(162, 127, 3); opacity: 0.6; font-family: var(--monospace); } -code { text-align: left; vertical-align: initial; } -a.md-print-anchor { white-space: pre !important; border-width: initial !important; border-style: none !important; border-color: initial !important; display: inline-block !important; position: absolute !important; width: 1px !important; right: 0px !important; outline: 0px !important; background: 0px 0px !important; text-decoration: initial !important; text-shadow: initial !important; } -.os-windows.monocolor-emoji .md-emoji { font-family: "Segoe UI Symbol", sans-serif; } -.md-diagram-panel > svg { max-width: 100%; } -[lang="flow"] svg, [lang="mermaid"] svg { max-width: 100%; height: auto; } -[lang="mermaid"] .node text { font-size: 1rem; } -table tr th { border-bottom: 0px; } -video { max-width: 100%; display: block; margin: 0px auto; } -iframe { max-width: 100%; width: 100%; border: none; } -.highlight td, .highlight tr { border: 0px; } -mark { background: rgb(255, 255, 0); color: rgb(0, 0, 0); } -.md-html-inline .md-plain, .md-html-inline strong, mark .md-inline-math, mark strong { color: inherit; } -.md-expand mark .md-meta { opacity: 0.3 !important; } -mark .md-meta { color: rgb(0, 0, 0); } -@media print { - .typora-export h1, .typora-export h2, .typora-export h3, .typora-export h4, .typora-export h5, .typora-export h6 { break-inside: avoid; } -} -.md-diagram-panel .messageText { stroke: none !important; } -.md-diagram-panel .start-state { fill: var(--node-fill); } -.md-diagram-panel .edgeLabel rect { opacity: 1 !important; } -.md-fences.md-fences-math { font-size: 1em; } -.md-fences-advanced:not(.md-focus) { padding: 0px; white-space: nowrap; border: 0px; } -.md-fences-advanced:not(.md-focus) { background: inherit; } -.mermaid-svg { margin: auto; } -.typora-export-show-outline .typora-export-content { max-width: 1440px; margin: auto; display: flex; flex-direction: row; } -.typora-export-sidebar { width: 300px; font-size: 0.8rem; margin-top: 80px; margin-right: 18px; } -.typora-export-show-outline #write { --webkit-flex: 2; flex: 2 1 0%; } -.typora-export-sidebar .outline-content { position: fixed; top: 0px; max-height: 100%; overflow: hidden auto; padding-bottom: 30px; padding-top: 60px; width: 300px; } -@media screen and (max-width: 1024px) { - .typora-export-sidebar, .typora-export-sidebar .outline-content { width: 240px; } -} -@media screen and (max-width: 800px) { - .typora-export-sidebar { display: none; } -} -.outline-content li, .outline-content ul { margin-left: 0px; margin-right: 0px; padding-left: 0px; padding-right: 0px; list-style: none; overflow-wrap: anywhere; } -.outline-content ul { margin-top: 0px; margin-bottom: 0px; } -.outline-content strong { font-weight: 400; } -.outline-expander { width: 1rem; height: 1.42857rem; position: relative; display: table-cell; vertical-align: middle; cursor: pointer; padding-left: 4px; } -.outline-expander::before { content: ""; position: relative; font-family: Ionicons; display: inline-block; font-size: 8px; vertical-align: middle; } -.outline-item { padding-top: 3px; padding-bottom: 3px; cursor: pointer; } -.outline-expander:hover::before { content: ""; } -.outline-h1 > .outline-item { padding-left: 0px; } -.outline-h2 > .outline-item { padding-left: 1em; } -.outline-h3 > .outline-item { padding-left: 2em; } -.outline-h4 > .outline-item { padding-left: 3em; } -.outline-h5 > .outline-item { padding-left: 4em; } -.outline-h6 > .outline-item { padding-left: 5em; } -.outline-label { cursor: pointer; display: table-cell; vertical-align: middle; text-decoration: none; color: inherit; } -.outline-label:hover { text-decoration: underline; } -.outline-item:hover { border-color: rgb(245, 245, 245); background-color: var(--item-hover-bg-color); } -.outline-item:hover { margin-left: -28px; margin-right: -28px; border-left: 28px solid transparent; border-right: 28px solid transparent; } -.outline-item-single .outline-expander::before, .outline-item-single .outline-expander:hover::before { display: none; } -.outline-item-open > .outline-item > .outline-expander::before { content: ""; } -.outline-children { display: none; } -.info-panel-tab-wrapper { display: none; } -.outline-item-open > .outline-children { display: block; } -.typora-export .outline-item { padding-top: 1px; padding-bottom: 1px; } -.typora-export .outline-item:hover { margin-right: -8px; border-right: 8px solid transparent; } -.typora-export .outline-expander::before { content: "+"; font-family: inherit; top: -1px; } -.typora-export .outline-expander:hover::before, .typora-export .outline-item-open > .outline-item > .outline-expander::before { content: "−"; } -.typora-export-collapse-outline .outline-children { display: none; } -.typora-export-collapse-outline .outline-item-open > .outline-children, .typora-export-no-collapse-outline .outline-children { display: block; } -.typora-export-no-collapse-outline .outline-expander::before { content: "" !important; } -.typora-export-show-outline .outline-item-active > .outline-item .outline-label { font-weight: 700; } -.md-inline-math-container mjx-container { zoom: 0.95; } -mjx-container { break-inside: avoid; } -.md-alert.md-alert-note { border-left-color: rgb(9, 105, 218); } -.md-alert.md-alert-important { border-left-color: rgb(130, 80, 223); } -.md-alert.md-alert-warning { border-left-color: rgb(154, 103, 0); } -.md-alert.md-alert-tip { border-left-color: rgb(31, 136, 61); } -.md-alert.md-alert-caution { border-left-color: rgb(207, 34, 46); } -.md-alert { padding: 0px 1em; margin-bottom: 16px; color: inherit; border-left: 0.25em solid rgb(0, 0, 0); } -.md-alert-text-note { color: rgb(9, 105, 218); } -.md-alert-text-important { color: rgb(130, 80, 223); } -.md-alert-text-warning { color: rgb(154, 103, 0); } -.md-alert-text-tip { color: rgb(31, 136, 61); } -.md-alert-text-caution { color: rgb(207, 34, 46); } -.md-alert-text { font-size: 0.9rem; font-weight: 700; } -.md-alert-text svg { fill: currentcolor; position: relative; top: 0.125em; margin-right: 1ch; overflow: visible; } -.md-alert-text-container::after { content: attr(data-text); text-transform: capitalize; pointer-events: none; margin-right: 1ch; } - -</style> -<style type='text/css' id="style-codemirror">.CodeMirror { height: auto; } -.CodeMirror.cm-s-inner { background: inherit; } -.CodeMirror-scroll { overflow: auto hidden; z-index: 3; } -.CodeMirror-gutter-filler, .CodeMirror-scrollbar-filler { background-color: rgb(255, 255, 255); } -.CodeMirror-gutters { border-right: 1px solid rgb(221, 221, 221); background: inherit; white-space: nowrap; } -.CodeMirror-linenumber { padding: 0px 3px 0px 5px; text-align: right; color: rgb(153, 153, 153); } -.cm-s-inner .cm-keyword { color: rgb(119, 0, 136); } -.cm-s-inner .cm-atom, .cm-s-inner.cm-atom { color: rgb(34, 17, 153); } -.cm-s-inner .cm-number { color: rgb(17, 102, 68); } -.cm-s-inner .cm-def { color: rgb(0, 0, 255); } -.cm-s-inner .cm-variable { color: rgb(0, 0, 0); } -.cm-s-inner .cm-variable-2 { color: rgb(0, 85, 170); } -.cm-s-inner .cm-variable-3 { color: rgb(0, 136, 85); } -.cm-s-inner .cm-string { color: rgb(170, 17, 17); } -.cm-s-inner .cm-property { color: rgb(0, 0, 0); } -.cm-s-inner .cm-operator { color: rgb(152, 26, 26); } -.cm-s-inner .cm-comment, .cm-s-inner.cm-comment { color: rgb(170, 85, 0); } -.cm-s-inner .cm-string-2 { color: rgb(255, 85, 0); } -.cm-s-inner .cm-meta { color: rgb(85, 85, 85); } -.cm-s-inner .cm-qualifier { color: rgb(85, 85, 85); } -.cm-s-inner .cm-builtin { color: rgb(51, 0, 170); } -.cm-s-inner .cm-bracket { color: rgb(153, 153, 119); } -.cm-s-inner .cm-tag { color: rgb(17, 119, 0); } -.cm-s-inner .cm-attribute { color: rgb(0, 0, 204); } -.cm-s-inner .cm-header, .cm-s-inner.cm-header { color: rgb(0, 0, 255); } -.cm-s-inner .cm-quote, .cm-s-inner.cm-quote { color: rgb(0, 153, 0); } -.cm-s-inner .cm-hr, .cm-s-inner.cm-hr { color: rgb(153, 153, 153); } -.cm-s-inner .cm-link, .cm-s-inner.cm-link { color: rgb(0, 0, 204); } -.cm-negative { color: rgb(221, 68, 68); } -.cm-positive { color: rgb(34, 153, 34); } -.cm-header, .cm-strong { font-weight: 700; } -.cm-del { text-decoration: line-through; } -.cm-em { font-style: italic; } -.cm-link { text-decoration: underline; } -.cm-error { color: red; } -.cm-invalidchar { color: red; } -.cm-constant { color: rgb(38, 139, 210); } -.cm-defined { color: rgb(181, 137, 0); } -div.CodeMirror span.CodeMirror-matchingbracket { color: rgb(0, 255, 0); } -div.CodeMirror span.CodeMirror-nonmatchingbracket { color: rgb(255, 34, 34); } -.cm-s-inner .CodeMirror-activeline-background { background: inherit; } -.CodeMirror { position: relative; overflow: hidden; } -.CodeMirror-scroll { height: 100%; outline: 0px; position: relative; box-sizing: content-box; background: inherit; } -.CodeMirror-sizer { position: relative; } -.CodeMirror-gutter-filler, .CodeMirror-hscrollbar, .CodeMirror-scrollbar-filler, .CodeMirror-vscrollbar { position: absolute; z-index: 6; display: none; outline: 0px; } -.CodeMirror-vscrollbar { right: 0px; top: 0px; overflow: hidden; } -.CodeMirror-hscrollbar { bottom: 0px; left: 0px; overflow: auto hidden; } -.CodeMirror-scrollbar-filler { right: 0px; bottom: 0px; } -.CodeMirror-gutter-filler { left: 0px; bottom: 0px; } -.CodeMirror-gutters { position: absolute; left: 0px; top: 0px; padding-bottom: 10px; z-index: 3; overflow-y: hidden; } -.CodeMirror-gutter { white-space: normal; height: 100%; box-sizing: content-box; padding-bottom: 30px; margin-bottom: -32px; display: inline-block; } -.CodeMirror-gutter-wrapper { position: absolute; z-index: 4; background: 0px 0px !important; border: none !important; } -.CodeMirror-gutter-background { position: absolute; top: 0px; bottom: 0px; z-index: 4; } -.CodeMirror-gutter-elt { position: absolute; cursor: default; z-index: 4; } -.CodeMirror-lines { cursor: text; } -.CodeMirror pre { border-radius: 0px; border-width: 0px; background: 0px 0px; font-family: inherit; font-size: inherit; margin: 0px; white-space: pre; overflow-wrap: normal; color: inherit; z-index: 2; position: relative; overflow: visible; } -.CodeMirror-wrap pre { overflow-wrap: break-word; white-space: pre-wrap; word-break: normal; } -.CodeMirror-code pre { border-right: 30px solid transparent; width: fit-content; } -.CodeMirror-wrap .CodeMirror-code pre { border-right: none; width: auto; } -.CodeMirror-linebackground { position: absolute; inset: 0px; z-index: 0; } -.CodeMirror-linewidget { position: relative; z-index: 2; overflow: auto; } -.CodeMirror-wrap .CodeMirror-scroll { overflow-x: hidden; } -.CodeMirror-measure { position: absolute; width: 100%; height: 0px; overflow: hidden; visibility: hidden; } -.CodeMirror-measure pre { position: static; } -.CodeMirror div.CodeMirror-cursor { position: absolute; visibility: hidden; border-right: none; width: 0px; } -.CodeMirror div.CodeMirror-cursor { visibility: hidden; } -.CodeMirror-focused div.CodeMirror-cursor { visibility: inherit; } -.cm-searching { background: rgba(255, 255, 0, 0.4); } -span.cm-underlined { text-decoration: underline; } -span.cm-strikethrough { text-decoration: line-through; } -.cm-tw-syntaxerror { color: rgb(255, 255, 255); background-color: rgb(153, 0, 0); } -.cm-tw-deleted { text-decoration: line-through; } -.cm-tw-header5 { font-weight: 700; } -.cm-tw-listitem:first-child { padding-left: 10px; } -.cm-tw-box { border-style: solid; border-right-width: 1px; border-bottom-width: 1px; border-left-width: 1px; border-color: inherit; border-top-width: 0px !important; } -.cm-tw-underline { text-decoration: underline; } -@media print { - .CodeMirror div.CodeMirror-cursor { visibility: hidden; } -} - -</style> -<link rel='stylesheet' href='https://fonts.googleapis.com/css?family=Open+Sans:400italic,700italic,700,400&subset=latin,latin-ext' type='text/css' /> -<style type='text/css' id="style-theme_css">:root { - --side-bar-bg-color: #fafafa; - --control-text-color: #777; -} - -@include-when-export url(https://fonts.googleapis.com/css?family=Open+Sans:400italic,700italic,700,400&subset=latin,latin-ext); - -/* open-sans-regular - latin-ext_latin */ - /* open-sans-italic - latin-ext_latin */ - /* open-sans-700 - latin-ext_latin */ - /* open-sans-700italic - latin-ext_latin */ - html { - font-size: 16px; - -webkit-font-smoothing: antialiased; -} - -body { - font-family: "Open Sans","Clear Sans", "Helvetica Neue", Helvetica, Arial, 'Segoe UI Emoji', 'SF Pro', sans-serif; - color: rgb(51, 51, 51); - line-height: 1.6; -} - -#write { - max-width: 860px; - margin: 0 auto; - padding: 30px; - padding-bottom: 100px; -} - -@media only screen and (min-width: 1400px) { - #write { - max-width: 1024px; - } -} - -@media only screen and (min-width: 1800px) { - #write { - max-width: 1200px; - } -} - -#write > ul:first-child, -#write > ol:first-child{ - margin-top: 30px; -} - -a { - color: #4183C4; -} -h1, -h2, -h3, -h4, -h5, -h6 { - position: relative; - margin-top: 1rem; - margin-bottom: 1rem; - font-weight: bold; - line-height: 1.4; - cursor: text; -} -h1:hover a.anchor, -h2:hover a.anchor, -h3:hover a.anchor, -h4:hover a.anchor, -h5:hover a.anchor, -h6:hover a.anchor { - text-decoration: none; -} -h1 tt, -h1 code { - font-size: inherit; -} -h2 tt, -h2 code { - font-size: inherit; -} -h3 tt, -h3 code { - font-size: inherit; -} -h4 tt, -h4 code { - font-size: inherit; -} -h5 tt, -h5 code { - font-size: inherit; -} -h6 tt, -h6 code { - font-size: inherit; -} -h1 { - font-size: 2.25em; - line-height: 1.2; - border-bottom: 1px solid #eee; -} -h2 { - font-size: 1.75em; - line-height: 1.225; - border-bottom: 1px solid #eee; -} - -/*@media print { - .typora-export h1, - .typora-export h2 { - border-bottom: none; - padding-bottom: initial; - } - - .typora-export h1::after, - .typora-export h2::after { - content: ""; - display: block; - height: 100px; - margin-top: -96px; - border-top: 1px solid #eee; - } -}*/ - -h3 { - font-size: 1.5em; - line-height: 1.43; -} -h4 { - font-size: 1.25em; -} -h5 { - font-size: 1em; -} -h6 { - font-size: 1em; - color: #777; -} -p, -blockquote, -ul, -ol, -dl, -table{ - margin: 0.8em 0; -} -li>ol, -li>ul { - margin: 0 0; -} -hr { - height: 2px; - padding: 0; - margin: 16px 0; - background-color: #e7e7e7; - border: 0 none; - overflow: hidden; - box-sizing: content-box; -} - -li p.first { - display: inline-block; -} -ul, -ol { - padding-left: 30px; -} -ul:first-child, -ol:first-child { - margin-top: 0; -} -ul:last-child, -ol:last-child { - margin-bottom: 0; -} -blockquote { - border-left: 4px solid #dfe2e5; - padding: 0 15px; - color: #777777; -} -blockquote blockquote { - padding-right: 0; -} -table { - padding: 0; - word-break: initial; -} -table tr { - border: 1px solid #dfe2e5; - margin: 0; - padding: 0; -} -table tr:nth-child(2n), -thead { - background-color: #f8f8f8; -} -table th { - font-weight: bold; - border: 1px solid #dfe2e5; - border-bottom: 0; - margin: 0; - padding: 6px 13px; -} -table td { - border: 1px solid #dfe2e5; - margin: 0; - padding: 6px 13px; -} -table th:first-child, -table td:first-child { - margin-top: 0; -} -table th:last-child, -table td:last-child { - margin-bottom: 0; -} - -.CodeMirror-lines { - padding-left: 4px; -} - -.code-tooltip { - box-shadow: 0 1px 1px 0 rgba(0,28,36,.3); - border-top: 1px solid #eef2f2; -} - -.md-fences, -code, -tt { - border: 1px solid #e7eaed; - background-color: #f8f8f8; - border-radius: 3px; - padding: 0; - padding: 2px 4px 0px 4px; - font-size: 0.9em; -} - -code { - background-color: #f3f4f4; - padding: 0 2px 0 2px; -} - -.md-fences { - margin-bottom: 15px; - margin-top: 15px; - padding-top: 8px; - padding-bottom: 6px; -} - - -.md-task-list-item > input { - margin-left: -1.3em; -} - -@media print { - html { - font-size: 13px; - } - pre { - page-break-inside: avoid; - word-wrap: break-word; - } -} - -.md-fences { - background-color: #f8f8f8; -} -#write pre.md-meta-block { - padding: 1rem; - font-size: 85%; - line-height: 1.45; - background-color: #f7f7f7; - border: 0; - border-radius: 3px; - color: #777777; - margin-top: 0 !important; -} - -.mathjax-block>.code-tooltip { - bottom: .375rem; -} - -.md-mathjax-midline { - background: #fafafa; -} - -#write>h3.md-focus:before{ - left: -1.5625rem; - top: .375rem; -} -#write>h4.md-focus:before{ - left: -1.5625rem; - top: .285714286rem; -} -#write>h5.md-focus:before{ - left: -1.5625rem; - top: .285714286rem; -} -#write>h6.md-focus:before{ - left: -1.5625rem; - top: .285714286rem; -} -.md-image>.md-meta { - /*border: 1px solid #ddd;*/ - border-radius: 3px; - padding: 2px 0px 0px 4px; - font-size: 0.9em; - color: inherit; -} - -.md-tag { - color: #a7a7a7; - opacity: 1; -} - -.md-toc { - margin-top:20px; - padding-bottom:20px; -} - -.sidebar-tabs { - border-bottom: none; -} - -#typora-quick-open { - border: 1px solid #ddd; - background-color: #f8f8f8; -} - -#typora-quick-open-item { - background-color: #FAFAFA; - border-color: #FEFEFE #e5e5e5 #e5e5e5 #eee; - border-style: solid; - border-width: 1px; -} - -/** focus mode */ -.on-focus-mode blockquote { - border-left-color: rgba(85, 85, 85, 0.12); -} - -header, .context-menu, .megamenu-content, footer{ - font-family: "Segoe UI", "Arial", sans-serif; -} - -.file-node-content:hover .file-node-icon, -.file-node-content:hover .file-node-open-state{ - visibility: visible; -} - -.mac-seamless-mode #typora-sidebar { - background-color: #fafafa; - background-color: var(--side-bar-bg-color); -} - -.mac-os #write{ - caret-color: AccentColor; -} - -.md-lang { - color: #b4654d; -} - -/*.html-for-mac { - --item-hover-bg-color: #E6F0FE; -}*/ - -#md-notification .btn { - border: 0; -} - -.dropdown-menu .divider { - border-color: #e5e5e5; - opacity: 0.4; -} - -.ty-preferences .window-content { - background-color: #fafafa; -} - -.ty-preferences .nav-group-item.active { - color: white; - background: #999; -} - -.menu-item-container a.menu-style-btn { - background-color: #f5f8fa; - background-image: linear-gradient( 180deg , hsla(0, 0%, 100%, 0.8), hsla(0, 0%, 100%, 0)); -} -</style> -<style type='text/css' id="style-lp">ol, ul {padding-left: 40px}</style> - -<title>README - -
-

PhotoPrism® Installation Packages

As an alternative to our Docker images, you can use the packages available at dl.photoprism.app/pkg/linux/ to install PhotoPrism on compatible Linux distributions without building it from source.

These binary installation packages are intended for experienced users and maintainers of third-party integrations only, as they require manual configuration and do not include tested system dependencies. Since we are unable to provide support for custom installations, we recommend using one of our Docker images to run PhotoPrism on a private server or NAS device.

Also note that the minimum required glibc version is 2.35, so for example Ubuntu 22.04 and Debian Bookworm will work, but older Linux distributions may not be compatible. Current package builds also require libvips 8.14+ for thumbnail processing.

Usage

Installation Using tar.gz Archives

You can download and install PhotoPrism in /opt/photoprism by running the following commands:

If your server has an ARM-based CPU, please make sure to install arm64.tar.gz instead of amd64.tar.gz when using the commands above. Both are linked to the latest stable release.

Since the packages currently do not include a default configuration, we recommend that you create a defaults.yml in /etc/photoprism next, in which you configure the paths and other settings that you want to use for your instance.

.deb Packages for Ubuntu / Debian Linux

As an alternative to the plain tar.gz archives, that you need to unpack manually, we also offer .deb packages for Debian-based distributions such as Ubuntu Linux. They install PhotoPrism under /opt/photoprism, add a /usr/local/bin/photoprism symlink, create /etc/photoprism/defaults.yml, and pull in the runtime libraries listed in the Dependencies section.

On servers with a 64-bit Intel or AMD CPU, our latest stable release can be installed as follows:

If your server has an ARM-based CPU, such as a Raspberry Pi, use the following commands instead:

Omit --no-install-recommends if you want APT to install MariaDB, Darktable, RawTherapee, ImageMagick, and other recommended extras automatically.

.rpm Packages for Fedora / RHEL / openSUSE

For RPM-based distributions we publish .rpm packages that mirror the layout described above. Install the latest release on x86_64 hardware with:

and on aarch64 (ARM64):

Replace dnf with zypper on openSUSE (use --allow-unsigned-rpm when required). On distributions that do not ship FFmpeg in the base repositories, enable the appropriate multimedia repository (EPEL, RPM Fusion, Packman, …) before installing the dependencies below.

AUR Packages for Arch Linux

Thomas Eizinger additionally maintains AUR packages for installation on Arch Linux. They are based on our tar.gz packages and have a systemd integration so that PhotoPrism can be started and restarted automatically.

Learn more ›

Updates

To update your installation, please stop all running PhotoPrism instances and make sure that there are no media, database, or custom config files in the /opt/photoprism directory. You can then delete its contents with the command sudo rm -rf /opt/photoprism/* and install a new version as shown above.

If you have used a .deb package for installation, you may need to remove the currently installed photoprism package by running sudo dpkg -r photoprism before you can install a new version with sudo apt install ./package.deb or sudo dpkg -i package.deb.

Dependencies

PhotoPrism packages bundle TensorFlow 2.18.0 and, starting with the December 2025 builds, ONNX Runtime 1.23.2 as described in ai/face/README.md. The shared libraries for both frameworks are shipped inside /opt/photoprism/lib, so no additional system packages are needed to switch PHOTOPRISM_FACE_ENGINE to onnx. The binaries still rely on glibc ≥ 2.35 and the standard C/C++ runtime libraries (libstdc++6, libgcc_s1, libgomp1, …) provided by your distribution.

Required Runtime Packages

Install the following packages before running PhotoPrism so that thumbnailing, metadata extraction, and the SQLite fallback database work out of the box:

Distribution familyCommand
Debian / Ubuntusudo apt install libvips42t64 libimage-exiftool-perl ffmpeg sqlite3 tzdata
Use libvips42 on releases without libvips42t64, but make sure the installed version is 8.14+.
Fedora / RHEL / Alma / Rockysudo dnf install vips perl-Image-ExifTool ffmpeg sqlite tzdata
openSUSEsudo zypper install vips perl-Image-ExifTool ffmpeg sqlite3 tzdata

These packages pull in the full libvips stack (GLib, libjpeg/libtiff/libwebp, archive/zstd, etc.) that the PhotoPrism binary links against. Run ldd /opt/photoprism/bin/photoprism if you need to diagnose missing libraries on custom distributions.

Installing Newer libvips on Ubuntu 22.04 (Jammy)

Ubuntu 22.04 ships libvips 8.12 by default, which is too old for current package builds. In that case, install a newer backport package first:

If you already have this repository checked out locally, you can run the same installer script directly:

For extended RAW processing, HEIF/HEIC support, and database scalability we recommend installing:

  • MariaDB or MariaDB Server (external database)

  • Darktable and/or RawTherapee (RAW converters)

  • ImageMagick (CLI utilities)

  • libvips 8.14+ (required; Ubuntu 22.04 users should install a backport with scripts/dist/install-libvips.sh if distro packages are too old)

  • libheif (prefer the up-to-date binaries from dl.photoprism.app/dist/libheif/; install with bash <(curl -s https://raw.githubusercontent.com/photoprism/photoprism/develop/scripts/dist/install-libheif.sh) when distro packages are outdated)

  • librsvg2-bin or librsvg2-tools (SVG conversion helpers)

Use sudo apt install, sudo dnf install, or sudo zypper install with the package names above to pull them in as needed.

We publish the same libheif builds that ship in our Docker images. They include fixes for rotation metadata and newer iOS HEIC variants that are often missing from distribution packages. Advanced users can regenerate them via make build-libheif-*, which calls scripts/dist/build-libheif.sh for each supported base image and architecture before uploading the archives to dl.photoprism.app.

Keep in mind that even if all dependencies are installed, it is possible that you are using a version that is not fully compatible with your pictures, phone, or camera. Our team cannot provide support in these cases if the same issue does not occur with our official Docker images. Details on the packages and package versions we use can be found in the Dockerfiles available in our public project repository.

Configuration

After unpacking the binaries you only need a writable configuration and storage location. The typical workflow is:

  1. Inspect the current settings: photoprism config

  2. Create dedicated directories for runtime data, for example (replace photoprism:photoprism with the user/group that should own the data):

  3. Update /etc/photoprism/defaults.yml (or .yaml) so ConfigPath, StoragePath, OriginalsPath, and ImportPath point outside the installation directory. When the /etc file is missing or empty, PhotoPrism automatically loads <config-path>/defaults.yml, so you may edit the copy under PHOTOPRISM_CONFIG_PATH instead.

  4. Optionally place per-instance overrides in <config-path>/options.yml.

  5. Restart the PhotoPrism service (or rerun the CLI command) so the changes take effect.

Run photoprism --help in a terminal to get an overview of the command flags and environment variables available for configuration. Their current values can always be displayed with the photoprism config command.

Precedence

PhotoPrism reads settings in the following order (later entries override earlier ones):

OrderSourceNotes
1Built-in defaultsHard-coded, fall back when nothing else is set.
2/etc/photoprism/defaults.ymlGlobal defaults for all users on the host; falls back to <config-path>/defaults.yml (respects .yml / .yaml) when missing or empty.
3Environment variables / CLI flagsCombine with service managers or wrappers.
4<config-path>/options.ymlInstance-specific overrides (per user or per deployment).
5Runtime changes in the UIPersisted to options.yml; require a restart when running outside Docker.

If no explicit originals, import and/or assets path has been configured, a list of default directory paths will be searched and the first existing directory will be used for the respective path. To simplify updates, we recommend not storing media, database files, or custom configs in the installation directory itself (for example /opt/photoprism); use another base such as /var/lib/photoprism or a path under the user’s home directory.

All configuration changes—whether made via UI, config files, or environment variables—require a restart to take effect when PhotoPrism runs as a standalone process.

defaults.yml

Packages install a starter /etc/photoprism/defaults.yml. Adjust it with root privileges to set global defaults such as filesystem locations, database options, and network ports. If you delete or leave that file empty, PhotoPrism automatically falls back to <config-path>/defaults.yml, so copying the sample there keeps the same behavior without touching /etc. When specifying strings you can use ~ as the current user’s home directory and relative paths starting with ./:

For a list of supported options and their names, see https://docs.photoprism.app/getting-started/config-files/#config-options.

When specifying values, make sure that the data type is the same as in the documentation, e.g. bool values must be either true or false and int values must be whole numbers without any quotes like in the example above.

options.yml

Default config values can be overridden by values specified in an options.yml file as well as with command flags and environment variables. To load values from an existing options.yml file, you can specify its storage path (excluding the filename) by setting the ConfigPath option in your defaults.yml file, using the --config-path command flag, or with the PHOTOPRISM_CONFIG_PATH environment variable.

The values in an options.yml file are not global and can be used to customize individual instances e.g. based on the default values in a defaults.yml file. Both files allow you to set any of the supported options.

Tip: when running PhotoPrism as a systemd service, export environment variables in the service unit or in /etc/default/photoprism. For interactive shells, specify the corresponding flags or prefix commands with variables (for example PHOTOPRISM_DEBUG=true photoprism index). Use the smallest scope that fits your deployment so updates stay manageable.

Documentation

For detailed information on specific features and related resources, see our Knowledge Base, or check the User Guide for help navigating the user interface, a complete list of config options, and other installation methods:

Getting Support

If you need help installing our software at home, you are welcome to post your question in GitHub Discussions or ask in our Community Chat. Common problems can be quickly diagnosed and solved using our Troubleshooting Checklists. Silver, Gold, and Platinum members are also welcome to email us for technical support and advice.

View Support Options ›

- - \ No newline at end of file diff --git a/setup/pkg/linux/README.md b/setup/pkg/linux/README.md index f966891ff..53778fa53 100644 --- a/setup/pkg/linux/README.md +++ b/setup/pkg/linux/README.md @@ -2,7 +2,7 @@ As an alternative to our [Docker images](https://docs.photoprism.app/getting-started/docker-compose/), you can use the packages available at [**dl.photoprism.app/pkg/linux/**](https://dl.photoprism.app/pkg/linux/) to install PhotoPrism on compatible Linux distributions without [building it from source](https://docs.photoprism.app/getting-started/faq/#building-from-source). -These [binary installation packages](https://dl.photoprism.app/pkg/linux/) are intended for **experienced users** and **maintainers of third-party integrations** only, as they [require manual configuration](#configuration) and [do not include tested system dependencies](#dependencies). Since we are unable to [provide support](https://www.photoprism.app/kb/getting-support) for custom installations, we recommend using [one of our Docker images](https://docs.photoprism.app/getting-started/docker-compose/) to run PhotoPrism on a private server or NAS device. +These [binary installation packages](https://dl.photoprism.app/pkg/linux/) are intended for **experienced users** and **maintainers of third-party integrations** only, as they [require manual configuration](#configuration) and [do not include tested system dependencies](#dependencies). Since we are unable to [provide support](https://www.photoprism.app/kb/getting-support/) for custom installations, we recommend using [one of our Docker images](https://docs.photoprism.app/getting-started/docker-compose/) to run PhotoPrism on a private server or NAS device. Also note that the minimum required glibc version is 2.35, so for example Ubuntu 22.04 and Debian Bookworm will work, but older Linux distributions may not be compatible. Current package builds also require **libvips 8.14+** for thumbnail processing. @@ -74,7 +74,7 @@ If you have used a *.deb* package for installation, you may need to remove the c ### Dependencies -PhotoPrism packages bundle TensorFlow 2.18.0 and, starting with the December 2025 builds, ONNX Runtime 1.23.2 as described in [`ai/face/README.md`](https://github.com/photoprism/photoprism/blob/develop/internal/ai/face/README.md). The shared libraries for both frameworks are shipped inside `/opt/photoprism/lib`, so no additional system packages are needed to switch `PHOTOPRISM_FACE_ENGINE` to `onnx`. The binaries still rely on glibc ≥ 2.35 and the standard C/C++ runtime libraries (`libstdc++6`, `libgcc_s1`, `libgomp1`, …) provided by your distribution. +PhotoPrism packages bundle TensorFlow 2.18.0 and, starting with the December 2025 builds, ONNX Runtime 1.25.0 (1.23.2 in earlier builds) as described in [`ai/face/README.md`](https://github.com/photoprism/photoprism/blob/develop/internal/ai/face/README.md). The shared libraries for both frameworks are shipped inside `/opt/photoprism/lib`, so no additional system packages are needed to switch `PHOTOPRISM_FACE_ENGINE` to `onnx`. The binaries still rely on glibc ≥ 2.35 and the standard C/C++ runtime libraries (`libstdc++6`, `libgcc_s1`, `libgomp1`, …) provided by your distribution. #### Required Runtime Packages @@ -119,7 +119,7 @@ Use `sudo apt install`, `sudo dnf install`, or `sudo zypper install` with the pa We publish the same libheif builds that ship in our Docker images. They include fixes for rotation metadata and newer iOS HEIC variants that are often missing from distribution packages. Advanced users can regenerate them via `make build-libheif-*`, which calls `scripts/dist/build-libheif.sh` for each supported base image and architecture before uploading the archives to `dl.photoprism.app`. -Keep in mind that even if all dependencies are installed, it is possible that you are using a version that is not fully compatible with your pictures, phone, or camera. Our team cannot [provide support](https://www.photoprism.app/kb/getting-support) in these cases if the same issue does not occur with our [official Docker images](https://docs.photoprism.app/getting-started/docker-compose/). Details on the packages and package versions we use can be found in the Dockerfiles available in our [public project repository](https://github.com/photoprism/photoprism/tree/develop/docker). +Keep in mind that even if all dependencies are installed, it is possible that you are using a version that is not fully compatible with your pictures, phone, or camera. Our team cannot [provide support](https://www.photoprism.app/kb/getting-support/) in these cases if the same issue does not occur with our [official Docker images](https://docs.photoprism.app/getting-started/docker-compose/). Details on the packages and package versions we use can be found in the Dockerfiles available in our [public project repository](https://github.com/photoprism/photoprism/tree/develop/docker). ### Configuration @@ -185,14 +185,14 @@ Tip: when running PhotoPrism as a systemd service, export environment variables ### Documentation -For detailed information on specific features and related resources, see our [Knowledge Base](https://www.photoprism.app/kb), or check the [User Guide](https://docs.photoprism.app/user-guide/) for help [navigating the user interface](https://docs.photoprism.app/user-guide/navigate/), a [complete list of config options](https://docs.photoprism.app/getting-started/config-options/), and [other installation methods](https://docs.photoprism.app/getting-started/): +For detailed information on specific features and related resources, see our [Knowledge Base](https://www.photoprism.app/kb/), or check the [User Guide](https://docs.photoprism.app/user-guide/) for help [navigating the user interface](https://docs.photoprism.app/user-guide/navigate/), a [complete list of config options](https://docs.photoprism.app/getting-started/config-options/), and [other installation methods](https://docs.photoprism.app/getting-started/): - [PhotoPrism® User Guide](https://docs.photoprism.app/user-guide/) - [PhotoPrism® Developer Guide](https://docs.photoprism.app/developer-guide/) -- [PhotoPrism® Knowledge Base](https://www.photoprism.app/kb) +- [PhotoPrism® Knowledge Base](https://www.photoprism.app/kb/) ### Getting Support If you need help installing our software at home, you are welcome to post your question in [GitHub Discussions](https://link.photoprism.app/discussions) or ask in our [Community Chat](https://link.photoprism.app/chat). Common problems can be quickly diagnosed and solved using our [Troubleshooting Checklists](https://docs.photoprism.app/getting-started/troubleshooting/). [Silver, Gold, and Platinum](https://link.photoprism.app/membership) members are also welcome to email us for technical support and advice. -[View Support Options ›](https://www.photoprism.app/kb/getting-support) +[View Support Options ›](https://www.photoprism.app/kb/getting-support/) diff --git a/setup/pkg/linux/defaults.yml b/setup/pkg/linux/defaults.yml index 3fc928e68..53c827ba0 100644 --- a/setup/pkg/linux/defaults.yml +++ b/setup/pkg/linux/defaults.yml @@ -8,7 +8,7 @@ AuthMode: "password" DatabaseDriver: "sqlite" HttpHost: "127.0.0.1" HttpPort: 2342 -HttpCompression: "gzip" +HttpCompression: "zstd,gzip" DisableTLS: false DefaultTLS: true Experimental: false diff --git a/setup/podman/README.md b/setup/podman/README.md index ad26f7bef..b16c2de67 100644 --- a/setup/podman/README.md +++ b/setup/podman/README.md @@ -30,11 +30,11 @@ Please keep in mind to replace the `docker` and `docker compose` commands with ` #### Knowledge Base -↪ https://www.photoprism.app/kb +↪ https://www.photoprism.app/kb/ #### Compliance FAQ -↪ https://www.photoprism.app/kb/compliance-faq +↪ https://www.photoprism.app/kb/compliance-faq/ #### Firewall Settings @@ -42,4 +42,4 @@ Please keep in mind to replace the `docker` and `docker compose` commands with ` ---- -*PhotoPrism® is a [registered trademark](https://www.photoprism.app/trademark). By using the software and services we provide, you agree to our [Terms of Service](https://www.photoprism.app/terms), [Privacy Policy](https://www.photoprism.app/privacy), and [Code of Conduct](https://www.photoprism.app/code-of-conduct). Docs are [available](https://link.photoprism.app/github-docs) under the [CC BY-NC-SA 4.0 License](https://creativecommons.org/licenses/by-nc-sa/4.0/); [additional terms](https://github.com/photoprism/photoprism/blob/develop/assets/README.md) may apply.* \ No newline at end of file +*PhotoPrism® is a [registered trademark](https://www.photoprism.app/trademark/). By using the software and services we provide, you agree to our [Terms of Service](https://www.photoprism.app/terms/), [Privacy Policy](https://www.photoprism.app/privacy/), and [Code of Conduct](https://www.photoprism.app/code-of-conduct/). Docs are [available](https://link.photoprism.app/github-docs) under the [CC BY-NC-SA 4.0 License](https://creativecommons.org/licenses/by-nc-sa/4.0/); [additional terms](https://github.com/photoprism/photoprism/blob/develop/assets/README.md) may apply.* \ No newline at end of file diff --git a/setup/podman/docker-compose.yml b/setup/podman/docker-compose.yml index b20ea7d43..5d4a40d4b 100644 --- a/setup/podman/docker-compose.yml +++ b/setup/podman/docker-compose.yml @@ -11,8 +11,8 @@ version: '3.5' # https://docs.photoprism.app/getting-started/proxies/traefik/ # # Quickstart Guide: https://docs.photoprism.app/getting-started/docker-compose/ -# Membership Activation: https://www.photoprism.app/kb/activation -# Knowledge Base: https://www.photoprism.app/kb +# Membership Activation: https://www.photoprism.app/kb/activation/ +# Knowledge Base: https://www.photoprism.app/kb/ # Docker Image: https://hub.docker.com/r/photoprism/photoprism # # PODMAN COMPOSE COMMAND REFERENCE @@ -65,12 +65,13 @@ services: PHOTOPRISM_DISABLE_TLS: "false" # disables HTTPS/TLS even if the site URL starts with https:// and a certificate is available PHOTOPRISM_DEFAULT_TLS: "true" # defaults to a self-signed HTTPS/TLS certificate if no other certificate is available PHOTOPRISM_ORIGINALS_LIMIT: 5000 # file size limit for originals in MB (increase for high-res video) - PHOTOPRISM_HTTP_COMPRESSION: "gzip" # improves transfer speed and bandwidth utilization (none or gzip) + PHOTOPRISM_HTTP_COMPRESSION: "zstd,gzip" # improves transfer speed and bandwidth utilization (none, gzip, zstd, or comma-separated list e.g. "zstd,gzip") PHOTOPRISM_LOG_LEVEL: "info" # log level: trace, debug, info, warning, or error PHOTOPRISM_READONLY: "false" # do not modify originals directory (reduced functionality) PHOTOPRISM_EXPERIMENTAL: "false" # enables experimental features PHOTOPRISM_DISABLE_CHOWN: "false" # disables updating storage permissions via chmod and chown on startup PHOTOPRISM_DISABLE_WEBDAV: "false" # disables built-in WebDAV server + PHOTOPRISM_DISABLE_MCP: "false" # disables Model Context Protocol (MCP) API endpoint for AI agent integrations PHOTOPRISM_DISABLE_SETTINGS: "false" # disables settings UI and API PHOTOPRISM_DISABLE_TENSORFLOW: "false" # disables all features depending on TensorFlow PHOTOPRISM_DISABLE_FACES: "false" # disables face detection and recognition (requires TensorFlow) @@ -93,13 +94,14 @@ services: PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB database, see MARIADB_DATABASE in the mariadb service PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database username, must be the same as MARIADB_USER PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database password, must be the same as MARIADB_PASSWORD - PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" - PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description - PHOTOPRISM_SITE_AUTHOR: "" # meta site author + PHOTOPRISM_SITE_NAME: "" # short name for identifying this instance within a cluster + PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" # short caption or tagline shown alongside the title + PHOTOPRISM_SITE_DESCRIPTION: "" # longer description shown in SEO and social meta tags + PHOTOPRISM_SITE_AUTHOR: "" # site owner shown in the author meta tag ## Run/install on first startup, see https://github.com/photoprism/photoprism/blob/develop/scripts/dist/Makefile: PHOTOPRISM_INIT: "https tensorflow" # common options: update https tensorflow tensorflow-gpu intel gpu davfs yt-dlp ## Video Transcoding (https://docs.photoprism.app/getting-started/advanced/transcoding/): - # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) + # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, vaapi, or vulkan) # PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840) # PHOTOPRISM_FFMPEG_BITRATE: "32" # video bitrate limit in Mbps (default: 60) ## Run as a non-root user after initialization (supported: 0, 33, 50-99, 500-600, and 900-1200): @@ -119,7 +121,7 @@ services: ## If MariaDB gets stuck in a restart loop, this points to a memory or filesystem issue: ## https://docs.photoprism.app/getting-started/troubleshooting/#fatal-server-errors restart: unless-stopped - image: mariadb:11 + image: mariadb:12.3 container_name: mariadb ## "security_opt" specifies options for kernel security modules, it can be omitted if it is not needed or supported: security_opt: