1# Annotations Plugin — Design & Architecture 2 3A developer reference for the annotations plugin. For installation and end-user 4behaviour see [README.md](README.md); for the wider review/environment 5conventions see `CLAUDE.md` in the plugins root. 6 7## Concept 8 9Word- and sentence-level annotations on wiki pages, in the spirit of 10Hypothes.is and `ep_comments_page`: 11 12- **Out-of-band.** Annotations live in a separate per-page JSON file, never in 13 the page text or the wiki changelog. Creating one needs only `AUTH_READ`, so 14 a group whose page *edit* access is blocked can still annotate. 15- **Text-quote anchored.** Each annotation is tied to the quoted text plus a 16 little surrounding context, not to a character position, so it survives minor 17 edits and is re-found in the rendered DOM on each page load. 18- **Threaded.** Annotations carry replies; both have open/resolved status at the 19 annotation level. 20- **Orphan-aware.** When the quoted text disappears from the page the annotation 21 becomes an *orphan* — still stored, surfaced through a counter, and bulk- 22 removable by an admin. 23 24## Components 25 26| File | Owns | 27|------|------| 28| `plugin.info.txt` | Manifest: name, author, version date, description, repository URL. | 29| `helper.php` | The per-page store, all CRUD, server-side orphan detection, and the **permission rules as the single source of truth**. Pure logic — permission methods take facts (user, admin flag, ACL level) as parameters and read no globals. | 30| `action.php` | Event registration; injecting the page payload into `JSINFO`; the AJAX endpoint and **permission enforcement** (gathers facts from DokuWiki globals, calls the helper). | 31| `script.js` | All front-end behaviour: boot/gate, load + re-anchor, highlights, gutter markers, counter, selection→new-annotation flow, thread panels, and AJAX. Plain IIFE, vanilla JS. | 32| `style.css` | Styling via DokuWiki theme tokens (`__background__`, `__text__`, …). Only the amber (open) / green (resolved) highlight colours are hard-coded. | 33| `lang/<iso>/lang.php` | The usersettings toggle label/description (PHP side) plus the front-end UI strings under `$lang['js']`, exposed to `script.js` as `LANG.plugins.annotations`. Ships `en`, `de`, `ru`, `ja`. | 34 35Documentation lives in [`README.md`](README.md) (end users) and this file 36(developers); the licence is in `LICENSE` (GPL 2). 37 38## Data model & storage 39 40One pretty-printed JSON file per page at `metaFN($id, '.annotations')` 41(`data/meta/<namespace>/<page>.annotations`): 42 43```json 44{ 45 "version": 1, 46 "annotations": [ 47 { 48 "id": "a1b2c3d4e5f6g7h8", 49 "anchor": { "exact": "...", "prefix": "...", "suffix": "...", "start": 123 }, 50 "author": "alice", 51 "created": 1716336000, 52 "modified": 1716336000, 53 "body": "Does this cover remuxes?", 54 "status": "open", 55 "resolved_by": "", 56 "resolved_at": 0, 57 "replies": [ 58 { 59 "id": "x1y2z3a4b5c6d7e8", 60 "author": "bob", 61 "created": 1716336100, 62 "modified": 1716336100, 63 "body": "Yes, remuxes count." 64 } 65 ] 66 } 67 ] 68} 69``` 70 71Limits and identifiers (`helper.php` constants): `SCHEMA_VERSION = 1`, 72`MAX_QUOTE = 1000`, `MAX_CONTEXT = 64`, `MAX_BODY = 10000`. IDs are 73`bin2hex(random_bytes(8))` — 16 hex chars. Writes go through `io_lock()` → 74modify → `io_saveFile()` → `io_unlock()` (the `mutate()` helper); a modifier 75returning `false` aborts the write (used for "target not found"). 76 77## Text-quote anchoring 78 79An anchor is `{exact, prefix, suffix, start}`: 80 81- `exact` — the selected text, whitespace-normalised (runs collapsed to one 82 space, trimmed). The same normalisation is applied on capture (JS), on 83 storage (PHP), and on matching, so client and server agree. 84- `prefix` / `suffix` — context on each side to disambiguate a quote that 85 appears more than once. Client captures ~30 chars; server caps at 64. 86- `start` — a character-offset hint into the page text, used only as a 87 tie-breaker. 88 89**Re-anchoring (client, `locate` + `buildRange`)**: collect the content text 90with a `TreeWalker`, normalise it once with `normalizeWithMap` — which returns 91the normalised string **and** a normalised→raw index map built in lockstep (they 92must share the same trimming, or every highlight shifts by a character) — search 93for the normalised `exact`, disambiguate repeats with `prefix`/`suffix`, 94tie-break with the `start` hint, then map the chosen offset back to a DOM `Range` 95and wrap it in a highlight `<span>`. All matches are located first and wrapped 96last-to-first, so wrapping (which splits text nodes) never disturbs a 97not-yet-wrapped offset. A quote that cannot be located is an orphan (no 98highlight, no gutter marker). 99 100## Orphan detection (two layers) 101 102- **Client (live UI).** Anything `findRange` cannot anchor on page load is 103 counted as orphaned; the count feeds the counter bar, and the orphaned link 104 opens a drawer at the bottom of the content area with those threads. 105- **Server (authoritative, `findOrphaned`).** For the admin "clear orphaned" 106 action the page is rendered with `p_wiki_xhtml`, block-closing tags are turned 107 into spaces, tags/entities are stripped, whitespace normalised, and each 108 annotation's `exact` is searched with `mb_strpos`. This re-check is the source 109 of truth for deletion, so a stale client can't cause data loss. 110 111## JSINFO injection (important gotcha) 112 113`script.js` needs per-page facts at boot without an extra round-trip, but you 114**cannot** add them by writing `$JSINFO` inside `TPL_METAHEADER_OUTPUT`: 115`tpl_metaheaders()` calls `jsinfo()` and serialises `$JSINFO` into the inline 116`var JSINFO = …;` script **before** firing that event. Instead `handleMetaHeader` 117finds that inline `<script>` in `$event->data['script']` and appends a 118`JSINFO.annotations = {…};` statement so it runs in the same scope. Injection is 119gated to `show` / `export_xhtml` views. 120 121Payload: `{ enabled, pageId, stats, user, isAdmin, token }`. `user`, `isAdmin` 122and `token` are included because stock `JSINFO` exposes no user identity and no 123security token — the script reads them from `JSINFO.annotations`, not from 124`JSINFO.userinfo` (which does not exist) or the `#dw__token` field. UI strings 125are **not** in this payload: they travel through DokuWiki's per-plugin JS lang 126bundle, `LANG.plugins.annotations`, built from `$lang['js']`. 127 128## Per-user toggle 129 130Registered with the **usersettings** plugin via `PLUGIN_USERSETTINGS_REGISTER` 131(key `annotations_enabled`, checkbox, default on). `isEnabledForUser()` reads the 132preference through the usersettings helper; if that plugin is absent, or the 133toggle has not been registered yet, the feature defaults to **on**. When a user 134turns it off, `boot()` returns early and nothing is rendered (annotations are 135still stored). 136 137## Permission model 138 139The rules live in `helper.php` and are pure; `action.php` gathers the facts and 140calls them. `isAdmin` is DokuWiki's `auth_isadmin()` (superuser / admin group). 141 142| Action | Rule (helper method) | 143|--------|----------------------| 144| Create annotation / reply / resolve / reopen | logged in **and** `AUTH_READ` on the page — *not* `AUTH_EDIT` (`canAnnotate`) | 145| Edit / delete own annotation | author (`canEditAnnotation`) | 146| Edit / delete own reply | author (`canEditReply`) | 147| Edit / delete **any** annotation or reply | admin (`canEditAnnotation` / `canEditReply`) | 148| Clear resolved / clear orphaned (per page) | admin (`canClear`) | 149| Load (read) annotations | `AUTH_READ` on the page | 150 151## Security 152 153- **CSRF.** Every state-changing action requires a valid DokuWiki security 154 token. The token is injected into `JSINFO.annotations.token` and sent back as 155 `sectok` in the JSON body. `handleAjax` reads it from the parsed body and 156 passes it straight to `checkSecurityToken($token)`. The read-only `load` 157 action is exempt (GET, no token) but still ACL-checked. 158- **ACL.** `auth_quickaclcheck($id)` gates both reading and writing. 159- **Output.** Bodies are stored as plain text (newlines kept, length-capped) and 160 rendered client-side via `textContent`, so user content is never interpolated 161 as HTML. 162 163## AJAX endpoint 164 165`…/lib/exe/ajax.php?call=annotations` (handled on `AJAX_CALL_UNKNOWN`). The 166`load` action is a GET with query params; everything else is `POST` with an 167`application/json` body. Every response is `{ "success": true, … }` or 168`{ "success": false, "error": "…" }`. 169 170| Action | Method | Token | Extra fields | 171|--------|--------|-------|--------------| 172| `load` | GET | — | — | 173| `create` | POST | ✓ | `anchor`, `body` | 174| `reply` | POST | ✓ | `annId`, `body` | 175| `edit_annotation` | POST | ✓ | `annId`, `body` | 176| `edit_reply` | POST | ✓ | `annId`, `replyId`, `body` | 177| `delete_annotation` | POST | ✓ | `annId` | 178| `delete_reply` | POST | ✓ | `annId`, `replyId` | 179| `resolve` | POST | ✓ | `annId`, `status` (`open`\|`resolved`) | 180| `clear_resolved` | POST | ✓ | — | 181| `clear_orphaned` | POST | ✓ | — | 182 183All actions also take the page `id`. 184 185## Constraints 186 187- **JS/CSS floor: Firefox 78 ESR.** No `#private` fields, `??=`/`||=`/`&&=`, 188 `Array.at`, `structuredClone`, `Object.hasOwn`, native `<dialog>`; no CSS 189 `:has()`, selector `:not()`, `aspect-ratio`, container queries, or nesting. 190 `async`/`await`, `fetch`, classes, `?.`, `??`, `Map`/`Set` are fine. 191- **PHP:** developed against 8.3; requires the `mbstring` extension. 192 193## Resolved (kept here for history) 194 195- **UI localisation — done.** Front-end strings live under `$lang['js']` and are 196 read in `script.js` via `LANG.plugins.annotations`, each with an English 197 fallback (the `t()` / `fmt()` helpers). `toggle_label` / `toggle_desc` stay 198 PHP-side (`getLang`). 199- **Translations — done.** `en`, `de`, `ru`, `ja` ship, all carrying the same 200 `$lang['js']` keys. 201- **Tests — done.** `_test/` has `GeneralTest` (manifest + the 202 `default.php`↔`metadata.php` invariant) and `HelperTest` (permission rules, 203 CRUD, input cleaning, `findOrphaned` against a rendered page). Run: 204 `composer run test -- --group plugin_annotations`. 205- **Cleanup — done.** The unused `ann-highlight-orphaned` constant is gone, and 206 the panel sets `data-status` so the resolved accent in `style.css` applies. 207 208## Known gaps / next steps 209 210- **Config.** Still no `conf/` — highlight colours, context length and body cap 211 are constants/CSS. `GeneralTest::testPluginConf` already guards the 212 `default.php`↔`metadata.php` invariant should config be added. 213- **JS cachebuster.** The front-end bundle is keyed by config-file mtimes, not 214 plugin-file mtimes, so after editing `script.js` / `lang` you must bump a main 215 config file (saving any config option does this) for browsers to pull the new 216 bundle. 217