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

main
Last change on this file since f3a58a4 was 679924e, checked in by Bart <bart@โ€ฆ>, 5 weeks ago

WebFinger: de primaire site via de ene bron van waarheid

Een verse instance heeft geen primaire site: is_primary is 0 by default en de
backfill draait alleen op het moment dat de kolom erbij komt. Een site die
daarna wordt aangemaakt laat de instance dus zonder vlag achter.

De HTML-kant merkte daar niets van, want getPrimarySite() valt terug op de
oudste site. Deze route hield zijn eigen is_primary-only kopie aan, precies het
verspreide gedrag dat middleware/site.js zegt te hebben opgeruimd. Dus / gaf de
site en WebFinger gaf 404, uit dezelfde database, in hetzelfde verzoek.

Gevonden op instance loop (๐Ÿฉต.is.wildenvrij.nl): รฉรฉn site, slug "mee",
is_primary 0. De andere instances kunnen in dezelfde staat staan.

De nieuwe test zet alle vlaggen op 0 en eist dat een kale host dan nog steeds
de oudste site vindt.

Co-Authored-By: Claude Opus 5 <claude@โ€ฆ>

  • Property mode set to 100644
File size: 37.4 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));
256queueRoute('wards', (id, slug) => Guardianship.wardsCollection(id, slug));
257// Availability (FEP-633c 3.6.1) is never public: the ward reads its
258// guardians' real states here and nowhere else.
259queueRoute('guardians', (id, slug) => Guardianship.guardiansCollection(id, slug));
260
261// โ”€โ”€ Inbox read (owner only, AP C2S) โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€
262// GET on the inbox is part of ActivityPub C2S: the account owner (a bearer
263// scoped to this site) reads recent inbound posts (the timeline: accounts
264// they follow) as Create(Note) items, so an app (Shaer) can build a unified
265// feed. Anyone else gets 403; the inbox stays write-only for the public.
266router.get('/ap/users/:slug/inbox', (req, res) => {
267 const auth = OAuth.verifyBearer(req.headers.authorization);
268 if (!auth || auth.site.slug !== req.params.slug) return res.status(403).end();
269 const base = baseUrl(req);
270 // Gated feature (FEP-633c): may this account see EXTERNAL embeds? A ward's
271 // world outside the fediverse is the guardians' call. The gate is applied
272 // here, at serialisation: a blocked embed is never sent, because an embed the
273 // client merely hides has still been delivered to the device.
274 const isWard = (() => { try { return Guardianship.listGuardians(auth.site.slug).length > 0; } catch { return false; } })();
275 const embedsAllowed = Guardianship.externalEmbedsAllowed(auth.site.external_embeds, isWard);
276 // The heavier sibling (5.6): may a third party's PLAYER run inside the app,
277 // and may a link hand the child over to a browser? Both are the guardians'
278 // call, both default to off for a ward, and both need the preview gate open
279 // first: you cannot play, or follow, what you may not see. Served here so
280 // the app knows what it may offer instead of guessing.
281 const playbackAllowed = embedsAllowed
282 && Guardianship.externalPlaybackAllowed(auth.site.external_playback, isWard);
283 const posts = AP.getTimeline(auth.site.slug, 60).map((t) => ({
284 id: `${t.id}#create`,
285 type: 'Create',
286 actor: t.author_uri,
287 published: t.published || t.created_at || undefined,
288 object: {
289 id: t.id,
290 type: 'Note',
291 attributedTo: t.author_uri,
292 content: t.content,
293 url: t.url || undefined,
294 published: t.published || t.created_at || undefined,
295 sensitive: !!t.nsfw,
296 summary: t.cw || undefined,
297 // Friends' media travels along (media_json โ†’ AS2 attachment), so the
298 // client renders their images/audio like own outbox posts.
299 attachment: AP.timelineAttachments(t.media_json),
300 // The note's preserved tags, so the client can render them: FEP-9098
301 // Emoji tags (:shortcode: โ†’ image) and FEP-e232 Link tags (quotes /
302 // inline object references). Combined into one `tag` array; omitted
303 // when the note has neither.
304 tag: (() => {
305 const tags = [...(AP.timelineEmojis(t.emoji_json) || []), ...(AP.timelineObjectLinks(t.link_json) || [])];
306 return tags.length ? tags : undefined;
307 })(),
308 // FEP-044f: the resolved quoted post (author + content), so the client
309 // renders an embedded quote card instead of a bare link. Omitted when the
310 // note has no quote or the quoted post could not be resolved.
311 'shaer:quote': AP.timelineQuote(t.quote_json),
312 // The post author's display info (name / @handle / avatar), so every card
313 // gets a byline header like the quote card. attributedTo stays the bare
314 // actor URI; this is the resolved presentation Klonkt already stored.
315 'shaer:author': (t.author_name || t.author_handle || t.author_icon) ? {
316 name: t.author_name || undefined, handle: t.author_handle || undefined,
317 icon: t.author_icon || undefined, url: t.author_url || undefined,
318 // FEP-9098: emojis in the display name (":shortcode:"), if any.
319 emojis: (() => { try { return t.author_emoji_json ? JSON.parse(t.author_emoji_json) : undefined; } catch { return undefined; } })(),
320 } : undefined,
321 // When a followed account boosted this, who did ("X boosted"). Omitted for
322 // ordinary posts.
323 'shaer:booster': (t.reblog_name || t.reblog_handle || t.reblog_icon) ? {
324 name: t.reblog_name || undefined, handle: t.reblog_handle || undefined,
325 icon: t.reblog_icon || undefined,
326 // FEP-9098: emojis in the booster's display name (":shortcode:"), if any.
327 emojis: (() => { try { return t.reblog_emoji_json ? JSON.parse(t.reblog_emoji_json) : undefined; } catch { return undefined; } })(),
328 } : undefined,
329 // Whether THIS account already liked/boosted the note, so the app's
330 // detail-view buttons show the current state (and can toggle/undo).
331 'shaer:liked': !!t.liked,
332 'shaer:boosted': !!t.boosted,
333 // An external (non-fediverse) embed, thumbnail-only and never an iframe.
334 // Omitted entirely when the gate is closed (see above).
335 // Carries shaer:playerUrl only when the playback gate is open too.
336 'shaer:embed': embedsAllowed ? AP.timelineEmbed(t.embed_json, { playback: playbackAllowed }) : undefined,
337 },
338 }));
339 // The direct notes addressed to this account: a plain DM, a guardian's wave
340 // (ยง5), a ward's ๐Ÿ›Ÿ help request (ยง5.2.1). Those are messages, not posts, so
341 // they are not in the timeline; without them the app's Berichten shows only
342 // what you said yourself. Same shape as a post, so one parser handles both.
343 const me = AP.actorId(base, auth.site.slug);
344 const myHandle = (() => { try { return `@${auth.site.slug}@${new URL(base).host}`; } catch { return `@${auth.site.slug}`; } })();
345 const messages = AP.getDirectMessages(auth.site.slug, 60).map((m) => ({
346 id: `${m.object_uri}#create`,
347 type: 'Create',
348 actor: m.actor_uri,
349 published: AP.isoStamp(m.published || m.created_at),
350 object: {
351 id: m.object_uri,
352 type: 'Note',
353 attributedTo: m.actor_uri,
354 content: AP.stripLeadingMentions(m.content),
355 url: m.note_url || undefined,
356 published: AP.isoStamp(m.published || m.created_at),
357 // Addressed to us and to nobody we know of: the other recipients of a
358 // note to several people are not ours to see, so we serve what we know.
359 to: [me],
360 // The Mention is how the client recognises itself as the addressee and
361 // groups the note into a conversation. No FEP-e232 link tags here: a
362 // mention row keeps the resolved quote, not the raw tags.
363 tag: [{ type: 'Mention', href: me, name: myHandle }, ...(AP.timelineEmojis(m.emoji_json) || [])],
364 attachment: AP.timelineAttachments(m.media_json),
365 // FEP-633c: what kind of message this is. The wave is a gentle nudge from
366 // a guardian; the help request is the buoy. Both render differently.
367 'shaer:wave': m.wave ? true : undefined,
368 'shaer:helpRequest': m.help_request ? true : undefined,
369 'shaer:quote': AP.timelineQuote(m.quote_json),
370 'shaer:author': (m.actor_name || m.actor_handle || m.actor_icon) ? {
371 name: m.actor_name || undefined, handle: m.actor_handle || undefined,
372 icon: m.actor_icon || undefined, url: m.actor_url || undefined,
373 emojis: (() => { try { return m.actor_emoji_json ? JSON.parse(m.actor_emoji_json) : undefined; } catch { return undefined; } })(),
374 } : undefined,
375 'shaer:embed': embedsAllowed ? AP.timelineEmbed(m.embed_json, { playback: playbackAllowed }) : undefined,
376 },
377 }));
378 // Inbound REPLIES on your own posts: stored as interactions (the web's
379 // comment machinery), never as mentions, so this read missed them and a
380 // friend's reply arrived everywhere except in your app (Robins melding,
381 // 30-7). Same shape as the other legs; media/quotes ride the stored JSON.
382 const replies = AP.getReplyMessages(auth.site.slug, 60).map((m) => ({
383 id: `${m.object_uri}#create`,
384 type: 'Create',
385 actor: m.actor_uri,
386 published: AP.isoStamp(m.published || m.created_at),
387 object: {
388 id: m.object_uri,
389 type: 'Note',
390 attributedTo: m.actor_uri,
391 content: AP.stripLeadingMentions(m.content),
392 inReplyTo: m.parent_uri || `${base}/ap/notes/${m.post_id}`,
393 published: AP.isoStamp(m.published || m.created_at),
394 to: [me],
395 tag: [{ type: 'Mention', href: me, name: myHandle }, ...(AP.timelineEmojis(m.emoji_json) || [])],
396 attachment: AP.timelineAttachments(m.media_json),
397 'shaer:quote': AP.timelineQuote(m.quote_json),
398 'shaer:author': (m.actor_name || m.actor_handle || m.actor_icon) ? {
399 name: m.actor_name || undefined, handle: m.actor_handle || undefined,
400 icon: m.actor_icon || undefined, url: m.actor_url || undefined,
401 emojis: (() => { try { return m.actor_emoji_json ? JSON.parse(m.actor_emoji_json) : undefined; } catch { return undefined; } })(),
402 } : undefined,
403 'shaer:embed': embedsAllowed ? AP.timelineEmbed(m.embed_json, { playback: playbackAllowed }) : undefined,
404 },
405 }));
406 // Your OWN sent notes (replies and direct messages, ap_outbox): without
407 // them a reply existed everywhere except in your own app, Messages showed
408 // half a conversation, and a retry ran into the duplicate guard (Robins
409 // melding, 30-7). Served like the other legs: same shape, one parser.
410 const mine = AP.selfAuthor(base, auth.site);
411 const sent = AP.getSentNotes(base, auth.site, 60).map((n) => ({
412 id: `${n.id}#create`,
413 type: 'Create',
414 actor: me,
415 published: n.published,
416 // The leading mention anchor is addressing, not prose (the DM leg strips
417 // it the same way); the Mention tags built from the full content stay.
418 object: { ...n, content: AP.stripLeadingMentions(n.content), 'shaer:author': mine },
419 }));
420 // Newest first over all legs, so the app can keep treating this as one feed.
421 const items = [...posts, ...messages, ...replies, ...sent].sort((a, b) => String(b.published || '').localeCompare(String(a.published || '')));
422 AP.sendAP(res, {
423 '@context': AP.AP_CONTEXT,
424 id: `${base}/ap/users/${auth.site.slug}/inbox`,
425 type: 'OrderedCollection',
426 // What this account may do with what is in here (FEP-633c 5.6). Owner-only
427 // by construction, and never on the public actor document: it says
428 // something about a child, and only the child and its guardians need it.
429 'shaer:capabilities': {
430 'shaer:externalEmbeds': embedsAllowed,
431 'shaer:externalPlayback': playbackAllowed,
432 // Leaving the app is the same decision as playing inside it: with the
433 // gate shut a link is shown but not followed, so the door is closed too
434 // and not just the picture over it.
435 'shaer:externalLinks': playbackAllowed,
436 },
437 totalItems: items.length,
438 orderedItems: items,
439 });
440});
441
442// โ”€โ”€ uploadMedia (owner only, AP C2S) โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€
443// The actor advertises endpoints.uploadMedia; this implements it. A bearer
444// scoped to this site uploads one image/audio/video (multipart field "file",
445// AP convention) into the same store the reply editor uses, and gets back
446// { url, mediaType, name } to attach on a note (e.g. the help-buoy capture).
447const AP_MEDIA_DIR = mediaDir('REPLY_MEDIA_PATH', 'reply-media');
448fs.mkdirSync(AP_MEDIA_DIR, { recursive: true });
449const AP_MEDIA_EXT = new Set(['.jpg', '.jpeg', '.png', '.webp', '.gif', '.mp3', '.m4a', '.ogg', '.opus', '.flac', '.wav', '.mp4', '.webm', '.mov']);
450const apMediaUpload = multer({
451 storage: multer.diskStorage({
452 destination: (req, file, cb) => cb(null, AP_MEDIA_DIR),
453 filename: (req, file, cb) => cb(null, `${randomUUID()}${path.extname(file.originalname || '').toLowerCase()}`),
454 }),
455 limits: { fileSize: 32 * 1024 * 1024 },
456 fileFilter: (req, file, cb) => {
457 const ext = path.extname(file.originalname || '').toLowerCase();
458 if (!AP_MEDIA_EXT.has(ext)) return cb(new Error('Media must be an image, audio or video file'));
459 cb(null, true);
460 },
461});
462router.post('/ap/users/:slug/uploadMedia', (req, res) => {
463 const auth = OAuth.verifyBearer(req.headers.authorization);
464 if (!auth || auth.site.slug !== req.params.slug) return res.status(403).end();
465 apMediaUpload.single('file')(req, res, (err) => {
466 if (err) return res.status(400).json({ error: err.message });
467 if (!req.file) return res.status(400).json({ error: 'No file' });
468 const mime = String(req.file.mimetype || '');
469 if (!/^(image|audio|video)\//.test(mime)) {
470 try { fs.unlinkSync(req.file.path); } catch { /* best effort */ }
471 return res.status(400).json({ error: 'Media must be an image, audio or video file' });
472 }
473 // A video gets a poster frame next to it (shaer-zowq), best-effort and
474 // out of band: ffmpeg pulls one frame at 1s into <name>.poster.jpg. On a
475 // machine without ffmpeg nothing happens and nothing breaks; the clients
476 // fall back to extracting a frame natively.
477 if (mime.startsWith('video/')) {
478 // The bundled static build (ffmpeg-static) does the work, exactly like
479 // VideoCoverService and AudioTranscoder already do: Klonkt SHIPS its
480 // ffmpeg (Robins opmerking, 30-7), so nothing needs installing on any
481 // machine. Soft dependency + best-effort: absent stays silent, and
482 // FFMPEG_PATH can still override for an operator who wants a newer one.
483 Promise.all([import('child_process'), import('ffmpeg-static')]).then(([{ execFile }, ff]) => {
484 const bin = process.env.FFMPEG_PATH || ff.default;
485 if (!bin) return;
486 const poster = req.file.path + '.poster.jpg';
487 execFile(bin, ['-hide_banner', '-loglevel', 'error', '-y', '-ss', '1', '-i', req.file.path, '-frames:v', '1', '-vf', "scale='min(640,iw)':-2", poster],
488 { timeout: 30000 }, (e) => { if (e && e.code !== 'ENOENT') console.warn('[media] poster failed:', e.message); });
489 }).catch(() => { /* never blocks the upload */ });
490 }
491 // Audio gets the same courtesy (Robins vraag, 30-7: vrolijk de kale
492 // audio-tegel op): ffmpeg draws the waveform into <name>.poster.png.
493 // White on transparent, so the tile's own gradient stays the backdrop
494 // and every audio post keeps its own hue. The shape is bars, not the
495 // raw hairy wave (Robins tweede vraag): peak and average sampled into
496 // 57 columns (soft tip over bright core), blown up nearest-neighbor to
497 // 14px bars, and drawgrid ERASES 5px gaps (c=black@0 + replace=1 writes
498 // transparent pixels; h=2*ih keeps horizontal grid lines out of frame).
499 if (mime.startsWith('audio/')) {
500 Promise.all([import('child_process'), import('ffmpeg-static')]).then(([{ execFile }, ff]) => {
501 const bin = process.env.FFMPEG_PATH || ff.default;
502 if (!bin) return;
503 const poster = req.file.path + '.poster.png';
504 const graph = '[0:a]aformat=channel_layouts=mono,asplit[a][b];'
505 + '[a]showwavespic=s=57x256:colors=white@0.5:filter=peak:scale=sqrt:draw=full[pk];'
506 + '[b]showwavespic=s=57x256:colors=white:filter=average:scale=sqrt:draw=full[av];'
507 + '[pk][av]overlay=format=auto,scale=798:256:flags=neighbor,drawgrid=w=14:h=2*ih:t=5:c=black@0:replace=1';
508 execFile(bin, ['-hide_banner', '-loglevel', 'error', '-y', '-i', req.file.path, '-filter_complex', graph, '-frames:v', '1', poster],
509 { timeout: 30000 }, (e) => { if (e && e.code !== 'ENOENT') console.warn('[media] waveform failed:', e.message); });
510 }).catch(() => { /* never blocks the upload */ });
511 }
512 res.status(201).json({
513 url: '/media/reply-media/' + req.file.filename,
514 mediaType: mime,
515 name: String(req.file.originalname || '').slice(0, 120),
516 });
517 });
518});
519
520// โ”€โ”€ Followers (count-only public, full for the owner) โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€
521// A C2S bearer scoped to this site (the account owner) gets the real actor
522// URIs so their own client can build a friends list; everyone else gets the
523// count only (privacy).
524// FEP-9876: enrichment is opt-in via `Prefer: return=representation` (RFC 7240).
525// Returns true and sets the response headers when the owner asked for it.
526function wantsEnriched(req, res) {
527 res.set('Vary', 'Prefer'); // enriched and bare are two representations
528 if (AP.prefersEnriched(req.get('Prefer'))) {
529 res.set('Preference-Applied', 'return=representation');
530 return true;
531 }
532 return false;
533}
534
535router.get('/ap/users/:slug/followers', (req, res) => {
536 const auth = OAuth.verifyBearer(req.headers.authorization);
537 const owner = auth && auth.site.slug === req.params.slug;
538 const site = owner ? auth.site : publicSite(req.params.slug);
539 if (!site) return res.status(404).end();
540 if (owner) {
541 const uris = db.prepare('SELECT actor_uri FROM ap_followers WHERE slug = ? ORDER BY created_at').all(site.slug).map((r) => r.actor_uri);
542 // Default = bare references; enrich only when the client asks (FEP-9876).
543 const items = wantsEnriched(req, res) ? uris.map((u) => AP.buildActorRef(site.slug, u)) : uris;
544 return AP.sendAP(res, AP.buildFollowers(baseUrl(req), site, items.length, items));
545 }
546 const n = db.prepare('SELECT COUNT(*) n FROM ap_followers WHERE slug = ?').get(site.slug).n;
547 AP.sendAP(res, AP.buildFollowers(baseUrl(req), site, n));
548});
549
550// โ”€โ”€ Following (count-only public, full for the owner) โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€
551router.get('/ap/users/:slug/following', (req, res) => {
552 const auth = OAuth.verifyBearer(req.headers.authorization);
553 const owner = auth && auth.site.slug === req.params.slug;
554 const site = owner ? auth.site : publicSite(req.params.slug);
555 if (!site) return res.status(404).end();
556 if (owner) {
557 const enrich = wantsEnriched(req, res); // FEP-9876 opt-in
558 let items = [];
559 try {
560 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);
561 items = enrich ? uris.map((u) => AP.buildActorRef(site.slug, u)) : uris;
562 } catch { /* table may not exist */ }
563 return AP.sendAP(res, AP.buildFollowing(baseUrl(req), site, items.length, items));
564 }
565 let n = 0;
566 try { n = db.prepare("SELECT COUNT(*) n FROM ap_following WHERE slug = ? AND status = 'accepted'").get(site.slug).n; } catch { /* table may not exist */ }
567 AP.sendAP(res, AP.buildFollowing(baseUrl(req), site, n));
568});
569
570// โ”€โ”€ Featured (pinned posts โ†’ Mastodon "Featured" tab) โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€
571router.get('/ap/users/:slug/featured', (req, res) => {
572 const site = publicSite(req.params.slug);
573 if (!site) return res.status(404).end();
574 // NB: Mastodon DISPLAYS the featured collection in REVERSE (pins shown
575 // last-processed-first). So we emit it reversed (lowest pin priority first,
576 // rank 1 last) โ†’ Mastodon flips it back to pin-rank ascending on the profile.
577 const posts = db.prepare(
578 `SELECT id, slug, title, content, cover_image_url, cover_video_url, nsfw, content_warning, c2s_attachments, published_at, created_at
579 FROM posts WHERE site_id = ? AND status = 'published' AND (fan_only IS NULL OR fan_only = 0)
580 AND pinned IS NOT NULL AND pinned > 0
581 ORDER BY pinned DESC, COALESCE(published_at, created_at) ASC LIMIT 20`
582 ).all(site.id);
583 AP.sendAP(res, AP.buildFeatured(baseUrl(req), site, posts));
584});
585
586// โ”€โ”€ Note โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€
587router.get('/ap/notes/:id', (req, res) => {
588 const post = db.prepare(
589 "SELECT * FROM posts WHERE id = ? AND status = 'published' AND (fan_only IS NULL OR fan_only = 0)"
590 ).get(req.params.id);
591 if (!post) {
592 // Could be one of OUR outbound replies (ap_outbox), not a post.
593 const note = AP.getOutboxNote(baseUrl(req), req.params.id);
594 if (!note) return res.status(404).end();
595 if (!AP.apWants(req)) {
596 // A browser hit a reply's AP URL โ†’ send them to the source it replies to
597 // (where the post + its reactions live), falling back to the site home.
598 const src = (typeof note.inReplyTo === 'string' && /^https?:\/\//i.test(note.inReplyTo))
599 ? note.inReplyTo : (baseUrl(req) + '/');
600 return res.redirect(302, src);
601 }
602 return AP.sendAP(res, { '@context': AP.AP_CONTEXT, ...note });
603 }
604 const site = db.prepare('SELECT * FROM sites WHERE id = ?').get(post.site_id);
605 if (!site) return res.status(404).end();
606 const note = AP.buildNote(baseUrl(req), site, post);
607 if (!AP.apWants(req)) {
608 // A browser hit a post's AP note URL โ†’ send them to the human post page
609 // (which shows the post + its "from the fediverse" reactions).
610 return res.redirect(302, note.url || (baseUrl(req) + '/'));
611 }
612 AP.sendAP(res, { '@context': AP.AP_CONTEXT, ...note });
613});
614
615// โ”€โ”€ Replies collection โ”€โ”€ lets remote servers fetch a post's whole thread.
616router.get('/ap/notes/:id/replies', (req, res) => {
617 const base = baseUrl(req);
618 const items = AP.getReplyUris(base, req.params.id);
619 AP.sendAP(res, {
620 '@context': AP.AP_CONTEXT,
621 id: `${base}/ap/notes/${req.params.id}/replies`,
622 type: 'OrderedCollection',
623 totalItems: items.length,
624 orderedItems: items,
625 });
626});
627
628// โ”€โ”€ NodeInfo โ”€โ”€ standard instance metadata so fediverse tools recognise Klonkt.
629router.get('/.well-known/nodeinfo', (req, res) => {
630 res.type('application/json');
631 res.set('Cache-Control', 'public, max-age=3600');
632 res.send(JSON.stringify({ links: [{ rel: 'http://nodeinfo.diaspora.software/ns/schema/2.1', href: `${baseUrl(req)}/nodeinfo/2.1` }] }));
633});
634router.get('/nodeinfo/2.1', (req, res) => {
635 let users = 0; let posts = 0;
636 // "users" = public AP actors (sites), not the admin/member account rows.
637 try { users = db.prepare('SELECT COUNT(*) c FROM sites WHERE (is_public IS NULL OR is_public = 1)').get().c; } catch { /* */ }
638 try { posts = db.prepare("SELECT COUNT(*) c FROM posts WHERE status = 'published'").get().c; } catch { /* */ }
639 res.type('application/json; charset=utf-8');
640 res.set('Cache-Control', 'public, max-age=600');
641 res.send(JSON.stringify({
642 version: '2.1',
643 software: { name: 'klonkt', version: _ver, repository: 'https://github.com/roboburr/klonkt' },
644 protocols: ['activitypub'],
645 services: { inbound: [], outbound: [] },
646 openRegistrations: false,
647 usage: { users: { total: users }, localPosts: posts },
648 metadata: { nodeName: 'Klonkt' },
649 }));
650});
651
652// โ”€โ”€ Inbox โ€” Followโ†’Accept, Undo Follow (best-effort signature verify) โ”€โ”€
653const apJson = express.json({
654 type: ['application/activity+json', 'application/ld+json', 'application/json'],
655 limit: '1mb',
656 verify: (req, _res, buf) => { req.rawBody = buf; }, // raw body for digest verification
657});
658router.post(['/ap/users/:slug/inbox', '/ap/inbox'], apInboxLimiter, apJson, async (req, res) => {
659 try { return res.status(await AP.handleInbox(req, req.params.slug || null) || 202).end(); }
660 catch (e) { console.warn('[AP inbox] error:', e.message); return res.status(202).end(); }
661});
662
663// โ”€โ”€ Outbox POST: ActivityPub Client-to-Server โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€
664// A bearer-authenticated client (Shaer) POSTs an activity; we translate it onto
665// the normal delivery machinery. The token is scoped to one user+site (OAuth
666// consent), so it must match the slug in the URL. (Declared after apJson, which
667// this shares with the inbox handler.)
668router.post('/ap/users/:slug/outbox', apInboxLimiter, apJson, async (req, res) => {
669 const auth = OAuth.verifyBearer(req.headers.authorization);
670 if (!auth) { res.set('WWW-Authenticate', 'Bearer'); return res.status(401).json({ error: 'invalid_token' }); }
671 if (auth.site.slug !== req.params.slug) return res.status(403).json({ error: 'wrong_site', detail: 'token is scoped to a different site' });
672 if (auth.user.readonly) return res.status(403).json({ error: 'read_only_account' });
673
674 const out = await AP.ingestOutboxActivity(auth.site, auth.user, req.body);
675 if (out.error) return res.status(out.status || 400).json({ error: out.error, detail: out.detail });
676 // 201 Created โ†’ Location header (AP spec); 202 Accepted for side-effect verbs.
677 if (out.status === 201 && out.url) res.set('Location', out.url);
678 return res.status(out.status || 202).json({ ok: true, id: out.id, url: out.url });
679});
680
681export default router;
Note: See TracBrowser for help on using the repository browser.