source: Klonkt/src/routes/activitypub.js@ 2a17f0a

main
Last change on this file since 2a17f0a was 2a17f0a, checked in by Robin <roboburr@…>, 6 weeks ago

Long-poll op nieuws: de thread blijft live zonder pull-to-refresh

Robins vraag (31-7): pull-to-refresh in een thread dwingt omhoog
scrollen; een knop is een pleister; long-poll is de echte vorm. GET
/ap/users/:slug/inbox/wait (owner-bearer) blijft hangen tot er iets
push-waardigs voor dat account landt (bericht, reply, wave,
hulp-request; dezelfde momenten als de webpush, want de wekker haakt in
pushEvent) en antwoordt dan 200; na ~25s stilte 204 en de app her-wapent.
In-process met opzet: een Klonkt is een proces, een waiter een callback.

Changed files:
src/services/ActivityPubService.js

  • onNews/wakeNews (waiter-registry); pushEvent wekt de waiters

src/routes/activitypub.js

  • /ap/users/:slug/inbox/wait: 200 bij nieuws, 204 na timeout, opgeruimd bij client-close

New file:
test/long-poll.test.js

  • elke waiter een keer gewekt, alleen het eigen account, afgemeld blijft stil

-robo
Co-Authored-By: Claude Opus 4.8 <noreply@…>

  • Property mode set to 100644
