repos.ts

17.7 KB · raw

1import type { Context, Hono } from "hono";2import { BucketWriteError, KEPR_PREFIX } from "../bucket/reader.ts";3import { isSafePath } from "../bucket/repo.ts";4import { rebuildRepo, syncAll } from "../bucket/sync.ts";5import { MAX_CHARS } from "../issues/spam.ts";6import { operatorIssues } from "../issues/store.ts";7import { languageLines, repoStats } from "../mirror/queries.ts";8import { openMirror, quarantinedPaths } from "../mirror/store.ts";9import { html } from "../pages/html.ts";10import { formatDate, plural } from "../pages/layout.ts";11import {12	deleteRelease,13	deleteReleaseFile,14	LastReleaseFile,15	type OperatorRelease,16	operatorReleases,17	setRelease,18	visibleReleases,19} from "../releases/releases.ts";20import { type RepoText, repoText, setRepoText } from "../server/db.ts";21import { dropTarballs } from "../tarball/cache.ts";22import { type AdminContext, adminPage, formField, notice, textFields } from "./console.ts";23import { type AdminRepo, allRepos, findRepo, type RepoEdit, updateRepo } from "./store.ts";24import { LIMITS } from "./text.ts";2526const MAX_FIELD = 500;27const HTTP_URL = /^https?:\/\/[^\s]+$/i;28const MAX_LANGUAGES = 5;29const MAX_LANGUAGE = 30;30const MAX_HIDDEN = 100;31const TABS = ["overview", "settings", "builds", "archives"] as const;32type Tab = (typeof TABS)[number];3334/** Shown languages as typed, comma-separated; blanks between commas are dropped. */35function languageNames(value: string): string[] {36	return value37		.split(",")38		.map((name) => name.trim())39		.filter((name) => name !== "");40}4142/** §24's Repos section: visibility (§20), card settings, texts, builds, sync status and "sync now". */43export function registerRepos(app: Hono, ctx: AdminContext): void {44	app.get("/admin/repos", (c) => {45		const tab = TABS.find((t) => t === c.req.query("tab")) ?? "overview";46		return c.html(reposPage(c, ctx, "", c.req.query("repo"), tab));47	});4849	app.post("/admin/sync", async (c) => {50		await syncAll(ctx.sync);51		return c.redirect("/admin/repos", 303);52	});5354	app.post("/admin/repos/:repo", async (c) => {55		const repo = findRepo(ctx.kepr, c.req.param("repo"));56		if (!repo) return c.notFound();57		const fields = await textFields(c);58		const text = (name: string) => (fields[name] ?? "").trim();59		const languages = languageNames(fields.languages ?? "");60		const hidden = (fields.hidden_paths ?? "")61			.split(/\r?\n/)62			.map((path) => path.trim().replace(/\/+$/, ""))63			.filter((path) => path !== "");64		const edit: RepoEdit = {65			public: fields.public === "1" ? 1 : 0,66			category: text("category"),67			homepage: text("homepage"),68			// Joined with the separator `publicRepo` splits on, so a name never contains it.69			languages: languages.join(", "),70			issues_paused: fields.issues_paused === "1" ? 1 : 0,71			hidden_paths: hidden.join("\n"),72		};73		const refuse = (error: string) =>74			c.html(reposPage(c, ctx, `${repo.name}: ${error}`, repo.name, "settings"), 400);75		const texts = (["description", "details"] as const).map((field): [RepoText, string] => [76			field,77			(fields[field] ?? "").replace(/\r\n/g, "\n").trim(),78		]);79		const long = texts.find(([field, value]) => value.length > LIMITS[field]);80		if (long) {81			const [field] = long;82			return refuse(`Keep the ${field} under ${LIMITS[field].toLocaleString("en-US")} characters.`);83		}84		if ([edit.category, edit.homepage, fields.languages ?? ""].some((v) => v.length > MAX_FIELD)) {85			return refuse(`keep each field under ${MAX_FIELD} characters.`);86		}87		if (edit.homepage !== "" && !HTTP_URL.test(edit.homepage)) {88			return refuse("the homepage must be an http or https address.");89		}90		if (languages.length > MAX_LANGUAGES) return refuse("up to five languages.");91		if (languages.some((name) => name.length > MAX_LANGUAGE)) {92			return refuse(`a language name is at most ${MAX_LANGUAGE} characters.`);93		}94		if (languages.some((name) => /\p{C}/u.test(name))) {95			return refuse("a language name is printable text.");96		}97		if (hidden.length > MAX_HIDDEN) return refuse(`up to ${MAX_HIDDEN} hidden paths.`);98		const unsafe = hidden.find((path) => path.length > MAX_FIELD || !isSafePath(path));99		if (unsafe !== undefined) return refuse(`"${unsafe}" is not a path in the repo.`);100		updateRepo(ctx.kepr, repo.name, edit);101		for (const [field, value] of texts) setRepoText(ctx.kepr, repo.name, field, value);102		if (edit.hidden_paths !== repo.hidden_paths) await applyHidden(ctx, repo.name, hidden);103		return c.redirect(`/admin/repos?repo=${repo.name}&tab=settings&saved=1`, 303);104	});105106	// A build's displayed notes and hiding live in kepr.db; the record in the bucket is untouched.107	app.post("/admin/releases/:repo/:version", async (c) => {108		const found = findRelease(ctx, c.req.param("repo"), c.req.param("version"));109		if (!found) return c.notFound();110		const { repo, release } = found;111		const fields = await textFields(c);112		const notes = (fields.notes ?? "").replace(/\r\n/g, "\n");113		if (notes.length > MAX_CHARS) {114			const limit = MAX_CHARS.toLocaleString("en-US");115			const error = `${repo.name} ${release.version}: notes are over ${limit} characters.`;116			return c.html(reposPage(c, ctx, error, repo.name, "builds"), 400);117		}118		// Notes equal to the record's are no override, so a later record edit would show through.119		const override = notes === release.recordNotes ? null : notes;120		setRelease(ctx.kepr, repo.name, release.version, fields.hidden === "1", override);121		return c.redirect(122			`/admin/repos?repo=${repo.name}&tab=builds&saved=1#${repo.name}-${release.version}`,123			303,124		);125	});126127	app.post("/admin/repos/:repo/tarballs/delete", async (c) => {128		const repo = findRepo(ctx.kepr, c.req.param("repo"));129		if (!repo) return c.notFound();130		try {131			await dropTarballs(ctx.sync.bucket, repo.name);132		} catch (error) {133			if (!(error instanceof BucketWriteError)) throw error;134			const message = `${repo.name}: ${error.message}`;135			return c.html(reposPage(c, ctx, message, repo.name, "archives"), 503);136		}137		return c.redirect(`/admin/repos?repo=${repo.name}&tab=archives&saved=1`, 303);138	});139140	app.post("/admin/releases/:repo/:version/delete", async (c) => {141		const found = findRelease(ctx, c.req.param("repo"), c.req.param("version"));142		if (!found) return c.notFound();143		const { repo, mirror, release } = found;144		const refuse = (status: 400 | 503, error: string) =>145			c.html(146				reposPage(c, ctx, `${repo.name} ${release.version}: ${error}`, repo.name, "builds"),147				status,148			);149		if ((await textFields(c)).confirm !== "1") return refuse(400, "tick the box to delete it.");150		try {151			await deleteRelease(ctx.sync.bucket, ctx.kepr, mirror, repo.name, release.version);152		} catch (error) {153			if (error instanceof BucketWriteError) return refuse(503, error.message);154			throw error;155		}156		return c.redirect(`/admin/repos?repo=${repo.name}&tab=builds&saved=1`, 303);157	});158159	app.post("/admin/releases/:repo/:version/:platform/delete", async (c) => {160		const found = findRelease(ctx, c.req.param("repo"), c.req.param("version"));161		const platform = c.req.param("platform");162		if (!found?.release.downloads.some(([p]) => p === platform)) return c.notFound();163		const { repo, mirror, release } = found;164		const refuse = (status: 400 | 503, error: string) =>165			c.html(166				reposPage(167					c,168					ctx,169					`${repo.name} ${release.version} ${platform}: ${error}`,170					repo.name,171					"builds",172				),173				status,174			);175		if ((await textFields(c)).confirm !== "1") return refuse(400, "tick the box to delete it.");176		try {177			await deleteReleaseFile(178				ctx.sync.bucket,179				ctx.kepr,180				mirror,181				repo.name,182				release.version,183				platform,184			);185		} catch (error) {186			if (error instanceof LastReleaseFile) return refuse(400, error.message);187			if (error instanceof BucketWriteError) return refuse(503, error.message);188			throw error;189		}190		return c.redirect(191			`/admin/repos?repo=${repo.name}&tab=builds&saved=1#${repo.name}-${release.version}`,192			303,193		);194	});195}196197/**198 * Hands a changed hidden list to Koh at `.kepr/hidden/<repo>`, one path per line, for it to add to199 * `.kohignore`; then rebuilds the mirror and drops kept tarballs, so hiding and unhiding both show200 * at once. Without a write key the list stays in Kepr: Koh reads it only from the bucket anyway.201 */202async function applyHidden(ctx: AdminContext, repo: string, hidden: string[]): Promise<void> {203	const list = new TextEncoder().encode(hidden.map((path) => `${path}\n`).join(""));204	try {205		await ctx.sync.bucket.put(`${KEPR_PREFIX}hidden/${repo}`, list, "text/plain");206		await dropTarballs(ctx.sync.bucket, repo);207	} catch (error) {208		if (!(error instanceof BucketWriteError)) throw error;209	}210	await rebuildRepo(ctx.sync, repo);211}212213/** A build of a known repo, as the console lists it, or null. */214function findRelease(ctx: AdminContext, name: string, version: string) {215	const repo = findRepo(ctx.kepr, name);216	const mirror = repo && openMirror(ctx.mirrorDir, repo.name);217	const release =218		repo &&219		mirror &&220		operatorReleases(ctx.kepr, mirror, repo.name).find((r) => r.version === version);221	return repo && mirror && release ? { repo, mirror, release } : null;222}223224function reposPage(225	c: Context,226	ctx: AdminContext,227	error: string,228	chosen: string | undefined,229	tab: Tab,230) {231	const repos = allRepos(ctx.kepr);232	const selected = repos.find((repo) => repo.name === chosen) ?? repos[0];233	const body = html`${notice(error)}234<p class="admin-intro">Choose a repository to manage its visibility and public page.</p>235<form method="post" action="/admin/sync">236${formField(c)}<button class="issues-submit" type="submit">sync now</button></form>237${repos.length === 0 && html`<p class="muted mono save-empty">no repos found in the bucket yet</p>`}238<div class="admin-repos">239<nav aria-label="repositories">240${repos.map(241	(repo) => html`<a class="issue-row" id="repo-${repo.name}"242href="/admin/repos?repo=${repo.name}#repo-editor"${selected?.name === repo.name ? html` aria-current="page"` : ""}>243<span>${repo.name}</span><span>${repo.public ? "public" : "private"}</span>244<span class="issue-meta mono">${repo.last_sync_at === null ? "never synced" : `last sync ${formatDate(repo.last_sync_at)} UTC`}</span>245${repo.last_sync_error && html`<span class="issues-error">${repo.last_sync_error}</span>`}</a>`,246)}247</nav>248${selected && repoForm(c, ctx, selected, tab)}249</div>`;250	return adminPage(c, ctx, "repos", body);251}252253/** The selected repo at a glance: its numbers and languages (§24). */254function workspace(ctx: AdminContext, repo: AdminRepo) {255	const mirror = openMirror(ctx.mirrorDir, repo.name);256	const stats = repoStats(mirror);257	const releases = operatorReleases(ctx.kepr, mirror, repo.name);258	const downloads = (release: (typeof releases)[number]) =>259		release.downloads.reduce((sum, [, count]) => sum + count, 0);260	const open = operatorIssues(ctx.kepr, "open").filter((issue) => issue.repo === repo.name);261	const vital = (label: string, value: string | number) =>262		html`<div><strong>${String(value)}</strong><span class="mono">${label}</span></div>`;263	return html`<div class="admin-vitals">264${vital("saves", stats.saves)}265${vital("lines", stats.lines)}266${vital("newest version", visibleReleases(ctx.kepr, mirror, repo.name)[0]?.version ?? "none")}267${vital("open issues", open.length)}268${vital(269	"downloads",270	releases.reduce((sum, release) => sum + downloads(release), 0),271)}272</div>273<p class="issue-meta mono">detected languages:274${languageLines(mirror).map(275	([language, lines], i) =>276		html`${i > 0 ? " · " : " "}${language} <span class="muted">${plural(lines, "line")}</span>`,277)}</p>278`;279}280281function repoForm(c: Context, ctx: AdminContext, repo: AdminRepo, tab: Tab) {282	const synced =283		repo.last_sync_at === null ? "never synced" : `last sync ${formatDate(repo.last_sync_at)} UTC`;284	const link = (t: Tab) =>285		html`<a class="issues-tab${t === tab ? " active" : ""}" href="/admin/repos?repo=${repo.name}&amp;tab=${t}"${286			t === tab ? html` aria-current="page"` : ""287		}>${t}</a>`;288	const content = {289		overview: () => overviewTab(ctx, repo),290		settings: () => settingsTab(c, ctx, repo),291		builds: () => buildsTab(c, ctx, repo),292		archives: () => archivesTab(c, repo),293	}[tab]();294	return html`<article class="issue-post" id="repo-editor">295<p class="issue-post-head mono">296<span class="issue-author">297${repo.public ? html`<a href="/${repo.name}">${repo.name}</a>` : repo.name}</span>298<span>${repo.public ? "public" : "private"}</span><span class="history-when">${synced}</span></p>299<nav class="issues-bar mono" aria-label="${repo.name} workspace">${TABS.map(link)}</nav>300${content}301</article>`;302}303304function overviewTab(ctx: AdminContext, repo: AdminRepo) {305	const quarantined = quarantinedPaths(openMirror(ctx.mirrorDir, repo.name));306	return html`${workspace(ctx, repo)}307${308	repo.last_sync_error && html`<p class="issues-error mono">sync error: ${repo.last_sync_error}</p>`309}310${311	quarantined.length > 0 &&312	html`<p class="issues-error mono">${plural(quarantined.length, "path")} quarantined: ${quarantined.join(", ")}</p>`313}`;314}315316function settingsTab(c: Context, ctx: AdminContext, repo: AdminRepo) {317	const own = repoText(ctx.kepr, repo.name);318	const input = (name: keyof RepoEdit, label: string) =>319		html`<label class="issues-label" for="${repo.name}-${name}">${label}</label>320<input class="issues-input" id="${repo.name}-${name}" name="${name}" maxlength="${MAX_FIELD}" value="${String(repo[name])}">`;321	return html`<form class="issues-form" method="post" action="/admin/repos/${repo.name}">322${formField(c)}323<label class="issues-label">324<input type="checkbox" name="public" value="1"${repo.public ? html` checked` : ""}> public</label>325<label class="issues-label">326<input type="checkbox" name="issues_paused" value="1"${repo.issues_paused ? html` checked` : ""}>327pause new issues</label>328${input("category", "category")}329${input("homepage", "homepage")}330${input("languages", "shown languages")}331<p class="issue-meta mono">Up to five, separated by commas. Leave blank to show the detected one.</p>332${textArea(repo.name, "description", "description", 3, own.description)}333${textArea(repo.name, "details", "details", 12, own.details)}334<p class="issue-meta mono">Markdown. Leave either blank to use the README's.</p>335<label class="issues-label" for="${repo.name}-hidden_paths">hidden files and folders</label>336<textarea class="issues-textarea mono" id="${repo.name}-hidden_paths" name="hidden_paths"337rows="4">${repo.hidden_paths}</textarea>338<p class="issue-meta mono">One path per line, such as notes.md or docs/private. Hidden from every page,339the stats and tarballs, and passed to Koh for .kohignore when there is a write key.</p>340<button class="issues-submit" type="submit">save ${repo.name}</button>341</form>`;342}343344function buildsTab(c: Context, ctx: AdminContext, repo: AdminRepo) {345	const releases = operatorReleases(ctx.kepr, openMirror(ctx.mirrorDir, repo.name), repo.name);346	return html`<section class="repo-section" id="builds">347${348	releases.length > 0349		? releases.map((release) => releaseForm(c, repo.name, release))350		: html`<p class="muted mono save-empty">no builds yet</p>`351}</section>`;352}353354function archivesTab(c: Context, repo: AdminRepo) {355	return html`<section class="repo-section">356<form class="issues-form" method="post" action="/admin/repos/${repo.name}/tarballs/delete">357${formField(c)}358<p class="issue-meta mono">Tarballs are kept in the bucket once downloaded, and rebuilt on the next download.359Each one is listed under <a href="/admin/storage">storage</a>.</p>360<button class="issues-submit" type="submit">delete kept tarballs</button>361</form></section>`;362}363364function textArea(repo: string, name: RepoText, label: string, rows: number, value: string) {365	return html`<label class="issues-label" for="${repo}-${name}">${label}</label>366<textarea class="issues-textarea" id="${repo}-${name}" name="${name}" rows="${String(rows)}"367maxlength="${String(LIMITS[name])}">${value}</textarea>`;368}369370function releaseForm(c: Context, repo: string, release: OperatorRelease) {371	const total = release.downloads.reduce((sum, [, n]) => sum + n, 0);372	const id = `${repo}-${release.version}`;373	return html`<article class="issue-post" id="${id}">374<p class="issue-post-head mono">375${/* this row stays one line: splitting its spans changes the HTML that tests/console.test.ts pins */ ""}${html`<span class="issue-author">${release.version}</span>`}${html`<span>${release.hidden ? "hidden" : "shown"}</span>`}${html`<span>${plural(total, "download")}</span>`}${release.downloads.map(376	([platform, n]) => html`<span class="muted">${platform} ${n}</span>`,377)}378</p>379<form class="issues-form" method="post" action="/admin/releases/${repo}/${release.version}">380${formField(c)}381<label class="issues-label" for="${id}-notes">notes382${release.notes !== release.recordNotes ? html` <span class="muted">(edited)</span>` : ""}</label>383<textarea class="issues-textarea" id="${id}-notes" name="notes" rows="3"384maxlength="${MAX_CHARS}">${release.notes}</textarea>385${386	// One line on purpose: Biome folds a hole-by-hole split back together, and breaking the387	// tag itself would put whitespace in the HTML that tests/console.test.ts pins.388	""389}<label class="issues-label">${html`<input type="checkbox"`}${html` name="hidden" value="1"`}${release.hidden ? html` checked` : ""}> hidden</label>390<button class="issues-submit" type="submit">save ${release.version}</button>391</form>392${393	release.downloads.length > 1 &&394	release.downloads.map(395		([platform]) => html`<form class="issues-form" method="post"396action="/admin/releases/${repo}/${release.version}/${platform}/delete">397${formField(c)}398<label class="issues-label"><input type="checkbox" name="confirm" value="1" required>399delete the ${platform} file from the bucket</label>400<button class="issues-submit" type="submit">delete ${platform}</button>401</form>`,402	)403}404<form class="issues-form" method="post" action="/admin/releases/${repo}/${release.version}/delete">405${formField(c)}406<label class="issues-label"><input type="checkbox" name="confirm" value="1" required>407delete ${release.version} and its files from the bucket; this cannot be undone</label>408<button class="issues-submit" type="submit">delete ${release.version}</button>409</form>410</article>`;411}