Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7724290921 | ||
|
|
3b1804b093 | ||
|
|
4cd8dbfc73 | ||
|
|
dc4bdf6efc | ||
|
|
a458bded09 | ||
|
|
3a4745389e | ||
|
|
4eea3ae3af | ||
|
|
69583fb9fe | ||
|
|
b57b7060ec | ||
|
|
3f27a0a292 | ||
|
|
b30d909a23 | ||
|
|
13fecd2118 | ||
|
|
11a138e19f | ||
|
|
ebd5911a38 | ||
|
|
db57125953 | ||
|
|
986e28c220 |
@@ -25,10 +25,12 @@ Pagerite is a CMS. See `docs` for the full design and implementation details. Ke
|
|||||||
- `markdown.py` — markdown-it-py renderer.
|
- `markdown.py` — markdown-it-py renderer.
|
||||||
- `views.py` — shared page layout and rendering; theme/user-font resolution across `THEME_DIRS` / `FONT_DIRS` (cwd, site, platform data roots, then built-in `pagerite/themes/`, see `docs/themes-and-assets.md`).
|
- `views.py` — shared page layout and rendering; theme/user-font resolution across `THEME_DIRS` / `FONT_DIRS` (cwd, site, platform data roots, then built-in `pagerite/themes/`, see `docs/themes-and-assets.md`).
|
||||||
- `seed.py` — demo content, written only on first database creation.
|
- `seed.py` — demo content, written only on first database creation.
|
||||||
- `analytics.py` — visit analytics collection (see `docs/analytics.md`).
|
- `analytics.py` — visit analytics collection (see `docs/analytics.md`). UA formatting/bot detection comes from the **uarite** package.
|
||||||
- `frontend/src/` — Vue editor and public-page JS entries.
|
- `frontend/src/` — Vue editor and public-page JS entries.
|
||||||
- `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).
|
||||||
|
- `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.
|
||||||
@@ -64,6 +66,6 @@ Server run by CLI entry point `uv run pagerite` (no auto reloads, build needed).
|
|||||||
## Conventions
|
## Conventions
|
||||||
|
|
||||||
- Keep dependencies minimal; add via `uv add` and mention it.
|
- Keep dependencies minimal; add via `uv add` and mention it.
|
||||||
- The public URL space belongs to content (pretty slugs at root). Reserve only `/_` for the machinery (`/_api/`, `/_f/`, `/_assets/`), plus `/favicon.ico` from the build. Slugs are lowercase ASCII letters, digits, hyphens and underscores `[a-z0-9_-]` (the site editor filters input live via `slugify.js`, built on the `transliteration` npm package — unicode folds to ASCII, spaces become hyphens; an empty slug on a new page is derived from its title), may not begin with `_` or `.`, and such URLs are never looked up as content.
|
- The public URL space belongs to content (pretty slugs at root). Reserve only `/_` for the machinery (`/_api/`, `/_f/`, `/_assets/`), plus `/favicon.ico` (backend redirect to the configured site icon). Slugs are lowercase ASCII letters, digits, hyphens and underscores `[a-z0-9_-]` (the site editor filters input live via `slugify.js`, built on the `transliteration` npm package — unicode folds to ASCII, spaces become hyphens; an empty slug on a new page is derived from its title), may not begin with `_` or `.`, and such URLs are never looked up as content.
|
||||||
- No auth in core code; the SSO/reverse proxy gates all of `/_api` (forward-auth) and owns `/auth/` (login/logout, session validation). Pages render identically for everyone; pagerite.js adds the editing UI only after the auth server validates the session. The one keyed exception is `/_translate/{key}` (translator service; `Data.translate_keys`, see docs/localization.md).
|
- No auth in core code; the SSO/reverse proxy gates all of `/_api` (forward-auth) and owns `/auth/` (login/logout, session validation). Pages render identically for everyone; pagerite.js adds the editing UI only after the auth server validates the session. The one keyed exception is `/_translate/{key}` (translator service; `Data.translate_keys`, see docs/localization.md).
|
||||||
- Update the relevant MarkDown files when architecture, tooling, or conventions change.
|
- Update the relevant MarkDown files when architecture, tooling, or conventions change.
|
||||||
|
|||||||
+49
-13
@@ -38,6 +38,9 @@ Each `Get` record (one per served document):
|
|||||||
(`x-pagerite-preload` header): never counted as a view, crawler hit or
|
(`x-pagerite-preload` header): never counted as a view, crawler hit or
|
||||||
abuse — recorded only so a navigation later served from the in-memory page
|
abuse — recorded only so a navigation later served from the in-memory page
|
||||||
cache (which issues no GET at all) can be attributed this GET's status,
|
cache (which issues no GET at all) can be attributed this GET's status,
|
||||||
|
- `lang` — rendered content language of the served document (the resolved
|
||||||
|
language of a localized page), `""` for non-localized responses (404
|
||||||
|
probes, reserved paths),
|
||||||
- `client` — 6-byte blake3 hash referencing `Analytics.clients`.
|
- `client` — 6-byte blake3 hash referencing `Analytics.clients`.
|
||||||
|
|
||||||
304 revalidation responses return before recording and are not logged.
|
304 revalidation responses return before recording and are not logged.
|
||||||
@@ -51,7 +54,9 @@ Each `Msg` record (one per pagerite.js activity message over `/_ws`):
|
|||||||
- `to` — navigation target (validated at record time: internal slug path or
|
- `to` — navigation target (validated at record time: internal slug path or
|
||||||
external https URL; anything else is dropped — sanitation, not
|
external https URL; anything else is dropped — sanitation, not
|
||||||
classification),
|
classification),
|
||||||
- `read` — active seconds spent on `fr` since the previous report.
|
- `read` — active seconds spent on `fr` since the previous report,
|
||||||
|
- `lang` — rendered language reported by the client for the page the
|
||||||
|
activity happened on (the page's `<html lang>`; `""` from old clients).
|
||||||
|
|
||||||
Each `Client` record (shared by every event, keyed by hash):
|
Each `Client` record (shared by every event, keyed by hash):
|
||||||
|
|
||||||
@@ -63,20 +68,35 @@ Each `Client` record (shared by every event, keyed by hash):
|
|||||||
when a database is available,
|
when a database is available,
|
||||||
- `city` — city name from the DB-IP MMDB lookup, when available,
|
- `city` — city name from the DB-IP MMDB lookup, when available,
|
||||||
- `ua` — raw `User-Agent` string,
|
- `ua` — raw `User-Agent` string,
|
||||||
- `ua_pretty` — compact display form of the UA (browser/OS/device) when
|
|
||||||
parsable, otherwise the raw string,
|
|
||||||
- `hide` — true for admin clients (`hide` message field): everything this
|
- `hide` — true for admin clients (`hide` message field): everything this
|
||||||
client ever did is recorded but excluded from every statistic and from the
|
client ever did is recorded but excluded from every statistic and from the
|
||||||
viewer payload. This is the one flag set at record time — it is a client
|
viewer payload. This is the one flag set at record time — it is a client
|
||||||
property, not a classification.
|
property, not a classification.
|
||||||
|
|
||||||
|
The viewer payload adds one display-time field to each client, never
|
||||||
|
persisted (stored records keep the default and old data always follows the
|
||||||
|
current uarite version):
|
||||||
|
|
||||||
|
- `uarite` — the `uarite.UA` dataclass from parsing the raw UA
|
||||||
|
(`pretty`/`engine`/`os`/`provider`/`kind`/`url`): the crawler name for
|
||||||
|
bots,
|
||||||
|
with a category suffix only where a provider runs crawlers of more than
|
||||||
|
one kind (`GPTBot (AI)` vs `OAI-SearchBot (search)`, `Googlebot (search)`
|
||||||
|
vs `Google-Extended (AI)`; single-kind providers stay plain: `Facebook`,
|
||||||
|
`WhatsApp`), `Browser/major OS` on the desktop, the device where that is
|
||||||
|
the relevant information (iPhone reports its iOS version, Android phones
|
||||||
|
their model instead of the OS), otherwise the raw string; `url` is the
|
||||||
|
crawler's info page when uarite knows one (rendered as a 🔗 link after the
|
||||||
|
pretty UA in the viewer), `kind` drives the bot classification.
|
||||||
|
|
||||||
A reverse-DNS lookup is attempted for each new client and the result, when
|
A reverse-DNS lookup is attempted for each new client and the result, when
|
||||||
available, is stored as `host`; local/reserved/multicast addresses are
|
available, is stored as `host`; local/reserved/multicast addresses are
|
||||||
skipped. If a DB-IP MMDB file (`dbip-*.mmdb` or `dbip-*.mmdb.gz`) is present
|
skipped. If a DB-IP MMDB file (`dbip-*.mmdb` or `dbip-*.mmdb.gz`) is present
|
||||||
in the repository root, it is loaded at startup and used to look up
|
in the working directory, it is loaded at startup and used to look up
|
||||||
`country`/`city`. These lookups run in background tasks after the event is
|
`country`/`city`. These lookups run in background tasks after the event is
|
||||||
stored, so WebSocket message handling is never delayed. The decompressed
|
stored, so WebSocket message handling is never delayed. Only the downloaded
|
||||||
`dbip-*.mmdb` file is kept in the repository root and ignored by git. The
|
`.mmdb.gz` is kept on disk (in the working directory, ignored by git); it is
|
||||||
|
decompressed into RAM when opened. The
|
||||||
CLI flag `--dbip` (`uv run pagerite --dbip`) downloads the latest
|
CLI flag `--dbip` (`uv run pagerite --dbip`) downloads the latest
|
||||||
`dbip-city-lite-YYYY-MM.mmdb.gz` from DB-IP at startup (in the app lifespan,
|
`dbip-city-lite-YYYY-MM.mmdb.gz` from DB-IP at startup (in the app lifespan,
|
||||||
before the MMDB is opened), skipping the download when the local database is
|
before the MMDB is opened), skipping the download when the local database is
|
||||||
@@ -89,7 +109,9 @@ The client (`pagerite.js`) keeps a WebSocket connection to `/_ws` for the
|
|||||||
whole browsing session and sends activity messages over it — JSON text
|
whole browsing session and sends activity messages over it — JSON text
|
||||||
frames matching the server's `Ping` msgspec struct with the fields `fr`
|
frames matching the server's `Ping` msgspec struct with the fields `fr`
|
||||||
(source path), `to` (navigation target), `read` (active seconds on `fr`
|
(source path), `to` (navigation target), `read` (active seconds on `fr`
|
||||||
since the last report) and `hide`; falsy fields are omitted. One channel
|
since the last report), `lang` (the rendered language of the page the
|
||||||
|
activity happened on — its `<html lang>`) and `hide`; falsy fields are
|
||||||
|
omitted. One channel
|
||||||
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
|
||||||
@@ -158,17 +180,25 @@ for misses.
|
|||||||
(`_SESSION_GAP`). A fresh page load with an already-open visit (second
|
(`_SESSION_GAP`). A fresh page load with an already-open visit (second
|
||||||
tab) extends it, logging a `(direct)` transition. The visit's trail holds
|
tab) extends it, logging a `(direct)` transition. The visit's trail holds
|
||||||
first-seen targets in order; `read` updates accumulate active seconds on
|
first-seen targets in order; `read` updates accumulate active seconds on
|
||||||
the trail item matching `fr`. Each trail item's HTTP status comes from
|
the trail item matching `fr` (preferring the item whose language matches
|
||||||
|
the report, so seconds after a language switch land on the new-language
|
||||||
|
step). Each trail item's HTTP status comes from
|
||||||
the client's latest GET for that path — preloads included, which is what
|
the client's latest GET for that path — preloads included, which is what
|
||||||
allows 404 pages to render red in the viewer even when the navigation
|
allows 404 pages to render red in the viewer even when the navigation
|
||||||
itself was served from the page cache. The entry page's referer and
|
itself was served from the page cache. Each trail item also carries the
|
||||||
|
rendered language: the client's report, for the entry page falling back
|
||||||
|
to its GET's rendered language (old clients don't send one); a page
|
||||||
|
re-visited in a different language becomes a distinct trail step instead
|
||||||
|
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).
|
||||||
- **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,
|
||||||
GoogleOther, Applebot, ...) do connect and send messages, but their UA
|
GoogleOther, Applebot, ...) do connect and send messages, but their UA
|
||||||
gives them away (`_is_bot_ua`): their messages are ignored at display
|
gives them away (`_is_bot_ua`, backed by `uarite.uaparse` — which
|
||||||
|
also knows the disguised ones: facebookexternalhit, Google-Extended,
|
||||||
|
WhatsApp, ...): their messages are ignored at display
|
||||||
time, so their GETs never match and land in the crawler list too. Real-
|
time, so their GETs never match and land in the crawler list too. Real-
|
||||||
browser bots whose UA does not match are caught by engagement: a visit
|
browser bots whose UA does not match are caught by engagement: a visit
|
||||||
whose total reported reading time is under 5 seconds (`_MIN_VISIT_READ`;
|
whose total reported reading time is under 5 seconds (`_MIN_VISIT_READ`;
|
||||||
@@ -215,6 +245,10 @@ to tell misses from real pages at a glance.
|
|||||||
The `Display` payload contains the derived `visits`, `crawlers` and `abuse`
|
The `Display` payload contains the derived `visits`, `crawlers` and `abuse`
|
||||||
rows (structs `Visit`/`Nav`/`TrailItem`, `CrawlerHit`, `AbuseHit` — display
|
rows (structs `Visit`/`Nav`/`TrailItem`, `CrawlerHit`, `AbuseHit` — display
|
||||||
DTOs only, never persisted), the visible `clients`, the fetched `favicons`,
|
DTOs only, never persisted), the visible `clients`, the fetched `favicons`,
|
||||||
|
the site language context (`multilingual` — translation languages are
|
||||||
|
configured, so the viewer can suppress language UI on single-language
|
||||||
|
sites — and `primary_lang` — the front page's primary language, so the
|
||||||
|
viewer can skip the primary-language default case),
|
||||||
and the aggregates below.
|
and the aggregates below.
|
||||||
|
|
||||||
Each derived `Visit`:
|
Each derived `Visit`:
|
||||||
@@ -226,8 +260,9 @@ Each derived `Visit`:
|
|||||||
- `trail` — the entry page and everything seen afterwards, keyed by the
|
- `trail` — the entry page and everything seen afterwards, keyed by the
|
||||||
timestamp of first sight (insertion order = first-seen order). Each item
|
timestamp of first sight (insertion order = first-seen order). Each item
|
||||||
holds `to` (page path or external exit URL), the accumulated active
|
holds `to` (page path or external exit URL), the accumulated active
|
||||||
reading time in seconds (`read`) and the most recent HTTP status seen
|
reading time in seconds (`read`), the most recent HTTP status seen
|
||||||
for the target (`status`),
|
for the target (`status`) and the rendered language (`lang`; a page
|
||||||
|
seen in two languages within one visit gets one item per language),
|
||||||
- `navs` — every navigation (`fr`, `to`), keyed by its timestamp, repeats
|
- `navs` — every navigation (`fr`, `to`), keyed by its timestamp, repeats
|
||||||
included. The aggregates are computed from this log,
|
included. The aggregates are computed from this log,
|
||||||
- `utm` — `utm_*` query parameters from the landing URL, as a dict.
|
- `utm` — `utm_*` query parameters from the landing URL, as a dict.
|
||||||
@@ -240,7 +275,8 @@ Each derived `CrawlerHit`:
|
|||||||
- `referer` — external https origin of the request, `""` for direct/none,
|
- `referer` — external https origin of the request, `""` for direct/none,
|
||||||
- `query` — raw query string of the request,
|
- `query` — raw query string of the request,
|
||||||
- `status` — HTTP status of the served response (200 for a real page, 404
|
- `status` — HTTP status of the served response (200 for a real page, 404
|
||||||
for a category placeholder or missing page).
|
for a category placeholder or missing page),
|
||||||
|
- `lang` — rendered content language of the served document (from the GET).
|
||||||
|
|
||||||
Each derived `AbuseHit`:
|
Each derived `AbuseHit`:
|
||||||
|
|
||||||
|
|||||||
+20
-7
@@ -53,11 +53,13 @@ Region tags normalize to their base subtag (`fi-FI` → `fi`).
|
|||||||
article's own language), `?lang=xx` when serving a translation — however
|
article's own language), `?lang=xx` when serving a translation — however
|
||||||
the language was arrived at (query or header).
|
the language was arrived at (query or header).
|
||||||
- `<link rel="alternate" hreflang="…">` entries follow the canonical
|
- `<link rel="alternate" hreflang="…">` entries follow the canonical
|
||||||
directly (before the social meta tags) and are the same set on every
|
directly (before the social meta tags) and list the languages the page
|
||||||
page — the site-wide configured languages (`translate_langs`, which the
|
is **actually available in**: `x-default` first, pointing at the plain
|
||||||
translator works to fill in): `x-default` first, pointing at the plain
|
autodetecting URL, then every available language — the original again by
|
||||||
autodetecting URL, then every language explicitly with `?lang=`, the
|
its plain URL, translations by `?lang=`. The public language selector
|
||||||
page's own primary language included.
|
keys off these: pagerite.js mounts the editors' flag dropdown in the
|
||||||
|
top-right corner when the head advertises x-default plus more than one
|
||||||
|
language, loading its bundle (Vue + the flag SVG set) on demand.
|
||||||
- The override sticks for the session of clicks: a page requested with
|
- The override sticks for the session of clicks: a page requested with
|
||||||
`?lang=` replicates the query onto the navigation links it renders (nav,
|
`?lang=` replicates the query onto the navigation links it renders (nav,
|
||||||
sidebar, cards, brand — in-article links are content and stay as
|
sidebar, cards, brand — in-article links are content and stay as
|
||||||
@@ -66,6 +68,11 @@ Region tags normalize to their base subtag (`fi-FI` → `fi`).
|
|||||||
`history.replaceState` (pretty, shareable URLs), remembers the language,
|
`history.replaceState` (pretty, shareable URLs), remembers the language,
|
||||||
and adds it to every internal fetch that lacks one (preloads,
|
and adds it to every internal fetch that lacks one (preloads,
|
||||||
fetch-navigations, history traversals); history entries stay query-less.
|
fetch-navigations, history traversals); history entries stay query-less.
|
||||||
|
- The public selector's pick is the same override, pure JS state
|
||||||
|
(`pagerite:set-session-lang`): the session language changes and the page
|
||||||
|
swaps in place — no `?lang=` in the address bar, no reload. The choice is
|
||||||
|
linked with the editor panel's language dropdown both ways; closing the
|
||||||
|
panel keeps the chosen language instead of reverting.
|
||||||
- A full page refresh or a shared link resets to automatic selection (header
|
- A full page refresh or a shared link resets to automatic selection (header
|
||||||
only). This gives a clean one-time override without cookies.
|
only). This gives a clean one-time override without cookies.
|
||||||
|
|
||||||
@@ -99,7 +106,9 @@ Region tags normalize to their base subtag (`fi-FI` → `fi`).
|
|||||||
language like content pages, but over the **subtree's** combined
|
language like content pages, but over the **subtree's** combined
|
||||||
availability (`subtree_languages`) — they have no chunks of their own;
|
availability (`subtree_languages`) — they have no chunks of their own;
|
||||||
the heading, navigation and card text localize from the title map and
|
the heading, navigation and card text localize from the title map and
|
||||||
the target articles' translations.
|
the target articles' translations. Their hreflang alternates are
|
||||||
|
computed exactly like a content page's (a translated title counts as
|
||||||
|
availability, so the language selector is offered there too).
|
||||||
- Card descriptions and cover picks run on the target article's hybrid
|
- Card descriptions and cover picks run on the target article's hybrid
|
||||||
Markdown where that page is available in the served language, with
|
Markdown where that page is available in the served language, with
|
||||||
per-card fallback to the original.
|
per-card fallback to the original.
|
||||||
@@ -137,7 +146,11 @@ served Markdown at render time.
|
|||||||
|
|
||||||
`chunk_markdown(markdown)` splits the source into block-level chunks —
|
`chunk_markdown(markdown)` splits the source into block-level chunks —
|
||||||
blank-line-separated blocks: headings, paragraphs, code fences (kept whole),
|
blank-line-separated blocks: headings, paragraphs, code fences (kept whole),
|
||||||
list blocks, tables, HTML blocks. A chunk's identity is its **source text**,
|
list blocks, tables, HTML blocks. Container fence lines (`::: name` openers
|
||||||
|
and `:::` closers) are always their own chunk, blank lines or not — folded
|
||||||
|
into a prose chunk the closer would cross to the translator as part of the
|
||||||
|
text, where the model can drop it (the rest of the page then renders inside
|
||||||
|
the container). A chunk's identity is its **source text**,
|
||||||
gettext-msgid style:
|
gettext-msgid style:
|
||||||
|
|
||||||
```python
|
```python
|
||||||
|
|||||||
@@ -20,6 +20,7 @@
|
|||||||
"codemirror": "^6.0.2",
|
"codemirror": "^6.0.2",
|
||||||
"country-flag-icons": "^1.6.20",
|
"country-flag-icons": "^1.6.20",
|
||||||
"overlayscrollbars": "^2.16.0",
|
"overlayscrollbars": "^2.16.0",
|
||||||
|
"pinia": "^4.0.3",
|
||||||
"transliteration": "^2.6.1",
|
"transliteration": "^2.6.1",
|
||||||
"vue": "^3.5.26",
|
"vue": "^3.5.26",
|
||||||
"vuedraggable": "^4.1.0"
|
"vuedraggable": "^4.1.0"
|
||||||
|
|||||||
@@ -23,6 +23,7 @@ import {
|
|||||||
formatVisitRows,
|
formatVisitRows,
|
||||||
} from './analytics/format.js'
|
} from './analytics/format.js'
|
||||||
import TrailLink from './TrailLink.vue'
|
import TrailLink from './TrailLink.vue'
|
||||||
|
import RefererBadge from './RefererBadge.vue'
|
||||||
import VisitorCell from './VisitorCell.vue'
|
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'
|
||||||
@@ -160,9 +161,15 @@ watch(range, (r) => {
|
|||||||
|
|
||||||
const clients = computed(() => data.value?.clients || {})
|
const clients = computed(() => data.value?.clients || {})
|
||||||
const favicons = computed(() => data.value?.favicons || {})
|
const favicons = computed(() => data.value?.favicons || {})
|
||||||
const visitRows = computed(() => formatVisitRows(visits.value, clients.value, pageTree.value, now.value))
|
// Site language context from the payload: drives the discreet rendered-
|
||||||
|
// language markers in the visit/crawler rows (multilingual sites only).
|
||||||
|
const site = computed(() => ({
|
||||||
|
multilingual: !!data.value?.multilingual,
|
||||||
|
primaryLang: data.value?.primary_lang || '',
|
||||||
|
}))
|
||||||
|
const visitRows = computed(() => formatVisitRows(visits.value, clients.value, pageTree.value, now.value, site.value))
|
||||||
const crawlers = computed(() => rangeData.value?.crawlers || [])
|
const crawlers = computed(() => rangeData.value?.crawlers || [])
|
||||||
const crawlerRows = computed(() => formatCrawlerRows(crawlers.value, clients.value, pageTree.value, now.value))
|
const crawlerRows = computed(() => formatCrawlerRows(crawlers.value, clients.value, pageTree.value, now.value, site.value))
|
||||||
const abuseRows = computed(() => formatAbuseRows(rangeData.value?.abuse || [], clients.value, pageTree.value, now.value))
|
const abuseRows = computed(() => formatAbuseRows(rangeData.value?.abuse || [], clients.value, pageTree.value, now.value))
|
||||||
|
|
||||||
</script>
|
</script>
|
||||||
@@ -209,15 +216,16 @@ const abuseRows = computed(() => formatAbuseRows(rangeData.value?.abuse || [], c
|
|||||||
<tbody>
|
<tbody>
|
||||||
<tr v-for="(v, i) in visitRows" :key="i">
|
<tr v-for="(v, i) in visitRows" :key="i">
|
||||||
<td class="trail">
|
<td class="trail">
|
||||||
<TrailLink v-if="v.refererStep" :step="v.refererStep" :favicons="favicons" @close="$emit('close')" />
|
<RefererBadge v-if="v.refererBadge" :badge="v.refererBadge" :favicons="favicons" />
|
||||||
<span v-if="v.utm && v.utm !== '—'" class="utm-tag small muted" :title="v.utmTitle">{{ v.utm }}</span>
|
<span v-if="v.rowFlag" class="flag" v-html="v.rowFlag" :title="v.rowFlagTitle"></span>
|
||||||
<TrailLink v-for="(s, si) in v.trail" :key="si" :step="s" :favicons="favicons" @close="$emit('close')" />
|
<TrailLink v-for="(s, si) in v.trail" :key="si" :step="s" :favicons="favicons" :flags="s.langFlags" @close="$emit('close')" />
|
||||||
</td>
|
</td>
|
||||||
<VisitorCell
|
<VisitorCell
|
||||||
:ip="v.ip"
|
:ip="v.ip"
|
||||||
:ip-display="v.ipDisplay"
|
:ip-display="v.ipDisplay"
|
||||||
:ua="v.ua"
|
:ua="v.ua"
|
||||||
:ua-raw="v.uaRaw"
|
:ua-raw="v.uaRaw"
|
||||||
|
:ua-url="v.uaUrl"
|
||||||
:country="v.country"
|
:country="v.country"
|
||||||
:city="v.city"
|
:city="v.city"
|
||||||
:lang="v.lang"
|
:lang="v.lang"
|
||||||
@@ -245,14 +253,16 @@ const abuseRows = computed(() => formatAbuseRows(rangeData.value?.abuse || [], c
|
|||||||
<tbody>
|
<tbody>
|
||||||
<tr v-for="(c, i) in crawlerRows" :key="i">
|
<tr v-for="(c, i) in crawlerRows" :key="i">
|
||||||
<td class="trail">
|
<td class="trail">
|
||||||
<TrailLink v-if="c.refererStep" :step="c.refererStep" :favicons="favicons" @close="$emit('close')" />
|
<RefererBadge v-if="c.refererBadge" :badge="c.refererBadge" :favicons="favicons" />
|
||||||
<TrailLink v-for="(s, si) in c.pages" :key="si" :step="s" :count="s.count" @close="$emit('close')" />
|
<TrailLink v-for="(s, si) in c.pages" :key="si" :step="s" :count="s.count" @close="$emit('close')" />
|
||||||
|
<span v-for="(f, fi) in c.readFlags" :key="fi" class="flag" v-html="f.flag" :title="f.name"></span>
|
||||||
</td>
|
</td>
|
||||||
<VisitorCell
|
<VisitorCell
|
||||||
:ip="c.ip"
|
:ip="c.ip"
|
||||||
:ip-display="c.ipDisplay"
|
:ip-display="c.ipDisplay"
|
||||||
:ua="c.ua"
|
:ua="c.ua"
|
||||||
:ua-raw="c.uaRaw"
|
:ua-raw="c.uaRaw"
|
||||||
|
:ua-url="c.uaUrl"
|
||||||
:country="c.country"
|
:country="c.country"
|
||||||
:city="c.city"
|
:city="c.city"
|
||||||
:lang="c.lang"
|
:lang="c.lang"
|
||||||
@@ -299,6 +309,8 @@ const abuseRows = computed(() => formatAbuseRows(rangeData.value?.abuse || [], c
|
|||||||
:ip-display="a.ipDisplay"
|
:ip-display="a.ipDisplay"
|
||||||
:ua="a.ua"
|
:ua="a.ua"
|
||||||
:ua-raw="a.uaRaw"
|
:ua-raw="a.uaRaw"
|
||||||
|
:ua-url="a.uaUrl"
|
||||||
|
:ua-raws="a.uaRaws"
|
||||||
:country="a.country"
|
:country="a.country"
|
||||||
:city="a.city"
|
:city="a.city"
|
||||||
:lang="a.lang"
|
:lang="a.lang"
|
||||||
@@ -468,16 +480,30 @@ const abuseRows = computed(() => formatAbuseRows(rangeData.value?.abuse || [], c
|
|||||||
color: var(--error, #c00);
|
color: var(--error, #c00);
|
||||||
}
|
}
|
||||||
|
|
||||||
.visit-table .utm-tag {
|
/* The referer badge outgrows the 8rem trail-link cap (it carries the UTM
|
||||||
display: inline-block;
|
summary too); keep the inline-flex layout from the component. */
|
||||||
|
.visit-table .trail a.referer-badge {
|
||||||
|
display: inline-flex;
|
||||||
max-width: 100%;
|
max-width: 100%;
|
||||||
padding: 0.05rem 0.4rem;
|
}
|
||||||
border: 1px solid var(--line);
|
|
||||||
border-radius: 0.25rem;
|
/* Same flag chip as the visitor cells (VisitorCell.vue); the flags here
|
||||||
white-space: nowrap;
|
mark the language the page was read in. */
|
||||||
|
.visit-table .flag {
|
||||||
|
display: inline-flex;
|
||||||
|
width: 18px;
|
||||||
|
height: 12px;
|
||||||
|
border-radius: 2px;
|
||||||
overflow: hidden;
|
overflow: hidden;
|
||||||
text-overflow: ellipsis;
|
border: 1px solid var(--line);
|
||||||
vertical-align: bottom;
|
box-shadow: 0 0 0 1px rgba(0, 0, 0, 0.2) inset;
|
||||||
|
vertical-align: middle;
|
||||||
|
}
|
||||||
|
|
||||||
|
.visit-table .flag :deep(svg) {
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
display: block;
|
||||||
}
|
}
|
||||||
|
|
||||||
.visit-table .clickable-list {
|
.visit-table .clickable-list {
|
||||||
@@ -506,22 +532,6 @@ const abuseRows = computed(() => formatAbuseRows(rangeData.value?.abuse || [], c
|
|||||||
.visit-table .clickable-list,
|
.visit-table .clickable-list,
|
||||||
.visit-table .last-seen {
|
.visit-table .last-seen {
|
||||||
cursor: pointer;
|
cursor: pointer;
|
||||||
position: relative;
|
|
||||||
}
|
|
||||||
|
|
||||||
.visit-table :deep(.copy-popup) {
|
|
||||||
position: absolute;
|
|
||||||
bottom: calc(100% + 0.25rem);
|
|
||||||
left: 50%;
|
|
||||||
transform: translateX(-50%);
|
|
||||||
padding: 0.15rem 0.4rem;
|
|
||||||
background: var(--text, CanvasText);
|
|
||||||
color: var(--bg, Canvas);
|
|
||||||
border-radius: 0.25rem;
|
|
||||||
font-size: 0.75rem;
|
|
||||||
white-space: nowrap;
|
|
||||||
pointer-events: none;
|
|
||||||
z-index: 10;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
.crawler-top-uas {
|
.crawler-top-uas {
|
||||||
|
|||||||
@@ -403,14 +403,6 @@ onUnmounted(() => {
|
|||||||
margin-left: auto;
|
margin-left: auto;
|
||||||
padding: 0 0.2rem;
|
padding: 0 0.2rem;
|
||||||
font-size: 1rem;
|
font-size: 1rem;
|
||||||
background: none;
|
|
||||||
border: none;
|
|
||||||
cursor: pointer;
|
|
||||||
opacity: 0.7;
|
|
||||||
}
|
|
||||||
|
|
||||||
.block-head .icon-btn:hover {
|
|
||||||
opacity: 1;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/* The banner design selector stays compact; the upload button is pushed
|
/* The banner design selector stays compact; the upload button is pushed
|
||||||
|
|||||||
@@ -21,11 +21,11 @@ const currentPath = ref(props.pagePath)
|
|||||||
const activeMode = ref(props.initialMode)
|
const activeMode = ref(props.initialMode)
|
||||||
|
|
||||||
// The shared language selection (./editorLang, v-modeled by the tabs'
|
// The shared language selection (./editorLang, v-modeled by the tabs'
|
||||||
// LangSelects) also drives the page preview: while the shell is open it
|
// LangSelects) is linked to the whole-page language: while the shell is
|
||||||
// overrides the normal language preferences (?lang= / Accept-Language),
|
// open it drives the page preview (overrides ?lang= / Accept-Language),
|
||||||
// so the page renders in the language being edited; closing restores.
|
// and closing keeps the pick as the session language. The primary
|
||||||
// The primary selection pins by the CURRENT PAGE's own primary language
|
// selection pins by the CURRENT PAGE's own primary language (pages may
|
||||||
// (pages may differ — Node.language is inherited down the tree).
|
// differ — Node.language is inherited down the tree).
|
||||||
let pinned = false
|
let pinned = false
|
||||||
function pinPreviewLang() {
|
function pinPreviewLang() {
|
||||||
pinned = true
|
pinned = true
|
||||||
@@ -34,6 +34,15 @@ function pinPreviewLang() {
|
|||||||
setLangOverride(editorLang.value || pagePrimary.value || 'en')
|
setLangOverride(editorLang.value || pagePrimary.value || 'en')
|
||||||
loadPlain(currentPath.value)
|
loadPlain(currentPath.value)
|
||||||
}
|
}
|
||||||
|
// Opening the panel must not switch the page's language: adopt the
|
||||||
|
// session's chosen language (public selector / earlier pick) once, then
|
||||||
|
// pin. Runs only on (re)open — after that the selection is the user's.
|
||||||
|
function openShell() {
|
||||||
|
const session = window.__pageriteLang
|
||||||
|
if (!editorLang.value && session && session !== (pagePrimary.value || 'en'))
|
||||||
|
editorLang.value = session
|
||||||
|
pinPreviewLang()
|
||||||
|
}
|
||||||
function unpinPreviewLang() {
|
function unpinPreviewLang() {
|
||||||
if (!pinned) return
|
if (!pinned) return
|
||||||
pinned = false
|
pinned = false
|
||||||
@@ -89,13 +98,13 @@ function onSwitchEvent(ev) {
|
|||||||
onMounted(() => {
|
onMounted(() => {
|
||||||
document.body.dataset.editorMode = activeMode.value
|
document.body.dataset.editorMode = activeMode.value
|
||||||
addEventListener('pagerite:switch-editor', onSwitchEvent)
|
addEventListener('pagerite:switch-editor', onSwitchEvent)
|
||||||
addEventListener('pagerite:editor-shown', pinPreviewLang)
|
addEventListener('pagerite:editor-shown', openShell)
|
||||||
addEventListener('pagerite:editor-hidden', unpinPreviewLang)
|
addEventListener('pagerite:editor-hidden', unpinPreviewLang)
|
||||||
// The shell mounts visible (openEditor), so pin immediately. The site
|
// The shell mounts visible (openEditor), so open immediately. The site
|
||||||
// default primary language comes from the settings — it only fills the
|
// default primary language comes from the settings — it only fills the
|
||||||
// unknown; the page/structure tabs refine pagePrimary per page as they
|
// unknown; the page/structure tabs refine pagePrimary per page as they
|
||||||
// learn it (their knowledge is strictly better).
|
// learn it (their knowledge is strictly better).
|
||||||
pinPreviewLang()
|
openShell()
|
||||||
fetch('/_api/settings').then((r) => r.json()).then((s) => {
|
fetch('/_api/settings').then((r) => r.json()).then((s) => {
|
||||||
if (!pagePrimary.value) pagePrimary.value = s.primary_lang || 'en'
|
if (!pagePrimary.value) pagePrimary.value = s.primary_lang || 'en'
|
||||||
}).catch(() => { /* keep the fallback */ })
|
}).catch(() => { /* keep the fallback */ })
|
||||||
@@ -103,7 +112,7 @@ onMounted(() => {
|
|||||||
|
|
||||||
onUnmounted(() => {
|
onUnmounted(() => {
|
||||||
removeEventListener('pagerite:switch-editor', onSwitchEvent)
|
removeEventListener('pagerite:switch-editor', onSwitchEvent)
|
||||||
removeEventListener('pagerite:editor-shown', pinPreviewLang)
|
removeEventListener('pagerite:editor-shown', openShell)
|
||||||
removeEventListener('pagerite:editor-hidden', unpinPreviewLang)
|
removeEventListener('pagerite:editor-hidden', unpinPreviewLang)
|
||||||
})
|
})
|
||||||
</script>
|
</script>
|
||||||
|
|||||||
@@ -3,7 +3,8 @@
|
|||||||
// flag button opening a clean dropdown, v-modeled on the shared editorLang
|
// flag button opening a clean dropdown, v-modeled on the shared editorLang
|
||||||
// ('' = the primary language). The lang tab's flag grid is a different
|
// ('' = the primary language). The lang tab's flag grid is a different
|
||||||
// control (toggles, not a select) and stays as it is.
|
// control (toggles, not a select) and stays as it is.
|
||||||
import { computed, ref } from 'vue'
|
import { computed, nextTick, ref } from 'vue'
|
||||||
|
import { usePopup } from './dropdown'
|
||||||
|
|
||||||
const props = defineProps({
|
const props = defineProps({
|
||||||
modelValue: { type: String, default: '' },
|
modelValue: { type: String, default: '' },
|
||||||
@@ -13,8 +14,12 @@ const props = defineProps({
|
|||||||
const emit = defineEmits(['update:modelValue'])
|
const emit = defineEmits(['update:modelValue'])
|
||||||
|
|
||||||
const open = ref(false)
|
const open = ref(false)
|
||||||
|
const root = ref(null)
|
||||||
const toggleBtn = ref(null)
|
const toggleBtn = ref(null)
|
||||||
|
const pop = ref(null)
|
||||||
const popStyle = ref({})
|
const popStyle = ref({})
|
||||||
|
// Closes on outside click / Escape (./dropdown), not on mouseleave.
|
||||||
|
usePopup(open, root)
|
||||||
const current = computed(
|
const current = computed(
|
||||||
() => props.options.find((o) => o.tag === props.modelValue) ?? props.options[0],
|
() => props.options.find((o) => o.tag === props.modelValue) ?? props.options[0],
|
||||||
)
|
)
|
||||||
@@ -26,6 +31,17 @@ function toggle() {
|
|||||||
// onto the page area instead of being clipped by it.
|
// onto the page area instead of being clipped by it.
|
||||||
const r = toggleBtn.value.getBoundingClientRect()
|
const r = toggleBtn.value.getBoundingClientRect()
|
||||||
popStyle.value = { top: `${r.bottom + 2}px`, left: `${r.left}px` }
|
popStyle.value = { top: `${r.bottom + 2}px`, left: `${r.left}px` }
|
||||||
|
// A toggle mounted near the right window edge (the public page
|
||||||
|
// selector sits top-right) opens the popup flush against that edge.
|
||||||
|
nextTick(() => {
|
||||||
|
const p = pop.value?.getBoundingClientRect()
|
||||||
|
if (p && p.right > innerWidth - 4) {
|
||||||
|
popStyle.value = {
|
||||||
|
...popStyle.value,
|
||||||
|
left: `${Math.max(4, innerWidth - 4 - p.width)}px`,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -36,7 +52,7 @@ function select(tag) {
|
|||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<span v-if="options.length > 1" class="lang-select">
|
<span v-if="options.length > 1" ref="root" class="lang-select">
|
||||||
<button
|
<button
|
||||||
ref="toggleBtn"
|
ref="toggleBtn"
|
||||||
type="button"
|
type="button"
|
||||||
@@ -47,7 +63,7 @@ function select(tag) {
|
|||||||
: '')"
|
: '')"
|
||||||
@click="toggle"
|
@click="toggle"
|
||||||
><span v-if="current?.flag" class="flag" v-html="current.flag" /></button>
|
><span v-if="current?.flag" class="flag" v-html="current.flag" /></button>
|
||||||
<span v-if="open" class="lang-pop" :style="popStyle" @mouseleave="open = false">
|
<span v-if="open" ref="pop" class="lang-pop" :style="popStyle">
|
||||||
<button
|
<button
|
||||||
v-for="o in options"
|
v-for="o in options"
|
||||||
:key="o.code"
|
:key="o.code"
|
||||||
@@ -66,20 +82,23 @@ function select(tag) {
|
|||||||
display: flex;
|
display: flex;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* The closed state is just the small flag — no button chrome until hovered. */
|
/* The closed state is just the small flag — no button chrome at all, on
|
||||||
|
hover either (it sits among borderless emoji-icon buttons); like them it
|
||||||
|
rests dimmed and brightens on hover. */
|
||||||
.lang-current {
|
.lang-current {
|
||||||
display: flex;
|
display: flex;
|
||||||
align-items: center;
|
align-items: center;
|
||||||
padding: 2px;
|
padding: 2px;
|
||||||
background: none;
|
background: none;
|
||||||
border: 1px solid transparent;
|
border: none;
|
||||||
border-radius: 4px;
|
border-radius: 4px;
|
||||||
cursor: pointer;
|
cursor: pointer;
|
||||||
|
opacity: 0.7;
|
||||||
}
|
}
|
||||||
|
|
||||||
.lang-current:hover,
|
.lang-current:hover,
|
||||||
.lang-current.open {
|
.lang-current.open {
|
||||||
border-color: var(--line);
|
opacity: 1;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* The dropdown matches the page's existing popups (.picker-pop look).
|
/* The dropdown matches the page's existing popups (.picker-pop look).
|
||||||
@@ -127,11 +146,13 @@ function select(tag) {
|
|||||||
color: var(--muted);
|
color: var(--muted);
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Flags render like in the analytics visitor cells. */
|
/* em-sized so the chip matches the surrounding text/icon size in each
|
||||||
|
context; the hairline border delineates white-flagged countries (not
|
||||||
|
button chrome). */
|
||||||
.flag {
|
.flag {
|
||||||
display: inline-flex;
|
display: inline-flex;
|
||||||
width: 18px;
|
width: 1.5em;
|
||||||
height: 12px;
|
height: 1em;
|
||||||
flex: 0 0 auto;
|
flex: 0 0 auto;
|
||||||
border-radius: 2px;
|
border-radius: 2px;
|
||||||
overflow: hidden;
|
overflow: hidden;
|
||||||
|
|||||||
@@ -0,0 +1,46 @@
|
|||||||
|
<script setup>
|
||||||
|
// The public page's language selector: the editors' flag dropdown
|
||||||
|
// (LangSelect) as the first item of the banner's corner container, fed
|
||||||
|
// from the shared store (pagerite.js sets the page's hreflang alternates
|
||||||
|
// and served language per navigation). It binds the same store.lang the
|
||||||
|
// editor's dropdown binds, so both always show the same selection. A pick
|
||||||
|
// also dispatches pagerite:set-session-lang — pagerite.js swaps the page
|
||||||
|
// in place when the editor is closed (open, the editor reacts to the
|
||||||
|
// store and re-renders it).
|
||||||
|
import { computed } from 'vue'
|
||||||
|
import LangSelect from './LangSelect.vue'
|
||||||
|
import { flagFor, langName, langSort } from './langs'
|
||||||
|
import { useStore } from './store'
|
||||||
|
|
||||||
|
const store = useStore()
|
||||||
|
|
||||||
|
// The "(primary)" marker is admin-panel information; the public selector
|
||||||
|
// lists plain languages. Order: the primary language first, then the rest
|
||||||
|
// in the lang tab's geographic grouping (./langs langSort) — the head's
|
||||||
|
// hreflang order is just alphabetical.
|
||||||
|
const primaryTag = computed(() => store.langAlternates.find((a) => a.primary)?.tag ?? '')
|
||||||
|
const options = computed(() => {
|
||||||
|
const rest = langSort(
|
||||||
|
store.langAlternates.map((a) => a.tag).filter((t) => t !== primaryTag.value),
|
||||||
|
)
|
||||||
|
return [primaryTag.value, ...rest].filter(Boolean).map((tag) => ({
|
||||||
|
tag,
|
||||||
|
code: tag,
|
||||||
|
name: langName(tag),
|
||||||
|
flag: flagFor(tag),
|
||||||
|
primary: false,
|
||||||
|
}))
|
||||||
|
})
|
||||||
|
// The explicit pick, else the served language (header-autodetected pages
|
||||||
|
// may have neither), else the primary.
|
||||||
|
const model = computed(() => store.lang || store.servedLang || primaryTag.value)
|
||||||
|
|
||||||
|
function go(tag) {
|
||||||
|
store.lang = tag === primaryTag.value ? '' : tag
|
||||||
|
dispatchEvent(new CustomEvent('pagerite:set-session-lang', { detail: { lang: tag } }))
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<LangSelect :model-value="model" :options="options" @update:model-value="go" />
|
||||||
|
</template>
|
||||||
+40
-14
@@ -26,13 +26,14 @@
|
|||||||
// renders the version being edited, whichever language the page itself
|
// renders the version being edited, whichever language the page itself
|
||||||
// was loaded in.
|
// was loaded in.
|
||||||
import { computed, onActivated, onMounted, onUnmounted, ref, watch } from 'vue'
|
import { computed, onActivated, onMounted, onUnmounted, ref, watch } from 'vue'
|
||||||
|
import { usePopup } from './dropdown'
|
||||||
import { EditorView, basicSetup } from 'codemirror'
|
import { EditorView, basicSetup } from 'codemirror'
|
||||||
import { Compartment, EditorState } from '@codemirror/state'
|
import { Compartment, EditorState } from '@codemirror/state'
|
||||||
import { keymap } from '@codemirror/view'
|
import { keymap } from '@codemirror/view'
|
||||||
import { indentWithTab } from '@codemirror/commands'
|
import { indentWithTab } from '@codemirror/commands'
|
||||||
import { markdown } from '@codemirror/lang-markdown'
|
import { markdown } from '@codemirror/lang-markdown'
|
||||||
import { cmHighlight, cmTheme } from './cmtheme'
|
import { cmHighlight, cmTheme } from './cmtheme'
|
||||||
import { flagFor, langName } from './langs'
|
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'
|
||||||
@@ -120,11 +121,13 @@ function normPath(p) {
|
|||||||
// localization settings tab).
|
// localization settings tab).
|
||||||
|
|
||||||
// The picker's options: the primary language first, then the union of the
|
// The picker's options: the primary language first, then the union of the
|
||||||
// page's translations and the site-wide configured targets, sorted.
|
// page's translations and the site-wide configured targets in the lang
|
||||||
|
// tab's geographic grouping (./langs langSort).
|
||||||
const langOptions = computed(() => {
|
const langOptions = computed(() => {
|
||||||
const others = [...new Set([...siteLangs.value, ...pageLangs.value])]
|
const others = langSort(
|
||||||
.filter((l) => l && l !== primaryLang.value)
|
[...new Set([...siteLangs.value, ...pageLangs.value])]
|
||||||
.sort()
|
.filter((l) => l && l !== primaryLang.value),
|
||||||
|
)
|
||||||
return [primaryLang.value, ...others].map((code) => ({
|
return [primaryLang.value, ...others].map((code) => ({
|
||||||
tag: code === primaryLang.value ? '' : code,
|
tag: code === primaryLang.value ? '' : code,
|
||||||
code,
|
code,
|
||||||
@@ -621,8 +624,15 @@ const TABLE_MAX_ROWS = 6
|
|||||||
// Class pickers: popup listing the block class toggles (placement ↔︎,
|
// Class pickers: popup listing the block class toggles (placement ↔︎,
|
||||||
// text size AA), closed after applying. The block's current class of the
|
// text size AA), closed after applying. The block's current class of the
|
||||||
// group is marked; choosing "normal" (or the current class) removes it.
|
// group is marked; choosing "normal" (or the current class) removes it.
|
||||||
|
// All popups share the close behavior of ./dropdown (outside click /
|
||||||
|
// Escape; never mouseleave).
|
||||||
const classPicker = ref(null) // 'place' | 'size' | null
|
const classPicker = ref(null) // 'place' | 'size' | null
|
||||||
const activeClasses = ref(new Set())
|
const activeClasses = ref(new Set())
|
||||||
|
const placeRoot = ref(null)
|
||||||
|
const sizeRoot = ref(null)
|
||||||
|
const tableRoot = ref(null)
|
||||||
|
usePopup(classPicker, computed(() => (classPicker.value === 'place' ? placeRoot : sizeRoot).value))
|
||||||
|
usePopup(tablePicker, tableRoot)
|
||||||
|
|
||||||
function openClassPicker(which) {
|
function openClassPicker(which) {
|
||||||
classPicker.value = classPicker.value === which ? null : which
|
classPicker.value = classPicker.value === which ? null : which
|
||||||
@@ -1136,15 +1146,31 @@ onUnmounted(() => {
|
|||||||
<div class="format-bar">
|
<div class="format-bar">
|
||||||
<button type="button" class="code-btn" title="code — inline wrap, or a fenced block for line-spanning selections; click again to unwrap" @click="insertCode"><code></></code></button>
|
<button type="button" class="code-btn" title="code — inline wrap, or a fenced block for line-spanning selections; click again to unwrap" @click="insertCode"><code></></code></button>
|
||||||
<button type="button" title="link (toggle: click inside a link to unwrap it)" @click="insertLink">🔗︎</button>
|
<button type="button" title="link (toggle: click inside a link to unwrap it)" @click="insertLink">🔗︎</button>
|
||||||
<button
|
<span class="picker" ref="tableRoot">
|
||||||
type="button"
|
<button
|
||||||
title="table"
|
type="button"
|
||||||
:class="{ active: tablePicker }"
|
title="table"
|
||||||
@click="tablePicker = !tablePicker"
|
:class="{ active: tablePicker }"
|
||||||
>⊞</button>
|
@click="tablePicker = !tablePicker"
|
||||||
|
>⊞</button>
|
||||||
|
<div v-if="tablePicker" class="table-picker" @mouseleave="tableSize = { cols: 0, rows: 0 }">
|
||||||
|
<div class="tp-grid" :style="{ gridTemplateColumns: `repeat(${TABLE_MAX_COLS}, 1fr)` }">
|
||||||
|
<button
|
||||||
|
v-for="n in TABLE_MAX_COLS * TABLE_MAX_ROWS"
|
||||||
|
:key="n"
|
||||||
|
type="button"
|
||||||
|
class="tp-cell"
|
||||||
|
:class="{ on: tableSize.cols >= (n - 1) % TABLE_MAX_COLS + 1 && tableSize.rows >= Math.floor((n - 1) / TABLE_MAX_COLS) + 1 }"
|
||||||
|
@mouseenter="tableSize = { cols: (n - 1) % TABLE_MAX_COLS + 1, rows: Math.floor((n - 1) / TABLE_MAX_COLS) + 1 }"
|
||||||
|
@click="insertTable(tableSize.cols, tableSize.rows)"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
<div class="tp-size">{{ tableSize.cols || '–' }} × {{ tableSize.rows || '–' }}</div>
|
||||||
|
</div>
|
||||||
|
</span>
|
||||||
<button type="button" title="insert image (upload) — pasting works too" @click="fileInput.click()">🖼︎</button>
|
<button type="button" title="insert image (upload) — pasting works too" @click="fileInput.click()">🖼︎</button>
|
||||||
<button type="button" title="aside box (::: aside) — wraps the selection or the cursor's line; clicked inside one, removes it" @click="insertAside">◧</button>
|
<button type="button" title="aside box (::: aside) — wraps the selection or the cursor's line; clicked inside one, removes it" @click="insertAside">◧</button>
|
||||||
<span class="picker">
|
<span class="picker" ref="placeRoot">
|
||||||
<button
|
<button
|
||||||
type="button"
|
type="button"
|
||||||
title="block placement class"
|
title="block placement class"
|
||||||
@@ -1166,7 +1192,7 @@ onUnmounted(() => {
|
|||||||
</span>
|
</span>
|
||||||
<button type="button" title="bold" @click="wrapInline('**')"><b>B</b></button>
|
<button type="button" title="bold" @click="wrapInline('**')"><b>B</b></button>
|
||||||
<button type="button" title="italic" @click="wrapInline('*')"><i>i</i></button>
|
<button type="button" title="italic" @click="wrapInline('*')"><i>i</i></button>
|
||||||
<span class="picker">
|
<span class="picker" ref="sizeRoot">
|
||||||
<button
|
<button
|
||||||
type="button"
|
type="button"
|
||||||
title="text size class"
|
title="text size class"
|
||||||
@@ -1368,7 +1394,7 @@ onUnmounted(() => {
|
|||||||
.table-picker {
|
.table-picker {
|
||||||
position: absolute;
|
position: absolute;
|
||||||
top: 100%;
|
top: 100%;
|
||||||
left: 6.5rem;
|
left: 0;
|
||||||
z-index: 20;
|
z-index: 20;
|
||||||
padding: 0.5rem;
|
padding: 0.5rem;
|
||||||
background: var(--bg);
|
background: var(--bg);
|
||||||
|
|||||||
@@ -0,0 +1,68 @@
|
|||||||
|
<script setup>
|
||||||
|
// Referer + UTM as one badge in the analytics visit/crawler tables: the
|
||||||
|
// referer's favicon flush on the left, its host as the link text, then the
|
||||||
|
// UTM summary smaller/muted inside the same badge. The whole badge links to
|
||||||
|
// the referer origin (external, new tab) and carries a single one-fact-
|
||||||
|
// per-line tooltip (badge.title: origin, then each utm pair) — no titles on
|
||||||
|
// the inner elements. Referers are external, so there is no close event.
|
||||||
|
import { computed } from 'vue'
|
||||||
|
|
||||||
|
const props = defineProps({
|
||||||
|
badge: { type: Object, required: true },
|
||||||
|
favicons: { type: Object, default: null },
|
||||||
|
})
|
||||||
|
|
||||||
|
const favicon = computed(() => (props.badge.origin ? props.favicons?.[props.badge.origin] : null))
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<a class="referer-badge"
|
||||||
|
:href="badge.href || undefined"
|
||||||
|
:title="badge.title"
|
||||||
|
:target="badge.href ? '_blank' : undefined"
|
||||||
|
:rel="badge.href ? 'noopener' : undefined">
|
||||||
|
<img v-if="favicon" class="badge-favicon" :src="favicon" alt="" />
|
||||||
|
<span v-if="badge.label">{{ badge.label }}</span>
|
||||||
|
<small v-if="badge.utm" class="small">{{ badge.utm }}</small>
|
||||||
|
</a>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
/* Browser-chrome chip on a fixed neutral palette (--badge-* in
|
||||||
|
pagerite.css, deliberately unthemed): black-on-transparent and
|
||||||
|
white-on-transparent favicons both stay legible on it, and the text is
|
||||||
|
always dark regardless of the theme's link/text colors. Colors go on the
|
||||||
|
inner elements, so the theme's a / a:hover color rules (which target the
|
||||||
|
anchor) cannot cascade in. */
|
||||||
|
.referer-badge {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.35em;
|
||||||
|
padding-right: 0.45em;
|
||||||
|
border-radius: 0.25rem;
|
||||||
|
background: var(--badge-bg);
|
||||||
|
color: var(--badge-text);
|
||||||
|
white-space: nowrap;
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Flush with the badge's top/left/bottom edges: a full-height square (the
|
||||||
|
badge has no padding on those sides), corners clipped by the badge's
|
||||||
|
overflow: hidden border-radius. */
|
||||||
|
.badge-favicon {
|
||||||
|
width: 1.5em;
|
||||||
|
height: 1.5em;
|
||||||
|
object-fit: cover;
|
||||||
|
flex: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.referer-badge > span,
|
||||||
|
.referer-badge > small {
|
||||||
|
min-width: 0;
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
}
|
||||||
|
|
||||||
|
.referer-badge > span { color: var(--badge-text); }
|
||||||
|
.referer-badge > small { color: var(--badge-muted); }
|
||||||
|
</style>
|
||||||
@@ -782,14 +782,6 @@ onUnmounted(() => {
|
|||||||
margin-left: auto;
|
margin-left: auto;
|
||||||
padding: 0 0.2rem;
|
padding: 0 0.2rem;
|
||||||
font-size: 1rem;
|
font-size: 1rem;
|
||||||
background: none;
|
|
||||||
border: none;
|
|
||||||
cursor: pointer;
|
|
||||||
opacity: 0.7;
|
|
||||||
}
|
|
||||||
|
|
||||||
.block-head .icon-btn:hover {
|
|
||||||
opacity: 1;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
.text-input {
|
.text-input {
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ import { computed, inject, onActivated, onMounted, onUnmounted, provide, ref, wa
|
|||||||
import StructureTree from './StructureTree.vue'
|
import StructureTree from './StructureTree.vue'
|
||||||
import LangSelect from './LangSelect.vue'
|
import LangSelect from './LangSelect.vue'
|
||||||
import { slugify } from './slugify'
|
import { slugify } from './slugify'
|
||||||
import { flagFor, langName } from './langs'
|
import { flagFor, langName, langSort } from './langs'
|
||||||
import { editorLang, pagePrimary } from './editorLang'
|
import { editorLang, pagePrimary } from './editorLang'
|
||||||
import { dropPageCache, loadPlain } from './swapdoc'
|
import { dropPageCache, loadPlain } from './swapdoc'
|
||||||
|
|
||||||
@@ -40,9 +40,10 @@ const primaryLang = ref('en')
|
|||||||
const siteLangs = ref([])
|
const siteLangs = ref([])
|
||||||
|
|
||||||
// The strip's options: the primary language first, then the configured
|
// The strip's options: the primary language first, then the configured
|
||||||
// translation targets (the lang tab manages that set).
|
// translation targets (the lang tab manages that set) in the lang tab's
|
||||||
|
// geographic grouping (./langs langSort).
|
||||||
const langOptions = computed(() =>
|
const langOptions = computed(() =>
|
||||||
[primaryLang.value, ...siteLangs.value.filter((l) => l !== primaryLang.value)]
|
[primaryLang.value, ...langSort(siteLangs.value.filter((l) => l !== primaryLang.value))]
|
||||||
.map((code) => ({
|
.map((code) => ({
|
||||||
tag: code === primaryLang.value ? '' : code,
|
tag: code === primaryLang.value ? '' : code,
|
||||||
code,
|
code,
|
||||||
@@ -63,7 +64,7 @@ watch(lang, () => refreshPages())
|
|||||||
// dropdown lists "inherit" first (naming what it resolves to), then every
|
// dropdown lists "inherit" first (naming what it resolves to), then every
|
||||||
// site language. Setting it on a section covers its whole subtree.
|
// site language. Setting it on a section covers its whole subtree.
|
||||||
const rowLangChoices = computed(() =>
|
const rowLangChoices = computed(() =>
|
||||||
[primaryLang.value, ...siteLangs.value.filter((l) => l !== primaryLang.value)]
|
[primaryLang.value, ...langSort(siteLangs.value.filter((l) => l !== primaryLang.value))]
|
||||||
.map((code) => ({ tag: code, code, name: langName(code), flag: flagFor(code), primary: false })),
|
.map((code) => ({ tag: code, code, name: langName(code), flag: flagFor(code), primary: false })),
|
||||||
)
|
)
|
||||||
function rowLangOptions(el) {
|
function rowLangOptions(el) {
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ const props = defineProps({
|
|||||||
step: { type: Object, required: true },
|
step: { type: Object, required: true },
|
||||||
count: { type: Number, default: 0 },
|
count: { type: Number, default: 0 },
|
||||||
favicons: { type: Object, default: null },
|
favicons: { type: Object, default: null },
|
||||||
|
flags: { type: Array, default: () => [] },
|
||||||
})
|
})
|
||||||
|
|
||||||
defineEmits(['close'])
|
defineEmits(['close'])
|
||||||
@@ -38,6 +39,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-for="(f, fi) in flags" :key="fi" class="flag" v-html="f"></span>
|
||||||
</a>
|
</a>
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
@@ -48,4 +50,23 @@ const title = computed(() => {
|
|||||||
margin-right: 0.25em;
|
margin-right: 0.25em;
|
||||||
vertical-align: -0.1em;
|
vertical-align: -0.1em;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Same flag chip as the visitor cells (VisitorCell.vue). */
|
||||||
|
.flag {
|
||||||
|
display: inline-flex;
|
||||||
|
width: 18px;
|
||||||
|
height: 12px;
|
||||||
|
margin-left: 0.25em;
|
||||||
|
border-radius: 2px;
|
||||||
|
overflow: hidden;
|
||||||
|
border: 1px solid var(--line);
|
||||||
|
box-shadow: 0 0 0 1px rgba(0, 0, 0, 0.2) inset;
|
||||||
|
vertical-align: middle;
|
||||||
|
}
|
||||||
|
|
||||||
|
.flag :deep(svg) {
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
</style>
|
</style>
|
||||||
|
|||||||
@@ -4,15 +4,20 @@
|
|||||||
// Clicking the IP copies the full address to the clipboard.
|
// Clicking the IP copies the full address to the clipboard.
|
||||||
// ``variantCount`` overrides the UA line to warn when multiple client
|
// ``variantCount`` overrides the UA line to warn when multiple client
|
||||||
// fingerprints share the same IP (e.g. a scanner rotating UAs).
|
// fingerprints share the same IP (e.g. a scanner rotating UAs).
|
||||||
|
// Clicking the UA line copies the raw UA(s) to the clipboard, one per line
|
||||||
|
// (``uaRaws`` carries every variation for multi-client IPs).
|
||||||
import { computed } from 'vue'
|
import { computed } from 'vue'
|
||||||
import * as flagSvgs from 'country-flag-icons/string/3x2'
|
import * as flagSvgs from 'country-flag-icons/string/3x2'
|
||||||
import { copyIp, formatLang } from './analytics/format.js'
|
import { copyIp, copyList, formatLang } from './analytics/format.js'
|
||||||
|
import { langName } from './langs.js'
|
||||||
|
|
||||||
const props = defineProps({
|
const props = defineProps({
|
||||||
ip: { type: String, default: '' },
|
ip: { type: String, default: '' },
|
||||||
ipDisplay: { type: String, default: '—' },
|
ipDisplay: { type: String, default: '—' },
|
||||||
ua: { type: String, default: '' },
|
ua: { type: String, default: '' },
|
||||||
uaRaw: { type: String, default: '' },
|
uaRaw: { type: String, default: '' },
|
||||||
|
uaRaws: { type: String, default: '' },
|
||||||
|
uaUrl: { type: String, default: '' },
|
||||||
country: { type: String, default: '' },
|
country: { type: String, default: '' },
|
||||||
city: { type: String, default: '' },
|
city: { type: String, default: '' },
|
||||||
lang: { type: String, default: '' },
|
lang: { type: String, default: '' },
|
||||||
@@ -26,6 +31,7 @@ const hasCity = computed(() => !!(props.city && props.city !== '—'))
|
|||||||
const hasLocale = computed(() => hasCountry.value || hasCity.value)
|
const hasLocale = computed(() => hasCountry.value || hasCity.value)
|
||||||
const langValue = computed(() => props.langDisplay || formatLang(props.lang))
|
const langValue = computed(() => props.langDisplay || formatLang(props.lang))
|
||||||
const showLang = computed(() => langValue.value && langValue.value !== '—')
|
const showLang = computed(() => langValue.value && langValue.value !== '—')
|
||||||
|
const uaCopy = computed(() => props.uaRaws || props.uaRaw)
|
||||||
|
|
||||||
function flagSvg(code) {
|
function flagSvg(code) {
|
||||||
return flagSvgs[code?.toUpperCase()] || ''
|
return flagSvgs[code?.toUpperCase()] || ''
|
||||||
@@ -58,10 +64,16 @@ function countryName(code) {
|
|||||||
</div>
|
</div>
|
||||||
<div class="visitor-row">
|
<div class="visitor-row">
|
||||||
<div class="ua-line">
|
<div class="ua-line">
|
||||||
<small v-if="variantCount > 1" class="muted variant-hint">{{ variantCount }} client variations</small>
|
<small v-if="variantCount > 1" class="muted variant-hint clickable-ip"
|
||||||
<small v-else class="muted" :title="uaRaw">{{ ua || '—' }}</small>
|
:title="uaCopy"
|
||||||
|
@click="copyList(uaCopy, $event)">{{ variantCount }} client variations</small>
|
||||||
|
<small v-else class="muted clickable-ip" :title="uaRaw"
|
||||||
|
@click="copyList(uaCopy, $event)">{{ ua || '—' }}</small><a v-if="uaUrl && variantCount <= 1"
|
||||||
|
class="ua-link icon-btn" :href="uaUrl"
|
||||||
|
target="_blank" rel="noopener noreferrer"
|
||||||
|
@click.stop>🔗</a>
|
||||||
</div>
|
</div>
|
||||||
<div v-if="showLang && variantCount <= 1" class="locale-lang"><small class="muted">{{ langValue }}</small></div>
|
<div v-if="showLang && variantCount <= 1" class="locale-lang"><small class="muted" :title="langName(lang)">{{ langValue }}</small></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</td>
|
</td>
|
||||||
@@ -121,6 +133,13 @@ function countryName(code) {
|
|||||||
text-align: left;
|
text-align: left;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.ua-link {
|
||||||
|
text-decoration: none;
|
||||||
|
font-size: 0.75em;
|
||||||
|
margin-left: 0.2em;
|
||||||
|
vertical-align: middle;
|
||||||
|
}
|
||||||
|
|
||||||
.locale-lang {
|
.locale-lang {
|
||||||
flex: 0 0 auto;
|
flex: 0 0 auto;
|
||||||
overflow: hidden;
|
overflow: hidden;
|
||||||
|
|||||||
@@ -2,6 +2,7 @@
|
|||||||
* Formatters and aggregators for summary sections: totals and the recent
|
* Formatters and aggregators for summary sections: totals and the recent
|
||||||
* visit trail.
|
* visit trail.
|
||||||
*/
|
*/
|
||||||
|
import { flagFor, langName } from '../langs.js'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* IPv4 unchanged, IPv6 returns the /64 network prefix in compact form.
|
* IPv4 unchanged, IPv6 returns the /64 network prefix in compact form.
|
||||||
@@ -25,32 +26,31 @@ export const hostIP = (ip) => {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function showCopiedFeedback(el) {
|
function showCopiedFeedback(el, event) {
|
||||||
if (!el || typeof document === 'undefined') return
|
if (typeof document === 'undefined') return
|
||||||
const popup = document.createElement('span')
|
const popup = document.createElement('span')
|
||||||
popup.textContent = 'Copied!'
|
popup.textContent = 'Copied!'
|
||||||
popup.className = 'copy-popup'
|
popup.className = 'copy-popup'
|
||||||
|
// Fixed to the viewport at the click point: table cells clip absolute
|
||||||
|
// popups with their overflow: hidden ellipsis styling.
|
||||||
|
const x = event?.clientX ?? 0
|
||||||
|
const y = event?.clientY ?? 0
|
||||||
popup.style.cssText =
|
popup.style.cssText =
|
||||||
'position:absolute;bottom:calc(100% + 0.25rem);left:50%;' +
|
`position:fixed;left:${x}px;top:${y}px;` +
|
||||||
'transform:translateX(-50%);padding:0.15rem 0.4rem;' +
|
'transform:translate(-50%, calc(-100% - 0.5rem));padding:0.15rem 0.4rem;' +
|
||||||
'background:var(--text, CanvasText);color:var(--bg, Canvas);' +
|
'background:var(--text, CanvasText);color:var(--bg, Canvas);' +
|
||||||
'border-radius:0.25rem;font-size:0.75rem;white-space:nowrap;' +
|
'border-radius:0.25rem;font-size:0.75rem;white-space:nowrap;' +
|
||||||
'pointer-events:none;z-index:10;'
|
'pointer-events:none;z-index:100;'
|
||||||
el.classList.add('has-copy-popup')
|
document.body.appendChild(popup)
|
||||||
el.appendChild(popup)
|
setTimeout(() => popup.remove(), 1200)
|
||||||
setTimeout(() => {
|
|
||||||
popup.remove()
|
|
||||||
el.classList.remove('has-copy-popup')
|
|
||||||
}, 1200)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Copy the full IP to the clipboard and show a brief "Copied!" popup. */
|
/** Copy the full IP to the clipboard and show a brief "Copied!" popup. */
|
||||||
export async function copyIp(ip, event) {
|
export async function copyIp(ip, event) {
|
||||||
if (!ip) return
|
if (!ip) return
|
||||||
const el = event?.currentTarget
|
|
||||||
try {
|
try {
|
||||||
await navigator.clipboard.writeText(ip)
|
await navigator.clipboard.writeText(ip)
|
||||||
showCopiedFeedback(el)
|
showCopiedFeedback(event?.currentTarget, event)
|
||||||
} catch {
|
} catch {
|
||||||
/* ignore */
|
/* ignore */
|
||||||
}
|
}
|
||||||
@@ -59,10 +59,9 @@ export async function copyIp(ip, event) {
|
|||||||
/** Copy arbitrary text to the clipboard and show a brief "Copied!" popup. */
|
/** Copy arbitrary text to the clipboard and show a brief "Copied!" popup. */
|
||||||
export async function copyList(text, event) {
|
export async function copyList(text, event) {
|
||||||
if (!text) return
|
if (!text) return
|
||||||
const el = event?.currentTarget
|
|
||||||
try {
|
try {
|
||||||
await navigator.clipboard.writeText(text)
|
await navigator.clipboard.writeText(text)
|
||||||
showCopiedFeedback(el)
|
showCopiedFeedback(event?.currentTarget, event)
|
||||||
} catch {
|
} catch {
|
||||||
/* ignore */
|
/* ignore */
|
||||||
}
|
}
|
||||||
@@ -178,6 +177,32 @@ function stepOf(path, titles) {
|
|||||||
return null
|
return null
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Badge data combining a visit's/crawler's external referer origin with the
|
||||||
|
* visit's UTM tags: the origin as the badge link/label (the favicon is
|
||||||
|
* looked up by origin in the component), the known UTM values as a short
|
||||||
|
* inline summary, and a one-fact-per-line tooltip — the full origin URL on
|
||||||
|
* the first line, then every ``utm_*=value`` pair. Null when there is no
|
||||||
|
* external referer and no UTM tag (a plain direct visit).
|
||||||
|
*/
|
||||||
|
function refererBadgeOf(referer, titles, utmTags = {}) {
|
||||||
|
const step = stepOf(referer, titles)
|
||||||
|
const external = step?.external ? step : null
|
||||||
|
const known = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content']
|
||||||
|
const utm = known.map((k) => utmTags[k]).filter(Boolean).join(' · ')
|
||||||
|
if (!external && !utm) return null
|
||||||
|
return {
|
||||||
|
href: external?.origin || '',
|
||||||
|
label: external?.slug || '',
|
||||||
|
origin: external?.origin || '',
|
||||||
|
utm,
|
||||||
|
title: [
|
||||||
|
...(external ? [external.origin] : []),
|
||||||
|
...Object.entries(utmTags).map(([k, value]) => `${k}=${value}`),
|
||||||
|
].join('\n'),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Human-readable relative timestamp. Adapted from cista-storage: uses
|
* Human-readable relative timestamp. Adapted from cista-storage: uses
|
||||||
* ``Intl.RelativeTimeFormat`` for short intervals and a compact date for
|
* ``Intl.RelativeTimeFormat`` for short intervals and a compact date for
|
||||||
@@ -342,7 +367,7 @@ export function countCrawlerUas(crawlers, clients) {
|
|||||||
const counts = {}
|
const counts = {}
|
||||||
for (const c of crawlers || []) {
|
for (const c of crawlers || []) {
|
||||||
const client = (clients || {})[c.client] || {}
|
const client = (clients || {})[c.client] || {}
|
||||||
const value = client.ua_pretty || client.ua || '(no UA)'
|
const value = client.uarite?.pretty || client.ua || '(no UA)'
|
||||||
counts[value] = (counts[value] || 0) + 1
|
counts[value] = (counts[value] || 0) + 1
|
||||||
}
|
}
|
||||||
return Object.entries(counts).sort((a, b) => b[1] - a[1])
|
return Object.entries(counts).sort((a, b) => b[1] - a[1])
|
||||||
@@ -370,12 +395,13 @@ export function mainDomain(host, limit = 24) {
|
|||||||
/**
|
/**
|
||||||
* Group raw crawler hits by client hash and format each group as a row showing
|
* Group raw crawler hits by client hash and format each group as a row showing
|
||||||
* every internal page that crawler visited. Rows are sorted by most recent hit
|
* every internal page that crawler visited. Rows are sorted by most recent hit
|
||||||
* first, with total hits as a tie-breaker. The group's ``refererStep`` is the
|
* first, with total hits as a tie-breaker. The group's ``refererBadge`` is
|
||||||
* latest external referer seen for the crawler — spiders often advertise
|
* the latest external referer seen for the crawler — spiders often advertise
|
||||||
* their own site there — rendered with its favicon like visit referers.
|
* their own site there — rendered as a badge with its favicon like visit
|
||||||
|
* referers.
|
||||||
* ``clients`` maps client hashes to client records.
|
* ``clients`` maps client hashes to client records.
|
||||||
*/
|
*/
|
||||||
export function formatCrawlerRows(crawlers, clients, pageTree, now = Date.now()) {
|
export function formatCrawlerRows(crawlers, clients, pageTree, now = Date.now(), site = { multilingual: false, primaryLang: '' }) {
|
||||||
const titles = buildTitleMap(pageTree)
|
const titles = buildTitleMap(pageTree)
|
||||||
const groups = new Map()
|
const groups = new Map()
|
||||||
for (const c of crawlers || []) {
|
for (const c of crawlers || []) {
|
||||||
@@ -386,10 +412,12 @@ export function formatCrawlerRows(crawlers, clients, pageTree, now = Date.now())
|
|||||||
lastStart: 0,
|
lastStart: 0,
|
||||||
referer: '',
|
referer: '',
|
||||||
pages: new Map(),
|
pages: new Map(),
|
||||||
|
langs: new Set(),
|
||||||
}
|
}
|
||||||
const start = new Date(c.start).getTime()
|
const start = new Date(c.start).getTime()
|
||||||
if (start > g.lastStart) g.lastStart = start
|
if (start > g.lastStart) g.lastStart = start
|
||||||
if (c.referer) g.referer = c.referer
|
if (c.referer) g.referer = c.referer
|
||||||
|
if (c.lang) g.langs.add(c.lang)
|
||||||
if (c.entry?.startsWith('/')) {
|
if (c.entry?.startsWith('/')) {
|
||||||
const existing = g.pages.get(c.entry) || { count: 0, status: c.status || 200 }
|
const existing = g.pages.get(c.entry) || { count: 0, status: c.status || 200 }
|
||||||
existing.count += 1
|
existing.count += 1
|
||||||
@@ -410,19 +438,28 @@ export function formatCrawlerRows(crawlers, clients, pageTree, now = Date.now())
|
|||||||
const client = g.client || {}
|
const client = g.client || {}
|
||||||
const host = client.host || ''
|
const host = client.host || ''
|
||||||
const isHost = !!host
|
const isHost = !!host
|
||||||
|
// Rendered languages read, shown only when they say something the
|
||||||
|
// primary language alone would not (multilingual sites only).
|
||||||
|
const langs = [...g.langs].sort()
|
||||||
|
const showLangs =
|
||||||
|
site.multilingual && (langs.length > 1 || (langs[0] && langs[0] !== site.primaryLang))
|
||||||
return {
|
return {
|
||||||
lastSeen: formatWhen(g.lastStart, now),
|
lastSeen: formatWhen(g.lastStart, now),
|
||||||
lastSeenIso: formatWhenIso(g.lastStart),
|
lastSeenIso: formatWhenIso(g.lastStart),
|
||||||
lastSeenLocal: formatWhenLocal(g.lastStart),
|
lastSeenLocal: formatWhenLocal(g.lastStart),
|
||||||
refererStep: stepOf(g.referer, titles),
|
refererBadge: refererBadgeOf(g.referer, titles),
|
||||||
pages: [...g.pages.entries()]
|
pages: [...g.pages.entries()]
|
||||||
.sort((a, b) => b[1].count - a[1].count)
|
.sort((a, b) => b[1].count - a[1].count)
|
||||||
.map(([path, info]) => ({ ...stepOf(path, titles), count: info.count, status: info.status })),
|
.map(([path, info]) => ({ ...stepOf(path, titles), count: info.count, status: info.status })),
|
||||||
|
readFlags: showLangs
|
||||||
|
? langs.map((l) => ({ flag: flagFor(l), name: langName(l) })).filter((f) => f.flag)
|
||||||
|
: [],
|
||||||
ip: client.ip || '',
|
ip: client.ip || '',
|
||||||
ipDisplay: isHost ? mainDomain(host) : hostIP(client.ip) || client.ip || '—',
|
ipDisplay: isHost ? mainDomain(host) : hostIP(client.ip) || client.ip || '—',
|
||||||
isHost,
|
isHost,
|
||||||
ua: client.ua_pretty || client.ua || '—',
|
ua: client.uarite?.pretty || client.ua || '—',
|
||||||
uaRaw: client.ua || '',
|
uaRaw: client.ua || '',
|
||||||
|
uaUrl: client.uarite?.url || '',
|
||||||
lang: client.lang || '—',
|
lang: client.lang || '—',
|
||||||
langDisplay: formatLang(client.lang),
|
langDisplay: formatLang(client.lang),
|
||||||
country: client.country || '—',
|
country: client.country || '—',
|
||||||
@@ -505,6 +542,13 @@ export function formatAbuseRows(abuse, clients, pageTree, now = Date.now()) {
|
|||||||
const client = (clients || {})[g.lastClient] || {}
|
const client = (clients || {})[g.lastClient] || {}
|
||||||
const host = client.host || ''
|
const host = client.host || ''
|
||||||
const isHost = !!host
|
const isHost = !!host
|
||||||
|
const uaRaws = [
|
||||||
|
...new Set(
|
||||||
|
[...g.clientHashes]
|
||||||
|
.map((h) => (clients || {})[h]?.ua)
|
||||||
|
.filter(Boolean),
|
||||||
|
),
|
||||||
|
].join('\n')
|
||||||
return {
|
return {
|
||||||
lastSeen: formatWhen(g.lastStart, now),
|
lastSeen: formatWhen(g.lastStart, now),
|
||||||
lastSeenIso: formatWhenIso(g.lastStart),
|
lastSeenIso: formatWhenIso(g.lastStart),
|
||||||
@@ -527,8 +571,10 @@ export function formatAbuseRows(abuse, clients, pageTree, now = Date.now()) {
|
|||||||
ip: client.ip || g.ip,
|
ip: client.ip || g.ip,
|
||||||
ipDisplay: isHost ? mainDomain(host) : hostIP(client.ip || g.ip) || client.ip || g.ip || '—',
|
ipDisplay: isHost ? mainDomain(host) : hostIP(client.ip || g.ip) || client.ip || g.ip || '—',
|
||||||
isHost,
|
isHost,
|
||||||
ua: client.ua_pretty || client.ua || '—',
|
ua: client.uarite?.pretty || client.ua || '—',
|
||||||
uaRaw: client.ua || '',
|
uaRaw: client.ua || '',
|
||||||
|
uaUrl: client.uarite?.url || '',
|
||||||
|
uaRaws,
|
||||||
lang: client.lang || '—',
|
lang: client.lang || '—',
|
||||||
langDisplay: formatLang(client.lang),
|
langDisplay: formatLang(client.lang),
|
||||||
country: client.country || '—',
|
country: client.country || '—',
|
||||||
@@ -540,52 +586,88 @@ export function formatAbuseRows(abuse, clients, pageTree, now = Date.now()) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Format raw visit records as rows for a technical table. Returns objects
|
* Format raw visit records as rows for a technical table. Returns objects
|
||||||
* with display strings; missing values become "—". ``trail`` starts with the
|
* with display strings; missing values become "—". The external referer
|
||||||
* external referer (when present), then the entry page and any further internal
|
* (when present) and the UTM tags ride along as ``refererBadge``; ``trail``
|
||||||
* pages or external exit origins. Only the 20 most recent visits are shown.
|
* holds the entry page and any further internal pages or external exit
|
||||||
* ``clients`` maps client hashes to client records.
|
* origins; consecutive views of the same page (e.g. a
|
||||||
|
* language switch re-view) merge into one step that keeps the
|
||||||
|
* consecutive-distinct rendered languages, summed read time, and the latest
|
||||||
|
* status. On multilingual sites the rendered languages surface as flag
|
||||||
|
* icons: a visit read entirely in one non-primary language gets ``rowFlag``,
|
||||||
|
* and a visit spanning languages gets per-step ``langFlags`` markers where
|
||||||
|
* the language begins or changes. Only the 20 most recent visits are shown.
|
||||||
|
* ``clients`` maps client hashes to client records; ``site`` carries the
|
||||||
|
* payload's multilingual/primary-language context.
|
||||||
*/
|
*/
|
||||||
export function formatVisitRows(visits, clients, pageTree, now = Date.now()) {
|
export function formatVisitRows(visits, clients, pageTree, now = Date.now(), site = { multilingual: false, primaryLang: '' }) {
|
||||||
const titles = buildTitleMap(pageTree)
|
const titles = buildTitleMap(pageTree)
|
||||||
return [...(visits || [])].reverse().slice(0, 20).map((v) => {
|
return [...(visits || [])].reverse().slice(0, 20).map((v) => {
|
||||||
const client = (clients || {})[v.client] || {}
|
const client = (clients || {})[v.client] || {}
|
||||||
const trail = Object.values(v.trail || {})
|
const steps = Object.values(v.trail || {})
|
||||||
.map((item) => {
|
.map((item) => {
|
||||||
const step = stepOf(item.to, titles)
|
const step = stepOf(item.to, titles)
|
||||||
if (step) {
|
if (step) {
|
||||||
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
|
||||||
}
|
}
|
||||||
return step
|
return step
|
||||||
})
|
})
|
||||||
.filter(Boolean)
|
.filter(Boolean)
|
||||||
const utmKeys = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content']
|
const trail = []
|
||||||
const utmValues = utmKeys.map((k) => (v.utm || {})[k]).filter(Boolean)
|
for (const step of steps) {
|
||||||
const utm = utmValues.length ? utmValues.join(' · ') : ''
|
const prev = trail[trail.length - 1]
|
||||||
const utmTitle = Object.entries(v.utm || {})
|
if (prev && prev.path === step.path) {
|
||||||
.map(([k, value]) => `${k}=${value}`)
|
if (step.lang && step.lang !== prev.langs[prev.langs.length - 1]) prev.langs.push(step.lang)
|
||||||
.join(', ')
|
if (step.readSeconds) prev.readSeconds = (prev.readSeconds || 0) + step.readSeconds
|
||||||
|
if (step.status) prev.status = step.status
|
||||||
|
} else {
|
||||||
|
step.langs = step.lang ? [step.lang] : []
|
||||||
|
trail.push(step)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const distinctLangs = new Set(trail.flatMap((s) => s.langs))
|
||||||
const dash = (s) => (s || '—')
|
const dash = (s) => (s || '—')
|
||||||
const host = client.host || ''
|
const host = client.host || ''
|
||||||
const isHost = !!host
|
const isHost = !!host
|
||||||
return {
|
const row = {
|
||||||
lastSeen: formatWhen(v.start, now),
|
lastSeen: formatWhen(v.start, now),
|
||||||
lastSeenIso: formatWhenIso(v.start),
|
lastSeenIso: formatWhenIso(v.start),
|
||||||
lastSeenLocal: formatWhenLocal(v.start),
|
lastSeenLocal: formatWhenLocal(v.start),
|
||||||
langDisplay: formatLang(client.lang),
|
langDisplay: formatLang(client.lang),
|
||||||
trail,
|
trail,
|
||||||
refererStep: stepOf(v.referer, titles),
|
refererBadge: refererBadgeOf(v.referer, titles, v.utm),
|
||||||
referer: dash(v.referer),
|
|
||||||
ip: client.ip || '',
|
ip: client.ip || '',
|
||||||
ipDisplay: isHost ? mainDomain(host) : hostIP(client.ip) || client.ip || '—',
|
ipDisplay: isHost ? mainDomain(host) : hostIP(client.ip) || client.ip || '—',
|
||||||
isHost,
|
isHost,
|
||||||
lang: dash(client.lang),
|
lang: dash(client.lang),
|
||||||
country: dash(client.country),
|
country: dash(client.country),
|
||||||
city: dash(client.city),
|
city: dash(client.city),
|
||||||
ua: client.ua_pretty || client.ua || '—',
|
ua: client.uarite?.pretty || client.ua || '—',
|
||||||
uaRaw: client.ua || '',
|
uaRaw: client.ua || '',
|
||||||
utm: utm || '—',
|
uaUrl: client.uarite?.url || '',
|
||||||
utmTitle,
|
|
||||||
}
|
}
|
||||||
|
if (site.multilingual && distinctLangs.size) {
|
||||||
|
if (distinctLangs.size === 1) {
|
||||||
|
const [tag] = distinctLangs
|
||||||
|
const flag = flagFor(tag)
|
||||||
|
if (flag && tag !== site.primaryLang) {
|
||||||
|
row.rowFlag = flag
|
||||||
|
row.rowFlagTitle = langName(tag)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// Flag the steps where the rendered language begins or changes;
|
||||||
|
// lang-less steps keep the comparison chain going, they never flag.
|
||||||
|
let lastLang = null
|
||||||
|
for (const step of trail) {
|
||||||
|
if (!step.langs.length) continue
|
||||||
|
if (!lastLang || step.langs[step.langs.length - 1] !== lastLang) {
|
||||||
|
step.langFlags = step.langs.map(flagFor).filter(Boolean)
|
||||||
|
}
|
||||||
|
lastLang = step.langs[step.langs.length - 1]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return row
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -26,6 +26,14 @@
|
|||||||
/* Selection fill for page text and the CodeMirror editors; themes
|
/* Selection fill for page text and the CodeMirror editors; themes
|
||||||
override when the accent tint clashes with accent-colored text. */
|
override when the accent tint clashes with accent-colored text. */
|
||||||
--selection-bg: color-mix(var(--accent) 30%, transparent);
|
--selection-bg: color-mix(var(--accent) 30%, transparent);
|
||||||
|
/* Referer-badge chip in the analytics viewer: a fixed neutral palette,
|
||||||
|
deliberately NOT themed — the chip sits behind transparent favicons, so
|
||||||
|
black-on-transparent and white-on-transparent glyphs must both stay
|
||||||
|
legible on every theme (dark greys kill black glyphs, pure white kills
|
||||||
|
white ones); its text likewise stays dark on any theme. */
|
||||||
|
--badge-bg: #c9d1d9;
|
||||||
|
--badge-text: #1f2328;
|
||||||
|
--badge-muted: #59636e;
|
||||||
/* Code highlighting palette, consumed by pygments.css: complete light and
|
/* Code highlighting palette, consumed by pygments.css: complete light and
|
||||||
dark sets (background included), resolved by light-dark() from the
|
dark sets (background included), resolved by light-dark() from the
|
||||||
used color-scheme. A theme picks a set simply by declaring
|
used color-scheme. A theme picks a set simply by declaring
|
||||||
@@ -756,6 +764,20 @@ article {
|
|||||||
position: relative;
|
position: relative;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Emoji/symbol icon buttons and links: dim until hovered. */
|
||||||
|
.icon-btn {
|
||||||
|
padding: 0;
|
||||||
|
font: inherit;
|
||||||
|
background: none;
|
||||||
|
border: none;
|
||||||
|
cursor: pointer;
|
||||||
|
opacity: 0.7;
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon-btn:hover {
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
|
||||||
.edit-link {
|
.edit-link {
|
||||||
position: absolute;
|
position: absolute;
|
||||||
top: 0.2rem;
|
top: 0.2rem;
|
||||||
@@ -763,12 +785,6 @@ article {
|
|||||||
left: -2.2rem;
|
left: -2.2rem;
|
||||||
z-index: 2;
|
z-index: 2;
|
||||||
/* stay above full-bleed .wide images */
|
/* stay above full-bleed .wide images */
|
||||||
font: inherit;
|
|
||||||
background: none;
|
|
||||||
border: none;
|
|
||||||
padding: 0;
|
|
||||||
cursor: pointer;
|
|
||||||
opacity: 0.7;
|
|
||||||
text-shadow: 0 0 0.1em black;
|
text-shadow: 0 0 0.1em black;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -790,24 +806,14 @@ article h2 .edit-section {
|
|||||||
opacity: 0.35;
|
opacity: 0.35;
|
||||||
}
|
}
|
||||||
|
|
||||||
.edit-link:hover {
|
|
||||||
opacity: 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Login/profile links injected by pagerite.js when Paskia SSO is in use.
|
/* Login/profile links injected by pagerite.js when Paskia SSO is in use.
|
||||||
They live inside the .editor-pens flex container in the banner's top-right
|
They live inside the .editor-pens flex container in the banner's top-right
|
||||||
corner and inherit its reset; keep only their opacity/text-shadow tweaks. */
|
corner and inherit its reset; keep only their text-shadow tweak. */
|
||||||
.editor-pens a.login-link,
|
.editor-pens a.login-link,
|
||||||
.editor-pens a.profile-link {
|
.editor-pens a.profile-link {
|
||||||
opacity: 0.7;
|
|
||||||
text-shadow: 0 0 0.1em black;
|
text-shadow: 0 0 0.1em black;
|
||||||
}
|
}
|
||||||
|
|
||||||
.editor-pens a.login-link:hover,
|
|
||||||
.editor-pens a.profile-link:hover {
|
|
||||||
opacity: 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
article p,
|
article p,
|
||||||
article li,
|
article li,
|
||||||
article dd {
|
article dd {
|
||||||
|
|||||||
@@ -0,0 +1,24 @@
|
|||||||
|
// Shared popup open-state behavior: while `open` (a ref, truthy = open)
|
||||||
|
// is set, a pointerdown outside `root` (a template ref covering both the
|
||||||
|
// toggle button and the popup) or Escape resets it to null. One logic for
|
||||||
|
// every dropdown (LangSelect, the page editor's class/table pickers), so
|
||||||
|
// they can't drift apart.
|
||||||
|
import { onBeforeUnmount, watch } from 'vue'
|
||||||
|
|
||||||
|
export function usePopup(open, root) {
|
||||||
|
let off = null
|
||||||
|
const stop = watch(open, (v) => {
|
||||||
|
off?.()
|
||||||
|
off = null
|
||||||
|
if (!v) return
|
||||||
|
const down = (ev) => { if (!root.value?.contains(ev.target)) open.value = null }
|
||||||
|
const key = (ev) => { if (ev.key === 'Escape') open.value = null }
|
||||||
|
addEventListener('pointerdown', down, true)
|
||||||
|
addEventListener('keydown', key)
|
||||||
|
off = () => {
|
||||||
|
removeEventListener('pointerdown', down, true)
|
||||||
|
removeEventListener('keydown', key)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
onBeforeUnmount(() => { off?.(); stop() })
|
||||||
|
}
|
||||||
@@ -1,10 +1,15 @@
|
|||||||
// The editor shell's shared language selection ('' = the primary language):
|
// The editor shell's shared language selection ('' = the primary language):
|
||||||
// one state, v-modeled by the LangSelect of every tab that has one (page,
|
// backed by the app-wide store (./store), so the editor tabs' LangSelects
|
||||||
// structure). While the panel is open it also drives the page preview —
|
// and the public corner selector bind the same value. Linked to the
|
||||||
// EditorShell applies it as the fetch-time language override (swapdoc).
|
// whole-page language: while the panel is open it drives the page preview
|
||||||
import { ref } from 'vue'
|
// (EditorShell applies it as the fetch-time language override, swapdoc).
|
||||||
|
import { computed, ref } from 'vue'
|
||||||
|
import { pinia, useStore } from './store'
|
||||||
|
|
||||||
export const editorLang = ref('')
|
export const editorLang = computed({
|
||||||
|
get: () => useStore(pinia).lang,
|
||||||
|
set: (v) => { useStore(pinia).lang = v },
|
||||||
|
})
|
||||||
|
|
||||||
// The CURRENT PAGE's primary language ('' = not yet learned): the shell's
|
// The CURRENT PAGE's primary language ('' = not yet learned): the shell's
|
||||||
// settings fetch fills it with the site default; the page/structure tabs
|
// settings fetch fills it with the site default; the page/structure tabs
|
||||||
|
|||||||
@@ -30,6 +30,20 @@ export const LANG_GROUPS = [
|
|||||||
|
|
||||||
const displayNames = new Intl.DisplayNames(['en'], { type: 'language' })
|
const displayNames = new Intl.DisplayNames(['en'], { type: 'language' })
|
||||||
|
|
||||||
|
// Consistent menu ordering for language selectors: the geographic/cultural
|
||||||
|
// grouping above (similar languages sit together, and it does not vary with
|
||||||
|
// the display language the way alphabetical-by-name would). Tags outside
|
||||||
|
// the groups trail, ordered by tag. The primary language is not special
|
||||||
|
// here — callers put it first themselves.
|
||||||
|
const groupOrder = new Map(LANG_GROUPS.flat().map((c, i) => [c, i]))
|
||||||
|
export function langSort(codes) {
|
||||||
|
return [...codes].sort(
|
||||||
|
(a, b) =>
|
||||||
|
(groupOrder.get(a) ?? groupOrder.size) - (groupOrder.get(b) ?? groupOrder.size)
|
||||||
|
|| a.localeCompare(b),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
// English display name for a language tag ("fi" -> "Finnish").
|
// English display name for a language tag ("fi" -> "Finnish").
|
||||||
export function langName(tag) {
|
export function langName(tag) {
|
||||||
try {
|
try {
|
||||||
|
|||||||
@@ -0,0 +1,50 @@
|
|||||||
|
// Public language-selector entry: imported on demand by pagerite.js on
|
||||||
|
// pages advertising more than one language in their hreflang alternates.
|
||||||
|
// Vue, Pinia and the flag SVG set live in this chunk only — untranslated
|
||||||
|
// pages never pay for them. The selector's state lives in the shared
|
||||||
|
// store (./store), not the DOM: the corner container is rebuilt freely
|
||||||
|
// and ensureMounted re-mounts from the store.
|
||||||
|
import { createApp } from 'vue'
|
||||||
|
import LangSelector from './LangSelector.vue'
|
||||||
|
import { pinia, useStore } from './store'
|
||||||
|
|
||||||
|
let app = null
|
||||||
|
|
||||||
|
function store() {
|
||||||
|
return useStore(pinia)
|
||||||
|
}
|
||||||
|
|
||||||
|
// The current page's languages (called on every navigation).
|
||||||
|
export function setLanguages(alternates, current) {
|
||||||
|
Object.assign(store(), {
|
||||||
|
langAlternates: alternates,
|
||||||
|
servedLang: current,
|
||||||
|
langSelectorActive: true,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// The current page is single-language: the selector goes away.
|
||||||
|
export function hide() {
|
||||||
|
store().langSelectorActive = false
|
||||||
|
app?.unmount()
|
||||||
|
app = null
|
||||||
|
}
|
||||||
|
|
||||||
|
// Mount the selector as the container's first item; re-mount when its
|
||||||
|
// element went away with a container rebuild (a live app updates from the
|
||||||
|
// store reactively).
|
||||||
|
export function ensureMounted(host) {
|
||||||
|
if (!store().langSelectorActive || !host) {
|
||||||
|
app?.unmount()
|
||||||
|
app = null
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if (app && host.contains(app._container)) return
|
||||||
|
app?.unmount()
|
||||||
|
const el = document.createElement('div')
|
||||||
|
el.id = 'lang-selector'
|
||||||
|
host.prepend(el)
|
||||||
|
app = createApp(LangSelector)
|
||||||
|
app.use(pinia)
|
||||||
|
app.mount(el)
|
||||||
|
}
|
||||||
+116
-33
@@ -51,13 +51,18 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
|
|||||||
url.searchParams.delete("lang");
|
url.searchParams.delete("lang");
|
||||||
history.replaceState(history.state, "", url);
|
history.replaceState(history.state, "", url);
|
||||||
}
|
}
|
||||||
// The session language. While the editor panel is open, its language
|
// The session language: the user's explicit pick (initial ?lang=, public
|
||||||
// selection overrides the normal preference (swapdoc.setLangOverride):
|
// selector, editor dropdown) is kept in chosenLang; while the editor is
|
||||||
// internal fetches and prefetches follow it until the panel closes and
|
// open its selection overrides it (swapdoc.setLangOverride), and closing
|
||||||
// the override clears (null restores the initial ?lang=, if any).
|
// falls back to chosenLang. JS state only — pretty URLs, no reloads.
|
||||||
|
// window.__pageriteLang is the pin for swapdoc.loadPlain's fetches.
|
||||||
|
let chosenLang = langParam;
|
||||||
let sessionLang = langParam;
|
let sessionLang = langParam;
|
||||||
|
window.__pageriteLang = sessionLang;
|
||||||
addEventListener("pagerite:session-lang", (ev) => {
|
addEventListener("pagerite:session-lang", (ev) => {
|
||||||
sessionLang = ev.detail?.lang || langParam;
|
if (ev.detail?.lang) chosenLang = ev.detail.lang;
|
||||||
|
sessionLang = ev.detail?.lang || chosenLang;
|
||||||
|
window.__pageriteLang = sessionLang;
|
||||||
});
|
});
|
||||||
// An internal URL as fetched: carries the session's ?lang= unless the
|
// An internal URL as fetched: carries the session's ?lang= unless the
|
||||||
// link already pins a language of its own. With no ?lang= on the initial
|
// link already pins a language of its own. With no ?lang= on the initial
|
||||||
@@ -127,16 +132,16 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
|
|||||||
if (line != null) {
|
if (line != null) {
|
||||||
// Section pen on an anchored h2: opens the page editor at the
|
// Section pen on an anchored h2: opens the page editor at the
|
||||||
// section's markdown source line (data-line, from the backend).
|
// section's markdown source line (data-line, from the backend).
|
||||||
btn.className = "edit-link edit-section";
|
btn.className = "edit-link edit-section icon-btn";
|
||||||
btn.title = "edit section";
|
btn.title = "edit section";
|
||||||
btn.textContent = "🖊️";
|
btn.textContent = "🖊️";
|
||||||
btn.dataset.editorLine = line;
|
btn.dataset.editorLine = line;
|
||||||
} else if (mode === "page") {
|
} else if (mode === "page") {
|
||||||
btn.className = "edit-link edit-page";
|
btn.className = "edit-link edit-page icon-btn";
|
||||||
btn.title = "edit page";
|
btn.title = "edit page";
|
||||||
btn.textContent = "🖊️";
|
btn.textContent = "🖊️";
|
||||||
} else {
|
} else {
|
||||||
btn.className = "edit-link site-edit-link";
|
btn.className = "edit-link site-edit-link icon-btn";
|
||||||
btn.title = "site settings";
|
btn.title = "site settings";
|
||||||
btn.textContent = "⚙️";
|
btn.textContent = "⚙️";
|
||||||
}
|
}
|
||||||
@@ -160,13 +165,29 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
|
|||||||
|
|
||||||
function makeAuthLink(admin) {
|
function makeAuthLink(admin) {
|
||||||
const a = document.createElement("a");
|
const a = document.createElement("a");
|
||||||
a.className = admin ? "profile-link" : "login-link";
|
a.className = (admin ? "profile-link" : "login-link") + " icon-btn";
|
||||||
a.href = "/auth/";
|
a.href = "/auth/";
|
||||||
a.title = admin ? "profile" : "log in";
|
a.title = admin ? "profile" : "log in";
|
||||||
a.textContent = admin ? "\u{1F510}" : "\u{1F511}";
|
a.textContent = admin ? "\u{1F510}" : "\u{1F511}";
|
||||||
return a;
|
return a;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The banner top-right corner container: the language selector (first
|
||||||
|
// 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,
|
||||||
|
// so the langselect bundle re-mounts it into the fresh container.
|
||||||
|
function pensContainer() {
|
||||||
|
let pens = document.querySelector(".editor-pens");
|
||||||
|
if (!pens) {
|
||||||
|
const banner = document.getElementById("page-banner");
|
||||||
|
if (!banner) return null;
|
||||||
|
pens = document.createElement("div");
|
||||||
|
pens.className = "editor-pens";
|
||||||
|
banner.after(pens);
|
||||||
|
}
|
||||||
|
return pens;
|
||||||
|
}
|
||||||
|
|
||||||
function removePens() {
|
function removePens() {
|
||||||
document.querySelectorAll(".editor-pens, #main article button.edit-link")
|
document.querySelectorAll(".editor-pens, #main article button.edit-link")
|
||||||
.forEach((el) => el.remove());
|
.forEach((el) => el.remove());
|
||||||
@@ -178,32 +199,33 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
|
|||||||
// pens that may have been injected while the browser cache made us look
|
// pens that may have been injected while the browser cache made us look
|
||||||
// authenticated.
|
// authenticated.
|
||||||
removePens();
|
removePens();
|
||||||
if (!authReady) return;
|
if (authReady) {
|
||||||
|
// 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 side
|
// panel do not apply there. Login/logout links are still useful.
|
||||||
// panel do not apply there. Login/logout links are still useful.
|
const onAnalytics = currentPath === "/_a";
|
||||||
const onAnalytics = currentPath === "/_a";
|
if (document.getElementById("page-banner")) {
|
||||||
const banner = document.getElementById("page-banner");
|
const pens = pensContainer();
|
||||||
if (banner) {
|
if (canEdit && !onAnalytics) {
|
||||||
const pens = document.createElement("div");
|
// Analytics viewer is now a normal page at /_a.
|
||||||
pens.className = "editor-pens";
|
const a = document.createElement("a");
|
||||||
if (canEdit && !onAnalytics) {
|
a.className = "edit-link analytics-link icon-btn";
|
||||||
// Analytics viewer is now a normal page at /_a.
|
a.href = "/_a";
|
||||||
const a = document.createElement("a");
|
a.title = "analytics";
|
||||||
a.className = "edit-link analytics-link";
|
a.textContent = "📊";
|
||||||
a.href = "/_a";
|
pens.append(a);
|
||||||
a.title = "analytics";
|
pens.append(makePen("site"));
|
||||||
a.textContent = "📊";
|
}
|
||||||
pens.append(a);
|
if (ssoAvailable) pens.append(makeAuthLink(isAdmin));
|
||||||
pens.append(makePen("site"));
|
if (!pens.firstElementChild) pens.remove();
|
||||||
}
|
}
|
||||||
if (ssoAvailable) pens.append(makeAuthLink(isAdmin));
|
if (canEdit && !onAnalytics) injectPagePen();
|
||||||
banner.after(pens);
|
|
||||||
}
|
}
|
||||||
if (canEdit && !onAnalytics) injectPagePen();
|
// Re-mount the selector into the fresh container (no-op until the
|
||||||
|
// bundle has been loaded once).
|
||||||
|
langselectMod?.ensureMounted(document.querySelector(".editor-pens"));
|
||||||
}
|
}
|
||||||
|
|
||||||
async function setupAuth() {
|
async function setupAuth() {
|
||||||
@@ -407,6 +429,9 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
|
|||||||
// copy pinned to a language (?lang=) caches under its own key, where
|
// copy pinned to a language (?lang=) caches under its own key, where
|
||||||
// navigation with the same session language finds it.
|
// navigation with the same session language finds it.
|
||||||
pageCache.set(rawKey(ev.detail.url), ev.detail.html);
|
pageCache.set(rawKey(ev.detail.url), ev.detail.html);
|
||||||
|
// Editor-driven swaps don't go through load(): re-evaluate the
|
||||||
|
// language selector from the fresh copy too.
|
||||||
|
mountLangselect(new DOMParser().parseFromString(ev.detail.html, "text/html"));
|
||||||
});
|
});
|
||||||
|
|
||||||
// Editors mutate site-wide state (theme, structure, headings, banners),
|
// Editors mutate site-wide state (theme, structure, headings, banners),
|
||||||
@@ -612,6 +637,8 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
|
|||||||
if (to) msg.to = to;
|
if (to) msg.to = to;
|
||||||
const secs = Math.round(read / 1000);
|
const secs = Math.round(read / 1000);
|
||||||
if (secs > 0) msg.read = secs;
|
if (secs > 0) msg.read = secs;
|
||||||
|
const lang = document.documentElement.lang;
|
||||||
|
if (lang) msg.lang = lang;
|
||||||
if (!msg.to && !msg.read) return;
|
if (!msg.to && !msg.read) return;
|
||||||
report(msg);
|
report(msg);
|
||||||
}
|
}
|
||||||
@@ -742,6 +769,60 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// --- Public language selector ------------------------------------------
|
||||||
|
// Pages translated into more than one language advertise it via hreflang
|
||||||
|
// alternates (x-default + one link per language). Those pages get the
|
||||||
|
// editors' flag dropdown as the first item of the corner container; its
|
||||||
|
// bundle (Vue + the flag SVG set) loads on demand. Re-evaluated from the
|
||||||
|
// fresh document on every swap (the head's own alternates stay stale).
|
||||||
|
let langselectMod = null;
|
||||||
|
async function mountLangselect(doc) {
|
||||||
|
const links = [...doc.head.querySelectorAll('link[rel="alternate"][hreflang]')];
|
||||||
|
const dflt = links.find((l) => l.hreflang === "x-default");
|
||||||
|
const langs = links.filter((l) => l.hreflang && l.hreflang !== "x-default");
|
||||||
|
if (!dflt || langs.length <= 1) return langselectMod?.hide();
|
||||||
|
try {
|
||||||
|
langselectMod ??= await import(/* @vite-ignore */ assets["pagerite:langselect-src"]);
|
||||||
|
for (const css of (assets["pagerite:langselect-css"] || "").split(",")) {
|
||||||
|
if (css && !document.querySelector(`link[href="${css}"]`)) {
|
||||||
|
const link = document.createElement("link");
|
||||||
|
link.rel = "stylesheet";
|
||||||
|
link.href = css;
|
||||||
|
link.dataset.pagerite = "langselect-css";
|
||||||
|
document.head.append(link);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
langselectMod.setLanguages(
|
||||||
|
// The original's alternate is the plain URL — x-default's href —
|
||||||
|
// which also marks it as the primary option.
|
||||||
|
langs.map((l) => ({ tag: l.hreflang, href: l.href, primary: l.href === dflt.href })),
|
||||||
|
doc.documentElement.lang,
|
||||||
|
);
|
||||||
|
langselectMod.ensureMounted(pensContainer());
|
||||||
|
} catch (e) {
|
||||||
|
console.error("language selector mount failed:", e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The selector's pick (LangSelector dispatches this): make it the
|
||||||
|
// session language and swap the page in place. With the editor open the
|
||||||
|
// pick already landed in the shared store — the editor's watch re-renders
|
||||||
|
// the page itself, so there is nothing to do here.
|
||||||
|
addEventListener("pagerite:set-session-lang", async (ev) => {
|
||||||
|
const tag = ev.detail?.lang;
|
||||||
|
if (!tag || tag === sessionLang) return;
|
||||||
|
if (document.body.classList.contains("editing")) return;
|
||||||
|
chosenLang = sessionLang = tag;
|
||||||
|
window.__pageriteLang = tag;
|
||||||
|
const y = scrollY; // a language switch is not a navigation: keep scroll
|
||||||
|
await load(currentPath, false);
|
||||||
|
scrollTo(0, y);
|
||||||
|
// Log the switch as a trail event in the new language (load() updated
|
||||||
|
// <html lang>): the ping matches the switch's GET server-side, so it is
|
||||||
|
// not misclassified as a crawler hit.
|
||||||
|
ping({ to: currentPath });
|
||||||
|
});
|
||||||
|
|
||||||
// --- 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 closes it; unsaved edits are lost
|
// Navigating with the editor open closes it; unsaved edits are lost
|
||||||
@@ -843,6 +924,7 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
|
|||||||
runScripts(document.getElementById("main"));
|
runScripts(document.getElementById("main"));
|
||||||
applyEffects();
|
applyEffects();
|
||||||
mountAnalytics(doc);
|
mountAnalytics(doc);
|
||||||
|
mountLangselect(doc);
|
||||||
};
|
};
|
||||||
// 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/);
|
||||||
@@ -1076,4 +1158,5 @@ import { reconnectPolicy, socketSlot, watchConnecting } from "./reconnect";
|
|||||||
setupAuth();
|
setupAuth();
|
||||||
applyEffects();
|
applyEffects();
|
||||||
mountAnalytics(document);
|
mountAnalytics(document);
|
||||||
|
mountLangselect(document);
|
||||||
})();
|
})();
|
||||||
|
|||||||
@@ -0,0 +1,26 @@
|
|||||||
|
// The app's shared Pinia store — cross-bundle UI state lives here. Every
|
||||||
|
// entry chunk imports its own copy of this module, so the Pinia instance
|
||||||
|
// is parked on window (Vue itself is a shared chunk, so reactivity works
|
||||||
|
// across the copies). Pass `pinia` explicitly when calling useStore
|
||||||
|
// outside a component (module code, no active instance).
|
||||||
|
import { createPinia, defineStore } from 'pinia'
|
||||||
|
|
||||||
|
export const pinia = (window.__pageritePinia ??= createPinia())
|
||||||
|
|
||||||
|
export const useStore = defineStore('pagerite', {
|
||||||
|
state: () => ({
|
||||||
|
// The ONE language selection, v-modeled by both dropdowns (editor
|
||||||
|
// tabs, public corner selector): '' = no explicit pick (the page's
|
||||||
|
// primary / autodetect), else a concrete tag. A pick from either
|
||||||
|
// dropdown is visible to everyone immediately.
|
||||||
|
lang: '',
|
||||||
|
// The language the current page was actually served in (set by
|
||||||
|
// pagerite.js per navigation) — the selector's highlight fallback
|
||||||
|
// when there is no explicit pick.
|
||||||
|
servedLang: '',
|
||||||
|
// The public selector's page data: hreflang alternates
|
||||||
|
// ([{tag, href, primary}]) and whether to show at all.
|
||||||
|
langAlternates: [],
|
||||||
|
langSelectorActive: false,
|
||||||
|
}),
|
||||||
|
})
|
||||||
+12
-9
@@ -12,12 +12,13 @@ export function dropPageCache() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// The editor's language override (set by EditorShell): while the panel is
|
// The editor's language override (set by EditorShell): while the panel is
|
||||||
// open, its language selection wins over the normal preferences (?lang= /
|
// open, its language selection wins over the normal preferences — every
|
||||||
// Accept-Language) — every in-place re-render asks for that language
|
// in-place re-render asks for that language explicitly, and pagerite.js
|
||||||
// explicitly, and pagerite.js applies it to its own fetches and prefetches
|
// applies it to its own fetches and prefetches (pagerite:session-lang).
|
||||||
// (pagerite:session-lang). The primary selection pins by its code:
|
// The primary selection pins by its code: ?lang=<primary> selects the
|
||||||
// ?lang=<primary> selects the original explicitly (i18n.select_language).
|
// original explicitly (i18n.select_language). Panel closed, the session's
|
||||||
let overrideLang = null // the ?lang= value in force, null = normal prefs
|
// chosen language (window.__pageriteLang) takes over — the pick stays.
|
||||||
|
let overrideLang = null // the ?lang= value in force, null = the session's
|
||||||
|
|
||||||
export function setLangOverride(queryLang) {
|
export function setLangOverride(queryLang) {
|
||||||
overrideLang = queryLang || null
|
overrideLang = queryLang || null
|
||||||
@@ -129,14 +130,16 @@ function swapRegions(doc) {
|
|||||||
// Fetch /p, swap its regions into the live page and replaceState to it.
|
// Fetch /p, swap its regions into the live page and replaceState to it.
|
||||||
// Returns the final URL (after redirects), or null when the fetch did not
|
// Returns the final URL (after redirects), or null when the fetch did not
|
||||||
// yield a page. Category and missing URLs render a placeholder 404 page —
|
// yield a page. Category and missing URLs render a placeholder 404 page —
|
||||||
// fine to swap in (new pages are created by editing them). While the
|
// fine to swap in (new pages are created by editing them). The fetch pins
|
||||||
// editor's language override is set the fetch pins that language.
|
// the editor's language override, or — panel closed — the session's chosen
|
||||||
|
// language (window.__pageriteLang).
|
||||||
export async function loadPlain(p) {
|
export async function loadPlain(p) {
|
||||||
let doc
|
let doc
|
||||||
let finalUrl = `/${p}`
|
let finalUrl = `/${p}`
|
||||||
let html
|
let html
|
||||||
try {
|
try {
|
||||||
const res = await fetch(overrideLang ? `${finalUrl}?lang=${overrideLang}` : finalUrl)
|
const pin = overrideLang || window.__pageriteLang
|
||||||
|
const res = await fetch(pin ? `${finalUrl}?lang=${pin}` : finalUrl)
|
||||||
const type = res.headers.get('content-type') || ''
|
const type = res.headers.get('content-type') || ''
|
||||||
if (!type.includes('text/html')) return null
|
if (!type.includes('text/html')) return null
|
||||||
if (res.redirected) finalUrl = res.url
|
if (res.redirected) finalUrl = res.url
|
||||||
|
|||||||
@@ -8,11 +8,11 @@
|
|||||||
* - Disables Vite's screen clearing on startup
|
* - Disables Vite's screen clearing on startup
|
||||||
*
|
*
|
||||||
* Options:
|
* Options:
|
||||||
* paths - Array of paths to proxy (default: ["/api"])
|
* paths - Array of paths to proxy (default: ['/api'])
|
||||||
*/
|
*/
|
||||||
|
|
||||||
export default function fastapiVue({ paths = ["/api"] } = {}) {
|
export default function fastapiVue({ paths = ['/api'] } = {}) {
|
||||||
const backendUrl = process.env.PAGERITE_BACKEND_URL || "http://localhost:8210"
|
const backendUrl = process.env.PAGERITE_BACKEND_URL || 'http://localhost:8210'
|
||||||
|
|
||||||
// Build proxy configuration for each path
|
// Build proxy configuration for each path
|
||||||
const proxy = {}
|
const proxy = {}
|
||||||
@@ -25,12 +25,12 @@ export default function fastapiVue({ paths = ["/api"] } = {}) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
name: "vite-plugin-fastapi-pagerite",
|
name: 'vite-plugin-fastapi-pagerite',
|
||||||
config: () => ({
|
config: () => ({
|
||||||
clearScreen: false,
|
clearScreen: false,
|
||||||
server: { proxy },
|
server: { proxy },
|
||||||
build: {
|
build: {
|
||||||
outDir: "../pagerite/frontend-build",
|
outDir: '../pagerite/frontend-build',
|
||||||
emptyOutDir: true,
|
emptyOutDir: true,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import { defineConfig } from 'vite'
|
|||||||
import vue from '@vitejs/plugin-vue'
|
import vue from '@vitejs/plugin-vue'
|
||||||
import vueDevTools from 'vite-plugin-vue-devtools'
|
import vueDevTools from 'vite-plugin-vue-devtools'
|
||||||
|
|
||||||
const backendUrl = process.env.PAGERITE_BACKEND_URL || 'http://localhost:3200'
|
const backendUrl = process.env.PAGERITE_BACKEND_URL || 'http://localhost:8210'
|
||||||
|
|
||||||
// Proxy everything except Vite's own dev-time paths and the backend machinery
|
// Proxy everything except Vite's own dev-time paths and the backend machinery
|
||||||
// to the FastAPI backend in dev. /_api, /_f, /_themes, /_fonts and /_a are
|
// to the FastAPI backend in dev. /_api, /_f, /_themes, /_fonts and /_a are
|
||||||
@@ -38,7 +38,7 @@ export default defineConfig({
|
|||||||
chunkSizeWarningLimit: 1200,
|
chunkSizeWarningLimit: 1200,
|
||||||
// Mirror the URL space in the build output: hashed files land under
|
// Mirror the URL space in the build output: hashed files land under
|
||||||
// frontend-build/_assets/ and the Frontend serves the build directory
|
// frontend-build/_assets/ and the Frontend serves the build directory
|
||||||
// at the site root (frontend/public/favicon.ico -> /favicon.ico).
|
// at the site root.
|
||||||
manifest: true,
|
manifest: true,
|
||||||
assetsDir: '_assets',
|
assetsDir: '_assets',
|
||||||
rollupOptions: {
|
rollupOptions: {
|
||||||
@@ -50,6 +50,7 @@ export default defineConfig({
|
|||||||
main: fileURLToPath(new URL('./src/main.js', import.meta.url)),
|
main: fileURLToPath(new URL('./src/main.js', import.meta.url)),
|
||||||
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)),
|
||||||
// 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)),
|
||||||
|
|||||||
@@ -5,12 +5,12 @@ import os
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
import msgspec
|
import msgspec
|
||||||
from fastapi_vue import server
|
from fastapi_vue import env, server
|
||||||
|
|
||||||
from pagerite.config import Config
|
from pagerite.config import Config
|
||||||
|
|
||||||
DEFAULT_PORT = 8100
|
DEFAULT_PORT = 8100
|
||||||
DEVMODE = os.getenv("PAGERITE_DEV") == "1"
|
os.environ["FASTAPI_VUE"] = "PAGERITE"
|
||||||
|
|
||||||
|
|
||||||
def main() -> None:
|
def main() -> None:
|
||||||
@@ -54,7 +54,7 @@ def main() -> None:
|
|||||||
listen=args.listen,
|
listen=args.listen,
|
||||||
default_port=DEFAULT_PORT,
|
default_port=DEFAULT_PORT,
|
||||||
server_header=False,
|
server_header=False,
|
||||||
reload=Path(__file__).parent if DEVMODE else False,
|
reload=Path(__file__).parent if env.dev else False,
|
||||||
**run_args,
|
**run_args,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
+140
-58
@@ -2,8 +2,9 @@
|
|||||||
|
|
||||||
Raw recording, display-time classification. Every document GET is appended
|
Raw recording, display-time classification. Every document GET is appended
|
||||||
to ``Analytics.gets`` as a raw access-log line (path with query string, true
|
to ``Analytics.gets`` as a raw access-log line (path with query string, true
|
||||||
HTTP status, external referer origin, preload flag) and every pagerite.js
|
HTTP status, external referer origin, preload flag, rendered content
|
||||||
activity message from the /_ws WebSocket is appended to ``Analytics.msgs``
|
language) and every pagerite.js activity message from the /_ws WebSocket is
|
||||||
|
appended to ``Analytics.msgs``
|
||||||
(navigations ``fr`` -> ``to`` and active reading-time updates). Nothing is
|
(navigations ``fr`` -> ``to`` and active reading-time updates). 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
|
||||||
@@ -60,32 +61,17 @@ from urllib.parse import parse_qs, urlencode, urlparse
|
|||||||
|
|
||||||
import blake3
|
import blake3
|
||||||
import msgspec
|
import msgspec
|
||||||
from ua_parser import parse
|
from uarite import UA, uaparse
|
||||||
|
|
||||||
|
|
||||||
def _compact_user_agent(ua: str) -> str:
|
def _display_client(client: Client) -> Client:
|
||||||
"""Format a User-Agent string into a compact display form.
|
"""Client copy with ``uarite`` filled in by the current uarite.
|
||||||
|
|
||||||
Returns the original UA when the parser cannot identify the browser/OS.
|
The parsed UA is a display-time field: stored records always carry the
|
||||||
|
default (None), so it never lands on disk, and old records always
|
||||||
|
follow current uarite rules.
|
||||||
"""
|
"""
|
||||||
if not ua or not ua.strip() or ua == "-":
|
return msgspec.structs.replace(client, uarite=uaparse(client.ua))
|
||||||
return ""
|
|
||||||
r = parse(ua)
|
|
||||||
browser = r.user_agent.family if r.user_agent else None
|
|
||||||
ver = r.user_agent.major if r.user_agent else ""
|
|
||||||
os_name = r.os.family if r.os else None
|
|
||||||
dev = r.device.family if r.device else None
|
|
||||||
if browser in (None, "Other") and os_name in (None, "Other"):
|
|
||||||
return ua
|
|
||||||
if browser and browser != "Other":
|
|
||||||
browser = browser.split()[0]
|
|
||||||
else:
|
|
||||||
browser = ""
|
|
||||||
os_name = os_name if os_name and os_name != "Other" else ""
|
|
||||||
if dev in (None, "Other") or dev == browser:
|
|
||||||
dev = ""
|
|
||||||
parts = [f"{browser}/{ver}" if browser else "", os_name, dev]
|
|
||||||
return " ".join(p for p in parts if p).strip()
|
|
||||||
|
|
||||||
|
|
||||||
class Ping(msgspec.Struct, omit_defaults=True):
|
class Ping(msgspec.Struct, omit_defaults=True):
|
||||||
@@ -107,6 +93,9 @@ class Ping(msgspec.Struct, omit_defaults=True):
|
|||||||
read: int = 0
|
read: int = 0
|
||||||
#: Admin client: record but hide everything from the statistics.
|
#: Admin client: record but hide everything from the statistics.
|
||||||
hide: bool = False
|
hide: bool = False
|
||||||
|
#: Rendered language of the page the activity happened on (the page's
|
||||||
|
#: ``<html lang>``, sent by pagerite.js).
|
||||||
|
lang: str = ""
|
||||||
|
|
||||||
|
|
||||||
class Get(msgspec.Struct, omit_defaults=True):
|
class Get(msgspec.Struct, omit_defaults=True):
|
||||||
@@ -130,6 +119,9 @@ class Get(msgspec.Struct, omit_defaults=True):
|
|||||||
#: never counted as a view/crawler/abuse hit; recorded only so a later
|
#: never counted as a view/crawler/abuse hit; recorded only so a later
|
||||||
#: cache-served navigation can be attributed this GET's status.
|
#: cache-served navigation can be attributed this GET's status.
|
||||||
pre: bool = False
|
pre: bool = False
|
||||||
|
#: Rendered content language of the served document; "" for
|
||||||
|
#: non-localized responses (404 probes, reserved paths).
|
||||||
|
lang: str = ""
|
||||||
|
|
||||||
|
|
||||||
class Msg(msgspec.Struct, omit_defaults=True):
|
class Msg(msgspec.Struct, omit_defaults=True):
|
||||||
@@ -150,6 +142,9 @@ class Msg(msgspec.Struct, omit_defaults=True):
|
|||||||
to: str = ""
|
to: str = ""
|
||||||
#: Active reading time (seconds) spent on ``fr`` since the last report.
|
#: Active reading time (seconds) spent on ``fr`` since the last report.
|
||||||
read: int = 0
|
read: int = 0
|
||||||
|
#: Rendered language reported by the client for the page the activity
|
||||||
|
#: happened on.
|
||||||
|
lang: str = ""
|
||||||
|
|
||||||
|
|
||||||
class Client(msgspec.Struct, omit_defaults=True):
|
class Client(msgspec.Struct, omit_defaults=True):
|
||||||
@@ -172,11 +167,14 @@ class Client(msgspec.Struct, omit_defaults=True):
|
|||||||
city: str = ""
|
city: str = ""
|
||||||
#: Raw User-Agent header.
|
#: Raw User-Agent header.
|
||||||
ua: str = ""
|
ua: str = ""
|
||||||
#: Compact display form of ``ua`` (browser/OS/device) when parsable.
|
|
||||||
ua_pretty: str = ""
|
|
||||||
#: True for admin clients (hide=1 ping): everything this client ever did
|
#: True for admin clients (hide=1 ping): everything this client ever did
|
||||||
#: is excluded from all statistics and from the viewer payload.
|
#: is excluded from all statistics and from the viewer payload.
|
||||||
hide: bool = False
|
hide: bool = False
|
||||||
|
#: Display-time parsed UA (uarite.UA dataclass: pretty/engine/os/
|
||||||
|
#: provider/kind/url). Set only on the display-payload copies by
|
||||||
|
#: ``_display_client`` — stored records keep the default, so it is never
|
||||||
|
#: persisted and old data always follows the current uarite version.
|
||||||
|
uarite: UA | None = None
|
||||||
|
|
||||||
|
|
||||||
# --- Display DTOs -------------------------------------------------------
|
# --- Display DTOs -------------------------------------------------------
|
||||||
@@ -203,6 +201,8 @@ class TrailItem(msgspec.Struct, omit_defaults=True):
|
|||||||
|
|
||||||
``read`` accumulates active reading time (seconds) across the whole
|
``read`` accumulates active reading time (seconds) across the whole
|
||||||
visit; ``status`` is the most recent HTTP status seen for the target.
|
visit; ``status`` is the most recent HTTP status seen for the target.
|
||||||
|
A page seen in two rendered languages within one visit (a mid-article
|
||||||
|
language switch) gets one item per language.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
to: str
|
to: str
|
||||||
@@ -210,6 +210,10 @@ class TrailItem(msgspec.Struct, omit_defaults=True):
|
|||||||
read: int = 0
|
read: int = 0
|
||||||
#: Most recent HTTP status of the response (200 or 404).
|
#: Most recent HTTP status of the response (200 or 404).
|
||||||
status: int = 200
|
status: int = 200
|
||||||
|
#: Rendered language of the target: the client's report, for the entry
|
||||||
|
#: page falling back to its GET's rendered language; "" when unknown
|
||||||
|
#: (old clients or data from before language recording).
|
||||||
|
lang: str = ""
|
||||||
|
|
||||||
|
|
||||||
class Visit(msgspec.Struct, omit_defaults=True):
|
class Visit(msgspec.Struct, omit_defaults=True):
|
||||||
@@ -218,8 +222,9 @@ class Visit(msgspec.Struct, omit_defaults=True):
|
|||||||
``trail`` holds the entry page and everything seen afterwards, keyed by
|
``trail`` holds the entry page and everything seen afterwards, keyed by
|
||||||
the timestamp of first sight (insertion order = first-seen order);
|
the timestamp of first sight (insertion order = first-seen order);
|
||||||
re-visiting an already seen target updates its item instead of
|
re-visiting an already seen target updates its item instead of
|
||||||
appending. Client metadata is held in ``Analytics.clients`` keyed by
|
appending — unless the client reports a different rendered language for
|
||||||
``client``.
|
it, which appends a distinct item (a mid-article language switch).
|
||||||
|
Client metadata is held in ``Analytics.clients`` keyed by ``client``.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
start: datetime
|
start: datetime
|
||||||
@@ -253,6 +258,8 @@ class CrawlerHit(msgspec.Struct, omit_defaults=True):
|
|||||||
query: str = ""
|
query: str = ""
|
||||||
#: HTTP status of the served response (200 or 404 for content pages).
|
#: HTTP status of the served response (200 or 404 for content pages).
|
||||||
status: int = 200
|
status: int = 200
|
||||||
|
#: Rendered content language of the served document (from the GET).
|
||||||
|
lang: str = ""
|
||||||
|
|
||||||
|
|
||||||
class AbuseHit(msgspec.Struct, omit_defaults=True):
|
class AbuseHit(msgspec.Struct, omit_defaults=True):
|
||||||
@@ -331,6 +338,12 @@ class Display(msgspec.Struct, omit_defaults=True):
|
|||||||
views: dict[str, dict[str, int]] = {}
|
views: dict[str, dict[str, int]] = {}
|
||||||
#: New visits per 5-minute bucket: bucket ISO -> count (sparse).
|
#: New visits per 5-minute bucket: bucket ISO -> count (sparse).
|
||||||
site_visits: dict[str, int] = {}
|
site_visits: dict[str, int] = {}
|
||||||
|
#: Site context: true when translation languages are configured, so the
|
||||||
|
#: viewer can suppress language UI on single-language sites.
|
||||||
|
multilingual: bool = False
|
||||||
|
#: The site's primary language (the front page's), so the viewer can
|
||||||
|
#: skip the primary-language default case.
|
||||||
|
primary_lang: str = ""
|
||||||
|
|
||||||
|
|
||||||
def _bucket(now: datetime) -> str:
|
def _bucket(now: datetime) -> str:
|
||||||
@@ -418,17 +431,22 @@ _MIN_VISIT_READ = 5
|
|||||||
_FAVICON_RETRY = timedelta(days=7)
|
_FAVICON_RETRY = timedelta(days=7)
|
||||||
|
|
||||||
#: UAs of JS-running crawlers, which would register as visitors on their
|
#: UAs of JS-running crawlers, which would register as visitors on their
|
||||||
#: activity messages. Anything calling itself a "bot" or "spider" matches;
|
#: activity messages. ``uarite`` knows the common crawlers
|
||||||
#: known crawlers without those tokens (GoogleOther) are listed as extra
|
#: and link-preview fetchers (including disguised ones such as
|
||||||
#: alternates. No source verification: a spoofed bot UA just lands in the
|
#: facebookexternalhit and Google-Extended) plus any UA with a
|
||||||
#: crawler list, and scanners that probe telltale paths are caught by the
|
#: bot/spider/crawler/scanner token. No source verification: a spoofed
|
||||||
#: abuse rules anyway.
|
#: bot UA just lands in the crawler list, and scanners that probe
|
||||||
_BOT_UA = re.compile(r"bot|spider|googleother", re.IGNORECASE)
|
#: telltale paths are caught by the abuse rules anyway.
|
||||||
|
|
||||||
|
|
||||||
def _is_bot_ua(ua: str) -> bool:
|
def _is_bot_ua(ua: str) -> bool:
|
||||||
"""True when the UA claims a crawler identity (bot or spider)."""
|
"""True when the UA is not a regular browser.
|
||||||
return bool(_BOT_UA.search(ua))
|
|
||||||
|
Every real browser registers as ``kind == "browser"``; anything else
|
||||||
|
(recognized crawler/previewer, generic bot token, or an unclassified
|
||||||
|
HTTP client such as httpx) is not a visitor.
|
||||||
|
"""
|
||||||
|
return uaparse(ua).kind != "browser"
|
||||||
|
|
||||||
|
|
||||||
#: Plain-404 count per IP within ``_ABUSE_404_WINDOW`` that classifies it as
|
#: Plain-404 count per IP within ``_ABUSE_404_WINDOW`` that classifies it as
|
||||||
@@ -560,7 +578,6 @@ class Store:
|
|||||||
self.data.clients[h] = Client(
|
self.data.clients[h] = Client(
|
||||||
ip=ip,
|
ip=ip,
|
||||||
ua=ua,
|
ua=ua,
|
||||||
ua_pretty=_compact_user_agent(ua),
|
|
||||||
lang=lang,
|
lang=lang,
|
||||||
country=country,
|
country=country,
|
||||||
)
|
)
|
||||||
@@ -602,22 +619,25 @@ class Store:
|
|||||||
referer: str = "",
|
referer: str = "",
|
||||||
accept_language: str = "",
|
accept_language: str = "",
|
||||||
pre: bool = False,
|
pre: bool = False,
|
||||||
|
lang: str = "",
|
||||||
) -> bytes | None:
|
) -> bytes | None:
|
||||||
"""Append one document GET to the raw log.
|
"""Append one document GET to the raw log.
|
||||||
|
|
||||||
``path`` is the full request path, query string included; ``status``
|
``path`` is the full request path, query string included; ``status``
|
||||||
the true HTTP status of the response; ``referer`` the raw Referer
|
the true HTTP status of the response; ``referer`` the raw Referer
|
||||||
header (reduced here to an external https origin, "" when internal
|
header (reduced here to an external https origin, "" when internal
|
||||||
or absent); ``pre`` marks idle-time preloads from pagerite.js.
|
or absent); ``pre`` marks idle-time preloads from pagerite.js;
|
||||||
|
``lang`` the rendered content language of the served document (""
|
||||||
|
for non-localized responses such as 404 probes and reserved paths).
|
||||||
|
|
||||||
Returns the client hash when the client record was just created (so
|
Returns the client hash when the client record was just created (so
|
||||||
the caller can schedule async enrichment), else None.
|
the caller can schedule async enrichment), else None.
|
||||||
"""
|
"""
|
||||||
lang, country = _parse_accept_language(accept_language)
|
client_lang, country = _parse_accept_language(accept_language)
|
||||||
client_hash = _client_hash(ip, ua, lang)
|
client_hash = _client_hash(ip, ua, client_lang)
|
||||||
new = client_hash not in self.data.clients
|
new = client_hash not in self.data.clients
|
||||||
if new:
|
if new:
|
||||||
self._ensure_client(ip, ua, lang, country=country)
|
self._ensure_client(ip, ua, client_lang, country=country)
|
||||||
self.data.gets.append(
|
self.data.gets.append(
|
||||||
Get(
|
Get(
|
||||||
t=datetime.now(UTC),
|
t=datetime.now(UTC),
|
||||||
@@ -626,6 +646,7 @@ class Store:
|
|||||||
status=status,
|
status=status,
|
||||||
ref=_origin(referer) or "",
|
ref=_origin(referer) or "",
|
||||||
pre=pre,
|
pre=pre,
|
||||||
|
lang=lang,
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
self._save()
|
self._save()
|
||||||
@@ -640,6 +661,7 @@ class Store:
|
|||||||
accept_language: str = "",
|
accept_language: str = "",
|
||||||
hide: bool = False,
|
hide: bool = False,
|
||||||
read: int = 0,
|
read: int = 0,
|
||||||
|
lang: str = "",
|
||||||
) -> bytes | None:
|
) -> bytes | None:
|
||||||
"""Append one client activity message (``Ping`` from pagerite.js) to
|
"""Append one client activity message (``Ping`` from pagerite.js) to
|
||||||
the raw log.
|
the raw log.
|
||||||
@@ -650,16 +672,18 @@ class Store:
|
|||||||
stored raw and filtered at display time, so future rule changes lose
|
stored raw and filtered at display time, so future rule changes lose
|
||||||
nothing. ``hide`` flags the client record as an admin; the message
|
nothing. ``hide`` flags the client record as an admin; the message
|
||||||
itself is recorded normally and hidden at display time like
|
itself is recorded normally and hidden at display time like
|
||||||
everything else the client ever did.
|
everything else the client ever did. ``lang`` is the rendered
|
||||||
|
language reported by the client for the page the activity happened
|
||||||
|
on.
|
||||||
|
|
||||||
Returns the client hash when the client record was just created (so
|
Returns the client hash when the client record was just created (so
|
||||||
the caller can schedule async enrichment), else None.
|
the caller can schedule async enrichment), else None.
|
||||||
"""
|
"""
|
||||||
lang, country = _parse_accept_language(accept_language)
|
client_lang, country = _parse_accept_language(accept_language)
|
||||||
client_hash = _client_hash(ip, ua, lang)
|
client_hash = _client_hash(ip, ua, client_lang)
|
||||||
new = client_hash not in self.data.clients
|
new = client_hash not in self.data.clients
|
||||||
if new:
|
if new:
|
||||||
self._ensure_client(ip, ua, lang, country=country)
|
self._ensure_client(ip, ua, client_lang, country=country)
|
||||||
if hide:
|
if hide:
|
||||||
self.data.clients[client_hash].hide = True
|
self.data.clients[client_hash].hide = True
|
||||||
fr = (_internal_path(fr) or "") if fr else ""
|
fr = (_internal_path(fr) or "") if fr else ""
|
||||||
@@ -671,7 +695,14 @@ class Store:
|
|||||||
target = _external_target(to) or ""
|
target = _external_target(to) or ""
|
||||||
if target or read > 0:
|
if target or read > 0:
|
||||||
self.data.msgs.append(
|
self.data.msgs.append(
|
||||||
Msg(t=datetime.now(UTC), client=client_hash, fr=fr, to=target, read=read)
|
Msg(
|
||||||
|
t=datetime.now(UTC),
|
||||||
|
client=client_hash,
|
||||||
|
fr=fr,
|
||||||
|
to=target,
|
||||||
|
read=read,
|
||||||
|
lang=lang,
|
||||||
|
)
|
||||||
)
|
)
|
||||||
if target or read > 0 or hide:
|
if target or read > 0 or hide:
|
||||||
self._save()
|
self._save()
|
||||||
@@ -708,7 +739,13 @@ class Store:
|
|||||||
self.data.favicons[origin] = Favicon(file=file, fetched=datetime.now(UTC))
|
self.data.favicons[origin] = Favicon(file=file, fetched=datetime.now(UTC))
|
||||||
self._save()
|
self._save()
|
||||||
|
|
||||||
def display(self, in_menu: Callable[[str], bool] | None = None) -> Display:
|
def display(
|
||||||
|
self,
|
||||||
|
in_menu: Callable[[str], bool] | None = None,
|
||||||
|
*,
|
||||||
|
multilingual: bool = False,
|
||||||
|
primary_lang: str = "",
|
||||||
|
) -> Display:
|
||||||
"""Build the viewer payload from the raw events.
|
"""Build the viewer payload from the raw events.
|
||||||
|
|
||||||
All classification happens here, so the stored data is independent
|
All classification happens here, so the stored data is independent
|
||||||
@@ -730,10 +767,17 @@ class Store:
|
|||||||
- visits: the remaining messages, grouped per client with a new
|
- visits: the remaining messages, grouped per client with a new
|
||||||
visit after ``_SESSION_GAP`` of inactivity. Trail statuses come
|
visit after ``_SESSION_GAP`` of inactivity. Trail statuses come
|
||||||
from the client's GETs (preloads included — a cache-served
|
from the client's GETs (preloads included — a cache-served
|
||||||
navigation's only GET is its preload); the entry referer and UTM
|
navigation's only GET is its preload); trail languages come from
|
||||||
tags from the GET that loaded the entry page.
|
the client's messages (the entry item falling back to its GET's
|
||||||
|
rendered language), and a page re-visited in a different rendered
|
||||||
|
language becomes a distinct trail step. The entry referer and
|
||||||
|
UTM tags come from the GET that loaded the entry page.
|
||||||
|
|
||||||
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
|
||||||
|
languages configured, the front page's primary language) copied
|
||||||
|
onto the payload so the viewer can suppress language UI on
|
||||||
|
single-language sites and skip the primary-language default case.
|
||||||
"""
|
"""
|
||||||
in_menu = in_menu or (lambda path: False)
|
in_menu = in_menu or (lambda path: False)
|
||||||
data = self.data
|
data = self.data
|
||||||
@@ -844,7 +888,11 @@ class Store:
|
|||||||
g.path.split("?", 1)[1] if "?" in g.path else ""
|
g.path.split("?", 1)[1] if "?" in g.path else ""
|
||||||
)
|
)
|
||||||
visit.trail[m.t] = TrailItem(
|
visit.trail[m.t] = TrailItem(
|
||||||
to=m.to, status=status_at(h, m.to, m.t)
|
to=m.to,
|
||||||
|
status=status_at(h, m.to, m.t),
|
||||||
|
# The client's report wins; the entry GET fills
|
||||||
|
# in for old clients that don't send lang.
|
||||||
|
lang=m.lang or (g.lang if g is not None else ""),
|
||||||
)
|
)
|
||||||
visits.append(visit)
|
visits.append(visit)
|
||||||
else:
|
else:
|
||||||
@@ -852,18 +900,40 @@ class Store:
|
|||||||
visit.navs[m.t] = Nav(fr=fr, to=m.to)
|
visit.navs[m.t] = Nav(fr=fr, to=m.to)
|
||||||
status = status_at(h, m.to, m.t)
|
status = status_at(h, m.to, m.t)
|
||||||
# First-seen only: repeat pages and repeated exits
|
# First-seen only: repeat pages and repeated exits
|
||||||
# update the existing trail item instead of appending.
|
# update the existing trail item instead of
|
||||||
|
# appending — but a repeat in a different rendered
|
||||||
|
# language (a mid-article language switch) becomes
|
||||||
|
# a distinct step.
|
||||||
for item in visit.trail.values():
|
for item in visit.trail.values():
|
||||||
if item.to == m.to:
|
if item.to == m.to:
|
||||||
item.status = status
|
if m.lang and item.lang and m.lang != item.lang:
|
||||||
|
visit.trail[m.t] = TrailItem(
|
||||||
|
to=m.to, status=status, lang=m.lang
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
item.status = status
|
||||||
|
if not item.lang:
|
||||||
|
item.lang = m.lang
|
||||||
break
|
break
|
||||||
else:
|
else:
|
||||||
visit.trail[m.t] = TrailItem(to=m.to, status=status)
|
visit.trail[m.t] = TrailItem(
|
||||||
|
to=m.to, status=status, lang=m.lang
|
||||||
|
)
|
||||||
if m.read > 0 and m.fr and visit is not None:
|
if m.read > 0 and m.fr and visit is not None:
|
||||||
|
# A page appears in the trail once per language seen:
|
||||||
|
# land the seconds on the matching-language step when
|
||||||
|
# the client reports one, else on the first-seen item.
|
||||||
|
read_item: TrailItem | None = None
|
||||||
for item in visit.trail.values():
|
for item in visit.trail.values():
|
||||||
if item.to == m.fr:
|
if item.to != m.fr:
|
||||||
item.read += m.read
|
continue
|
||||||
|
if read_item is None:
|
||||||
|
read_item = item
|
||||||
|
if m.lang and item.lang == m.lang:
|
||||||
|
read_item = item
|
||||||
break
|
break
|
||||||
|
if read_item is not None:
|
||||||
|
read_item.read += m.read
|
||||||
last_t = m.t
|
last_t = m.t
|
||||||
|
|
||||||
# --- crawler hits: document GETs no message matched
|
# --- crawler hits: document GETs no message matched
|
||||||
@@ -897,6 +967,7 @@ class Store:
|
|||||||
referer=g.ref,
|
referer=g.ref,
|
||||||
query=query,
|
query=query,
|
||||||
status=g.status,
|
status=g.status,
|
||||||
|
lang=g.lang,
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -920,6 +991,7 @@ class Store:
|
|||||||
referer=visit.referer if first else "",
|
referer=visit.referer if first else "",
|
||||||
query=query if first else "",
|
query=query if first else "",
|
||||||
status=item.status,
|
status=item.status,
|
||||||
|
lang=item.lang,
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
first = False
|
first = False
|
||||||
@@ -940,12 +1012,14 @@ class Store:
|
|||||||
and not self._hidden(g.client)
|
and not self._hidden(g.client)
|
||||||
and ip_of.get(g.client, "") in abuse_ips
|
and ip_of.get(g.client, "") in abuse_ips
|
||||||
],
|
],
|
||||||
clients={h: c for h, c in data.clients.items() if not c.hide},
|
clients={h: _display_client(c) for h, c in data.clients.items() if not c.hide},
|
||||||
favicons={
|
favicons={
|
||||||
origin: f"/_f/{f.file}"
|
origin: f"/_f/{f.file}"
|
||||||
for origin, f in data.favicons.items()
|
for origin, f in data.favicons.items()
|
||||||
if f.file
|
if f.file
|
||||||
},
|
},
|
||||||
|
multilingual=multilingual,
|
||||||
|
primary_lang=primary_lang,
|
||||||
)
|
)
|
||||||
for visit in kept:
|
for visit in kept:
|
||||||
bucket = _bucket(visit.start)
|
bucket = _bucket(visit.start)
|
||||||
@@ -967,6 +1041,14 @@ class Store:
|
|||||||
nbuckets[nb] = nbuckets.get(nb, 0) + 1
|
nbuckets[nb] = nbuckets.get(nb, 0) + 1
|
||||||
return display
|
return display
|
||||||
|
|
||||||
def display_json(self, in_menu: Callable[[str], bool] | None = None) -> str:
|
def display_json(
|
||||||
|
self,
|
||||||
|
in_menu: Callable[[str], bool] | None = None,
|
||||||
|
*,
|
||||||
|
multilingual: bool = False,
|
||||||
|
primary_lang: str = "",
|
||||||
|
) -> str:
|
||||||
"""The ``display()`` payload as a JSON string for the WebSocket."""
|
"""The ``display()`` payload as a JSON string for the WebSocket."""
|
||||||
return msgspec.json.encode(self.display(in_menu)).decode()
|
return msgspec.json.encode(
|
||||||
|
self.display(in_menu, multilingual=multilingual, primary_lang=primary_lang)
|
||||||
|
).decode()
|
||||||
|
|||||||
+4
-5
@@ -36,11 +36,10 @@ from pathlib import Path
|
|||||||
|
|
||||||
from fastapi import FastAPI, Request
|
from fastapi import FastAPI, Request
|
||||||
from fastapi.responses import Response
|
from fastapi.responses import Response
|
||||||
from fastapi_vue import Frontend
|
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, files, pages, tracking
|
||||||
from pagerite.__main__ import DEVMODE
|
|
||||||
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
|
||||||
|
|
||||||
@@ -48,7 +47,7 @@ logger = logging.getLogger(__name__)
|
|||||||
|
|
||||||
# Vue build served at the site root, no SPA catch-all (assets only). The
|
# Vue build served at the site root, no SPA catch-all (assets only). The
|
||||||
# build mirrors the URL space: hashed, immutable files live under
|
# build mirrors the URL space: hashed, immutable files live under
|
||||||
# /_assets/ (assetsDir: '_/assets'), the favicon at /favicon.ico.
|
# /_assets/ (assetsDir: '_/assets').
|
||||||
frontend = Frontend(
|
frontend = Frontend(
|
||||||
Path(__file__).with_name("frontend-build"), spa=False, cached="/_assets/"
|
Path(__file__).with_name("frontend-build"), spa=False, cached="/_assets/"
|
||||||
)
|
)
|
||||||
@@ -99,7 +98,7 @@ async def lifespan(_app: FastAPI) -> AsyncGenerator:
|
|||||||
# is not meant to be browsable by the public anyway.
|
# is not meant to be browsable by the public anyway.
|
||||||
app = FastAPI(
|
app = FastAPI(
|
||||||
title="Pagerite",
|
title="Pagerite",
|
||||||
debug=DEVMODE,
|
debug=env.dev,
|
||||||
lifespan=lifespan,
|
lifespan=lifespan,
|
||||||
docs_url=None,
|
docs_url=None,
|
||||||
redoc_url=None,
|
redoc_url=None,
|
||||||
@@ -124,7 +123,7 @@ app.include_router(tracking.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
|
||||||
# build mirrors the URL space (/_assets/*, /favicon.ico at the root).
|
# build mirrors the URL space (/_assets/*).
|
||||||
frontend.route(app, "/")
|
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,
|
||||||
|
|||||||
+19
-3
@@ -17,6 +17,13 @@ from pagerite.segments import has_prose
|
|||||||
#: backticks or tildes (CommonMark).
|
#: backticks or tildes (CommonMark).
|
||||||
_FENCE_OPEN = re.compile(r"^ {0,3}(`{3,}|~{3,})")
|
_FENCE_OPEN = re.compile(r"^ {0,3}(`{3,}|~{3,})")
|
||||||
|
|
||||||
|
#: A container fence line (mdit-py-plugins container): the "::: aside"
|
||||||
|
#: opener and the ":::" closer alike. Always its own block, even with no
|
||||||
|
#: blank line around it: folded into a prose paragraph it would cross to
|
||||||
|
#: the translator as part of the text run, where the model can drop it —
|
||||||
|
#: the rest of the page then renders inside the container.
|
||||||
|
_CONTAINER = re.compile(r"^ {0,3}:{3,}(?:[ \t]|$)")
|
||||||
|
|
||||||
#: HTML block openers that may span blank lines (CommonMark types 1-5:
|
#: HTML block openers that may span blank lines (CommonMark types 1-5:
|
||||||
#: script/pre/style/textarea, comments, processing instructions,
|
#: script/pre/style/textarea, comments, processing instructions,
|
||||||
#: declarations, CDATA) with their closing condition. Other HTML blocks
|
#: declarations, CDATA) with their closing condition. Other HTML blocks
|
||||||
@@ -54,9 +61,11 @@ def chunk_markdown(markdown: str) -> list[str]:
|
|||||||
Blocks are separated by blank lines; fenced code blocks and the
|
Blocks are separated by blank lines; fenced code blocks and the
|
||||||
multi-line HTML blocks (comments, script/pre/style, CDATA...) are
|
multi-line HTML blocks (comments, script/pre/style, CDATA...) are
|
||||||
kept atomic, even across blank lines, and end at their closing
|
kept atomic, even across blank lines, and end at their closing
|
||||||
condition. Chunks carry no surrounding blank lines and no trailing
|
condition. Container fence lines (:::, open and close alike) are
|
||||||
newline; rejoining with ``join_chunks`` reproduces the source modulo
|
always their own block, blank lines or not (see _CONTAINER). Chunks
|
||||||
blank-line normalization.
|
carry no surrounding blank lines and no trailing newline; rejoining
|
||||||
|
with ``join_chunks`` reproduces the source modulo blank-line
|
||||||
|
normalization.
|
||||||
"""
|
"""
|
||||||
chunks: list[str] = []
|
chunks: list[str] = []
|
||||||
buf: list[str] = []
|
buf: list[str] = []
|
||||||
@@ -91,6 +100,13 @@ def chunk_markdown(markdown: str) -> list[str]:
|
|||||||
fence = m.group(1)
|
fence = m.group(1)
|
||||||
buf.append(line)
|
buf.append(line)
|
||||||
continue
|
continue
|
||||||
|
if _CONTAINER.match(line):
|
||||||
|
# Container fence lines (open and close alike) are their own
|
||||||
|
# block — never part of a prose chunk (see _CONTAINER).
|
||||||
|
flush()
|
||||||
|
buf.append(line)
|
||||||
|
flush()
|
||||||
|
continue
|
||||||
if not buf:
|
if not buf:
|
||||||
for open_re, close_re in _HTML_ATOMIC:
|
for open_re, close_re in _HTML_ATOMIC:
|
||||||
if open_re.match(line):
|
if open_re.match(line):
|
||||||
|
|||||||
+2
-2
@@ -98,8 +98,8 @@ class Data(msgspec.Struct):
|
|||||||
#: Trusted author content; not sanitized.
|
#: Trusted author content; not sanitized.
|
||||||
custom_css: str = ""
|
custom_css: str = ""
|
||||||
#: Favicon: content-addressed file name (served at "/_f/{name}"),
|
#: Favicon: content-addressed file name (served at "/_f/{name}"),
|
||||||
#: linked as <link rel="icon"> on every page. Empty = the build's
|
#: linked as <link rel="icon"> on every page; /favicon.ico redirects
|
||||||
#: /favicon.ico.
|
#: to it. Empty = no icon (and /favicon.ico 404s).
|
||||||
favicon: str = ""
|
favicon: str = ""
|
||||||
#: API keys gating the translator service WebSocket (/_translate/{key};
|
#: API keys gating the translator service WebSocket (/_translate/{key};
|
||||||
#: the external forward-auth does not cover that route): key -> display
|
#: the external forward-auth does not cover that route): key -> display
|
||||||
|
|||||||
+21
-10
@@ -6,7 +6,8 @@ when compression shrinks the body), served immutable at ``/_f/``. Raster
|
|||||||
images and SVGs are recompressed into AVIF/WebP/JPEG derivatives
|
images and SVGs are recompressed into AVIF/WebP/JPEG derivatives
|
||||||
(``store_image`` and helpers); the untouched original is kept alongside as
|
(``store_image`` and helpers); the untouched original is kept alongside as
|
||||||
``<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 ``/_f/`` server with
|
``/_api/files``, the favicon settings endpoints, the /favicon.ico
|
||||||
|
redirect to the configured icon, the ``/_f/`` server with
|
||||||
Accept-negotiated formats, and the user assets (``/_themes/``, ``/_fonts/``).
|
Accept-negotiated formats, and the user assets (``/_themes/``, ``/_fonts/``).
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@@ -19,7 +20,7 @@ from pathlib import Path
|
|||||||
|
|
||||||
import blake3
|
import blake3
|
||||||
from fastapi import APIRouter, HTTPException, Request
|
from fastapi import APIRouter, HTTPException, Request
|
||||||
from fastapi.responses import Response
|
from fastapi.responses import RedirectResponse, Response
|
||||||
from mediapreview import dispatch
|
from mediapreview import dispatch
|
||||||
|
|
||||||
from pagerite import views
|
from pagerite import views
|
||||||
@@ -38,10 +39,6 @@ from pagerite.state import (
|
|||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
# mediapreview logs pyvips noise ("VipsForeignSaveJpegTarget argument strip is
|
|
||||||
# deprecated", "threadpool completed with N workers") at INFO; keep warnings.
|
|
||||||
logging.getLogger("mediapreview").setLevel(logging.WARNING)
|
|
||||||
|
|
||||||
router = APIRouter()
|
router = APIRouter()
|
||||||
|
|
||||||
|
|
||||||
@@ -158,14 +155,13 @@ def _svg_to_png(body: bytes, maxsize: int) -> bytes | None:
|
|||||||
|
|
||||||
def _avif_to_format(avif: bytes, suffix: str, quality: int) -> bytes:
|
def _avif_to_format(avif: bytes, suffix: str, quality: int) -> bytes:
|
||||||
"""Re-encode the AVIF derivative into a fallback format (WebP/JPEG)
|
"""Re-encode the AVIF derivative into a fallback format (WebP/JPEG)
|
||||||
via pyvips. JPEG has no alpha, so it is flattened onto white;
|
via pyvips. JPEG has no alpha, so it is flattened onto white."""
|
||||||
``strip`` keeps metadata (EXIF) out of the fallbacks."""
|
|
||||||
import pyvips
|
import pyvips
|
||||||
|
|
||||||
img = pyvips.Image.new_from_buffer(avif, "")
|
img = pyvips.Image.new_from_buffer(avif, "")
|
||||||
if suffix == ".jpg" and img.hasalpha():
|
if suffix == ".jpg" and img.hasalpha():
|
||||||
img = img.flatten(background=[255, 255, 255])
|
img = img.flatten(background=[255, 255, 255])
|
||||||
return img.write_to_buffer(suffix, Q=quality, strip=True)
|
return img.write_to_buffer(suffix, Q=quality, keep="none")
|
||||||
|
|
||||||
|
|
||||||
def _image_derivatives(
|
def _image_derivatives(
|
||||||
@@ -252,6 +248,20 @@ async def delete_file(name: str) -> None:
|
|||||||
file_store.delete(name)
|
file_store.delete(name)
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/favicon.ico", include_in_schema=False)
|
||||||
|
async def favicon_ico() -> Response:
|
||||||
|
"""The conventional /favicon.ico: redirect to the configured site icon.
|
||||||
|
|
||||||
|
Browsers request this path on their own (tabs, bookmarks, feeds and
|
||||||
|
other non-HTML contexts) regardless of the <link rel="icon"> pages
|
||||||
|
carry. Redirect to the icon's store URL, which negotiates the format
|
||||||
|
and caches immutably; 404 when no custom icon is configured.
|
||||||
|
"""
|
||||||
|
if not data.favicon:
|
||||||
|
raise HTTPException(404)
|
||||||
|
return RedirectResponse(f"/_f/{data.favicon}")
|
||||||
|
|
||||||
|
|
||||||
@router.put("/_api/settings/favicon")
|
@router.put("/_api/settings/favicon")
|
||||||
async def put_favicon(request: Request) -> dict[str, str]:
|
async def put_favicon(request: Request) -> dict[str, str]:
|
||||||
"""Upload a favicon into the content-addressed store and activate it.
|
"""Upload a favicon into the content-addressed store and activate it.
|
||||||
@@ -276,7 +286,8 @@ async def put_favicon(request: Request) -> dict[str, str]:
|
|||||||
|
|
||||||
@router.delete("/_api/settings/favicon", status_code=204)
|
@router.delete("/_api/settings/favicon", status_code=204)
|
||||||
async def delete_favicon(request: Request) -> None:
|
async def delete_favicon(request: Request) -> None:
|
||||||
"""Clear the custom favicon (back to the build's /favicon.ico).
|
"""Clear the custom favicon (/favicon.ico goes back to 404, pages drop
|
||||||
|
the <link rel="icon">).
|
||||||
|
|
||||||
The blob stays in the content-addressed store; only the reference goes.
|
The blob stays in the content-addressed store; only the reference goes.
|
||||||
"""
|
"""
|
||||||
|
|||||||
+4
-3
@@ -152,7 +152,8 @@ async def show_page(request: Request, path: str) -> Response:
|
|||||||
if node is not None and node.published and node.chunks is not None:
|
if node is not None and node.published and node.chunks is not None:
|
||||||
# Language selection (docs/localization.md): ?lang= wins when a
|
# Language selection (docs/localization.md): ?lang= wins when a
|
||||||
# translation exists, else header logic. Analytics keep the raw
|
# translation exists, else header logic. Analytics keep the raw
|
||||||
# Accept-Language header regardless of the selection.
|
# Accept-Language header regardless of the selection, and record
|
||||||
|
# the resolved language as the GET's rendered language.
|
||||||
query_lang = request.query_params.get("lang")
|
query_lang = request.query_params.get("lang")
|
||||||
lang = i18n.select_language(
|
lang = i18n.select_language(
|
||||||
query_lang,
|
query_lang,
|
||||||
@@ -175,7 +176,7 @@ async def show_page(request: Request, path: str) -> Response:
|
|||||||
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)
|
||||||
if _is_trackable_path(path):
|
if _is_trackable_path(path):
|
||||||
_record_get(request)
|
_record_get(request, lang=lang)
|
||||||
return _html_response(
|
return _html_response(
|
||||||
request,
|
request,
|
||||||
"page",
|
"page",
|
||||||
@@ -205,7 +206,7 @@ async def show_page(request: Request, path: str) -> Response:
|
|||||||
)
|
)
|
||||||
link_lang = i18n.base_tag(query_lang or "")
|
link_lang = i18n.base_tag(query_lang or "")
|
||||||
if _is_trackable_path(path):
|
if _is_trackable_path(path):
|
||||||
_record_get(request, status=404)
|
_record_get(request, status=404, lang=lang)
|
||||||
return _html_response(
|
return _html_response(
|
||||||
request,
|
request,
|
||||||
"category",
|
"category",
|
||||||
|
|||||||
+7
-2
@@ -22,11 +22,11 @@ from pathlib import Path
|
|||||||
import blake3
|
import blake3
|
||||||
from fastapi import HTTPException, Request
|
from fastapi import HTTPException, Request
|
||||||
from fastapi.responses import Response
|
from fastapi.responses import Response
|
||||||
|
from fastapi_vue import env
|
||||||
from kanta import Kanta
|
from kanta import Kanta
|
||||||
from zstandard import ZstdCompressor
|
from zstandard import ZstdCompressor
|
||||||
|
|
||||||
from pagerite import analytics, i18n, seed, translate, views
|
from pagerite import analytics, i18n, seed, translate, views
|
||||||
from pagerite.__main__ import DEVMODE
|
|
||||||
from pagerite.chunks import store_chunks
|
from pagerite.chunks import store_chunks
|
||||||
from pagerite.config import load
|
from pagerite.config import load
|
||||||
from pagerite.data import (
|
from pagerite.data import (
|
||||||
@@ -56,6 +56,10 @@ DB_PATH = os.getenv("PAGERITE_DB", str(SITE_DIR / "content.kantadb"))
|
|||||||
|
|
||||||
# Visit analytics go to their own JSON file, not the kanta database.
|
# Visit analytics go to their own JSON file, not the kanta database.
|
||||||
ANALYTICS_PATH = Path(os.getenv("PAGERITE_ANALYTICS", str(SITE_DIR / "analytics.json")))
|
ANALYTICS_PATH = Path(os.getenv("PAGERITE_ANALYTICS", str(SITE_DIR / "analytics.json")))
|
||||||
|
# The per-hostname data directory may not exist yet on first run; kanta
|
||||||
|
# creates the database file but not its parent directory.
|
||||||
|
Path(DB_PATH).parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
ANALYTICS_PATH.parent.mkdir(parents=True, exist_ok=True)
|
||||||
analytics_store = analytics.Store(ANALYTICS_PATH)
|
analytics_store = analytics.Store(ANALYTICS_PATH)
|
||||||
|
|
||||||
# Content-addressed file store (uploads, seed assets, fetched favicons):
|
# Content-addressed file store (uploads, seed assets, fetched favicons):
|
||||||
@@ -132,6 +136,7 @@ def _render_html(
|
|||||||
data.theme,
|
data.theme,
|
||||||
data.favicon,
|
data.favicon,
|
||||||
data.brand_html,
|
data.brand_html,
|
||||||
|
base_url,
|
||||||
transition=data.transition,
|
transition=data.transition,
|
||||||
lang=lang,
|
lang=lang,
|
||||||
translation=translation,
|
translation=translation,
|
||||||
@@ -225,7 +230,7 @@ def _html_response(
|
|||||||
# Absolute social/canonical URLs use the site's public origin; on
|
# Absolute social/canonical URLs use the site's public origin; on
|
||||||
# localhost (varying ports) fall back to the request's own base URL.
|
# localhost (varying ports) fall back to the request's own base URL.
|
||||||
base_url = SITE_URL or str(request.base_url).rstrip("/")
|
base_url = SITE_URL or str(request.base_url).rstrip("/")
|
||||||
if DEVMODE:
|
if env.dev:
|
||||||
identity = _render_html(kind, path, base_url, lang, link_lang).encode()
|
identity = _render_html(kind, path, base_url, lang, link_lang).encode()
|
||||||
body = _zstd.compress(identity) if zstd else identity
|
body = _zstd.compress(identity) if zstd else identity
|
||||||
else:
|
else:
|
||||||
|
|||||||
+54
-33
@@ -3,18 +3,19 @@
|
|||||||
The visitor-activity WebSocket (``/_ws``, public) and the admin analytics
|
The visitor-activity WebSocket (``/_ws``, public) and the admin analytics
|
||||||
stream (``/_api/ws/analytics``) plus the ``/_a`` viewer page. Client IPs are
|
stream (``/_api/ws/analytics``) plus the ``/_a`` viewer page. Client IPs are
|
||||||
enriched in background tasks with reverse DNS (cached PTR lookups) and the
|
enriched in background tasks with reverse DNS (cached PTR lookups) and the
|
||||||
DB-IP city MMDB (``GeoIP``, decompressed and opened once at startup);
|
DB-IP city MMDB (``GeoIP``, decompressed into RAM and opened once at
|
||||||
|
startup);
|
||||||
external referrers get their favicon fetched and stored content-hashed.
|
external referrers get their favicon fetched and stored content-hashed.
|
||||||
Snapshot broadcasts to connected admin sockets are debounced.
|
Snapshot broadcasts to connected admin sockets are debounced.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
import gzip
|
import gzip
|
||||||
|
import io
|
||||||
import ipaddress
|
import ipaddress
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
import re
|
import re
|
||||||
import shutil
|
|
||||||
import socket
|
import socket
|
||||||
from datetime import date
|
from datetime import date
|
||||||
from functools import lru_cache
|
from functools import lru_cache
|
||||||
@@ -25,8 +26,9 @@ 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 pagerite import analytics
|
from pagerite import analytics, i18n
|
||||||
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
|
||||||
@@ -44,8 +46,9 @@ _analytics_ws_clients: set[WebSocket] = set()
|
|||||||
_analytics_broadcast_task: asyncio.Task | None = None
|
_analytics_broadcast_task: asyncio.Task | None = None
|
||||||
|
|
||||||
|
|
||||||
# Repository root from this file's location (pagerite/tracking.py -> ..).
|
# DB-IP databases persist in the working directory (one download serves all
|
||||||
_REPO_ROOT = Path(__file__).resolve().parent.parent
|
# sites run from it). Not the package directory: reinstalls/upgrades wipe it.
|
||||||
|
_DBIP_DIR = Path.cwd()
|
||||||
|
|
||||||
DBIP_URL = "https://download.db-ip.com/free/dbip-city-lite-{month}.mmdb.gz"
|
DBIP_URL = "https://download.db-ip.com/free/dbip-city-lite-{month}.mmdb.gz"
|
||||||
|
|
||||||
@@ -60,7 +63,7 @@ def _download_dbip() -> None:
|
|||||||
|
|
||||||
existing = sorted(
|
existing = sorted(
|
||||||
p.stem.removeprefix("dbip-city-lite-").removesuffix(".mmdb")
|
p.stem.removeprefix("dbip-city-lite-").removesuffix(".mmdb")
|
||||||
for p in _REPO_ROOT.glob("dbip-city-lite-*.mmdb*")
|
for p in _DBIP_DIR.glob("dbip-city-lite-*.mmdb*")
|
||||||
)
|
)
|
||||||
if existing and existing[-1] >= months[0]:
|
if existing and existing[-1] >= months[0]:
|
||||||
logger.info("DB-IP database is current (%s), skipping download", existing[-1])
|
logger.info("DB-IP database is current (%s), skipping download", existing[-1])
|
||||||
@@ -68,7 +71,7 @@ def _download_dbip() -> None:
|
|||||||
|
|
||||||
for month in months:
|
for month in months:
|
||||||
url = DBIP_URL.format(month=month)
|
url = DBIP_URL.format(month=month)
|
||||||
target = _REPO_ROOT / f"dbip-city-lite-{month}.mmdb.gz"
|
target = _DBIP_DIR / f"dbip-city-lite-{month}.mmdb.gz"
|
||||||
tmp = target.with_suffix(".mmdb.gz.tmp")
|
tmp = target.with_suffix(".mmdb.gz.tmp")
|
||||||
logger.info("Downloading %s", url)
|
logger.info("Downloading %s", url)
|
||||||
try:
|
try:
|
||||||
@@ -93,7 +96,7 @@ def _download_dbip() -> None:
|
|||||||
continue
|
continue
|
||||||
os.replace(tmp, target)
|
os.replace(tmp, target)
|
||||||
# Drop older databases so the app never picks up a stale one.
|
# Drop older databases so the app never picks up a stale one.
|
||||||
for old in _REPO_ROOT.glob("dbip-city-lite-*.mmdb*"):
|
for old in _DBIP_DIR.glob("dbip-city-lite-*.mmdb*"):
|
||||||
if old.name != target.name:
|
if old.name != target.name:
|
||||||
old.unlink()
|
old.unlink()
|
||||||
logger.info("DB-IP database updated to %s", target.name)
|
logger.info("DB-IP database updated to %s", target.name)
|
||||||
@@ -102,15 +105,19 @@ def _download_dbip() -> None:
|
|||||||
|
|
||||||
|
|
||||||
def _geoip_db_path() -> Path | None:
|
def _geoip_db_path() -> Path | None:
|
||||||
"""Find a DB-IP MMDB in the repo root, preferring an already-decompressed
|
"""Find a DB-IP MMDB in the working directory: the ``.mmdb.gz`` download
|
||||||
``.mmdb`` over the matching ``.mmdb.gz``. Returns None if none is present.
|
is canonical (decompressed into RAM at open); a plain ``.mmdb`` left over
|
||||||
|
from older versions is still usable, and removed once the matching ``.gz``
|
||||||
|
is present so it does not linger on disk. Returns None if none is present.
|
||||||
"""
|
"""
|
||||||
mmdb = sorted(_REPO_ROOT.glob("dbip-*.mmdb"))
|
gz = sorted(_DBIP_DIR.glob("dbip-*.mmdb.gz"))
|
||||||
|
if gz:
|
||||||
|
for stale in _DBIP_DIR.glob("dbip-*.mmdb"):
|
||||||
|
stale.unlink()
|
||||||
|
return gz[0]
|
||||||
|
mmdb = sorted(_DBIP_DIR.glob("dbip-*.mmdb"))
|
||||||
if mmdb:
|
if mmdb:
|
||||||
return mmdb[0]
|
return mmdb[0]
|
||||||
gz = sorted(_REPO_ROOT.glob("dbip-*.mmdb.gz"))
|
|
||||||
if gz:
|
|
||||||
return gz[0]
|
|
||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
||||||
@@ -123,28 +130,23 @@ class GeoIP:
|
|||||||
def __init__(self) -> None:
|
def __init__(self) -> None:
|
||||||
self._reader: object | None = None
|
self._reader: object | None = None
|
||||||
|
|
||||||
def _decompress(self, source: Path, target: Path) -> None:
|
|
||||||
if target.exists():
|
|
||||||
return
|
|
||||||
tmp = target.with_suffix(target.suffix + ".tmp")
|
|
||||||
with gzip.open(source, "rb") as src, open(tmp, "wb") as dst:
|
|
||||||
shutil.copyfileobj(src, dst)
|
|
||||||
os.replace(tmp, target)
|
|
||||||
|
|
||||||
def _load(self) -> None:
|
def _load(self) -> None:
|
||||||
if self._reader is not None:
|
if self._reader is not None:
|
||||||
return
|
return
|
||||||
source = _geoip_db_path()
|
source = _geoip_db_path()
|
||||||
if source is None:
|
if source is None:
|
||||||
return
|
return
|
||||||
if source.suffix == ".gz":
|
|
||||||
target = source.with_suffix("")
|
|
||||||
self._decompress(source, target)
|
|
||||||
source = target
|
|
||||||
try:
|
try:
|
||||||
import maxminddb
|
import maxminddb
|
||||||
|
|
||||||
self._reader = maxminddb.open_database(str(source))
|
if source.suffix == ".gz":
|
||||||
|
# Only the .gz is kept on disk; the database is decompressed
|
||||||
|
# into RAM (MODE_FD makes the pure-Python Reader .read() the
|
||||||
|
# buffer — never mmap — and bypasses the C extension).
|
||||||
|
buf = io.BytesIO(gzip.decompress(source.read_bytes()))
|
||||||
|
self._reader = maxminddb.open_database(buf, maxminddb.MODE_FD)
|
||||||
|
else:
|
||||||
|
self._reader = maxminddb.open_database(str(source))
|
||||||
except Exception:
|
except Exception:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
@@ -332,7 +334,7 @@ async def _broadcast_analytics() -> None:
|
|||||||
"""Send the current analytics snapshot to every connected WS client."""
|
"""Send the current analytics snapshot to every connected WS client."""
|
||||||
if not _analytics_ws_clients:
|
if not _analytics_ws_clients:
|
||||||
return
|
return
|
||||||
payload = analytics_store.display_json(_in_menu)
|
payload = _display_json()
|
||||||
closed = set()
|
closed = set()
|
||||||
for ws in _analytics_ws_clients:
|
for ws in _analytics_ws_clients:
|
||||||
try:
|
try:
|
||||||
@@ -368,12 +370,29 @@ def _in_menu(path: str) -> bool:
|
|||||||
return resolve(data.menu, path.strip("/")) is not None
|
return resolve(data.menu, path.strip("/")) is not None
|
||||||
|
|
||||||
|
|
||||||
def _record_get(request: Request, *, status: int = 200) -> None:
|
def _display_json() -> str:
|
||||||
|
"""The current analytics snapshot as JSON for the admin stream.
|
||||||
|
|
||||||
|
Adds the site's language context: ``multilingual`` (translation
|
||||||
|
languages configured) lets the viewer suppress language UI on
|
||||||
|
single-language sites, ``primary_lang`` (the front page's) lets it skip
|
||||||
|
the primary-language default case.
|
||||||
|
"""
|
||||||
|
return analytics_store.display_json(
|
||||||
|
_in_menu,
|
||||||
|
multilingual=bool(data.translate_langs),
|
||||||
|
primary_lang=i18n.primary_lang(data.menu, ""),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _record_get(request: Request, *, status: int = 200, lang: str = "") -> None:
|
||||||
"""Record the document GET as one raw access-log line in analytics.
|
"""Record the document GET as one raw access-log line in analytics.
|
||||||
|
|
||||||
Nothing is classified here — the true HTTP status, the full request path
|
Nothing is classified here — the true HTTP status, the full request path
|
||||||
(query included), an external referer origin and the preload flag are
|
(query included), an external referer origin, the preload flag and the
|
||||||
stored, and visitor/crawler/abuse classification happens at display time
|
rendered content language (``lang``, "" for non-localized responses such
|
||||||
|
as 404 probes and reserved paths) are stored, and
|
||||||
|
visitor/crawler/abuse classification happens at display time
|
||||||
(see analytics.Store.display). Idle-time preloads from pagerite.js
|
(see analytics.Store.display). Idle-time preloads from pagerite.js
|
||||||
(``x-pagerite-preload`` header) are recorded with ``pre=True``: never
|
(``x-pagerite-preload`` header) are recorded with ``pre=True``: never
|
||||||
counted, but a navigation later served from the in-memory page cache is
|
counted, but a navigation later served from the in-memory page cache is
|
||||||
@@ -401,6 +420,7 @@ def _record_get(request: Request, *, status: int = 200) -> None:
|
|||||||
referer=referer,
|
referer=referer,
|
||||||
accept_language=request.headers.get("accept-language", ""),
|
accept_language=request.headers.get("accept-language", ""),
|
||||||
pre=bool(request.headers.get("x-pagerite-preload")),
|
pre=bool(request.headers.get("x-pagerite-preload")),
|
||||||
|
lang=lang,
|
||||||
)
|
)
|
||||||
if client_hash is not None:
|
if client_hash is not None:
|
||||||
_schedule_client_enrichment([client_hash])
|
_schedule_client_enrichment([client_hash])
|
||||||
@@ -442,7 +462,7 @@ async def activity_ws(ws: WebSocket) -> None:
|
|||||||
# already printed there): compact UA plus the browser's language tag.
|
# already printed there): compact UA plus the browser's language tag.
|
||||||
lang, _country = analytics._parse_accept_language(accept_language)
|
lang, _country = analytics._parse_accept_language(accept_language)
|
||||||
ws.scope.setdefault("state", {})["log_extra"] = " ".join(
|
ws.scope.setdefault("state", {})["log_extra"] = " ".join(
|
||||||
part for part in (analytics._compact_user_agent(ua), lang) if part
|
part for part in (uaparse(ua).pretty, lang) if part
|
||||||
)
|
)
|
||||||
await ws.accept()
|
await ws.accept()
|
||||||
try:
|
try:
|
||||||
@@ -460,6 +480,7 @@ async def activity_ws(ws: WebSocket) -> None:
|
|||||||
accept_language,
|
accept_language,
|
||||||
hide=msg.hide,
|
hide=msg.hide,
|
||||||
read=msg.read,
|
read=msg.read,
|
||||||
|
lang=msg.lang,
|
||||||
)
|
)
|
||||||
if new_client is not None:
|
if new_client is not None:
|
||||||
_schedule_client_enrichment([new_client])
|
_schedule_client_enrichment([new_client])
|
||||||
@@ -476,7 +497,7 @@ async def analytics_websocket(ws: WebSocket) -> None:
|
|||||||
endpoint. Powers the analytics viewer rendered at /_a.
|
endpoint. Powers the analytics viewer rendered at /_a.
|
||||||
"""
|
"""
|
||||||
await ws.accept()
|
await ws.accept()
|
||||||
await ws.send_text(analytics_store.display_json(_in_menu))
|
await ws.send_text(_display_json())
|
||||||
_analytics_ws_clients.add(ws)
|
_analytics_ws_clients.add(ws)
|
||||||
try:
|
try:
|
||||||
while True:
|
while True:
|
||||||
|
|||||||
@@ -101,7 +101,8 @@ ClientMsg = Hello | Result
|
|||||||
def pending_items(data: Data, lang: str) -> list[TransItem]:
|
def pending_items(data: Data, lang: str) -> list[TransItem]:
|
||||||
"""Fragments of the site still untranslated for ``lang``, deduped by key.
|
"""Fragments of the site still untranslated for ``lang``, deduped by key.
|
||||||
|
|
||||||
Every page node (published or not) contributes its title and each chunk
|
Every node (published or not, pages and pure category labels alike)
|
||||||
|
contributes its title; pages also contribute each chunk
|
||||||
that needs translation (``needs_translation``), is not editor-flagged
|
that needs translation (``needs_translation``), is not editor-flagged
|
||||||
no-translate (``node.no_trans``) and has no ``trans`` entry for ``lang``
|
no-translate (``node.no_trans``) and has no ``trans`` entry for ``lang``
|
||||||
yet. Content-addressed text (shared paragraphs, repeated titles) appears
|
yet. Content-addressed text (shared paragraphs, repeated titles) appears
|
||||||
@@ -133,8 +134,10 @@ def pending_items(data: Data, lang: str) -> list[TransItem]:
|
|||||||
path = f"{prefix}/{slug}" if prefix else slug
|
path = f"{prefix}/{slug}" if prefix else slug
|
||||||
# An article whose primary language IS the target needs no
|
# An article whose primary language IS the target needs no
|
||||||
# translation into it — skip its title and chunks entirely.
|
# translation into it — skip its title and chunks entirely.
|
||||||
|
# Category labels (chunks is None) contribute only their title:
|
||||||
|
# it is their nav-menu label.
|
||||||
node_lang = node.language or inherited
|
node_lang = node.language or inherited
|
||||||
if node.chunks is not None and node_lang != lang:
|
if node_lang != lang:
|
||||||
if node.title:
|
if node.title:
|
||||||
emit(
|
emit(
|
||||||
chunk_key(node.title),
|
chunk_key(node.title),
|
||||||
@@ -143,7 +146,7 @@ def pending_items(data: Data, lang: str) -> list[TransItem]:
|
|||||||
"title",
|
"title",
|
||||||
context=opening(node),
|
context=opening(node),
|
||||||
)
|
)
|
||||||
for h in node.chunks:
|
for h in node.chunks or ():
|
||||||
text = data.chunks.get(h)
|
text = data.chunks.get(h)
|
||||||
if (
|
if (
|
||||||
text is not None
|
text is not None
|
||||||
@@ -178,8 +181,8 @@ def store_results(data: Data, lang: str, items: list[TransResult]) -> list[str]:
|
|||||||
for slug, node in sorted_nodes(nodes):
|
for slug, node in sorted_nodes(nodes):
|
||||||
path = f"{prefix}/{slug}" if prefix else slug
|
path = f"{prefix}/{slug}" if prefix else slug
|
||||||
node_lang = node.language or inherited
|
node_lang = node.language or inherited
|
||||||
if node.chunks is not None and node_lang != lang:
|
if node_lang != lang:
|
||||||
keys = set(node.chunks)
|
keys = set(node.chunks or ())
|
||||||
if node.title:
|
if node.title:
|
||||||
keys.add(chunk_key(node.title))
|
keys.add(chunk_key(node.title))
|
||||||
if keys & stored:
|
if keys & stored:
|
||||||
|
|||||||
+100
-34
@@ -21,6 +21,7 @@ import json
|
|||||||
import os
|
import os
|
||||||
import re
|
import re
|
||||||
|
|
||||||
|
from fastapi_vue import env
|
||||||
from html5tagger import HTML, Document, E, Template
|
from html5tagger import HTML, Document, E, Template
|
||||||
from platformdirs import site_data_dir, user_data_path
|
from platformdirs import site_data_dir, user_data_path
|
||||||
|
|
||||||
@@ -263,20 +264,31 @@ def _transition_css_url(transition: str) -> str | None:
|
|||||||
|
|
||||||
|
|
||||||
def _editor_css_url(vite_url: str | None) -> str | None:
|
def _editor_css_url(vite_url: str | None) -> str | None:
|
||||||
"""URL for the editor-specific stylesheet (Vue component styles).
|
"""URLs (comma-joined) for the editor-specific stylesheets (Vue
|
||||||
|
component styles).
|
||||||
|
|
||||||
This is linked by the public-page edit pen so the editor styles are
|
This is linked by the public-page edit pen so the editor styles are
|
||||||
loaded before the editor JS dynamic-import resolves.
|
loaded before the editor JS dynamic-import resolves. Component styles
|
||||||
|
can land on shared chunks rather than the entry's own stylesheet —
|
||||||
|
LangSelect's ride on the shared store chunk, as it is also used by the
|
||||||
|
on-demand public language selector — so collect the stylesheets of the
|
||||||
|
entry and its imported chunks (the same traversal _langselect_assets
|
||||||
|
does).
|
||||||
"""
|
"""
|
||||||
if vite_url:
|
if vite_url:
|
||||||
return None
|
return None
|
||||||
manifest = _manifest()
|
manifest = _manifest()
|
||||||
entry = manifest["src/main.js"]
|
|
||||||
base = manifest.get(_BASE_CSS_KEY, {}).get("file")
|
base = manifest.get(_BASE_CSS_KEY, {}).get("file")
|
||||||
for css in entry.get("css", []):
|
stylesheets, seen = [], set()
|
||||||
if css != base:
|
queue = ["src/main.js"]
|
||||||
return f"/{css}"
|
for key in queue: # grows with imported chunks
|
||||||
return None
|
if key in seen:
|
||||||
|
continue
|
||||||
|
seen.add(key)
|
||||||
|
entry = manifest[key]
|
||||||
|
stylesheets += [f"/{css}" for css in entry.get("css", []) if css != base]
|
||||||
|
queue += entry.get("imports", [])
|
||||||
|
return ",".join(stylesheets) or None
|
||||||
|
|
||||||
|
|
||||||
def _inline_asset(url: str) -> str:
|
def _inline_asset(url: str) -> str:
|
||||||
@@ -326,7 +338,7 @@ def _layout(
|
|||||||
) -> Template:
|
) -> Template:
|
||||||
"""Page layout template with standard assets and ES-module scripts.
|
"""Page layout template with standard assets and ES-module scripts.
|
||||||
|
|
||||||
In dev (PAGERITE_VITE_URL set) assets are linked from the Vite dev
|
In dev (Vite dev-server URL set) assets are linked from the Vite dev
|
||||||
server and stylesheets use ``blocking="render"`` so the browser waits
|
server and stylesheets use ``blocking="render"`` so the browser waits
|
||||||
for them before showing the page, avoiding a flash of unstyled content.
|
for them before showing the page, avoiding a flash of unstyled content.
|
||||||
In production all page assets are inlined into the document: stylesheets
|
In production all page assets are inlined into the document: stylesheets
|
||||||
@@ -372,8 +384,8 @@ def _layout(
|
|||||||
doc.meta(property=key, content=value)
|
doc.meta(property=key, content=value)
|
||||||
else:
|
else:
|
||||||
doc.meta(name=key, content=value)
|
doc.meta(name=key, content=value)
|
||||||
# A custom favicon (from the site editor) is linked explicitly; without
|
# A custom favicon (from the site editor) is linked explicitly;
|
||||||
# one, browsers fall back to the build's /favicon.ico by convention.
|
# /favicon.ico redirects to the same store file for non-HTML contexts.
|
||||||
if favicon:
|
if favicon:
|
||||||
doc.link(rel="icon", href=f"/_f/{favicon}", id="pagerite-favicon")
|
doc.link(rel="icon", href=f"/_f/{favicon}", id="pagerite-favicon")
|
||||||
# Asset URLs for the on-demand bundles (editor, analytics) for
|
# Asset URLs for the on-demand bundles (editor, analytics) for
|
||||||
@@ -383,12 +395,16 @@ def _layout(
|
|||||||
# dev-server URLs as meta tags (Vite serves the modules and injects
|
# dev-server URLs as meta tags (Vite serves the modules and injects
|
||||||
# their CSS for hot reloads); production inlines all page assets and
|
# their CSS for hot reloads); production inlines all page assets and
|
||||||
# carries the on-demand URLs in one JSON script instead.
|
# carries the on-demand URLs in one JSON script instead.
|
||||||
vite_url = os.environ.get("PAGERITE_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()
|
||||||
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],
|
||||||
}
|
}
|
||||||
|
if langselect_css:
|
||||||
|
config["pagerite:langselect-css"] = ",".join(langselect_css)
|
||||||
if editor_css:
|
if editor_css:
|
||||||
config["pagerite:editor-css"] = editor_css
|
config["pagerite:editor-css"] = editor_css
|
||||||
if vite_url:
|
if vite_url:
|
||||||
@@ -1017,6 +1033,42 @@ def _social_meta(
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _language_urls(
|
||||||
|
data: Data,
|
||||||
|
path: str,
|
||||||
|
node: Node,
|
||||||
|
lang: str,
|
||||||
|
original: str,
|
||||||
|
base_url: str,
|
||||||
|
) -> tuple[str, list[tuple[str, str]]]:
|
||||||
|
"""(canonical, hreflang alternates) for a page (docs/localization.md).
|
||||||
|
|
||||||
|
The canonical names the actually served language — the plain URL for
|
||||||
|
the original (for SEO the non-query URL means the article's language),
|
||||||
|
?lang= for a translation — regardless of how the language was arrived
|
||||||
|
at (query or header). The alternates list the languages the page is
|
||||||
|
actually available in (``node.langs``; a category label's title counts
|
||||||
|
as its content): x-default first (the plain, autodetecting URL), then
|
||||||
|
every available language — the original again by its plain URL,
|
||||||
|
translations by ?lang=. The public language selector keys off these.
|
||||||
|
("", []) without a base_url.
|
||||||
|
"""
|
||||||
|
if not base_url:
|
||||||
|
return "", []
|
||||||
|
url = f"{base_url}/{path}"
|
||||||
|
canonical = url if lang == original else f"{url}?lang={lang}"
|
||||||
|
alternates = []
|
||||||
|
if data.translate_langs:
|
||||||
|
# Only languages the page actually has AND that are still enabled
|
||||||
|
# site-wide (a disabled target stops being advertised).
|
||||||
|
enabled = {original, *data.translate_langs}
|
||||||
|
alternates = [("x-default", url)] + [
|
||||||
|
(tag, url if tag == original else f"{url}?lang={tag}")
|
||||||
|
for tag in sorted({original, *node.langs} & enabled)
|
||||||
|
]
|
||||||
|
return canonical, alternates
|
||||||
|
|
||||||
|
|
||||||
def render_page(
|
def render_page(
|
||||||
menu: dict[str, Node],
|
menu: dict[str, Node],
|
||||||
data: Data,
|
data: Data,
|
||||||
@@ -1046,24 +1098,7 @@ def render_page(
|
|||||||
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)
|
||||||
social = _social_meta(node, path, title, str(main), brand, base_url)
|
social = _social_meta(node, path, title, str(main), brand, base_url)
|
||||||
# Canonical/hreflang URLs (docs/localization.md): the canonical names
|
canonical, alternates = _language_urls(data, path, node, lang, original, base_url)
|
||||||
# the actually served language — the plain URL for the original (for
|
|
||||||
# SEO the non-query URL means the article's language), ?lang= for a
|
|
||||||
# translation — regardless of how the language was arrived at (query
|
|
||||||
# or header). The alternates are site-wide, the same set on every
|
|
||||||
# page: the configured translate_langs (the translator works to fill
|
|
||||||
# them all in), x-default first (the plain, autodetecting URL), then
|
|
||||||
# every language explicitly, the page's own primary included.
|
|
||||||
canonical = ""
|
|
||||||
alternates = []
|
|
||||||
if base_url:
|
|
||||||
url = f"{base_url}/{path}"
|
|
||||||
canonical = url if lang == original else f"{url}?lang={lang}"
|
|
||||||
if data.translate_langs:
|
|
||||||
alternates = [("x-default", url)] + [
|
|
||||||
(tag, f"{url}?lang={tag}")
|
|
||||||
for tag in sorted({original, *data.translate_langs})
|
|
||||||
]
|
|
||||||
return str(
|
return str(
|
||||||
_layout(
|
_layout(
|
||||||
*_page_assets(),
|
*_page_assets(),
|
||||||
@@ -1096,6 +1131,7 @@ def render_category(
|
|||||||
theme: str = "",
|
theme: str = "",
|
||||||
favicon: str = "",
|
favicon: str = "",
|
||||||
brand_html: str = "",
|
brand_html: str = "",
|
||||||
|
base_url: str = "",
|
||||||
transition: str = "cube",
|
transition: str = "cube",
|
||||||
lang: str = i18n.ORIGINAL_LANGUAGE,
|
lang: str = i18n.ORIGINAL_LANGUAGE,
|
||||||
translation: Translation | None = None,
|
translation: Translation | None = None,
|
||||||
@@ -1111,12 +1147,16 @@ def render_category(
|
|||||||
With a translation (titles only — the category has no Markdown) the
|
With a translation (titles only — the category has no Markdown) the
|
||||||
heading, navigation and card text localize per target article
|
heading, navigation and card text localize per target article
|
||||||
(docs/localization.md); ``link_lang`` replicates the ?lang= override
|
(docs/localization.md); ``link_lang`` replicates the ?lang= override
|
||||||
onto the navigation links as on content pages.
|
onto the navigation links as on content pages. The hreflang alternates
|
||||||
|
are computed as on content pages — a translated title makes the
|
||||||
|
language available here too.
|
||||||
"""
|
"""
|
||||||
node = resolve(menu, path)[-1]
|
node = resolve(menu, path)[-1]
|
||||||
|
original = i18n.primary_lang(menu, path)
|
||||||
if translation is None:
|
if translation is None:
|
||||||
lang = i18n.primary_lang(menu, path)
|
lang = original
|
||||||
title = _title(path.rpartition("/")[2], node, translation, path)
|
title = _title(path.rpartition("/")[2], node, translation, path)
|
||||||
|
_, alternates = _language_urls(data, path, node, lang, original, base_url)
|
||||||
doc = E.article
|
doc = E.article
|
||||||
with doc:
|
with doc:
|
||||||
doc.h1(title)
|
doc.h1(title)
|
||||||
@@ -1133,6 +1173,7 @@ def render_category(
|
|||||||
transition,
|
transition,
|
||||||
favicon,
|
favicon,
|
||||||
lang=lang,
|
lang=lang,
|
||||||
|
alternates=alternates,
|
||||||
)(
|
)(
|
||||||
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),
|
||||||
@@ -1186,7 +1227,7 @@ def _page_assets() -> tuple[list[str], list[str]]:
|
|||||||
by the entry (e.g. overlayscrollbars.css) is extracted by Vite and must
|
by the entry (e.g. overlayscrollbars.css) is extracted by Vite and must
|
||||||
be linked separately.
|
be linked separately.
|
||||||
"""
|
"""
|
||||||
vite_url = os.environ.get("PAGERITE_VITE_URL")
|
vite_url = env.vite_url
|
||||||
if vite_url:
|
if vite_url:
|
||||||
return [f"{vite_url}/src/pagerite.js"], []
|
return [f"{vite_url}/src/pagerite.js"], []
|
||||||
if "page" not in _asset_cache:
|
if "page" not in _asset_cache:
|
||||||
@@ -1204,7 +1245,7 @@ def _editor_assets() -> tuple[list[str], str | None]:
|
|||||||
The shared CSS is already linked on the page, so the pen only needs the
|
The shared CSS is already linked on the page, so the pen only needs the
|
||||||
editor-specific stylesheet.
|
editor-specific stylesheet.
|
||||||
"""
|
"""
|
||||||
vite_url = os.environ.get("PAGERITE_VITE_URL")
|
vite_url = env.vite_url
|
||||||
if vite_url:
|
if vite_url:
|
||||||
return [f"{vite_url}/@vite/client", f"{vite_url}/src/main.js"], None
|
return [f"{vite_url}/@vite/client", f"{vite_url}/src/main.js"], None
|
||||||
if "editor" not in _asset_cache:
|
if "editor" not in _asset_cache:
|
||||||
@@ -1216,7 +1257,7 @@ def _editor_assets() -> tuple[list[str], str | None]:
|
|||||||
|
|
||||||
def _analytics_assets() -> tuple[list[str], list[str]]:
|
def _analytics_assets() -> tuple[list[str], list[str]]:
|
||||||
"""Script and stylesheet URLs for the analytics page entry."""
|
"""Script and stylesheet URLs for the analytics page entry."""
|
||||||
vite_url = os.environ.get("PAGERITE_VITE_URL")
|
vite_url = env.vite_url
|
||||||
if vite_url:
|
if vite_url:
|
||||||
return [f"{vite_url}/src/analytics-main.js"], []
|
return [f"{vite_url}/src/analytics-main.js"], []
|
||||||
if "analytics" not in _asset_cache:
|
if "analytics" not in _asset_cache:
|
||||||
@@ -1228,6 +1269,31 @@ def _analytics_assets() -> tuple[list[str], list[str]]:
|
|||||||
return _asset_cache["analytics"]
|
return _asset_cache["analytics"]
|
||||||
|
|
||||||
|
|
||||||
|
def _langselect_assets() -> tuple[list[str], list[str]]:
|
||||||
|
"""Script and stylesheet URLs for the on-demand public language selector."""
|
||||||
|
vite_url = env.vite_url
|
||||||
|
if vite_url:
|
||||||
|
return [f"{vite_url}/src/langselect-main.js"], []
|
||||||
|
if "langselect" not in _asset_cache:
|
||||||
|
manifest = _manifest()
|
||||||
|
# import() loads no CSS automatically: collect the stylesheets of
|
||||||
|
# the entry and its imported chunks (LangSelect's ride on the
|
||||||
|
# shared langs chunk).
|
||||||
|
scripts, stylesheets, seen = [], [], set()
|
||||||
|
queue = ["src/langselect-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["langselect"] = scripts, stylesheets
|
||||||
|
return _asset_cache["langselect"]
|
||||||
|
|
||||||
|
|
||||||
def render_analytics(
|
def render_analytics(
|
||||||
menu: dict[str, Node],
|
menu: dict[str, Node],
|
||||||
brand: str = SITE_NAME,
|
brand: str = SITE_NAME,
|
||||||
|
|||||||
+2
-2
@@ -17,7 +17,7 @@ readme = "README.md"
|
|||||||
requires-python = ">=3.14"
|
requires-python = ">=3.14"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"blake3>=1.0.9",
|
"blake3>=1.0.9",
|
||||||
"fastapi-vue~=1.4.2",
|
"fastapi-vue~=1.6.1",
|
||||||
"fastapi[standard]>=0.141.1",
|
"fastapi[standard]>=0.141.1",
|
||||||
"html5tagger>=2.0.0",
|
"html5tagger>=2.0.0",
|
||||||
"httpx>=0.28.1",
|
"httpx>=0.28.1",
|
||||||
@@ -29,7 +29,7 @@ dependencies = [
|
|||||||
"platformdirs>=4.11.5",
|
"platformdirs>=4.11.5",
|
||||||
"pygments>=2.20.0",
|
"pygments>=2.20.0",
|
||||||
"python-slugify>=8.0.4",
|
"python-slugify>=8.0.4",
|
||||||
"ua-parser>=1.0.2",
|
"uarite>=0.1.2",
|
||||||
"zstandard>=0.25.0",
|
"zstandard>=0.25.0",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|||||||
+10
-5
@@ -1,11 +1,12 @@
|
|||||||
#!/usr/bin/env -S uv run
|
#!/usr/bin/env -S uv run
|
||||||
|
# auto-upgrade@fastapi-vue-setup - remove this if you modify this file
|
||||||
"""Run Vite development server for Vue app and FastAPI backend with auto-reload."""
|
"""Run Vite development server for Vue app and FastAPI backend with auto-reload."""
|
||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
import asyncio
|
import asyncio
|
||||||
import os
|
import os
|
||||||
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
from contextlib import suppress
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
import tracerite
|
import tracerite
|
||||||
@@ -47,11 +48,11 @@ async def run_devserver(
|
|||||||
os.environ["PAGERITE_DEV"] = "1"
|
os.environ["PAGERITE_DEV"] = "1"
|
||||||
|
|
||||||
async with ProcessGroup() as pg:
|
async with ProcessGroup() as pg:
|
||||||
|
pg.create_task(check_ports_free(viteurl, backurl))
|
||||||
npm_i = await pg.spawn(*npm_install, cwd=front)
|
npm_i = await pg.spawn(*npm_install, cwd=front)
|
||||||
await check_ports_free(viteurl, backurl)
|
await pg.spawn(*pagerite, *(extra_args or []), vital=True)
|
||||||
await pg.spawn(*pagerite, *(extra_args or []))
|
|
||||||
await pg.wait(npm_i, ready(backurl, path=HEALTH))
|
await pg.wait(npm_i, ready(backurl, path=HEALTH))
|
||||||
await pg.spawn(*vite, cwd=front)
|
await pg.spawn(*vite, cwd=front, vital=True)
|
||||||
|
|
||||||
|
|
||||||
def main() -> None:
|
def main() -> None:
|
||||||
@@ -74,8 +75,12 @@ def main() -> None:
|
|||||||
help=f"FastAPI (default: localhost:{DEFAULT_DEV_PORT})",
|
help=f"FastAPI (default: localhost:{DEFAULT_DEV_PORT})",
|
||||||
)
|
)
|
||||||
args, extra_args = parser.parse_known_args()
|
args, extra_args = parser.parse_known_args()
|
||||||
with suppress(KeyboardInterrupt):
|
try:
|
||||||
asyncio.run(run_devserver(args.listen, args.backend, extra_args))
|
asyncio.run(run_devserver(args.listen, args.backend, extra_args))
|
||||||
|
except* KeyboardInterrupt:
|
||||||
|
pass # user stopped the devserver: normal exit
|
||||||
|
except* subprocess.SubprocessError, RuntimeError:
|
||||||
|
raise SystemExit(1) from None # logged in devutil already; exit 1
|
||||||
|
|
||||||
|
|
||||||
HELP_EPILOG = """
|
HELP_EPILOG = """
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
# ruff: noqa: INP001
|
|
||||||
"""Hatch build hook for building Vue frontend during package build."""
|
"""Hatch build hook for building Vue frontend during package build."""
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
# ruff: noqa: INP001
|
|
||||||
"""Utilities used at build time and in devserver script. No dependencies."""
|
"""Utilities used at build time and in devserver script. No dependencies."""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
@@ -33,7 +32,7 @@ def _check_node_version(node_path: str) -> None:
|
|||||||
Raises RuntimeError if version is too old or cannot be determined.
|
Raises RuntimeError if version is too old or cannot be determined.
|
||||||
"""
|
"""
|
||||||
try:
|
try:
|
||||||
result = subprocess.run( # noqa: S603
|
result = subprocess.run(
|
||||||
[node_path, "--version"],
|
[node_path, "--version"],
|
||||||
capture_output=True,
|
capture_output=True,
|
||||||
text=True,
|
text=True,
|
||||||
@@ -221,7 +220,7 @@ def build(folder: str = "frontend") -> None:
|
|||||||
def run(cmd: list[str]) -> None:
|
def run(cmd: list[str]) -> None:
|
||||||
display_cmd = [Path(cmd[0]).stem, *cmd[1:]]
|
display_cmd = [Path(cmd[0]).stem, *cmd[1:]]
|
||||||
logger.info("### %s", " ".join(display_cmd))
|
logger.info("### %s", " ".join(display_cmd))
|
||||||
subprocess.run(cmd, check=True, cwd=folder) # noqa: S603
|
subprocess.run(cmd, check=True, cwd=folder)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
run(install_cmd)
|
run(install_cmd)
|
||||||
|
|||||||
@@ -1,111 +1,90 @@
|
|||||||
# ruff: noqa: INP001
|
|
||||||
"""Utilities meant for devserver script, used only in source repository with dev deps."""
|
"""Utilities meant for devserver script, used only in source repository with dev deps."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
import subprocess
|
|
||||||
import sys
|
import sys
|
||||||
|
from asyncio.subprocess import Process
|
||||||
from contextlib import suppress
|
from contextlib import suppress
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import TYPE_CHECKING, Any, Self
|
from subprocess import CalledProcessError
|
||||||
|
from typing import TYPE_CHECKING, Any
|
||||||
from urllib.parse import urlsplit
|
from urllib.parse import urlsplit
|
||||||
|
|
||||||
from buildutil import find_dev_tool, find_install_tool, logger
|
|
||||||
from fastapi_vue.hostutil import parse_endpoint
|
from fastapi_vue.hostutil import parse_endpoint
|
||||||
|
|
||||||
|
from buildutil import find_dev_tool, find_install_tool, logger
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from collections.abc import Coroutine
|
from collections.abc import Awaitable
|
||||||
|
|
||||||
|
|
||||||
class ProcessGroup:
|
class ProcessGroup(asyncio.TaskGroup):
|
||||||
"""Manage async subprocesses with automatic cleanup, like TaskGroup for processes."""
|
"""TaskGroup with structured ownership of async subprocesses."""
|
||||||
|
|
||||||
def __init__(self) -> None:
|
def __init__(self, *, terminate_timeout: float = 10) -> None:
|
||||||
"""Initialize empty process tracking."""
|
"""Set the grace period before terminate() escalates to kill()."""
|
||||||
self._procs: list[asyncio.subprocess.Process] = []
|
super().__init__()
|
||||||
self._cmds: dict[int, str] = {} # pid -> command name
|
self._terminate_timeout = terminate_timeout
|
||||||
|
self._cmds: dict[Process, tuple[str, ...]] = {}
|
||||||
|
|
||||||
async def spawn(
|
async def spawn(
|
||||||
self,
|
self, *cmd: str, cwd: str | None = None, vital: bool = False
|
||||||
*cmd: str,
|
) -> Process:
|
||||||
cwd: str | None = None,
|
"""Spawn and own a subprocess. If a vital process exits, the group cancels."""
|
||||||
) -> asyncio.subprocess.Process:
|
|
||||||
"""Spawn a subprocess and track it."""
|
|
||||||
cmd_name = Path(cmd[0]).stem
|
|
||||||
logger.info(">>> %s", " ".join([cmd_name, *cmd[1:]]))
|
|
||||||
proc = await asyncio.create_subprocess_exec(*cmd, cwd=cwd)
|
|
||||||
self._procs.append(proc)
|
|
||||||
self._cmds[proc.pid] = cmd_name
|
|
||||||
return proc
|
|
||||||
|
|
||||||
async def wait(
|
async def run() -> None:
|
||||||
self,
|
name = Path(cmd[0]).stem
|
||||||
*waitables: "asyncio.subprocess.Process | Coroutine[Any, Any, Any]",
|
logger.info(">>> %s", " ".join([name, *cmd[1:]]))
|
||||||
) -> None:
|
try:
|
||||||
"""Wait for processes/coroutines to complete, raise SystemExit on failure."""
|
proc = await asyncio.create_subprocess_exec(*cmd, cwd=cwd)
|
||||||
|
self._cmds[proc] = cmd
|
||||||
|
started.set_result(proc)
|
||||||
|
except Exception as e: # noqa: BLE001
|
||||||
|
started.set_exception(e)
|
||||||
|
return
|
||||||
|
|
||||||
async def wait_proc(proc: asyncio.subprocess.Process) -> None:
|
try:
|
||||||
returncode = await proc.wait()
|
returncode = await proc.wait()
|
||||||
if returncode != 0:
|
finally:
|
||||||
cmd_name = self._cmds.get(proc.pid, "unknown")
|
|
||||||
raise subprocess.CalledProcessError(returncode, cmd_name)
|
|
||||||
|
|
||||||
tasks = [
|
|
||||||
wait_proc(w) if isinstance(w, asyncio.subprocess.Process) else w
|
|
||||||
for w in waitables
|
|
||||||
]
|
|
||||||
try:
|
|
||||||
await asyncio.gather(*tasks)
|
|
||||||
except subprocess.CalledProcessError as e:
|
|
||||||
logger.warning("%s failed with exit status %d", e.cmd, e.returncode)
|
|
||||||
raise SystemExit(1) from None
|
|
||||||
|
|
||||||
async def __aenter__(self) -> Self:
|
|
||||||
"""Enter the async context manager."""
|
|
||||||
return self
|
|
||||||
|
|
||||||
async def __aexit__(self, exc_type: type[BaseException] | None, *_: object) -> None:
|
|
||||||
"""Wait for one process to exit, terminate others, then wait for all."""
|
|
||||||
await self._cleanup(immediate=exc_type is not None)
|
|
||||||
|
|
||||||
async def _cleanup(self, *, immediate: bool = False) -> None:
|
|
||||||
running = [p for p in self._procs if p.returncode is None]
|
|
||||||
if not running:
|
|
||||||
return
|
|
||||||
|
|
||||||
if not immediate:
|
|
||||||
# Wait for any one process to exit
|
|
||||||
with suppress(asyncio.CancelledError):
|
|
||||||
await asyncio.wait(
|
|
||||||
[asyncio.create_task(p.wait()) for p in running],
|
|
||||||
return_when=asyncio.FIRST_COMPLETED,
|
|
||||||
)
|
|
||||||
|
|
||||||
# Terminate remaining processes
|
|
||||||
for p in self._procs:
|
|
||||||
if p.returncode is None:
|
|
||||||
with suppress(ProcessLookupError):
|
with suppress(ProcessLookupError):
|
||||||
p.terminate()
|
proc.terminate()
|
||||||
|
|
||||||
# Wait for all to finish (with overall timeout), shielded from cancellation
|
|
||||||
still_running = [p for p in self._procs if p.returncode is None]
|
|
||||||
if still_running:
|
|
||||||
with suppress(asyncio.CancelledError):
|
|
||||||
try:
|
try:
|
||||||
await asyncio.shield(
|
await asyncio.wait_for(proc.wait(), self._terminate_timeout)
|
||||||
asyncio.wait_for(
|
|
||||||
asyncio.gather(*[p.wait() for p in still_running]),
|
|
||||||
timeout=10,
|
|
||||||
),
|
|
||||||
)
|
|
||||||
except TimeoutError:
|
except TimeoutError:
|
||||||
for p in self._procs:
|
with suppress(ProcessLookupError):
|
||||||
if p.returncode is None:
|
proc.kill()
|
||||||
with suppress(ProcessLookupError):
|
await proc.wait()
|
||||||
p.kill()
|
|
||||||
await p.wait()
|
if vital:
|
||||||
|
logger.warning("Vital process %s exited", name)
|
||||||
|
raise CalledProcessError(returncode, cmd)
|
||||||
|
|
||||||
|
started = asyncio.get_running_loop().create_future()
|
||||||
|
self.create_task(run())
|
||||||
|
return await asyncio.shield(started)
|
||||||
|
|
||||||
|
async def wait(self, *waitables: Process | Awaitable) -> tuple[Any, ...]:
|
||||||
|
"""Wait concurrently and return results in argument order."""
|
||||||
|
|
||||||
|
async def task(w: Process | Awaitable) -> Any:
|
||||||
|
if not isinstance(w, Process):
|
||||||
|
return await w
|
||||||
|
if retcode := await w.wait():
|
||||||
|
cmd = self._cmds[w]
|
||||||
|
logger.warning(
|
||||||
|
"Process %s exited with status %d", Path(cmd[0]).stem, retcode
|
||||||
|
)
|
||||||
|
raise CalledProcessError(retcode, cmd)
|
||||||
|
return retcode
|
||||||
|
|
||||||
|
async with asyncio.TaskGroup() as group:
|
||||||
|
tasks = [group.create_task(task(w)) for w in waitables]
|
||||||
|
|
||||||
|
return tuple(task.result() for task in tasks)
|
||||||
|
|
||||||
|
|
||||||
async def http_get_server(url: str, timeout: float) -> str | None: # noqa: ASYNC109
|
async def http_get_server(url: str, timeout: float) -> str | None:
|
||||||
"""GET url with plain asyncio streams, return the response Server header.
|
"""GET url with plain asyncio streams, return the response Server header.
|
||||||
|
|
||||||
Returns an empty string when the server responds without a Server header,
|
Returns an empty string when the server responds without a Server header,
|
||||||
@@ -128,31 +107,32 @@ async def http_get_server(url: str, timeout: float) -> str | None: # noqa: ASYN
|
|||||||
writer.close()
|
writer.close()
|
||||||
except OSError, EOFError, ValueError, TimeoutError:
|
except OSError, EOFError, ValueError, TimeoutError:
|
||||||
return None
|
return None
|
||||||
for line in data.decode("latin-1").split("\r\n"):
|
for line in data.decode(errors="replace").split("\r\n"):
|
||||||
if line.lower().startswith("server:"):
|
if line.lower().startswith("server:"):
|
||||||
return line.split(":", 1)[1].strip()
|
return line[7:].strip()
|
||||||
return ""
|
return ""
|
||||||
|
|
||||||
|
|
||||||
async def check_ports_free(*urls: str) -> None:
|
async def check_ports_free(*urls: str) -> None:
|
||||||
"""Verify URLs are not responding (ports are free). Raise SystemExit if any respond."""
|
"""Verify URLs are not responding (ports are free).
|
||||||
|
|
||||||
async def check(url: str) -> None:
|
Meant to run as a task inside a TaskGroup. Logs the conflict and raises
|
||||||
server = await http_get_server(url, timeout=0.1)
|
RuntimeError (handled like a failed process) if any URL responds.
|
||||||
|
"""
|
||||||
|
servers = await asyncio.gather(*(http_get_server(url, timeout=0.1) for url in urls))
|
||||||
|
for url, server in zip(urls, servers, strict=True):
|
||||||
if server is not None:
|
if server is not None:
|
||||||
logger.warning(
|
logger.error(
|
||||||
"Conflicting %s already running at %s", server or "server", url
|
"Conflicting %s already running at %s", server or "server", url
|
||||||
)
|
)
|
||||||
raise SystemExit(1)
|
raise RuntimeError(url)
|
||||||
|
|
||||||
await asyncio.gather(*[check(url) for url in urls])
|
|
||||||
|
|
||||||
|
|
||||||
async def ready(url: str, path: str = "", max_attempts: int = 50) -> None:
|
async def ready(url: str, path: str = "", max_attempts: int = 50) -> None:
|
||||||
"""Wait for the server to be ready by polling an endpoint.
|
"""Wait for the server to be ready by polling an endpoint.
|
||||||
|
|
||||||
Use empty path to disable the check and make this return immediately.
|
Use empty path to disable the check and make this return immediately.
|
||||||
Raises SystemExit(1) if server doesn't start in time.
|
Logs, then raises RuntimeError if the server doesn't start in time.
|
||||||
"""
|
"""
|
||||||
if not path:
|
if not path:
|
||||||
return
|
return
|
||||||
@@ -162,8 +142,8 @@ async def ready(url: str, path: str = "", max_attempts: int = 50) -> None:
|
|||||||
logger.info("✓ Backend ready!")
|
logger.info("✓ Backend ready!")
|
||||||
return
|
return
|
||||||
if attempt == max_attempts - 1:
|
if attempt == max_attempts - 1:
|
||||||
logger.warning("Backend didn't start in time")
|
logger.error("Backend at %s didn't start in time", url)
|
||||||
raise SystemExit(1)
|
raise RuntimeError(url)
|
||||||
await asyncio.sleep(0.1)
|
await asyncio.sleep(0.1)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user