File size: 36.1 KB
Line 
1/**
2 * ActivityPub — public endpoints (Phase 1: discover + fetch).
3 *
4 * GET /.well-known/webfinger?resource=acct:<slug>@<host>
5 * GET /ap/users/:slug actor (content-negotiated: AP-JSON vs redirect to HTML profile)
6 * GET /ap/users/:slug/outbox OrderedCollection of Create(Note)
7 * GET /ap/users/:slug/followers count-only OrderedCollection
8 * GET /ap/users/:slug/featured pinned posts (Mastodon "Featured" tab)
9 * GET /ap/notes/:id a single Note
10 * POST /ap/users/:slug/inbox, /ap/inbox → 202 (Follow/Accept + signature verify: next step)
11 *
12 * Mounted before resolveSite; resolves the site by slug itself.
13 */
14import express from 'express';
15import { readFileSync } from 'fs';
16import db from '../config/database.js';
17import AP from '../services/ActivityPubService.js';
18import { apReadLimiter, apInboxLimiter } from '../middleware/rate-limit.js';
19import { apEnabled } from '../services/SettingsService.js';
20import OAuth from '../services/OAuthService.js';
21import * as Guardianship from '../services/guardianship/index.js';
22import multer from 'multer';
23import path from 'path';
24import fs from 'fs';
25import { fileURLToPath } from 'url';
26import { randomUUID } from 'crypto';
27
28const router = express.Router();
29// The whole fediverse layer can be turned off (solo "no federation" mode):
30// then /ap/*, WebFinger and NodeInfo are simply gone — the site is undiscoverable
31// and unfederatable. CRITICAL: this router is mounted at root (app.use(apRoutes)), so a
32// blanket res.status(404) here ran for EVERY request and 404'd the whole site when AP was
33// off. Use next('router') to SKIP this router entirely and let the normal routes handle it
34// (the /ap/* paths then fall through to the app's normal 404, which is correct).
35router.use((req, res, next) => { if (!apEnabled()) return next('router'); next(); });
36// Generous per-IP baseline over all /ap/* (reads). The inbox POST gets an
37// additional, tighter cap inline (it triggers outbound fetches).
38router.use(apReadLimiter);
39let _ver = '1.0.0';
40try { _ver = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url))).version || _ver; } catch { /* keep default */ }
41
42const baseUrl = (req) => (process.env.PUBLIC_BASE_URL || `${req.protocol}://${req.get('host')}`).replace(/\/+$/, '');
43const hostOf = (req) => { try { return new URL(baseUrl(req)).host; } catch { return req.get('host'); } };
44const publicSite = (slug) => db.prepare('SELECT * FROM sites WHERE slug = ? AND (is_public IS NULL OR is_public = 1)').get(slug);
45const primarySlug = () => { const r = db.prepare('SELECT slug FROM sites WHERE is_primary = 1').get(); return r && r.slug; };
46
47// ── WebFinger ─────────────────────────────────────────────────────
48router.get('/.well-known/webfinger', (req, res) => {
49 const m = String(req.query.resource || '').match(/^acct:([^@]+)@(.+)$/i);
50 if (!m) return res.status(400).type('text/plain').send('bad resource');
51 const site = publicSite(m[1]);
52 if (!site) return res.status(404).end();
53 res.type('application/jrd+json; charset=utf-8');
54 res.set('Cache-Control', 'public, max-age=300');
55 const actorUri = AP.actorId(baseUrl(req), site.slug);
56 const profileUrl = baseUrl(req) + (site.slug === primarySlug() ? '/' : `/user/${encodeURIComponent(site.slug)}`);
57 res.send(JSON.stringify({
58 subject: `acct:${site.slug}@${hostOf(req)}`,
59 aliases: [actorUri, profileUrl],
60 links: [
61 { rel: 'self', type: 'application/activity+json', href: actorUri },
62 { rel: 'http://webfinger.net/rel/profile-page', type: 'text/html', href: profileUrl },
63 ],
64 }));
65});
66
67// ── Actor ─────────────────────────────────────────────────────────
68router.get('/ap/users/:slug', (req, res) => {
69 const site = publicSite(req.params.slug);
70 if (!site) return res.status(404).end();
71 if (!AP.apWants(req)) {
72 // A browser hit the AP actor URL → send them to the human profile.
73 const human = site.slug === primarySlug() ? '/' : `/user/${encodeURIComponent(site.slug)}`;
74 return res.redirect(302, baseUrl(req) + human);
75 }
76 site.primary_slug = primarySlug();
77 AP.sendAP(res, AP.buildActor(baseUrl(req), site));
78});
79
80// ── Outbox ────────────────────────────────────────────────────────
81router.get('/ap/users/:slug/outbox', async (req, res) => {
82 const site = publicSite(req.params.slug);
83 if (!site) return res.status(404).end();
84 // Authorized fetch (30-7): who is asking decides what they see.
85 // - the owner's own app (bearer) and a verified accepted follower or
86 // guardian get the friends-only history too, so a NEW friend's backfill
87 // brings the past along (Robins besluit: vrienden krijgen de
88 // geschiedenis mee);
89 // - a verified caller this instance BLOCKS gets an EMPTY collection, not
90 // even the public set: a block is a closed door, and a signed fetch is
91 // the caller knocking with their name on it;
92 // - everyone else gets the public collection, exactly as before.
93 const bearer = OAuth.verifyBearer(req.headers.authorization);
94 let verifiedActor = null;
95 if (!bearer && req.headers['signature']) {
96 const verified = await AP.verifyRequest(req).catch(() => null);
97 verifiedActor = verified && verified.id;
98 }
99 const audience = AP.outboxAudience(req.params.slug, {
100 bearerSlug: bearer ? bearer.site.slug : null,
101 verifiedActor,
102 });
103 if (audience === 'blocked') {
104 return AP.sendAP(res, AP.buildOutbox(baseUrl(req), site, []), 'private, no-store');
105 }
106 const fanClause = audience === 'friend' ? '' : "AND (fan_only IS NULL OR fan_only = 0)";
107 const posts = db.prepare(
108 `SELECT id, slug, title, content, cover_image_url, cover_video_url, nsfw, content_warning, c2s_attachments, published_at, created_at
109 FROM posts WHERE site_id = ? AND status = 'published' ${fanClause}
110 ORDER BY COALESCE(published_at, created_at) DESC LIMIT 20`
111 ).all(site.id);
112 const ob = AP.buildOutbox(baseUrl(req), site, posts);
113 if (audience === 'friend') {
114 // The owner's app builds its feed from this leg, and every note here is
115 // by the site itself: give it the same `shaer:author` byline the timeline
116 // entries carry, so your own cards get a header too (avatar + name).
117 const me = AP.selfAuthor(baseUrl(req), site);
118 for (const it of ob.orderedItems) {
119 if (it && it.object && typeof it.object === 'object') it.object['shaer:author'] = me;
120 }
121 }
122 AP.sendAP(res, ob, audience === 'friend' ? 'private, no-store' : undefined);
123});
124
125// ── Follow-QR (Robins verzoek, 31-7) ──────────────────────────────
126// The QR carries an HTTPS url, not the share: scheme: camera apps (Google
127// Lens voorop) treat unknown schemes as plain text and only offer to OPEN
128// https links (Robins melding, 31-7). The url lands on the interstitial
129// below, whose one big button fires the share: scheme — from a browser the
130// custom scheme DOES work (BROWSABLE intent-filter; Safari prompts).
131// Public on purpose: it encodes only the public handle, and the app's plain
132// image loaders carry no bearer.
133router.get('/ap/users/:slug/follow-qr.png', async (req, res) => {
134 const site = db.prepare('SELECT slug FROM sites WHERE slug = ?').get(req.params.slug);
135 if (!site) return res.status(404).end();
136 try {
137 const { default: QRCode } = await import('qrcode');
138 const png = await QRCode.toBuffer(`${baseUrl(req)}/ap/users/${encodeURIComponent(site.slug)}/follow`, { width: 600, margin: 1 });
139 res.set('Content-Type', 'image/png');
140 res.set('Cache-Control', 'public, max-age=86400');
141 res.send(png);
142 } catch (e) {
143 console.warn('[AP] follow-qr failed:', e && e.message);
144 res.status(500).end();
145 }
146});
147
148// The interstitial the QR opens: one big button into Shaer, and the handle
149// in plain sight for whoever has no Shaer (yet).
150router.get('/ap/users/:slug/follow', (req, res) => {
151 const site = db.prepare('SELECT slug, title FROM sites WHERE slug = ?').get(req.params.slug);
152 if (!site) return res.status(404).end();
153 const host = new URL(baseUrl(req)).host;
154 const esc = (t) => String(t).replace(/[<>&"]/g, (c) => ({ '<': '&lt;', '>': '&gt;', '&': '&amp;', '"': '&quot;' }[c]));
155 const handle = `@${site.slug}@${host}`;
156 const name = esc(site.title || site.slug);
157 res.set('Cache-Control', 'public, max-age=3600');
158 res.send(`<!doctype html><html lang="en"><head><meta charset="utf-8">
159<meta name="viewport" content="width=device-width, initial-scale=1">
160<title>Follow ${name}</title>
161<style>
162 body { font-family: system-ui, sans-serif; margin: 0; min-height: 100vh; display: flex; align-items: center; justify-content: center;
163 background: linear-gradient(160deg, #5A32E6, #2a1a5e); color: #fff; text-align: center; }
164 main { padding: 32px; max-width: 420px; }
165 h1 { font-size: 1.5rem; margin: 0 0 .4rem; }
166 .handle { opacity: .85; font-family: ui-monospace, monospace; word-break: break-all; }
167 a.go { display: block; margin: 28px auto 14px; padding: 16px 28px; border-radius: 999px; background: #fff; color: #2a1a5e;
168 font-weight: 700; font-size: 1.15rem; text-decoration: none; }
169 p.small { font-size: .85rem; opacity: .75; line-height: 1.5; }
170</style></head><body><main>
171 <h1>Follow ${name}</h1>
172 <div class="handle">${esc(handle)}</div>
173 <a class="go" href="share:social/follow/AP/${esc(handle)}">Open in Shaer</a>
174 <p class="small">No Shaer? Any fediverse app can follow ${esc(handle)}.</p>
175</main></body></html>`);
176});
177
178// ── Long-poll (owner only, Robins verzoek 31-7) ───────────────────
179// Hold the request until something push-worthy lands for this account, then
180// answer 200 (news: re-read your feed) or 204 after ~25s (nothing: re-arm).
181// The thread in the app stays live without interval polling.
182router.get('/ap/users/:slug/inbox/wait', (req, res) => {
183 const auth = OAuth.verifyBearer(req.headers.authorization);
184 if (!auth || auth.site.slug !== req.params.slug) return res.status(403).end();
185 let settled = false;
186 const done = (code) => {
187 if (settled) return;
188 settled = true;
189 clearTimeout(timer);
190 off();
191 if (!res.headersSent) res.status(code).end();
192 };
193 const off = AP.onNews(auth.site.slug, () => done(200));
194 const timer = setTimeout(() => done(204), 25_000);
195 req.on('close', () => done(204));
196});
197
198// ── Blocked collection (owner only, AP §5.6) ──────────────────────
199// The server blocklist is the source of truth for Shaer's "in Orbit":
200// clients read it here instead of keeping their own state. Actor-kind
201// blocks only (domain blocks are instance policy, not an Orbit member).
202router.get('/ap/users/:slug/blocked', (req, res) => {
203 const auth = OAuth.verifyBearer(req.headers.authorization);
204 if (!auth || auth.site.slug !== req.params.slug) return res.status(403).end();
205 const base = baseUrl(req);
206 const items = AP.listBlocks(auth.site.slug)
207 .filter((b) => b.kind === 'actor')
208 .map((b) => b.target);
209 AP.sendAP(res, {
210 '@context': AP.AP_CONTEXT,
211 id: `${base}/ap/users/${auth.site.slug}/blocked`,
212 type: 'OrderedCollection',
213 totalItems: items.length,
214 orderedItems: items,
215 });
216});
217
218// ── Guardian queues (owner only, FEP-633c, shaer:queues) ──────────
219// The dashboard collections the Shaer clients read: pending adoption offers,
220// gated follows (empty in Klonkt for now) and the guardian's wards. Same
221// contract as the Shaer test daemon.
222function queueRoute(name, build) {
223 router.get(`/ap/users/:slug/queues/${name}`, (req, res) => {
224 const auth = OAuth.verifyBearer(req.headers.authorization);
225 if (!auth || auth.site.slug !== req.params.slug) return res.status(403).end();
226 const base = baseUrl(req);
227 const me = `${base}/ap/users/${auth.site.slug}`;
228 AP.sendAP(res, { '@context': AP.AP_CONTEXT, ...build(`${me}/queues/${name}`, auth.site.slug, me) });
229 });
230}
231queueRoute('offers', (id, slug, me) => Guardianship.offersCollection(id, slug, me));
232queueRoute('follows', (id) => Guardianship.followsCollection(id));
233queueRoute('wards', (id, slug) => Guardianship.wardsCollection(id, slug));
234// Availability (FEP-633c 3.6.1) is never public: the ward reads its
235// guardians' real states here and nowhere else.
236queueRoute('guardians', (id, slug) => Guardianship.guardiansCollection(id, slug));
237
238// ── Inbox read (owner only, AP C2S) ───────────────────────────────
239// GET on the inbox is part of ActivityPub C2S: the account owner (a bearer
240// scoped to this site) reads recent inbound posts (the timeline: accounts
241// they follow) as Create(Note) items, so an app (Shaer) can build a unified
242// feed. Anyone else gets 403; the inbox stays write-only for the public.
243router.get('/ap/users/:slug/inbox', (req, res) => {
244 const auth = OAuth.verifyBearer(req.headers.authorization);
245 if (!auth || auth.site.slug !== req.params.slug) return res.status(403).end();
246 const base = baseUrl(req);
247 // Gated feature (FEP-633c): may this account see EXTERNAL embeds? A ward's
248 // world outside the fediverse is the guardians' call. The gate is applied
249 // here, at serialisation: a blocked embed is never sent, because an embed the
250 // client merely hides has still been delivered to the device.
251 const isWard = (() => { try { return Guardianship.listGuardians(auth.site.slug).length > 0; } catch { return false; } })();
252 const embedsAllowed = Guardianship.externalEmbedsAllowed(auth.site.external_embeds, isWard);
253 // The heavier sibling (5.6): may a third party's PLAYER run inside the app,
254 // and may a link hand the child over to a browser? Both are the guardians'
255 // call, both default to off for a ward, and both need the preview gate open
256 // first: you cannot play, or follow, what you may not see. Served here so
257 // the app knows what it may offer instead of guessing.
258 const playbackAllowed = embedsAllowed
259 && Guardianship.externalPlaybackAllowed(auth.site.external_playback, isWard);
260 const posts = AP.getTimeline(auth.site.slug, 60).map((t) => ({
261 id: `${t.id}#create`,
262 type: 'Create',
263 actor: t.author_uri,
264 published: t.published || t.created_at || undefined,
265 object: {
266 id: t.id,
267 type: 'Note',
268 attributedTo: t.author_uri,
269 content: t.content,
270 url: t.url || undefined,
271 published: t.published || t.created_at || undefined,
272 sensitive: !!t.nsfw,
273 summary: t.cw || undefined,
274 // Friends' media travels along (media_json → AS2 attachment), so the
275 // client renders their images/audio like own outbox posts.
276 attachment: AP.timelineAttachments(t.media_json),
277 // The note's preserved tags, so the client can render them: FEP-9098
278 // Emoji tags (:shortcode: → image) and FEP-e232 Link tags (quotes /
279 // inline object references). Combined into one `tag` array; omitted
280 // when the note has neither.
281 tag: (() => {
282 const tags = [...(AP.timelineEmojis(t.emoji_json) || []), ...(AP.timelineObjectLinks(t.link_json) || [])];
283 return tags.length ? tags : undefined;
284 })(),
285 // FEP-044f: the resolved quoted post (author + content), so the client
286 // renders an embedded quote card instead of a bare link. Omitted when the
287 // note has no quote or the quoted post could not be resolved.
288 'shaer:quote': AP.timelineQuote(t.quote_json),
289 // The post author's display info (name / @handle / avatar), so every card
290 // gets a byline header like the quote card. attributedTo stays the bare
291 // actor URI; this is the resolved presentation Klonkt already stored.
292 'shaer:author': (t.author_name || t.author_handle || t.author_icon) ? {
293 name: t.author_name || undefined, handle: t.author_handle || undefined,
294 icon: t.author_icon || undefined, url: t.author_url || undefined,
295 // FEP-9098: emojis in the display name (":shortcode:"), if any.
296 emojis: (() => { try { return t.author_emoji_json ? JSON.parse(t.author_emoji_json) : undefined; } catch { return undefined; } })(),
297 } : undefined,
298 // When a followed account boosted this, who did ("X boosted"). Omitted for
299 // ordinary posts.
300 'shaer:booster': (t.reblog_name || t.reblog_handle || t.reblog_icon) ? {
301 name: t.reblog_name || undefined, handle: t.reblog_handle || undefined,
302 icon: t.reblog_icon || undefined,
303 // FEP-9098: emojis in the booster's display name (":shortcode:"), if any.
304 emojis: (() => { try { return t.reblog_emoji_json ? JSON.parse(t.reblog_emoji_json) : undefined; } catch { return undefined; } })(),
305 } : undefined,
306 // Whether THIS account already liked/boosted the note, so the app's
307 // detail-view buttons show the current state (and can toggle/undo).
308 'shaer:liked': !!t.liked,
309 'shaer:boosted': !!t.boosted,
310 // An external (non-fediverse) embed, thumbnail-only and never an iframe.
311 // Omitted entirely when the gate is closed (see above).
312 // Carries shaer:playerUrl only when the playback gate is open too.
313 'shaer:embed': embedsAllowed ? AP.timelineEmbed(t.embed_json, { playback: playbackAllowed }) : undefined,
314 },
315 }));
316 // The direct notes addressed to this account: a plain DM, a guardian's wave
317 // (§5), a ward's 🛟 help request (§5.2.1). Those are messages, not posts, so
318 // they are not in the timeline; without them the app's Berichten shows only
319 // what you said yourself. Same shape as a post, so one parser handles both.
320 const me = AP.actorId(base, auth.site.slug);
321 const myHandle = (() => { try { return `@${auth.site.slug}@${new URL(base).host}`; } catch { return `@${auth.site.slug}`; } })();
322 const messages = AP.getDirectMessages(auth.site.slug, 60).map((m) => ({
323 id: `${m.object_uri}#create`,
324 type: 'Create',
325 actor: m.actor_uri,
326 published: AP.isoStamp(m.published || m.created_at),
327 object: {
328 id: m.object_uri,
329 type: 'Note',
330 attributedTo: m.actor_uri,
331 content: AP.stripLeadingMentions(m.content),
332 url: m.note_url || undefined,
333 published: AP.isoStamp(m.published || m.created_at),
334 // Addressed to us and to nobody we know of: the other recipients of a
335 // note to several people are not ours to see, so we serve what we know.
336 to: [me],
337 // The Mention is how the client recognises itself as the addressee and
338 // groups the note into a conversation. No FEP-e232 link tags here: a
339 // mention row keeps the resolved quote, not the raw tags.
340 tag: [{ type: 'Mention', href: me, name: myHandle }, ...(AP.timelineEmojis(m.emoji_json) || [])],
341 attachment: AP.timelineAttachments(m.media_json),
342 // FEP-633c: what kind of message this is. The wave is a gentle nudge from
343 // a guardian; the help request is the buoy. Both render differently.
344 'shaer:wave': m.wave ? true : undefined,
345 'shaer:helpRequest': m.help_request ? true : undefined,
346 'shaer:quote': AP.timelineQuote(m.quote_json),
347 'shaer:author': (m.actor_name || m.actor_handle || m.actor_icon) ? {
348 name: m.actor_name || undefined, handle: m.actor_handle || undefined,
349 icon: m.actor_icon || undefined, url: m.actor_url || undefined,
350 emojis: (() => { try { return m.actor_emoji_json ? JSON.parse(m.actor_emoji_json) : undefined; } catch { return undefined; } })(),
351 } : undefined,
352 'shaer:embed': embedsAllowed ? AP.timelineEmbed(m.embed_json, { playback: playbackAllowed }) : undefined,
353 },
354 }));
355 // Inbound REPLIES on your own posts: stored as interactions (the web's
356 // comment machinery), never as mentions, so this read missed them and a
357 // friend's reply arrived everywhere except in your app (Robins melding,
358 // 30-7). Same shape as the other legs; media/quotes ride the stored JSON.
359 const replies = AP.getReplyMessages(auth.site.slug, 60).map((m) => ({
360 id: `${m.object_uri}#create`,
361 type: 'Create',
362 actor: m.actor_uri,
363 published: AP.isoStamp(m.published || m.created_at),
364 object: {
365 id: m.object_uri,
366 type: 'Note',
367 attributedTo: m.actor_uri,
368 content: AP.stripLeadingMentions(m.content),
369 inReplyTo: m.parent_uri || `${base}/ap/notes/${m.post_id}`,
370 published: AP.isoStamp(m.published || m.created_at),
371 to: [me],
372 tag: [{ type: 'Mention', href: me, name: myHandle }, ...(AP.timelineEmojis(m.emoji_json) || [])],
373 attachment: AP.timelineAttachments(m.media_json),
374 'shaer:quote': AP.timelineQuote(m.quote_json),
375 'shaer:author': (m.actor_name || m.actor_handle || m.actor_icon) ? {
376 name: m.actor_name || undefined, handle: m.actor_handle || undefined,
377 icon: m.actor_icon || undefined, url: m.actor_url || undefined,
378 emojis: (() => { try { return m.actor_emoji_json ? JSON.parse(m.actor_emoji_json) : undefined; } catch { return undefined; } })(),
379 } : undefined,
380 'shaer:embed': embedsAllowed ? AP.timelineEmbed(m.embed_json, { playback: playbackAllowed }) : undefined,
381 },
382 }));
383 // Your OWN sent notes (replies and direct messages, ap_outbox): without
384 // them a reply existed everywhere except in your own app, Messages showed
385 // half a conversation, and a retry ran into the duplicate guard (Robins
386 // melding, 30-7). Served like the other legs: same shape, one parser.
387 const mine = AP.selfAuthor(base, auth.site);
388 const sent = AP.getSentNotes(base, auth.site, 60).map((n) => ({
389 id: `${n.id}#create`,
390 type: 'Create',
391 actor: me,
392 published: n.published,
393 // The leading mention anchor is addressing, not prose (the DM leg strips
394 // it the same way); the Mention tags built from the full content stay.
395 object: { ...n, content: AP.stripLeadingMentions(n.content), 'shaer:author': mine },
396 }));
397 // Newest first over all legs, so the app can keep treating this as one feed.
398 const items = [...posts, ...messages, ...replies, ...sent].sort((a, b) => String(b.published || '').localeCompare(String(a.published || '')));
399 AP.sendAP(res, {
400 '@context': AP.AP_CONTEXT,
401 id: `${base}/ap/users/${auth.site.slug}/inbox`,
402 type: 'OrderedCollection',
403 // What this account may do with what is in here (FEP-633c 5.6). Owner-only
404 // by construction, and never on the public actor document: it says
405 // something about a child, and only the child and its guardians need it.
406 'shaer:capabilities': {
407 'shaer:externalEmbeds': embedsAllowed,
408 'shaer:externalPlayback': playbackAllowed,
409 // Leaving the app is the same decision as playing inside it: with the
410 // gate shut a link is shown but not followed, so the door is closed too
411 // and not just the picture over it.
412 'shaer:externalLinks': playbackAllowed,
413 },
414 totalItems: items.length,
415 orderedItems: items,
416 });
417});
418
419// ── uploadMedia (owner only, AP C2S) ──────────────────────────────
420// The actor advertises endpoints.uploadMedia; this implements it. A bearer
421// scoped to this site uploads one image/audio/video (multipart field "file",
422// AP convention) into the same store the reply editor uses, and gets back
423// { url, mediaType, name } to attach on a note (e.g. the help-buoy capture).
424const AP_MEDIA_DIR = path.resolve(
425 process.env.REPLY_MEDIA_PATH ||
426 path.join(path.dirname(fileURLToPath(import.meta.url)), '..', '..', 'storage', 'media', 'reply-media')
427);
428fs.mkdirSync(AP_MEDIA_DIR, { recursive: true });
429const AP_MEDIA_EXT = new Set(['.jpg', '.jpeg', '.png', '.webp', '.gif', '.mp3', '.m4a', '.ogg', '.opus', '.flac', '.wav', '.mp4', '.webm', '.mov']);
430const apMediaUpload = multer({
431 storage: multer.diskStorage({
432 destination: (req, file, cb) => cb(null, AP_MEDIA_DIR),
433 filename: (req, file, cb) => cb(null, `${randomUUID()}${path.extname(file.originalname || '').toLowerCase()}`),
434 }),
435 limits: { fileSize: 32 * 1024 * 1024 },
436 fileFilter: (req, file, cb) => {
437 const ext = path.extname(file.originalname || '').toLowerCase();
438 if (!AP_MEDIA_EXT.has(ext)) return cb(new Error('Media must be an image, audio or video file'));
439 cb(null, true);
440 },
441});
442router.post('/ap/users/:slug/uploadMedia', (req, res) => {
443 const auth = OAuth.verifyBearer(req.headers.authorization);
444 if (!auth || auth.site.slug !== req.params.slug) return res.status(403).end();
445 apMediaUpload.single('file')(req, res, (err) => {
446 if (err) return res.status(400).json({ error: err.message });
447 if (!req.file) return res.status(400).json({ error: 'No file' });
448 const mime = String(req.file.mimetype || '');
449 if (!/^(image|audio|video)\//.test(mime)) {
450 try { fs.unlinkSync(req.file.path); } catch { /* best effort */ }
451 return res.status(400).json({ error: 'Media must be an image, audio or video file' });
452 }
453 // A video gets a poster frame next to it (shaer-zowq), best-effort and
454 // out of band: ffmpeg pulls one frame at 1s into <name>.poster.jpg. On a
455 // machine without ffmpeg nothing happens and nothing breaks; the clients
456 // fall back to extracting a frame natively.
457 if (mime.startsWith('video/')) {
458 // The bundled static build (ffmpeg-static) does the work, exactly like
459 // VideoCoverService and AudioTranscoder already do: Klonkt SHIPS its
460 // ffmpeg (Robins opmerking, 30-7), so nothing needs installing on any
461 // machine. Soft dependency + best-effort: absent stays silent, and
462 // FFMPEG_PATH can still override for an operator who wants a newer one.
463 Promise.all([import('child_process'), import('ffmpeg-static')]).then(([{ execFile }, ff]) => {
464 const bin = process.env.FFMPEG_PATH || ff.default;
465 if (!bin) return;
466 const poster = req.file.path + '.poster.jpg';
467 execFile(bin, ['-hide_banner', '-loglevel', 'error', '-y', '-ss', '1', '-i', req.file.path, '-frames:v', '1', '-vf', "scale='min(640,iw)':-2", poster],
468 { timeout: 30000 }, (e) => { if (e && e.code !== 'ENOENT') console.warn('[media] poster failed:', e.message); });
469 }).catch(() => { /* never blocks the upload */ });
470 }
471 // Audio gets the same courtesy (Robins vraag, 30-7: vrolijk de kale
472 // audio-tegel op): ffmpeg draws the waveform into <name>.poster.png.
473 // White on transparent, so the tile's own gradient stays the backdrop
474 // and every audio post keeps its own hue. The shape is bars, not the
475 // raw hairy wave (Robins tweede vraag): peak and average sampled into
476 // 57 columns (soft tip over bright core), blown up nearest-neighbor to
477 // 14px bars, and drawgrid ERASES 5px gaps (c=black@0 + replace=1 writes
478 // transparent pixels; h=2*ih keeps horizontal grid lines out of frame).
479 if (mime.startsWith('audio/')) {
480 Promise.all([import('child_process'), import('ffmpeg-static')]).then(([{ execFile }, ff]) => {
481 const bin = process.env.FFMPEG_PATH || ff.default;
482 if (!bin) return;
483 const poster = req.file.path + '.poster.png';
484 const graph = '[0:a]aformat=channel_layouts=mono,asplit[a][b];'
485 + '[a]showwavespic=s=57x256:colors=white@0.5:filter=peak:scale=sqrt:draw=full[pk];'
486 + '[b]showwavespic=s=57x256:colors=white:filter=average:scale=sqrt:draw=full[av];'
487 + '[pk][av]overlay=format=auto,scale=798:256:flags=neighbor,drawgrid=w=14:h=2*ih:t=5:c=black@0:replace=1';
488 execFile(bin, ['-hide_banner', '-loglevel', 'error', '-y', '-i', req.file.path, '-filter_complex', graph, '-frames:v', '1', poster],
489 { timeout: 30000 }, (e) => { if (e && e.code !== 'ENOENT') console.warn('[media] waveform failed:', e.message); });
490 }).catch(() => { /* never blocks the upload */ });
491 }
492 res.status(201).json({
493 url: '/media/reply-media/' + req.file.filename,
494 mediaType: mime,
495 name: String(req.file.originalname || '').slice(0, 120),
496 });
497 });
498});
499
500// ── Followers (count-only public, full for the owner) ─────────────
501// A C2S bearer scoped to this site (the account owner) gets the real actor
502// URIs so their own client can build a friends list; everyone else gets the
503// count only (privacy).
504// FEP-9876: enrichment is opt-in via `Prefer: return=representation` (RFC 7240).
505// Returns true and sets the response headers when the owner asked for it.
506function wantsEnriched(req, res) {
507 res.set('Vary', 'Prefer'); // enriched and bare are two representations
508 if (AP.prefersEnriched(req.get('Prefer'))) {
509 res.set('Preference-Applied', 'return=representation');
510 return true;
511 }
512 return false;
513}
514
515router.get('/ap/users/:slug/followers', (req, res) => {
516 const auth = OAuth.verifyBearer(req.headers.authorization);
517 const owner = auth && auth.site.slug === req.params.slug;
518 const site = owner ? auth.site : publicSite(req.params.slug);
519 if (!site) return res.status(404).end();
520 if (owner) {
521 const uris = db.prepare('SELECT actor_uri FROM ap_followers WHERE slug = ? ORDER BY created_at').all(site.slug).map((r) => r.actor_uri);
522 // Default = bare references; enrich only when the client asks (FEP-9876).
523 const items = wantsEnriched(req, res) ? uris.map((u) => AP.buildActorRef(site.slug, u)) : uris;
524 return AP.sendAP(res, AP.buildFollowers(baseUrl(req), site, items.length, items));
525 }
526 const n = db.prepare('SELECT COUNT(*) n FROM ap_followers WHERE slug = ?').get(site.slug).n;
527 AP.sendAP(res, AP.buildFollowers(baseUrl(req), site, n));
528});
529
530// ── Following (count-only public, full for the owner) ─────────────
531router.get('/ap/users/:slug/following', (req, res) => {
532 const auth = OAuth.verifyBearer(req.headers.authorization);
533 const owner = auth && auth.site.slug === req.params.slug;
534 const site = owner ? auth.site : publicSite(req.params.slug);
535 if (!site) return res.status(404).end();
536 if (owner) {
537 const enrich = wantsEnriched(req, res); // FEP-9876 opt-in
538 let items = [];
539 try {
540 const uris = db.prepare("SELECT actor_uri FROM ap_following WHERE slug = ? AND status = 'accepted' ORDER BY created_at").all(site.slug).map((r) => r.actor_uri);
541 items = enrich ? uris.map((u) => AP.buildActorRef(site.slug, u)) : uris;
542 } catch { /* table may not exist */ }
543 return AP.sendAP(res, AP.buildFollowing(baseUrl(req), site, items.length, items));
544 }
545 let n = 0;
546 try { n = db.prepare("SELECT COUNT(*) n FROM ap_following WHERE slug = ? AND status = 'accepted'").get(site.slug).n; } catch { /* table may not exist */ }
547 AP.sendAP(res, AP.buildFollowing(baseUrl(req), site, n));
548});
549
550// ── Featured (pinned posts → Mastodon "Featured" tab) ─────────────
551router.get('/ap/users/:slug/featured', (req, res) => {
552 const site = publicSite(req.params.slug);
553 if (!site) return res.status(404).end();
554 // NB: Mastodon DISPLAYS the featured collection in REVERSE (pins shown
555 // last-processed-first). So we emit it reversed (lowest pin priority first,
556 // rank 1 last) → Mastodon flips it back to pin-rank ascending on the profile.
557 const posts = db.prepare(
558 `SELECT id, slug, title, content, cover_image_url, cover_video_url, nsfw, content_warning, c2s_attachments, published_at, created_at
559 FROM posts WHERE site_id = ? AND status = 'published' AND (fan_only IS NULL OR fan_only = 0)
560 AND pinned IS NOT NULL AND pinned > 0
561 ORDER BY pinned DESC, COALESCE(published_at, created_at) ASC LIMIT 20`
562 ).all(site.id);
563 AP.sendAP(res, AP.buildFeatured(baseUrl(req), site, posts));
564});
565
566// ── Note ──────────────────────────────────────────────────────────
567router.get('/ap/notes/:id', (req, res) => {
568 const post = db.prepare(
569 "SELECT * FROM posts WHERE id = ? AND status = 'published' AND (fan_only IS NULL OR fan_only = 0)"
570 ).get(req.params.id);
571 if (!post) {
572 // Could be one of OUR outbound replies (ap_outbox), not a post.
573 const note = AP.getOutboxNote(baseUrl(req), req.params.id);
574 if (!note) return res.status(404).end();
575 if (!AP.apWants(req)) {
576 // A browser hit a reply's AP URL → send them to the source it replies to
577 // (where the post + its reactions live), falling back to the site home.
578 const src = (typeof note.inReplyTo === 'string' && /^https?:\/\//i.test(note.inReplyTo))
579 ? note.inReplyTo : (baseUrl(req) + '/');
580 return res.redirect(302, src);
581 }
582 return AP.sendAP(res, { '@context': AP.AP_CONTEXT, ...note });
583 }
584 const site = db.prepare('SELECT * FROM sites WHERE id = ?').get(post.site_id);
585 if (!site) return res.status(404).end();
586 const note = AP.buildNote(baseUrl(req), site, post);
587 if (!AP.apWants(req)) {
588 // A browser hit a post's AP note URL → send them to the human post page
589 // (which shows the post + its "from the fediverse" reactions).
590 return res.redirect(302, note.url || (baseUrl(req) + '/'));
591 }
592 AP.sendAP(res, { '@context': AP.AP_CONTEXT, ...note });
593});
594
595// ── Replies collection ── lets remote servers fetch a post's whole thread.
596router.get('/ap/notes/:id/replies', (req, res) => {
597 const base = baseUrl(req);
598 const items = AP.getReplyUris(base, req.params.id);
599 AP.sendAP(res, {
600 '@context': AP.AP_CONTEXT,
601 id: `${base}/ap/notes/${req.params.id}/replies`,
602 type: 'OrderedCollection',
603 totalItems: items.length,
604 orderedItems: items,
605 });
606});
607
608// ── NodeInfo ── standard instance metadata so fediverse tools recognise Klonkt.
609router.get('/.well-known/nodeinfo', (req, res) => {
610 res.type('application/json');
611 res.set('Cache-Control', 'public, max-age=3600');
612 res.send(JSON.stringify({ links: [{ rel: 'http://nodeinfo.diaspora.software/ns/schema/2.1', href: `${baseUrl(req)}/nodeinfo/2.1` }] }));
613});
614router.get('/nodeinfo/2.1', (req, res) => {
615 let users = 0; let posts = 0;
616 // "users" = public AP actors (sites), not the admin/member account rows.
617 try { users = db.prepare('SELECT COUNT(*) c FROM sites WHERE (is_public IS NULL OR is_public = 1)').get().c; } catch { /* */ }
618 try { posts = db.prepare("SELECT COUNT(*) c FROM posts WHERE status = 'published'").get().c; } catch { /* */ }
619 res.type('application/json; charset=utf-8');
620 res.set('Cache-Control', 'public, max-age=600');
621 res.send(JSON.stringify({
622 version: '2.1',
623 software: { name: 'klonkt', version: _ver, repository: 'https://github.com/roboburr/klonkt' },
624 protocols: ['activitypub'],
625 services: { inbound: [], outbound: [] },
626 openRegistrations: false,
627 usage: { users: { total: users }, localPosts: posts },
628 metadata: { nodeName: 'Klonkt' },
629 }));
630});
631
632// ── Inbox — Follow→Accept, Undo Follow (best-effort signature verify) ──
633const apJson = express.json({
634 type: ['application/activity+json', 'application/ld+json', 'application/json'],
635 limit: '1mb',
636 verify: (req, _res, buf) => { req.rawBody = buf; }, // raw body for digest verification
637});
638router.post(['/ap/users/:slug/inbox', '/ap/inbox'], apInboxLimiter, apJson, async (req, res) => {
639 try { return res.status(await AP.handleInbox(req, req.params.slug || null) || 202).end(); }
640 catch (e) { console.warn('[AP inbox] error:', e.message); return res.status(202).end(); }
641});
642
643// ── Outbox POST: ActivityPub Client-to-Server ─────────────────────
644// A bearer-authenticated client (Shaer) POSTs an activity; we translate it onto
645// the normal delivery machinery. The token is scoped to one user+site (OAuth
646// consent), so it must match the slug in the URL. (Declared after apJson, which
647// this shares with the inbox handler.)
648router.post('/ap/users/:slug/outbox', apInboxLimiter, apJson, async (req, res) => {
649 const auth = OAuth.verifyBearer(req.headers.authorization);
650 if (!auth) { res.set('WWW-Authenticate', 'Bearer'); return res.status(401).json({ error: 'invalid_token' }); }
651 if (auth.site.slug !== req.params.slug) return res.status(403).json({ error: 'wrong_site', detail: 'token is scoped to a different site' });
652 if (auth.user.readonly) return res.status(403).json({ error: 'read_only_account' });
653
654 const out = await AP.ingestOutboxActivity(auth.site, auth.user, req.body);
655 if (out.error) return res.status(out.status || 400).json({ error: out.error, detail: out.detail });
656 // 201 Created → Location header (AP spec); 202 Accepted for side-effect verbs.
657 if (out.status === 201 && out.url) res.set('Location', out.url);
658 return res.status(out.status || 202).json({ ok: true, id: out.id, url: out.url });
659});
660
661export default router;
Note: See TracBrowser for help on using the repository browser.