fedipod 1.43.0 → 1.44.0

package/web/app/forum-form.mjs

@@ -0,0 +1,38 @@
+// forum-form.mjs — what the sign-up page's forum fields say, read into what
+// the forum is made from. No imports, so a test reads it as the page does.
+
+export const SLUG = /^[a-z0-9][a-z0-9-]{0,62}$/u;
+
+// One category per line: a short name for the address, then a colon and the
+// name readers see; a line with no colon is both.
+export function categoriesFrom(text) {
+  const lines = String(text || '').split('\n').map((l) => l.trim()).filter(Boolean);
+  if (!lines.length) throw new Error('Categories: at least one is required.');
+  const out = [];
+  const seen = new Set();
+  for (const line of lines) {
+    const i = line.indexOf(':');
+    const slug = (i < 0 ? line : line.slice(0, i)).trim().toLowerCase();
+    const name = (i < 0 ? '' : line.slice(i + 1)).trim() || slug;
+    if (!SLUG.test(slug)) throw new Error(`Categories: "${slug}" is not a short name. Letters, digits and hyphens, starting with a letter or digit.`);
+    if (seen.has(slug)) throw new Error(`Categories: "${slug}" is listed twice.`);
+    seen.add(slug);
+    out.push({ slug, name: name.slice(0, 200) });
+  }
+  return out;
+}
+
+// Who moderates, as an actor id: an address at this site, or a web address
+// given outright. Empty is nobody named yet.
+export function moderatorFrom(text, frontOrigin) {
+  const s = String(text || '').trim();
+  if (!s) return null;
+  if (/^https?:\/\//iu.test(s)) {
+    try { return new URL(s).href; } catch { throw new Error('Moderator: not a valid web address.'); }
+  }
+  const m = /^@?([a-z0-9][a-z0-9._-]*)@([a-z0-9.-]+(?::\d+)?)$/iu.exec(s);
+  if (!m) throw new Error('Moderator: write it as @name@server, or as a web address.');
+  const front = frontOrigin ? new URL(frontOrigin) : null;
+  if (front && m[2].toLowerCase() === front.host.toLowerCase()) return `${front.origin}/u/${m[1].toLowerCase()}/ap/actor`;
+  throw new Error(`Moderator: only an address at ${front ? front.host : 'this site'} can be named here. Others can be added on the forum's settings page.`);
+}

package/web/app/forum-support.mjs

@@ -0,0 +1,11 @@
+// forum-support.mjs — whether this site's sign-up page offers a forum. The
+// page's own code never imports the forum; this file is the one place that
+// names the forum's setup module, and the page hides the choice when it is
+// null. The counterpart of netlify/forum-support.mjs, which decides whether
+// the Gateway behind this page keeps forums: the two go together.
+//
+//   with forums     import * as setup from '../../packages/fedipod-bb/src/setup.mjs'; export default setup;
+//   without forums  export default null;
+
+import * as setup from '../../packages/fedipod-bb/src/setup.mjs';
+export default setup;

package/web/app/index.html

