Compare commits

...
18 Commits
Author SHA1 Message Date
LeoVasanko d14fcbc4f3 nitro theme: tuck adjacent buttons under the right slant
A -0.8em right margin pulls whatever follows an article button (another
button or text) under the slant's empty top triangle: adjacent buttons'
slant bands overlap horizontally by ~0.3em while the painted parallel
edges keep a constant ~0.3em clearance — overlapping but never touching.
2026-09-29 03:41:39 +00:00
LeoVasanko cb046fe867 contact messages: live language switching, language-neutral visitor UI
The asset config now carries every site language's label/subject variant
(pagerite:contact-langs, JSON); the client re-picks the dialog title and
mailto subject from <html lang> as the language selector swaps pages in
place (the config block itself is not swapped).

The visitor-facing dialog no longer has hardcoded English: empty state
and intro fields are glyphs (✉️, 👤/📧), the composer placeholder and
toolbar are symbols, upload errors flag the file with ⚠️ (details to
the console), and closing a conversation is a two-tap-armed ⟲ instead
of a text confirm(). The admin inbox stays English.
2026-09-29 03:29:21 +00:00
LeoVasanko 766fb503d9 Merge branch 'main' of https://git.zi.fi/LeoVasanko/pagerite
# Conflicts:
#	AGENTS.md
#	pagerite/views.py
2026-09-29 03:04:17 +00:00
LeoVasanko d3c89e8c66 Visitor contact messaging: in site communication system with email readiness (#3)
- `{contact}` or `{contact: Label}` to add a button on article, additional access on top right corner letter emoji
- Article button styling (with custom shape for Nitro theme)
- Visitor contact panel: live thread over the activity socket, rich composer (formatting,/file uploads), PoW anti-spam gating, contact email reveal after proof
- Admin inbox in the same overlay: thread list, replies, read marking, unread badge; background watch keeps badge and notifications live
- Messaging site settings (button label, email subject, our email) with per-language overrides and auto-translation support
- Browser notifications for new messages on both sides, with click-through to the new content
- Close conversation: archives the thread for admins, starts visitors fresh

Reviewed-on: https://git.zi.fi/LeoVasanko/pagerite/pulls/3
2026-09-29 03:01:00 +00:00
LeoVasanko 3c9ef04ffd Transition map beads: connector-colored elongated pulses
Beads now take their connector's color — accent for internal links,
plain text color for external ones (matching the tconn-exit styling) —
and render as an elongated pulse along the direction of travel instead
of a plain dot: a rounded capsule with a gradient-faded tail, rotated
to the edge's angle (cached per flow). Flow objects carry an 'external'
tag from buildFlows; the gradients live in the svg defs with stop
colors resolved from CSS so theme variables apply.
2026-09-25 20:23:20 +00:00
LeoVasanko fb2914d853 Don't accrue reading time across sleep
The inactivity cutoff timer cannot fire while the computer is asleep, and
performance.now() keeps running through sleep on some platforms, so after
a wake the whole slept span could be credited as reading time (inflating
min/visit stats). A gap longer than the inactivity timeout now closes the
span at its intended cutoff, and the cutoff timer clamps its accumulation
to its scheduled fire time — covering both event-first and timer-first
wake orderings.
2026-09-25 18:22:43 +00:00
LeoVasanko d4add54f10 Editor sockets: auth-aware reconnect, shared with the analytics view
An expired session failed the /_api/ws/editor handshake exactly like a dead
network, so the page/banner editors retried forever — the WS API cannot
open the login dialog. reconnect.js gains authReconnect(): on close, probe
/_api/settings (dialog-less fetchJson); a 401/403 runs the paskia login
flow and reconnects the moment it completes, a declined login holds at a
'session expired' ConnNote, and only transient failures take the paced
backoff. A paskia auth-success message from anywhere in the page
reconnects a waiting editor at once. AnalyticsView moves from its inline
copy of the same flow onto the shared helper.
2026-09-25 18:19:05 +00:00
LeoVasanko 31b56c3e5e Serve each article's Markdown at .md URLs (and via Accept: text/markdown)
/pages.md (front page /.md) serves the page's source Markdown — per-language
hybrid assembly, title injected as '# title' when the content has no h1 —
with the same ETag/Last-Modified/no-cache scheme as the HTML, which now
carries vary: accept. Pages advertise the counterpart via
<link rel=alternate type=text/markdown> and llms.txt links point at the
.md URLs.
2026-09-25 18:04:47 +00:00
LeoVasanko 7780d190d0 Analytics viewer: auth-aware reconnect, wake recovery, sliding time window
- Expired session dropped the socket into an endless paced retry loop the
  WS handshake can never escape: probe /_api/settings on close, run the
  paskia login flow on 401/403 and reconnect the moment it resolves; an
  aborted login leaves for the front page (history replace).
- Follow paskia's auth-success/auth-logout window messages: logins anywhere
  in the page reconnect at once instead of waiting out the backoff; logout
  leaves /_a. pagerite.js re-probes its pens on the same events.
- Recycle the socket on visibilitychange/online/bfcache restore: a socket
  that survived sleep looks OPEN but is dead, so no updates ever landed.
- The stats range window was frozen at mount (no reactive time dependency);
  it now slides on a minute clock.
- Transition map beads: fast-forward emitter schedules after long gaps
  instead of spawning a bead per missed interval in one tick.
2026-09-25 18:01:05 +00:00
LeoVasanko 204c6ab608 Transition map: always show the site structure, omit content-less index pages
Node inclusion no longer depends on views in the window: every page
from /_api/pages is shown (the front page used to vanish when quiet).
Omission follows the navigation instead — index pages without content
of their own (category labels and empty pages, the nodes nav links
bypass to the first child) are omitted, children promoted, first
visible child taking the slot. Deleted pages named by traffic are
inserted as ghosts where they would have been, materializing missing
ancestors as content-less category lanes.

/_api/pages gains the "empty" flag (not node.chunks) for the nav
notion; has_content (chunks is not None) stays for the structure
editor's delete affordance.
2026-09-25 03:23:53 +00:00
LeoVasanko 0ff5c6b526 ruff 2026-09-23 07:32:57 +00:00
LeoVasanko 2aed176c9e Cache feed/llms.txt bodies, serve with content-hash ETags
Rendering every article per request is expensive. Bodies are now
RAM-cached keyed by the public base URL and cleared from
_invalidate_pages (the same hook that drops the page render cache on
any content/settings write). Responses carry a blake3 content-hash
ETag and answer 304, so polling feed readers revalidate cheaply;
matching page behavior, 304 revalidations are not recorded in
analytics.
2026-09-23 07:30:32 +00:00
LeoVasanko 9ff22016d1 Add llms.txt, JSON Feed and RSS feed exports
New pagerite/feeds.py: /llms.txt (Markdown site map with excerpts for
LLM agents), /feed.json (JSON Feed 1.1) and /feed.xml (RSS 2.0 +
atom:link), all carrying every published article with full content and
absolutized URLs. Linked from every page <head> (feed alternates +
llms-txt) and from the sitemap, recorded in analytics like page GETs
and emoji-marked in the trails (🧠 llms.txt, 📡 feeds).
2026-09-23 07:25:08 +00:00
LeoVasanko 97bde49296 Record robots.txt/sitemap.xml GETs, emoji-mark machinery steps in trails
The robots and sitemap routes never called _record_get, so those
accesses were invisible. Recorded like page GETs, they surface as
crawler hits at display time (no activity message ever follows). In
the trail rendering, known non-article machinery paths (robots,
sitemap, future feed paths) get an emoji marker instead of a bare
slug.
2026-09-23 07:12:15 +00:00
LeoVasanko 4f97a6592c Relax automatic large-card pick: w > 600, h > 400, aspect > 1.05
The old 1.4-2.5 aspect window sent big near-square images (e.g.
1350x1200) to the compact layout despite ample resolution. The new
rule keeps square and portrait images compact (the compact box fits
them) while letting anything big and clearly wider than tall render
as a full-card cover.
2026-09-23 07:07:42 +00:00
LeoVasanko 7e86efeb9f Place external source/exit pills near their connection targets
Replace count-sorted, group-centered rows with a spring-like placement:
pills order by their weighted median target x and settle by clamped
coordinate descent, minimizing weighted horizontal connection distance
while keeping the minimum pill spacing.
2026-09-23 07:02:17 +00:00
LeoVasanko 580ebac06c Card image: paste button and site-icon (@favicon) option
The banner panel's card-image block gains a pasteboard button (an image
uploads; an image URL goes as the save message's image setting itself and
is fetched/stored server-side, cross-origin being CORS-blocked for the
browser) and a site-icon button saving the @favicon sentinel, which
resolves to Data.favicon at render time and follows favicon changes.
2026-09-23 06:31:06 +00:00
LeoVasanko 4d6735f609 Fix card image priority: own > mined from article > inherited
The resolved (inheriting) Node.image was checked before mining the
article, so a front-page banner image shadowed the articles' own
extracted figures everywhere: card covers, og:image and the editor's
card previews.
2026-09-23 06:10:01 +00:00
46 changed files with 4835 additions and 347 deletions

No files matched your search

+12 -8
View File
@@ -10,16 +10,18 @@ Please instead ask the user to see from dev tools what you need, e.g. to look up
Pagerite is a CMS. See `docs` for the full design and implementation details. Key files for code changes: Pagerite is a CMS. See `docs` for the full design and implementation details. Key files for code changes:
- `pagerite/` — Python backend package (hatchling build target). - `pagerite/` — Python backend package (hatchling build target).
- `app.py` — thin FastAPI assembly: lifespan, `FastAPI(...)`, router includes (route ordering: api/tracking/files routers, then `frontend.route(app, "/")`, then the pages catch-all last). - `app.py` — thin FastAPI assembly: lifespan, `FastAPI(...)`, router includes (route ordering: api/tracking/messages/files routers, then `frontend.route(app, "/")`, then the pages catch-all last).
- `state.py` — shared core, no routes: env-derived site constants, `data`/`kanta`, `analytics_store`, the fastapi-vue `frontend`, the render cache (`_html_response`, `_invalidate_pages`), the translator `dispatcher`, slug helpers, `@kanta.bootstrap` hooks. - `state.py` — shared core, no routes: env-derived site constants, `data`/`kanta`, `analytics_store`, the fastapi-vue `frontend`, the render cache (`_html_response`, `_invalidate_pages`), the translator `dispatcher`, slug helpers, `@kanta.bootstrap` hooks.
- `files.py` — `FileStore` (content-addressed, RAM-cached), image derivative helpers (`store_image`), file routes (`/_api/files`, `/_f/`, `/_themes/`, `/_fonts/`, favicon settings). - `files.py` — `FileStore` (content-addressed, RAM-cached), image derivative helpers (`store_image`; `store_attachment` keeps non-media uploads as inert `{hash}.file` blobs), file routes (`/_api/files`, `/_f/` — media by hash, attachments only via `/_f/{hash}/{filename}`, all forced-download + nosniff, `/_themes/`, `/_fonts/`, favicon settings).
- `api.py` — editor REST + WS: `/_api/pages`, `/_api/structure`, `/_api/settings`, `/_api/toggle-task`, `/_api/translations`, `/_api/ws/editor`, `/_translate/{key}`. - `api.py` — editor REST + WS: `/_api/pages`, `/_api/structure`, `/_api/settings`, `/_api/toggle-task`, `/_api/translations`, `/_api/ws/editor`, `/_translate/{key}`.
- `tracking.py` — visit analytics: GeoIP, client enrichment, favicon fetch, `/_ws`, `/_api/ws/analytics`, the `/_a` page (docs/analytics.md). - `tracking.py` — visit analytics: GeoIP, client enrichment, favicon fetch, `/_ws`, `/_api/ws/analytics`, the `/_a` page (docs/analytics.md). Both sockets also carry the contact-message protocol (docs/messages.md): `/_ws` routes token-bearing visitor frames and holds the per-connection easypow challenge (a validated proof grants the per-session message/upload quota held in messages.py, reveals the site contact email, and records the visit's contact trail marker), the analytics socket the admin inbox.
- `pages.py` — public content pages: `/`, `/sitemap.xml`, `/robots.txt`, the `/{path:path}` catch-all. - `messages.py` — visitor contact threads (docs/messages.md): strict message rendering (`html=False` markdown-it — threads never carry user markup), thread store ops, the visitor/admin socket protocols (PoW challenges live in `tracking.activity_ws` as a per-connection local; the granted quota here as a per-session RAM budget shared with the upload route; browser solver served at `/_contact/easypow.js`), the admin unread count for `/_api/settings`, and the public `/_contact/files` upload route (PoW quota + pending-upload quota, unreferenced files deleted when the session's last socket closes).
- `pages.py` — public content pages: `/`, `/sitemap.xml`, `/robots.txt`, the `/{path:path}` catch-all. Articles serve their Markdown (title injected as `# title`, per-language hybrid) at a `.md`-suffixed URL, or at the plain URL when Accept explicitly names text/markdown; pages link it via `<link rel="alternate" type="text/markdown">`, and llms.txt links point at the `.md` URLs.
- `feeds.py` — machine-readable exports: `/llms.txt` (compact index linking each article's `.md` Markdown URL), `/feed.json` (JSON Feed 1.1), `/feed.xml` (RSS 2.0 + atom:link); the feeds carry all published articles with full content, linked from every page `<head>` and the sitemap, recorded in analytics.
- `data.py` — msgspec Structs for the kanta database. - `data.py` — msgspec Structs for the kanta database.
- `chunks.py` — block-level Markdown chunking and content-hash keys for the chunk stores (docs/migrate.md). - `chunks.py` — block-level Markdown chunking and content-hash keys for the chunk stores (docs/migrate.md).
- `i18n.py` — language selection, translation assembly (chunks + overrides) and translated-edit recording (per-chunk user overrides in `Data.overrides`, per-language title overrides, refresh). - `i18n.py` — language selection, translation assembly (chunks + overrides) and translated-edit recording (per-chunk user overrides in `Data.overrides`, per-language title overrides, refresh), plus the site-string translations (`site_string`/`set_string_translation`) for the contact label/subject (docs/messages.md).
- `translate.py` — translator service protocol (msgspec structs), the connected-client `Dispatcher` (job pipeline, result validation) and pending/store core for the `/_translate/{key}` WebSocket (docs/localization.md); api.py only registers the route. - `translate.py` — translator service protocol (msgspec structs), the connected-client `Dispatcher` (job pipeline, result validation) and pending/store core for the `/_translate/{key}` WebSocket (docs/localization.md); api.py only registers the route. Pending title/nav work includes the site contact strings, so the contact chrome localizes automatically.
- `segments.py` — the translation round trip: fragments split into pure-prose wire segments (via markdown.make_md's verbatim parser; link- and formatting-carrying blocks stay whole, link/formatted texts inline, Markdown stripped) and translations spliced back by source offset, link/formatting markdown re-inserted at weight-mapped positions (docs/localization.md). - `segments.py` — the translation round trip: fragments split into pure-prose wire segments (via markdown.make_md's verbatim parser; link- and formatting-carrying blocks stay whole, link/formatted texts inline, Markdown stripped) and translations spliced back by source offset, link/formatting markdown re-inserted at weight-mapped positions (docs/localization.md).
- `migrations.py` — kanta migrations (`migrate_vN`); ALL schema/storage upgrades live here (raw state dict before struct decoding), never in the app lifespan: v1 moves legacy in-db file blobs to the on-disk store and rebuilds the legacy flat `pages` as the menu tree, v2 rewrites `/_f/{hash}.ext` image links to the extension-less form, backfills AVIF/WebP/JPEG derivatives on disk and drops the obsolete `version` field. - `migrations.py` — kanta migrations (`migrate_vN`); ALL schema/storage upgrades live here (raw state dict before struct decoding), never in the app lifespan: v1 moves legacy in-db file blobs to the on-disk store and rebuilds the legacy flat `pages` as the menu tree, v2 rewrites `/_f/{hash}.ext` image links to the extension-less form, backfills AVIF/WebP/JPEG derivatives on disk and drops the obsolete `version` field.
- `markdown.py` — markdown-it-py renderer. - `markdown.py` — markdown-it-py renderer.
@@ -30,10 +32,12 @@ Pagerite is a CMS. See `docs` for the full design and implementation details. Ke
- `main.js` — Vue editor app entry. - `main.js` — Vue editor app entry.
- `analytics-main.js` — analytics page entry (mounts `AnalyticsView` at `/_a`). - `analytics-main.js` — analytics page entry (mounts `AnalyticsView` at `/_a`).
- `langselect-main.js` + `LangSelector.vue` — public language selector, imported on demand by pagerite.js on pages with more than one hreflang alternate (the editors' `LangSelect` flag dropdown). - `langselect-main.js` + `LangSelector.vue` — public language selector, imported on demand by pagerite.js on pages with more than one hreflang alternate (the editors' `LangSelect` flag dropdown).
- `contact-main.js` + `ContactOverlay.vue` — messaging overlay entry and shell (docs/messages.md), imported on demand by pagerite.js when a `{contact:}` trigger button or the corner ✉️ icon is clicked, and at page load when a message session is live: the visitor thread (ContactPanel.vue, riding the `/_ws` activity socket through pagerite.js's bridge — register/send, shared queue and reconnect pacing) or, for editors, the admin inbox (MessagesView.vue: thread list, replies and read marking over `/_api/ws/analytics`, connected while open — a background `watchAdmin` connection keeps the badge and notifications live at all times). A visitor's open conversation is flagged in localStorage and resumed on page load; closing it archives the thread server-side and rotates the token. Both sides notify new messages via the browser Notification API (`notify.js`), permission asked after the first message of a fresh thread.
- `Composer.vue` + `richtext.js` — the message composer shared by the contact panel and the admin inbox: constrained contenteditable (plain-text paste, toolbar formatting, upload chips) serialized to a Markdown subset that the server re-renders strictly.
- `store.js` — the shared Pinia store (`useStore`, id `pagerite`) for cross-bundle UI state. - `store.js` — the shared Pinia store (`useStore`, id `pagerite`) for cross-bundle UI state.
- `pagerite.js` — public page entry. - `pagerite.js` — public page entry.
- `editorLang.js` + `LangSelect.vue` — the editor shell's shared language selection and its selector component (page + structure tabs; drives the page preview while the panel is open, via `swapdoc.setLangOverride`). - `editorLang.js` + `LangSelect.vue` — the editor shell's shared language selection and its selector component (page + structure tabs; drives the page preview while the panel is open, via `swapdoc.setLangOverride`).
- `reconnect.js` — shared WebSocket pacing for all sockets (staggered connect slots, stuck-CONNECTING watchdog, exponential backoff): bursts and rapid retries trip the browser's WebSocket throttling. - `reconnect.js` — shared WebSocket pacing for all sockets (staggered connect slots, stuck-CONNECTING watchdog, exponential backoff): bursts and rapid retries trip the browser's WebSocket throttling. Also the auth-aware close handling for the admin sockets (`authReconnect`): probe `/_api/settings` on close, run the paskia login flow on 401/403 and reconnect at once, pace only genuine network/server failures.
- `assets/` — base CSS, Pygments styles, fonts. - `assets/` — base CSS, Pygments styles, fonts.
- `scripts/devserver.py` — dev server with auto reload (the user mostly uses this; avoid running the server yourself, ask the user to test). - `scripts/devserver.py` — dev server with auto reload (the user mostly uses this; avoid running the server yourself, ask the user to test).
- `scripts/translator.py` — Seed-X translator service client for the `/_translate/{key}` socket (reference client, runs in its own uv env via PEP 723); stays connected full time, unloads the model after 60 s idle and reloads on the next job. - `scripts/translator.py` — Seed-X translator service client for the `/_translate/{key}` socket (reference client, runs in its own uv env via PEP 723); stays connected full time, unloads the model after 60 s idle and reloads on the next job.
@@ -44,7 +48,7 @@ Server run by CLI entry point `uv run pagerite` (no auto reloads, build needed).
## Toolchain ## Toolchain
- Python >= 3.14, managed with **uv**. Dependencies: `fastapi[standard]`, `fastapi-vue`, `html5tagger`, `kanta`, `markdown-it-py`, `mdit-py-plugins`, `platformdirs`, `pygments`, `tracerite`; dev group has `httpx`. Run anything via `uv run ...` (the venv is `.venv`). - Python >= 3.14, managed with **uv**. Dependencies: `fastapi[standard]`, `fastapi-vue`, `easypow`, `html5tagger`, `kanta`, `markdown-it-py`, `mdit-py-plugins`, `platformdirs`, `pygments`, `tracerite`; dev group has `httpx`. Run anything via `uv run ...` (the venv is `.venv`).
- Key libraries: - Key libraries:
- **html5tagger** — all HTML generation (`E`, `Document`, `Template`, `HTML` for trusted/raw HTML). - **html5tagger** — all HTML generation (`E`, `Document`, `Template`, `HTML` for trusted/raw HTML).
- To create stand alone pages, begin with `doc = Document(...)` that gives a HTML5 page header - To create stand alone pages, begin with `doc = Document(...)` that gives a HTML5 page header
+55 -11
View File
@@ -9,7 +9,9 @@ from the kanta content database, path from `PAGERITE_ANALYTICS` (default:
`Favicon`), the `Store` (raw log + atomic JSON persistence) and `Favicon`), the `Store` (raw log + atomic JSON persistence) and
`Store.display()`, where **all** classification happens. `Store.display()`, where **all** classification happens.
- `pagerite/pages.py` — records every served document as one raw GET line - `pagerite/pages.py` — records every served document as one raw GET line
(`_record_get`, in `pagerite/tracking.py`) with its true HTTP status. (`_record_get`, in `pagerite/tracking.py`) with its true HTTP status, plus
the `/robots.txt` and `/sitemap.xml` machinery GETs (never followed by an
activity message, they surface as crawler hits).
- `pagerite/tracking.py` — the `/_ws` activity WebSocket, and - `pagerite/tracking.py` — the `/_ws` activity WebSocket, and
`WebSocket /_api/ws/analytics` (admin-gated like every `/_api` endpoint). `WebSocket /_api/ws/analytics` (admin-gated like every `/_api` endpoint).
- `frontend/src/pagerite.js` — the client activity channel and the 📊 pen. - `frontend/src/pagerite.js` — the client activity channel and the 📊 pen.
@@ -117,7 +119,11 @@ transition applies the new `<html lang>` only after the ping goes out) and
follows the session, so the activity of a visit stays tied together, and follows the session, so the activity of a visit stays tied together, and
while the user is active the accumulated reading time is flushed every few while the user is active the accumulated reading time is flushed every few
seconds: the times are incremental, so a disconnection simply leaves the seconds: the times are incremental, so a disconnection simply leaves the
last reported time in place (no close beacon). After 5 minutes without last reported time in place (no close beacon). A sleeping computer accrues
no reading time: the inactivity-cutoff timer cannot fire while asleep (and
`performance.now()` keeps running through sleep on some platforms), so a
gap longer than the timeout closes the span at its intended cutoff, and a
late-firing cutoff timer clamps its accumulation the same way. After 5 minutes without
any activity the client closes the socket itself — a sleeping browser tab any activity the client closes the socket itself — a sleeping browser tab
would lose it anyway — and the next activity reconnects; reconnects are would lose it anyway — and the next activity reconnects; reconnects are
attempted only on user activity, with an exponential backoff between attempted only on user activity, with an exponential backoff between
@@ -193,7 +199,11 @@ for misses.
re-visited in a different language becomes a distinct trail step instead re-visited in a different language becomes a distinct trail step instead
of merging into the existing item. The entry page's referer and of merging into the existing item. The entry page's referer and
`utm_*` tags come from the GET that loaded it (within 10 s before the `utm_*` tags come from the GET that loaded it (within 10 s before the
first message). first message). A server-originated contact marker (the visitor opened
the contact panel and solved its proof of work, docs/messages.md —
recorded by the `/_ws` handler on the validated solution, never by the
client) flags the trail step it happened on, the first one per visit,
rendered with a ✉️ marker in the viewer.
- **Crawler hits**: a document GET no activity message matched within - **Crawler hits**: a document GET no activity message matched within
`_CRAWLER_TIMEOUT` (10 s) is a crawler hit — plain bots that only fetch `_CRAWLER_TIMEOUT` (10 s) is a crawler hit — plain bots that only fetch
documents never register as visits. JS-running crawlers (Googlebot, documents never register as visits. JS-running crawlers (Googlebot,
@@ -211,7 +221,10 @@ for misses.
are caught by the abuse rules regardless. In the viewer, crawler hits are are caught by the abuse rules regardless. In the viewer, crawler hits are
grouped by client hash and shown as a trail of pages, preceded by the grouped by client hash and shown as a trail of pages, preceded by the
referer when there is one (rendered with its favicon like visit referer when there is one (rendered with its favicon like visit
referers). The crawler table lists the most recent crawler first, with referers). Non-article machinery GETs (`/robots.txt`, `/sitemap.xml`,
`/llms.txt`, the feeds) appear as
emoji-marked steps (🤖 / 🗺️ / 🧠 / 📡) so they stand out from article steps.
The crawler table lists the most recent crawler first, with
the most active as a tie-breaker. the most active as a tie-breaker.
- **Abuse (scanner) hits**: a 404 on a telltale path — an empty URL segment - **Abuse (scanner) hits**: a 404 on a telltale path — an empty URL segment
(`//foo` — no real client generates those), any segment starting with a (`//foo` — no real client generates those), any segment starting with a
@@ -336,8 +349,8 @@ the edit pens) links to `/_a`, the analytics page. It is a normal site page:
the standard banner, navigation and footer stay in place, and the analytics the standard banner, navigation and footer stay in place, and the analytics
content is rendered inside `#main`. The page itself is public, but the data content is rendered inside `#main`. The page itself is public, but the data
stream comes from `WebSocket /_api/ws/analytics`, which remains admin-gated stream comes from `WebSocket /_api/ws/analytics`, which remains admin-gated
like the rest of the management API; visitors without access see the viewer like the rest of the management API; without a session the viewer starts the
with a "could not be loaded" message. paskia login flow instead of loading data.
Because it is a real page, fetch-navigation handles it like any other internal Because it is a real page, fetch-navigation handles it like any other internal
link: clicking the 📊 pen (or any link to `/_a`) fetches the server-rendered link: clicking the 📊 pen (or any link to `/_a`) fetches the server-rendered
@@ -350,6 +363,24 @@ spans less than 24 hours, otherwise `week`.
`AnalyticsView.vue` is no longer a full-screen overlay; the `body.analytics-open` `AnalyticsView.vue` is no longer a full-screen overlay; the `body.analytics-open`
page-chrome hiding and `#/analytics/<range>` hash routing have been removed. page-chrome hiding and `#/analytics/<range>` hash routing have been removed.
The viewer owns its connection lifecycle (the probe/login mechanics are the
shared `authReconnect` in `reconnect.js`, also used by the editor sockets). When the socket drops it probes
`/_api/settings` (plain `fetchJson`, never pops a dialog) to tell an expired
session from a dead network: a 401/403 runs the paskia login flow instead of
retrying (the WS handshake cannot open the login dialog) and the stream
reconnects the moment the login completes; an aborted login (declined, or a
proxy offering no paskia flow) leaves for the front page with a history
replace, so Back does not return to `/_a` just to pop the login again.
Anything else retries with the shared paced backoff (`reconnect.js`).
paskia's `auth-success`/`auth-logout` window messages are followed too: a
login anywhere in the page (the banner's 🔑 button included) reconnects the
stream at once, never waiting out a backoff timer, and a logout leaves for
the front page. Waking the page (`visibilitychange`, `online`, a bfcache
restore) recycles the socket immediately — one that survived sleep still
looks open but is dead — so the fresh snapshot lands right away, and the
stats window slides on a minute clock so an open page never leaves
"last 24 hours" frozen at mount.
Charts are SVG curves (Catmull-Rom over an edge-aware Gaussian — a Charts are SVG curves (Catmull-Rom over an edge-aware Gaussian — a
change-point detector splits the series at traffic-level shifts, then each change-point detector splits the series at traffic-level shifts, then each
segment is smoothed independently with a fixed sigma chosen so N events in segment is smoothed independently with a fixed sigma chosen so N events in
@@ -411,8 +442,15 @@ by a top lane labeled 🏠︎ beside the home pill (50% thicker than
the branch lanes, its label font and guide offset scaled along), each item's the branch lanes, its label font and guide offset scaled along), each item's
subtree fanning out below it in menu order along a large-radius circular subtree fanning out below it in menu order along a large-radius circular
arc that leaves heading arc that leaves heading
straight down and gradually bends right, index pages without views omitted straight down and gradually bends right. Every page of the tree is shown
and their children promoted in their place. The submenu structure is drawn whether or not it had views in the window — only index pages without
content of their own (category labels and empty pages — the ones the
navigation itself bypasses in favor of the first child) are omitted,
their children
promoted in their place, the first visible child taking the slot. Paths
the traffic names but the tree no longer has (deleted pages) are
inserted as ghosts where they would have been, missing ancestors
materialized as category lanes. The submenu structure is drawn
as wide branch lanes: one per path prefix with at least two visible as wide branch lanes: one per path prefix with at least two visible
nodes, running behind the branch's node pills as circle arcs concentric nodes, running behind the branch's node pills as circle arcs concentric
with the fan (parent levels one radius step outward, so all lanes of a with the fan (parent levels one radius step outward, so all lanes of a
@@ -431,15 +469,21 @@ flow along each edge, persisting across data reloads (emitters are keyed
per edge direction and beads tracked by progress, so an unrelated count per edge direction and beads tracked by progress, so an unrelated count
change never reshuffles them), emitted at a rate linearly proportional change never reshuffles them), emitted at a rate linearly proportional
to the directional count with no in-flight limit, opposing directions to the directional count with no in-flight limit, opposing directions
offset onto parallel lanes. External sources and exits whose connectors are offset onto parallel lanes; each bead renders as an elongated pulse
(gradient-faded tail) along its direction of travel, colored like its
connector — accent for internal edges, plain text color for external
ones. External sources and exits whose connectors are
all culled by the width threshold are dropped from their rows themselves all culled by the width threshold are dropped from their rows themselves
(the site's own page nodes always stay, connected or not). External sources show as a node row above the (the site's own page nodes always stay, connected or not). External sources show as a node row above the
map: each visit is attributed to `utm_campaign`, then `utm_source`, then the map: each visit is attributed to `utm_campaign`, then `utm_source`, then the
referer origin, then any other `utm_*` tag, so UTM-tagged visits are grouped referer origin, then any other `utm_*` tag, so UTM-tagged visits are grouped
under their campaign/source value rather than the referer domain. A UTM under their campaign/source value rather than the referer domain. A UTM
source node only links to its referer when every visit carrying that tag source node only links to its referer when every visit carrying that tag
came from the same origin. External exits are full-size nodes in a matching came from the same origin. Within the source and exit rows the pills are
row centered below the map, so the site itself stays in the middle), per-page view not sorted by count; each slides sideways toward the pages it connects to,
minimizing the weighted horizontal connection distance while keeping a
minimum pill spacing. External exits are full-size nodes in a matching
row below the map, so the site itself stays in the middle), per-page view
counts, the top transitions and the 50 most recent visit trails. Data is counts, the top transitions and the 50 most recent visit trails. Data is
streamed live over `WebSocket /_api/ws/analytics`, which pushes the latest streamed live over `WebSocket /_api/ws/analytics`, which pushes the latest
JSON snapshot on connect and again whenever the analytics file is updated JSON snapshot on connect and again whenever the analytics file is updated
+4 -3
View File
@@ -10,7 +10,8 @@ Thin FastAPI assembly: lifespan (open the kanta database, load the file store, t
- `files.py` — the `FileStore` and image derivative helpers, and the file routes: `/_api/files`, `/_f/`, `/_themes/`, `/_fonts/`, the favicon settings endpoints. - `files.py` — the `FileStore` and image derivative helpers, and the file routes: `/_api/files`, `/_f/`, `/_themes/`, `/_fonts/`, the favicon settings endpoints.
- `api.py` — the editor REST API and WebSockets: `/_api/pages`, `/_api/structure`, `/_api/settings`, `/_api/toggle-task`, `/_api/translations`, `/_api/ws/editor`, and the translator channel `/_translate/{clientkey}`. - `api.py` — the editor REST API and WebSockets: `/_api/pages`, `/_api/structure`, `/_api/settings`, `/_api/toggle-task`, `/_api/translations`, `/_api/ws/editor`, and the translator channel `/_translate/{clientkey}`.
- `tracking.py` — visit analytics: GeoIP, client enrichment, favicon fetching, debounced broadcasts, the `/_ws` activity socket, the admin stream `/_api/ws/analytics`, and the `/_a` viewer page. - `tracking.py` — visit analytics: GeoIP, client enrichment, favicon fetching, debounced broadcasts, the `/_ws` activity socket, the admin stream `/_api/ws/analytics`, and the `/_a` viewer page.
- `pages.py` — the public content pages: `/`, `/sitemap.xml`, `/robots.txt` and the `/{path:path}` catch-all. - `feeds.py` — machine-readable site exports: `/llms.txt` (Markdown site map for LLM agents, linking each article's `.md` Markdown URL), `/feed.json` (JSON Feed 1.1) and `/feed.xml` (RSS 2.0 + atom:link), the feeds carrying every published article with full content (relative URLs absolutized), linked from every page's `<head>` and from the sitemap, and recorded in analytics like page GETs. Bodies are RAM-cached (keyed by base URL, cleared by `_invalidate_pages` like the page render cache) and served with a content-hash ETag (304 revalidation).
- `pages.py` — the public content pages: `/`, `/sitemap.xml`, `/robots.txt` and the `/{path:path}` catch-all. Every article also has a Markdown counterpart: a `.md` suffix on the page URL (or an Accept header explicitly naming `text/markdown` on the plain URL — the HTML response carries `vary: accept`) serves the page's source Markdown (per-language hybrid assembly via `?lang=`/Accept-Language, page title injected as `# title` when the content has no h1, same ETag/Last-Modified scheme as the HTML). Pages advertise it with `<link rel="alternate" type="text/markdown">`.
Route ordering is load-bearing and lives in `app.py`: the api/tracking/files routers are included BEFORE `frontend.route(app, "/")` is called — fastapi-vue inserts its file routes at the position where `route()` was called (during `load()` in the lifespan), so anything registered earlier wins. The content catch-all `/{path:path}` is included AFTER `frontend.route()` so that built frontend assets still take priority over content slugs. The `Frontend` is constructed with `spa=False` explicitly: it only serves the built files without a catch-all. Route ordering is load-bearing and lives in `app.py`: the api/tracking/files routers are included BEFORE `frontend.route(app, "/")` is called — fastapi-vue inserts its file routes at the position where `route()` was called (during `load()` in the lifespan), so anything registered earlier wins. The content catch-all `/{path:path}` is included AFTER `frontend.route()` so that built frontend assets still take priority over content slugs. The `Frontend` is constructed with `spa=False` explicitly: it only serves the built files without a catch-all.
@@ -34,11 +35,11 @@ markdown-it-py renderer (html passthrough + attrs, footnote, deflist, tasklists,
The shared page layout as an html5tagger `Template` with placeholders (`Title`, `Brand`, `Banner`, `Nav`, `Sidebar`, `Main`), nav rendering straight from the `Data.menu` tree (siblings sorted by `Node.order`; nav links to content-less labels point at their first child via `first_leaf`, the first published descendant with content), and page/404 rendering. The shared page layout as an html5tagger `Template` with placeholders (`Title`, `Brand`, `Banner`, `Nav`, `Sidebar`, `Main`), nav rendering straight from the `Data.menu` tree (siblings sorted by `Node.order`; nav links to content-less labels point at their first child via `first_leaf`, the first published descendant with content), and page/404 rendering.
Content pages get SEO/social meta (description, canonical link, Open Graph + twitter card) from heuristics over the rendered article: the description is the first paragraph's text; the card image is the node's own `Node.image` when one resolves (nearest ancestor, front page last — see docs/content-model.md), otherwise mined from the article, preferring a `{.hero}`-classed image, then the first raster `<img>`, then the first SVG; the first `<video>` yields `og:video`; URLs are made absolute with the site origin (`SITE_URL` — `https://<hostname>` from the CLI hostname argument; on localhost the request's own base URL is the fallback); `article:published/modified_time` come from `Node.created`/`modified`. Additionally `twitter:image` pins extension-less `/_f/{hash}` card images to the `.webp` variant — X only honors WebP via twitter:image (not og:image) and its scraper cannot be trusted to negotiate via Accept. `twitter:card` is `summary_large_image` when the image's probed store dimensions suit a large card (>= 600px wide, aspect between 1.4 and 2.5; dimensions are read from the `<hash>.webp` derivative via pyvips, cached per hash) and `summary` for small or portrait images — external or unprobeable images keep the presence-based default (large when an image exists). The node's `Node.large` setting overrides that pick per article (False = small, True = large, the default None = automatic; NOT inherited like `Node.image`). The page title is injected as `# {title}` when the markdown has no h1 of its own, so it never appears twice (it always supplies `<title>` and nav labels). Content pages get SEO/social meta (description, canonical link, Open Graph + twitter card) from heuristics over the rendered article: the description is the first paragraph's text; the card image is the node's own `Node.image` when set, otherwise mined from the article (preferring a `{.hero}`-classed image, then the first raster `<img>`, then the first SVG), and only when the article yields none the inherited one (nearest ancestor, front page last — see docs/content-model.md); the first `<video>` yields `og:video`; URLs are made absolute with the site origin (`SITE_URL` — `https://<hostname>` from the CLI hostname argument; on localhost the request's own base URL is the fallback); `article:published/modified_time` come from `Node.created`/`modified`. Additionally `twitter:image` pins extension-less `/_f/{hash}` card images to the `.webp` variant — X only honors WebP via twitter:image (not og:image) and its scraper cannot be trusted to negotiate via Accept. `twitter:card` is `summary_large_image` when the image's probed store dimensions suit a large card (wider than 600px, taller than 400px and clearly wider than tall — aspect > 1.05, so square and portrait images keep the compact layout; dimensions are read from the `<hash>.webp` derivative via pyvips, cached per hash) and `summary` otherwise — external or unprobeable images keep the presence-based default (large when an image exists). The node's `Node.large` setting overrides that pick per article (False = small, True = large, the default None = automatic; NOT inherited like `Node.image`). The page title is injected as `# {title}` when the markdown has no h1 of its own, so it never appears twice (it always supplies `<title>` and nav labels).
The navbar holds top-level items only; the current section's subitems go to a left `#sidebar` as a nested list (the section's direct children plain, deeper levels indented with article-list-style markers), rendered only from the second level down — main-level pages list their children as cards after the content instead. Below that, the sidebar renders when the section offers at least two published items, or exactly one while viewing anything other than that only page — the section index, a 404, a grandchild (so those pages can reach the child), and also on that only page itself when it has published children of its own; no aside element at all on the front page, main-level pages, leaf pages and the sole childless page of a one-page section. Also, category labels are nodes without content — None *or* empty markdown — and their nav links point at their first child page. Dynamic regions have stable ids (`#page-banner`, `#nav`, `#sidebar`, `#main`) for fetch-navigation swaps (`#sidebar` may be absent on either side of a swap). The navbar holds top-level items only; the current section's subitems go to a left `#sidebar` as a nested list (the section's direct children plain, deeper levels indented with article-list-style markers), rendered only from the second level down — main-level pages list their children as cards after the content instead. Below that, the sidebar renders when the section offers at least two published items, or exactly one while viewing anything other than that only page — the section index, a 404, a grandchild (so those pages can reach the child), and also on that only page itself when it has published children of its own; no aside element at all on the front page, main-level pages, leaf pages and the sole childless page of a one-page section. Also, category labels are nodes without content — None *or* empty markdown — and their nav links point at their first child page. Dynamic regions have stable ids (`#page-banner`, `#nav`, `#sidebar`, `#main`) for fetch-navigation swaps (`#sidebar` may be absent on either side of a swap).
Any page with published children — a category page — lists them as a card grid (`nav.cards`) after the markdown content, as does the content-less category 404. Each card links to the child page (a content-less child to its first leaf) and shows the child's card image (its resolved `Node.image` when set, else the same hero → first raster → first SVG heuristics as `og:image`). The layout follows the same selection as `twitter:card` (_card_large — the child's per-article `Node.large` override, else the image's probed dimensions): large cards show the image as a full-card cover with the title overlaid, small cards (`.card.compact`) split horizontally at the golden ratio (two sub-grids, top φ : bottom 1): the square image fills the top part with the title beside it at its bottom, the article description (which only the small format carries) tops the bottom part — title and description carry the translucent band (the same band color as the large cards' title) as their own background; imageless cards keep the image space as a blank gradient. Each card carries the target article's language as its `lang` (the page language when the target is translated into it, else the target's primary language — matching the per-card text fallback) so the clamped title/description hyphenate correctly (`hyphens: auto`). Any page with published children — a category page — lists them as a card grid (`nav.cards`) after the markdown content, as does the content-less category 404. Each card links to the child page (a content-less child to its first leaf) and shows the child's card image (its own `Node.image` when set, else the same hero → first raster → first SVG heuristics as `og:image`, else the inherited image). The layout follows the same selection as `twitter:card` (_card_large — the child's per-article `Node.large` override, else the image's probed dimensions): large cards show the image as a full-card cover with the title overlaid, small cards (`.card.compact`) split horizontally at the golden ratio (two sub-grids, top φ : bottom 1): the square image fills the top part with the title beside it at its bottom, the article description (which only the small format carries) tops the bottom part — title and description carry the translucent band (the same band color as the large cards' title) as their own background; imageless cards keep the image space as a blank gradient. Each card carries the target article's language as its `lang` (the page language when the target is translated into it, else the target's primary language — matching the per-card text fallback) so the clamped title/description hyphenate correctly (`hyphens: auto`).
## `seed.py` ## `seed.py`
+1 -1
View File
@@ -24,7 +24,7 @@ Files are content-addressed (blake3[:12] + extension) and stored **on disk** und
## Card images ## Card images
`Node.image` names a content-addressed store file (12-hex hash, served at `/_f/{name}`) used as the page's card image: `og:image`/`twitter:image` meta and the card cover in listings. Empty inherits the nearest ancestor's image, the front page last; unset everywhere, the meta tags fall back to mining the rendered article (hero → first raster → first SVG). Set in the editor's banner panel (upload → `PUT /_api/files/{name}`, then a `save` with `image` over the editor WebSocket), stored at `IMAGE_MAXSIZE` like other uploads. `twitter:card` picks `summary_large_image` vs `summary` from the image's probed dimensions (views.py `_image_dims`). `Node.image` names a content-addressed store file (12-hex hash, served at `/_f/{name}`) used as the page's card image: `og:image`/`twitter:image` meta and the card cover in listings. The effective image follows the priority: the node's own `image`, then one mined from the rendered article (hero → first raster → first SVG), then the inherited image (the nearest ancestor's, the front page last). The special value `@favicon` resolves to the site icon (`Data.favicon`) at render time — it follows favicon changes rather than copying the current icon. Set in the editor's banner panel (upload → `PUT /_api/files/{name}` or paste from the pasteboard — an image uploads, an image URL is sent as the `image` setting itself and fetched/stored server-side by the save handler, since cross-origin URLs are CORS-blocked for the browser — then a `save` with `image` over the editor WebSocket; the site-icon button saves `@favicon`), stored at `IMAGE_MAXSIZE` like other uploads. `twitter:card` picks `summary_large_image` vs `summary` from the image's probed dimensions (views.py `_image_dims`).
`Node.large: bool | None` overrides the automatic card-mode pick per article: None = automatic, False forces a small card, True a large one. Unlike `image`, it is NOT inherited down the tree. Set from the banner panel's card previews (a `save` with `large` over the editor WebSocket). `Node.large: bool | None` overrides the automatic card-mode pick per article: None = automatic, False forces a small card, True a large one. Unlike `image`, it is NOT inherited down the tree. Set from the banner panel's card previews (a `save` with `large` over the editor WebSocket).
+1 -1
View File
@@ -27,7 +27,7 @@ Pagerite is a single-user CMS/blog. This document records the initial high-level
- All pages share one static layout, defined once as an **html5tagger Template** with capitalized placeholders (`Title`, `Banner`, `Nav`, `Sidebar`, `Main`) filled per request. The dynamic regions carry stable ids (`#page-banner`, `#nav`, `#sidebar`, `#main`). - All pages share one static layout, defined once as an **html5tagger Template** with capitalized placeholders (`Title`, `Banner`, `Nav`, `Sidebar`, `Main`) filled per request. The dynamic regions carry stable ids (`#page-banner`, `#nav`, `#sidebar`, `#main`).
- The page top is a **full-width banner header** with the site name and the navigation bar overlaid on it — no separate chrome header. The banner combines two layers, stacked in `#page-banner` (a grid, so they overlay): first the **banner design** — a named design living in a theme folder (`pagerite/themes/{name}/banner.css` plus artwork as `banner.html` — arbitrary markup like canvas + style + script — or `banner.svg`), chosen per page via `Node.banner_design` (a design name, "" for none, None to inherit from the nearest ancestor, then the front page, then the active theme's own design). The artwork is inlined into a `div[data-design]` wrapper: SVG artwork can be recolored from the theme stylesheet (corporate's single SVG serves both light and dark mode via `var()`-driven stops). Second, **per-page author code**: `Node.banner` holds an arbitrary trusted HTML snippet (an image, a styled div, canvas + script — anything), resolved by walking up the node's ancestors to the front page and rendered **after** the design artwork, so author styles always win over the design's own. The base stylesheet falls back to a plain gradient. There is deliberately no scrim fading the banner into the page background — any such fade would ruin user-supplied designs; themes that want one bake it into their SVG (purple does). - The page top is a **full-width banner header** with the site name and the navigation bar overlaid on it — no separate chrome header. The banner combines two layers, stacked in `#page-banner` (a grid, so they overlay): first the **banner design** — a named design living in a theme folder (`pagerite/themes/{name}/banner.css` plus artwork as `banner.html` — arbitrary markup like canvas + style + script — or `banner.svg`), chosen per page via `Node.banner_design` (a design name, "" for none, None to inherit from the nearest ancestor, then the front page, then the active theme's own design). The artwork is inlined into a `div[data-design]` wrapper: SVG artwork can be recolored from the theme stylesheet (corporate's single SVG serves both light and dark mode via `var()`-driven stops). Second, **per-page author code**: `Node.banner` holds an arbitrary trusted HTML snippet (an image, a styled div, canvas + script — anything), resolved by walking up the node's ancestors to the front page and rendered **after** the design artwork, so author styles always win over the design's own. The base stylesheet falls back to a plain gradient. There is deliberately no scrim fading the banner into the page background — any such fade would ruin user-supplied designs; themes that want one bake it into their SVG (purple does).
- **Fetch-navigation.** Links are plain `<a href>`; a small script (`frontend/src/pagerite.js`) intercepts same-origin clicks, fetches the page, and swaps the `#page-banner`, `#nav`, `#sidebar` and `#main` regions, the document title, and the site-wide custom CSS (`<style id="pagerite-user">` in `<head>`), keeping the rest of `<head>` and the layout chrome. Without JS everything works as normal page loads. Scripts inside fetched banner and content regions are re-created so they execute. Swaps run inside `document.startViewTransition` for the page transition selected in the site settings (`Data.transition`; the `cube` design — CSS adapted from termotohtori.fi, fragile, do not tweak — rotates, mirrored on browser back; `crossfade` fades; both skipped under `prefers-reduced-motion`). With `cube`, navigation within the same top-level section crossfades instead of rotating. - **Fetch-navigation.** Links are plain `<a href>`; a small script (`frontend/src/pagerite.js`) intercepts same-origin clicks, fetches the page, and swaps the `#page-banner`, `#nav`, `#sidebar` and `#main` regions, the document title, and the site-wide custom CSS (`<style id="pagerite-user">` in `<head>`), keeping the rest of `<head>` and the layout chrome. Without JS everything works as normal page loads. Scripts inside fetched banner and content regions are re-created so they execute. Swaps run inside `document.startViewTransition` for the page transition selected in the site settings (`Data.transition`; the `cube` design — CSS adapted from termotohtori.fi, fragile, do not tweak — rotates, mirrored on browser back; `crossfade` fades; both skipped under `prefers-reduced-motion`). With `cube`, navigation within the same top-level section crossfades instead of rotating.
- **The site structure is a tree of labels.** `Data.menu` holds the top-level items by slug, each with `children` keyed by slug — the URL path is the slug chain. The front page is a top-level node with slug "" (an item *parallel* to the other main level pages, not their parent) and cannot have children. The header navbar holds only the top level; a top-level item is highlighted when viewing any of its subpages. A page with published children lists them as **cards** after its content (the child page's card image as the cover — its resolved `Node.image` when set, else mined like the og tags — laid out by the child's card-mode selection: full-card cover with the title overlaid, or a golden-ratio split with a square image and the title in the top part, the description below it on a translucent band); a **left sidebar** (`#sidebar`) with the section's sub-navigation appears only from the second level down, when there is something to navigate — main-level pages, sections with fewer than two published items, leaf pages and the front page render no aside element at all. Other sections' subitems are never shown without navigating into them first. - **The site structure is a tree of labels.** `Data.menu` holds the top-level items by slug, each with `children` keyed by slug — the URL path is the slug chain. The front page is a top-level node with slug "" (an item *parallel* to the other main level pages, not their parent) and cannot have children. The header navbar holds only the top level; a top-level item is highlighted when viewing any of its subpages. A page with published children lists them as **cards** after its content (the child page's card image as the cover — its own `Node.image` when set, else mined like the og tags, else the inherited one — laid out by the child's card-mode selection: full-card cover with the title overlaid, or a golden-ratio split with a square image and the title in the top part, the description below it on a translucent band); a **left sidebar** (`#sidebar`) with the section's sub-navigation appears only from the second level down, when there is something to navigate — main-level pages, sections with fewer than two published items, leaf pages and the front page render no aside element at all. Other sections' subitems are never shown without navigating into them first.
- **Landing pages are optional.** Every label can either have content (`Node.content`, a Markdown page) or none — a content-less label renders a 404 page listing its children as cards (with a pen to create the landing page) instead of redirecting, while nav links to it point straight at its first child, so categories need no filler content and normal navigation never sees the 404. Title and slug of every label are editable; renaming a slug moves the whole subtree. The sidebar never lists the section itself, avoiding title duplication with the navbar. - **Landing pages are optional.** Every label can either have content (`Node.content`, a Markdown page) or none — a content-less label renders a 404 page listing its children as cards (with a pen to create the landing page) instead of redirecting, while nav links to it point straight at its first child, so categories need no filler content and normal navigation never sees the 404. Title and slug of every label are editable; renaming a slug moves the whole subtree. The sidebar never lists the section itself, avoiding title duplication with the navbar.
- **Menu order is manual.** Each node has a fractional `order` key among its siblings; reordering/moving writes only the moved node (it takes a fresh value halfway between its new siblings; all other items keep theirs). New pages append at the end of their menu. Structure edits (reorder, move/rename with the whole subtree, retitle) go through `POST /_api/structure` and the editor's structure panel. - **Menu order is manual.** Each node has a fractional `order` key among its siblings; reordering/moving writes only the moved node (it takes a fresh value halfway between its new siblings; all other items keep theirs). New pages append at the end of their menu. Structure edits (reorder, move/rename with the whole subtree, retitle) go through `POST /_api/structure` and the editor's structure panel.
- Unpublished pages are hidden from both nav and URL access (404). - Unpublished pages are hidden from both nav and URL access (404).
+2 -2
View File
@@ -7,7 +7,7 @@ The Vue editor is a single tabbed `EditorShell.vue` mounted in a host div create
The shell hosts five kept-alive tabs (ordered site-wide first — site, structure, localization — then, after a visual break, the per-page tabs — article, banner): The shell hosts five kept-alive tabs (ordered site-wide first — site, structure, localization — then, after a visual break, the per-page tabs — article, banner):
- `PageEditor.vue` — CodeMirror + server-rendered preview over WebSocket `/_api/ws/editor`, previewing into the visible article; editor and article scrolls are linked piecewise-linearly, keyed on the section anchors' `data-line` (markdown source line the backend stamps on top-level anchored h1/h2s): the page follows the cursor (fractional, wrap-aware, scrolling only when the cursor's page position leaves the viewport, with an edge margin), the editor follows page scroll with a progress-based viewport anchor, applied instantly (the window keeps scrolling normally while any editor is open — the panel is fixed to the viewport's left edge, its top tracking the banner's bottom edge until the banner scrolls away — and the panel scrolls internally); anchored h2s carry their own edit pens that open the editor scrolled to that section; a format bar offers Markdown helpers — bold/italic/code/link/table/image upload (always block-level on a fresh blank-separated line of its own — a cursor on a non-empty line, e.g. inside an existing image tag, inserts after that line, never into it; always with an empty `""` caption, cursor inside the quotes), toggling fences (` ``` ` code blocks and `::: aside` containers share the same machinery: clicked inside one they remove it and select the content, otherwise they wrap the selection or the cursor's line, keeping it selected), and `.left`/`.right`/`.wide`/`.margin` placement toggles plus `.small`/`.large`/`.huge` text-size toggles (brace attributes on the block at the cursor, mutually exclusive within each group; on `:::` containers a placement class replaces the container name instead — `::: aside` → `::: margin`), with Ctrl/Cmd-B/I/S bindings — for the hard-to-remember syntax. Edits content and title only, never the path. - `PageEditor.vue` — CodeMirror + server-rendered preview over WebSocket `/_api/ws/editor`, previewing into the visible article; editor and article scrolls are linked piecewise-linearly, keyed on the section anchors' `data-line` (markdown source line the backend stamps on top-level anchored h1/h2s): the page follows the cursor (fractional, wrap-aware, scrolling only when the cursor's page position leaves the viewport, with an edge margin), the editor follows page scroll with a progress-based viewport anchor, applied instantly (the window keeps scrolling normally while any editor is open — the panel is fixed to the viewport's left edge, its top tracking the banner's bottom edge until the banner scrolls away — and the panel scrolls internally); anchored h2s carry their own edit pens that open the editor scrolled to that section; a format bar offers Markdown helpers — bold/italic/code/link/table/image upload (always block-level on a fresh blank-separated line of its own — a cursor on a non-empty line, e.g. inside an existing image tag, inserts after that line, never into it; always with an empty `""` caption, cursor inside the quotes), toggling fences (` ``` ` code blocks and `::: aside` containers share the same machinery: clicked inside one they remove it and select the content, otherwise they wrap the selection or the cursor's line, keeping it selected), and `.left`/`.right`/`.wide`/`.margin` placement toggles plus `.small`/`.large`/`.huge` text-size toggles (brace attributes on the block at the cursor, mutually exclusive within each group; on `:::` containers a placement class replaces the container name instead — `::: aside` → `::: margin`), with Ctrl/Cmd-B/I/S bindings — for the hard-to-remember syntax. Edits content and title only, never the path.
- `BannerEditor.vue` — per-page banner HTML + banner design selector, previewed into `#page-banner`, plus the page's card image (`Node.image`, inherited by the subtree): just an upload button and a ✕ clearing the node's own (back to inherit) — the label states which image is in use (none / inherited from … / set for this article, “used in /<path>/*” when it has children / mined from the article) and the card previews below show it. Below it, the site's own cards preview in both modes (small and large) with the real `.card` markup and styles from pagerite.css — theme variables included, they are the site's look — scaled down via font-size (the card internals are all em, so the layout proportions match real cards exactly); both render the effective card image (the resolved node image, else the image the server mines from the article), and the description appears only in the small format, like the backend's `_card`. The previews double as the card-mode selector for the per-article `Node.large` override: clicking one forces that mode (thin solid outline), clicking the selected one returns to automatic; under automatic the mode auto currently resolves to gets a dashed marker (both outlines — selection never shifts the layout), approximated from image presence only (the server's dimension probe is not available in the panel). - `BannerEditor.vue` — per-page banner HTML + banner design selector, previewed into `#page-banner`, plus the page's card image (`Node.image`, inherited by the subtree): upload and paste (pasteboard: an image uploads, an image URL is fetched and stored server-side via the `save` socket message) buttons, a site-icon button (saves `@favicon`, which resolves to the current site icon at render time, following favicon changes) and a ✕ clearing the node's own (back to inherit) — the label states which image is in use (none / set for this article, “used in /<path>/*” when it has children / the site icon / mined from the article / inherited from …) and the card previews below show it. Below it, the site's own cards preview in both modes (small and large) with the real `.card` markup and styles from pagerite.css — theme variables included, they are the site's look — scaled down via font-size (the card internals are all em, so the layout proportions match real cards exactly); both render the effective card image (the node's own, else the image the server mines from the article, else the inherited one), and the description appears only in the small format, like the backend's `_card`. The previews double as the card-mode selector for the per-article `Node.large` override: clicking one forces that mode (thin solid outline), clicking the selected one returns to automatic; under automatic the mode auto currently resolves to gets a dashed marker (both outlines — selection never shifts the layout), approximated from image presence only (the server's dimension probe is not available in the panel).
- `SiteEditor.vue` — site brand + optional custom brand HTML with image/video upload + theme selector + page-transition selector + font picker + favicon upload — clicking the preview tile picks a new one — + site-wide custom CSS, CSS injected into `<head id="pagerite-user">`. - `SiteEditor.vue` — site brand + optional custom brand HTML with image/video upload + theme selector + page-transition selector + font picker + favicon upload — clicking the preview tile picks a new one — + site-wide custom CSS, CSS injected into `<head id="pagerite-user">`.
- `StructureEditor.vue` — the vue-draggable structure tree with always-editable title/slug inputs per row and a per-row flag dropdown setting the page's primary language (`Node.language`, inherited by the subtree). - `StructureEditor.vue` — the vue-draggable structure tree with always-editable title/slug inputs per row and a per-row flag dropdown setting the page's primary language (`Node.language`, inherited by the subtree).
- `LocalizationEditor.vue` — the site-wide translation settings: target languages as a flag grid (toggles, grouped in geographic rows; see docs/localization.md), the refresh-all-translations button, and the translator service WebSocket URL(s) to connect `scripts/translator.py` to. - `LocalizationEditor.vue` — the site-wide translation settings: target languages as a flag grid (toggles, grouped in geographic rows; see docs/localization.md), the refresh-all-translations button, and the translator service WebSocket URL(s) to connect `scripts/translator.py` to.
@@ -18,7 +18,7 @@ In-place page re-rendering shared by the banner/site/structure tabs lives in `sw
The page and structure tabs share one language selector: `LangSelect.vue` (small flag + dropdown) v-modeled on the shell-wide selection in `editorLang.js` (`''` = primary). While the panel is open that selection overrides the page's normal language preferences: EditorShell calls `swapdoc.setLangOverride`, which pins every `loadPlain` fetch (`?lang=`, the primary by its own code) and pagerite.js's own fetches/prefetches (`pagerite:session-lang`), until the panel closes and the override clears. The page and structure tabs share one language selector: `LangSelect.vue` (small flag + dropdown) v-modeled on the shell-wide selection in `editorLang.js` (`''` = primary). While the panel is open that selection overrides the page's normal language preferences: EditorShell calls `swapdoc.setLangOverride`, which pins every `loadPlain` fetch (`?lang=`, the primary by its own code) and pagerite.js's own fetches/prefetches (`pagerite:session-lang`), until the panel closes and the override clears.
All WebSockets (page/banner editors, analytics view, the pagerite.js activity channel) pace their connections through `reconnect.js`: new sockets are created a staggered slot apart (a page load opens Vite's HMR socket plus several of ours at the same moment, and such bursts — like rapid retries — trip the browser's WebSocket throttling, leaving every socket to the host "pending" for minutes), a watchdog closes sockets stuck CONNECTING so they reschedule instead of hanging forever, and retries follow an exponential backoff with jitter that only a healthy connection resets. While a socket is connecting or waiting to reconnect the panel says so (`ConnNote.vue`), and the CodeMirror editors stay locked until their document arrives (typing before the doc accept would be clobbered by it). All WebSockets (page/banner editors, analytics view, the pagerite.js activity channel) pace their connections through `reconnect.js`: new sockets are created a staggered slot apart (a page load opens Vite's HMR socket plus several of ours at the same moment, and such bursts — like rapid retries — trip the browser's WebSocket throttling, leaving every socket to the host "pending" for minutes), a watchdog closes sockets stuck CONNECTING so they reschedule instead of hanging forever, and retries follow an exponential backoff with jitter that only a healthy connection resets. The admin sockets (`/_api/...`) also close through `authReconnect`: an expired session fails the WS handshake like a dead network but can never open the login dialog from a socket, so the close handler probes `/_api/settings` first — a 401/403 runs the paskia login flow and reconnects the moment it completes (a declined login holds at a "session expired" note; a login anywhere in the page reconnects the panel, via paskia's `auth-success` window message), and only genuine network/server failures take the paced backoff. While a socket is connecting or waiting to reconnect the panel says so (`ConnNote.vue`), and the CodeMirror editors stay locked until their document arrives (typing before the doc accept would be clobbered by it).
## Saving behavior ## Saving behavior
+1 -1
View File
@@ -14,7 +14,7 @@ It first probes `GET /auth/api/settings` to detect whether Paskia SSO is availab
The editor/analytics components (everything except pagerite.js and main.js) make their `/_api` calls through paskia-js's `apiFetch`/`apiJson` instead of plain `fetch`: when a call gets a 401/403 carrying an `auth.iframe` hint (expired session), the login dialog opens in place and the request retries transparently after authentication. pagerite.js uses `apiJson` only for the task-checkbox toggle (ticking a box is an explicit edit attempt, so a login dialog is welcome there; any failure — including a cancelled login — reverts the checkbox) and `fetchJson` for its auth probes (plain fetch with JSON handling and errors on non-OK, never a dialog); page-cache and navigation fetches stay on plain `fetch`, so anonymous visitors never get a login popup uninvited. The editor/analytics components (everything except pagerite.js and main.js) make their `/_api` calls through paskia-js's `apiFetch`/`apiJson` instead of plain `fetch`: when a call gets a 401/403 carrying an `auth.iframe` hint (expired session), the login dialog opens in place and the request retries transparently after authentication. pagerite.js uses `apiJson` only for the task-checkbox toggle (ticking a box is an explicit edit attempt, so a login dialog is welcome there; any failure — including a cancelled login — reverts the checkbox) and `fetchJson` for its auth probes (plain fetch with JSON handling and errors on non-OK, never a dialog); page-cache and navigation fetches stay on plain `fetch`, so anonymous visitors never get a login popup uninvited.
Asset wiring differs by mode. In dev the backend links the Vite dev-server URLs (`pagerite:editor-src`/`-css`/`pagerite:analytics-src` meta tags, `<link>` stylesheets) and Vite injects the entry CSS from JS for hot reloads. In production there are no pagerite meta tags: all page assets are inlined into the document — stylesheets as `<style>` elements in `<head>` (fixed order: base, theme, banner design, page transition, entry sheets, custom CSS last), module scripts as inline `<script>`s at the end of the body (relative chunk imports are rewritten to absolute `/_assets/` paths) — and the on-demand bundles' URLs ride in a `<script type="application/json" id="pagerite-assets">` config. The editor bundle always stays external, imported on demand when a pen is opened. Every stylesheet element carries a stable id so fetch-navigation and the site editor can sync `<head>` positionally across swaps (the analytics sheet exists on `/_a` only and is added/removed as you navigate). The analytics entry is inlined into the `/_a` page itself; pagerite.js re-creates that script element after fetch-navigating there (inline scripts don't execute on a DOM swap) and calls the module's exposed unmount before swapping away. Asset wiring differs by mode. In dev the backend links the Vite dev-server URLs (`pagerite:editor-src`/`-css`/`pagerite:analytics-src`/`pagerite:contact-src` meta tags, `<link>` stylesheets) and Vite injects the entry CSS from JS for hot reloads. In production there are no pagerite meta tags: all page assets are inlined into the document — stylesheets as `<style>` elements in `<head>` (fixed order: base, theme, banner design, page transition, entry sheets, custom CSS last), module scripts as inline `<script>`s at the end of the body (relative chunk imports are rewritten to absolute `/_assets/` paths) — and the on-demand bundles' URLs ride in a `<script type="application/json" id="pagerite-assets">` config. The editor bundle always stays external, imported on demand when a pen is opened; the langselect and contact bundles load on demand the same way, on multi-language pages and `{contact:}` trigger clicks. Every stylesheet element carries a stable id so fetch-navigation and the site editor can sync `<head>` positionally across swaps (the analytics sheet exists on `/_a` only and is added/removed as you navigate). The analytics entry is inlined into the `/_a` page itself; pagerite.js re-creates that script element after fetch-navigating there (inline scripts don't execute on a DOM swap) and calls the module's exposed unmount before swapping away.
## `assets/` ## `assets/`
+7
View File
@@ -503,6 +503,13 @@ offerable to clients of another approach.
placeholders lost is skipped individually and likewise stays pending placeholders lost is skipped individually and likewise stays pending
for a scoped title job. for a scoped title job.
Site-level settings strings (the contact-messaging label/subject,
docs/messages.md) localize through the same machinery: they are emitted
as title-kind fragments by `pending_items` and ride nav jobs as extra
top-level list items; `i18n.site_string` looks them up at render time,
and manual overrides are edited in the site editor's messaging block
(`i18n.set_string_translation`).
`scripts/llm_translator.py` is the reference markdown+article+nav client `scripts/llm_translator.py` is the reference markdown+article+nav client
(instruct LLMs via an OpenAI Chat Completions endpoint or ollama's native (instruct LLMs via an OpenAI Chat Completions endpoint or ollama's native
API); `scripts/translator.py` (Seed-X) is untouched and announces API); `scripts/translator.py` (Seed-X) is untouched and announces
+272
View File
@@ -0,0 +1,272 @@
# Contact messages
Visitor→admin messaging built into the site: a `{contact: Label}` directive
in article Markdown renders a button that opens the messaging overlay, and
the corner ✉️ icon (top right, for everyone) opens it too — the visitor's
own thread for visitors, the admin inbox for editors. Messages are stored
in the kanta database. Visitors are anonymous — a localStorage session
token identifies their thread — and everything realtime rides the two
existing WebSockets; there is no REST polling anywhere.
- `pagerite/messages.py` — the feature's core: the strict message renderer,
thread store ops, wire payloads, both socket protocols, the admin unread
count and the `/_contact/files` upload route.
- `pagerite/data.py` — `Data.contact` (`ContactThread`/`ContactMessage`)
and the site settings (`contact_label` — which doubles as the on/off
switch — `contact_email`, `contact_subject`, `contact_mailserver`).
- `pagerite/tracking.py` — the sockets the protocol rides (see below).
- `pagerite/api.py` — `/_api/settings` carries `contact_unread` (the admin
icon badge seed — the probe runs on every page load, no polling) and the
contact configuration (with `?lang=` overrides for the label/subject).
- `pagerite/views.py` — the `{contact:}` directive (`_contact_tag`), the
localized contact strings (`_contact_config`) and the on-demand bundle's
asset config.
- `frontend/src/contact-main.js` + `ContactOverlay.vue` — the overlay entry
and shell (paskia's shared blur backdrop, centered dialog, full-screen on
mobile), imported on demand by `pagerite.js` on icon/trigger clicks.
- `frontend/src/ContactPanel.vue` — the visitor thread content.
- `frontend/src/MessagesView.vue` — the admin inbox content (thread list,
replies, read marking); connects its admin-gated socket only while open.
- `frontend/src/Composer.vue` + `richtext.js` — the shared composer and its
DOM→Markdown serializer.
## Trigger
A lone `{contact: Label}` line in article Markdown (the block-directive
machinery of `markdown.py`) renders
`<button class="contact-trigger">Label</button>`. An empty label falls
back to the configured site label (`Data.contact_label`, localized —
below; "Contact us" is the last-resort fallback when neither is set).
`pagerite.js`
click-delegates these buttons and lazy-loads
the contact bundle; the editor preview renders the same button inert, and
description/card mining resolves the tag to nothing. A per-button label
lives in the chunk, so translated pages localize it like any other text.
Feeds render the tag as its literal source (no directive context). When
messaging is disabled (no site label configured) the tag renders nothing
at all, in the editor preview just as on the served page.
## Site settings and localization
The site editor's messaging row holds the feature's configuration
(`/_api/settings`): `contact_label` — the {contact:} buttons' label and
the visitor dialog's title, doubling as the on/off switch (empty = no
trigger buttons, no visitor corner icon, sends rejected; admins keep the
inbox for existing threads) — `contact_email` (a mailto link in the
visitor dialog: the recipient is addressed `Brand <email>`, the link
text the bare address, the subject prefilled) and `contact_subject`
(defaults to the label). `contact_mailserver` is a mailbridge URL
(`smtp://user:pass@host:port`, a bare `host[:port]`, or a backend URL
like `sendgrid:API-KEY`) reserved for email notifications — the actual
sending is not implemented yet. Saves re-render the page in place, so
button and dialog strings update without a reload.
Both sides also get browser notifications (the Notification API,
`frontend/src/notify.js`): permission is asked at one entry point only —
right after the first message of a fresh thread (a denied permission is
permanent in the browser and never re-asked; a dismissed prompt comes up
again on the next fresh thread). With permission granted the visitor is
notified of new admin replies while not viewing the thread and the admin
of new visitor messages; clicking a notification focuses the tab and
opens the thread/inbox at what was new.
The two strings localize like titles: translations live in the
chunk-keyed `Data.trans` store (`i18n.site_string` looks them up at
render time) and the translator service picks them up automatically
(`pending_items` emits them as title-kind fragments; nav-mode jobs carry
them as extra top-level list items). Manual overrides are edited in the
same messaging row: the flag selector (the article editor's LangSelect)
switches the label/subject fields to a translation, saved via
`PUT /_api/settings?lang=` into the
same store (`i18n.set_string_translation`; empty or the original's text
drops the override). The localized strings reach the client through the
page's asset config (`pagerite:contact-label` / `-subject`, absent
entirely when disabled — pagerite.js reads that as "visitors get no
icon") plus `pagerite:contact-langs`, a JSON map of every site
language's variant: the language selector swaps pages in place without
touching the asset config, so the client re-picks the strings live from
`<html lang>`. The
email address itself is never in the config: it is revealed over the
messaging socket only after the proof of work is solved (and only when
configured).
The visitor-facing UI carries no hardcoded language: the dialog title
and mailto subject are the localized site strings, and everything else
is glyphs (✉️ empty state, 👤/📧 intro fields, ✏️ composer placeholder,
toolbar symbols, the two-tap-armed ⟲ close-conversation button — no
text confirm). The admin inbox UI stays English.
## Visitor side
The token is `crypto.randomUUID()` in localStorage
(`pagerite-contact-token`), generated on first use; the server stores only
its blake3 hash as the thread key. Pages are shared/cached renders, so the
thread UI is entirely client-side. A per-browser "seen" timestamp
(`pagerite-contact-seen`) and the newest admin reply's timestamp
(`pagerite-contact-lastadmin`) drive the unread marker (a periodic
scale-and-shake nudge animation, `has-unread` in pagerite.css) on trigger
buttons and the corner ✉️ icon when an admin reply arrives while the panel
is closed — including on a fresh page load before any socket activity
(pagerite.js reads the pair directly; the bundle keeps it live once
loaded). A live conversation is also flagged
(`pagerite-contact-session`): while set, page loads register the session
right away (no panel click needed), so a granted notification permission
reports new replies immediately.
**Closing a conversation**: the panel's ⟲ button sends `{token, close}` —
the server marks the thread `closed` (archived in the admin inbox,
excluded from the unread count, replies rejected, the token's pushes
stopped) — then wipes the local session keys (token, seen, lastadmin,
session flag) and rotates the token, so the next message starts an
all-new thread.
The panel rides the public `/_ws` activity socket via a bridge in
`pagerite.js` (`register`/`send`, sharing its queue and reconnect pacing —
no extra connection). Frames **to** the server:
- `{token}` — register/resync; the current thread state is pushed back.
`pagerite.js` re-sends this on every socket (re)connect, which is the
resync mechanism (the socket idle-closes after 5 min and reconnects on
activity).
- `{token, pow}` — a solved proof-of-work, submitted as soon as the
background solve finishes (below); grants the message/upload quota,
reveals the site's contact email and marks the visit's analytics trail.
- `{token, msg, fr, name?, email?}` — append a message; `msg` is the
Markdown-subset source, `fr` the page path it was sent from (stored
for context). Spends one quota; with none left it is answered with a
fresh `required` challenge instead, which the client solves, re-proves
and retries the message once. The **first** message
of a thread must carry `name` (and optionally `email`, unvalidated)
introducing the visitor; the identity is stored on the thread and fixed
from then on.
- `{token, close}` — end the conversation (archived for admins; above).
Frames **from** the server: `{type: "thread", id, created, unread,
closed, name, email, messages: [{id, t, admin, html, page}]}` — a full
thread snapshot
(replace/upsert by `id`); `{type: "pow", challenge, required}` — a fresh
single-use PoW challenge (`required` means the last message was rejected
for an empty quota and should be re-sent once re-proven); `{type: "pow",
quota}` — a submitted proof was accepted, this many messages/uploads it
grants; `{type: "contact-email", email}` — the site's contact email,
revealed only after a solve; or `{type: "contact-error", detail}`.
### Proof of work (anti-spam)
Sends and uploads draw from a quota granted by easypow (PBKDF2
challenges, ~5 s solving cost, 10 actions per solve). The server hands a
fresh single-use challenge on registration/resync and whenever the quota
runs out; the panel solves it in the background with the bundled solver
module (served from the installed package at `/_contact/easypow.js`, so
client and validator versions always match) and submits the solution as
soon as it is ready — typically long before the user finishes writing,
so sends just work. Solutions are single-use and challenges are a
per-connection local in the `/_ws` handler; the granted quota lives in
RAM keyed by the token hash (single worker), shared with the HTTP upload
route and kept across reconnects. A validated proof also reveals the
site's contact email (the address never appears in pages — scrapers
cannot lift it without solving) and records the visit's contact trail
marker in analytics (a panel opened without a solve leaves no trace).
## Admin side
Editors open the inbox from the same ✉️ corner icon (the trigger buttons
always open the visitor side, so both can be tested side by side): the
same overlay, wider to fit the thread list, served by the existing
`/_api/ws/analytics` socket (admin-gated like all of `/_api`) which
`MessagesView` connects while the overlay is open — and a background
watch in `contact-main.js` (`watchAdmin`) connects at every page load
while messaging is enabled, keeping the icon badge live and notifying
new visitor messages without waiting for the inbox (MessagesView owns
notifications while open). Analytics payloads
keep their type-less snapshot shape; messaging frames always carry a
`type` field, and that is how each client picks out its own frames (the
analytics viewer ignores them). On connect the server sends
`{type: "threads", threads: [...]}` (100 most recently active, archived
last); new
messages and replies push single-thread updates. Admin→server frames:
`{type: "reply", id, text}` and `{type: "read", id}`.
Replies store the SSO `remote-user` name for audit but are labeled with
the currently configured **site name** in the wire payload (substituted at
read time) and mark the thread read; `unread` on a thread means its last
message is the visitor's and newer than the admin's last read. The icon's
unread marker (any unanswered thread, archived ones excluded) is seeded by the `/_api/settings`
probe's `contact_unread` on every page load and kept live by the watch
and the inbox.
## Message format and the XSS model
Bodies are a **Markdown subset** — emphasis, links, lists, code, plus
`/_f/` image and file references — serialized client-side from a
constrained contenteditable composer (plain-text paste only; formatting
via toolbar; uploads insert image/attachment-chip nodes).
**No user HTML is ever rendered or sanitized.** Sanitizing arbitrary HTML
is unwinnable, so the design never attempts it: the composer serializes to
*text*, and the server re-renders that text with a strict `MarkdownIt`
instance (`messages.py`): `html=False` (the page renderer's trusted-author
raw passthrough does not apply here), no plugins. Every byte of the stored
`html` is markdown-it output from the constrained grammar. markdown-it
also validates link protocols (`javascript:` & co. never become `href`s);
the link rule adds `rel="nofollow ugc noopener"` + `target="_blank"` (and
`download` + a chip class for `/_f/` attachment links); images are
restricted to `/_f/` store names, anything else collapses to its alt text.
Both panels inject this server-rendered HTML verbatim (`v-html`) — the one
injection point, fed only by the strict renderer.
## Uploads
`PUT /_contact/files/{name}` (public, like the messaging socket) stores
panel uploads in the content-addressed file store. Images (raster and
SVG) go through the usual AVIF/WebP/JPEG derivative pipeline and inline
in the message — SVGs included: the extension-less link negotiates
raster derivatives, and even an as-is-served `.svg` is script-inert
inside an `<img>`. Everything else (videos, archives, html, exe…) is
stored as an inert `{hash}.file` blob — the original extension is
dropped on disk, so the store can never be double-click-executed — and
linked as `/_f/{hash}/{original-name}`; the `.file` suffix exists only
on the filesystem and is rejected in URLs. Serving is strictly
separated: `/_f/{name}` serves media only (hash with or without
extension), `.orig.` originals stay blocked, and the filename-carrying
route serves only `{name}.file` blobs (never media, never by hash).
Every `/_f/` response carries `content-disposition: attachment` (no
filename needed — the URL's last segment names the download) and
`x-content-type-options: nosniff`, so a store file can never be
rendered or sniffed into something executable in the site's origin;
subresource fetches (`<img>`, `<video>`, favicons) ignore the
disposition, so inline media is unaffected. The chip anchors
additionally carry a `download` attribute. Uploads spend the same PoW
quota as messages (a solved challenge covers both; the gates are a
session-shaped `x-contact-token` header, a 20 MB size cap, and the
quota itself) — an upload answered 429 "pow" makes the client re-prove
and retry once. Every upload also stays *pending* per session (10
un-sent files cap, answered 429 — not 403, which could trip auth
flows): a sent message strikes the files it references off the pending
set, and when the session's last socket closes the remaining pending
files are deleted from the store. Admin uploads from the same composer
go to the admin-gated `/_api/files` instead. Files left behind by a
server restart (the pending set is RAM-only) still linger — no GC.
## Storage
`Data.contact: dict[bytes, ContactThread]` in the kanta database, keyed by
the 12-byte blake3 hash of the session token (never the token itself). A
thread is `created`, `admin_read`, the visitor's self-entered
`name`/`email` (name required, email optional; captured with the first
message, fixed afterwards) and
`messages: dict[str, ContactMessage]` keyed by a sortable timestamp-random
id (dict-keyed, so a save's database diff touches only the appended
message). Each message stores `t`, the Markdown source `md`, its strict
rendering `html`, `admin` ("" = visitor, else the SSO name — the wire
payload shows the current site name instead) and `page`.
Appends are single transactions (`contact` / `contact:reply` /
`contact:read`).
## Limits and deliberate gaps (MVP)
- Message source ≤ 8000 chars; uploads ≤ 20 MB and ≤ 10 pending per
session; payloads cap at 100 threads × last 200 messages.
- No thread moderation (delete/block), no orphan-upload GC for files
orphaned by a server restart, and the panels' own UI strings (composer
hints, "you", inbox labels) are English-only — the *configurable* site
strings (label, subject) do localize (above).
+161 -33
View File
@@ -2,10 +2,12 @@
// Analytics viewer rendered as a normal page inside #main. Receives live // Analytics viewer rendered as a normal page inside #main. Receives live
// analytics data over /_api/ws/analytics (admin-gated by the auth proxy) and // analytics data over /_api/ws/analytics (admin-gated by the auth proxy) and
// renders totals, smoothed visit/views curves, a transition map, and recent // renders totals, smoothed visit/views curves, a transition map, and recent
// visit/crawler tables. Read-only. // visit/crawler tables. The same socket also carries the contact-messaging
// protocol (typed frames) for the admin inbox overlay (MessagesView.vue,
// docs/messages.md), so typed frames are ignored here.
// See docs/analytics.md for the data format. // See docs/analytics.md for the data format.
import { computed, onMounted, onUnmounted, ref, watch } from 'vue' import { computed, onMounted, onUnmounted, ref, watch } from 'vue'
import { apiJson } from 'paskia' import { fetchJson } from 'paskia'
import { import {
RANGES, RANGES,
rangeWindow, rangeWindow,
@@ -29,7 +31,7 @@ import VisitorCell from './VisitorCell.vue'
import TransitionGraph from './TransitionGraph.vue' import TransitionGraph from './TransitionGraph.vue'
import VisitorCharts from './VisitorCharts.vue' import VisitorCharts from './VisitorCharts.vue'
import { VIEW_W } from './analytics/chart.js' import { VIEW_W } from './analytics/chart.js'
import { reconnectPolicy, socketSlot, watchConnecting } from './reconnect' import { authReconnect, reconnectPolicy, socketSlot, watchConnecting } from './reconnect'
import ConnNote from './ConnNote.vue' import ConnNote from './ConnNote.vue'
// Same centering margin as the charts, so the totals row's left edge // Same centering margin as the charts, so the totals row's left edge
@@ -43,18 +45,23 @@ const pageTree = ref(null)
const error = ref('') const error = ref('')
const now = ref(Date.now()) const now = ref(Date.now())
let ws = null let ws = null
let reconnectTimeout = null let reconnectTimer = null
let connectWatchdog = null let connectWatchdog = null
const reconnects = reconnectPolicy() const reconnects = reconnectPolicy()
let timeInterval = null let timeInterval = null
let mounted = false
let epoch = 0 // bumped on every intentional (re)connect; stale async tails bail
let hiddenAt = 0
// The panel is live data over its socket: while it is connecting or waiting // The panel is live data over its socket: while it is connecting, waiting to
// to reconnect, say so (ConnNote) instead of showing a silent stale view. // reconnect or logged out, say so (ConnNote / the login line) instead of
const conn = ref('connecting') // connecting | open | waiting // showing a silent stale view.
const conn = ref('connecting') // connecting | open | waiting | login
const retryIn = ref(0) const retryIn = ref(0)
const connNote = computed(() => const connNote = computed(() =>
conn.value === 'connecting' ? 'connecting to the server…' conn.value === 'connecting' ? 'connecting to the server…'
: conn.value === 'waiting' ? `connection lost — reconnecting in ~${retryIn.value} s…` : conn.value === 'waiting' ? `connection lost — reconnecting in ~${retryIn.value} s…`
: conn.value === 'login' ? 'login required — authenticate to continue…'
: '', : '',
) )
@@ -65,8 +72,8 @@ const hashRange = location.hash.slice(1)
const range = ref(RANGES[hashRange] ? hashRange : 'week') const range = ref(RANGES[hashRange] ? hashRange : 'week')
let rangePinned = Boolean(RANGES[hashRange]) let rangePinned = Boolean(RANGES[hashRange])
function connectAnalytics() { function connect() {
if (ws) return if (ws || !mounted) return
conn.value = 'connecting' conn.value = 'connecting'
const proto = location.protocol === 'https:' ? 'wss:' : 'ws:' const proto = location.protocol === 'https:' ? 'wss:' : 'ws:'
ws = new WebSocket(`${proto}//${location.host}/_api/ws/analytics`) ws = new WebSocket(`${proto}//${location.host}/_api/ws/analytics`)
@@ -79,7 +86,12 @@ function connectAnalytics() {
} }
ws.onmessage = (event) => { ws.onmessage = (event) => {
try { try {
data.value = JSON.parse(event.data) const msg = JSON.parse(event.data)
// Contact-messaging frames (docs/messages.md) carry a type field and
// are for the admin inbox overlay; the type-less snapshot is
// analytics data.
if (msg?.type) return
data.value = msg
if (!rangePinned) { if (!rangePinned) {
rangePinned = true rangePinned = true
const starts = (data.value?.visits || []) const starts = (data.value?.visits || [])
@@ -93,37 +105,147 @@ function connectAnalytics() {
error.value = 'analytics data could not be loaded' error.value = 'analytics data could not be loaded'
} }
} }
ws.onerror = () => { // No error banner from onerror: it is always followed by onclose, which
error.value = 'analytics data could not be loaded' // probes the cause — a lost login gets the login flow, not an error loop.
} ws.onclose = onSocketClose
ws.onclose = () => { }
ws = null
// The policy paces the retry: doubling backoff with jitter, reset only // The socket dropped. Find out why before retrying (./reconnect's
// by a healthy connection — a fixed rapid loop trips the browser's // authReconnect): an expired session fails the handshake exactly like a dead
// WebSocket throttling (all sockets then sit "pending" for minutes). // network, but retrying the socket loops forever — the WS API cannot open
const wait = reconnects.closed() // the login dialog. A lost session runs the paskia login flow and reconnects
retryIn.value = Math.max(1, Math.round(wait / 1000)) // the moment it completes; an aborted login (declined, or a proxy offering
conn.value = 'waiting' // no paskia flow) leaves for the front page — the viewer is useless without
reconnectTimeout = setTimeout(connectAnalytics, wait) // a session; anything else gets the paced backoff.
async function onSocketClose() {
ws = null
if (!mounted) return
const gen = epoch
const wait = reconnects.closed()
const outcome = await authReconnect(() => { conn.value = 'login' })
if (!mounted || gen !== epoch) return
if (outcome === 'auth') {
loadPageTree() // the mount-time fetch may have run anonymous
connectNow()
} else if (outcome === 'abort') {
goHome()
} else {
scheduleRetry(wait)
} }
} }
onMounted(async () => { function scheduleRetry(wait) {
clearTimeout(reconnectTimer)
retryIn.value = Math.max(1, Math.round(wait / 1000))
conn.value = 'waiting'
reconnectTimer = setTimeout(connect, wait)
}
// Leave for the front page, replacing the history entry: Back must not
// return to /_a just to pop the login flow again.
function goHome() {
location.replace('/')
}
// Connect (or recycle) right away, skipping any pending backoff: used after
// login and when the page wakes — a socket that survived sleep still looks
// OPEN but is dead (the server gave up on it while we were asleep), and only
// a fresh connect pushes the full snapshot that catches the view up.
function connectNow() {
epoch++
clearTimeout(reconnectTimer)
reconnectTimer = null
if (ws) {
ws.onclose = null
ws.close()
ws = null
}
connect()
}
// Waking up (sleep, or a long while hidden): recycle the connection rather
// than trust a zombie socket or wait out a stale backoff. A short tab switch
// with a live socket is left alone.
const WAKE_RECYCLE_MS = 30_000
function onVisibility() {
if (document.visibilityState === 'hidden') {
hiddenAt = Date.now()
return
}
now.value = Date.now()
if (!mounted || conn.value === 'login') return
const longAway = hiddenAt && Date.now() - hiddenAt > WAKE_RECYCLE_MS
hiddenAt = 0
if (conn.value !== 'open' || longAway) connectNow()
}
function onOnline() {
if (mounted && conn.value !== 'open' && conn.value !== 'login') connectNow()
}
function onPageShow(ev) {
// A bfcache restore comes back with dead sockets.
if (ev.persisted && mounted) connectNow()
}
// paskia's auth iframe announces its result as a window message: a login
// completed anywhere in the page (the banner's 🔑 button or our own flow —
// 'login' means it is pending and will connect itself on resolve) reconnects
// at once instead of waiting out the backoff timer; a logout leaves for the
// front page — the stream is useless without a session.
function onAuthMessage(ev) {
if (!mounted) return
const type = ev.data?.type
if (type === 'auth-success') {
if (conn.value === 'open' || conn.value === 'login') return
loadPageTree()
connectNow()
} else if (type === 'auth-logout') {
epoch++
clearTimeout(reconnectTimer)
reconnectTimer = null
if (ws) {
ws.onclose = null
ws.close()
ws = null
}
goHome()
}
}
// The site tree for the transition map (all pages in menu order). Not fatal:
// without it the map just narrows to pages seen in transitions. Plain
// fetchJson: the login flow is the socket's business, this fetch never pops
// a dialog.
async function loadPageTree() {
try {
pageTree.value = await fetchJson('/_api/pages')
} catch { /* map just narrows to pages seen in transitions */ }
}
onMounted(() => {
mounted = true
// The first connection takes a staggered slot (see ./reconnect). // The first connection takes a staggered slot (see ./reconnect).
reconnectTimeout = setTimeout(connectAnalytics, socketSlot()) reconnectTimer = setTimeout(connect, socketSlot())
now.value = Date.now() now.value = Date.now()
timeInterval = setInterval(() => { now.value = Date.now() }, 1000) timeInterval = setInterval(() => { now.value = Date.now() }, 1000)
// The site tree for the transition map (all pages in menu order). Not addEventListener('visibilitychange', onVisibility)
// fatal: without it the map just narrows to pages seen in transitions. addEventListener('online', onOnline)
try { addEventListener('pageshow', onPageShow)
pageTree.value = await apiJson('/_api/pages') addEventListener('message', onAuthMessage)
} catch { /* map just narrows to pages seen in transitions */ } loadPageTree()
}) })
onUnmounted(() => { onUnmounted(() => {
if (reconnectTimeout) clearTimeout(reconnectTimeout) mounted = false
if (connectWatchdog) clearTimeout(connectWatchdog) clearTimeout(reconnectTimer)
if (timeInterval) clearInterval(timeInterval) clearTimeout(connectWatchdog)
clearInterval(timeInterval)
removeEventListener('visibilitychange', onVisibility)
removeEventListener('online', onOnline)
removeEventListener('pageshow', onPageShow)
removeEventListener('message', onAuthMessage)
if (ws) { if (ws) {
ws.onclose = null ws.onclose = null
ws.close() ws.close()
@@ -131,7 +253,11 @@ onUnmounted(() => {
} }
}) })
const window = computed(() => rangeWindow(range.value)) // Minute-granular clock for the stats window: the range filters slide with
// time (a page left open must not leave "last 24 hours" frozen at mount)
// without re-filtering every second.
const windowMinute = computed(() => Math.floor(now.value / 60_000) * 60_000)
const window = computed(() => rangeWindow(range.value, windowMinute.value))
// All non-chart stats follow the selected range; the charts keep their own // All non-chart stats follow the selected range; the charts keep their own
// range-specific x windows (week aligned to Monday, overlaid with the // range-specific x windows (week aligned to Monday, overlaid with the
@@ -190,6 +316,7 @@ const abuseRows = computed(() => formatAbuseRows(rangeData.value?.abuse || [], c
<a href="/" class="close" title="home">✕</a> <a href="/" class="close" title="home">✕</a>
</header> </header>
<ConnNote :text="connNote" /> <ConnNote :text="connNote" />
<div>
<p v-if="error" class="error">⚠️ {{ error }}</p> <p v-if="error" class="error">⚠️ {{ error }}</p>
<p v-else-if="!data" class="loading">loading…</p> <p v-else-if="!data" class="loading">loading…</p>
<template v-else> <template v-else>
@@ -328,6 +455,7 @@ const abuseRows = computed(() => formatAbuseRows(rangeData.value?.abuse || [], c
</div> </div>
</section> </section>
</template> </template>
</div>
</div> </div>
</div> </div>
</template> </template>
+114 -22
View File
@@ -11,7 +11,7 @@ import { indentWithTab } from '@codemirror/commands'
import { html } from '@codemirror/lang-html' import { html } from '@codemirror/lang-html'
import { cmHighlight, cmTheme } from './cmtheme' import { cmHighlight, cmTheme } from './cmtheme'
import ConnNote from './ConnNote.vue' import ConnNote from './ConnNote.vue'
import { reconnectPolicy, socketSlot, watchConnecting } from './reconnect' import { authReconnect, reconnectPolicy, socketSlot, watchConnecting } from './reconnect'
import { dropPageCache, loadPlain, runScripts } from './swapdoc' import { dropPageCache, loadPlain, runScripts } from './swapdoc'
import { apiFetch, apiJson } from 'paskia' import { apiFetch, apiJson } from 'paskia'
@@ -34,17 +34,21 @@ let reconnectTimer = null
let connectWatchdog = null let connectWatchdog = null
// Reconnection pacing lives in ./reconnect (shared with the other sockets). // Reconnection pacing lives in ./reconnect (shared with the other sockets).
const reconnects = reconnectPolicy() const reconnects = reconnectPolicy()
// Bumped by every connect()/unmount: the auth probe in onclose is async, so
// a stale tail checks it did not get superseded before acting.
let connectEpoch = 0
let everConnected = false let everConnected = false
// Connection state drives the note at the top (ConnNote), and locks input // Connection state drives the note at the top (ConnNote), and locks input
// until the banner's document has arrived (typing before it would be // until the banner's document has arrived (typing before it would be
// clobbered by the doc accept). // clobbered by the doc accept).
const conn = ref('connecting') // connecting | open | waiting const conn = ref('connecting') // connecting | open | waiting | login
const retryIn = ref(0) const retryIn = ref(0)
const docReady = ref(false) const docReady = ref(false)
const editable = new Compartment() const editable = new Compartment()
const connNote = computed(() => const connNote = computed(() =>
conn.value === 'connecting' ? 'connecting to the server…' conn.value === 'connecting' ? 'connecting to the server…'
: conn.value === 'waiting' ? `connection lost — reconnecting in ~${retryIn.value} s…` : conn.value === 'waiting' ? `connection lost — reconnecting in ~${retryIn.value} s…`
: conn.value === 'login' ? 'session expired — log in to continue editing…'
: docReady.value ? '' : 'loading the banner…', : docReady.value ? '' : 'loading the banner…',
) )
let view = null // CodeMirror for the banner HTML let view = null // CodeMirror for the banner HTML
@@ -67,42 +71,57 @@ const bannerDesignInherited = ref('')
let refreshOnSave = null let refreshOnSave = null
// --- Card image (Node.image, '' = inherit, like the banner design) ------ // --- Card image (Node.image, '' = inherit, like the banner design) ------
// The node's own setting, the effective image after inheritance ("" = // The node's own setting ('@favicon' = the site icon, resolved live
// none) and which node supplied an inherited one ("" = the front page, // against the favicon ref), the effective image after inheritance ("" =
// "" also when own/none — mirrors bannerFrom). // none, already resolved server-side) and which node supplied an
// inherited one ("" = the front page, "" also when own/none — mirrors
// bannerFrom).
const image = ref('') const image = ref('')
const imageResolved = ref('') const imageResolved = ref('')
const imageSource = ref('') const imageSource = ref('')
// The site icon (bare store hash, "" = none): the "@favicon" own setting
// resolves against it, live, in the previews.
const favicon = ref('')
// The image the server would mine from the article itself — the card // The image the server would mine from the article itself — the card
// previews fall back to it when no node image resolves (mirrors og:image). // previews fall back to it when the node has no image of its own, and it
// beats an inherited one (mirrors og:image).
const imageMined = ref('') const imageMined = ref('')
// Whether the page has children (from the doc message): an own share // Whether the page has children (from the doc message): an own share
// image is inherited by the whole section. // image is inherited by the whole section.
const hasChildren = ref(false) const hasChildren = ref(false)
// The block label states which image is currently in use. // The block label states which image is currently in use.
const imageLabel = computed(() => { const imageLabel = computed(() => {
if (image.value === '@favicon') {
return 'card image: the site icon (follows favicon changes)'
}
if (image.value) { if (image.value) {
return hasChildren.value return hasChildren.value
? `card image: set for this article — used in /${path.value}/*` ? `card image: set for this article — used in /${path.value}/*`
: 'card image: set for this article' : 'card image: set for this article'
} }
if (imageMined.value) return 'card image: from the article'
if (imageResolved.value) { if (imageResolved.value) {
const where = imageSource.value === '' ? 'the front page' : `/${imageSource.value}` const where = imageSource.value === '' ? 'the front page' : `/${imageSource.value}`
return `card image: inherited from ${where}` return `card image: inherited from ${where}`
} }
if (imageMined.value) return 'card image: from the article'
return 'card image: none' return 'card image: none'
}) })
// The page title and description (from the doc message) feed the mock card // The page title and description (from the doc message) feed the mock card
// previews; empty shows placeholder bars / text instead. // previews; empty shows placeholder bars / text instead.
const pageTitle = ref('') const pageTitle = ref('')
const pageDesc = ref('') const pageDesc = ref('')
// The image the Twitter cards preview with: the resolved node card image, // The image the Twitter cards preview with: the node's own card image
// else the mined article image (what og:image would use). image_resolved is // ("@favicon" resolves to the site icon), else the mined article image,
// a bare store hash; image_mined is already a src path. // else the inherited node image (what og:image would use).
const cardImage = computed(() => // image/image_resolved are bare store hashes; image_mined is already a
imageResolved.value ? `/_f/${imageResolved.value}` : imageMined.value, // src path.
) const cardImage = computed(() => {
// "@favicon" with no site icon configured falls through like no own
// image at all (mirrors the backend's resolution).
const own = image.value === '@favicon' ? favicon.value : image.value
if (own) return `/_f/${own}`
return imageMined.value || (imageResolved.value ? `/_f/${imageResolved.value}` : '')
})
// Card-mode override (Node.large, per-article, NOT inherited): // Card-mode override (Node.large, per-article, NOT inherited):
// null = automatic, false = small, true = large. // null = automatic, false = small, true = large.
const large = ref(null) const large = ref(null)
@@ -144,13 +163,39 @@ async function uploadCardImage(ev) {
const file = ev.target.files[0] const file = ev.target.files[0]
ev.target.value = '' // allow re-picking the same file ev.target.value = '' // allow re-picking the same file
if (!file || !file.type.startsWith('image/')) return if (!file || !file.type.startsWith('image/')) return
const name = file.name.replace(/[^\w.-]/g, '-') storeCardImage(file, file.name)
const res = await apiFetch(`/_api/files/${encodeURIComponent(name)}`, { method: 'PUT', body: file }) }
async function storeCardImage(blob, filename) {
const name = filename.replace(/[^\w.-]/g, '-')
const res = await apiFetch(`/_api/files/${encodeURIComponent(name)}`, { method: 'PUT', body: blob })
if (!res.ok) return if (!res.ok) return
const { path: stored } = await res.json() // "/_f/<hash>[.ext]" const { path: stored } = await res.json() // "/_f/<hash>[.ext]"
saveImage(stored.split('/').pop().split('.')[0]) saveImage(stored.split('/').pop().split('.')[0])
} }
async function pasteCardImage() {
// The pasteboard button (unlike pasting into a text editor, where the
// paste event carries files) must read the clipboard explicitly.
try {
for (const item of await navigator.clipboard.read()) {
const type = item.types.find((t) => t.startsWith('image/'))
if (type) {
const blob = await item.getType(type)
await storeCardImage(blob, `paste.${type.split('/')[1].replace('+xml', '')}`)
return
}
}
// No image on the pasteboard: a pasted URL goes as the setting
// itself — the server fetches and stores it (cross-origin URLs are
// CORS-blocked for the browser).
const text = (await navigator.clipboard.readText()).trim()
if (/^https?:\/\/\S+$/.test(text)) saveImage(text)
} catch {
// Clipboard read denied or empty: nothing to do.
}
}
// The inherit option names the design actually in effect and its source. // The inherit option names the design actually in effect and its source.
const inheritLabel = computed(() => { const inheritLabel = computed(() => {
if (bannerDesignFrom.value === null) { if (bannerDesignFrom.value === null) {
@@ -326,6 +371,7 @@ function onMessage(ev) {
imageResolved.value = msg.image_resolved ?? '' imageResolved.value = msg.image_resolved ?? ''
imageMined.value = msg.image_mined ?? '' imageMined.value = msg.image_mined ?? ''
imageSource.value = msg.image_source ?? '' imageSource.value = msg.image_source ?? ''
favicon.value = msg.favicon ?? ''
hasChildren.value = msg.has_children ?? false hasChildren.value = msg.has_children ?? false
large.value = msg.large ?? null large.value = msg.large ?? null
pageTitle.value = msg.title ?? '' pageTitle.value = msg.title ?? ''
@@ -351,6 +397,7 @@ function onKeydown(ev) {
} }
function connect() { function connect() {
connectEpoch++
clearTimeout(reconnectTimer) clearTimeout(reconnectTimer)
conn.value = 'connecting' conn.value = 'connecting'
if (ws) { if (ws) {
@@ -374,17 +421,38 @@ function connect() {
} }
everConnected = true everConnected = true
} }
ws.onclose = () => { ws.onclose = async () => {
// The wait is the policy's: doubling backoff with jitter (./reconnect), // An expired session fails the handshake like a dead network, but blind
// reset only by a healthy connection — rapid retries trip the browser's // retries loop forever — the WS API cannot open the login dialog. Probe
// WebSocket throttling (sockets stuck "pending" for minutes). // /_api (./reconnect's authReconnect): a lost session runs the paskia
// login flow and reconnects the moment it completes; a declined login
// holds at the 'login' note (a later login anywhere in the page, or a
// save attempt, reconnects); only transient failures take the paced
// backoff (./reconnect), reset only by a healthy connection — rapid
// retries trip the browser's WebSocket throttling.
const gen = connectEpoch
const wait = reconnects.closed() const wait = reconnects.closed()
retryIn.value = Math.max(1, Math.round(wait / 1000)) const outcome = await authReconnect(() => { conn.value = 'login' })
conn.value = 'waiting' if (gen !== connectEpoch) return
reconnectTimer = setTimeout(connect, wait) if (outcome === 'auth') {
connect()
} else if (outcome === 'abort') {
conn.value = 'login'
} else {
retryIn.value = Math.max(1, Math.round(wait / 1000))
conn.value = 'waiting'
reconnectTimer = setTimeout(connect, wait)
}
} }
} }
// A login completed anywhere in the page (the banner's 🔑 button, another
// panel's flow) reconnects a waiting editor at once instead of waiting out
// the backoff. paskia's auth iframe announces it as a window message.
function onAuthMessage(ev) {
if (ev.data?.type === 'auth-success' && conn.value !== 'open') connect()
}
onMounted(async () => { onMounted(async () => {
// The first connection takes a staggered slot (see ./reconnect). // The first connection takes a staggered slot (see ./reconnect).
reconnectTimer = setTimeout(connect, socketSlot()) reconnectTimer = setTimeout(connect, socketSlot())
@@ -413,10 +481,12 @@ onMounted(async () => {
}) })
addEventListener('keydown', onKeydown) addEventListener('keydown', onKeydown)
addEventListener('pagerite:editor-shown', onEditorShown) addEventListener('pagerite:editor-shown', onEditorShown)
addEventListener('message', onAuthMessage)
await loadSettings() await loadSettings()
}) })
onUnmounted(() => { onUnmounted(() => {
connectEpoch++ // invalidate a pending onclose auth probe
clearTimeout(reconnectTimer) clearTimeout(reconnectTimer)
clearTimeout(connectWatchdog) clearTimeout(connectWatchdog)
for (const t of Object.values(timers)) clearTimeout(t) for (const t of Object.values(timers)) clearTimeout(t)
@@ -427,6 +497,7 @@ onUnmounted(() => {
view?.destroy() view?.destroy()
removeEventListener('keydown', onKeydown) removeEventListener('keydown', onKeydown)
removeEventListener('pagerite:editor-shown', onEditorShown) removeEventListener('pagerite:editor-shown', onEditorShown)
removeEventListener('message', onAuthMessage)
}) })
</script> </script>
@@ -451,6 +522,19 @@ onUnmounted(() => {
title="upload card image (og:image / card covers) — the subtree inherits it" title="upload card image (og:image / card covers) — the subtree inherits it"
@click="imageInput.click()" @click="imageInput.click()"
>🖼︎</button> >🖼︎</button>
<button
type="button"
class="icon-btn"
title="paste a card image from the pasteboard (image or image URL)"
@click="pasteCardImage"
>📋</button>
<button
v-if="favicon"
type="button"
class="icon-btn favicon-btn"
title="use the site icon as the card image — follows favicon changes"
@click="saveImage('@favicon')"
><img :src="`/_f/${favicon}`" alt="site icon" /></button>
<input <input
ref="imageInput" ref="imageInput"
type="file" type="file"
@@ -611,6 +695,14 @@ onUnmounted(() => {
font-size: 1rem; font-size: 1rem;
} }
/* The "use site icon" button shows the icon itself. */
.favicon-btn img {
display: block;
width: 1rem;
height: 1rem;
object-fit: contain;
}
/* The first icon button pushes itself (and any siblings after it, like /* The first icon button pushes itself (and any siblings after it, like
the card-image clear button) to the end of the row. */ the card-image clear button) to the end of the row. */
.block-head .icon-btn:first-of-type { .block-head .icon-btn:first-of-type {
+266
View File
@@ -0,0 +1,266 @@
<script setup>
// The message composer shared by the visitor contact panel and the admin
// inbox: a constrained contenteditable (plain-text paste, toolbar-driven
// formatting, upload chips) serialized to the Markdown subset on send
// (./richtext.js). The server re-renders that with its strict parser —
// what shows in threads is never this DOM.
import { onMounted, ref } from 'vue'
import { apiFetch } from 'paskia'
import { serializeRich } from './richtext.js'
const props = defineProps({
// The visitor side passes nothing: language-neutral glyph (admin
// instances pass their own English placeholders).
placeholder: { type: String, default: '✏️' },
// Visitor session token for the public upload endpoint; empty = admin,
// whose uploads go to the /_api file store instead.
token: { type: String, default: '' },
autofocus: { type: Boolean, default: false },
// When true, send (button and Ctrl+Enter) is inert and the draft is
// kept — e.g. the contact panel's first-message name/email fields are
// still empty.
sendDisabled: { type: Boolean, default: false },
// Visitor side: an upload hit the end of the PoW quota (429 "pow") —
// re-prove and resolve, then the upload retries once.
reauthorize: { type: Function, default: null },
})
const emit = defineEmits(['send'])
const box = ref(null)
const imageInput = ref(null)
const fileInput = ref(null)
const uploading = ref(0)
const error = ref('')
let errorTimer = null
function showError(text) {
error.value = text
clearTimeout(errorTimer)
errorTimer = setTimeout(() => { error.value = '' }, 6000)
}
onMounted(() => {
if (props.autofocus) box.value?.focus()
})
function cmd(name, value = null) {
box.value?.focus()
document.execCommand(name, false, value)
}
function link() {
const url = window.prompt('URL', 'https://')
if (url && /^(https?:\/\/|mailto:)/.test(url)) cmd('createLink', url)
}
const escHtml = (s) =>
s.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;')
// Paste is plain text only — the grammar (bold, links, chips…) comes from
// the toolbar and uploads, never from foreign HTML.
function onPaste(ev) {
ev.preventDefault()
if (ev.clipboardData?.files?.length) {
uploadFiles(ev.clipboardData.files)
return
}
const text = ev.clipboardData?.getData('text/plain') || ''
if (!text) return
const html = text
.split(/\n{2,}/)
.map((p) => `<div>${p.split(/\r\n|\r|\n/).map(escHtml).join('<br>')}</div>`)
.join('')
document.execCommand('insertHTML', false, html)
}
function onDrop(ev) {
if (ev.dataTransfer?.files?.length) {
ev.preventDefault()
uploadFiles(ev.dataTransfer.files)
}
}
async function uploadFiles(files) {
for (const file of files) {
if (file.size > 20 * 1024 * 1024) {
// Visitor-facing chrome is language-neutral: details go to the
// console, the panel just flags the file.
console.error(`contact upload: "${file.name}" is over 20 MB`)
showError(`⚠️ ${file.name}`)
continue
}
uploading.value++
try {
const path = `/_${props.token ? 'contact' : 'api'}/files/${encodeURIComponent(file.name)}`
const init = { method: 'PUT', body: file }
if (props.token) init.headers = { 'x-contact-token': props.token }
const put = () => (props.token ? fetch(path, init) : apiFetch(path, init))
let r = await put()
if (!r.ok && r.status === 429 && props.reauthorize) {
// The PoW quota (shared with messages) ran out: re-prove, retry once.
const detail = await r.json().then((d) => d?.detail, () => null)
if (detail === 'pow' && (await props.reauthorize())) r = await put()
}
if (!r.ok) {
const detail = await r.json().then((d) => d?.detail, () => null)
throw new Error(detail || `status ${r.status}`)
}
insertUpload(await r.json())
} catch (e) {
console.error('contact upload failed:', e)
showError(`⚠️ ${file.name}`)
} finally {
uploading.value--
}
}
}
// An uploaded file becomes an inline image or an attachment chip; both
// serialize back to /_f/ Markdown references on send.
function insertUpload({ path, image, name }) {
const html = image
? `<img class="contact-img" src="${escHtml(path)}" data-path="${escHtml(path)}" alt="${escHtml(name)}">`
: `<span class="contact-file" contenteditable="false" data-path="${escHtml(path)}" data-name="${escHtml(name)}">📎 ${escHtml(name)}</span>&nbsp;`
box.value?.focus()
document.execCommand('insertHTML', false, html)
}
function send() {
const md = serializeRich(box.value)
if (!md || uploading.value || props.sendDisabled) return
emit('send', md)
box.value.innerHTML = ''
}
function onKeydown(ev) {
if ((ev.ctrlKey || ev.metaKey) && ev.key === 'Enter') send()
}
defineExpose({ focus: () => box.value?.focus() })
</script>
<template>
<div class="composer">
<div
ref="box"
class="composer-box"
contenteditable="true"
:data-placeholder="placeholder"
role="textbox"
aria-multiline="true"
@paste="onPaste"
@drop="onDrop"
@keydown="onKeydown"
></div>
<div class="composer-bar">
<button type="button" @mousedown.prevent @click="cmd('bold')"><b>B</b></button>
<button type="button" @mousedown.prevent @click="cmd('italic')"><i>I</i></button>
<button type="button" @mousedown.prevent @click="link">🔗</button>
<button type="button" @mousedown.prevent @click="cmd('insertUnorderedList')">≡</button>
<button type="button" @mousedown.prevent @click="imageInput.click()">🖼</button>
<button type="button" @mousedown.prevent @click="fileInput.click()">📎</button>
<span v-if="uploading" class="uploading">⏳</span>
<button type="button" class="send" :disabled="sendDisabled" @mousedown.prevent @click="send">➤</button>
</div>
<p v-if="error" class="composer-error">{{ error }}</p>
<input
ref="imageInput"
type="file"
accept="image/*"
multiple
hidden
@change="uploadFiles($event.target.files); $event.target.value = ''"
>
<input
ref="fileInput"
type="file"
multiple
hidden
@change="uploadFiles($event.target.files); $event.target.value = ''"
>
</div>
</template>
<style scoped>
.composer {
border: 1px solid var(--line);
border-radius: 0.5rem;
background: var(--bg, Canvas);
}
.composer:focus-within {
border-color: var(--accent);
}
.composer-box {
min-height: 3.2rem;
max-height: 30vh;
overflow-y: auto;
padding: 0.5rem 0.7rem;
outline: none;
font: inherit;
overflow-wrap: break-word;
}
.composer-box:empty::before {
content: attr(data-placeholder);
color: var(--muted);
pointer-events: none;
}
.composer-box :deep(img.contact-img) {
display: block;
max-width: 100%;
max-height: 10rem;
margin: 0.2rem 0;
border-radius: 0.3rem;
}
.composer-box :deep(.contact-file) {
display: inline-block;
padding: 0.05em 0.5em;
border: 1px solid var(--line);
border-radius: 1em;
background: color-mix(var(--muted) 10%, transparent);
font-size: 0.9em;
white-space: nowrap;
}
.composer-bar {
display: flex;
align-items: center;
gap: 0.15rem;
padding: 0.2rem 0.3rem;
border-top: 1px solid var(--line);
}
.composer-bar button {
min-width: 1.7rem;
padding: 0.15rem 0.3rem;
border: none;
border-radius: 0.3rem;
background: none;
color: var(--text, CanvasText);
font: inherit;
cursor: pointer;
}
.composer-bar button:hover {
background: color-mix(var(--muted) 15%, transparent);
}
.composer-bar button:disabled {
opacity: 0.4;
cursor: default;
background: none;
}
.composer-bar .uploading {
margin-left: 0.4rem;
color: var(--muted);
font-size: 0.85em;
}
.composer-bar .send {
margin-left: auto;
color: var(--accent);
}
.composer-error {
margin: 0;
padding: 0.2rem 0.7rem 0.35rem;
color: #b3261e;
font-size: 0.85em;
}
</style>
+181
View File
@@ -0,0 +1,181 @@
<script setup>
// The messaging overlay shell (docs/messages.md): one centered dialog over
// paskia's shared blur backdrop, on any page. The mode decides the content:
// 'visitor' shows the visitor's own thread (ContactPanel — what the
// {contact:} trigger buttons open, for admins too), 'admin' the contact
// inbox (MessagesView — what the corner ✉️ icon opens for admins).
// contact-main holds the backdrop while state.open and owns the store.
import { computed, onMounted, onUnmounted, ref } from 'vue'
import ContactPanel from './ContactPanel.vue'
import MessagesView from './MessagesView.vue'
const props = defineProps({
state: { type: Object, required: true },
// Visitor-side PoW quota re-grant for the composer's upload retries.
reauthorize: { type: Function, default: null },
})
const emit = defineEmits(['send', 'close', 'close-thread'])
const admin = computed(() => props.state.mode === 'admin')
// The visitor dialog's title is the localized site contact label (the
// {contact:} buttons' default label). The mailto href carries the
// server-encoded "Brand <email>" recipient and the localized subject;
// the link text is the bare address.
const mailto = computed(
() => `mailto:${props.state.mailtoTo}?subject=${encodeURIComponent(props.state.subject)}`
)
// Escape closes, like the paskia dialogs whose backdrop we share.
function onKey(ev) {
if (ev.key === 'Escape' && props.state.open) emit('close')
}
onMounted(() => addEventListener('keydown', onKey))
onUnmounted(() => removeEventListener('keydown', onKey))
// The close-conversation ⟲ button is two-tap armed (the visitor UI has
// no hardcoded language, so no text confirm): the first tap arms it for
// a few seconds, the second fires.
const armingClose = ref(false)
let armTimer = null
function onCloseThread() {
if (!armingClose.value) {
armingClose.value = true
clearTimeout(armTimer)
armTimer = setTimeout(() => { armingClose.value = false }, 3000)
return
}
clearTimeout(armTimer)
armingClose.value = false
emit('close-thread')
}
</script>
<template>
<div v-if="state.open" class="contact-overlay" @click.self="emit('close')">
<section
class="contact-panel"
:class="{ admin }"
role="dialog"
:aria-label="admin ? 'Messages' : state.label"
>
<header>
<h2>{{ admin ? 'Messages' : state.label }}</h2>
<a v-if="!admin && state.email" class="mailto" :href="mailto">{{ state.email }}</a>
<button
v-if="!admin && state.thread?.messages?.length"
type="button"
class="close-thread"
:class="{ armed: armingClose }"
@click="onCloseThread"
>{{ armingClose ? '❗' : '⟲' }}</button>
<button type="button" class="close" @click="emit('close')">✕</button>
</header>
<ContactPanel
v-if="!admin"
:state="state"
:token="state.token"
:reauthorize="reauthorize"
@send="(p) => emit('send', p)"
/>
<MessagesView v-else :state="state" />
</section>
</div>
</template>
<style scoped>
.contact-overlay {
position: fixed;
inset: 0;
/* Above paskia's shared blur backdrop (1099, held by contact-main while
open), below the authentication iframe (9999). Transparent: the blur
is the backdrop's job, this layer only centers the panel and catches
outside clicks (the backdrop itself is pointer-events: none). */
z-index: 1100;
display: flex;
align-items: center;
justify-content: center;
}
.contact-panel {
display: flex;
flex-direction: column;
/* Same dimensions as paskia's own dialog. */
width: min(36rem, 100%);
height: min(42rem, 92vh);
padding: 0.8rem;
gap: 0.6rem;
background: var(--bg, Canvas);
color: var(--text, CanvasText);
border: 1px solid var(--line);
border-radius: 0.5rem;
box-shadow: 0 0.5rem 2rem rgb(0 0 0 / 0.3);
}
/* The admin inbox adds the thread-list sidebar: a wider dialog. */
.contact-panel.admin {
width: min(54rem, 100%);
}
.contact-panel header {
display: flex;
align-items: center;
gap: 0.6rem;
}
.contact-panel h2 {
margin: 0;
font-size: 1.1rem;
}
.contact-panel .mailto {
color: var(--muted);
font-size: 0.85rem;
text-decoration: none;
overflow: hidden;
text-overflow: ellipsis;
white-space: nowrap;
}
.contact-panel .mailto:hover {
color: var(--text, CanvasText);
text-decoration: underline;
}
.contact-panel .close {
margin-left: auto;
}
.contact-panel .close,
.contact-panel .close-thread {
padding: 0 0.3rem;
border: none;
background: none;
color: var(--muted);
font-size: 1.2rem;
cursor: pointer;
}
.contact-panel .close:hover,
.contact-panel .close-thread:hover {
color: var(--text, CanvasText);
}
.contact-panel .close-thread.armed {
color: var(--accent);
}
/* Mobile: full screen (the admin layout's own sidebar stacking kicks in
at the same width). */
@media (max-width: 36rem) {
.contact-panel {
width: 100%;
height: 100%;
border: none;
border-radius: 0;
box-shadow: none;
}
}
@media (max-width: 48rem) {
.contact-panel.admin {
width: 100%;
height: 100%;
border: none;
border-radius: 0;
box-shadow: none;
}
}
</style>
+180
View File
@@ -0,0 +1,180 @@
<script setup>
// The visitor's contact thread: messages pushed live over the activity
// socket (via the bridge pagerite.js hands to contact-main), with the
// composer shared with the admin inbox. state is contact-main's reactive
// store ({open, mode, thread, unread, ...}). The overlay shell (backdrop,
// dialog frame, close) is ContactOverlay.vue.
import { computed, nextTick, onMounted, reactive, ref, watch } from 'vue'
import { formatWhen } from './analytics/format.js'
import Composer from './Composer.vue'
const props = defineProps({
state: { type: Object, required: true },
token: { type: String, required: true },
// Re-grant the PoW quota (an upload hit its end): resolves once the
// fresh proof is accepted, so the upload can retry.
reauthorize: { type: Function, default: null },
})
const emit = defineEmits(['send'])
const scroll = ref(null)
async function scrollDown() {
await nextTick()
if (scroll.value) scroll.value.scrollTop = scroll.value.scrollHeight
}
// Scroll to the newest message: on mount (the overlay is v-if'd, so every
// open is a fresh mount) and whenever the message count changes — sent or
// received, both arrive as server-pushed thread updates.
watch(() => props.state.thread?.messages?.length, scrollDown)
onMounted(scrollDown)
// Relative timestamps like in analytics.
const fmtTime = (t) => formatWhen(t)
const NAME_KEY = 'pagerite-contact-name'
const EMAIL_KEY = 'pagerite-contact-email'
// Name (and optionally email) are asked with the first message; from
// then on the thread's stored identity labels the visitor's messages.
const intro = reactive({
name: localStorage.getItem(NAME_KEY) || '',
email: localStorage.getItem(EMAIL_KEY) || '',
})
const showIntro = computed(() => !props.state.thread?.name)
// Sending stays disabled until the name field is filled.
const introInvalid = computed(() => showIntro.value && !intro.name.trim())
function onSend(md) {
if (showIntro.value) {
const name = intro.name.trim()
const email = intro.email.trim()
localStorage.setItem(NAME_KEY, name)
localStorage.setItem(EMAIL_KEY, email)
emit('send', { md, name, email })
return
}
emit('send', { md })
}
</script>
<template>
<div ref="scroll" class="contact-messages">
<p v-if="!state.thread || !state.thread.messages.length" class="contact-empty">✉️</p>
<div
v-for="m in state.thread?.messages || []"
:key="m.id"
class="contact-msg"
:class="{ mine: !m.admin }"
>
<!-- m.html is the server's strict-markdown rendering of the
message source (pagerite/messages.py, html=False): markdown-it
output only, never user markup. -->
<header>
<span class="who">{{ m.admin || state.thread?.name || '👤' }}</span>
<time>{{ fmtTime(m.t) }}</time>
</header>
<div class="contact-msg-body" v-html="m.html"></div>
</div>
</div>
<div v-if="showIntro" class="contact-intro">
<label><span aria-hidden="true">👤</span><input v-model="intro.name" type="text" maxlength="100"></label>
<label><span aria-hidden="true">📧</span><input v-model="intro.email" type="email" maxlength="200"></label>
</div>
<Composer
:token="token"
:send-disabled="introInvalid"
:reauthorize="reauthorize"
autofocus
@send="onSend"
/>
</template>
<style scoped>
.contact-messages {
flex: 1;
min-height: 0;
overflow-y: auto;
padding-right: 0.2rem;
}
.contact-empty {
color: var(--muted);
text-align: center;
margin-top: 2rem;
font-size: 2rem;
opacity: 0.5;
}
.contact-msg {
padding: 0.55rem 0;
}
.contact-msg + .contact-msg {
border-top: 1px solid var(--line);
}
.contact-msg-body {
overflow-wrap: break-word;
}
.contact-msg-body :deep(p) {
margin: 0.25em 0;
}
.contact-msg-body :deep(img) {
max-width: 100%;
border-radius: 0.3rem;
}
.contact-msg-body :deep(a.attachment) {
display: inline-block;
padding: 0.05em 0.5em;
border: 1px solid var(--line);
border-radius: 1em;
background: var(--bg, Canvas);
text-decoration: none;
white-space: nowrap;
}
.contact-msg header {
display: flex;
gap: 0.5rem;
align-items: baseline;
color: var(--muted);
font-size: 0.75rem;
}
.contact-msg.mine header {
justify-content: flex-end;
}
.contact-msg header .who {
font-weight: 600;
color: var(--text, CanvasText);
}
.contact-intro {
display: flex;
flex-wrap: wrap;
gap: 0.4rem;
}
.contact-intro label {
flex: 1;
min-width: 8rem;
display: flex;
align-items: center;
gap: 0.35rem;
padding-left: 0.5rem;
border: 1px solid var(--line);
border-radius: 0.3rem;
}
.contact-intro input {
flex: 1;
min-width: 0;
padding: 0.3rem 0.5rem 0.3rem 0;
border: none;
background: none;
color: var(--text, CanvasText);
font: inherit;
font-size: 0.9rem;
}
.contact-intro label:focus-within {
border-color: var(--accent);
}
.contact-intro input:focus {
outline: none;
}
</style>
+495
View File
@@ -0,0 +1,495 @@
<script setup>
// The admin contact inbox, mounted inside the messaging overlay
// (ContactOverlay.vue) when an admin opens the corner ✉️ icon. Owns its
// connection to the admin-gated /_api/ws/analytics socket (the same
// endpoint the analytics viewer uses) for exactly as long as the overlay
// is open: frames carrying a `type` field are messaging payloads
// (threads/thread/contact-error), the type-less analytics snapshot is
// ignored. Replies and read-markings go back down the same socket
// (docs/messages.md). Message HTML is the server's strict-markdown
// rendering — injected verbatim, never user markup (pagerite/messages.py).
import { computed, nextTick, onMounted, onUnmounted, ref, watch } from 'vue'
import { formatWhen } from './analytics/format.js'
import Composer from './Composer.vue'
import ConnNote from './ConnNote.vue'
import { authReconnect, reconnectPolicy, socketSlot, watchConnecting } from './reconnect'
import { askNotifyPermission, messageText, notifyMessage } from './notify.js'
// The shared store (contact-main): adminUnread mirrors the inbox's unread
// count onto the corner icon's badge.
const props = defineProps({
state: { type: Object, required: true },
})
const threads = ref([])
const selected = ref('')
const scroll = ref(null)
let ws = null
let reconnectTimer = null
let connectWatchdog = null
const reconnects = reconnectPolicy()
let mounted = false
let epoch = 0 // bumped on every intentional (re)connect; stale async tails bail
let hiddenAt = 0
// 'threads' full-state pushes are the baseline, history never notifies.
const seenLastMsg = new Map()
// The inbox is live data over its socket: while it is connecting, waiting
// to reconnect or logged out, say so (ConnNote) instead of showing a
// silent stale view.
const conn = ref('connecting') // connecting | open | waiting | login
const retryIn = ref(0)
const connNote = computed(() =>
conn.value === 'connecting' ? 'connecting to the server…'
: conn.value === 'waiting' ? `connection lost — reconnecting in ~${retryIn.value} s…`
: conn.value === 'login' ? 'login required — authenticate to continue…'
: '',
)
const unreadTotal = computed(() => threads.value.reduce((n, t) => n + (t.unread && !t.closed ? 1 : 0), 0))
watch(unreadTotal, (n) => { props.state.adminUnread = n }, { immediate: true })
function lastT(t) {
return t.messages.length ? t.messages[t.messages.length - 1].t : t.created
}
function upsertThread(thread) {
const rest = threads.value.filter((t) => t.id !== thread.id)
// Most recently active first, visitor-closed (archived) threads last.
threads.value = [thread, ...rest].sort(
(a, b) => (a.closed - b.closed) || lastT(b).localeCompare(lastT(a))
)
}
function notifyThread(t) {
const last = t.messages[t.messages.length - 1]
const prev = seenLastMsg.get(t.id)
seenLastMsg.set(t.id, last?.id || '')
// prev undefined = a brand-new thread, which should notify. Not when the
// thread is already on screen.
if (!last || last.admin || prev === last.id || t.id === selected.value) return
notifyMessage(`New message from ${t.name || 'a visitor'}`, messageText(last.html), () => {
selected.value = t.id
})
}
function wsSend(obj) {
if (ws?.readyState === WebSocket.OPEN) ws.send(JSON.stringify(obj))
}
function connect() {
if (ws || !mounted) return
conn.value = 'connecting'
const proto = location.protocol === 'https:' ? 'wss:' : 'ws:'
ws = new WebSocket(`${proto}//${location.host}/_api/ws/analytics`)
clearTimeout(connectWatchdog)
connectWatchdog = watchConnecting(ws, 'messages')
ws.onopen = () => {
conn.value = 'open'
reconnects.opened()
}
ws.onmessage = (event) => {
let msg = null
try {
msg = JSON.parse(event.data)
} catch {
return
}
// The type-less snapshot is analytics data, not for this view.
if (msg?.type === 'threads') {
threads.value = msg.threads
for (const t of msg.threads) seenLastMsg.set(t.id, lastMsg(t)?.id || '')
} else if (msg?.type === 'thread') {
notifyThread(msg)
upsertThread(msg)
} else if (msg?.type === 'contact-error') {
console.warn('contact:', msg.detail)
}
}
// No error banner from onerror: it is always followed by onclose, which
// probes the cause — a lost login gets the login flow, not an error loop.
ws.onclose = onSocketClose
}
// The socket dropped. Find out why before retrying (./reconnect's
// authReconnect): an expired session fails the handshake exactly like a
// dead network, but retrying the socket loops forever — the WS API cannot
// open the login dialog. A lost session runs the paskia login flow and
// reconnects the moment it completes; an aborted login (declined, or a
// proxy offering no paskia flow) closes the inbox; anything else gets the
// paced backoff.
async function onSocketClose() {
ws = null
if (!mounted) return
const gen = epoch
const wait = reconnects.closed()
const outcome = await authReconnect(() => { conn.value = 'login' })
if (!mounted || gen !== epoch) return
if (outcome === 'auth') {
connectNow()
} else if (outcome === 'abort') {
props.state.open = false
} else {
scheduleRetry(wait)
}
}
function scheduleRetry(wait) {
clearTimeout(reconnectTimer)
retryIn.value = Math.max(1, Math.round(wait / 1000))
conn.value = 'waiting'
reconnectTimer = setTimeout(connect, wait)
}
// Connect (or recycle) right away, skipping any pending backoff: used after
// login and when the page wakes — a socket that survived sleep still looks
// OPEN but is dead (the server gave up on it while we were asleep), and
// only a fresh connect pushes the full inbox that catches the view up.
function connectNow() {
epoch++
clearTimeout(reconnectTimer)
reconnectTimer = null
if (ws) {
ws.onclose = null
ws.close()
ws = null
}
connect()
}
// Waking up (sleep, or a long while hidden): recycle the connection rather
// than trust a zombie socket or wait out a stale backoff. A short tab
// switch with a live socket is left alone.
const WAKE_RECYCLE_MS = 30_000
function onVisibility() {
if (document.visibilityState === 'hidden') {
hiddenAt = Date.now()
return
}
if (!mounted || conn.value === 'login') return
const longAway = hiddenAt && Date.now() - hiddenAt > WAKE_RECYCLE_MS
hiddenAt = 0
if (conn.value !== 'open' || longAway) connectNow()
}
function onOnline() {
if (mounted && conn.value !== 'open' && conn.value !== 'login') connectNow()
}
function onPageShow(ev) {
// A bfcache restore comes back with dead sockets.
if (ev.persisted && mounted) connectNow()
}
// paskia's auth iframe announces its result as a window message: a login
// completed anywhere in the page reconnects at once instead of waiting out
// the backoff timer; a logout closes the inbox — it is useless without a
// session.
function onAuthMessage(ev) {
if (!mounted) return
const type = ev.data?.type
if (type === 'auth-success') {
if (conn.value === 'open' || conn.value === 'login') return
connectNow()
} else if (type === 'auth-logout') {
epoch++
clearTimeout(reconnectTimer)
reconnectTimer = null
if (ws) {
ws.onclose = null
ws.close()
ws = null
}
props.state.open = false
}
}
onMounted(() => {
mounted = true
// The first connection takes a staggered slot (see ./reconnect).
reconnectTimer = setTimeout(connect, socketSlot())
addEventListener('visibilitychange', onVisibility)
addEventListener('online', onOnline)
addEventListener('pageshow', onPageShow)
addEventListener('message', onAuthMessage)
})
onUnmounted(() => {
mounted = false
clearTimeout(reconnectTimer)
clearTimeout(connectWatchdog)
removeEventListener('visibilitychange', onVisibility)
removeEventListener('online', onOnline)
removeEventListener('pageshow', onPageShow)
removeEventListener('message', onAuthMessage)
if (ws) {
ws.onclose = null
ws.close()
ws = null
}
})
const thread = computed(() => threads.value.find((t) => t.id === selected.value) || null)
// Auto-open the first thread once the list arrives.
watch(
() => threads.value.length,
(n) => {
if (n && !selected.value) selected.value = threads.value[0].id
},
{ immediate: true },
)
// Opening a thread marks it read on the server (the updated payload
// comes back around and clears the dot).
watch(thread, (t) => {
if (!t) return
if (t.unread) wsSend({ type: 'read', id: t.id })
scrollDown()
})
watch(() => thread.value?.messages?.length, scrollDown)
async function scrollDown() {
await nextTick()
if (scroll.value) scroll.value.scrollTop = scroll.value.scrollHeight
}
function lastMsg(t) {
return t.messages[t.messages.length - 1] || null
}
// List-row preview: the last message's visible text (the html is
// server-rendered strict markdown, safe to parse here).
function preview(t) {
const m = lastMsg(t)
if (!m) return ''
const div = document.createElement('div')
div.innerHTML = m.html
const who = m.admin ? `${m.admin}: ` : ''
return (who + (div.textContent || '')).slice(0, 80)
}
// Relative timestamps like elsewhere in analytics.
const fmtTime = (t) => formatWhen(t)
function send(md) {
// First reply doubles as the notification-permission gesture.
askNotifyPermission()
if (thread.value) wsSend({ type: 'reply', id: thread.value.id, text: md })
}
</script>
<template>
<ConnNote :text="connNote" />
<div class="messages-view">
<aside class="thread-list">
<p v-if="!threads.length" class="empty">no messages yet</p>
<button
v-for="t in threads"
:key="t.id"
type="button"
class="thread-row"
:class="{ active: t.id === selected, archived: t.closed }"
@click="selected = t.id"
>
<span class="dot" :class="{ unread: t.unread && !t.closed }"></span>
<span class="peek">
<strong>{{ t.name || t.id.slice(0, 8) }}</strong>
<em v-if="t.closed" class="archived-tag">archived</em>
{{ preview(t) }}
</span>
<time>{{ fmtTime(lastMsg(t)?.t || t.created) }}</time>
</button>
</aside>
<section v-if="thread" class="thread">
<header v-if="thread.name" class="thread-head">
<strong>{{ thread.name }}</strong>
<a v-if="thread.email" :href="`mailto:${thread.email}`">{{ thread.email }}</a>
</header>
<div ref="scroll" class="thread-messages">
<div
v-for="m in thread.messages"
:key="m.id"
class="contact-msg"
:class="{ mine: m.admin }"
>
<!-- Server-rendered strict markdown only (see ContactPanel). -->
<header>
<span class="who">{{ m.admin || thread.name || 'visitor' }}</span>
<time>{{ fmtTime(m.t) }}</time>
</header>
<div class="contact-msg-body" v-html="m.html"></div>
</div>
</div>
<Composer
:placeholder="thread.closed ? 'archived — the visitor closed this conversation' : 'Reply…'"
:send-disabled="thread.closed"
@send="send"
/>
</section>
<section v-else class="thread">
<p class="empty">select a thread</p>
</section>
</div>
</template>
<style scoped>
.messages-view {
flex: 1;
min-height: 0;
display: flex;
gap: 1rem;
}
.thread-list {
display: flex;
flex-direction: column;
gap: 0.2rem;
width: 16rem;
flex-shrink: 0;
overflow-y: auto;
}
.thread-row {
display: flex;
align-items: baseline;
gap: 0.4rem;
padding: 0.35rem 0.5rem;
border: 1px solid var(--line);
border-radius: 0.4rem;
background: none;
color: var(--text, CanvasText);
font: inherit;
font-size: 0.85rem;
text-align: left;
cursor: pointer;
}
.thread-row.active {
border-color: var(--accent);
}
.thread-row .dot {
flex-shrink: 0;
width: 0.5rem;
height: 0.5rem;
border-radius: 50%;
background: transparent;
}
.thread-row .dot.unread {
background: var(--accent);
}
.thread-row .peek {
flex: 1;
overflow: hidden;
white-space: nowrap;
text-overflow: ellipsis;
color: var(--muted);
}
.thread-row .peek strong {
color: var(--text, CanvasText);
font-weight: 600;
}
.thread-row.archived {
opacity: 0.6;
}
.thread-row .archived-tag {
font-style: normal;
font-size: 0.7rem;
border: 1px solid var(--line);
border-radius: 0.6em;
padding: 0 0.4em;
color: var(--muted);
}
.thread-row time {
flex-shrink: 0;
color: var(--muted);
font-size: 0.75rem;
}
.thread {
flex: 1;
display: flex;
flex-direction: column;
gap: 0.6rem;
min-width: 0;
min-height: 0;
}
.thread-messages {
flex: 1;
min-height: 0;
overflow-y: auto;
padding-right: 0.2rem;
}
.empty {
color: var(--muted);
text-align: center;
margin-top: 2rem;
}
.thread-head {
display: flex;
gap: 0.6rem;
align-items: baseline;
padding-bottom: 0.25rem;
border-bottom: 1px solid var(--line);
font-size: 0.9rem;
}
.thread-head a {
color: var(--muted);
text-decoration: none;
}
.thread-head a:hover {
color: var(--accent);
}
.contact-msg {
padding: 0.55rem 0;
}
.contact-msg + .contact-msg {
border-top: 1px solid var(--line);
}
.contact-msg-body {
overflow-wrap: break-word;
}
.contact-msg-body :deep(p) {
margin: 0.25em 0;
}
.contact-msg-body :deep(img) {
max-width: 100%;
border-radius: 0.3rem;
}
.contact-msg-body :deep(a.attachment) {
display: inline-block;
padding: 0.05em 0.5em;
border: 1px solid var(--line);
border-radius: 1em;
background: var(--bg, Canvas);
text-decoration: none;
white-space: nowrap;
}
.contact-msg header {
display: flex;
gap: 0.5rem;
align-items: baseline;
color: var(--muted);
font-size: 0.75rem;
}
.contact-msg.mine header {
justify-content: flex-end;
}
.contact-msg header .who {
font-weight: 600;
color: var(--text, CanvasText);
}
@media (max-width: 48rem) {
.messages-view {
flex-direction: column;
}
.thread-list {
width: 100%;
max-height: 30%;
}
}
</style>
+36 -7
View File
@@ -38,7 +38,7 @@ import { flagFor, langName, langSort } from './langs'
import { editorLang, pagePrimary } from './editorLang' import { editorLang, pagePrimary } from './editorLang'
import LangSelect from './LangSelect.vue' import LangSelect from './LangSelect.vue'
import ConnNote from './ConnNote.vue' import ConnNote from './ConnNote.vue'
import { reconnectPolicy, socketSlot, watchConnecting } from './reconnect' import { authReconnect, reconnectPolicy, socketSlot, watchConnecting } from './reconnect'
import { dropPageCache, loadPlain } from './swapdoc' import { dropPageCache, loadPlain } from './swapdoc'
const props = defineProps({ const props = defineProps({
@@ -75,13 +75,14 @@ let sessionDoc = null
// input until the page's document has arrived: typing before the accept // input until the page's document has arrived: typing before the accept
// would be clobbered by it. While merely DISconnected the editor stays // would be clobbered by it. While merely DISconnected the editor stays
// editable — text stashes and pending saves flush on reconnect. // editable — text stashes and pending saves flush on reconnect.
const conn = ref('connecting') // connecting | open | waiting const conn = ref('connecting') // connecting | open | waiting | login
const retryIn = ref(0) const retryIn = ref(0)
const docReady = ref(false) const docReady = ref(false)
const editable = new Compartment() const editable = new Compartment()
const connNote = computed(() => const connNote = computed(() =>
conn.value === 'connecting' ? 'connecting to the server…' conn.value === 'connecting' ? 'connecting to the server…'
: conn.value === 'waiting' ? `connection lost — reconnecting in ~${retryIn.value} s…` : conn.value === 'waiting' ? `connection lost — reconnecting in ~${retryIn.value} s…`
: conn.value === 'login' ? 'session expired — log in to continue editing…'
: docReady.value ? '' : 'loading the page…', : docReady.value ? '' : 'loading the page…',
) )
@@ -96,6 +97,9 @@ let connectWatchdog = null
// retries trip the browser's WebSocket throttling (sockets stuck "pending" // retries trip the browser's WebSocket throttling (sockets stuck "pending"
// for minutes), which is what kept hollowing out the editor. // for minutes), which is what kept hollowing out the editor.
const reconnects = reconnectPolicy() const reconnects = reconnectPolicy()
// Bumped by every connect()/unmount: the auth probe in onclose is async, so
// a stale tail checks it did not get superseded before acting.
let connectEpoch = 0
const dirty = ref(false) // unsaved text exists (drives the 💾 button) const dirty = ref(false) // unsaved text exists (drives the 💾 button)
let syncingScroll = false let syncingScroll = false
@@ -990,6 +994,7 @@ function consumePendingLine() {
} }
function connect() { function connect() {
connectEpoch++
clearTimeout(reconnectTimer) clearTimeout(reconnectTimer)
conn.value = 'connecting' conn.value = 'connecting'
if (ws) { if (ws) {
@@ -1021,19 +1026,40 @@ function connect() {
openPath(normPath(props.pagePath)) openPath(normPath(props.pagePath))
} }
} }
ws.onclose = (ev) => { ws.onclose = async (ev) => {
// 1006 = abnormal (e.g. the dev proxy refused/dropped the upgrade, or // 1006 = abnormal (e.g. the dev proxy refused/dropped the upgrade, or
// the connecting watchdog fired); worth seeing since a dead socket // the connecting watchdog fired); worth seeing since a dead socket
// before the first doc bricks the editor until a retry lands one. // before the first doc bricks the editor until a retry lands one.
// The wait is the policy's: doubling backoff with jitter (./reconnect).
console.warn('[pagerite] editor socket closed:', ev.code, ev.reason || '') console.warn('[pagerite] editor socket closed:', ev.code, ev.reason || '')
const gen = connectEpoch
const wait = reconnects.closed() const wait = reconnects.closed()
retryIn.value = Math.max(1, Math.round(wait / 1000)) // An expired session fails the handshake like a dead network, but blind
conn.value = 'waiting' // retries loop forever — the WS API cannot open the login dialog. Probe
reconnectTimer = setTimeout(connect, wait) // /_api (./reconnect's authReconnect): a lost session runs the paskia
// login flow and reconnects the moment it completes; a declined login
// holds at the 'login' note (a later login anywhere in the page, or a
// save attempt, reconnects); only transient failures take the backoff.
const outcome = await authReconnect(() => { conn.value = 'login' })
if (gen !== connectEpoch) return
if (outcome === 'auth') {
connect()
} else if (outcome === 'abort') {
conn.value = 'login'
} else {
retryIn.value = Math.max(1, Math.round(wait / 1000))
conn.value = 'waiting'
reconnectTimer = setTimeout(connect, wait)
}
} }
} }
// A login completed anywhere in the page (the banner's 🔑 button, another
// panel's flow) reconnects a waiting editor at once instead of waiting out
// the backoff. paskia's auth iframe announces it as a window message.
function onAuthMessage(ev) {
if (ev.data?.type === 'auth-success' && conn.value !== 'open') connect()
}
onMounted(() => { onMounted(() => {
// The first connection takes a staggered slot (see ./reconnect): page // The first connection takes a staggered slot (see ./reconnect): page
// load opens several sockets at once, and the burst trips throttling. // load opens several sockets at once, and the burst trips throttling.
@@ -1090,9 +1116,11 @@ onMounted(() => {
addEventListener('pagerite:editor-shown', onEditorShown) addEventListener('pagerite:editor-shown', onEditorShown)
// A section pen clicked while the page editor is already open. // A section pen clicked while the page editor is already open.
addEventListener('pagerite:edit-section', consumePendingLine) addEventListener('pagerite:edit-section', consumePendingLine)
addEventListener('message', onAuthMessage)
}) })
onUnmounted(() => { onUnmounted(() => {
connectEpoch++ // invalidate a pending onclose auth probe
clearTimeout(reconnectTimer) clearTimeout(reconnectTimer)
clearTimeout(connectWatchdog) clearTimeout(connectWatchdog)
if (ws) { if (ws) {
@@ -1106,6 +1134,7 @@ onUnmounted(() => {
removeEventListener('keydown', onKeydown) removeEventListener('keydown', onKeydown)
removeEventListener('pagerite:editor-shown', onEditorShown) removeEventListener('pagerite:editor-shown', onEditorShown)
removeEventListener('pagerite:edit-section', consumePendingLine) removeEventListener('pagerite:edit-section', consumePendingLine)
removeEventListener('message', onAuthMessage)
}) })
</script> </script>
+244
View File
@@ -12,6 +12,9 @@ import { html } from '@codemirror/lang-html'
import { cmHighlight, cmTheme } from './cmtheme' import { cmHighlight, cmTheme } from './cmtheme'
import { dropPageCache, loadPlain, runScripts } from './swapdoc' import { dropPageCache, loadPlain, runScripts } from './swapdoc'
import { apiFetch, apiJson } from 'paskia' import { apiFetch, apiJson } from 'paskia'
import { editorLang } from './editorLang'
import LangSelect from './LangSelect.vue'
import { flagFor, langName, langSort } from './langs'
const props = defineProps({ const props = defineProps({
pagePath: { type: String, default: '' }, pagePath: { type: String, default: '' },
@@ -57,6 +60,103 @@ async function errorDetail(res) {
// empty brand removes the header link and the title suffix entirely. // empty brand removes the header link and the title suffix entirely.
const brand = ref('') const brand = ref('')
const theme = ref('') const theme = ref('')
// --- Messaging (contact) ---------------------------------------------------
// Contact messaging settings: a two-row grid (labels above, the flag
// selector and the boxes below). The label (the {contact:} buttons'
// label and the visitor dialog's title) doubles as the on/off switch:
// empty = disabled. The label and email subject are per-language
// strings — the LangSelect (the article editor's flag dropdown, on the
// shared shell-wide editorLang) switches the two fields between the
// original and a translation override (stored in the chunk-keyed trans
// store; auto translators fill the same store, so this is the
// manual-override UI). The email and mail server are global: the
// email's reveal after the PoW solve is server-side, and the mail
// server (a mailbridge URL, docs/messages.md; empty = no email) is
// reserved for email notifications.
const contactEmail = ref('')
const contactLabel = ref('')
const contactSubject = ref('')
const contactMailserver = ref('')
const contactLabelOrig = ref('')
const contactSubjectOrig = ref('')
// Password managers offer credential autofill on these boxes no matter
// the autocomplete setting; readonly until the first interaction keeps
// them off (the vendors' ignore attributes on the inputs back it up).
const pmGuard = ref(true)
const pmUnlock = () => { pmGuard.value = false }
const lang = editorLang // '' = the original strings (the primary language)
const primaryLang = ref('en')
const translateLangs = ref([])
const translating = computed(() => lang.value && lang.value !== primaryLang.value)
// The flag selector's options, built like the article editor's: the
// primary language first (tag ''), then the configured targets in the
// geographic grouping.
const contactLangOptions = computed(() => {
const others = langSort(translateLangs.value.filter((l) => l && l !== primaryLang.value))
return [primaryLang.value, ...others].map((code) => ({
tag: code === primaryLang.value ? '' : code,
code,
name: langName(code),
flag: flagFor(code),
primary: code === primaryLang.value,
}))
})
async function onContactLangChange() {
if (!translating.value) {
contactLabel.value = contactLabelOrig.value
contactSubject.value = contactSubjectOrig.value
return
}
try {
const s = await apiJson(`/_api/settings?lang=${lang.value}`)
contactLabel.value = s.contact_label_tr || ''
contactSubject.value = s.contact_subject_tr || ''
} catch { /* keep empty */ }
}
watch(lang, onContactLangChange)
function onContactInput() {
// Capture the language being edited: a debounced save must not land in
// whatever language happens to be selected when the timer fires.
const tag = lang.value
if (!tag || tag === primaryLang.value) {
contactLabelOrig.value = contactLabel.value
contactSubjectOrig.value = contactSubject.value
}
debounce('contact', () => saveContact(tag, contactLabel.value, contactSubject.value))
}
async function saveContact(tag = lang.value, label = '', subject = '') {
if (tag && tag !== primaryLang.value) {
// Translation override: only the label/subject apply (empty = drop).
const res = await apiFetch(`/_api/settings?lang=${tag}`, {
method: 'PUT',
headers: { 'content-type': 'application/json' },
body: JSON.stringify({
brand: brand.value,
theme: theme.value,
custom_css: customCss.value,
contact_label: label,
contact_subject: subject,
}),
})
saveError.value = res.ok ? '' : '⚠️ changes could not be saved'
if (res.ok) rerender()
return
}
if (await saveSettings()) rerender()
}
// The rendered {contact:} buttons are server HTML: after a save the page
// re-renders (like a theme change), updating buttons and dialog strings
// without a reload.
async function rerender() {
dropPageCache()
loadPlain(path.value)
}
// Theme options come from the backend (theme folders on disk, see GET // Theme options come from the backend (theme folders on disk, see GET
// /_api/settings), so added themes need no frontend changes. // /_api/settings), so added themes need no frontend changes.
const themeOptions = ref([{ value: '', label: '☀️ none' }]) const themeOptions = ref([{ value: '', label: '☀️ none' }])
@@ -88,6 +188,16 @@ async function loadSettings() {
] ]
transition.value = s.transition || 'cube' transition.value = s.transition || 'cube'
transitionOptions.value = s.transitions || [] transitionOptions.value = s.transitions || []
contactEmail.value = s.contact_email || ''
contactMailserver.value = s.contact_mailserver || ''
contactLabelOrig.value = s.contact_label || ''
contactSubjectOrig.value = s.contact_subject || ''
if (!translating.value) {
contactLabel.value = contactLabelOrig.value
contactSubject.value = contactSubjectOrig.value
}
primaryLang.value = s.primary_lang || 'en'
translateLangs.value = s.translate_langs || []
fontOptions.value = [ fontOptions.value = [
...BASE_FONT_OPTIONS, ...BASE_FONT_OPTIONS,
...(s.fonts || []).map((f) => ({ ...(s.fonts || []).map((f) => ({
@@ -255,6 +365,12 @@ async function saveSettings(opts = {}) {
custom_css: customCss.value, custom_css: customCss.value,
brand_html: brandHtml.value, brand_html: brandHtml.value,
transition: transition.value, transition: transition.value,
contact_email: contactEmail.value,
contact_mailserver: contactMailserver.value,
// The originals: while a translation override is being edited the
// input refs hold the override, not the original.
contact_label: contactLabelOrig.value,
contact_subject: contactSubjectOrig.value,
...opts, ...opts,
}), }),
}) })
@@ -264,6 +380,7 @@ async function saveSettings(opts = {}) {
} else { } else {
saveError.value = '⚠️ changes could not be saved' saveError.value = '⚠️ changes could not be saved'
} }
return res.ok
} }
async function onThemeChange() { async function onThemeChange() {
@@ -528,6 +645,9 @@ onMounted(async () => {
parent: brandEl.value, parent: brandEl.value,
}) })
await loadSettings() await loadSettings()
// The shared editorLang may already point at a translation (picked in
// another tab): load its label/subject overrides.
await onContactLangChange()
parseFonts(customCss.value) parseFonts(customCss.value)
setCssDocument(customCss.value) setCssDocument(customCss.value)
applyCustomCss(customCss.value) applyCustomCss(customCss.value)
@@ -655,6 +775,88 @@ onUnmounted(() => {
</div> </div>
</section> </section>
<section class="block">
<div class="msg-grid">
<div class="msg-flag">
<span class="field-label" aria-hidden="true"></span>
<LangSelect
v-model="lang"
:options="contactLangOptions"
title="Language of the button label and email subject strings (edits the translation override)"
/>
</div>
<label class="field">
<span class="field-label">contact button label</span>
<input
v-model="contactLabel"
class="text-input"
:placeholder="translating ? contactLabelOrig : ''"
title="The {contact:} button label and visitor dialog title — empty disables messaging"
:readonly="pmGuard"
data-1p-ignore
data-lpignore="true"
data-bwignore
@pointerdown="pmUnlock"
@focus="pmUnlock"
@input="onContactInput"
/>
</label>
<label class="field">
<span class="field-label">email subject</span>
<input
v-model="contactSubject"
class="text-input"
:placeholder="translating ? contactSubjectOrig : ''"
title="Subject line for the mailto link — empty = the button label"
:readonly="pmGuard"
data-1p-ignore
data-lpignore="true"
data-bwignore
@pointerdown="pmUnlock"
@focus="pmUnlock"
@input="onContactInput"
/>
</label>
<label class="field">
<span class="field-label">our email</span>
<input
v-model="contactEmail"
class="text-input"
title="A mailto link in the visitor dialog, revealed after the visitor solves the proof of work — empty = no link"
:disabled="!!translating"
:readonly="pmGuard"
data-1p-ignore
data-lpignore="true"
data-bwignore
@pointerdown="pmUnlock"
@focus="pmUnlock"
@input="debounce('contact-email', () => saveSettings())"
/>
</label>
<!-- Mail server (SMTP notification backend): plumbing in place
(contactMailserver ref, settings load/save, Data field) but
the sending is not implemented yet — the field stays hidden
until then. Re-adds a fourth column to .msg-grid.
<label class="field">
<span class="field-label">mail server</span>
<input
v-model="contactMailserver"
class="text-input"
title="Server for email notifications — smtp://user:pass@host:port, a bare host[:port], or a backend URL like sendgrid:API-KEY — empty = no email"
:disabled="!!translating"
:readonly="pmGuard"
data-1p-ignore
data-lpignore="true"
data-bwignore
@pointerdown="pmUnlock"
@focus="pmUnlock"
@input="debounce('contact-mailserver', () => saveSettings())"
/>
</label>
-->
</div>
</section>
<section class="block grow" @paste="onBrandPaste"> <section class="block grow" @paste="onBrandPaste">
<div class="block-head"> <div class="block-head">
<span class="field-label">brand code (replaces the brand link)</span> <span class="field-label">brand code (replaces the brand link)</span>
@@ -785,6 +987,48 @@ onUnmounted(() => {
font-size: 1rem; font-size: 1rem;
} }
/* The messaging block: a two-row grid — labels on the first row, the
article editor's flag selector and the boxes on the second, so the
flag centers with the boxes and every label sits directly above its
own field (contact button label = the enable switch, email subject,
our email; the hidden mail-server field joins the email group once the
backend lands). The flag column sizes
to the flag; when only one language is configured the selector renders
nothing and the column collapses.
The boxes are readonly until first interaction (+ vendor ignore
attributes): password managers offer credential autofill on them no
matter the autocomplete setting. */
.msg-grid {
display: grid;
/* The hidden mail-server field (template comment) re-adds a column. */
grid-template-columns: auto repeat(3, minmax(0, 1fr));
align-items: center;
gap: 0.15rem 0.6rem;
}
/* Field wrappers vanish into the grid: labels land on row 1 (the
flag's empty spacer keeps the fields in the 1fr columns whether or
not the flag renders), the flag and boxes on row 2. */
.msg-grid .field,
.msg-grid .msg-flag {
display: contents;
}
.msg-grid .field-label {
grid-row: 1;
min-width: 0;
}
.msg-grid .lang-select,
.msg-grid .text-input {
grid-row: 2;
}
.msg-grid .text-input {
flex: none;
font-size: 0.85rem;
}
.text-input { .text-input {
flex: 1; flex: 1;
min-width: 4rem; min-width: 4rem;
+2 -1
View File
@@ -1,7 +1,8 @@
<script setup> <script setup>
// Recursive site-structure tree with drag-and-drop ordering (vue-draggable). // Recursive site-structure tree with drag-and-drop ordering (vue-draggable).
// Nodes come from the server (GET /_api/pages via StructureEditor.vue) as // Nodes come from the server (GET /_api/pages via StructureEditor.vue) as
// {slug, path, title, translated, order, published, has_content, language, // {slug, path, title, translated, order, published, has_content, empty,
// language,
// primary, children}. The row's flag // primary, children}. The row's flag
// (LangSelect) sets the node's primary language (language; '' = inherit — // (LangSelect) sets the node's primary language (language; '' = inherit —
// dimmed, showing the resolved flag); the setting covers the whole subtree. // dimmed, showing the resolved flag); the setting covers the whole subtree.
+10
View File
@@ -24,6 +24,9 @@ const title = computed(() => {
if (hasError.value) { if (hasError.value) {
parts.push(`${props.step.status}`) parts.push(`${props.step.status}`)
} }
if (props.step.contact) {
parts.push('contact panel opened, proof of work solved')
}
return parts.filter(Boolean).join(' — ') return parts.filter(Boolean).join(' — ')
}) })
</script> </script>
@@ -39,6 +42,7 @@ const title = computed(() => {
<small v-if="count > 1" class="muted">{{ formatCount(count) }}×</small> <small v-if="count > 1" class="muted">{{ formatCount(count) }}×</small>
<img v-if="favicon" class="favicon" :src="favicon" alt="" /> <img v-if="favicon" class="favicon" :src="favicon" alt="" />
<span>{{ step.slug }}</span> <span>{{ step.slug }}</span>
<span v-if="step.contact" class="contact-mark">✉️</span>
<span v-for="(f, fi) in flags" :key="fi" class="flag" v-html="f"></span> <span v-for="(f, fi) in flags" :key="fi" class="flag" v-html="f"></span>
</a> </a>
</template> </template>
@@ -51,6 +55,12 @@ const title = computed(() => {
vertical-align: -0.1em; vertical-align: -0.1em;
} }
/* The contact-panel marker (PoW solved on this step). */
.contact-mark {
margin-left: 0.25em;
font-size: 0.85em;
}
/* Same flag chip as the visitor cells (VisitorCell.vue). */ /* Same flag chip as the visitor cells (VisitorCell.vue). */
.flag { .flag {
display: inline-flex; display: inline-flex;
+45 -6
View File
@@ -13,6 +13,7 @@ import {
TNODE_W, TNODE_W,
TNODE_H, TNODE_H,
BEAD_R, BEAD_R,
BEAD_LEN,
buildTransitionGraph, buildTransitionGraph,
} from './analytics/transitions.js' } from './analytics/transitions.js'
@@ -121,9 +122,16 @@ const syncBeads = (flows) => {
} }
const tick = (t) => { const tick = (t) => {
const dt = lastTick ? (t - lastTick) / 1000 : 0 // Long gaps (sleep, hidden tab) must not spawn a bead per missed interval
// just to drop them all in the same tick: clamp the step (every in-flight
// bead simply completes) and fast-forward each emitter's schedule to its
// next future slot, keeping the phase.
const dt = lastTick ? Math.min((t - lastTick) / 1000, TRAVERSAL_S) : 0
lastTick = t lastTick = t
for (const e of emitters.values()) { for (const e of emitters.values()) {
if (e.next < t - e.interval) {
e.next = t + (((e.next - t) % e.interval) + e.interval) % e.interval
}
while (e.next <= t) { while (e.next <= t) {
live.push({ e, p: 0 }) live.push({ e, p: 0 })
e.next += e.interval e.next += e.interval
@@ -138,7 +146,17 @@ const tick = (t) => {
continue continue
} }
const f = b.e.flow const f = b.e.flow
out.push({ x: f.x1 + (f.x2 - f.x1) * b.p, y: f.y1 + (f.y2 - f.y1) * b.p }) // The pulse is elongated along the direction of travel (constant per
// flow) and colored like its connector (external edges use --text).
if (f.deg === undefined) {
f.deg = (Math.atan2(f.y2 - f.y1, f.x2 - f.x1) * 180) / Math.PI
}
out.push({
x: f.x1 + (f.x2 - f.x1) * b.p,
y: f.y1 + (f.y2 - f.y1) * b.p,
deg: f.deg,
ext: f.external,
})
} }
beads.value = out beads.value = out
rafId = requestAnimationFrame(tick) rafId = requestAnimationFrame(tick)
@@ -177,6 +195,21 @@ const countLabel = (n) =>
<section v-if="graph"> <section v-if="graph">
<svg class="tmap" :style="{ maxWidth: `${graph.bounds.x1 - graph.bounds.x0}px` }" :viewBox="`${graph.bounds.x0} ${graph.bounds.y0} ${graph.bounds.x1 - graph.bounds.x0} ${graph.bounds.y1 - graph.bounds.y0}`" <svg class="tmap" :style="{ maxWidth: `${graph.bounds.x1 - graph.bounds.x0}px` }" :viewBox="`${graph.bounds.x0} ${graph.bounds.y0} ${graph.bounds.x1 - graph.bounds.x0} ${graph.bounds.y1 - graph.bounds.y0}`"
role="img" aria-label="map of transitions between pages"> role="img" aria-label="map of transitions between pages">
<defs>
<!-- Pulse gradient: opaque head at the bead position (local origin),
fading tail trailing behind it (stop-color comes from CSS so
theme vars resolve). -->
<linearGradient id="tbead-grad">
<stop offset="0" class="tbead-stop" stop-opacity="0" />
<stop offset="0.55" class="tbead-stop" stop-opacity="0.5" />
<stop offset="1" class="tbead-stop" stop-opacity="1" />
</linearGradient>
<linearGradient id="tbead-grad-exit">
<stop offset="0" class="tbead-stop-exit" stop-opacity="0" />
<stop offset="0.55" class="tbead-stop-exit" stop-opacity="0.5" />
<stop offset="1" class="tbead-stop-exit" stop-opacity="1" />
</linearGradient>
</defs>
<path v-for="(a, i) in graph.arcs" :key="'a' + i" <path v-for="(a, i) in graph.arcs" :key="'a' + i"
:id="`tarc${i}`" :d="a.d" :class="['tarc', a.top && 'tarc-top']" /> :id="`tarc${i}`" :d="a.d" :class="['tarc', a.top && 'tarc-top']" />
<template v-for="(a, i) in graph.arcs" :key="'t' + i"> <template v-for="(a, i) in graph.arcs" :key="'t' + i">
@@ -187,8 +220,11 @@ const countLabel = (n) =>
:d="e.d" :class="['tconn', e.external && 'tconn-exit']"> :d="e.d" :class="['tconn', e.external && 'tconn-exit']">
<title>{{ e.title }}</title> <title>{{ e.title }}</title>
</path> </path>
<circle v-for="(b, i) in beads" :key="'b' + i" <rect v-for="(b, i) in beads" :key="'b' + i"
:cx="b.x" :cy="b.y" :r="BEAD_R" class="tbead" /> :x="-BEAD_LEN" :y="-BEAD_R" :width="BEAD_LEN" :height="2 * BEAD_R" :rx="BEAD_R"
:fill="b.ext ? 'url(#tbead-grad-exit)' : 'url(#tbead-grad)'"
:class="['tbead', b.ext && 'tbead-exit']"
:transform="`translate(${b.x} ${b.y}) rotate(${b.deg})`" />
<g v-for="(x, i) in graph.extNodes" :key="'x' + i"> <g v-for="(x, i) in graph.extNodes" :key="'x' + i">
<clipPath :id="`xclip${i}`"> <clipPath :id="`xclip${i}`">
<rect :x="x.x - TNODE_W/2 + 6" :y="x.y - TNODE_H/2" :width="TNODE_W - 12" <rect :x="x.x - TNODE_W/2 + 6" :y="x.y - TNODE_H/2" :width="TNODE_W - 12"
@@ -252,10 +288,13 @@ const countLabel = (n) =>
fill: var(--text); fill: var(--text);
} }
.tmap .tbead { .tmap .tbead {
fill: var(--accent);
opacity: 0.85;
filter: drop-shadow(0 0 2.5px var(--accent)); filter: drop-shadow(0 0 2.5px var(--accent));
} }
.tmap .tbead-exit {
filter: drop-shadow(0 0 2.5px var(--text));
}
.tmap .tbead-stop { stop-color: var(--accent); }
.tmap .tbead-stop-exit { stop-color: var(--text); }
.tmap .txnode { .tmap .txnode {
/* External source/exit pills: plain white on every theme, with a hairline /* External source/exit pills: plain white on every theme, with a hairline
so the pill stays visible on a white page. */ so the pill stays visible on a white page. */
+26
View File
@@ -160,9 +160,32 @@ function externalOrigin(url) {
} }
} }
// Non-article machinery paths shown in trails with an emoji marker:
// recorded like page GETs but fetched by crawlers/feed readers, so they
// surface in the crawler rows. Feed paths are pre-registered for the
// future RSS/Atom routes.
const MACHINE_STEPS = {
'/robots.txt': ['🤖', 'robots.txt'],
'/sitemap.xml': ['🗺️', 'sitemap.xml'],
'/llms.txt': ['🧠', 'llms.txt'],
'/feed.json': ['📡', 'feed.json'],
'/feed.xml': ['📡', 'feed.xml'],
'/rss.xml': ['📡', 'rss.xml'],
'/atom.xml': ['📡', 'atom.xml'],
'/feed': ['📡', 'feed'],
}
/** Format one trail step: an internal page or an external https origin. */ /** Format one trail step: an internal page or an external https origin. */
function stepOf(path, titles) { function stepOf(path, titles) {
if (path?.startsWith('/')) { if (path?.startsWith('/')) {
// Known non-article machinery GETs (fetched by crawlers and feed
// readers, recorded like page GETs): emoji-marked so they stand out
// from article steps in the trails.
const machine = MACHINE_STEPS[path]
if (machine) {
const [emoji, name] = machine
return { path, slug: `${emoji} ${name}`, title: name, external: false, machine: true }
}
return { path, slug: slugOf(path), title: titles.get(path) || '', external: false, home: path === '/' } return { path, slug: slugOf(path), title: titles.get(path) || '', external: false, home: path === '/' }
} }
if (path?.startsWith('https://')) { if (path?.startsWith('https://')) {
@@ -633,6 +656,8 @@ export function formatVisitRows(visits, clients, pageTree, now = Date.now(), sit
if (item.read) step.readSeconds = item.read if (item.read) step.readSeconds = item.read
if (item.status) step.status = item.status if (item.status) step.status = item.status
if (item.lang) step.lang = item.lang if (item.lang) step.lang = item.lang
// Contact panel opened here and its PoW solved (✉️ marker).
if (item.contact) step.contact = true
} }
return step return step
}) })
@@ -644,6 +669,7 @@ export function formatVisitRows(visits, clients, pageTree, now = Date.now(), sit
if (step.lang && step.lang !== prev.langs[prev.langs.length - 1]) prev.langs.push(step.lang) if (step.lang && step.lang !== prev.langs[prev.langs.length - 1]) prev.langs.push(step.lang)
if (step.readSeconds) prev.readSeconds = (prev.readSeconds || 0) + step.readSeconds if (step.readSeconds) prev.readSeconds = (prev.readSeconds || 0) + step.readSeconds
if (step.status) prev.status = step.status if (step.status) prev.status = step.status
if (step.contact) prev.contact = true
} else { } else {
step.langs = step.lang ? [step.lang] : [] step.langs = step.lang ? [step.lang] : []
trail.push(step) trail.push(step)
+3 -3
View File
@@ -190,11 +190,11 @@ export function makeSeries(buckets, rangeKey) {
* Every bounded range is a rolling span ending at now; the charts instead * Every bounded range is a rolling span ending at now; the charts instead
* align week to Monday 00:00 UTC (overlaying previous weeks) and month+ * align week to Monday 00:00 UTC (overlaying previous weeks) and month+
* to UTC day boundaries, so their x windows differ from the stats range * to UTC day boundaries, so their x windows differ from the stats range
* on purpose. * on purpose. `now` is passed in by reactive callers so the window slides
* as time passes instead of freezing at mount.
* Returns { t0, t1 } where null means unbounded. * Returns { t0, t1 } where null means unbounded.
*/ */
export function rangeWindow(rangeKey) { export function rangeWindow(rangeKey, now = Date.now()) {
const now = Date.now()
if (rangeKey === 'all') { if (rangeKey === 'all') {
return { t0: null, t1: null } return { t0: null, t1: null }
} }
+186 -107
View File
@@ -3,11 +3,16 @@
* *
* Site map following the menu structure: top-level items in a row at the * Site map following the menu structure: top-level items in a row at the
* top (below the external source row), each item's subtree fanning out * top (below the external source row), each item's subtree fanning out
* below it in menu order along a slightly circular downward arc. Index * below it in menu order along a slightly circular downward arc. Every
* pages with no views are omitted, their children moving up in their * page of the site is shown (from /_api/pages), whether or not it had
* place. All pages of the site are shown (from /_api/pages), plus any * views in the window — only index pages without content of their own
* extra paths seen in transitions (deleted pages); these form their own * (category labels and empty pages — the ones the site navigation itself
* top-level groups. Internal path -> path transitions join opposite * bypasses in favor of the first child) are omitted, their children
* moving up in their place, the first visible child taking the slot.
* Paths the traffic
* names but the tree no longer has (deleted pages) are inserted as
* ghosts where they would have been, materializing missing ancestors as
* content-less category lanes. Internal path -> path transitions join opposite
* directions into straight connections (middle width = total * directions into straight connections (middle width = total
* count; connectors flare into the node pills at both ends and wrap * count; connectors flare into the node pills at both ends and wrap
* around their backs, surrounding them; the pills are drawn on top). Connection width grows * around their backs, surrounding them; the pills are drawn on top). Connection width grows
@@ -18,7 +23,9 @@
* connections. Animated beads flow along every edge in each direction, * connections. Animated beads flow along every edge in each direction,
* emitted at time intervals inversely proportional (linear) to the * emitted at time intervals inversely proportional (linear) to the
* directional count. * directional count.
* External sources appear as nodes in a row above the map. Sources are * External sources appear as nodes in a row above the map, each pill
* slid sideways toward the pages it connects to (weighted by count,
* minimum spacing kept). Sources are
* identified from visit records in this order: utm_campaign, utm_source, * identified from visit records in this order: utm_campaign, utm_source,
* referer, then other utm_* tags. Visits with a UTM tag are grouped under * referer, then other utm_* tags. Visits with a UTM tag are grouped under
* that tag's value, not under the referer domain. A UTM source node only * that tag's value, not under the referer domain. A UTM source node only
@@ -142,8 +149,10 @@ const MIN_WMID = 0.4
// from real time to keep the animation lightweight. The component // from real time to keep the animation lightweight. The component
// simulates every bead independently in JS with a constant traversal // simulates every bead independently in JS with a constant traversal
// time per edge (speed relative to span length), with no limit on beads // time per edge (speed relative to span length), with no limit on beads
// in flight. // in flight. A bead renders as an elongated pulse trailing its direction
// of travel: BEAD_R is its half-thickness, BEAD_LEN its full length.
export const BEAD_R = 3.2 export const BEAD_R = 3.2
export const BEAD_LEN = BEAD_R * 5.5
const BEAD_RATE = 0.0084 // beads per second per hit/day const BEAD_RATE = 0.0084 // beads per second per hit/day
const FLOW_OFFSET = 3 // lane offset to the right of the travel direction const FLOW_OFFSET = 3 // lane offset to the right of the travel direction
@@ -151,33 +160,6 @@ const MAX_EXT_IN = 8 // referer nodes in the top row
const MAX_EXT_OUT = 12 // exit nodes in the bottom row const MAX_EXT_OUT = 12 // exit nodes in the bottom row
const EXT_GAP = 12 // vertical margin of the source/exit rows to the map const EXT_GAP = 12 // vertical margin of the source/exit rows to the map
/** Flatten the site tree into navigation order via DFS. */
function buildNavigationOrder(pageTree) {
const order = new Map()
const walk = (items) => {
for (const item of items || []) {
const p = `/${item.path}`
if (!order.has(p)) order.set(p, order.size)
walk(item.children)
}
}
walk(pageTree)
return order
}
/** Map page paths to their article titles from the site tree. */
function buildTitleMap(pageTree) {
const titles = new Map()
const walk = (items) => {
for (const item of items || []) {
titles.set(`/${item.path}`, item.title)
walk(item.children)
}
}
walk(pageTree)
return titles
}
/** Extract internal page-to-page transitions, excluding self-loops. */ /** Extract internal page-to-page transitions, excluding self-loops. */
function collectInternalTransitions(transitions) { function collectInternalTransitions(transitions) {
const internal = [] const internal = []
@@ -220,43 +202,70 @@ function collectExitPairs(transitions) {
return [...pairs.values()] return [...pairs.values()]
} }
/** Build nodes with depth and a path lookup map; children are wired to parents. */ /**
function buildNodeTree(internal, navOrder) { * Build the node tree: every page of the current site tree (from
const paths = new Set(['/', ...navOrder.keys()]) * /_api/pages), nested by URL and ordered by the menu, plus a ghost for
for (const e of internal) { paths.add(e.fr); paths.add(e.to) } * every path the traffic names but the tree no longer has (deleted or
* renamed pages). A ghost is inserted where it would have been: under
* its URL parent, with missing ancestors materialized as content-less
* ghost categories — never drawn themselves, their children move up in
* their place and they still define branch lanes, exactly like live
* index pages without content (see annotateNodes/layoutGroups).
* Ghost pills sort after the real siblings, alphabetically among
* themselves (their original menu position is unknowable).
*/
function buildNodeTree(pageTree, extraPaths) {
// The front page anchors the map and is always shown, even with no
// views in the window (and even when the site has no front page node).
const root = { path: '/', depth: 0, title: '', content: true, ghost: false, children: [] }
const byPath = new Map([['/', root]])
const nodes = [root]
const depth = (p) => (p === '/' ? 0 : p.split('/').length - 1) const walk = (items, parent) => {
const nodes = [...paths].map((p) => ({ for (const item of items || []) {
path: p, depth: depth(p), angle: 0, children: [], const p = `/${item.path}`
})) let n = byPath.get(p) // the front page item (path "") maps to "/"
const byPath = new Map(nodes.map((n) => [n.path, n])) if (!n) {
n = {
// Parent is the nearest ancestor present in the map, front page last. path: p, depth: parent.depth + 1, title: '',
const parentOf = (p) => { content: !item.empty, ghost: false, children: [],
let q = p }
while (q !== '/') { byPath.set(p, n)
q = q.slice(0, q.lastIndexOf('/')) || '/' parent.children.push(n)
if (byPath.has(q)) return byPath.get(q) nodes.push(n)
}
n.title = item.title
walk(item.children, n)
} }
return byPath.get('/')
} }
for (const n of nodes) { walk(pageTree, root)
if (n.path !== '/') parentOf(n.path).children.push(n)
// Ghosts: placed under their URL parent, materializing missing
// ancestors as content-less ghost categories (not drawn; their
// children move up and they still define branch lanes).
const materialize = (p) => {
let n = byPath.get(p)
if (n) return n
const parent = materialize(p.slice(0, p.lastIndexOf('/')) || '/')
n = { path: p, depth: parent.depth + 1, title: '', content: false, ghost: true, children: [] }
byPath.set(p, n)
parent.children.push(n)
nodes.push(n)
return n
}
for (const p of extraPaths) {
const n = materialize(p)
if (n.ghost) n.content = true // traffic seen: show the pill
} }
return { nodes, byPath, root: byPath.get('/') } // Real siblings keep menu order; ghosts follow them, alphabetical.
} const sortChildren = (n) => {
n.children.sort((a, b) => (a.ghost - b.ghost) || (a.ghost ? a.path.localeCompare(b.path) : 0))
/** Sort each node's children by navigation order, recursively. */ n.children.forEach(sortChildren)
function sortByNav(root, navOrder) {
const byNav = (a, b) =>
(navOrder.get(a.path) ?? Infinity) - (navOrder.get(b.path) ?? Infinity)
|| a.path.localeCompare(b.path)
const walk = (n) => {
n.children.sort(byNav)
n.children.forEach(walk)
} }
walk(root) sortChildren(root)
return { nodes, byPath, root }
} }
/** Compute median reading time per article in seconds. */ /** Compute median reading time per article in seconds. */
@@ -281,7 +290,7 @@ function buildReadSeconds(visits) {
} }
/** Compute view counts, labels and hidden flags for each node. */ /** Compute view counts, labels and hidden flags for each node. */
function annotateNodes(nodes, viewsData, titles, readSeconds) { function annotateNodes(nodes, viewsData, readSeconds) {
const viewCount = (p) => { const viewCount = (p) => {
let n = 0 let n = 0
for (const c of Object.values(viewsData?.[p] || {})) n += c for (const c of Object.values(viewsData?.[p] || {})) n += c
@@ -292,12 +301,17 @@ function annotateNodes(nodes, viewsData, titles, readSeconds) {
n.views = viewCount(n.path) n.views = viewCount(n.path)
n.readSec = readSeconds[n.path] || 0 n.readSec = readSeconds[n.path] || 0
// Article title inside the pill (clipped at the pill border on // Article title inside the pill (clipped at the pill border on
// render), slug as fallback for pages missing from the site tree. // render), slug as fallback for ghost pages missing from the tree.
n.label = titles.get(n.path) || (n.path === '/' ? '🏠︎' : n.path.split('/').pop()) n.label = n.title || (n.path === '/' ? '🏠︎' : n.path.split('/').pop())
n.title = titles.get(n.path) || '' // Index pages without content of their own — category labels (404
// Category (non-leaf) pages with no views in this window are omitted: // placeholders), empty pages and materialized ghost categories — are
// their children move up in their place (see layoutGroups). // the nodes the site navigation itself bypasses in favor of the first
n.hidden = n.children.length > 0 && n.views === 0 // child page, so they are omitted from the map too, their children
// moving up in their place (see layoutGroups). A childless empty page
// is a real navigation stop and stays, and every real page stays
// whether or not it had views in the window: the map always shows
// the full site structure.
n.hidden = !n.content && n.children.length > 0
} }
} }
@@ -626,10 +640,12 @@ function buildRibbon(a, b, ab, ba, wMid, external = false) {
* at the surround), plus the emission interval (seconds between beads, * at the surround), plus the emission interval (seconds between beads,
* inverse of the daily hit rate * BEAD_RATE). Each segment is offset to the * inverse of the daily hit rate * BEAD_RATE). Each segment is offset to the
* right-hand side of its travel direction, so opposing flows on the same * right-hand side of its travel direction, so opposing flows on the same
* edge run on parallel lanes instead of colliding. The component turns * edge run on parallel lanes instead of colliding. `external` tags flows on
* these into independently simulated beads. * external-link edges so the component can render their beads in the
* connector color (the exit/source connectors use --text, not --accent).
* The component turns these into independently simulated beads.
*/ */
function buildFlows(a, b, ab, ba, dayScale = 1) { function buildFlows(a, b, ab, ba, dayScale = 1, external = false) {
const len = Math.hypot(b.x - a.x, b.y - a.y) || 1 const len = Math.hypot(b.x - a.x, b.y - a.y) || 1
const ux = (b.x - a.x) / len const ux = (b.x - a.x) / len
const uy = (b.y - a.y) / len const uy = (b.y - a.y) / len
@@ -653,6 +669,7 @@ function buildFlows(a, b, ab, ba, dayScale = 1) {
y2: a.y + toT * uy + s * ry, y2: a.y + toT * uy + s * ry,
len: span, len: span,
interval: 1 / (count * BEAD_RATE * dayScale), interval: 1 / (count * BEAD_RATE * dayScale),
external,
} }
} }
const flows = [] const flows = []
@@ -700,6 +717,51 @@ function buildInternalEdges(pairs, byPath, dayScale = 1) {
return { edges, flows } return { edges, flows }
} }
/**
* Weighted median of {x, w} targets: the x minimizing Σ w|x − t| —
* the spot where a pill's total horizontal connection pull balances.
*/
function weightedMedian(targets) {
const ts = [...targets].sort((a, b) => a.x - b.x)
let total = 0
for (const t of ts) total += t.w
let acc = 0
for (const t of ts) {
acc += t.w
if (acc >= total / 2) return t.x
}
return ts[ts.length - 1].x
}
/**
* Slide the pills of an external row sideways so each sits as close as
* possible to the pages it connects to: minimize Σ w|pill.x − target.x|
* over all drawn connections (weight = count), subject to a minimum
* center `spacing` (no overlap). Pills are ordered by their weighted
* median target (swapping any inverted adjacent pair can only add
* crossing distance), then positioned by coordinate descent on this
* convex objective: each pass snaps a pill to its weighted median,
* clamped to the spacing window between its current neighbors.
*/
function placeRow(items, spacing) {
items.sort((a, b) => a.anchor - b.anchor)
const n = items.length
for (const it of items) it.x = it.anchor
for (let pass = 0; pass < 40; pass++) {
let moved = 0
const sweep = (i) => {
const lo = i > 0 ? items[i - 1].x + spacing : -Infinity
const hi = i < n - 1 ? items[i + 1].x - spacing : Infinity
const x = Math.min(Math.max(items[i].anchor, lo), hi)
moved = Math.max(moved, Math.abs(x - items[i].x))
items[i].x = x
}
for (let i = 0; i < n; i++) sweep(i)
for (let i = n - 1; i >= 0; i--) sweep(i)
if (moved < 0.01) break
}
}
const UTM_PRIORITY = ['utm_campaign', 'utm_source'] const UTM_PRIORITY = ['utm_campaign', 'utm_source']
const UTM_FALLBACK = ['utm_medium', 'utm_content', 'utm_term', 'utm_id'] const UTM_FALLBACK = ['utm_medium', 'utm_content', 'utm_term', 'utm_id']
@@ -764,10 +826,12 @@ function collectSourcePairs(visits) {
* Place external source and exit nodes and build their edges and bead * Place external source and exit nodes and build their edges and bead
* flows. * flows.
* Sources (incoming links) are derived from visit UTM/referer data and form * Sources (incoming links) are derived from visit UTM/referer data and form
* a row centered above the map, hottest first; exits come from the * a row above the map; exits come from the
* transition matrix and form a matching row centered below the map, so * transition matrix and form a matching row below the map, so
* the site itself stays in the middle. Both rows sit EXT_GAP beyond the * the site itself stays in the middle. Both rows sit EXT_GAP beyond the
* map's bounds. * map's bounds. Within a row the pills slide sideways toward the pages
* they connect to (placeRow), minimizing the weighted horizontal
* connection distance while keeping a minimum center spacing.
* Widths and pruning use the same log scale and traffic-share rule as * Widths and pruning use the same log scale and traffic-share rule as
* internal connections. * internal connections.
*/ */
@@ -785,9 +849,10 @@ function buildExternal({ sources, exits }, byPath, innerBounds, dayScale = 1) {
const width = (count) => scaledWidth(count * dayScale) const width = (count) => scaledWidth(count * dayScale)
// Incoming: one source node per identified source, in a row centered // Incoming: one source node per identified source, in a row above the
// above the map, with an edge to each page that source led to. A source // map, with an edge to each page that source led to. A source whose
// whose connectors are all culled (below MIN_WMID) is dropped itself. // connectors are all culled (below MIN_WMID) is dropped itself. Pills
// slide sideways toward their connection targets (see placeRow).
const bySource = new Map() // source -> pairs, sorted by total incoming count const bySource = new Map() // source -> pairs, sorted by total incoming count
for (const p of liveSources.filter((p) => p.in >= minCount)) { for (const p of liveSources.filter((p) => p.in >= minCount)) {
const g = bySource.get(p.source) || [] const g = bySource.get(p.source) || []
@@ -804,20 +869,25 @@ function buildExternal({ sources, exits }, byPath, innerBounds, dayScale = 1) {
})) }))
.sort((a, b) => b.total - a.total) .sort((a, b) => b.total - a.total)
.slice(0, MAX_EXT_IN) .slice(0, MAX_EXT_IN)
.filter(({ ps }) => .map((o) => ({
ps.some((p) => !byPath.get(p.page).hidden && width(p.in) >= MIN_WMID)) ...o,
// Anchoring targets: the drawn (non-culled) connections only.
targets: o.ps
.filter((p) => !byPath.get(p.page).hidden && width(p.in) >= MIN_WMID)
.map((p) => ({ x: byPath.get(p.page).x, w: p.in })),
}))
.filter((o) => o.targets.length)
if (origins.length) { if (origins.length) {
const cx = (innerBounds.x0 + innerBounds.x1) / 2
const y = innerBounds.y0 - TNODE_BOUND - EXT_GAP const y = innerBounds.y0 - TNODE_BOUND - EXT_GAP
const spacing = TNODE_W + 44 for (const o of origins) o.anchor = weightedMedian(o.targets)
const x0 = cx - ((origins.length - 1) * spacing) / 2 placeRow(origins, TNODE_W + 44)
origins.forEach(({ source, ps, total, href, isUtm }, i) => { origins.forEach(({ source, ps, total, href, isUtm, x }) => {
const label = isUtm ? source : extLabel(source) const label = isUtm ? source : extLabel(source)
const xn = { const xn = {
path: source, path: source,
href, href,
label, // clipped at the pill border on render label, // clipped at the pill border on render
x: x0 + i * spacing, x,
y, y,
count: total, count: total,
kind: 'source', kind: 'source',
@@ -829,17 +899,18 @@ function buildExternal({ sources, exits }, byPath, innerBounds, dayScale = 1) {
const wMid = width(p.in) const wMid = width(p.in)
if (wMid < MIN_WMID) continue if (wMid < MIN_WMID) continue
edges.push(buildRibbon(xn, page, p.in, 0, wMid, true)) edges.push(buildRibbon(xn, page, p.in, 0, wMid, true))
flows.push(...buildFlows(xn, page, p.in, 0, dayScale)) flows.push(...buildFlows(xn, page, p.in, 0, dayScale, true))
} }
}) })
} }
// Outgoing: one exit node per distinct full URL (so several links to // Outgoing: one exit node per distinct full URL (so several links to
// the same domain stay distinct), showing the total count across all // the same domain stay distinct), showing the total count across all
// pages linking to it, in a row centered below the map (hottest // pages linking to it, in a row below the map mirroring the source row
// first), mirroring the source row above. Each (URL, page) pair // above. Each (URL, page) pair contributes an edge from that page. An
// contributes an edge from that page. An exit whose connectors are all // exit whose connectors are all culled (below MIN_WMID) is dropped
// culled (below MIN_WMID) is dropped itself. // itself. Pills slide sideways toward their connection targets (see
// placeRow).
const byExt = new Map() // full URL -> { ext, out, pairs } const byExt = new Map() // full URL -> { ext, out, pairs }
for (const p of liveExits.filter((p) => p.out >= minCount)) { for (const p of liveExits.filter((p) => p.out >= minCount)) {
const g = byExt.get(p.ext) || { ext: p.ext, out: 0, pairs: [] } const g = byExt.get(p.ext) || { ext: p.ext, out: 0, pairs: [] }
@@ -850,19 +921,23 @@ function buildExternal({ sources, exits }, byPath, innerBounds, dayScale = 1) {
const targets = [...byExt.values()] const targets = [...byExt.values()]
.sort((a, b) => b.out - a.out) .sort((a, b) => b.out - a.out)
.slice(0, MAX_EXT_OUT) .slice(0, MAX_EXT_OUT)
.filter(({ pairs }) => .map((t) => ({
pairs.some((p) => !byPath.get(p.page).hidden && width(p.out) >= MIN_WMID)) ...t,
targets: t.pairs
.filter((p) => !byPath.get(p.page).hidden && width(p.out) >= MIN_WMID)
.map((p) => ({ x: byPath.get(p.page).x, w: p.out })),
}))
.filter((t) => t.targets.length)
if (targets.length) { if (targets.length) {
const cx = (innerBounds.x0 + innerBounds.x1) / 2
const y = innerBounds.y1 + TNODE_BOUND + EXT_GAP const y = innerBounds.y1 + TNODE_BOUND + EXT_GAP
const spacing = TNODE_W + 44 for (const t of targets) t.anchor = weightedMedian(t.targets)
const x0 = cx - ((targets.length - 1) * spacing) / 2 placeRow(targets, TNODE_W + 44)
targets.forEach(({ ext, out, pairs }, i) => { targets.forEach(({ ext, out, pairs, x }) => {
const xn = { const xn = {
path: ext, path: ext,
href: ext, href: ext,
label: extLabel(ext), label: extLabel(ext),
x: x0 + i * spacing, x,
y, y,
count: out, count: out,
kind: 'exit', kind: 'exit',
@@ -874,7 +949,7 @@ function buildExternal({ sources, exits }, byPath, innerBounds, dayScale = 1) {
const wMid = width(p.out) const wMid = width(p.out)
if (wMid < MIN_WMID) continue if (wMid < MIN_WMID) continue
edges.push(buildRibbon(page, xn, p.out, 0, wMid, true)) edges.push(buildRibbon(page, xn, p.out, 0, wMid, true))
flows.push(...buildFlows(page, xn, p.out, 0, dayScale)) flows.push(...buildFlows(page, xn, p.out, 0, dayScale, true))
} }
}) })
} }
@@ -893,15 +968,19 @@ export function buildTransitionGraph(data, pageTree, visits = [], dayScale = 1)
const internal = collectInternalTransitions(data?.transitions) const internal = collectInternalTransitions(data?.transitions)
const sources = collectSourcePairs(visits) const sources = collectSourcePairs(visits)
const exits = collectExitPairs(data?.transitions) const exits = collectExitPairs(data?.transitions)
const navOrder = buildNavigationOrder(pageTree)
const titles = buildTitleMap(pageTree)
const readSeconds = buildReadSeconds(visits) const readSeconds = buildReadSeconds(visits)
if (!internal.length && !navOrder.size) return null // Every internal path the traffic names, for ghost placement:
// transition endpoints, plus pages with views but no internal
// transition (entries from outside — a deleted page still visited).
const extraPaths = new Set()
for (const e of internal) { extraPaths.add(e.fr); extraPaths.add(e.to) }
for (const p of Object.keys(data?.views || {})) extraPaths.add(p)
const { nodes, byPath, root } = buildNodeTree(internal, navOrder) if (!pageTree?.length && !extraPaths.size) return null
sortByNav(root, navOrder)
annotateNodes(nodes, data?.views, titles, readSeconds) const { nodes, byPath, root } = buildNodeTree(pageTree, extraPaths)
annotateNodes(nodes, data?.views, readSeconds)
const { arcs, arcLeft } = layoutGroups(root) const { arcs, arcLeft } = layoutGroups(root)
const placed = nodes.filter((n) => !n.hidden) const placed = nodes.filter((n) => !n.hidden)
const pairs = aggregatePairs(internal) const pairs = aggregatePairs(internal)
+92
View File
@@ -72,6 +72,10 @@
--font-heading: var(--font-source-serif); --font-heading: var(--font-source-serif);
/* The brand follows the heading font unless overridden separately. */ /* The brand follows the heading font unless overridden separately. */
--font-brand: var(--font-heading); --font-brand: var(--font-heading);
/* Navbar typography (family and weight only — size/letter-case stay
per-theme #nav rules); the {contact:} trigger button matches it. */
--font-nav: var(--font-body);
--nav-weight: 400;
--font-code: var(--font-fira-code); --font-code: var(--font-fira-code);
/* Target x-height ratio for code text: set to the body font's ratio /* Target x-height ratio for code text: set to the body font's ratio
(here Source Sans 3's 0.478) so font-size-adjust can scale the code (here Source Sans 3's 0.478) so font-size-adjust can scale the code
@@ -258,6 +262,8 @@ body {
/* Nav overlaid at the bottom of the banner */ /* Nav overlaid at the bottom of the banner */
#nav { #nav {
font-family: var(--font-nav);
font-weight: var(--nav-weight);
font-size: 1.3em; font-size: 1.3em;
padding: 0.35rem 1.25rem; padding: 0.35rem 1.25rem;
} }
@@ -407,6 +413,22 @@ body.editing #sidebar {
text-decoration: none; text-decoration: none;
} }
/* The corner ✉️ (docs/messages.md) is in the pens row for everyone, so
needs its own positioning context. Unread (a new reply for visitors,
unanswered threads for admins) lifts it out of the icon-btn dimming
and animates it (see contact-nudge by the trigger button).
✉️'s envelope glyph runs smaller than its emoji neighbors (📊, 🔐, the
flag) at the same font size; bump it to match their height (scoped to
.editor-pens to out-specify the row's `font: inherit` reset). */
.editor-pens .contact-icon {
position: relative;
font-size: 1.38em;
}
.contact-icon.has-unread {
opacity: 1;
}
#sidebar { #sidebar {
grid-column: 1; grid-column: 1;
/* Pinned to the page's start edge (not the article's) and kept in view /* Pinned to the page's start edge (not the article's) and kept in view
@@ -878,6 +900,76 @@ article {
opacity: 1; opacity: 1;
} }
/* {contact: Label} directive: the button opening the visitor contact
panel (docs/messages.md). A standalone accent button in the article
flow; .has-unread (set by contact-main) marks a new admin reply.
Filled with the accent and hovered like the accent-filled navbar tab:
text in --ink (nitro; --bg elsewhere), hover switches to the bright
--tab-hover with the same glow (text-shadow, which fades dimmer, so
the color stays bright). */
.contact-trigger {
position: relative;
display: inline-flex;
align-items: center;
gap: 0.35em;
margin: 0.3em 0.1em;
padding: 0.35em 1.1em;
/* Same font and weight as the navbar, size/leading as the article text. */
font-size: inherit;
line-height: inherit;
font-family: var(--font-nav);
font-weight: var(--nav-weight);
color: var(--ink, var(--bg));
background: var(--accent);
border: 1px solid var(--accent);
border-radius: 1.2em;
cursor: pointer;
}
.contact-trigger .icon {
/* Match the corner ✉️'s optical size against the button text. The
reduced line-height keeps the larger glyph from inflating the
button: 1.38 × 1.2 ≈ the label text's own 1.65 line box. */
font-size: 1.38em;
line-height: 1.2;
}
.contact-trigger:hover {
color: var(--tab-hover, var(--bg));
text-shadow: 0 0 0.1em;
}
/* Unread (a new admin reply, or unanswered threads on the corner icon —
the .has-unread class, set by contact-main): a scale-up with a shake
every few seconds to draw the eye, stopping when read (the class goes
away). No static badge; reduced-motion users just get the lift above. */
@media (prefers-reduced-motion: no-preference) {
.contact-trigger.has-unread,
.contact-icon.has-unread {
animation: contact-nudge 4.5s ease-in-out infinite;
}
@keyframes contact-nudge {
0%, 16%, 100% { transform: none; }
2% { transform: scale(1.15) rotate(-8deg); }
5% { transform: scale(1.15) rotate(7deg); }
8% { transform: scale(1.15) rotate(-5deg); }
11% { transform: scale(1.15) rotate(4deg); }
14% { transform: scale(1.12); }
}
}
/* Any button in the article flow (the {contact:} trigger and raw
<button>s in the markup — not the .icon-btn editor pens or .copy):
a slight lift on hover. */
article button:not(.icon-btn):not(.copy) {
transition: transform 0.15s;
}
article button:not(.icon-btn):not(.copy):hover {
transform: scale(1.01);
}
.edit-link { .edit-link {
position: absolute; position: absolute;
top: 0.2rem; top: 0.2rem;
+436
View File
@@ -0,0 +1,436 @@
// Messaging overlay entry: imported on demand by pagerite.js when a
// {contact:} trigger button or the corner ✉️ icon is clicked — and right
// at page load when there is a live message session (a visitor's open
// conversation, flagged in localStorage, resumes checking for replies
// without waiting for the panel; for admins the always-on inbox watch
// keeps the badge and notifications live while messaging is enabled).
// The icon opens the admin inbox for admins, the visitor thread for
// visitors; the trigger buttons always open the visitor thread (so
// admins can test both sides). The visitor thread rides the activity
// socket through the bridge pagerite.js hands over ({send, register}) —
// no extra connection; the admin inbox connects its own admin-gated
// socket (MessagesView while open, the background watch otherwise). The
// session token is a localStorage random; the server stores only its
// hash. Closing a conversation archives the thread server-side, wipes
// the local session keys and rotates the token, so the next message
// starts an all-new thread.
import { createApp, reactive, watch } from 'vue'
import { holdGlobalBackdrop, releaseGlobalBackdrop } from 'paskia'
import ContactOverlay from './ContactOverlay.vue'
import { askNotifyPermission, messageText, notifyMessage } from './notify.js'
import { authReconnect, reconnectPolicy, socketSlot, watchConnecting } from './reconnect.js'
const TOKEN_KEY = 'pagerite-contact-token'
const SEEN_KEY = 'pagerite-contact-seen'
// The newest admin reply seen, so the corner icon's unread dot survives
// page loads without any socket activity (pagerite.js reads it too).
const LASTADMIN_KEY = 'pagerite-contact-lastadmin'
// An open conversation: set while the visitor has a live thread, so page
// loads resume checking for replies immediately (cleared on close).
const SESSION_KEY = 'pagerite-contact-session'
let app = null
const state = reactive({
open: false,
mode: 'visitor', // 'visitor' | 'admin'
thread: null,
unread: false, // visitor: an unread admin reply
adminUnread: 0, // admin: unanswered threads
viewerAdmin: false, // set once the inbox has been opened: icon badge = adminUnread
// The session token (a localStorage random; the server stores only its
// hash). Reactive in state because closing a conversation rotates it
// and the composer's uploads send it as a header.
token: '',
// Localized site contact strings (pagerite:contact-* asset config,
// refreshed on every open — they change with the page language):
// label doubles as the visitor dialog's title; email gets a mailto
// link with subject prefilled.
label: 'Contact us',
email: '',
mailtoTo: '', // RFC-encoded "Brand <email>" recipient for the mailto href
subject: '',
})
// The localized contact strings ride the page's asset config (the
// production JSON block, or pagerite:* meta tags in dev). Every site
// language's variant is included (pagerite:contact-langs, JSON): the
// language selector swaps the page in place without touching the asset
// config, so the strings follow <html lang> live instead.
let baseLabel = ''
let baseSubject = ''
let contactLangs = {}
function applyLang() {
const tag = (document.documentElement.lang || '').split('-')[0]
const tr = contactLangs[tag]
state.label = tr?.label || baseLabel || 'Contact us'
state.subject = tr?.subject || baseSubject || state.label
// state.email is NOT reset here: it arrives over the socket after the
// PoW is solved and stays valid for the session.
}
function readContactStrings() {
let assets = {}
const el = document.getElementById('pagerite-assets')
if (el) {
try {
assets = JSON.parse(el.textContent)
} catch { /* keep empty */ }
} else {
for (const m of document.querySelectorAll('meta[name^="pagerite:contact-"]')) {
assets[m.name] = m.content
}
}
baseLabel = assets['pagerite:contact-label'] || ''
baseSubject = assets['pagerite:contact-subject'] || ''
try {
contactLangs = JSON.parse(assets['pagerite:contact-langs'] || '{}')
} catch {
contactLangs = {}
}
applyLang()
}
// Language switches update <html lang> (fetch navigation, the editor's
// lang override): re-pick the strings.
new MutationObserver(applyLang).observe(document.documentElement, {
attributes: true,
attributeFilter: ['lang'],
})
// Page swaps (fetch navigation, editor re-renders after settings saves)
// carry fresh per-language config: keep the dialog strings in sync
// without reopening.
addEventListener('pagerite:page-fetched', readContactStrings)
// The panel is main content, not a sidebar: while open it holds paskia's
// shared blur backdrop (refcounted, z-index 1099; the overlay itself sits
// at 1100, below the auth iframe's 9999).
watch(() => state.open, (open) => {
if (open) holdGlobalBackdrop()
else releaseGlobalBackdrop()
})
watch(() => state.adminUnread, () => refreshBadges())
function ensureToken() {
let token = localStorage.getItem(TOKEN_KEY)
if (!token) {
token = crypto.randomUUID()
localStorage.setItem(TOKEN_KEY, token)
}
return token
}
function seenAt() {
return Number(localStorage.getItem(SEEN_KEY) || 0)
}
function markSeen() {
localStorage.setItem(SEEN_KEY, String(Date.now()))
state.unread = false
refreshBadges()
}
// PoW (easypow, docs/messages.md): the server issues a fresh single-use
// challenge on registration/resync and whenever the quota runs out. The
// solver runs in the background and the solution is submitted as soon as
// it is ready; a validated proof grants a quota of messages and uploads
// and reveals the site's contact email (never carried in the page's
// asset config). The solver module is served by the backend from the
// easypow package, so both sides always match.
const SOLVER_URL = '/_contact/easypow.js' // backend-served; kept in a variable so Rollup leaves the import dynamic
let bridge = null
let solverPromise = null
let powSolution = null // Promise<string> solving the current challenge
let powAborter = null
let unsent = null // last message frame, retried once when its send races the quota
let quotaWaiters = [] // uploads waiting for a re-granted quota
// The solved solution goes out immediately, ahead of any send.
async function submitProof() {
const p = powSolution
if (!p) return
try {
const pow = await p
if (pow && p === powSolution) bridge.send({ token: state.token, pow })
} catch { /* aborted: a newer solve is in flight */ }
}
function sendMessage(md, name = '', email = '') {
// The first message of a fresh thread doubles as the
// notification-permission gesture (denied is never re-asked; a
// dismissed prompt comes up again on the next fresh thread).
if (!localStorage.getItem(SESSION_KEY)) askNotifyPermission()
unsent = { md, name, email, retried: false }
bridge.send({ token: state.token, msg: md, ...(name && { name, email }) })
}
function onPow(msg) {
if (typeof msg.quota === 'number') {
// Proof accepted, quota granted: queued uploads and the racing send
// (rejected for a stale/empty quota) continue.
const waiters = quotaWaiters
quotaWaiters = []
for (const resolve of waiters) resolve(true)
if (unsent && !unsent.retried) {
const { md, name, email } = unsent
unsent.retried = true
bridge.send({ token: state.token, msg: md, ...(name && { name, email }) })
}
return
}
powAborter?.abort() // superseded challenge: stop the stale solve
const ac = (powAborter = new AbortController())
solverPromise ??= import(/* @vite-ignore */ SOLVER_URL)
solverPromise.then(({ solve }) => {
powSolution = solve(msg.challenge, ac.signal)
powSolution.catch(() => {}) // aborts are expected
submitProof()
})
}
function onEmail(msg) {
state.email = msg.email || ''
state.mailtoTo = msg.to || '' // RFC-encoded "Brand <email>" recipient
}
// An upload hit the end of the PoW quota: re-register (the server pushes
// a fresh challenge, solved and proven in the background) and resolve
// once the new quota lands.
function requestQuota() {
return new Promise((resolve) => {
quotaWaiters.push(resolve)
bridge.send({ token: state.token }) // re-registration: a fresh challenge follows
})
}
// Unread markers: the has-unread class (a periodic nudge animation, see
// pagerite.css) on every contact trigger button and on the corner ✉️ icon
// — a new admin reply for visitors, any unanswered thread for admins.
// Called on thread pushes and (from pagerite.js) after navigations, whose
// swap rebuilds the buttons.
export function refreshBadges() {
for (const btn of document.querySelectorAll('.contact-trigger')) {
btn.classList.toggle('has-unread', state.unread)
}
const icon = document.getElementById('contact-icon')
if (!icon) return
icon.classList.toggle('has-unread', state.viewerAdmin ? state.adminUnread > 0 : state.unread)
}
let notifyBaseline = '' // the first push after load is history, only baselines
function onThread(thread) {
state.thread = thread
unsent = null // the send landed (a thread push acknowledges it)
// A thread with messages is a live session: page loads resume checking
// it right away (cleared when the conversation is closed).
if (thread.messages.length) localStorage.setItem(SESSION_KEY, '1')
const lastAdmin = [...thread.messages].reverse().find((m) => m.admin)
if (lastAdmin) localStorage.setItem(LASTADMIN_KEY, lastAdmin.t)
const viewing = state.open && state.mode === 'visitor'
state.unread = Boolean(lastAdmin) && Date.parse(lastAdmin.t) > seenAt() && !viewing
// ISO timestamps compare lexicographically.
if (lastAdmin && lastAdmin.t > notifyBaseline) {
const fresh = Boolean(notifyBaseline)
notifyBaseline = lastAdmin.t
if (fresh && !viewing) {
notifyMessage(state.label, messageText(lastAdmin.html), () => open(bridge))
}
}
if (viewing) markSeen()
else refreshBadges()
}
// The visitor ended the conversation: archive it server-side (the admin
// inbox keeps it), wipe the local session and rotate the token, so the
// next message starts an all-new thread. The panel stays open on the
// fresh empty state. The ⟲ button is two-tap armed in the overlay — no
// text confirm dialog (the visitor UI carries no hardcoded language).
function closeConversation() {
bridge.send({ token: state.token, close: true })
for (const key of [TOKEN_KEY, SEEN_KEY, LASTADMIN_KEY, SESSION_KEY]) {
localStorage.removeItem(key)
}
state.token = ensureToken() // TOKEN_KEY is gone: a fresh random
state.thread = null
state.unread = false
notifyBaseline = ''
unsent = null
bridge.register(state.token, onThread, onPow, onEmail)
refreshBadges()
}
let registered = false
// Registration doubles as the resync: the server pushes the thread state
// back, and pagerite.js re-registers on every socket reconnect. Done once
// per page (also without opening the panel — resume()), in either mode —
// the visitor thread is also the admin's own (the trigger buttons open it
// for them).
function ensureRegistered(br) {
bridge = br
if (registered) return
registered = true
state.token = ensureToken()
bridge.register(state.token, onThread, onPow, onEmail)
}
// A live session found at page load: check for replies immediately,
// without opening the panel (pagerite.js calls this when the session flag
// is set; with a granted notification permission new replies notify right
// away).
export function resume(br) {
ensureRegistered(br)
}
export function open(br, { admin = false } = {}) {
ensureRegistered(br)
if (admin) state.viewerAdmin = true
if (!app) {
app = createApp(ContactOverlay, {
state,
reauthorize: requestQuota,
onSend: ({ md, name, email }) => sendMessage(md, name, email),
onClose: () => {
state.open = false
refreshBadges()
},
onCloseThread: closeConversation,
})
const el = document.createElement('div')
el.id = 'contact-root'
document.body.append(el)
app.mount(el)
}
state.mode = admin ? 'admin' : 'visitor'
readContactStrings()
state.open = true
if (!admin) markSeen()
else refreshBadges()
}
// --- Admin watch -------------------------------------------------------------
// For editors, while messaging is enabled on the site: a background
// /_api/ws/analytics connection keeps the corner icon's badge live and
// notifies new visitor messages right away — the admin always checks,
// without waiting for the inbox to open (pagerite.js starts the watch at
// page load). While the inbox is open MessagesView owns its own socket and
// the notifications; the watch then only tracks the badge. Reconnect
// pacing and the auth-aware close handling are the shared reconnect.js
// policy, same as MessagesView's.
let watchWs = null
let watchStarted = false
let watchTimer = null
let watchEpoch = 0
let watchHiddenAt = 0
const watchReconnects = reconnectPolicy()
const watchThreads = new Map() // id -> thread payload (badge + notify baseline)
const WATCH_WAKE_MS = 30_000
function watchBadge() {
state.adminUnread = [...watchThreads.values()].filter(
(t) => t.unread && !t.closed
).length
}
function watchThread(t) {
const last = t.messages[t.messages.length - 1]
const prev = watchThreads.get(t.id)?.messages?.at(-1)?.id
watchThreads.set(t.id, t)
watchBadge()
// No notification for history (the first 'threads' push baselines), the
// admin's own replies, non-message updates (prev === last.id — or an
// unread:false push, e.g. a read marking for a thread beyond the
// baseline cap), closed threads — or while the inbox is open
// (MessagesView notifies then).
if (!last || last.admin || !t.unread || prev === last.id || t.closed) return
if (state.open && state.mode === 'admin') return
notifyMessage(`New message from ${t.name || 'a visitor'}`, messageText(last.html), () =>
open(bridge, { admin: true })
)
}
function watchConnect() {
if (watchWs) return
const proto = location.protocol === 'https:' ? 'wss:' : 'ws:'
const ws = (watchWs = new WebSocket(`${proto}//${location.host}/_api/ws/analytics`))
watchConnecting(ws, 'contact-watch')
ws.onopen = () => watchReconnects.opened()
ws.onmessage = (ev) => {
let msg = null
try {
msg = JSON.parse(ev.data)
} catch {
return
}
if (msg?.type === 'threads') {
watchThreads.clear()
for (const t of msg.threads) watchThreads.set(t.id, t)
watchBadge()
} else if (msg?.type === 'thread') {
watchThread(msg)
}
}
ws.onclose = async () => {
if (watchWs !== ws) return
watchWs = null
const gen = watchEpoch
const wait = watchReconnects.closed()
const outcome = await authReconnect()
if (gen !== watchEpoch) return
if (outcome === 'auth') watchConnect()
else if (outcome === 'retry') watchTimer = setTimeout(watchConnect, wait)
// 'abort': no session — the next auth-success restarts the watch.
}
ws.onerror = () => ws.close()
}
function watchConnectNow() {
watchEpoch++
clearTimeout(watchTimer)
if (watchWs) {
watchWs.onclose = null
watchWs.close()
watchWs = null
}
watchConnect()
}
export function watchAdmin(br) {
bridge = br
if (watchStarted) return
watchStarted = true
watchTimer = setTimeout(watchConnect, socketSlot())
addEventListener('online', () => {
if (!watchWs) watchConnectNow()
})
addEventListener('visibilitychange', () => {
if (document.visibilityState === 'hidden') {
watchHiddenAt = Date.now()
return
}
// A long-hidden tab's socket is a zombie: reconnect to catch up.
if (watchHiddenAt && Date.now() - watchHiddenAt > WATCH_WAKE_MS) watchConnectNow()
watchHiddenAt = 0
})
// A completed login (re)starts the watch at once; a logout stops it.
addEventListener('message', (ev) => {
const type = ev.data?.type
if (type === 'auth-success') {
if (!watchWs) watchConnectNow()
} else if (type === 'auth-logout') {
watchEpoch++
clearTimeout(watchTimer)
if (watchWs) {
watchWs.onclose = null
watchWs.close()
watchWs = null
}
watchThreads.clear()
state.adminUnread = 0
}
})
}
+33
View File
@@ -0,0 +1,33 @@
// Browser notifications for contact messaging (docs/messages.md): the
// visitor is notified of admin replies, the admin of new visitor
// messages. Permission is requested at one entry point only — right
// after the first message of a fresh thread (the Notification API
// requires a user gesture). A denied permission is permanent in the
// browser, so we never re-ask; a dismissed prompt stays "default" and is
// asked again on the next fresh thread.
export function askNotifyPermission() {
if (!('Notification' in window) || Notification.permission !== 'default') return
Notification.requestPermission()
}
// Fire a notification (a no-op without a granted permission). Clicking
// it focuses the site tab and runs onclick (opening the thread/inbox
// view), so the user reliably lands on what was new.
export function notifyMessage(title, body, onclick) {
if (!('Notification' in window) || Notification.permission !== 'granted') return
const n = new Notification(title, { body, icon: '/favicon.ico' })
n.onclick = () => {
window.focus()
onclick?.()
n.close()
}
}
// The visible text of a server-rendered strict-markdown message (safe to
// parse: the stored html is markdown-it output, never user markup).
export function messageText(html) {
const div = document.createElement('div')
div.innerHTML = html
return (div.textContent || '').trim()
}
+223 -41
View File
@@ -182,6 +182,37 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
return btn; return btn;
} }
// The corner ✉️ (for everyone): opens the messaging overlay — the
// visitor's own thread, or the admin inbox for editors (the {contact:}
// trigger buttons always open the visitor side, so admins can test it).
// The unread marker is seeded without any socket: for visitors from
// localStorage (the newest admin reply vs. the last look, both written
// by the contact bundle), for editors from the /_api/settings probe's
// contact_unread. Once the bundle has loaded, its refreshBadges keeps
// the marker live.
let adminUnreadSeed = 0;
// Messaging disabled in the site settings (no pagerite:contact-label in
// the asset config): no icon for visitors — admins keep theirs, the
// inbox still holds the existing threads.
const contactEnabled = !!assets["pagerite:contact-label"];
function makeContactIcon(admin) {
const b = document.createElement("button");
b.type = "button";
b.id = "contact-icon";
b.className = "contact-icon icon-btn";
b.title = admin ? "messages" : (assets["pagerite:contact-label"] || "contact us");
b.textContent = "✉️";
if (admin) {
if (adminUnreadSeed > 0) b.classList.add("has-unread");
} else {
const seen = Number(localStorage.getItem("pagerite-contact-seen") || 0);
const last = localStorage.getItem("pagerite-contact-lastadmin") || "";
if (last && Date.parse(last) > seen) b.classList.add("has-unread");
}
b.addEventListener("click", () => openContactPanel({ admin }));
return b;
}
// The banner top-right corner container: the language selector (first // The banner top-right corner container: the language selector (first
// item) plus the admin pens and auth links. renderAuthUi rebuilds it from // item) plus the admin pens and auth links. renderAuthUi rebuilds it from
// scratch; the selector's state lives in the shared store, not the DOM, // scratch; the selector's state lives in the shared store, not the DOM,
@@ -213,13 +244,16 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
// Editing is open for admins and, as a dev/no-proxy fallback, when no // Editing is open for admins and, as a dev/no-proxy fallback, when no
// Paskia SSO is detected at all. // Paskia SSO is detected at all.
const canEdit = isAdmin || !ssoAvailable; const canEdit = isAdmin || !ssoAvailable;
// The analytics page is a read-only dashboard: editing pens and the side // The analytics page is a read-only dashboard: editing pens and the
// panel do not apply there. Login/logout links are still useful. // side panel do not apply there. Login/logout links are still useful.
const onAnalytics = currentPath === "/_a"; const onToolPage = currentPath === "/_a";
if (document.getElementById("page-banner")) { if (document.getElementById("page-banner")) {
const pens = pensContainer(); const pens = pensContainer();
if (canEdit && !onAnalytics) { // The contact icon is there for everyone — except visitors when
// Analytics viewer is now a normal page at /_a. // messaging is disabled (admins keep the inbox).
if (canEdit || contactEnabled) pens.append(makeContactIcon(canEdit));
if (canEdit && !onToolPage) {
// Analytics viewer is a normal page at /_a.
const a = document.createElement("a"); const a = document.createElement("a");
a.className = "edit-link analytics-link icon-btn"; a.className = "edit-link analytics-link icon-btn";
a.href = "/_a"; a.href = "/_a";
@@ -231,7 +265,7 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
if (ssoAvailable) pens.append(makeAuthButton(isAdmin)); if (ssoAvailable) pens.append(makeAuthButton(isAdmin));
if (!pens.firstElementChild) pens.remove(); if (!pens.firstElementChild) pens.remove();
} }
if (canEdit && !onAnalytics) injectPagePen(); if (canEdit && !onToolPage) injectPagePen();
} }
// Re-mount the selector into the fresh container (no-op until the // Re-mount the selector into the fresh container (no-op until the
// bundle has been loaded once). // bundle has been loaded once).
@@ -263,8 +297,10 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
isAdmin = false; isAdmin = false;
try { try {
await fetchJson("/_api/settings"); const settings = await fetchJson("/_api/settings");
isAdmin = true; isAdmin = true;
// Seeds the contact icon's admin badge (docs/messages.md).
adminUnreadSeed = settings.contact_unread || 0;
} catch { } catch {
// Anonymous, no pagerite:admin, or no auth proxy / dev. // Anonymous, no pagerite:admin, or no auth proxy / dev.
} }
@@ -285,6 +321,7 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
renderAuthUi(); renderAuthUi();
placeEditPen(); placeEditPen();
pingEntryOnce(); pingEntryOnce();
contactAutoStart();
} }
// Returning to the page via history back/forward may restore a cached // Returning to the page via history back/forward may restore a cached
@@ -293,6 +330,16 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
if (ev.persisted) setupAuth(); if (ev.persisted) setupAuth();
}); });
// paskia's auth iframe announces its result as a window message: a login
// or logout completed anywhere in the page (e.g. the analytics view's
// login flow) re-probes auth and re-renders the pens. setupAuth is
// idempotent, so the profile button's own re-probe after the same login
// is a harmless duplicate.
addEventListener("message", (ev) => {
const type = ev.data?.type;
if (type === "auth-success" || type === "auth-logout") setupAuth();
});
function runScripts(root) { function runScripts(root) {
// Scripts inserted via DOM swapping do not execute; re-create them. // Scripts inserted via DOM swapping do not execute; re-create them.
for (const old of root.querySelectorAll("script")) { for (const old of root.querySelectorAll("script")) {
@@ -446,6 +493,7 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
// Editor-driven swaps don't go through load(): re-evaluate the // Editor-driven swaps don't go through load(): re-evaluate the
// language selector from the fresh copy too. // language selector from the fresh copy too.
mountLangselect(new DOMParser().parseFromString(ev.detail.html, "text/html")); mountLangselect(new DOMParser().parseFromString(ev.detail.html, "text/html"));
contactMod?.refreshBadges();
}); });
// Editors mutate site-wide state (theme, structure, headings, banners), // Editors mutate site-wide state (theme, structure, headings, banners),
@@ -619,6 +667,22 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
ws.onopen = () => { ws.onopen = () => {
wsPolicy.opened(); wsPolicy.opened();
for (const msg of wsQueue.splice(0)) ws.send(JSON.stringify(msg)); for (const msg of wsQueue.splice(0)) ws.send(JSON.stringify(msg));
// Re-registering resyncs the contact thread after a reconnect.
if (contactToken) ws.send(JSON.stringify({ token: contactToken }));
};
ws.onmessage = (ev) => {
// Contact thread pushes ride this socket (docs/messages.md).
if (!contactListener) return;
let msg = null;
try {
msg = JSON.parse(ev.data);
} catch {
return;
}
if (msg?.type === "thread") contactListener(msg);
else if (msg?.type === "pow") contactPowListener?.(msg);
else if (msg?.type === "contact-email") contactEmailListener?.(msg);
else if (msg?.type === "contact-error") console.warn("contact:", msg.detail);
}; };
ws.onclose = () => { ws.onclose = () => {
ws = null; ws = null;
@@ -630,7 +694,7 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
function report(msg) { function report(msg) {
if (document.body.classList.contains("editing")) return; if (document.body.classList.contains("editing")) return;
if (msg.to === "/_a") return; if (isToolPage(msg.to)) return;
if (ssoAvailable && isAdmin) msg.hide = true; if (ssoAvailable && isAdmin) msg.hide = true;
activityWs(); activityWs();
if (ws?.readyState === WebSocket.OPEN) { if (ws?.readyState === WebSocket.OPEN) {
@@ -643,9 +707,9 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
} }
function ping({ to, fr = currentPath, read = 0, lang } = {}) { function ping({ to, fr = currentPath, read = 0, lang } = {}) {
// Reading-time updates from the analytics page itself are not tracked // Reading-time updates from the tool pages themselves are not tracked
// (/_a is admin machinery; the server would reject the path anyway). // (admin machinery; the server would reject the path anyway).
if (!to && currentPath === "/_a") return; if (!to && isToolPage(currentPath)) return;
const msg = {}; const msg = {};
if (fr) msg.fr = fr; if (fr) msg.fr = fr;
if (to) msg.to = to; if (to) msg.to = to;
@@ -674,16 +738,34 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
let reading = true; let reading = true;
let readInactivityTimer = null; let readInactivityTimer = null;
let idleTimer = null; let idleTimer = null;
let lastActivityAt = performance.now();
function markReadActivity() { function markReadActivity() {
if (!reading) { const t = performance.now();
if (reading) {
// A gap longer than the inactivity timeout means the cutoff timer
// could not run on time (the computer slept, or the tab was throttled
// hard): close the span at its intended cutoff — the gap itself was
// not reading time, and performance.now() keeps running through sleep
// on some platforms.
const cutoff = lastActivityAt + INACTIVE_MS;
if (t > cutoff) {
readElapsed += Math.max(0, cutoff - readStart);
readStart = t;
}
} else {
reading = true; reading = true;
readStart = performance.now(); readStart = t;
} }
lastActivityAt = t;
clearTimeout(readInactivityTimer); clearTimeout(readInactivityTimer);
// Same sleep guard, other ordering: when this timer itself fires late
// (waking from sleep before any user event), clamp the accumulation to
// its intended fire time.
const stopAt = t + INACTIVE_MS;
readInactivityTimer = setTimeout(() => { readInactivityTimer = setTimeout(() => {
if (reading) { if (reading) {
readElapsed += performance.now() - readStart; readElapsed += Math.max(0, Math.min(performance.now(), stopAt) - readStart);
reading = false; reading = false;
} }
}, INACTIVE_MS); }, INACTIVE_MS);
@@ -746,27 +828,39 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
ping({ to: currentPath, fr: "" }); ping({ to: currentPath, fr: "" });
} }
// --- Analytics page mount/unmount -------------------------------------- // --- Admin tool pages mount/unmount ------------------------------------
// The analytics page is a normal page whose body is rendered by the server // /_a (analytics) is a normal page whose body is rendered by the server
// but whose content is a Vue app. In dev the entry module is imported from // but whose content is a Vue app. In dev the
// the Vite dev server on demand; in production it is inlined into the /_a // entry module is imported from the Vite dev server on demand; in
// page as script#pagerite-js-analytics, which a fetch-navigation swap does // production it is inlined into the page as a script element, which a
// not execute — re-create the element so the fresh module auto-mounts on // fetch-navigation swap does not execute — re-create the element so the
// #analytics-app (see analytics-main.js). The module exposes its unmount // fresh module auto-mounts on its container. Each module exposes its
// as window.__pageriteAnalyticsUnmount. // unmount as a window global (see analytics-main.js).
function teardownAnalytics() { const TOOL_PAGES = {
// Remove even the server-rendered script element so a later return to "/_a": { container: "analytics-app", script: "pagerite-js-analytics",
// /_a re-mounts from a fresh copy (the module has torn itself down). asset: "pagerite:analytics-src", unmount: "__pageriteAnalyticsUnmount" },
document.getElementById("pagerite-js-analytics")?.remove(); };
window.__pageriteAnalyticsUnmount?.();
window.__pageriteAnalyticsUnmount = null; function isToolPage(path) {
return Object.hasOwn(TOOL_PAGES, path || "");
} }
async function mountAnalytics(doc) { function teardownTools() {
if (!doc.getElementById("analytics-app")) return; // Remove even the server-rendered script element so a later return
// Already mounted: on a full /_a load the inline script has run. // re-mounts from a fresh copy (the module has torn itself down).
if (document.getElementById("pagerite-js-analytics")) return; for (const p of Object.values(TOOL_PAGES)) {
const inline = doc.getElementById("pagerite-js-analytics"); document.getElementById(p.script)?.remove();
window[p.unmount]?.();
window[p.unmount] = null;
}
}
async function mountTool(doc) {
const page = Object.values(TOOL_PAGES).find((p) => doc.getElementById(p.container));
if (!page) return;
// Already mounted: on a full page load the inline script has run.
if (document.getElementById(page.script)) return;
const inline = doc.getElementById(page.script);
if (inline) { if (inline) {
const s = document.createElement("script"); const s = document.createElement("script");
for (const a of inline.attributes) s.setAttribute(a.name, a.value); for (const a of inline.attributes) s.setAttribute(a.name, a.value);
@@ -778,11 +872,11 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
// Dev: the cached module auto-mounts only on its first evaluation, // Dev: the cached module auto-mounts only on its first evaluation,
// so call mount() explicitly for repeat visits (it no-ops when the // so call mount() explicitly for repeat visits (it no-ops when the
// app is already up). // app is already up).
const mod = await import(/* @vite-ignore */ assets["pagerite:analytics-src"]); const mod = await import(/* @vite-ignore */ assets[page.asset]);
const container = document.getElementById("analytics-app"); const container = document.getElementById(page.container);
if (container) mod.mount(container); if (container) mod.mount(container);
} catch (e) { } catch (e) {
console.error("analytics mount failed:", e); console.error("tool page mount failed:", e);
} }
} }
@@ -841,6 +935,91 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
ping({ to: currentPath, lang: tag }); ping({ to: currentPath, lang: tag });
}); });
// --- Messaging overlay ---------------------------------------------------
// {contact: Label} directives in articles render .contact-trigger buttons,
// and the corner ✉️ icon (rendered by renderAuthUi for everyone) opens the
// same overlay: the visitor's thread, or the admin inbox for editors
// (docs/messages.md). The bundle (Vue overlay + composer) loads on first
// click and rides the activity socket for realtime thread state — no extra
// connection for visitors. Registration re-sends on every socket
// (re)connect, and the server pushes the thread back as the resync.
let contactMod = null;
let contactToken = "";
let contactListener = null;
let contactPowListener = null;
let contactEmailListener = null;
const contactBridge = {
register(token, onThread, onPow, onEmail) {
contactToken = token;
contactListener = onThread;
contactPowListener = onPow;
contactEmailListener = onEmail;
contactBridge.send({ token });
},
send(msg) {
msg.fr = currentPath;
activityWs();
if (ws?.readyState === WebSocket.OPEN) {
try {
ws.send(JSON.stringify(msg));
return;
} catch { /* fall through to queueing */ }
}
wsQueue.push(msg);
},
};
async function loadContact() {
contactMod ??= await import(/* @vite-ignore */ assets["pagerite:contact-src"]);
for (const css of (assets["pagerite:contact-css"] || "").split(",")) {
if (css && !document.querySelector(`link[href="${css}"]`)) {
const link = document.createElement("link");
link.rel = "stylesheet";
link.href = css;
link.dataset.pagerite = "contact-css";
document.head.append(link);
}
}
return contactMod;
}
async function openContactPanel(opts) {
try {
(await loadContact()).open(contactBridge, opts);
} catch (e) {
console.error("contact panel load failed:", e);
}
}
// Message sessions follow the page load, not the panel: a visitor with
// an open conversation (the bundle's localStorage session flag) resumes
// checking for replies right away — with a granted notification
// permission new replies notify immediately; an admin's inbox watch
// (badge + notifications) runs whenever messaging is enabled.
async function contactAutoStart() {
if (!contactEnabled) return;
const wantAdmin = isAdmin;
const wantResume = !!localStorage.getItem("pagerite-contact-session");
if (!wantAdmin && !wantResume) return;
try {
const mod = await loadContact();
if (wantAdmin) mod.watchAdmin(contactBridge);
if (wantResume) mod.resume(contactBridge);
} catch (e) {
console.error("contact session resume failed:", e);
}
}
addEventListener("click", (ev) => {
const btn = ev.target.closest?.(".contact-trigger");
if (!btn) return;
ev.preventDefault();
// In the editor preview the button is inert.
if (document.body.classList.contains("editing")) return;
// Always the visitor side, even for admins (testing both sides).
openContactPanel({ admin: false });
});
// --- Fetch navigation ------------------------------------------------ // --- Fetch navigation ------------------------------------------------
async function load(url, push = true, back = false) { async function load(url, push = true, back = false) {
// Navigating with the editor open keeps it open: the shell retargets to // Navigating with the editor open keeps it open: the shell retargets to
@@ -851,10 +1030,10 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
// bypassed while editing because the editor may have invalidated the // bypassed while editing because the editor may have invalidated the
// prefetched copies of other pages. // prefetched copies of other pages.
const editing = document.body.classList.contains("editing"); const editing = document.body.classList.contains("editing");
if (editing && new URL(url, location.href).pathname === "/_a") { if (editing && isToolPage(new URL(url, location.href).pathname)) {
await editorModule?.then((m) => m.closeEditor({ navigating: true })); await editorModule?.then((m) => m.closeEditor({ navigating: true }));
} }
teardownAnalytics(); teardownTools();
let doc; let doc;
let finalUrl = url; let finalUrl = url;
const cached = !editing && pageCache.get(cacheKey(url)); const cached = !editing && pageCache.get(cacheKey(url));
@@ -948,8 +1127,11 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
runScripts(document.getElementById("page-banner")); runScripts(document.getElementById("page-banner"));
runScripts(document.getElementById("main")); runScripts(document.getElementById("main"));
applyEffects(); applyEffects();
mountAnalytics(doc); mountTool(doc);
mountLangselect(doc); mountLangselect(doc);
// The swap rebuilt any contact-trigger buttons: re-apply the
// "new reply" dot to the fresh elements.
contactMod?.refreshBadges();
}; };
// Rotating cube page transition (styles injected as #pagerite-transition // Rotating cube page transition (styles injected as #pagerite-transition
// from the selected design's transition.css, e.g. themes/cube/); // from the selected design's transition.css, e.g. themes/cube/);
@@ -1057,7 +1239,7 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
} }
// Machinery and auth endpoints are never fetch-navigated, except the // Machinery and auth endpoints are never fetch-navigated, except the
// public analytics viewer page at /_a. // public analytics viewer page at /_a.
if ((url.pathname.startsWith("/_") && url.pathname !== "/_a") if ((url.pathname.startsWith("/_") && !isToolPage(url.pathname))
|| url.pathname.startsWith("/auth")) return; || url.pathname.startsWith("/auth")) return;
ev.preventDefault(); ev.preventDefault();
// Capture the source now: load() updates currentPath before pinging. // Capture the source now: load() updates currentPath before pinging.
@@ -1177,6 +1359,6 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
setupAuth(); setupAuth();
applyEffects(); applyEffects();
mountAnalytics(document); mountTool(document);
mountLangselect(document); mountLangselect(document);
})(); })();
+35
View File
@@ -10,6 +10,8 @@
// (a few seconds, doubling to half a minute), reset only after a // (a few seconds, doubling to half a minute), reset only after a
// connection stayed open long enough to count as healthy. A socket // connection stayed open long enough to count as healthy. A socket
// that closes right after opening must NOT reset the backoff. // that closes right after opening must NOT reset the backoff.
import { ApiError, NetworkError, apiJson, fetchJson } from 'paskia'
export function reconnectPolicy({ min = 2000, max = 30000, healthyAfter = 30000 } = {}) { export function reconnectPolicy({ min = 2000, max = 30000, healthyAfter = 30000 } = {}) {
let delay = min let delay = min
let openedAt = 0 let openedAt = 0
@@ -54,3 +56,36 @@ export function watchConnecting(ws, label) {
} }
}, 10_000) }, 10_000)
} }
// Auth-aware close handling for the admin sockets (/_api/...). An expired
// session fails the WS handshake exactly like a dead network, but retrying
// the socket loops forever — the WS API cannot open the login dialog. So
// probe /_api first (plain fetchJson, which never pops a dialog) and:
//
// 'retry' — the session is fine or the trouble is a network/server one:
// take the policy's paced backoff.
// 'auth' — the session was gone, so the paskia login flow ran (apiJson
// pops the auth iframe and retries through it) and completed:
// reconnect at once, no backoff.
// 'abort' — the login was declined or the proxy offers no paskia flow:
// stop retrying; the caller decides what its UI does next.
//
// onLogin fires when the login flow starts, so the caller can say so.
export async function authReconnect(onLogin) {
try {
await fetchJson('/_api/settings')
return 'retry'
} catch (e) {
if (!(e instanceof ApiError && (e.status === 401 || e.status === 403))) return 'retry'
}
onLogin?.()
try {
await apiJson('/_api/settings')
return 'auth'
} catch (e) {
return e instanceof NetworkError
|| (e instanceof ApiError && e.status !== 401 && e.status !== 403)
? 'retry'
: 'abort'
}
}
+119
View File
@@ -0,0 +1,119 @@
// Serialize the constrained contenteditable composer DOM to the contact
// message Markdown subset (emphasis, links, lists, code, /_f/ images and
// file chips). The wire format is text: the server re-renders it with a
// strict, html-less MarkdownIt (pagerite/messages.py), so no user markup
// of any kind ever reaches a page. This serializer is for fidelity, not
// safety — anything it does not know is simply unwrapped.
const ESCAPE_RE = /([\\`*_[\]])/g
export function escapeMd(text) {
return text.replace(ESCAPE_RE, '\\$1')
}
// Tags that open a new block at the composer's top level. Everything else
// there — text, B/I/A/SPAN formatting elements, inline images — is an
// inline run and joins the paragraph being accumulated: browsers happily
// put formatting directly under the editable root (a bolded segment of an
// undivided first line is a top-level <b>), and treating those as blocks
// would split the paragraph and drop the formatting.
const BLOCK_TAGS = new Set([
'DIV', 'P', 'UL', 'OL', 'BLOCKQUOTE', 'PRE',
'H1', 'H2', 'H3', 'H4', 'H5', 'H6', 'HR', 'TABLE',
])
// One message's Markdown from the composer root: inline runs become
// paragraphs, block elements become their own blocks, blank lines between.
export function serializeRich(root) {
const blocks = []
let run = []
const flush = () => {
const text = run.join('').trim()
run = []
if (text) blocks.push(text)
}
for (const node of root.childNodes) {
if (node.nodeType === Node.ELEMENT_NODE && BLOCK_TAGS.has(node.tagName)) {
flush()
block(node, blocks)
} else {
run.push(inline(node))
}
}
flush()
return blocks.join('\n\n').replace(/\n{3,}/g, '\n\n').trim()
}
function block(node, out) {
switch (node.tagName) {
case 'UL':
out.push([...node.children].map((li) => `- ${inlineChildren(li).trim()}`).join('\n'))
break
case 'OL':
out.push([...node.children].map((li, i) => `${i + 1}. ${inlineChildren(li).trim()}`).join('\n'))
break
case 'BLOCKQUOTE':
out.push(inlineChildren(node).split('\n').map((l) => `> ${l}`).join('\n'))
break
case 'PRE':
out.push('```\n' + node.textContent + '\n```')
break
case 'HR':
break
default: {
// DIV, P, headings: a paragraph of inline content.
const text = inlineChildren(node).trim()
if (text) out.push(text)
}
}
}
function inlineChildren(node) {
return [...node.childNodes].map(inline).join('')
}
function inline(node) {
if (node.nodeType === Node.TEXT_NODE) return escapeMd(node.textContent)
if (node.nodeType !== Node.ELEMENT_NODE) return ''
switch (node.tagName) {
case 'B':
case 'STRONG':
return `**${inlineChildren(node)}**`
case 'I':
case 'EM':
return `*${inlineChildren(node)}*`
case 'CODE':
return '`' + node.textContent.replace(/\\/g, '\\\\').replace(/`/g, '\\`') + '`'
case 'BR':
return '\n'
case 'A': {
const text = inlineChildren(node)
const href = node.getAttribute('href') || ''
return /^(https?:\/\/|mailto:|\/)/.test(href) ? `[${text}](${href})` : text
}
case 'IMG':
// Uploaded image (data-path set by the composer on insert).
return node.dataset.path ? `![${escapeMd(node.alt || 'image')}](${node.dataset.path})` : ''
case 'SPAN':
// Attachment chip (data-path + data-name); other spans unwrap.
if (node.dataset.path && node.dataset.name) {
return `[📎 ${escapeMd(node.dataset.name)}](${node.dataset.path})`
}
return wrapStyle(node, inlineChildren(node))
default:
return wrapStyle(node, inlineChildren(node))
}
}
// Some browsers style formatting instead of tagging it (Firefox's
// execCommand produces <span style="font-weight: bold">): keep span-level
// bold/italic alive into the Markdown.
function wrapStyle(node, text) {
if (!text.trim()) return text
const s = node.style
if (s) {
if (/bold|bolder|[6-9]00/.test(s.fontWeight)) text = `**${text}**`
if (s.fontStyle === 'italic' || s.fontStyle === 'oblique') text = `*${text}*`
}
return text
}
+2 -1
View File
@@ -16,7 +16,7 @@ const CONTENT_PROXY = '^(?!/_|/@|/src|/node_modules|/__).*$'
// https://vite.dev/config/ // https://vite.dev/config/
export default defineConfig({ export default defineConfig({
plugins: [ plugins: [
fastapiVue({ paths: ["/_api", "/_f", "/_themes", "/_fonts", "/_a", "/_ws", "/_translate"] }), fastapiVue({ paths: ["/_api", "/_f", "/_themes", "/_fonts", "/_a", "/_ws", "/_translate", "/_contact"] }),
vue(), vue(),
vueDevTools(), vueDevTools(),
], ],
@@ -51,6 +51,7 @@ export default defineConfig({
pagerite: fileURLToPath(new URL('./src/pagerite.js', import.meta.url)), pagerite: fileURLToPath(new URL('./src/pagerite.js', import.meta.url)),
analytics: fileURLToPath(new URL('./src/analytics-main.js', import.meta.url)), analytics: fileURLToPath(new URL('./src/analytics-main.js', import.meta.url)),
langselect: fileURLToPath(new URL('./src/langselect-main.js', import.meta.url)), langselect: fileURLToPath(new URL('./src/langselect-main.js', import.meta.url)),
contact: fileURLToPath(new URL('./src/contact-main.js', import.meta.url)),
// Only the base CSS is built; theme/banner-design stylesheets live // Only the base CSS is built; theme/banner-design stylesheets live
// in pagerite/themes/{name}/ and are served by the backend as-is. // in pagerite/themes/{name}/ and are served by the backend as-is.
pagerite_base: fileURLToPath(new URL('./src/assets/pagerite.css', import.meta.url)), pagerite_base: fileURLToPath(new URL('./src/assets/pagerite.css', import.meta.url)),
+55 -1
View File
@@ -5,7 +5,10 @@ to ``Analytics.gets`` as a raw access-log line (path with query string, true
HTTP status, external referer origin, preload flag, rendered content HTTP status, external referer origin, preload flag, rendered content
language) and every pagerite.js activity message from the /_ws WebSocket is language) and every pagerite.js activity message from the /_ws WebSocket is
appended to ``Analytics.msgs`` appended to ``Analytics.msgs``
(navigations ``fr`` -> ``to`` and active reading-time updates). Nothing is (navigations ``fr`` -> ``to`` and active reading-time updates). The
non-document machinery GETs ``/robots.txt`` and ``/sitemap.xml`` are
recorded the same way: never followed by an activity message, they surface
as crawler hits at display time. Nothing is
classified when it is recorded: whether a client turns out to be a reader, classified when it is recorded: whether a client turns out to be a reader,
a crawler or a scanner is decided by ``Store.display()`` from the raw a crawler or a scanner is decided by ``Store.display()`` from the raw
events, so the stored data survives any future change to the classification events, so the stored data survives any future change to the classification
@@ -145,6 +148,10 @@ class Msg(msgspec.Struct, omit_defaults=True):
#: Rendered language reported by the client for the page the activity #: Rendered language reported by the client for the page the activity
#: happened on. #: happened on.
lang: str = "" lang: str = ""
#: Server-originated contact marker (docs/messages.md): the visitor
#: opened the contact panel and solved its proof of work on ``fr``.
#: Never sent by clients — recorded by the /_ws handler.
contact: bool = False
class Client(msgspec.Struct, omit_defaults=True): class Client(msgspec.Struct, omit_defaults=True):
@@ -214,6 +221,9 @@ class TrailItem(msgspec.Struct, omit_defaults=True):
#: page falling back to its GET's rendered language; "" when unknown #: page falling back to its GET's rendered language; "" when unknown
#: (old clients or data from before language recording). #: (old clients or data from before language recording).
lang: str = "" lang: str = ""
#: The visitor opened the contact panel and solved its proof of work
#: on this page (docs/messages.md) — the trail's ✉️ marker.
contact: bool = False
class Visit(msgspec.Struct, omit_defaults=True): class Visit(msgspec.Struct, omit_defaults=True):
@@ -708,6 +718,34 @@ class Store:
self._save() self._save()
return client_hash if new else None return client_hash if new else None
def record_contact(
self, fr: str, ip: str, ua: str, accept_language: str = ""
) -> bytes | None:
"""Append one server-originated contact marker to the raw log: the
visitor opened the contact panel on ``fr`` and solved its proof of
work (docs/messages.md). Recorded by the /_ws handler on a
validated solution — an unsolved panel open leaves no trace.
Display lands the marker on the visit's trail step for ``fr``.
Returns the client hash when the client record was just created (so
the caller can schedule async enrichment), else None.
"""
client_lang, country = _parse_accept_language(accept_language)
client_hash = _client_hash(ip, ua, client_lang)
new = client_hash not in self.data.clients
if new:
self._ensure_client(ip, ua, client_lang, country=country)
self.data.msgs.append(
Msg(
t=datetime.now(UTC),
client=client_hash,
fr=(_internal_path(fr) or "") if fr else "",
contact=True,
)
)
self._save()
return client_hash if new else None
def favicon_origins_needed(self) -> list[str]: def favicon_origins_needed(self) -> list[str]:
"""External https origins seen in the raw events whose favicon needs """External https origins seen in the raw events whose favicon needs
fetching. fetching.
@@ -772,6 +810,9 @@ class Store:
rendered language), and a page re-visited in a different rendered rendered language), and a page re-visited in a different rendered
language becomes a distinct trail step. The entry referer and language becomes a distinct trail step. The entry referer and
UTM tags come from the GET that loaded the entry page. UTM tags come from the GET that loaded the entry page.
Server-originated contact markers (the contact panel's proof of
work solved, docs/messages.md) flag the trail step they happened
on — the first one per visit.
Hidden (admin) clients are excluded from every list and aggregate. Hidden (admin) clients are excluded from every list and aggregate.
``multilingual`` and ``primary_lang`` are site context (translation ``multilingual`` and ``primary_lang`` are site context (translation
@@ -868,6 +909,19 @@ class Store:
visit: Visit | None = None visit: Visit | None = None
last_t: datetime | None = None last_t: datetime | None = None
for m in msgs: for m in msgs:
if m.contact:
# Contact PoW proven (docs/messages.md): mark the trail
# step it happened on — the first one per visit only.
if visit is not None and not any(
item.contact for item in visit.trail.values()
):
want = m.fr or visit.entry
for item in visit.trail.values():
if item.to == want:
item.contact = True
break
last_t = m.t
continue
if m.to: if m.to:
if visit is None or ( if visit is None or (
last_t is not None and m.t - last_t > _SESSION_GAP last_t is not None and m.t - last_t > _SESSION_GAP
+128 -28
View File
@@ -23,8 +23,8 @@ from fastapi import (
from html5tagger import E from html5tagger import E
from pydantic import BaseModel from pydantic import BaseModel
from pagerite import i18n, views from pagerite import i18n, messages, views
from pagerite.chunks import store_chunks from pagerite.chunks import chunk_key, store_chunks
from pagerite.data import ( from pagerite.data import (
Node, Node,
append_order, append_order,
@@ -65,6 +65,10 @@ async def list_pages(lang: str | None = None) -> list[dict]:
Nested by slug; each node carries its full path, menu order, flags and Nested by slug; each node carries its full path, menu order, flags and
language settings (``language`` is the node's own primary-language language settings (``language`` is the node's own primary-language
setting, "" = inherit; ``primary`` is the resolved effective one). setting, "" = inherit; ``primary`` is the resolved effective one).
``has_content`` tells whether a landing page exists at all (even an
empty one — the structure editor offers deleting it); ``empty`` is the
navigation's notion: no content of its own (None or empty markdown),
so nav links bypass the node to its first child page.
With a ``?lang=`` translation, titles come out in that language where a With a ``?lang=`` translation, titles come out in that language where a
translation exists (``translated`` flags it — true trivially for rows translation exists (``translated`` flags it — true trivially for rows
whose primary language IS the selected one; other rows fall back to whose primary language IS the selected one; other rows fall back to
@@ -88,6 +92,10 @@ async def list_pages(lang: str | None = None) -> list[dict]:
"order": node.order, "order": node.order,
"published": node.published, "published": node.published,
"has_content": node.chunks is not None, "has_content": node.chunks is not None,
# No content of its own (None or empty markdown): the
# navigation bypasses the node, linking its first child
# page instead (views nav_html/first_leaf).
"empty": not node.chunks,
"language": node.language, "language": node.language,
"primary": primary, "primary": primary,
"children": dump(node.children, path, primary), "children": dump(node.children, path, primary),
@@ -268,12 +276,18 @@ async def update_structure(op: StructureOp, request: Request) -> None:
@router.get("/_api/settings") @router.get("/_api/settings")
async def get_settings() -> dict: async def get_settings(lang: str | None = None) -> dict:
"""Site-wide settings (brand, theme, custom CSS and favicon URL), plus """Site-wide settings (brand, theme, custom CSS and favicon URL), plus
the themes, banner designs and user fonts available on disk for the the themes, banner designs and user fonts available on disk for the
selectors, the translator service keys and the wanted translation selectors, the translator service keys and the wanted translation
languages (for the /_translate socket).""" languages (for the /_translate socket), and the contact-messaging
return { configuration.
With a ``?lang=`` translation language the contact label/subject also
come out as ``*_tr`` (their per-language override, "" = none — the
site settings' messaging section edits those, falling back to the
original it edits without the query)."""
out = {
"brand": data.brand, "brand": data.brand,
"brand_html": data.brand_html, "brand_html": data.brand_html,
"theme": data.theme, "theme": data.theme,
@@ -285,11 +299,27 @@ async def get_settings() -> dict:
"transition": data.transition, "transition": data.transition,
"transitions": views._transition_names(), "transitions": views._transition_names(),
"translate_keys": data.translate_keys, "translate_keys": data.translate_keys,
# Unanswered contact threads: the corner ✉️ icon's badge for
# admins (this probe runs on every page load; no polling).
"contact_unread": messages.unread_count(),
# Messaging is enabled by configuring a label (empty = off).
"contact_label": data.contact_label,
"contact_email": data.contact_email,
"contact_subject": data.contact_subject,
"contact_mailserver": data.contact_mailserver,
# The site default primary language: the front page's resolved # The site default primary language: the front page's resolved
# setting (every page may override it, inherited down the tree). # setting (every page may override it, inherited down the tree).
"primary_lang": i18n.primary_lang(data.menu, ""), "primary_lang": i18n.primary_lang(data.menu, ""),
"translate_langs": sorted(data.translate_langs), "translate_langs": sorted(data.translate_langs),
} }
tag = i18n.base_tag(lang or "")
if tag and tag != out["primary_lang"]:
for field in ("contact_label", "contact_subject"):
original = getattr(data, field)
out[f"{field}_tr"] = (
data.trans.get(chunk_key(original), {}).get(tag, "") if original else ""
)
return out
class SettingsIn(BaseModel): class SettingsIn(BaseModel):
@@ -302,17 +332,54 @@ class SettingsIn(BaseModel):
transition: str = "cube" transition: str = "cube"
translate_langs: list[str] | None = None # None keeps the current set translate_langs: list[str] | None = None # None keeps the current set
translate_keys: dict[str, str] | None = None # None keeps the current keys translate_keys: dict[str, str] | None = None # None keeps the current keys
contact_label: str | None = None
contact_email: str | None = None
contact_subject: str | None = None
contact_mailserver: str | None = None
@router.put("/_api/settings", status_code=204) @router.put("/_api/settings", status_code=204)
async def put_settings(settings: SettingsIn, request: Request) -> None: async def put_settings(
"""Update site-wide settings; invalidates cached pages and ETags.""" settings: SettingsIn, request: Request, lang: str | None = None
) -> None:
"""Update site-wide settings; invalidates cached pages and ETags.
With a ``?lang=`` translation language only the contact label/subject
apply — as per-language overrides in the chunk-keyed trans store, the
same storage machine translations use (i18n.set_string_translation);
empty or the original's text drops the override."""
tag = i18n.base_tag(lang or "")
if tag and tag != i18n.primary_lang(data.menu, ""):
with kanta.transaction(
f"settings:{tag}", user=request.headers.get("remote-user")
):
changed = False
for field in ("contact_label", "contact_subject"):
value = getattr(settings, field)
if value is None:
continue
original = getattr(data, field)
if original:
changed |= i18n.set_string_translation(
data, tag, original, value.strip()
)
if changed:
_invalidate_pages()
return
with kanta.transaction("settings", user=request.headers.get("remote-user")): with kanta.transaction("settings", user=request.headers.get("remote-user")):
data.brand = settings.brand data.brand = settings.brand
data.brand_html = settings.brand_html data.brand_html = settings.brand_html
data.theme = settings.theme data.theme = settings.theme
data.custom_css = settings.custom_css data.custom_css = settings.custom_css
data.transition = settings.transition data.transition = settings.transition
if settings.contact_label is not None:
data.contact_label = settings.contact_label.strip()
if settings.contact_email is not None:
data.contact_email = settings.contact_email.strip()
if settings.contact_subject is not None:
data.contact_subject = settings.contact_subject.strip()
if settings.contact_mailserver is not None:
data.contact_mailserver = settings.contact_mailserver.strip()
if settings.translate_langs is not None: if settings.translate_langs is not None:
# Any language may be a target — including the site default # Any language may be a target — including the site default
# (an article in another language can be translated INTO it); # (an article in another language can be translated INTO it);
@@ -407,8 +474,8 @@ async def editor_ws(ws: WebSocket) -> None:
-> {"type": "doc", "path", "exists", "title", "markdown", "published", -> {"type": "doc", "path", "exists", "title", "markdown", "published",
"banner", "banner_design", "banner_from", "banner_design_from", "banner", "banner_design", "banner_from", "banner_design_from",
"banner_design_inherited", "description", "image", "image_resolved", "banner_design_inherited", "description", "image", "image_resolved",
"image_mined", "image_source", "has_children", "large", "lang", "image_mined", "image_source", "favicon", "has_children", "large",
"primary_lang", "langs", "lang", "primary_lang", "langs",
"translate_langs"} "translate_langs"}
<- {"type": "render", "path", "markdown"} <- {"type": "render", "path", "markdown"}
-> {"type": "html", "path", "html"} -> {"type": "html", "path", "html"}
@@ -416,7 +483,8 @@ async def editor_ws(ws: WebSocket) -> None:
"banner"?, "banner_design"?, "image"?, "large"?, "move_from"?, "banner"?, "banner_design"?, "image"?, "large"?, "move_from"?,
"lang"?, "base"?} "lang"?, "base"?}
(absent fields keep their old values; move_from: rename/move a (absent fields keep their old values; move_from: rename/move a
page, subtree included) page, subtree included; image: a store hash, "@favicon", "" to
inherit, or an http(s) URL the server fetches and stores)
-> {"type": "saved", "path"} | {"type": "error", "detail"} -> {"type": "saved", "path"} | {"type": "error", "detail"}
With "lang" (a translation, not the primary language), open returns the With "lang" (a translation, not the primary language), open returns the
@@ -458,11 +526,13 @@ async def editor_ws(ws: WebSocket) -> None:
# original (docs/localization.md editor flow). # original (docs/localization.md editor flow).
markdown = i18n.hybrid_markdown(data, node, path, lang) markdown = i18n.hybrid_markdown(data, node, path, lang)
title = i18n.title_map(data, lang).get(path) or title title = i18n.title_map(data, lang).get(path) or title
# The node's card image: its own setting ("" = inherit), # The node's card image: its own setting ("" = inherit,
# the effective one after inheritance ("" = none) and # "@favicon" = the site icon), the effective one after
# inheritance ("" = none, resolved to a store name) and
# which node supplied an inherited one ("" = front page; # which node supplied an inherited one ("" = front page;
# "" also when own/none — mirrors banner_from). # "" also when own/none — mirrors banner_from).
img, img_source = views.card_image(data.menu, path) img, img_source = views.card_image(data.menu, path)
img = views._resolve_image_name(data, img)
# The card preview's description and mined image, # The card preview's description and mined image,
# from the same rendered-article heuristics as the # from the same rendered-article heuristics as the
# og:/twitter: meta (_description, _media). # og:/twitter: meta (_description, _media).
@@ -503,9 +573,13 @@ async def editor_ws(ws: WebSocket) -> None:
# /<path>/*"): the subtree inherits it. # /<path>/*"): the subtree inherits it.
"has_children": bool(node.children) if node else False, "has_children": bool(node.children) if node else False,
"image_resolved": img, "image_resolved": img,
# The site icon ("" = none): the "@favicon" own
# setting previews/resolves against it.
"favicon": data.favicon,
# The image the og:/twitter: heuristics would mine # The image the og:/twitter: heuristics would mine
# from the article itself ("" = none): the previews # from the article itself ("" = none): the previews
# show it when no node image resolves. # show it when the node has no image of its own
# (it beats an inherited one).
"image_mined": img_mined, "image_mined": img_mined,
"image_source": ( "image_source": (
"" if node is None or node.image else img_source "" if node is None or node.image else img_source
@@ -529,11 +603,26 @@ async def editor_ws(ws: WebSocket) -> None:
markdown = msg.get("markdown", "") markdown = msg.get("markdown", "")
chain = resolve(data.menu, path) chain = resolve(data.menu, path)
node = chain[-1] if chain else None node = chain[-1] if chain else None
# Expand {cards} like page_content does, so the preview
# shows real cards, not the literal tag. No translation
# context: the preview has no lang of its own, so cards
# render in their originals.
has_cards_tag = views._CARDS_TAG_RE.search(markdown) is not None has_cards_tag = views._CARDS_TAG_RE.search(markdown) is not None
# {contact} buttons preview like the served page: inert,
# and nothing at all when messaging is disabled (no
# configured label). {cards} expands like page_content
# does, so the preview shows real cards, not the literal
# tag. No translation context: the preview has no lang of
# its own, so cards render in their originals.
directives: dict = {
"contact": (
(lambda args, _env: views._contact_tag(args, _env, data))
if data.contact_label.strip()
else (lambda _args, _env: "")
)
}
if node is not None and has_cards_tag:
directives["cards"] = (
lambda args, _env, node=node, path=path: views._cards_tag(
data.menu, data, node, path, args
)
)
rendered = render( rendered = render(
markdown, markdown,
path, path,
@@ -550,15 +639,7 @@ async def editor_ws(ws: WebSocket) -> None:
if node if node
else None else None
), ),
directives=( directives=directives,
{
"cards": lambda args, _env, node=node, path=path: (
views._cards_tag(data.menu, data, node, path, args)
)
}
if node is not None and has_cards_tag
else None
),
) )
html = rendered.html html = rendered.html
if node is not None and not has_cards_tag: if node is not None and not has_cards_tag:
@@ -655,9 +736,28 @@ async def editor_ws(ws: WebSocket) -> None:
image = msg.get("image") image = msg.get("image")
if image is not None: if image is not None:
# Card-image setting (inherited by the subtree): a # Card-image setting (inherited by the subtree): a
# 12-hex content-addressed store name, "" = inherit. # 12-hex content-addressed store name, "@favicon" =
# the site icon, "" = inherit, or an http(s) URL —
# pasted image links are fetched and stored
# server-side (cross-origin is CORS-blocked for the
# browser), the stored name becomes the setting.
image = str(image).strip() image = str(image).strip()
if image and not re.fullmatch(r"[0-9a-f]{12}", image): if image.startswith(("http://", "https://")):
from pagerite.files import fetch_image
try:
# Bare hash name, like an upload's setting.
image = (await fetch_image(image)).split(".")[0]
except HTTPException as e:
await ws.send_json(
{"type": "error", "detail": str(e.detail)}
)
continue
if (
image
and image != "@favicon"
and not re.fullmatch(r"[0-9a-f]{12}", image)
):
await ws.send_json( await ws.send_json(
{ {
"type": "error", "type": "error",
+9 -2
View File
@@ -11,6 +11,11 @@ The routes live in specialized modules, included below as APIRouters:
(``/_api/*``, ``/_translate/{clientkey}``). (``/_api/*``, ``/_translate/{clientkey}``).
- ``pagerite.tracking`` — visit analytics (``/_ws``, ``/_api/ws/analytics``, - ``pagerite.tracking`` — visit analytics (``/_ws``, ``/_api/ws/analytics``,
the ``/_a`` viewer page). the ``/_a`` viewer page).
- ``pagerite.messages`` — visitor contact threads (docs/messages.md): the
``/_contact/files`` upload route; the messaging protocol itself rides
the tracking sockets.
- ``pagerite.feeds`` — machine-readable site exports: ``/llms.txt``,
``/feed.json`` (JSON Feed) and ``/feed.xml`` (RSS).
- ``pagerite.pages`` — the public content pages: ``/``, ``/sitemap.xml``, - ``pagerite.pages`` — the public content pages: ``/``, ``/sitemap.xml``,
``/robots.txt`` and the ``/{path:path}`` catch-all. ``/robots.txt`` and the ``/{path:path}`` catch-all.
@@ -39,7 +44,7 @@ from fastapi.responses import Response
from fastapi_vue import Frontend, env from fastapi_vue import Frontend, env
from starlette.types import ASGIApp, Receive, Scope, Send from starlette.types import ASGIApp, Receive, Scope, Send
from pagerite import api, files, pages, tracking from pagerite import api, feeds, files, messages, pages, tracking
from pagerite.files import file_store from pagerite.files import file_store
from pagerite.state import analytics_store, config, kanta from pagerite.state import analytics_store, config, kanta
@@ -117,9 +122,10 @@ async def _headers(request: Request, call_next) -> Response:
# Our own routes first: the editor API and translator socket, the analytics # Our own routes first: the editor API and translator socket, the analytics
# machinery, and the file store/user assets. # machinery, the contact-message upload route, and the file store/user assets.
app.include_router(api.router) app.include_router(api.router)
app.include_router(tracking.router) app.include_router(tracking.router)
app.include_router(messages.router)
app.include_router(files.router) app.include_router(files.router)
# Vue build asset routes are inserted at this position during load(): the # Vue build asset routes are inserted at this position during load(): the
@@ -128,4 +134,5 @@ frontend.route(app, "/")
# The content catch-all goes last: built assets win over content slugs, # The content catch-all goes last: built assets win over content slugs,
# anything unmatched falls through to content (and 404). # anything unmatched falls through to content (and 404).
app.include_router(feeds.router)
app.include_router(pages.router) app.include_router(pages.router)
+68 -1
View File
@@ -50,6 +50,50 @@ class LangEdits(msgspec.Struct, omit_defaults=True):
adds: dict[str, str] = {} adds: dict[str, str] = {}
class ContactMessage(msgspec.Struct, omit_defaults=True):
"""One message in a visitor contact thread (docs/messages.md).
``md`` is the Markdown-subset source serialized by the composer;
``html`` its rendering by the strict parser in pagerite.messages
(html=False — no user markup ever reaches a page, only markdown-it
output from the constrained grammar). Both are stored: the source for
future edits/moderation, the rendering so panels inject it verbatim.
"""
t: datetime
#: Markdown-subset source.
md: str = ""
#: Strict server-side rendering of ``md``.
html: str = ""
#: Author: "" = the visitor, otherwise the admin's SSO remote-user.
admin: str = ""
#: Page path the message was sent from ("" for admin replies).
page: str = ""
class ContactThread(msgspec.Struct, omit_defaults=True):
"""One visitor's message thread, keyed in Data.contact by token hash.
Messages are keyed (never a list) by a sortable timestamp-random id so
a save's database diff touches only the appended message.
"""
created: datetime
messages: dict[str, ContactMessage] = {}
#: When an admin last looked at the thread; visitor messages newer
#: than this are unread in the admin inbox.
admin_read: datetime | None = None
#: The visitor's self-entered identity (name required, email optional
#: and unvalidated), captured with their first message and fixed
#: afterwards ("" until then).
name: str = ""
email: str = ""
#: The visitor closed the conversation (their next message starts a
#: fresh thread under a new token); archived in the admin inbox,
#: excluded from the unread count.
closed: bool = False
class Node(msgspec.Struct, omit_defaults=True): class Node(msgspec.Struct, omit_defaults=True):
"""One item of the site hierarchy. """One item of the site hierarchy.
@@ -93,7 +137,9 @@ class Node(msgspec.Struct, omit_defaults=True):
#: Content-addressed card image name (served at "/_f/{name}") for #: Content-addressed card image name (served at "/_f/{name}") for
#: og:image/twitter:image and card covers. "" inherits the nearest #: og:image/twitter:image and card covers. "" inherits the nearest
#: ancestor's image, the front page last; unset everywhere falls back #: ancestor's image, the front page last; unset everywhere falls back
#: to mining the rendered article. #: to mining the rendered article (which beats an inherited image).
#: "@favicon" resolves to the site icon (Data.favicon) at render time,
#: following favicon changes.
image: str = "" image: str = ""
#: Card-mode override (site cards + twitter:card): None = pick #: Card-mode override (site cards + twitter:card): None = pick
#: automatically from the card image's dimensions, False forces a #: automatically from the card image's dimensions, False forces a
@@ -165,6 +211,27 @@ class Data(msgspec.Struct):
#: path -> lang -> LangEdits (paths without leading slash). Replaces #: path -> lang -> LangEdits (paths without leading slash). Replaces
#: the old "patches" key (ignored on decode, discarding that data). #: the old "patches" key (ignored on decode, discarding that data).
overrides: dict[str, dict[str, LangEdits]] = {} overrides: dict[str, dict[str, LangEdits]] = {}
#: Visitor contact threads (docs/messages.md), keyed by the blake3
#: hash of the visitor's session token (never the token itself).
contact: dict[bytes, ContactThread] = {}
#: The {contact:} button label and visitor dialog title — and the
#: feature's on/off switch: EMPTY disables messaging (no buttons, no
#: visitor corner icon, sends rejected; admins keep the inbox). A
#: per-button {contact: Label} arg overrides it. Translated per
#: language in Data.trans, keyed by chunk hash like titles
#: (i18n.site_string).
contact_label: str = ""
#: Contact email shown as a mailto link in the visitor dialog (with
#: the subject prefilled), revealed over the socket only after the
#: proof of work is solved. Empty = no link.
contact_email: str = ""
#: Subject for the mailto link; empty = the (localized) label.
#: Translated like contact_label.
contact_subject: str = ""
#: Mail server for email notifications (docs/messages.md): a mailbridge
#: URL — a bare host[:port] or smtp://user:pass@host:port for plain
#: SMTP, or a backend URL like sendgrid:API-KEY. Empty = no email.
contact_mailserver: str = ""
def node_markdown(data: Data, node: Node) -> str | None: def node_markdown(data: Data, node: Node) -> str | None:
+183
View File
@@ -0,0 +1,183 @@
"""Machine-readable site exports: /llms.txt, /feed.json and /feed.xml.
- ``/llms.txt`` (llmstxt.org convention): a Markdown map of the site for
LLM agents — the brand as title, then every published article as a link
to its ``.md`` Markdown counterpart (pages.show_page) with a short
excerpt.
- ``/feed.json``: JSON Feed 1.1 of all published articles, full content.
- ``/feed.xml``: the same as RSS 2.0 (with an atom:link self reference)
for older feed readers.
All three are linked from every page's <head> (see views._layout) and from
the sitemap, recorded in analytics like page GETs (they surface as crawler
hits — no activity message ever follows them), and rendered in the site's
primary language only (feeds have no per-language negotiation here).
Rendering every article is expensive, so bodies are cached in RAM keyed by
the public base URL and cleared by ``state._invalidate_pages`` on any
content/settings write — the same hook that drops the page render cache.
Each response also carries a content-hash ETag and answers 304, so polling
feed readers revalidate cheaply.
"""
import blake3
import json
from datetime import UTC
from email.utils import format_datetime
from functools import lru_cache
from xml.sax.saxutils import escape as xml_escape
from fastapi import APIRouter, Request
from fastapi.responses import Response
from pagerite.data import Node, node_markdown, sorted_nodes
from pagerite.markdown import make_md
from pagerite.state import SITE_URL, data
from pagerite.tracking import _record_get
from pagerite.views import _description
router = APIRouter()
_md = make_md()
def _articles() -> list[tuple[str, Node]]:
"""All published content pages in menu order: (path, node)."""
out: list[tuple[str, Node]] = []
def walk(nodes: dict[str, Node], prefix: str) -> None:
for slug, node in sorted_nodes(nodes):
path = f"{prefix}/{slug}" if prefix else slug
if node.published and node.chunks is not None:
out.append((path, node))
if node.children:
walk(node.children, path)
walk(data.menu, "")
return out
def _body_html(node: Node, base: str) -> str:
"""Full article HTML for feed content, with relative URLs absolutized.
Rendered without the layout segmentation of page rendering (colseg
wrappers are meaningless in a feed reader); the item title carries the
page title, so no implicit h1 is injected either.
"""
html = _md.render(node_markdown(data, node) or "")
return html.replace('src="/', f'src="{base}/').replace('href="/', f'href="{base}/')
def _rfc822(node: Node) -> str:
return format_datetime(node.modified.astimezone(UTC), usegmt=True)
def _iso(node: Node) -> str:
return node.modified.astimezone(UTC).replace(microsecond=0).isoformat()
def _render_llms(base: str) -> str:
lines = [f"# {data.brand}", "", "## Pages", ""]
for path, node in _articles():
url = f"{base}/{path}.md" if path else f"{base}/.md"
excerpt = _description(_body_html(node, base), 120)
suffix = f": {excerpt}" if excerpt else ""
lines.append(f"- [{node.title or path}]({url}){suffix}")
return "\n".join(lines) + "\n"
def _render_feed_json(base: str) -> str:
items = [
{
"id": (url := f"{base}/{path}" if path else base),
"url": url,
"title": node.title or path,
"content_html": _body_html(node, base),
"date_published": node.created.astimezone(UTC)
.replace(microsecond=0)
.isoformat(),
"date_modified": _iso(node),
}
for path, node in _articles()
]
feed = {
"version": "https://jsonfeed.org/version/1.1",
"title": data.brand,
"home_page_url": base,
"feed_url": f"{base}/feed.json",
"items": items,
}
return json.dumps(feed, ensure_ascii=False, indent=1)
def _render_feed_xml(base: str) -> str:
items = []
for path, node in _articles():
url = f"{base}/{path}" if path else base
items.append(
f"<item><title>{xml_escape(node.title or path)}</title>"
f"<link>{xml_escape(url)}</link>"
f'<guid isPermaLink="true">{xml_escape(url)}</guid>'
f"<pubDate>{_rfc822(node)}</pubDate>"
f"<description><![CDATA[{_body_html(node, base)}]]></description>"
f"</item>"
)
return (
'<?xml version="1.0" encoding="UTF-8"?>'
'<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">'
f"<channel><title>{xml_escape(data.brand)}</title>"
f"<link>{xml_escape(base)}</link>"
f"<description>{xml_escape(data.brand)}</description>"
f'<atom:link href="{xml_escape(base)}/feed.xml" rel="self" type="application/rss+xml" />'
+ "".join(items)
+ "</channel></rss>"
)
#: Export body builders by route path.
_RENDERERS = {
"/llms.txt": (_render_llms, "text/plain"),
"/feed.json": (_render_feed_json, "application/feed+json"),
"/feed.xml": (_render_feed_xml, "application/rss+xml"),
}
@lru_cache(maxsize=12)
def _cached_feed(path: str, base_url: str) -> str:
"""Rendered export body; cleared by ``state._invalidate_pages`` on any
content/settings write. base_url is part of the key because the bodies
bake absolute URLs into every link, image and guid."""
return _RENDERERS[path][0](base_url)
def _feed_response(request: Request, path: str) -> Response:
"""Cached export response with a content-hash ETag (304 on match), so
polling feed readers revalidate without a rerender or a download."""
base = SITE_URL or str(request.base_url).rstrip("/")
body = _cached_feed(path, base)
headers = {"cache-control": "no-cache"}
tag = f'"{blake3.blake3(body.encode()).hexdigest()[:32]}"'
headers["etag"] = tag
if request.headers.get("if-none-match") == tag:
return Response(status_code=304, headers=headers)
_record_get(request)
return Response(body, media_type=_RENDERERS[path][1], headers=headers)
@router.get("/llms.txt")
async def llms_txt(request: Request) -> Response:
"""Markdown map of the site for LLM agents (llmstxt.org)."""
return _feed_response(request, "/llms.txt")
@router.get("/feed.json")
async def feed_json(request: Request) -> Response:
"""JSON Feed 1.1 of all published articles, full content."""
return _feed_response(request, "/feed.json")
@router.get("/feed.xml")
async def feed_xml(request: Request) -> Response:
"""RSS 2.0 of all published articles (full content in CDATA), with an
atom:link self reference."""
return _feed_response(request, "/feed.xml")
+99 -19
View File
@@ -8,7 +8,11 @@ images and SVGs are recompressed into AVIF/WebP/JPEG derivatives
``<hash>.orig<ext>`` (never served). Routes: upload/delete under ``<hash>.orig<ext>`` (never served). Routes: upload/delete under
``/_api/files``, the favicon settings endpoints, the /favicon.ico ``/_api/files``, the favicon settings endpoints, the /favicon.ico
redirect to the configured icon, the ``/_f/`` server with redirect to the configured icon, the ``/_f/`` server with
Accept-negotiated formats, and the user assets (``/_themes/``, ``/_fonts/``). Accept-negotiated formats (``/_f/{name}/{filename}`` serves ``{name}.file``
attachment blobs), and the user assets (``/_themes/``, ``/_fonts/``).
All ``/_f/`` responses are forced downloads (``content-disposition:
attachment`` — ignored by <img>/<video> subresource fetches) with
``nosniff``.
""" """
import asyncio import asyncio
@@ -17,8 +21,10 @@ import mimetypes
import tempfile import tempfile
from contextlib import suppress from contextlib import suppress
from pathlib import Path from pathlib import Path
from urllib.parse import urlsplit
import blake3 import blake3
import httpx
from fastapi import APIRouter, HTTPException, Request from fastapi import APIRouter, HTTPException, Request
from fastapi.responses import RedirectResponse, Response from fastapi.responses import RedirectResponse, Response
from mediapreview import dispatch from mediapreview import dispatch
@@ -213,6 +219,48 @@ def store_image(
return digest return digest
def store_attachment(body: bytes) -> str:
"""Store a non-media upload as an inert ``<hash>.file`` blob.
The original extension is deliberately dropped on disk (a stored
``.exe``/``.html`` could otherwise be accidentally run from the
filesystem); the original name lives only in the serving URL
(``/_f/{hash}/{name}``), and ``.file`` blobs are served nowhere
else. Returns the store name.
"""
name = blake3.blake3(body).hexdigest()[:12] + ".file"
file_store.put(name, body)
return name
#: Pasted-URL image fetches (fetch_image) refuse bodies over this size.
FETCH_MAXSIZE = 20 * 1024 * 1024
async def fetch_image(url: str) -> str:
"""Fetch an image URL and store it like an upload (store_image's
derivative pipeline), returning the stored file name.
Server-side because arbitrary cross-origin URLs are CORS-blocked for
the browser; used by the editor socket when a card-image setting
arrives as a URL (paste). 415 for non-images, 413 over FETCH_MAXSIZE,
502 when the fetch itself fails.
"""
try:
async with httpx.AsyncClient(follow_redirects=True, timeout=15) as client:
r = await client.get(url)
r.raise_for_status()
except httpx.HTTPError as e:
raise HTTPException(502, f"image fetch failed: {e}") from e
ctype = r.headers.get("content-type", "").split(";")[0].strip().lower()
if not ctype.startswith("image/"):
raise HTTPException(415, "the URL is not an image")
if len(r.content) > FETCH_MAXSIZE:
raise HTTPException(413, "image too large")
ext = _ext(Path(urlsplit(url).path).name) or mimetypes.guess_extension(ctype) or ""
return await asyncio.to_thread(store_image, r.content, ext, derive=ext != ".gif")
@router.put("/_api/files/{name}") @router.put("/_api/files/{name}")
async def upload_file(name: str, request: Request) -> dict[str, str]: async def upload_file(name: str, request: Request) -> dict[str, str]:
"""Store an upload (image, video...) in the content-addressed store. """Store an upload (image, video...) in the content-addressed store.
@@ -339,6 +387,20 @@ async def user_font_file(name: str, filename: str, request: Request) -> Response
@router.get("/_f/{name}") @router.get("/_f/{name}")
async def stored_file(name: str, request: Request) -> Response: async def stored_file(name: str, request: Request) -> Response:
return _stored_response(name, request)
@router.get("/_f/{name}/{filename}")
async def stored_file_download(name: str, filename: str, request: Request) -> Response:
"""The attachment URL shape. ``{name}`` identifies a ``{name}.file``
blob (inert on disk, never served without the filename segment);
``{filename}`` is the original upload name and lives only in this
URL — the browser names the download after the last path segment.
"""
return _stored_response(name, request, attachment=True)
def _stored_response(name: str, request: Request, *, attachment: bool = False) -> Response:
"""Serve a file from the content-addressed store (immutable: the name """Serve a file from the content-addressed store (immutable: the name
is its own hash, so cache forever). Bodies are served from the RAM is its own hash, so cache forever). Bodies are served from the RAM
cache, zstd-compressed when the client accepts it and compression cache, zstd-compressed when the client accepts it and compression
@@ -349,33 +411,51 @@ async def stored_file(name: str, request: Request) -> Response:
only when the Accept header lists it explicitly — ``image/avif`` → only when the Accept header lists it explicitly — ``image/avif`` →
AVIF, ``image/webp`` → WebP, anything else (including ``image/*`` and AVIF, ``image/webp`` → WebP, anything else (including ``image/*`` and
``*/*``) → JPEG. An explicit extension pins the format. ``.orig.`` ``*/*``) → JPEG. An explicit extension pins the format. ``.orig.``
originals are internal (they may carry EXIF data) and never served.""" originals are internal (they may carry EXIF data) and never served,
and ``.file`` attachment blobs are only served through the
filename-carrying URL (stored_file_download), never by hash.
Every response is ``content-disposition: attachment`` with
``nosniff``: subresource fetches (<img>, <video>, favicons) ignore
the disposition, but a direct navigation always downloads and the
body is never sniffed into something executable in this origin."""
if ".orig." in name: if ".orig." in name:
raise HTTPException(404) raise HTTPException(404)
etag = name etag = name
vary = "" vary = ""
entry = file_store.get(name) if attachment:
if entry is None and "." not in name: etag = f"{name}.file"
# Extension-less image link: negotiate avif/webp/jpg by Accept. entry = file_store.get(etag)
vary = "accept" else:
accept = request.headers.get("accept", "") if name.endswith(".file"):
if "image/avif" in accept: raise HTTPException(404)
order = ("avif", "webp", "jpg") entry = file_store.get(name)
elif "image/webp" in accept: if entry is None and "." not in name:
order = ("webp", "jpg", "avif") # Extension-less image link: negotiate avif/webp/jpg by Accept.
else: vary = "accept"
order = ("jpg", "webp", "avif") accept = request.headers.get("accept", "")
for ext in order: if "image/avif" in accept:
etag = f"{name}.{ext}" order = ("avif", "webp", "jpg")
entry = file_store.get(etag) elif "image/webp" in accept:
if entry is not None: order = ("webp", "jpg", "avif")
break else:
order = ("jpg", "webp", "avif")
for ext in order:
etag = f"{name}.{ext}"
entry = file_store.get(etag)
if entry is not None:
break
if entry is None: if entry is None:
raise HTTPException(404) raise HTTPException(404)
if request.headers.get("if-none-match") == etag: if request.headers.get("if-none-match") == etag:
return Response(status_code=304) return Response(status_code=304)
body, compressed = entry body, compressed = entry
headers = {"etag": etag, "cache-control": "public, max-age=31536000, immutable"} headers = {
"etag": etag,
"cache-control": "public, max-age=31536000, immutable",
"content-disposition": "attachment",
"x-content-type-options": "nosniff",
}
if compressed is not None and "zstd" in request.headers.get("accept-encoding", ""): if compressed is not None and "zstd" in request.headers.get("accept-encoding", ""):
headers["content-encoding"] = "zstd" headers["content-encoding"] = "zstd"
vary = f"{vary}, accept-encoding".lstrip(", ") vary = f"{vary}, accept-encoding".lstrip(", ")
+33 -1
View File
@@ -102,7 +102,9 @@ def select_language(
return original return original
def hybrid_items(data: Data, node: Node, path: str, lang: str) -> list[tuple[bytes | None, str]]: def hybrid_items(
data: Data, node: Node, path: str, lang: str
) -> list[tuple[bytes | None, str]]:
"""The served hybrid as (anchor, block text) pairs: the anchor is the """The served hybrid as (anchor, block text) pairs: the anchor is the
ORIGINAL chunk hash behind the block (None for translation-only ORIGINAL chunk hash behind the block (None for translation-only
addition blocks), in article order. addition blocks), in article order.
@@ -405,6 +407,36 @@ def set_title_translation(data: Data, node: Node, lang: str, title: str) -> bool
return True return True
def site_string(data: Data, lang: str, text: str) -> str:
"""A site-level settings string (not article content — the contact
label/subject) in ``lang``: its translation from the trans store,
chunk-keyed like titles (the translator service picks these up via
pending_items), falling back to the original. The site default
language always gets the original."""
if not text or not lang or lang == primary_lang(data.menu, ""):
return text
return data.trans.get(chunk_key(text), {}).get(lang) or text
def set_string_translation(data: Data, lang: str, original: str, text: str) -> bool:
"""Record (or drop) a site-string translation (i18n.site_string): a
fragment in ``Data.trans`` keyed by the original's chunk hash — the
same storage machine translations use, overriding them. Empty or the
original's text drops the override. Returns True when anything changed.
Pure data ops — the caller wraps in a transaction and invalidates."""
key = chunk_key(original)
current = data.trans.get(key, {}).get(lang)
if not text or text == original:
if current is None:
return False
del data.trans[key][lang]
return True
if current == text:
return False
data.trans.setdefault(key, {})[lang] = text
return True
def clear_translations(data: Data) -> None: def clear_translations(data: Data) -> None:
"""Drop all machine translations (``Data.trans``) and rebuild the """Drop all machine translations (``Data.trans``) and rebuild the
availability index (``node.langs``) from the surviving user overrides — availability index (``node.langs``) from the surviving user overrides —
+557
View File
@@ -0,0 +1,557 @@
"""Visitor contact messages: storage, strict rendering, socket protocol.
Anonymous visitors open a panel from a ``{contact: Label}`` button in an
article (views._contact_tag). The panel rides the public /_ws activity
socket: tracking.activity_ws routes frames carrying a ``token`` field to
``visitor_frame``. The token (a localStorage random, generated on first
use) identifies the visitor's thread; only its blake3 hash is stored.
Admins watch and reply from the same overlay panel (the corner ✉️ icon
opens the inbox for them, the visitor thread for visitors) over the
analytics socket (tracking.analytics_websocket), admin-gated like the
rest of /_api; their frames go to ``admin_frame``. Both sides get
pushed full thread payloads (threads are small); there is no REST
polling anywhere.
Sends are proof-of-work gated (easypow): the /_ws handler
(tracking.activity_ws) issues a fresh single-use challenge on
registration/resync and whenever the quota runs out; the browser solves
it in the background (bundled solver, served at /_contact/easypow.js)
and submits the solution as soon as it is ready (``visitor_proven``),
which grants a quota of messages and uploads (``_quota``, RAM only,
keyed by token hash so the HTTP upload route shares it). The solution
is single-use — a fresh challenge is pushed when the quota hits zero,
which the client solves before continuing. A validated proof also
unlocks the site's contact email (sent over the socket, never in the
page's asset config) and records the visit's contact trail marker in
analytics. Uploads without quota are answered 429; the client re-proves
and retries.
Message bodies are a Markdown subset (emphasis, links, lists, code plus
/_f/ image and file references) serialized client-side from a constrained
contenteditable composer. They are rendered here with a strict MarkdownIt
instance: html=False, so not a single byte of user markup can reach a
page — the stored html is always markdown-it output from the constrained
grammar, never sanitized user HTML (sanitization is unwinnable; grammar
restriction is not). Links get rel="nofollow ugc noopener"; images are
limited to /_f/ store names (the upload endpoint is the only way in).
"""
import asyncio
import logging
import re
import secrets
from datetime import UTC, datetime
from pathlib import Path
from urllib.parse import quote
import blake3
import easypow
from fastapi import APIRouter, HTTPException, Request, WebSocket
from fastapi.responses import Response
from markdown_it import MarkdownIt
from markdown_it.common.utils import escapeHtml
from pagerite.data import ContactMessage, ContactThread
from pagerite.files import _ext, file_store, store_attachment, store_image
from pagerite.state import data, kanta
logger = logging.getLogger(__name__)
router = APIRouter()
#: Session-token shape: crypto-random from the browser (uuid or hex).
TOKEN_RE = re.compile(r"^[A-Za-z0-9_-]{16,64}$")
#: Message source length cap (the rendered html is bounded by it too).
MAX_MESSAGE = 8000
#: Live sockets: visitor token hash -> panels, and every connected admin.
_visitor_ws: dict[bytes, set[WebSocket]] = {}
_admin_ws: set[WebSocket] = set()
#: Uploaded-but-unreferenced file digests per session (RAM only) — deleted
#: when the session's last socket closes. The PoW challenge state is a
#: per-connection local in the WS handler (tracking.activity_ws).
_pending_uploads: dict[bytes, set[str]] = {}
#: Remaining message/upload actions per session (token hash), granted by a
#: solved PoW challenge (RAM only — single worker; the challenge itself is
#: a per-connection local in tracking.activity_ws). Keyed by token hash
#: rather than connection so the HTTP upload route (/_contact/files)
#: shares the same budget, and a reconnect keeps it.
_quota: dict[bytes, int] = {}
#: easypow solving cost per challenge, the actions a solution grants
#: (messages and uploads alike), and the pending-upload quota.
POW_SECONDS = 5.0
POW_QUOTA = 10
MAX_PENDING_UPLOADS = 10
# --- Strict rendering -----------------------------------------------------
# A separate instance from markdown.py's page renderer: no raw HTML (the
# trusted-author passthrough would be an XSS hole here), no plugins, no
# typographer. markdown-it escapes all markup in the source and validates
# link protocols (javascript: etc. never become hrefs).
_md = MarkdownIt("default", {"html": False, "typographer": False, "breaks": True})
#: Images may only reference the content-addressed store (uploads land
#: there via /_contact/files); anything else collapses to its alt text.
_IMG_SRC = re.compile(r"/_f/[0-9a-f]{12}(?:\.[a-z0-9]+)?")
def _link_rule(self, tokens, idx, options, env):
"""Open external links in a new tab without window.opener; store-file
links (uploaded attachments) render as download chips."""
token = tokens[idx]
href = token.attrs.get("href", "")
if href.startswith("/_f/"):
token.attrSet("class", "attachment")
token.attrSet("download", "")
else:
token.attrSet("rel", "nofollow ugc noopener")
token.attrSet("target", "_blank")
return self.renderToken(tokens, idx, options, env)
def _image_rule(self, tokens, idx, options, env):
"""Drop images that do not point at a /_f/ store file (escaped alt)."""
token = tokens[idx]
if not _IMG_SRC.fullmatch(token.attrs.get("src", "")):
return escapeHtml(self.renderInlineAsText(token.children, options, env))
token.attrSet("loading", "lazy")
return self.renderToken(tokens, idx, options, env)
_md.add_render_rule("link_open", _link_rule)
_md.add_render_rule("image", _image_rule)
def render_message(text: str) -> str:
"""Render message-source Markdown to thread HTML (the only HTML a
visitor's message ever becomes)."""
return _md.render(text)
# --- Thread store ----------------------------------------------------------
def thread_key(token: str) -> bytes:
"""The Data.contact key for a session token (hash, never the token)."""
return blake3.blake3(token.encode()).digest(12)
def _new_id(now: datetime) -> str:
"""Sortable message id: timestamp plus a random tiebreak."""
return f"{now:%Y%m%d%H%M%S%f}-{secrets.token_hex(3)}"
def _unread(thread: ContactThread) -> bool:
"""Admin perspective: the last message is the visitor's and newer than
the admin's last read."""
for mid in reversed(thread.messages):
m = thread.messages[mid]
if m.admin:
return False
return thread.admin_read is None or m.t > thread.admin_read
return False
def _payload(key: bytes, thread: ContactThread) -> dict:
"""Full thread state for the wire (same shape for visitors and admins;
clients replace/upsert by id). Messages are capped to the last 200.
Admin messages are labeled with the site name as currently configured
(not the stored SSO name, which stays in the database for audit)."""
brand = data.brand or "admin"
return {
"type": "thread",
"id": key.hex(),
"created": thread.created.isoformat(),
"unread": _unread(thread),
"closed": thread.closed,
"name": thread.name,
"email": thread.email,
"messages": [
{
"id": mid,
"t": m.t.isoformat(),
"admin": brand if m.admin else "",
"html": m.html,
"page": m.page,
}
for mid, m in list(thread.messages.items())[-200:]
],
}
def _empty_payload(key: bytes) -> dict:
return {"type": "thread", "id": key.hex(), "created": "", "unread": False,
"closed": False, "name": "", "email": "", "messages": []}
async def _push(sockets, payload: dict) -> None:
"""Send a payload to a socket set, dropping the ones that fail."""
closed = set()
for ws in sockets:
try:
await ws.send_json(payload)
except Exception:
logger.exception("Message push failed; dropping client")
closed.add(ws)
for ws in closed:
sockets.discard(ws)
async def _broadcast(key: bytes, thread: ContactThread) -> None:
"""Push a thread update to its visitor's panels and every admin."""
payload = _payload(key, thread)
if key in _visitor_ws:
await _push(_visitor_ws[key], payload)
await _push(_admin_ws, payload)
def _append(
key: bytes,
msg: ContactMessage,
action: str,
user: str | None,
name: str = "",
email: str = "",
) -> None:
"""Append a message to the thread (created on first use), in one
transaction so the database diff is just the new entry. A visitor's
name/email are recorded alongside their first message."""
with kanta.transaction(action, user=user, extra=key.hex()):
thread = data.contact.get(key)
if thread is None:
thread = data.contact[key] = ContactThread(created=msg.t)
if name and not thread.name:
thread.name = name
thread.email = email
thread.messages[_new_id(msg.t)] = msg
# --- Visitor protocol (/_ws frames carrying "token") ------------------------
def enabled() -> bool:
"""Messaging on/off: the site contact label doubles as the switch —
empty disables the feature (docs/messages.md)."""
return bool(data.contact_label.strip())
def quota_left(token: str) -> int:
"""Remaining PoW-granted actions for a session token (0 for malformed
tokens — they fail validation later anyway)."""
if not TOKEN_RE.fullmatch(token):
return 0
return _quota.get(thread_key(token), 0)
async def visitor_proven(ws: WebSocket, raw: dict) -> bytes | None:
"""A solved PoW challenge submitted ahead of sending ({token, pow} —
the solution itself is already validated and burned by the WS
handler): grant the message/upload quota, acknowledge it, reveal the
site's contact email (never carried in the page's asset config, so
scrapers cannot lift it without solving) and return the thread key
(the handler records the visit's contact trail marker in analytics).
None for a malformed token."""
token = str(raw.get("token") or "")
if not TOKEN_RE.fullmatch(token):
await ws.send_json({"type": "contact-error", "detail": "bad session token"})
return None
key = thread_key(token)
_visitor_ws.setdefault(key, set()).add(ws)
_quota[key] = POW_QUOTA
await ws.send_json({"type": "pow", "quota": POW_QUOTA})
if data.contact_email:
# The mailto recipient is "Brand <email>" (RFC-encoded here; the
# link text is the bare address, the subject is the client's
# localized contact_subject).
recipient = (
quote(f"{data.brand} <{data.contact_email}>", safe="@")
if data.brand.strip()
else quote(data.contact_email, safe="@")
)
await ws.send_json(
{"type": "contact-email", "email": data.contact_email, "to": recipient}
)
return key
def _spend(key: bytes) -> None:
"""Burn one message/upload of the session's PoW quota."""
if _quota.get(key, 0) > 0:
_quota[key] -= 1
async def visitor_frame(ws: WebSocket, raw: dict) -> None:
"""Handle one visitor frame: ``{token}`` registers/resyncs (the thread
state is pushed back), ``{token, msg, fr?}`` appends a message and
broadcasts the updated thread to both sides, ``{token, close}`` ends
the conversation (archived in the admin inbox; a fresh thread needs a
new token, which the client rotates itself). The PoW quota check
happens in the WS handler (tracking.activity_ws) — message frames
arrive here with quota remaining, spent here per accepted message."""
token = str(raw.get("token") or "")
if not TOKEN_RE.fullmatch(token):
await ws.send_json({"type": "contact-error", "detail": "bad session token"})
return
key = thread_key(token)
_visitor_ws.setdefault(key, set()).add(ws)
if raw.get("close"):
thread = data.contact.get(key)
if thread and not thread.closed:
with kanta.transaction("contact:close", extra=key.hex()):
thread.closed = True
await _push(_admin_ws, _payload(key, thread))
# No more pushes to this token: drop the socket from its registry
# and clean up its pending uploads like a disconnect would.
sockets = _visitor_ws.get(key)
if sockets is not None:
sockets.discard(ws)
if not sockets:
del _visitor_ws[key]
for digest in _pending_uploads.pop(key, ()):
file_store.delete(digest)
return
text = str(raw.get("msg") or "").strip()
if not text:
thread = data.contact.get(key)
# A closed thread resyncs as empty: the conversation is over, and a
# stale client (same token) starts from a clean slate.
if thread and not thread.closed:
await ws.send_json(_payload(key, thread))
else:
await ws.send_json(_empty_payload(key))
return
if len(text) > MAX_MESSAGE:
await ws.send_json({"type": "contact-error", "detail": "message too long"})
return
if not enabled():
# Messaging off (no contact label configured): sends are rejected
# (the UI is already hidden); existing threads and admin replies
# stay.
await ws.send_json({"type": "contact-error", "detail": "messaging is disabled"})
return
# The first message must introduce the visitor (name; email optional,
# unvalidated). The stored identity is fixed from then on.
thread = data.contact.get(key)
if thread and thread.closed:
# Defensive: the client rotates its token on close, so a message
# for a closed thread only comes from a stale client.
await ws.send_json({"type": "contact-error", "detail": "thread closed"})
return
name = email = ""
if thread is None or not thread.name:
name = str(raw.get("name") or "").strip()[:100]
email = str(raw.get("email") or "").strip()[:200]
if not name:
await ws.send_json({"type": "contact-error", "detail": "name required"})
return
now = datetime.now(UTC)
_append(
key,
ContactMessage(
t=now,
md=text,
html=render_message(text),
page=str(raw.get("fr") or "")[:200],
),
"contact",
None,
name,
email,
)
_spend(key)
# Files the message references are no longer pending cleanup.
if pending := _pending_uploads.get(key):
for digest in re.findall(r"/_f/([0-9a-f]{12})", text):
pending.discard(digest)
await _broadcast(key, data.contact[key])
def visitor_disconnect(ws: WebSocket) -> None:
"""Drop a closed /_ws socket from every registry. When a session's
last socket closes, its uploaded files that no sent message ended up
referencing are deleted from the store."""
empty = [key for key, sockets in _visitor_ws.items() if not sockets - {ws}]
for sockets in _visitor_ws.values():
sockets.discard(ws)
for key in empty:
del _visitor_ws[key]
for digest in _pending_uploads.pop(key, ()):
file_store.delete(digest)
# --- Admin protocol (/_api/ws/analytics frames) -----------------------------
def unread_count() -> int:
"""Threads with an unanswered visitor message — the admin inbox icon's
badge, seeded by /_api/settings (no polling; live while the inbox's
socket is open). Visitor-closed (archived) threads do not count."""
return sum(1 for t in data.contact.values() if _unread(t) and not t.closed)
def _key_from_hex(value) -> bytes | None:
try:
key = bytes.fromhex(str(value or ""))
except ValueError:
return None
return key if len(key) == 12 else None
def _last_t(thread: ContactThread) -> datetime:
"""The thread's last-activity time (its newest message, else creation)."""
if thread.messages:
return list(thread.messages.values())[-1].t
return thread.created
async def admin_connect(ws: WebSocket) -> None:
"""Register an admin socket and send the inbox: all threads, most
recently active first, visitor-closed (archived) ones last (capped at
100)."""
_admin_ws.add(ws)
threads = sorted(data.contact.items(), key=lambda kv: _last_t(kv[1]), reverse=True)
threads = [kv for kv in threads if not kv[1].closed] + [
kv for kv in threads if kv[1].closed
]
await ws.send_json(
{"type": "threads", "threads": [_payload(k, t) for k, t in threads[:100]]}
)
def admin_disconnect(ws: WebSocket) -> None:
_admin_ws.discard(ws)
async def admin_frame(ws: WebSocket, raw: dict) -> None:
"""Handle one admin frame: ``{type: reply, id, text}`` appends an admin
message, ``{type: read, id}`` marks a thread read."""
match raw.get("type"):
case "reply":
key = _key_from_hex(raw.get("id"))
text = str(raw.get("text") or "").strip()
thread = data.contact.get(key) if key else None
if thread is None:
await ws.send_json({"type": "contact-error", "detail": "no such thread"})
return
if thread.closed:
await ws.send_json(
{"type": "contact-error", "detail": "the visitor closed this conversation"}
)
return
if not text or len(text) > MAX_MESSAGE:
await ws.send_json({"type": "contact-error", "detail": "bad message"})
return
now = datetime.now(UTC)
user = ws.headers.get("remote-user")
_append(
key,
ContactMessage(
t=now,
md=text,
html=render_message(text),
admin=user or "admin",
),
"contact:reply",
user,
)
with kanta.transaction("contact:read", user=user, extra=key.hex()):
thread.admin_read = now
await _broadcast(key, thread)
case "read":
key = _key_from_hex(raw.get("id"))
thread = data.contact.get(key) if key else None
if thread is None:
return
with kanta.transaction(
"contact:read", user=ws.headers.get("remote-user"), extra=key.hex()
):
thread.admin_read = datetime.now(UTC)
await _push(_admin_ws, _payload(key, thread))
# --- Uploads -----------------------------------------------------------------
#: Contact-panel uploads: images (raster and SVG) go through the usual
#: derivative pipeline and inline in the message — SVGs included: the
#: extension-less link negotiates raster derivatives, and even an
#: as-is-served .svg is inert inside an <img> (and downloads when
#: navigated to). Every other type is stored as an inert {hash}.file
#: blob (store_attachment — no original extension on disk) and links as
#: /_f/{hash}/{original-name}; the .file suffix never appears in URLs.
IMAGE_EXTS = {".png", ".jpg", ".jpeg", ".gif", ".svg", ".webp", ".avif", ".heic", ".heif"}
UPLOAD_MAX_BYTES = 20 * 1024 * 1024
@router.put("/_contact/files/{name}")
async def contact_upload(name: str, request: Request) -> dict:
"""Store a contact-panel upload in the content-addressed store.
Public like the messaging socket (only /_api is gated): the caller
must present a session-shaped token and size is capped. Uploads spend
the same PoW quota as messages (a solved challenge covers both): with
no quota left the answer is 429 "pow" (429, not 403 — no auth flows
here) and the client re-proves and retries. The file additionally
stays pending per session and is deleted when the session's last
socket closes without a sent message referencing it, and a separate
quota caps those pending files.
Images (raster and SVG) get the usual derivative treatment and are
referenced extension-less; any other file is stored as an inert
{hash}.file blob and referenced as /_f/{hash}/{original-name}, which
is always served as a forced download. Returns the /_f/ path and
whether the file is an inline-able image.
"""
token = request.headers.get("x-contact-token", "")
if not TOKEN_RE.fullmatch(token):
raise HTTPException(403, "no session")
key = thread_key(token)
if _quota.get(key, 0) <= 0:
raise HTTPException(429, "pow")
pending = _pending_uploads.setdefault(key, set())
if len(pending) >= MAX_PENDING_UPLOADS:
raise HTTPException(429, "too many un-sent uploads — send your message first")
try:
length = int(request.headers.get("content-length") or 0)
except ValueError:
length = 0
if length > UPLOAD_MAX_BYTES:
raise HTTPException(413, "file too large")
body = await request.body()
if not body:
raise HTTPException(400, "empty file")
if len(body) > UPLOAD_MAX_BYTES:
raise HTTPException(413, "file too large")
_spend(key)
orig = Path(name).name[:100] or "file"
ext = _ext(orig)
if ext in IMAGE_EXTS:
stored = await asyncio.to_thread(store_image, body, ext, derive=ext != ".gif")
# Decodable images come back extension-less (GIFs and as-is SVGs
# keep their extension); an undecodable body attaches like any file.
if "." not in stored or ext in (".gif", ".svg"):
pending.add(stored.partition(".")[0])
return {"path": f"/_f/{stored}", "image": True, "name": orig}
stored = await asyncio.to_thread(store_attachment, body)
pending.add(stored.removesuffix(".file"))
return {
"path": f"/_f/{stored.removesuffix('.file')}/{quote(orig, safe='')}",
"image": False,
"name": orig,
}
@router.get("/_contact/easypow.js")
async def pow_solver() -> Response:
"""The easypow browser solver as an ES module, served from the
installed package so the client solver and the server validator are
always the same version."""
return Response(
easypow.js,
media_type="text/javascript",
headers={"cache-control": "public, max-age=86400"},
)
+78 -5
View File
@@ -5,7 +5,9 @@ the page (or a category placeholder, or 404); it must be registered AFTER
the fastapi-vue asset routes so built frontend files win over content slugs the fastapi-vue asset routes so built frontend files win over content slugs
(see app.py). Every served document is recorded raw in analytics (one (see app.py). Every served document is recorded raw in analytics (one
access-log line with its true HTTP status; classification happens at access-log line with its true HTTP status; classification happens at
display time — see pagerite/analytics.py). display time — see pagerite/analytics.py), as are robots.txt and sitemap.xml
fetches (they surface as crawler hits, since no activity message ever
follows them).
""" """
import logging import logging
@@ -17,7 +19,9 @@ from fastapi import APIRouter, HTTPException, Request
from fastapi.responses import RedirectResponse, Response from fastapi.responses import RedirectResponse, Response
from pagerite import i18n, state from pagerite import i18n, state
from pagerite.data import Node, resolve, sorted_nodes from pagerite.chunks import chunk_key
from pagerite.data import Node, node_markdown, resolve, sorted_nodes
from pagerite.markdown import has_h1
from pagerite.state import ( from pagerite.state import (
SITE_URL, SITE_URL,
_html_response, _html_response,
@@ -45,6 +49,40 @@ def _is_trackable_path(path: str) -> bool:
return not _is_reserved(path) return not _is_reserved(path)
def _markdown_response(
request: Request, path: str, node: Node, lang: str, original: str
) -> Response:
"""The page as Markdown (text/markdown): the same source the HTML page
renders (per-language hybrid assembly), with the page title injected as
``# title`` when the content has no h1 of its own — mirroring
markdown.render's title injection, so the .md reads like the page.
Served at the page's ``.md`` URL, and also at the plain URL when the
request's Accept header explicitly names text/markdown (Vary: accept).
Language selection is the page's own (?lang= or Accept-Language), so
``/page.md?lang=fi`` is the Finnish markdown."""
content = node_markdown(data, node) or ""
title = node.title
if lang != original and lang in node.langs:
content = i18n.hybrid_markdown(data, node, path, lang)
if t := data.trans.get(chunk_key(node.title), {}).get(lang):
title = t
if title and not has_h1(content):
content = f"# {title}\n\n{content}"
etag = f'"{path}@{node.modified.timestamp()}g{state._render_gen}l{lang}md"'
headers = {
"etag": etag,
"last-modified": _http_date(node.modified),
"cache-control": "no-cache",
"vary": "accept",
}
if request.headers.get("if-none-match") == etag:
return Response(status_code=304, headers=headers)
if _is_trackable_path(path):
_record_get(request, lang=lang)
return Response(content, media_type="text/markdown", headers=headers)
@router.get("/") @router.get("/")
async def front_page(request: Request) -> Response: async def front_page(request: Request) -> Response:
"""Render the front page (slug path "").""" """Render the front page (slug path "")."""
@@ -53,7 +91,8 @@ async def front_page(request: Request) -> Response:
@router.get("/sitemap.xml") @router.get("/sitemap.xml")
async def sitemap(request: Request) -> Response: async def sitemap(request: Request) -> Response:
"""Dynamically generate a sitemap of all published article pages.""" """Dynamically generate a sitemap of all published article pages, plus
the machine-readable exports (feeds, llms.txt)."""
base = SITE_URL or str(request.base_url).rstrip("/") base = SITE_URL or str(request.base_url).rstrip("/")
entries: list[tuple[str, datetime, int]] = [] entries: list[tuple[str, datetime, int]] = []
@@ -110,6 +149,26 @@ async def sitemap(request: Request) -> Response:
) )
lines.append("</urlset>") lines.append("</urlset>")
# The machine-readable exports (feeds, llms.txt) are linked too, with
# the latest article's modification time as their lastmod.
if entries:
latest = max(m for _, m, _ in entries)
lastmod = (
latest.astimezone(UTC)
.replace(microsecond=0)
.isoformat()
.replace("+00:00", "Z")
)
for special in ("llms.txt", "feed.json", "feed.xml"):
lines.insert(
-1,
f" <url><loc>{xml_escape(f'{base}/{special}')}</loc>"
f"<lastmod>{lastmod}</lastmod></url>",
)
# Recorded like a page GET: never followed by an activity message, so
# it lands in the crawler list at display time (docs/analytics.md).
_record_get(request)
return Response( return Response(
"\n".join(lines), "\n".join(lines),
media_type="application/xml", media_type="application/xml",
@@ -124,6 +183,7 @@ async def robots_txt(request: Request) -> Response:
the sitemap.""" the sitemap."""
base = SITE_URL or str(request.base_url).rstrip("/") base = SITE_URL or str(request.base_url).rstrip("/")
body = f"User-agent: *\nAllow: /\nDisallow: /auth/\nDisallow: /_api\nSitemap: {base}/sitemap.xml\n" body = f"User-agent: *\nAllow: /\nDisallow: /auth/\nDisallow: /_api\nSitemap: {base}/sitemap.xml\n"
_record_get(request)
return Response( return Response(
body, body,
media_type="text/plain", media_type="text/plain",
@@ -140,6 +200,14 @@ async def show_page(request: Request, path: str) -> Response:
""" """
path = path.strip("/") path = path.strip("/")
accept_language = request.headers.get("accept-language", "") accept_language = request.headers.get("accept-language", "")
# A .md suffix (or an Accept header explicitly naming text/markdown)
# asks for the page's Markdown instead of HTML. Slugs never contain a
# dot, so "page.md" unambiguously means the markdown of "page"; the
# front page's markdown URL is "/.md".
markdown = False
if path.endswith(".md"):
path = path[:-3]
markdown = True
if path and _is_reserved(path): if path and _is_reserved(path):
# Invalid slug shape: not a content URL, let FastAPI return its # Invalid slug shape: not a content URL, let FastAPI return its
# built-in 404 instead of rendering an editable article page. # built-in 404 instead of rendering an editable article page.
@@ -155,18 +223,20 @@ async def show_page(request: Request, path: str) -> Response:
# Accept-Language header regardless of the selection, and record # Accept-Language header regardless of the selection, and record
# the resolved language as the GET's rendered language. # the resolved language as the GET's rendered language.
query_lang = request.query_params.get("lang") query_lang = request.query_params.get("lang")
original = i18n.primary_lang(data.menu, path)
lang = i18n.select_language( lang = i18n.select_language(
query_lang, query_lang,
accept_language, accept_language,
lambda tag: tag in node.langs, lambda tag: tag in node.langs,
original=i18n.primary_lang(data.menu, path), original=original,
) )
# A ?lang= override is replicated onto the page's navigation links # A ?lang= override is replicated onto the page's navigation links
# (link_lang), so clicks and prefetches stay in the chosen language. # (link_lang), so clicks and prefetches stay in the chosen language.
# Query and header-selected renders of the same language differ in # Query and header-selected renders of the same language differ in
# their links, so link_lang is part of the ETag and body cache key. # their links, so link_lang is part of the ETag and body cache key.
link_lang = i18n.base_tag(query_lang or "") link_lang = i18n.base_tag(query_lang or "")
# no-cache forbids serving a stored page without revalidation if markdown or "text/markdown" in request.headers.get("accept", ""):
return _markdown_response(request, path, node, lang, original)
# (browsers would otherwise cache heuristically and serve stale # (browsers would otherwise cache heuristically and serve stale
# pages, e.g. after a theme change). In-session speed instead comes # pages, e.g. after a theme change). In-session speed instead comes
# from pagerite.js's in-memory page cache (preload everything, never # from pagerite.js's in-memory page cache (preload everything, never
@@ -185,6 +255,9 @@ async def show_page(request: Request, path: str) -> Response:
"etag": etag, "etag": etag,
"last-modified": _http_date(node.modified), "last-modified": _http_date(node.modified),
"cache-control": "no-cache", "cache-control": "no-cache",
# The same URL serves text/markdown when the Accept header
# explicitly asks for it (_markdown_response).
"vary": "accept",
}, },
lang=lang, lang=lang,
link_lang=link_lang, link_lang=link_lang,
+7 -2
View File
@@ -171,11 +171,16 @@ _render_gen = 0
def _invalidate_pages() -> None: def _invalidate_pages() -> None:
"""Drop cached page bodies and bump the render generation (ETags); """Drop cached page bodies (and the feed/llms.txt export bodies) and
any content change also re-runs translation dispatch.""" bump the render generation (ETags); any content change also re-runs
translation dispatch."""
global _render_gen global _render_gen
_render_gen += 1 _render_gen += 1
_cached_body.cache_clear() _cached_body.cache_clear()
# Local import: pagerite.feeds imports this module.
from pagerite import feeds
feeds._cached_feed.cache_clear()
dispatcher.schedule() dispatcher.schedule()
+1 -1
View File
@@ -16,6 +16,7 @@
--line: #12203f14; --line: #12203f14;
--font-body: var(--font-inter); --font-body: var(--font-inter);
--font-heading: var(--font-montserrat); --font-heading: var(--font-montserrat);
--nav-weight: 600;
--code-x-height: 0.546; /* Inter's x-height ratio */ --code-x-height: 0.546; /* Inter's x-height ratio */
} }
@@ -54,7 +55,6 @@
#nav { #nav {
font-size: 1.05em; font-size: 1.05em;
font-weight: 600;
letter-spacing: 0.04em; letter-spacing: 0.04em;
text-transform: uppercase; text-transform: uppercase;
text-shadow: none; text-shadow: none;
+74 -3
View File
@@ -1,6 +1,7 @@
/* Nitro theme: racing/HUD style — saturated orange + cyan, console/HUD-style /* Nitro theme: racing/HUD style — saturated orange + cyan, console/HUD-style
monospace display type, an orange racing-tab nav with a bezier clip-path, monospace display type, an orange racing-tab nav with a bezier clip-path,
and a dark bezier banner. Follows prefers-color-scheme: the light scheme matching slanted-parallelogram buttons, and a dark bezier banner. Follows
prefers-color-scheme: the light scheme
is a warm light-grey page, the dark scheme a deep violet page; the banner is a warm light-grey page, the dark scheme a deep violet page; the banner
and other dark/bright elements carry over unchanged. and other dark/bright elements carry over unchanged.
@@ -41,6 +42,8 @@
--font-body: var(--font-montserrat); --font-body: var(--font-montserrat);
--font-heading: var(--font-literata); --font-heading: var(--font-literata);
--font-nav: var(--font-heading);
--nav-weight: 700;
--code-x-height: 0.517; /* Montserrat's x-height ratio */ --code-x-height: 0.517; /* Montserrat's x-height ratio */
/* Neutral grey selection instead of the accent tint: accent-colored /* Neutral grey selection instead of the accent tint: accent-colored
text (h2, links, markers) stays readable on it in both schemes. */ text (h2, links, markers) stays readable on it in both schemes. */
@@ -86,9 +89,7 @@
} }
#nav { #nav {
font-family: var(--font-heading);
font-size: 0.95em; font-size: 0.95em;
font-weight: 700;
letter-spacing: 0.08em; letter-spacing: 0.08em;
text-transform: uppercase; text-transform: uppercase;
/* Racing tab: sitting at the bottom of the banner, with a bezier clip — /* Racing tab: sitting at the bottom of the banner, with a bezier clip —
@@ -135,6 +136,76 @@
color: var(--tab-muted); color: var(--tab-muted);
} }
/* Buttons in the article flow (the {contact:} trigger and any raw
<button> in the markup): a racing parallelogram with / slanted sides,
clipped with the same shape() language as the nav tab. All buttons
are forced to one fixed 1.7em height (inline-flex centering, nowrap,
no border — it would be invisible under the clip), so every button
gets the identical shape and the geometry is exact: a ~62° slant from
the 0.9em run. The obtuse top-left and bottom-right corners replicate
the nav tab's top-left corner: a wide bezier sweep with the same
0.8/0.6 control-handle split along the joining edges (over a 0.5em
tangent run), mirrored between the two corners. The sharp corners
keep small arcs, in balance with the wide sweeps (0.22em, arc
≈ 0.45em — about half the obtuse sweep's, so the sharp corners stay
subordinate). border-radius is the fallback for browsers without
shape(). Asymmetric inline padding keeps the text clear of the
slants (wider on the right: the wide bottom-right sweep cuts deeper
into the label's end side). The negative right margin tucks whatever
follows — another button or plain text — under the right slant's
empty top triangle: adjacent buttons' slant bands overlap by ~0.3em
horizontally while the painted edges keep ~0.3em apart (the slants
are parallel, so the clearance is constant top to bottom).
Editor chrome (.icon-btn pens, .copy)
keeps its own styling. The {contact:} envelope's line-height is
reduced in the base stylesheet so it doesn't outgrow this height. */
.contact-trigger,
article button:not(.icon-btn):not(.copy) {
display: inline-flex;
align-items: center;
justify-content: center;
height: 1.7em;
padding: 0 1.3em 0 1em;
margin-right: -0.8em;
white-space: nowrap;
/* Same typography as the contact trigger (raw <button>s otherwise get
the small UA font): nav family/weight, article size and leading. */
font-family: var(--font-nav);
font-weight: var(--nav-weight);
font-size: inherit;
line-height: inherit;
color: var(--ink);
background: var(--accent);
border: none;
border-radius: 0.2em;
cursor: pointer;
clip-path: shape(
/* bottom edge, left to right */
from 0.365em 100%,
hline to calc(100% - 1.4em),
/* bottom-right corner: nav-style bezier, mirrored from top-left */
curve to calc(100% - 0.666em) calc(100% - 0.442em)
with calc(100% - 1.1em) 100% / calc(100% - 0.853em) calc(100% - 0.088em),
/* right slant */
line to calc(100% - 0.171em) 0.323em,
/* top-right corner: sharp, small arc */
arc to calc(100% - 0.365em) 0% of 0.22em ccw,
/* top edge, right to left */
hline to 1.4em,
/* top-left corner: nav-style bezier */
curve to 0.666em 0.442em with 1.1em 0 / 0.853em 0.088em,
/* left slant */
line to 0.171em calc(100% - 0.323em),
/* bottom-left corner: sharp, small arc */
arc to 0.365em 100% of 0.22em ccw,
close);
}
article button:not(.icon-btn):not(.copy):hover {
color: var(--tab-hover);
text-shadow: 0 0 0.1em;
}
/* Console-style headings: uppercase monospace. h1 in the page text color /* Console-style headings: uppercase monospace. h1 in the page text color
with a hazard-stripe underline, h2 deep orange, h3 cyan. */ with a hazard-stripe underline, h2 deep orange, h3 cyan. */
article h1 { article h1 {
+94 -4
View File
@@ -23,13 +23,14 @@ from functools import lru_cache
from pathlib import Path from pathlib import Path
from urllib.parse import urlparse from urllib.parse import urlparse
import easypow
import httpx import httpx
import msgspec import msgspec
from fastapi import APIRouter, Request, WebSocket, WebSocketDisconnect from fastapi import APIRouter, Request, WebSocket, WebSocketDisconnect
from fastapi.responses import Response from fastapi.responses import Response
from uarite import uaparse from uarite import uaparse
from pagerite import analytics, i18n from pagerite import analytics, i18n, messages
from pagerite.data import resolve from pagerite.data import resolve
from pagerite.files import _hash_name, file_store from pagerite.files import _hash_name, file_store
from pagerite.state import SITE_URL, _html_response, analytics_store, data from pagerite.state import SITE_URL, _html_response, analytics_store, data
@@ -447,6 +448,18 @@ async def activity_ws(ws: WebSocket) -> None:
abusive IPs are filtered at display time, not here. The reverse-DNS and abusive IPs are filtered at display time, not here. The reverse-DNS and
DB-IP geoip lookups happen in background tasks so message handling is DB-IP geoip lookups happen in background tasks so message handling is
never delayed by slow DNS or the first MMDB decompress. never delayed by slow DNS or the first MMDB decompress.
Frames carrying a ``token`` field are visitor contact messages
(docs/messages.md), routed to pagerite.messages — the same socket
serves the contact panel, which also receives thread pushes on it.
Sends and uploads spend a per-session quota granted by solving an
easypow challenge: a single-use challenge (a per-connection local) is
issued on registration and whenever the quota runs out; the client
submits the solution as soon as it is ready ({token, pow}), validated
and burned here, and the quota itself lives in pagerite.messages
keyed by token hash (shared with the HTTP upload route, kept across
reconnects). A validated proof also reveals the site's contact email
and records the visit's contact trail marker in analytics.
""" """
ip = _client_ip(ws) ip = _client_ip(ws)
ua = ws.headers.get("user-agent", "") ua = ws.headers.get("user-agent", "")
@@ -458,11 +471,70 @@ async def activity_ws(ws: WebSocket) -> None:
part for part in (uaparse(ua).pretty, lang) if part part for part in (uaparse(ua).pretty, lang) if part
) )
await ws.accept() await ws.accept()
challenge = "" # outstanding PoW challenge for contact sends (below)
try: try:
while True: while True:
text = await ws.receive_text() text = await ws.receive_text()
try: try:
msg = msgspec.json.decode(text.encode(), type=analytics.Ping) raw = msgspec.json.decode(text.encode())
except msgspec.DecodeError:
continue
if isinstance(raw, dict) and "token" in raw:
# Contact-messaging frames (docs/messages.md).
if raw.get("msg"):
# A send with no quota left gets a fresh challenge
# instead; the client solves it, re-proves and retries.
if messages.quota_left(str(raw.get("token") or "")) <= 0:
challenge = easypow.generate(messages.POW_SECONDS)
await ws.send_json(
{"type": "pow", "challenge": challenge, "required": True}
)
continue
await messages.visitor_frame(ws, raw)
if messages.quota_left(str(raw.get("token") or "")) <= 0:
# Quota just ran out: push the next challenge right
# away so the client can pre-solve it.
challenge = easypow.generate(messages.POW_SECONDS)
await ws.send_json(
{"type": "pow", "challenge": challenge, "required": False}
)
continue
if "pow" in raw:
# A solved challenge, submitted as soon as ready:
# validate and burn it here, grant the quota in
# pagerite.messages (shared with the upload route).
try:
if not challenge:
raise ValueError("no outstanding challenge")
easypow.validate(challenge, str(raw.pop("pow", "") or ""))
except ValueError:
challenge = easypow.generate(messages.POW_SECONDS)
await ws.send_json(
{"type": "pow", "challenge": challenge, "required": True}
)
continue
challenge = "" # burned; a fresh one comes when the quota ends
key = await messages.visitor_proven(ws, raw)
if key is not None:
# Panel opened AND PoW solved: mark the visit's
# trail at the page it first happened on.
new_client = analytics_store.record_contact(
str(raw.get("fr") or ""), ip, ua, accept_language
)
if new_client is not None:
_schedule_client_enrichment([new_client])
_schedule_analytics_broadcast()
continue
# Registration/resync: the thread state is pushed back, and
# a fresh challenge is issued for the client to pre-solve.
await messages.visitor_frame(ws, raw)
challenge = easypow.generate(messages.POW_SECONDS)
await ws.send_json(
{"type": "pow", "challenge": challenge, "required": False}
)
continue
try:
msg = msgspec.convert(raw, type=analytics.Ping)
except msgspec.DecodeError: except msgspec.DecodeError:
continue continue
new_client = analytics_store.record_msg( new_client = analytics_store.record_msg(
@@ -480,6 +552,8 @@ async def activity_ws(ws: WebSocket) -> None:
_schedule_favicon_fetch() _schedule_favicon_fetch()
except WebSocketDisconnect: except WebSocketDisconnect:
pass pass
finally:
messages.visitor_disconnect(ws)
@router.websocket("/_api/ws/analytics") @router.websocket("/_api/ws/analytics")
@@ -488,15 +562,31 @@ async def analytics_websocket(ws: WebSocket) -> None:
Admin-only via the /_api forward-auth gate, like every management Admin-only via the /_api forward-auth gate, like every management
endpoint. Powers the analytics viewer rendered at /_a. endpoint. Powers the analytics viewer rendered at /_a.
The same socket serves the admin contact inbox (the overlay opened
from the corner ✉️ icon, docs/messages.md):
on connect the thread list follows the snapshot, new visitor messages
are pushed as they arrive, and incoming frames (``reply``/``read``)
go to pagerite.messages. Analytics payloads carry no ``type`` field;
messaging payloads always do, so the client can tell them apart.
""" """
await ws.accept() await ws.accept()
await ws.send_text(_display_json()) await ws.send_text(_display_json())
_analytics_ws_clients.add(ws) _analytics_ws_clients.add(ws)
await messages.admin_connect(ws)
try: try:
# Receive until the client goes away; we only push. # Receive until the client goes away; messaging frames are handled,
# anything else is ignored (analytics only pushes).
while True: while True:
await ws.receive_text() text = await ws.receive_text()
try:
raw = msgspec.json.decode(text.encode())
except msgspec.DecodeError:
continue
if isinstance(raw, dict):
await messages.admin_frame(ws, raw)
except WebSocketDisconnect: except WebSocketDisconnect:
logger.debug("Analytics WS client disconnected") logger.debug("Analytics WS client disconnected")
finally: finally:
_analytics_ws_clients.discard(ws) _analytics_ws_clients.discard(ws)
messages.admin_disconnect(ws)
+22
View File
@@ -309,6 +309,15 @@ def pending_items(data: Data, lang: str) -> list[TransItem]:
walk(node.children, path, node_lang) walk(node.children, path, node_lang)
walk(data.menu, "", i18n.ORIGINAL_LANGUAGE) walk(data.menu, "", i18n.ORIGINAL_LANGUAGE)
# Site-level messaging strings (Data.contact_label/contact_subject):
# translated like titles and looked up at render time by chunk key
# (i18n.site_string). Skipped when messaging is off (no label — the
# label doubles as the enable switch) and in the site default
# language, like titles in their article's primary language.
if data.contact_label.strip() and lang != i18n.primary_lang(data.menu, ""):
for text in (data.contact_label, data.contact_subject):
if text and "\n" not in text:
emit(chunk_key(text), text, "", "title")
return items return items
@@ -536,6 +545,19 @@ class Dispatcher:
walk(node.children, depth + 1, node_lang) walk(node.children, depth + 1, node_lang)
walk(self.data.menu, 0, i18n.ORIGINAL_LANGUAGE) walk(self.data.menu, 0, i18n.ORIGINAL_LANGUAGE)
# The site-level messaging strings ride the same list (pending_items
# covers them for scoped jobs): one round trip names the menu and
# the contact chrome alike.
if self.data.contact_label.strip() and lang != i18n.primary_lang(self.data.menu, ""):
for text in (self.data.contact_label, self.data.contact_subject):
if text and "\n" not in text:
key = chunk_key(text)
if (
lang not in self.data.trans.get(key, {})
and (lang, key) not in inflight
and (lang, key, "nav") not in self.validation_failures
):
titles.append((0, text, key))
if len(titles) < 2: if len(titles) < 2:
return None return None
md = "\n".join(f"{' ' * depth}- {title}" for depth, title, _ in titles) md = "\n".join(f"{' ' * depth}- {title}" for depth, title, _ in titles)
+182 -32
View File
@@ -336,6 +336,8 @@ def _layout(
lang: str = i18n.ORIGINAL_LANGUAGE, lang: str = i18n.ORIGINAL_LANGUAGE,
canonical: str = "", canonical: str = "",
alternates: list[tuple[str, str]] = (), alternates: list[tuple[str, str]] = (),
markdown_url: str = "",
contact: dict[str, str] | None = None,
) -> Template: ) -> Template:
"""Page layout template with standard assets and ES-module scripts. """Page layout template with standard assets and ES-module scripts.
@@ -368,6 +370,9 @@ def _layout(
``alternates`` ((hreflang, href) pairs) are the page's language URLs ``alternates`` ((hreflang, href) pairs) are the page's language URLs
(see docs/localization.md), emitted right after the viewport and before (see docs/localization.md), emitted right after the viewport and before
the social tags: canonical first, then the hreflang alternates. the social tags: canonical first, then the hreflang alternates.
``contact`` carries the localized contact-messaging strings
(_contact_config; None = messaging disabled) into the asset config.
""" """
doc = Document( doc = Document(
E.Title, lang=lang, dir="rtl" if lang in i18n.RTL_LANGUAGES else "ltr" E.Title, lang=lang, dir="rtl" if lang in i18n.RTL_LANGUAGES else "ltr"
@@ -379,6 +384,21 @@ def _layout(
doc.link(rel="canonical", href=canonical) doc.link(rel="canonical", href=canonical)
for hreflang, href in alternates: for hreflang, href in alternates:
doc.link(rel="alternate", hreflang=hreflang, href=href) doc.link(rel="alternate", hreflang=hreflang, href=href)
# Feed/LLM discovery links (see pagerite/feeds.py): identical on every
# page, so the positional <head> sync (swapdoc.js) is unaffected.
doc.link(
rel="alternate",
type="application/feed+json",
title="JSON Feed",
href="/feed.json",
)
doc.link(
rel="alternate", type="application/rss+xml", title="RSS feed", href="/feed.xml"
)
doc.link(rel="llms-txt", type="text/markdown", title="llms.txt", href="/llms.txt")
# The page's own Markdown counterpart (pages.show_page's .md mode).
if markdown_url:
doc.link(rel="alternate", type="text/markdown", href=markdown_url)
for key, value in (social or {}).items(): for key, value in (social or {}).items():
if value: if value:
if key.startswith(("og:", "article:")): if key.startswith(("og:", "article:")):
@@ -399,15 +419,29 @@ def _layout(
vite_url = env.vite_url vite_url = env.vite_url
editor_scripts, editor_css = _editor_assets() editor_scripts, editor_css = _editor_assets()
langselect_scripts, langselect_css = _langselect_assets() langselect_scripts, langselect_css = _langselect_assets()
contact_scripts, contact_css = _contact_assets()
config = { config = {
"pagerite:editor-src": editor_scripts[-1], "pagerite:editor-src": editor_scripts[-1],
"pagerite:analytics-src": _analytics_assets()[0][0], "pagerite:analytics-src": _analytics_assets()[0][0],
"pagerite:langselect-src": langselect_scripts[-1], "pagerite:langselect-src": langselect_scripts[-1],
"pagerite:contact-src": contact_scripts[-1],
} }
if langselect_css: if langselect_css:
config["pagerite:langselect-css"] = ",".join(langselect_css) config["pagerite:langselect-css"] = ",".join(langselect_css)
if contact_css:
config["pagerite:contact-css"] = ",".join(contact_css)
if editor_css: if editor_css:
config["pagerite:editor-css"] = editor_css config["pagerite:editor-css"] = editor_css
# Localized contact-messaging strings (label = the {contact:} buttons'
# default and the visitor dialog's title, mailto subject — the address
# itself is revealed over the socket only after the PoW is solved).
# Absent entirely when messaging is disabled: pagerite.js then shows
# the corner ✉️ icon to admins only.
if contact is not None:
config["pagerite:contact-label"] = contact["label"]
config["pagerite:contact-subject"] = contact["subject"]
# Every site language's label/subject (JSON): live switching.
config["pagerite:contact-langs"] = contact["langs"]
if vite_url: if vite_url:
for key, value in config.items(): for key, value in config.items():
doc.meta(name=key, content=value) doc.meta(name=key, content=value)
@@ -786,14 +820,23 @@ def banner_source(menu: dict[str, Node], path: str) -> str | None:
return None return None
def _resolve_image_name(data: Data, name: str) -> str:
"""The store name a card-image setting resolves to: the "@favicon"
sentinel follows the site icon (set in the site editor — "" when
unset); anything else is already a store name."""
return data.favicon if name == "@favicon" else name
def card_image(menu: dict[str, Node], path: str) -> tuple[str, str]: def card_image(menu: dict[str, Node], path: str) -> tuple[str, str]:
"""The effective card image at ``path`` and which node supplied it. """The effective card image at ``path`` and which node supplied it.
Nearest ancestor with ``image`` set wins (the node itself first), the Nearest ancestor with ``image`` set wins (the node itself first), the
front page — a top-level sibling of the chain — last. ("", "") when no front page — a top-level sibling of the chain — last. ("", "") when no
node sets one: rendering falls back to mining the article HTML. The node sets one: rendering falls back to mining the article HTML (which
source path ("" = front page) feeds the editor banner panel's inherit beats an inherited image — see _card/_social_meta). The returned name
label. is the raw setting (may be "@favicon"; resolve with
_resolve_image_name). The source path ("" = front page) feeds the
editor banner panel's inherit label.
""" """
chain = resolve(menu, path) or [] chain = resolve(menu, path) or []
segs = path.split("/") segs = path.split("/")
@@ -875,13 +918,18 @@ def page_content(
# A {cards} tag places the card rows itself (possibly several); # A {cards} tag places the card rows itself (possibly several);
# without one the children are appended after the content as before. # without one the children are appended after the content as before.
has_cards_tag = _CARDS_TAG_RE.search(content) is not None has_cards_tag = _CARDS_TAG_RE.search(content) is not None
directives = None # Messaging disabled: {contact:} tags render nothing at all.
directives = {
"contact": (
(lambda args, _env: _contact_tag(args, _env, data, lang))
if data.contact_label.strip()
else (lambda _args, _env: "")
)
}
if has_cards_tag: if has_cards_tag:
directives = { directives["cards"] = lambda args, _env: _cards_tag(
"cards": lambda args, _env: _cards_tag( menu, data, node, path, args, translation, link_lang, lang
menu, data, node, path, args, translation, link_lang, lang )
)
}
rendered = render( rendered = render(
content, content,
path, path,
@@ -959,6 +1007,54 @@ def _cards(
_CARDS_TAG_RE = re.compile(r"^\{cards(?::[^{}\n]*)?\}[ \t]*$", re.MULTILINE) _CARDS_TAG_RE = re.compile(r"^\{cards(?::[^{}\n]*)?\}[ \t]*$", re.MULTILINE)
def _contact_config(data: Data, lang: str) -> dict[str, str]:
"""The localized contact-messaging strings for the page's asset config
(pagerite:contact-*): the {contact:} buttons' default label doubling as
the visitor dialog's title, and the mailto subject (the label when no
separate subject is configured). Translations come from the
chunk-keyed trans store (i18n.site_string). ``langs`` carries every
site language's variant as JSON, so the client switches strings live
with the page language (<html lang>) — language switches swap the page
in place without touching the asset config. The email address itself
is NOT here — it is revealed over the messaging socket only after the
proof of work is solved, so scrapers cannot lift it from pages."""
label = i18n.site_string(data, lang, data.contact_label)
langs = {}
for tag in sorted({i18n.primary_lang(data.menu, ""), *data.translate_langs}):
tr = i18n.site_string(data, tag, data.contact_label)
langs[tag] = {
"label": tr,
"subject": i18n.site_string(data, tag, data.contact_subject) or tr,
}
return {
"label": label,
"subject": i18n.site_string(data, lang, data.contact_subject) or label,
"langs": json.dumps(langs, ensure_ascii=False),
}
def _contact_tag(args: str, _env: dict, data: Data | None = None, lang: str = "") -> str:
"""Expand a ``{contact: Label}`` directive: the button that opens the
visitor contact panel (docs/messages.md). The args are a per-button
label overriding the configured site label (Data.contact_label,
localized here; "Contact us" is the last-resort fallback). Callers
expand the tag only when messaging is enabled — with a blank
contact_label the tag renders nothing at all. pagerite.js binds the
click and lazy-loads the panel bundle; in the editor preview the
button stays inert."""
label = args.strip()
if not label and data is not None:
label = i18n.site_string(data, lang, data.contact_label)
return str(
E.button(
E.span("✉️", class_="icon"),
label or "Contact us",
type="button",
class_="contact-trigger",
)
)
def _cards_tag( def _cards_tag(
menu: dict[str, Node], menu: dict[str, Node],
data: Data, data: Data,
@@ -1036,20 +1132,22 @@ def _walk(node: Node, path: str):
def _card_large(node: Node, image: str) -> bool: def _card_large(node: Node, image: str) -> bool:
"""Whether the card renders large (True) or small (False). """Whether the card renders large (True) or small (False).
Automatic: large when the image's probed store dimensions suit a large Automatic: large when the image is big and wide enough for the
card (>= 600px wide, landscape-ish aspect 1.4–2.5), small for full-card cover — wider than 600px, taller than 400px and clearly
small/portrait images — and, when dimensions are unknown or the image wider than tall (aspect > 1.05, so square and portrait images keep
is external, for any present image. The node's ``large`` setting the compact layout whose box they fit). When dimensions are unknown
(per-article, not inherited) overrides the automatic pick; None or the image is external, any present image defaults to large. The
means automatic. Shared by twitter:card (_social_meta, which maps it node's ``large`` setting (per-article, not inherited) overrides the
to "summary_large_image"/"summary") and the site's own cards (_card). automatic pick; None means automatic. Shared by twitter:card
(_social_meta, which maps it to "summary_large_image"/"summary") and
the site's own cards (_card).
""" """
large = bool(image) large = bool(image)
if (m := re.search(r"/_f/([0-9a-f]{12})$", image)) and ( if (m := re.search(r"/_f/([0-9a-f]{12})$", image)) and (
dims := _image_dims(m.group(1)) dims := _image_dims(m.group(1))
): ):
w, h = dims w, h = dims
large = w >= 600 and h > 0 and 1.4 <= w / h <= 2.5 large = w > 600 and h > 400 and w / h > 1.05
if node.large is not None: if node.large is not None:
large = node.large large = node.large
return large return large
@@ -1071,9 +1169,10 @@ def _card(
the small format). Imageless cards keep the image space blank (a the small format). Imageless cards keep the image space blank (a
gradient cover). gradient cover).
The cover is the page's resolved card image (Node.image, inheriting The cover is the node's own ``image`` when set, else mined from the
down the tree) when set, else mined from the rendered article like rendered article like og:image, else the inherited image (the nearest
og:image; the mode follows the same selection as twitter:card ancestor's or the front page's); the mode follows the same selection
as twitter:card
(_card_large: the node's override, else the image's dimensions). The (_card_large: the node's override, else the image's dimensions). The
card text localizes per target article where that page is available in card text localizes per target article where that page is available in
the language: the title comes from the translation's title map and the the language: the title comes from the translation's title map and the
@@ -1081,8 +1180,9 @@ def _card(
with per-card fallback to the original otherwise. with per-card fallback to the original otherwise.
""" """
image = html = "" image = html = ""
if name := card_image(menu, path)[0]: if node.image:
image = f"/_f/{name}" if name := _resolve_image_name(data, node.image):
image = f"/_f/{name}"
if node.chunks and not image: if node.chunks and not image:
md = node_markdown(data, node) or "" md = node_markdown(data, node) or ""
if lang and lang in node.langs: if lang and lang in node.langs:
@@ -1094,9 +1194,15 @@ def _card(
node.modified, node.modified,
# Card heuristics only mine the prose: nested {cards} rows # Card heuristics only mine the prose: nested {cards} rows
# would just be noise in the description extraction. # would just be noise in the description extraction.
directives={"cards": lambda _args, _env: ""}, directives={"cards": lambda _args, _env: "", "contact": lambda _a, _e: ""},
).html ).html
image, _ = _media(html) image, _ = _media(html)
if not image:
# The node's own setting was empty: an inherited image applies
# only when the article itself yielded none (card_image with no
# own image set resolves to the nearest ancestor's/front page's).
if name := _resolve_image_name(data, card_image(menu, path)[0]):
image = f"/_f/{name}"
large = _card_large(node, image) large = _card_large(node, image)
description = "" description = ""
if not large and node.chunks and not html: if not large and node.chunks and not html:
@@ -1108,7 +1214,7 @@ def _card(
path, path,
node.created, node.created,
node.modified, node.modified,
directives={"cards": lambda _args, _env: ""}, directives={"cards": lambda _args, _env: "", "contact": lambda _a, _e: ""},
).html ).html
if not large and html: if not large and html:
description = _description(html, 150) description = _description(html, 150)
@@ -1227,16 +1333,18 @@ def _social_meta(
brand: str, brand: str,
base_url: str, base_url: str,
card: str = "", card: str = "",
card_fallback: str = "",
) -> dict[str, str]: ) -> dict[str, str]:
"""Open Graph/Twitter/SEO meta tags for a content page. """Open Graph/Twitter/SEO meta tags for a content page.
The card image is the node's own ``image`` setting when one resolves The card image is the node's own ``image`` setting (``card``) when
(``card``, see card_image — the nearest ancestor's or the front set; with none set, heuristics over the rendered article pick the
page's otherwise); with none set, heuristics over the rendered article first representative <img> (a {.hero} first, then raster, then SVG);
pick the first representative <img> (a {.hero} first, then raster, only when the article yields none does the inherited image
then SVG). The description is the first paragraph's text; the first (``card_fallback`` — the nearest ancestor's or the front page's, see
<video> yields og:video. Absolute URLs are built from the request's card_image) apply. The description is the first paragraph's text; the
base (social scrapers cannot use relative ones). first <video> yields og:video. Absolute URLs are built from the
request's base (social scrapers cannot use relative ones).
``twitter:image`` pins extension-less store links to the ``.webp`` ``twitter:image`` pins extension-less store links to the ``.webp``
variant: X only honors WebP via twitter:image (not og:image) and its variant: X only honors WebP via twitter:image (not og:image) and its
@@ -1252,6 +1360,8 @@ def _social_meta(
_, video = _card_media(html, base_url) _, video = _card_media(html, base_url)
else: else:
image, video = _card_media(html, base_url) image, video = _card_media(html, base_url)
if not image and card_fallback and base_url:
image = f"{base_url}/_f/{card_fallback}"
twitter_image = re.sub(r"(/_f/[0-9a-f]{12})$", r"\1.webp", image) if image else "" twitter_image = re.sub(r"(/_f/[0-9a-f]{12})$", r"\1.webp", image) if image else ""
large = _card_large(node, image) large = _card_large(node, image)
return { return {
@@ -1334,8 +1444,20 @@ def render_page(
lang = original lang = original
title = _title(path.rpartition("/")[2], node, translation, path) title = _title(path.rpartition("/")[2], node, translation, path)
main = page_content(menu, data, path, translation, link_lang, lang) main = page_content(menu, data, path, translation, link_lang, lang)
# The card image priority: the node's own setting, then mined from the
# article (inside _social_meta), then the inherited one. card_image
# resolves both: its source equals the path iff the node itself set it.
img, img_from = card_image(menu, path)
img = _resolve_image_name(data, img)
social = _social_meta( social = _social_meta(
node, path, title, str(main), brand, base_url, card_image(menu, path)[0] node,
path,
title,
str(main),
brand,
base_url,
card=img if img_from == path else "",
card_fallback="" if img_from == path else img,
) )
canonical, alternates = _language_urls(data, path, node, lang, original, base_url) canonical, alternates = _language_urls(data, path, node, lang, original, base_url)
return str( return str(
@@ -1350,6 +1472,9 @@ def render_page(
lang, lang,
canonical, canonical,
alternates, alternates,
# The page's Markdown counterpart (pages.show_page's .md mode).
f"/{path}.md",
contact=_contact_config(data, lang) if data.contact_label.strip() else None,
)( )(
Title=f"{title} – {brand}" if brand else title, Title=f"{title} – {brand}" if brand else title,
Brand=_brand_link(brand, brand_html, link_lang), Brand=_brand_link(brand, brand_html, link_lang),
@@ -1413,6 +1538,7 @@ def render_category(
favicon, favicon,
lang=lang, lang=lang,
alternates=alternates, alternates=alternates,
contact=_contact_config(data, lang) if data.contact_label.strip() else None,
)( )(
Title=f"{title} – {brand}" if brand else title, Title=f"{title} – {brand}" if brand else title,
Brand=_brand_link(brand, brand_html, link_lang), Brand=_brand_link(brand, brand_html, link_lang),
@@ -1533,6 +1659,30 @@ def _langselect_assets() -> tuple[list[str], list[str]]:
return _asset_cache["langselect"] return _asset_cache["langselect"]
def _contact_assets() -> tuple[list[str], list[str]]:
"""Script and stylesheet URLs for the on-demand contact panel."""
vite_url = env.vite_url
if vite_url:
return [f"{vite_url}/src/contact-main.js"], []
if "contact" not in _asset_cache:
manifest = _manifest()
# import() loads no CSS automatically: collect the stylesheets of
# the entry and its imported chunks (same walk as _langselect).
scripts, stylesheets, seen = [], [], set()
queue = ["src/contact-main.js"]
for key in queue: # grows with imported chunks
if key in seen:
continue
seen.add(key)
entry = manifest[key]
if entry.get("isEntry"):
scripts.append(f"/{entry['file']}")
stylesheets += [f"/{css}" for css in entry.get("css", [])]
queue += entry.get("imports", [])
_asset_cache["contact"] = scripts, stylesheets
return _asset_cache["contact"]
def render_analytics( def render_analytics(
menu: dict[str, Node], menu: dict[str, Node],
brand: str = SITE_NAME, brand: str = SITE_NAME,
+1
View File
@@ -17,6 +17,7 @@ readme = "README.md"
requires-python = ">=3.14" requires-python = ">=3.14"
dependencies = [ dependencies = [
"blake3>=1.0.9", "blake3>=1.0.9",
"easypow>=0.1.0",
"fastapi-vue~=1.7.2", "fastapi-vue~=1.7.2",
"fastapi[standard]>=0.141.1", "fastapi[standard]>=0.141.1",
"html5tagger>=2.0.0", "html5tagger>=2.0.0",