source: Klonkt/src/routes/activitypub.js@ fa33214

main
Last change on this file since fa33214 was fa33214, checked in by Bart <bart@…>, 5 weeks ago

FEP-633c §5.3 andersom: een ward vraagt eerst of het iemand mag volgen

Uitgaande follows gingen ongehinderd de deur uit; de guardians kregen achteraf
een bericht (1a2f206). Dat is informeren, niet gaten — de deur staat al open als
het bericht aankomt. Bead shaer-p729, ontwerp in
docs/ward-outbound-follows-design.md.

De regel: per geval goedkeuring, met twee uitzonderingen die geen gunst zijn
maar dezelfde beslissing die al genomen is. Je eigen guardian volgen is geen
vraag. En iemand die de ward al volgt DOOR DE POORT heen is door een guardian
bij naam goedgekeurd; die vraag nog eens stellen leert mensen alleen om de vraag
niet meer te lezen.

Daarvoor moet je weten wie er door de poort kwam, dus ap_followers krijgt
gate_approved, gezet bij acceptGatedFollow. Iedereen die al volgde toen die
kolom erbij kwam wordt eenmalig gegrandfatherd (Barts besluit): exact vanaf nu,
in plaats van met terugwerkende kracht wantrouwig tegen wat er al was.

Eigen tabel, want ap_pending_follows is gesleuteld met de ward als DOEL. Eigen
wachtrij (outgoingFollows), want een guardian moet "iemand wil je ward volgen"
kunnen onderscheiden van "je ward wil iemand volgen" — de AS2-test ving netjes
dat de nieuwe term aangemeld moest worden. En een tegengehouden follow reist als
derde uitkomst naar de app (state: awaiting_guardian), zodat Shaer "wacht op
toestemming" kan tonen in plaats van een tegel die er al volgend uitziet.

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

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