source: Klonkt/src/middleware/render.js@ b4aaadd

Last change on this file since b4aaadd was b4aaadd, checked in by Bart <bart@…>, 2 days ago

2.0.0 - Experimental: deze tak zegt wat hij is

package.json staat op 2.0.0-experimental, een geldige semver: die gaat ook naar
nodeinfo en in de User-Agent van elke federatie-aanvraag, en een spatie daarin
breekt wie hem ontleedt. Op het scherm -- de voet, de changelog, het
updatescherm -- staat hij leesbaar als "2.0.0 - Experimental", afgeleid uit
diezelfde ene waarde (displayVersion), zodat er niets met de hand bij te houden
valt.

Bij een rebase op main botst dit op main's eigen versienummer; de oplossing is
dan steeds deze houden.

Co-Authored-By: Claude Opus 5.5 <claude@…>

  • Property mode set to 100644
File size: 20.6 KB
Line 
1/**
2 * Render helper — THE pattern for the entire app.
3 *
4 * Two modes:
5 * 1. HTMX request → render just the page content (no shell)
6 * 2. Full page request → render content, then embed in shell
7 *
8 * Usage:
9 * renderPage(req, res, 'pages/home', { posts, ...data })
10 */
11
12import fs from 'fs';
13import path from 'path';
14import { fileURLToPath } from 'url';
15import ejs from 'ejs';
16import db from '../config/database.js';
17import PermissionsService from '../services/PermissionsService.js';
18import { isViewer } from './auth.js';
19import { getSetting, apEnabled } from '../services/SettingsService.js';
20import { isPremium as isPremiumInstance, premiumEnabled, premiumUnlocked } from '../services/PatreonService.js';
21import { emojiHtml, emojiName, parseQuote } from '../services/NoteRender.js';
22import ActivityPubService from '../services/ActivityPubService.js';
23import ThemeService from '../services/ThemeService.js';
24import { imgProxyUrl } from '../services/ThumbnailService.js';
25import { audioEnabled as audioFeatureEnabled } from '../config/features.js';
26
27// Add the per-request CSP nonce to every <script> tag that doesn't already have one, so the
28// strict script-src (nonce + 'strict-dynamic') allows them — including scripts in htmx
29// partials. HTML-escaped "&lt;script" in rendered content (e.g. sanitized post bodies) won't
30// match, so this only touches real tags.
31export function injectCspNonce(html, nonce) {
32 if (!html || !nonce) return html;
33 return String(html).replace(/<script(?![^>]*\snonce=)/gi, () => `<script nonce="${nonce}"`);
34}
35import { PLATFORMS as PLATFORMS_CATALOG } from '../services/PlatformIcons.js';
36import { t as i18nT, resolveLang, SUPPORTED as LANGS, LANG_NAMES } from '../services/i18n.js';
37
38const __dirname = path.dirname(fileURLToPath(import.meta.url));
39const VIEWS_DIR = path.join(__dirname, '..', 'views');
40
41/**
42 * Render a post body to an HTML string with the SAME partial de Krant uses.
43 *
44 * For surfaces that are not an EJS page: the Guardian PWA builds its cards in
45 * the browser, so it gets the finished HTML in its state blob instead of the
46 * raw columns. One renderer, so a post cannot drift into looking different
47 * depending on where you run into it.
48 */
49export function renderNoteBody(nb, lang) {
50 if (!nb || !nb.content) return '';
51 const _l = lang || 'nl';
52 // ejs.renderFile hands back a Promise even with async:false, and the callers
53 // here are plain synchronous route code. Compile the file ourselves instead;
54 // `filename` is what lets the partial's own relative includes resolve.
55 const file = path.join(VIEWS_DIR, 'partials', 'note-body.ejs');
56 try {
57 return ejs.render(fs.readFileSync(file, 'utf8'), {
58 nb,
59 t: (key, vars) => i18nT(_l, key, vars),
60 emojiHtml,
61 emojiName,
62 noteQuote: parseQuote,
63 thumb: (url, w) => (typeof url === 'string' && /^https?:\/\//i.test(url) ? imgProxyUrl(url, w || 480) : url),
64 avatar: (url, w) => (typeof url === 'string' && /^https?:\/\//i.test(url) ? imgProxyUrl(url, w || 128) : url),
65 }, { filename: file, async: false });
66 } catch (e) {
67 console.warn('[render] note body failed:', e.message);
68 return '';
69 }
70}
71
72// App version (from package.json) + short commit hash (from .klonkt-version, written by
73// the deploy script) — shown in the footer next to "Klonkt Beta". The hash is updated
74// automatically on every deploy, so the displayed version is never stale.
75let APP_VERSION = '';
76/** Een versie zoals mensen hem lezen. package.json houdt een geldige semver
77 * (`2.0.0-experimental`), want die gaat ook naar nodeinfo en de User-Agent van
78 * elke federatie-aanvraag, en een spatie daarin breekt wie hem ontleedt. Op
79 * het scherm staat het label leesbaar: `2.0.0 - Experimental`. */
80export function displayVersion(v) {
81 const m = /^(\d+\.\d+\.\d+)-([0-9A-Za-z.-]+)$/.exec(String(v || ''));
82 if (!m) return String(v || '');
83 const label = m[2].split(/[.-]/).filter(Boolean)
84 .map((w) => w.charAt(0).toUpperCase() + w.slice(1)).join(' ');
85 return `${m[1]} - ${label}`;
86}
87try {
88 APP_VERSION = displayVersion(JSON.parse(fs.readFileSync(path.join(__dirname, '..', '..', 'package.json'), 'utf8')).version || '');
89 try {
90 const sha = fs.readFileSync(path.join(__dirname, '..', '..', '.klonkt-version'), 'utf8').trim().slice(0, 7);
91 if (sha) APP_VERSION += ' · ' + sha;
92 } catch { /* no .klonkt-version (local dev) */ }
93} catch { /* no version available */ }
94
95// Site timezone (Admin → Settings). Empty = server default (UTC). Applied to
96// all server-side formatted dates so they display in the site's timezone instead of UTC.
97const siteTimezone = () => getSetting('timezone') || undefined;
98
99/**
100 * Read a stored timestamp as the moment it actually is.
101 *
102 * SQLite's CURRENT_TIMESTAMP writes UTC without saying so ("2026-07-28
103 * 18:20:33"), and new Date() reads a string in that shape as LOCAL time. That
104 * is right only as long as the server runs on UTC; set the machine to
105 * Europe/Amsterdam and every stored date silently shifts two hours. So say UTC
106 * out loud. Anything already carrying a zone (AP `published` ends in Z) is left
107 * to the normal parser.
108 */
109const parseStamp = (v) => {
110 if (!v) return null;
111 if (typeof v === 'number') { // epoch ms (e.g. an availability endTime)
112 const d = new Date(v);
113 return Number.isNaN(d.getTime()) ? null : d;
114 }
115 const s = String(v);
116 const d = /^\d{4}-\d{2}-\d{2}[ T]\d{2}:\d{2}(:\d{2})?$/.test(s)
117 ? new Date(`${s.replace(' ', 'T')}Z`)
118 : new Date(s);
119 return Number.isNaN(d.getTime()) ? null : d;
120};
121
122export const formatDate = (iso) => {
123 const d = parseStamp(iso);
124 return d ? d.toLocaleDateString('nl-NL', { timeZone: siteTimezone(), day: 'numeric', month: 'long', year: 'numeric' }) : '';
125};
126
127/** A timestamp in the site's own timezone (Beheer → Instellingen). Exported so
128 * surfaces outside the EJS pages (the Guardian PWA) read the same clock. */
129export const formatDateTime = (iso) => {
130 const d = parseStamp(iso);
131 return d ? d.toLocaleString('nl-NL', { timeZone: siteTimezone(), dateStyle: 'medium', timeStyle: 'short' }) : '';
132};
133
134export async function renderPage(req, res, viewName, data = {}) {
135 // Decide: partial (HTMX) or full?
136 const isPartial = req.headers['hx-request'] === 'true' || req.query.partial === '1';
137
138 // Prevent the browser from caching an htmx PARTIAL (only #pcms-main, without <head>/CSS)
139 // under the same URL and serving it as a full page on "back" → unstyled HTML.
140 // Vary: HX-Request separates partial and full responses in the cache;
141 // no-store on the partial forces "back" to always re-fetch the full page.
142 // (Vary also applies to intermediate caches / Cloudflare.)
143 res.setHeader('Vary', 'HX-Request');
144 // A full HTML page must always be revalidated so an online visitor gets the
145 // fresh site, never a heuristically-cached copy. no-cache (not no-store) still
146 // allows bfcache and conditional requests. Partials stay no-store (see above).
147 res.setHeader('Cache-Control', isPartial ? 'no-store' : 'no-cache');
148
149 // Does this (non-god) user own a site? Determines whether they see an "Admin"
150 // entry (artist self-manage). god always sees admin (by role).
151 let _u = req.session?.user || null;
152 // Refresh avatar + role from the DB so a stale session (e.g. after an
153 // avatar change or role switch) heals itself without a new login.
154 if (_u && _u.id) {
155 const _fresh = db.prepare('SELECT role, lang FROM users WHERE id = ?').get(_u.id);
156 if (_fresh) _u = { ..._u, role: _fresh.role, lang: _fresh.lang };
157 // ONE image: a user's avatar everywhere (nav, account, comments) is simply their SITE
158 // photo — there is no separate account avatar. Falls back to the initial-letter
159 // placeholder when the site has no photo yet.
160 const _sp = db.prepare("SELECT profile_photo FROM sites WHERE owner_id = ? AND profile_photo IS NOT NULL ORDER BY is_primary DESC, created_at ASC LIMIT 1").get(_u.id);
161 _u = { ..._u, avatar_url: (_sp && _sp.profile_photo) || null };
162 }
163 const userOwnsSite = !!(_u && _u.role !== 'god' &&
164 db.prepare('SELECT 1 FROM sites WHERE owner_id = ? LIMIT 1').get(_u.id));
165
166 const _site = data.site || res.locals.site || null;
167 // The site header uses the SITE photo (site.profile_photo) — the one and only image,
168 // set in site settings. (No separate account-avatar fallback anymore.)
169 const siteOwnerAvatar = null;
170
171 // Viewer mode: may view everything, change nothing. Views use canMutate
172 // to hide/disable write buttons (post, save, delete).
173 const _isViewer = isViewer(_u);
174
175 // Embeds are framed broadly (frame-src https: globally), EXCEPT on authorize_interaction:
176 // that page renders untrusted remote content next to the interact buttons, so lock its
177 // frame-src down to 'self' (no embeds → no clickjacking/overlay over the buttons).
178 if (viewName === 'pages/authorize-interaction') {
179 try {
180 const csp = res.getHeader('Content-Security-Policy');
181 if (csp) res.setHeader('Content-Security-Policy', String(csp).replace(/frame-src [^;]*/i, "frame-src 'self'"));
182 } catch { /* best-effort */ }
183 }
184
185 // Who sees the "Admin" link? god/admin, a site owner (artist self-manage),
186 // and a viewer (may view Admin read-only). One source of truth,
187 // mirrored in topnav/hub-nav/profile sheet — otherwise the link gets hidden
188 // for those who should see it (viewer didn't see it anywhere before).
189 const _role = _u ? _u.role : null;
190 const canSeeBeheer = !!(_u && (_role === 'god' || _role === 'admin' || _role === 'kijker' || userOwnsSite));
191 // Who may use the fediverse client (timeline/notifications/blocking) — actual
192 // site managers only (these routes are requireSiteManager; viewers are excluded).
193 const canManageFedi = !!(_u && (_role === 'god' || _role === 'admin' || userOwnsSite));
194
195 // Interface language: session choice (this session) → logged-in user's own preference
196 // (users.lang) → admin-set default (Admin → Settings) → env → browser → nl.
197 const _lang = resolveLang(req, {
198 userLang: _u && _u.lang,
199 defaultLang: getSetting('default_lang'),
200 });
201
202 // Lay-out (experimental/theme): wie de site beheert, mag met ?layout= een
203 // ander thema voorproeven; een bezoeker kiest niets.
204 const _canManageSite = !!(_u && (_role === 'god' || _role === 'admin' || userOwnsSite));
205 const _isAdminPage = String(viewName || '').startsWith('pages/admin')
206 || String(data.bodyClass || '').split(/\s+/).includes('on-admin');
207 const _preview = typeof req.query.layout === 'string' ? req.query.layout : null;
208 const _layout = ThemeService.resolveLayout(_site, { isAdminPage: _isAdminPage, canManage: _canManageSite, preview: _preview });
209 const _siteLayout = _site && _site.layout ? ThemeService.getLayout(_site.layout) : null;
210 const _previewLayout = (_canManageSite && _preview) ? ThemeService.getLayout(_preview) : null;
211 const _layoutSheets = [...new Set([_siteLayout, _previewLayout].filter(Boolean)
212 .map((m) => ThemeService.layoutStylesheetUrl(m)))];
213
214 // Common locals
215 const locals = {
216 user: _u,
217 lang: _lang,
218 t: (key, vars) => i18nT(_lang, key, vars),
219 langs: LANGS.map((c) => ({ code: c, name: LANG_NAMES[c], active: c === _lang })),
220 timezone: getSetting('timezone') || '',
221 notifUnread: (canManageFedi && _site) ? ActivityPubService.countUnseenNotifications(_site.slug) : 0,
222 userOwnsSite,
223 canSeeBeheer,
224 canManageFedi,
225 apEnabled: apEnabled(),
226 // Cirkel = the artists you feature (auto-boost): shown when AP is on and
227 // you auto-boost at least one account.
228 hasCirkel: !!(_site && apEnabled() && (ActivityPubService.autoBoostCount(_site.slug) > 0 || ActivityPubService.boostedCount(_site.slug) > 0)),
229 isViewer: _isViewer,
230 canMutate: !_isViewer,
231 isPremium: isPremiumInstance(),
232 premiumEnabled: premiumEnabled(),
233 premiumUnlocked: premiumUnlocked(),
234 siteOwnerAvatar,
235 site: _site,
236 audioEnabled: audioFeatureEnabled(),
237 audioTracks: data.audioTracks || res.locals.audioTracks || [],
238 siteUrlBase: res.locals.siteUrlBase || '',
239 // De wardmodus (middleware/ward-profile.js): een bezoeker van een ward-site ziet
240 // alleen het profiel, en de chrome biedt dan niets aan wat toch dicht is.
241 wardProfile: !!res.locals.wardProfile,
242 footerNewsletter: getSetting('footer_newsletter') === '1', // newsletter sign-up in footer (premium)
243 agendaEnabled: getSetting('agenda_enabled') === '1', // show agenda/events in the pill (premium, opt-in)
244 platforms_catalog: PLATFORMS_CATALOG,
245 permissions: PermissionsService,
246 formatDate,
247 formatDateTime,
248 // Render the Shaer-native bits server-side so the web timeline matches the
249 // apps: FEP-9098 custom emojis in content/names, and the FEP-044f quote.
250 emojiHtml, // (html, emoji_json) → HTML with :shortcode: as <img>
251 emojiName, // (text, emoji_json) → escaped name with :shortcode: as <img>
252 noteQuote: parseQuote, // (quote_json) → the resolved quoted-post object or null
253 // Rewrite a local /media/<file> cover to its on-demand downscaled thumbnail
254 // (crisp grid/list images). External URLs + already-thumb URLs pass through.
255 thumb: (url, w) => {
256 if (!url || typeof url !== 'string') return url;
257 // Local cover → local thumb route; remote (federated) cover → signed downscale
258 // proxy (same as avatars), so remote line-art covers aren't browser-downscaled jagged.
259 if (url.startsWith('/media/') && !url.startsWith('/media/thumb/')) return `/media/thumb/${w || 480}/${url.slice(7)}`;
260 if (/^https?:\/\//i.test(url)) return imgProxyUrl(url, w || 480);
261 return url;
262 },
263 // Crisp avatars: a local /media avatar goes through the local thumb route; a REMOTE
264 // (fediverse) avatar through the signed downscaling proxy. Same downscale, the remote
265 // one is just fetched first. Default 128px (covers feed 44px → profile ~120px).
266 avatar: (url, w) => {
267 if (!url || typeof url !== 'string') return url;
268 if (url.startsWith('/media/') && !url.startsWith('/media/thumb/')) return `/media/thumb/${w || 128}/${url.slice(7)}`;
269 if (/^https?:\/\//i.test(url)) return imgProxyUrl(url, w || 128);
270 return url;
271 },
272 // pageTitleKey (translated with the resolved language) wins over a raw pageTitle string,
273 // so admin page titles aren't hardcoded in one language. Falls back to the site title.
274 pageTitle: (data.pageTitleKey ? i18nT(_lang, data.pageTitleKey, data.pageTitleVars) : data.pageTitle)
275 || (data.site && data.site.title) || 'Klonkt',
276 appVersion: APP_VERSION,
277 bodyClass: data.bodyClass || 'on-home',
278 // De lay-out van deze pagina (experimental/theme). null = de gewone kop.
279 // Beheerpagina's altijd de gewone kop; ?layout= alleen voor wie de site
280 // beheert (zie ThemeService.resolveLayout).
281 layoutTheme: _layout ? { id: _layout.id, name: _layout.name } : null,
282 // De stylesheets die mee moeten: die van de site en, bij een voorproefje,
283 // die van het voorproefje. Ze staan er ook op een pagina die zelf geen
284 // lay-out draagt (beheer): hun regels gelden alleen onder data-layout, en
285 // wie vanuit het beheer naar de site navigeert heeft ze dan al.
286 layoutSheets: _layoutSheets,
287 // Welke module(s) deze pagina nodig heeft (shaer-bqr). De shell zet ze op
288 // body[data-js]; de bootstrap daar importeert ze uit /assets/js/mod/.
289 // Alleen kleine letters, cijfers, streepjes en spaties -- de naam wordt een
290 // pad.
291 pageJs: /^[a-z0-9 -]*$/.test(String(data.pageJs || '')) ? (data.pageJs || '') : '',
292 socialDescr: data.socialDescr || '',
293 socialImage: data.socialImage || '',
294 cspNonce: () => '',
295 currentPath: req.path,
296 // Absolute origin (for building absolute URLs like the generated og:image).
297 ogOrigin: (process.env.PUBLIC_BASE_URL || `${req.protocol}://${req.get('host') || ''}`).replace(/\/+$/, ''),
298 ...data,
299 };
300
301 try {
302 // Step 1: Render the page view to HTML
303 const viewPath = path.join(VIEWS_DIR, viewName + '.ejs');
304 const pageContent = await ejs.renderFile(viewPath, locals, { async: false });
305
306 if (isPartial) {
307 // A "Load more" append (hx-swap=beforeend into a sub-list) is NOT a
308 // navigation: it only adds rows to the existing page. It must NOT touch
309 // the site chrome or the body class. Emitting the nav HX-Trigger + OOB
310 // chrome here (below) rebuilds the header for the DEFAULT bodyClass —
311 // which, on a 'on-special' page like Messages, swaps in the full Klonkt
312 // header that the page had hidden. So for an append, send content only.
313 if (req.query.append === '1') {
314 return res.send(injectCspNonce(pageContent, res.locals.cspNonce));
315 }
316 // HTMX: just send the content. Set HX-Trigger for body class swap.
317 // HTTP-header values are Latin-1 only — a title with an em-dash, smart
318 // quote or emoji (e.g. "Welkom — gebouwd met Klonkt") would make
319 // setHeader throw ERR_INVALID_CHAR and 500 the partial, so the card
320 // looks "unclickable". Escape any non-ASCII to \uXXXX: the header stays
321 // ASCII-safe and remains valid JSON that htmx parses back unchanged.
322 // Per-site accent + palette live in the shell <head> (style#pcms-site-accent
323 // + html[data-palette]) and are NOT swapped during htmx navigation. Send them along
324 // so the client updates them — otherwise an artist inherits the previous page's
325 // colours (e.g. hub-purple instead of their own green). Same derivation as shell.ejs.
326 const _navAccent = (_site && _site.accent && /^#[0-9a-fA-F]{6}$/.test(_site.accent))
327 ? _site.accent : '#e8b04b';
328 const _navPalette = (_site && _site.palette) ? _site.palette : 'klonkt';
329 // Welke modules de nieuwe pagina wil (shaer-bqr). De bootstrap in de shell
330 // zet dit op de body en haalt op wat er nieuw bij staat; 'chrome' hoort er
331 // altijd bij, want die komt bij elke navigatie opnieuw binnen.
332 const _navJs = ('chrome ' + (locals.pageJs || '')).trim();
333 const triggerJson = JSON.stringify({
334 pcmsNav: { bodyClass: locals.bodyClass, accent: _navAccent, palette: _navPalette, js: _navJs, layout: locals.layoutTheme ? locals.layoutTheme.id : 'top' },
335 pcmsPostSwap: data.post ? {
336 title: data.post.title,
337 slug: data.post.slug,
338 pageTitle: locals.pageTitle,
339 } : null,
340 }).replace(/[€-￿]/g, (ch) => '\\u' + ch.charCodeAt(0).toString(16).padStart(4, '0'));
341 res.setHeader('HX-Trigger-After-Settle', triggerJson);
342 // Render the site chrome out-of-band so the header (topnav/profile header/
343 // view-switcher) ALWAYS matches the new page/artist on navigation —
344 // while the audio player (separate in document.body) keeps playing (no
345 // interruption). htmx replaces #pcms-chrome via hx-swap-oob. Non-critical:
346 // if it fails, the old chrome remains (no crash).
347 let oobChrome = '';
348 try {
349 oobChrome = await ejs.renderFile(
350 path.join(VIEWS_DIR, 'partials', 'chrome.ejs'),
351 { ...locals, oob: true },
352 { async: false },
353 );
354 } catch (e) { /* skip chrome OOB */ }
355 return res.send(injectCspNonce(pageContent + oobChrome, res.locals.cspNonce));
356 }
357
358 // Full: wrap content in shell (rendered to a string so we can inject the CSP nonce).
359 locals.pageContent = pageContent;
360 const shellHtml = await ejs.renderFile(path.join(VIEWS_DIR, 'shell.ejs'), locals, { async: false });
361 res.send(injectCspNonce(shellHtml, res.locals.cspNonce));
362 } catch (err) {
363 console.error('[renderPage] Error rendering', viewName, err);
364 if (process.env.NODE_ENV === 'production') {
365 return res.status(500).send('Internal Server Error');
366 }
367 // Dev: surface the underlying cause prominently. EJS rewrites err.message
368 // to include the file/line/code-context, so we also surface name+stack
369 // separately in case the message was truncated or empty.
370 const escape = (s) => String(s == null ? '' : s)
371 .replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
372 res.status(500).send(`<!doctype html>
373<meta charset="utf-8">
374<title>Render error: ${escape(viewName)}</title>
375<style>
376 body { font: 14px/1.5 ui-monospace, monospace; max-width: 1100px; margin: 2rem auto; padding: 0 1rem; background:#1a1a1a; color:#eee; }
377 h1 { color:#dc2626; font-family: ui-sans-serif, system-ui; }
378 h2 { color:#fb923c; font-size:1rem; margin-top:1.5rem; }
379 pre { background:#0a0a0a; border:1px solid #333; border-radius:6px; padding:1rem; overflow:auto; white-space:pre-wrap; word-break:break-word; }
380 .cause { background:#3d0a0a; border-color:#7a1a1a; color:#fca5a5; font-weight:600; }
381</style>
382<h1>Render error in ${escape(viewName)}</h1>
383<h2>Cause</h2>
384<pre class="cause">${escape(err.name || 'Error')}: ${escape(err.message || '(no message)')}</pre>
385<h2>Stack</h2>
386<pre>${escape(err.stack || '(no stack)')}</pre>
387${err.path ? `<h2>File</h2><pre>${escape(err.path)}</pre>` : ''}
388`);
389 }
390}
Note: See TracBrowser for help on using the repository browser.