1import type { Context, Hono } from "hono";2import { saveByPrefix } from "../mirror/queries.ts";3import { type Html, html } from "../pages/html.ts";4import {5 cacheFor,6 formatDate,7 notFound,8 openPublicRepo,9 type PageContext,10 type PublicRepo,11 page,12 relativeTime,13} from "../pages/layout.ts";14import { visibleReleases } from "../releases/releases.ts";15import { checkStamp, FILINGS_PER_HOUR, formStamp, ipHash, MAX_CHARS } from "./spam.ts";16import {17 addEntry,18 fileIssue,19 filingsSince,20 findIssue,21 hashToken,22 ISSUE_TYPES,23 type Issue,24 type IssueType,25 issueCounts,26 listIssues,27 threadEntries,28} from "./store.ts";2930type Fields = Record<string, string>;31type Notice = { error?: string; draft?: string };3233const TOKEN = /^[0-9a-f]{64}$/;34const FORM_FIELDS = ["title", "body", "type", "version", "name", "email", "website", "stamp"];35const unixNow = () => Math.floor(Date.now() / 1000);363738export function registerIssuePages(app: Hono, ctx: PageContext): void {39 app.get("/:repo/issues", (c) => {40 const repo = openPublicRepo(ctx, c.req.param("repo"));41 if (!repo) return notFound(c, ctx);42 const status = c.req.query("status") === "closed" ? "closed" : "open";43 cacheFor(c, false);44 return c.html(listPage(ctx, repo, status, c.req.query("q") ?? "", c.req.query("type") ?? ""));45 });4647 app.get("/:repo/issues/new", (c) => {48 const repo = openPublicRepo(ctx, c.req.param("repo"));49 if (!repo) return notFound(c, ctx);50 const version = visibleReleases(ctx.kepr, repo.mirror, repo.settings.name)[0]?.version ?? "";51 return formPage(c, ctx, repo, { type: "bug", version }, "", 200);52 });5354 app.post("/:repo/issues/new", async (c) => {55 const repo = openPublicRepo(ctx, c.req.param("repo"));56 if (!repo) return notFound(c, ctx);57 const fields = await readFields(c, FORM_FIELDS);58 const now = unixNow();59 const refuse = (message: string, status: 400 | 403 | 429) =>60 formPage(c, ctx, repo, fields, message, status);61 62 if (fields.website !== "") return refuse("This issue could not be filed.", 400);63 const stamp = checkStamp(ctx.kepr, c, fields.stamp ?? "", now);64 if (stamp === "invalid") return refuse("This form expired. Please send it again.", 403);65 if (stamp === "too-fast") return refuse("That was quick. Please send it again.", 400);66 const title = fields.title?.trim() ?? "";67 const body = fields.body?.trim() ?? "";68 if (title === "" || body === "") return refuse("A title and what happened are needed.", 400);69 if (!ISSUE_TYPES.includes(fields.type as IssueType)) return refuse("Pick a type.", 400);70 if (Object.values(fields).some((value) => value.length > MAX_CHARS)) {71 return refuse(72 `Please keep each field under ${MAX_CHARS.toLocaleString("en-US")} characters.`,73 400,74 );75 }76 const hash = ipHash(ctx.kepr, c);77 if (filingsSince(ctx.kepr, hash, now - 3600) >= FILINGS_PER_HOUR) {78 return refuse("Too many issues from here this hour. Please try again later.", 429);79 }80 const name = repo.settings.name;81 const filed = fileIssue(ctx.kepr, {82 repo: name,83 title,84 body,85 type: fields.type as IssueType,86 version: fields.version?.trim() ?? "",87 reporterName: fields.name?.trim() ?? "",88 contactEmail: fields.email?.trim() ?? "",89 ipHash: hash,90 filedAt: now,91 });92 const link = `https://${ctx.domain}/${name}/issues/${filed.number}?token=${filed.token}`;93 privatePage(c);94 return c.html(95 page(ctx, {96 title: `issue #${filed.number} filed · ${name}`,97 description: "",98 path: c.req.path,99 body: html`${crumbs(name)}100<h1 class="file-page-title">Filed as101<a href="/${name}/issues/${filed.number}">#${filed.number}</a></h1>102<p>This is your private link for adding to the issue later. It is shown only this once,103so keep it; anyone who has it can post as you.</p>104<p class="issue-link mono"><a href="${link}">${link}</a></p>`,105 }),106 );107 });108109 app.get("/:repo/issues/:n{[0-9]{1,9}}", (c) => {110 const repo = openPublicRepo(ctx, c.req.param("repo"));111 const issue = repo && findIssue(ctx.kepr, repo.settings.name, Number(c.req.param("n")));112 if (!repo || !issue) return notFound(c, ctx);113 const token = c.req.query("token");114 if (token === undefined) {115 cacheFor(c, false);116 return c.html(threadPage(c, ctx, repo, issue, null, {}));117 }118 privatePage(c);119 return c.html(threadPage(c, ctx, repo, issue, token, {}));120 });121122 app.post("/:repo/issues/:n{[0-9]{1,9}}", async (c) => {123 const repo = openPublicRepo(ctx, c.req.param("repo"));124 const issue = repo && findIssue(ctx.kepr, repo.settings.name, Number(c.req.param("n")));125 if (!repo || !issue) return notFound(c, ctx);126 const { token = "", body = "", stamp = "" } = await readFields(c, ["token", "body", "stamp"]);127 privatePage(c);128 const refuse = (error: string, status: 400 | 403) =>129 c.html(threadPage(c, ctx, repo, issue, token, { error, draft: body }), status);130 if (!ownsIssue(issue, token))131 return refuse("This follow-up link does not match the issue.", 403);132 const check = checkStamp(ctx.kepr, c, stamp, unixNow());133 if (check === "invalid") return refuse("This form expired. Please send it again.", 403);134 if (check === "too-fast") return refuse("That was quick. Please send it again.", 400);135 const text = body.trim();136 if (text === "") return refuse("Write something to add.", 400);137 if (text.length > MAX_CHARS) {138 return refuse(`Please keep it under ${MAX_CHARS.toLocaleString("en-US")} characters.`, 400);139 }140 const entry = addEntry(ctx.kepr, issue.id, "reporter", text, unixNow());141 return c.redirect(142 `/${repo.settings.name}/issues/${issue.number}?token=${token}#entry-${entry}`,143 303,144 );145 });146}147148async function readFields(c: Context, names: string[]): Promise<Fields> {149 const form = await c.req.parseBody();150 const fields: Fields = {};151 for (const name of names) {152 const value = form[name];153 fields[name] = typeof value === "string" ? value : "";154 }155 return fields;156}157158function ownsIssue(issue: Issue, token: string): boolean {159 return TOKEN.test(token) && issue.token_hash === hashToken(token);160}161162163function privatePage(c: Context): void {164 c.header("Cache-Control", "no-store");165 c.header("Referrer-Policy", "no-referrer");166}167168function crumbs(repo: string): Html {169 return html`<p class="breadcrumb mono">170<a href="/${repo}">${repo}</a> / <a href="/${repo}/issues">issues</a></p>`;171}172173function listPage(174 ctx: PageContext,175 repo: PublicRepo,176 status: "open" | "closed",177 query: string,178 type: string,179): string {180 const name = repo.settings.name;181 const counts = issueCounts(ctx.kepr, name);182 const filter = ISSUE_TYPES.includes(type as IssueType) ? type : "";183 const issues = listIssues(ctx.kepr, name, status).filter(184 (issue) =>185 (!filter || issue.type === filter) &&186 issue.title.toLowerCase().includes(query.trim().toLowerCase()),187 );188 const tab = (which: "open" | "closed") =>189 html`<a class="issues-tab${which === status ? " active" : ""}"190 href="/${name}/issues${which === "closed" ? "?status=closed" : ""}">191${which} <span class="muted">${counts[which]}</span></a>`;192 return page(ctx, {193 title: `issues · ${name}`,194 description: `Issues filed against ${name}.`,195 path: `/${name}/issues`,196 body: html`<p class="breadcrumb mono"><a href="/${name}">${name}</a></p>197<h1 class="file-page-title">issues</h1>198<p class="issues-bar mono">${tab("open")}${tab("closed")}199<a class="issues-new" href="/${name}/issues/new">report an issue →</a></p>200<form class="issues-filter" method="get" action="/${name}/issues">201<input type="hidden" name="status" value="${status}">202<input class="issues-input" name="q" type="search" aria-label="search issue titles" placeholder="search issues" value="${query}">203<select class="issues-input" name="type" aria-label="issue type">204<option value="">all types</option>205${ISSUE_TYPES.map((value) => html`<option value="${value}"${filter === value ? html` selected` : ""}>${value}</option>`)}206</select><button class="issues-submit" type="submit">filter</button></form>207<section class="repo-section">208${209 issues.length > 0210 ? issues.map(211 (issue) =>212 html`<a class="issue-row" href="/${name}/issues/${issue.number}">213<span class="issue-symbol issue-symbol--${issue.status}">214${issue.status === "open" ? "◉" : "◈"}</span>215<span class="issue-title">${issue.title}</span>216${ ""}<span class="issue-meta mono">#${issue.number} · ${issue.type}${issue.version && ` · v${issue.version}`} · ${relativeTime(issue.filed_at)}</span>217<span class="issue-reporter mono">${issue.reporter_name || "anonymous"}</span>218</a>`,219 )220 : html`<p class="muted mono save-empty">${query || filter ? "no matching issues" : `no ${status} issues`}</p>`221}222</section>`,223 });224}225226function formPage(227 c: Context,228 ctx: PageContext,229 repo: PublicRepo,230 values: Fields,231 error: string,232 status: 200 | 400 | 403 | 429,233): Response {234 const name = repo.settings.name;235 privatePage(c);236 const typeOption = (type: string) =>237 html`<option value="${type}"${values.type === type ? html` selected` : ""}>${type}</option>`;238 const body = html`${crumbs(name)}239<h1 class="file-page-title">report an issue</h1>240${error && html`<p class="issues-error mono" role="alert">${error}</p>`}241<form class="issues-form" method="post" action="/${name}/issues/new">242<input type="hidden" name="stamp" value="${formStamp(ctx.kepr, c, unixNow())}">243<label class="issues-hp" aria-hidden="true">leave this empty244<input name="website" tabindex="-1" autocomplete="off"></label>245<label class="issues-label" for="issue-title">title</label>246<input class="issues-input" id="issue-title" name="title" required maxlength="${MAX_CHARS}" value="${values.title ?? ""}">247<label class="issues-label" for="issue-body">what happened</label>248<textarea class="issues-textarea" id="issue-body" name="body" rows="8" required249maxlength="${MAX_CHARS}">${values.body ?? ""}</textarea>250<label class="issues-label" for="issue-type">type</label>251<select class="issues-input" id="issue-type" name="type">${ISSUE_TYPES.map(typeOption)}</select>252<label class="issues-label" for="issue-version">version you're on</label>253<input class="issues-input" id="issue-version" name="version" maxlength="200" value="${values.version ?? ""}">254<label class="issues-label" for="issue-name">name to show255<span class="muted">(optional)</span></label>256<input class="issues-input" id="issue-name" name="name" maxlength="200" value="${values.name ?? ""}">257<label class="issues-label" for="issue-email">contact email258<span class="muted">(optional, only the operator sees it)</span></label>259<input class="issues-input" id="issue-email" name="email" type="email" maxlength="320" value="${values.email ?? ""}">260<p class="issues-actions"><button class="issues-submit" type="submit">file issue</button>261<a class="issues-cancel mono" href="/${name}/issues">cancel</a></p>262</form>`;263 return c.html(264 page(ctx, {265 title: `report an issue · ${name}`,266 description: `File an issue against ${name}.`,267 path: `/${name}/issues/new`,268 body,269 }),270 status,271 );272}273274function threadPage(275 c: Context,276 ctx: PageContext,277 repo: PublicRepo,278 issue: Issue,279 token: string | null,280 notice: Notice,281): string {282 const name = repo.settings.name;283 const reporter = issue.reporter_name || "anonymous";284 const post = (id: string, operator: boolean, at: number, text: string) =>285 html`<article class="issue-post${operator ? " issue-post--operator" : ""}" id="${id}">286<p class="issue-post-head mono">${287 operator288 ? html`<span class="issue-badge">operator</span>`289 : html`<span class="issue-author">${reporter}</span>`290 }<span class="history-when">${formatDate(at)}</span></p>291<div class="issue-text">${text}</div>292</article>`;293 const owner = token !== null && ownsIssue(issue, token);294 return page(ctx, {295 title: `#${issue.number} ${issue.title} · ${name}`,296 description: issue.title,297 path: `/${name}/issues/${issue.number}`,298 body: html`${crumbs(name)}299<h1 class="file-page-title">${issue.title} <span class="muted">#${issue.number}</span></h1>300<p class="issue-meta mono">301<span class="issue-symbol issue-symbol--${issue.status}">302${issue.status === "open" ? "◉ open" : "◈ closed"}</span>303${issue.type}${issue.version && ` · v${issue.version}`} · filed ${relativeTime(issue.filed_at)}304${issue.status === "closed" && fixedIn(repo, issue)}</p>305${post("issue", false, issue.filed_at, issue.body)}306${threadEntries(ctx.kepr, issue.id).map((entry) =>307 post(`entry-${entry.id}`, entry.author === "operator", entry.created_at, entry.body),308)}309${notice.error && html`<p class="issues-error mono" role="alert">${notice.error}</p>`}310${311 token !== null &&312 !owner &&313 !notice.error &&314 html`<p class="issues-error mono">This follow-up link does not match the issue.</p>`315}316${317 owner &&318 html`<form class="issues-form" method="post" action="/${name}/issues/${issue.number}">319<p class="muted">This is your private follow-up link; anyone who has it can post as you.</p>320<input type="hidden" name="token" value="${token}">321<input type="hidden" name="stamp" value="${formStamp(ctx.kepr, c, unixNow())}">322<label class="issues-label" for="follow-up">add to this issue</label>323<textarea class="issues-textarea" id="follow-up" name="body" rows="5" required324maxlength="${MAX_CHARS}">${notice.draft ?? ""}</textarea>325<button class="issues-submit" type="submit">post</button>326</form>`327}`,328 });329}330331function fixedIn(repo: PublicRepo, issue: Issue): Html | "" {332 if (issue.fixed_in === "") return "";333 const save = saveByPrefix(repo.mirror, issue.fixed_in);334 335 const id =336 save && !save.is_checkpoint337 ? html`<a class="history-id" href="/${repo.settings.name}/saves/${save.id}">${save.id}</a>`338 : html`<span class="history-id">${issue.fixed_in}</span>`;339 return html` · fixed in ${id}`;340}