@@ -41,13 +41,14 @@ code { background: rgba(120,120,120,.18); padding: .05em .35em; border-radius: 4
 fieldset { border: 1px solid var(--line); border-radius: .4rem; margin: 1rem 0; padding: .75rem 1rem 1rem; }
 legend { padding: 0 .3rem; font-weight: 600; }
 label { display: block; margin: .75rem 0 .2rem; }
-input[type=text], input[type=email], input[type=url], input[type=password], select {
+input[type=text], input[type=email], input[type=url], input[type=password], select, textarea {
   font: inherit; font-size: 1rem; width: 100%; padding: .55rem; box-sizing: border-box;
   border: 1px solid var(--field-border); border-radius: .3rem;
   background: var(--field-bg); color: var(--field-text); }
 /* A list to pick from looks different from a box to type in: its own tint,
    the accent border, and the same on its options. */
 select { background: var(--select-bg); border-color: var(--select-border); }
+textarea { min-height: 6.5rem; resize: vertical; }
 select option { background: var(--select-bg); color: var(--field-text); }
 ::placeholder { color: var(--sub); opacity: 1; }
 .choice { display: block; margin: .4rem 0; font-weight: normal; }
@@ -145,6 +146,14 @@ a { color: var(--accent); }
       <fieldset>
         <legend>Your Solid Pod</legend>
 
+        <div role="radiogroup" aria-labelledby="making-label" id="making-group">
+          <span id="making-label" class="grouplabel">What you are making</span>
+          <label class="choice"><input type="radio" name="making" value="account" checked> An account for yourself</label>
+          <label class="choice"><input type="radio" name="making" value="forum"> A forum</label>
+          <p class="hint" id="making-hint" hidden>A forum has a pod of its own. Make a new pod for it at the
+            provider, or sign in with a pod that holds nothing else. The forum's address will be at this site.</p>
+        </div>
+
         <div role="radiogroup" aria-labelledby="podtype-label">
           <span id="podtype-label" class="grouplabel">Pod type</span>
           <label class="choice"><input type="radio" name="mode" value="existing"> An existing pod</label>
@@ -186,7 +195,7 @@ a { color: var(--accent); }
     <!-- Screen 2: Your Fediverse Identity — shown on return from the pod's login -->
     <div class="step" id="step-2" hidden>
       <fieldset>
-        <legend>Your Fediverse Identity</legend>
+        <legend id="identity-legend">Your Fediverse Identity</legend>
 
         <span id="signed-pod-label" class="grouplabel">Your pod</span>
         <p id="signed-pod" role="status" aria-labelledby="signed-pod-label"></p>
@@ -204,12 +213,27 @@ a { color: var(--accent); }
           Your posts, followers and key come with you, and your followers are told the
           new address. Keep the same handle, or choose a new one here.</p>
 
-        <label for="handle">Fediverse handle</label>
+        <label for="handle" id="handle-label">Fediverse handle</label>
         <input type="text" id="handle" name="handle" autocomplete="off"
           placeholder="the handle part of your address: @HANDLE@server" aria-describedby="handle-hint">
         <p class="hint" id="handle-hint">The name in your Fediverse address. This is permanent.
           Letters, digits, and hyphens only.</p>
 
+        <div id="forum-fields" hidden>
+          <label for="forumName">Forum name</label>
+          <input type="text" id="forumName" name="forumName" autocomplete="off" placeholder="The name readers see">
+          <label for="categories">Categories, one per line</label>
+          <textarea id="categories" name="categories" autocomplete="off" spellcheck="false" aria-describedby="categories-hint"
+            placeholder="general: General Discussion&#10;software: Software"></textarea>
+          <p class="hint" id="categories-hint">Each line is a short name for the category's address, then a colon and
+            the name readers see. Short names are letters, digits and hyphens, and are permanent.</p>
+          <label for="moderator">Your address at this site, to moderate the forum as</label>
+          <input type="text" id="moderator" name="moderator" autocomplete="off" spellcheck="false" aria-describedby="moderator-hint"
+            placeholder="@you@this-site">
+          <p class="hint" id="moderator-hint">Optional. Signing in with the forum's own pod moderates too. More
+            moderators can be named on the forum's settings page later.</p>
+        </div>
+
         <div role="radiogroup" aria-labelledby="shape-label" id="shape-group">
           <span id="shape-label" class="grouplabel">Where your address lives</span>
           <label class="choice"><input type="radio" name="shape" value="pod" checked> On your pod</label>
@@ -221,7 +245,7 @@ a { color: var(--accent); }
         <span id="addr-label" class="grouplabel">Your Fediverse address</span>
         <p class="address" id="preview" role="status" aria-live="polite" aria-labelledby="addr-label">@…@…</p>
       </fieldset>
-      <p class="hint">The handle and the pod cannot be changed afterwards. Everything else — display
+      <p class="hint" id="after-hint">The handle and the pod cannot be changed afterwards. Everything else — display
         name, bio, pictures — you set later in the client.</p>
       <p class="err" id="form-error" role="alert"></p>
       <div id="index-ask" role="alertdialog" aria-labelledby="index-ask-text" hidden>
@@ -246,6 +270,7 @@ a { color: var(--accent); }
   <h2 id="running-title">Setting up…</h2>
   <ul class="steps" id="steps" aria-live="polite"></ul>
   <p class="err" id="run-error" role="alert"></p>
+  <p id="run-done" hidden><a id="run-done-link" href="#">Open your forum</a></p>
   <p id="run-actions" hidden>
     <button type="button" id="run-back">Start over</button>
     <button type="button" class="primary" id="run-retry">Try again</button>

package/web/app/signup-forum.mjs

@@ -0,0 +1,52 @@
+// signup-forum.mjs — a forum made from the sign-up page. The person made a pod
+// for it at a provider and is signed in as that pod; this writes the forum on
+// the pod, takes its addresses here, and names this site its keeper. The
+// keeper's first run, started by the last switch, mints the forum's keys and
+// publishes its actors. Nothing of the person's own account is touched, and
+// nothing runs on their machine afterwards.
+
+import forumSetup from './forum-support.mjs';
+import { BrowserRemotePod } from './pod-remote.mjs';
+import { HttpStorage } from '../../lib/core/storage.mjs';
+import { podBaseOfWebId } from '../../lib/pod/urls.mjs';
+import { resourceExists } from '../../lib/pod/root.mjs';
+import { findAccount } from '../../lib/core/place.mjs';
+import { handleProblem, assertFrontNameFree, readConfigAt } from './signup.mjs';
+import { categoriesFrom, moderatorFrom } from './forum-form.mjs';
+
+/** Whether this site makes forums at all (web/app/forum-support.mjs). */
+export const forumsOffered = () => !!forumSetup;
+
+export async function signUpForum({ handle, name, categories, moderator = '' }, { session, onStep = () => {}, frontOrigin = null } = {}) {
+  if (!forumSetup) throw new Error('This site does not host forums.');
+  if (!frontOrigin) throw new Error('A forum lives at a gateway, and this page has none.');
+  const bad = handleProblem(handle);
+  if (bad) throw new Error(`Forum handle: ${bad}`);
+  if (!String(name || '').trim()) throw new Error('A forum name is required.');
+  const cats = categoriesFrom(categories);
+  const mod = moderatorFrom(moderator, frontOrigin);
+  if (!session?.webId || typeof session.fetch !== 'function') throw new Error("sign in at the forum's pod first");
+
+  const webId = session.webId;
+  const pod = podBaseOfWebId(webId);
+  const remote = new BrowserRemotePod(session, { webId, role: 'signup', log: () => {} });
+
+  // A forum needs a pod of its own: not one that hosts an account, not one
+  // that holds a forum already; and its names must be free here.
+  onStep('pod', 'running');
+  if (await findAccount(remote, pod, readConfigAt(remote, pod))) {
+    throw new Error('This pod already hosts a FediPod account. A forum needs a pod of its own.');
+  }
+  if (await resourceExists(session.fetch, pod + forumSetup.ROOT)) {
+    throw new Error('This pod already holds a forum.');
+  }
+  for (const h of [handle, ...cats.map((c) => c.slug)]) await assertFrontNameFree(frontOrigin, h);
+  onStep('pod', 'ok');
+
+  const made = await forumSetup.setUpForumAtGateway({
+    remote, storageFor: (base, fetch) => new HttpStorage(base, fetch), fetch: (u, i) => session.fetch(u, i),
+    front: frontOrigin, ownerWebId: webId, remotePod: pod, handle, name: String(name).trim(), categories: cats,
+    moderators: mod ? [mod] : [], moderatorWebIds: [webId],
+  }, { onStep });
+  return { handle: made.handle, front: made.front, address: `@${made.handle}@${new URL(made.front).host}` };
+}

package/web/app/signup.mjs

@@ -27,7 +27,7 @@ const keysDocFor = (pod, root) => `${pod}${root}ap-state/keys.json`;
 const stateOf = (pod, root) => `${pod}${root}ap-state/`;
 
 /** The account's config as it sits under `root`, read as its owner. */
-const readConfigAt = (remote, pod) => (root) => podState.readConfig(remote, { state: stateOf(pod, root) });
+export const readConfigAt = (remote, pod) => (root) => podState.readConfig(remote, { state: stateOf(pod, root) });
 
 const HANDLE_RE = /^[a-z0-9-]{2,30}$/;
 
@@ -49,7 +49,7 @@ const PROGRESS = new Map();
 const progressKey = (webId, a) => [webId, a.handle, a.shape || 'pod', a.container || ''].join('|');
 
 /** A fronted name is one per gateway; a taken one is refused before anything is made. */
-async function assertFrontNameFree(frontOrigin, handle) {
+export async function assertFrontNameFree(frontOrigin, handle) {
   const res = await fetch(`${frontOrigin.replace(/\/$/, '')}/api/handle?handle=${encodeURIComponent(handle)}`,
     { headers: { accept: 'application/json' } }).catch(() => null);
   const d = res ? await res.json().catch(() => ({})) : null;

package/web/front/new-account.html

@@ -3,33 +3,25 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1">
-<title>FediPod — access the Fediverse and ATProto from a Solid pod</title>
+<title>FediPod Gateway</title>
 <link rel="icon" href="/icons/gateway.svg" type="image/svg+xml">
 <style>
-  :root { color-scheme: light dark; --line:#d9d4c7; --dim:#45443d; --accent:#6a8a5a; }
+  :root { color-scheme: light dark; --dim:#45443d; }
   @media (prefers-color-scheme: dark) { :root { --dim:#c2c0b4; } }
   body { font: 20px/1.6 Arial, Helvetica, sans-serif; max-width: 44rem; margin: 2rem auto; padding: 0 1.1rem; }
   h1 { font-size: 1.7rem; margin: 0 0 .2rem; }
-  h2 { font-size: 1.2rem; margin: 1.4rem 0 .4rem; }
   p.lede { color: var(--dim); margin-top: 0; }
   .hint { color: var(--dim); font-size: .95rem; }
-  code { background: rgba(120,120,120,.12); padding: .05em .35em; border-radius: 4px; }
-  pre { background: rgba(120,120,120,.12); padding: .7rem .9rem; border-radius: 8px; overflow-x: auto; }
-  ol.steps li { margin: .5rem 0; }
+  a { text-decoration: underline; }
   [hidden] { display: none !important; }
 </style>
 </head>
 <body>
-<h1>FediPod - join the Fediverse from a Solid pod.</h1>
-<p class="lede">Welcome to <b>FediPod</b>! Here, you can get a free pod and Fediverse account or link to your existing pod/account.</p>
-
-<p class="hint" id="current-version" hidden>Current FediPod: <strong id="current-version-num"></strong><br>
- — install or update an existing install with <code id="current-version-cmd"></code></p>
-
-<p>
-FediPod is experimental and free to use.  See the <a href="https://github.com/jeff-zucker/FediPod">FediPod repository</a> for details.
-</p>
-
+<h1>FediPod Gateway</h1>
+<p class="lede">This is a FediPod Gateway: the door other Fediverse servers deliver to, for accounts whose data lives on Solid pods.</p>
+<p>Accounts are made and used in the browser. <a href="/">Open FediPod</a> to create one or sign in. Nothing is installed.</p>
+<p class="hint" id="current-version" hidden>This gateway runs FediPod <strong id="current-version-num"></strong>.</p>
+<p>FediPod is experimental and free to use. See the <a href="https://github.com/jeff-zucker/FediPod">FediPod repository</a> for details.</p>
 <script src="/new-account.js"></script>
 </body>
 </html>

package/web/front/new-account.js

@@ -1,13 +1,9 @@
-// new-account.js — the sign-up page's script, in a file of its own.
-//
-// It lived inline in new-account.html until 2026-09-09. Out here the page can
-// be served under `script-src 'self'`, which is what stops a stray bit of
-// markup from becoming running code; inline script cannot be told apart from
-// injected script by any policy. Served by the front at /new-account.js.
+// new-account.js — the front's root page's script, in a file of its own so
+// the page is served under `script-src 'self'`. Served by the front at
+// /new-account.js. It fills in the version this gateway runs, nothing more.
 fetch('/api/handle?handle=__probe__').then(r => r.json()).then(d => {
   if (d.version) {
     document.getElementById('current-version-num').textContent = d.version;
-    document.getElementById('current-version-cmd').textContent = `curl -fsSL ${location.origin}/install | sh`;
     document.getElementById('current-version').hidden = false;
   }
 }).catch(() => {});

package/web/front/install.sh

@@ -1,69 +0,0 @@
-#!/bin/sh
-# FediPod installer.  Usage:  curl -fsSL https://fedipod.net/install | sh
-# Installs into ~/FediPod (or $FEDIPOD_DIR); re-running updates the install.
-#
-# A signup page may append parameters (sh -s -- --gateway ... --secret ...);
-# they are saved for the first start, whose setup opens pre-filled and
-# attaches to the gateway when it completes.
-set -eu
-
-REPO="https://github.com/jeff-zucker/FediPod"
-DIR="${FEDIPOD_DIR:-$HOME/FediPod}"
-
-say() { printf '%s\n' "$*"; }
-fail() { printf 'fedipod install: %s\n' "$*" >&2; exit 1; }
-
-GATEWAY= SECRET= POD= ISSUER= HANDLE= KIND=person FRONTED=false
-while [ $# -gt 0 ]; do
-  case "$1" in
-    --gateway) GATEWAY=$2; shift 2;;
-    --secret)  SECRET=$2;  shift 2;;
-    --pod)     POD=$2;     shift 2;;
-    --issuer)  ISSUER=$2;  shift 2;;
-    --handle)  HANDLE=$2;  shift 2;;
-    --kind)    KIND=$2;    shift 2;;
-    --fronted) FRONTED=true; shift;;
-    *) fail "unknown option $1";;
-  esac
-done
-
-command -v git >/dev/null 2>&1 || fail "git is required — install it from https://git-scm.com/ and re-run"
-command -v node >/dev/null 2>&1 || fail "node 20 or newer is required — install it from https://nodejs.org/ and re-run"
-command -v npm >/dev/null 2>&1 || fail "npm is required (it ships with node) — install node from https://nodejs.org/ and re-run"
-
-major=$(node -v | sed 's/^v//' | cut -d. -f1)
-[ "$major" -ge 20 ] 2>/dev/null || fail "node 20 or newer is required (found $(node -v))"
-
-if [ -d "$DIR/.git" ]; then
-  say "updating the existing install in $DIR"
-  git -C "$DIR" pull --ff-only || fail "could not update $DIR — it has local changes; update it by hand"
-elif [ -e "$DIR" ]; then
-  fail "$DIR exists and is not a FediPod checkout — set FEDIPOD_DIR to another location and re-run"
-else
-  say "installing into $DIR"
-  git clone --depth 1 "$REPO" "$DIR"
-fi
-
-cd "$DIR"
-npm install --omit=dev --no-audit --no-fund
-
-# Put `fedipod` on PATH, the same command an `npm install -g fedipod` gives.
-# Everything printed from here on — the docs, the agent's own advice, the
-# command a signup page hands you — names it that way, and a checkout that
-# skipped this step could run none of them.
-if npm link >/dev/null 2>&1; then
-  say "linked: the fedipod command is on your PATH"
-else
-  say "note: could not link the fedipod command — run it as: node $DIR/bin/fedipod.mjs"
-fi
-
-if [ -n "$HANDLE" ]; then
-  printf '{"handle":"%s","kind":"%s","pod":"%s","issuer":"%s","gateway":"%s","secret":"%s","fronted":%s}\n' \
-    "$HANDLE" "$KIND" "$POD" "$ISSUER" "$GATEWAY" "$SECRET" "$FRONTED" > "$DIR/first-run.json"
-  chmod 600 "$DIR/first-run.json"
-fi
-
-say ""
-say "Installed. To start (first run opens setup in your browser):"
-say ""
-say "  fedipod start"