@meith/attachments 0.16.0

package/LICENSE.md

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@meith/attachments",
+  "version": "0.16.0",
+  "license": "LGPL-3.0-or-later",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/meith-dev/meith.git",
+    "directory": "packages/attachments"
+  },
+  "type": "module",
+  "main": "./src/index.ts",
+  "types": "./src/index.ts",
+  "exports": {
+    ".": "./src/index.ts",
+    "./limits": "./src/limits.ts",
+    "./types": "./src/types.ts"
+  },
+  "files": [
+    "src",
+    "!src/**/*.test.*",
+    "!src/**/*.type-test.*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@meith/core": "0.16.0",
+    "@meith/i18n": "0.16.0"
+  }
+}

package/src/dimensions.ts

@@ -0,0 +1,85 @@
+import type { AttachmentType } from './types'
+
+export interface Dimensions {
+  readonly width: number
+  readonly height: number
+}
+
+function readUint32BE(bytes: Uint8Array, at: number): number | undefined {
+  if (at + 4 > bytes.length) return undefined
+  return (
+    (((bytes[at] as number) << 24) |
+      ((bytes[at + 1] as number) << 16) |
+      ((bytes[at + 2] as number) << 8) |
+      (bytes[at + 3] as number)) >>>
+    0
+  )
+}
+
+function readUint16BE(bytes: Uint8Array, at: number): number | undefined {
+  if (at + 2 > bytes.length) return undefined
+  return ((bytes[at] as number) << 8) | (bytes[at + 1] as number)
+}
+
+function pngDimensions(bytes: Uint8Array): Dimensions | undefined {
+  const isIhdr =
+    bytes[12] === 0x49 && bytes[13] === 0x48 && bytes[14] === 0x44 && bytes[15] === 0x52
+  if (!isIhdr) return undefined
+
+  const width = readUint32BE(bytes, 16)
+  const height = readUint32BE(bytes, 20)
+  if (width === undefined || height === undefined) return undefined
+  if (width === 0 || height === 0) return undefined
+  return { width, height }
+}
+
+const JPEG_START_OF_FRAME = new Set([
+  0xc0, 0xc1, 0xc2, 0xc3, 0xc5, 0xc6, 0xc7, 0xc9, 0xca, 0xcb, 0xcd, 0xce, 0xcf,
+])
+
+function jpegDimensions(bytes: Uint8Array): Dimensions | undefined {
+  let at = 2
+
+  while (at + 4 <= bytes.length) {
+    if (bytes[at] !== 0xff) return undefined
+
+    const marker = bytes[at + 1] as number
+    if (marker === 0xff) {
+      at += 1
+      continue
+    }
+    if (marker === 0xd8 || (marker >= 0xd0 && marker <= 0xd9)) {
+      at += 2
+      continue
+    }
+
+    const length = readUint16BE(bytes, at + 2)
+    if (length === undefined || length < 2) return undefined
+
+    if (JPEG_START_OF_FRAME.has(marker)) {
+      const height = readUint16BE(bytes, at + 5)
+      const width = readUint16BE(bytes, at + 7)
+      if (width === undefined || height === undefined) return undefined
+      if (width === 0 || height === 0) return undefined
+      return { width, height }
+    }
+
+    at += 2 + length
+  }
+
+  return undefined
+}
+
+export function declaredDimensions(
+  bytes: Uint8Array,
+  type: AttachmentType,
+): Dimensions | undefined {
+  switch (type.codec) {
+    case 'png':
+      return pngDimensions(bytes)
+    case 'jpeg':
+      return jpegDimensions(bytes)
+    default:
+      return undefined
+  }
+}

package/src/filename.ts

@@ -0,0 +1,27 @@
+import type { AttachmentType } from './types'
+
+export const MAX_FILENAME_LENGTH = 100
+
+const UNSAFE = /[^A-Za-z0-9._ -]+/g
+
+const EDGES = /^[.\s]+|[.\s]+$/g
+
+export function sanitiseFilename(raw: string, type: AttachmentType): string {
+  const extension = type.extensions[0] as string
+
+  const base = raw.split(/[\\/]/).pop() ?? ''
+
+  const stem = base
+    .replace(/\.[^.]*$/, '')
+    .replace(UNSAFE, '-')
+    .replace(/-{2,}/g, '-')
+    .replace(EDGES, '')
+    .slice(0, MAX_FILENAME_LENGTH - extension.length - 1)
+    .replace(EDGES, '')
+
+  return `${stem === '' ? 'file' : stem}.${extension}`
+}
+
+export function storageKeyFor(purpose: 'source' | 'file' | 'thumb', random: () => string): string {
+  return `attachments/${random()}/${purpose}`
+}

package/src/index.ts

@@ -0,0 +1,47 @@
+export { type Dimensions, declaredDimensions } from './dimensions'
+export {
+  MAX_FILENAME_LENGTH,
+  sanitiseFilename,
+  storageKeyFor,
+} from './filename'
+export {
+  HARD_MAX_BYTES,
+  HARD_MAX_PER_POST,
+  maxBytesFor,
+  maxPerPostFor,
+  type UploadLimits,
+} from './limits'
+export {
+  type AttachmentForDownload,
+  type AttachmentRepository,
+  AttachmentService,
+  type AttachmentServiceDeps,
+  acceptFile,
+  acceptFiles,
+  type CreateAttachmentInput,
+  type ImageProcessor,
+  isViewable,
+  MAX_IMAGE,
+  MAX_MEGAPIXELS,
+  ORPHAN_GRACE_MINUTES,
+  PROCESSING_GRACE_MINUTES,
+  type ProcessedImage,
+  type ReadyInput,
+  type StagedUpload,
+  THUMBNAIL,
+  THUMBNAIL_THRESHOLD,
+} from './service'
+export {
+  ACCEPTED_EXTENSIONS,
+  type AcceptedUpload,
+  ATTACHMENT_FIELD,
+  ATTACHMENT_TYPES,
+  type AttachmentHandling,
+  type AttachmentRecord,
+  type AttachmentStatus,
+  type AttachmentType,
+  attachmentType,
+  type IncomingFile,
+  MAGIC_BYTES_NEEDED,
+  sniff,
+} from './types'

package/src/limits.ts

@@ -0,0 +1,17 @@
+export const HARD_MAX_BYTES = 16 * 1024 * 1024
+export const HARD_MAX_PER_POST = 10
+
+export interface UploadLimits {
+  readonly maxPerPost: number
+  readonly maxSizeKb: number
+}
+
+export function maxBytesFor(limits: UploadLimits): number {
+  const configured = limits.maxSizeKb <= 0 ? HARD_MAX_BYTES : limits.maxSizeKb * 1024
+  return Math.min(configured, HARD_MAX_BYTES)
+}
+
+export function maxPerPostFor(limits: UploadLimits): number {
+  const configured = limits.maxPerPost <= 0 ? HARD_MAX_PER_POST : limits.maxPerPost
+  return Math.min(configured, HARD_MAX_PER_POST)
+}

package/src/service.ts

@@ -0,0 +1,377 @@
+import type { FileStore } from '@meith/core'
+import { ValidationError } from '@meith/core'
+import { msg } from '@meith/i18n'
+
+import { declaredDimensions } from './dimensions'
+import { sanitiseFilename, storageKeyFor } from './filename'
+import { maxBytesFor, maxPerPostFor, type UploadLimits } from './limits'
+import {
+  type AcceptedUpload,
+  type AttachmentRecord,
+  type AttachmentType,
+  type IncomingFile,
+  MAGIC_BYTES_NEEDED,
+  sniff,
+} from './types'
+
+export const MAX_MEGAPIXELS = 50
+
+export const MAX_IMAGE = { width: 2000, height: 2000 } as const
+export const THUMBNAIL = { width: 320, height: 320 } as const
+
+export const THUMBNAIL_THRESHOLD = THUMBNAIL.width
+
+export function acceptFile(file: IncomingFile, limits: UploadLimits): AcceptedUpload {
+  const shown = file.filename.slice(0, 60)
+
+  if (file.bytes.length === 0) {
+    throw new ValidationError(msg('error.attachments.empty', { name: shown }))
+  }
+
+  const maxBytes = maxBytesFor(limits)
+  if (file.bytes.length > maxBytes) {
+    throw new ValidationError(
+      msg('error.attachments.too-large', {
+        name: shown,
+        size: describeSize(file.bytes.length),
+        limit: describeSize(maxBytes),
+      }),
+    )
+  }
+
+  if (file.bytes.length < MAGIC_BYTES_NEEDED) {
+    throw new ValidationError(msg('error.attachments.too-short', { name: shown }))
+  }
+
+  const type = sniff(file.bytes)
+  if (type === undefined) {
+    throw new ValidationError(msg('error.attachments.bad-type', { name: shown }))
+  }
+
+  if (type.codec !== null) {
+    const size = declaredDimensions(file.bytes, type)
+    if (size === undefined) {
+      throw new ValidationError(msg('error.attachments.damaged', { name: shown }))
+    }
+    if ((size.width * size.height) / 1_000_000 > MAX_MEGAPIXELS) {
+      throw new ValidationError(
+        msg('error.attachments.too-many-pixels', {
+          name: shown,
+          width: size.width,
+          height: size.height,
+          max: MAX_MEGAPIXELS,
+        }),
+      )
+    }
+  }
+
+  return { filename: sanitiseFilename(file.filename, type), type, bytes: file.bytes }
+}
+
+export function acceptFiles(
+  files: readonly IncomingFile[],
+  limits: UploadLimits,
+  existing = 0,
+): readonly AcceptedUpload[] {
+  const cap = maxPerPostFor(limits)
+  if (existing + files.length > cap) {
+    throw new ValidationError(msg('error.attachments.per-post', { max: cap }))
+  }
+  return files.map((file) => acceptFile(file, limits))
+}
+
+function describeSize(bytes: number): string {
+  if (bytes >= 1024 * 1024) return `${Math.round((bytes / (1024 * 1024)) * 10) / 10} MB`
+  return `${Math.max(1, Math.round(bytes / 1024))} KB`
+}
+
+export interface ProcessedImage {
+  readonly bytes: Uint8Array
+  readonly contentType: string
+  readonly width: number
+  readonly height: number
+  readonly thumbnail?: {
+    readonly bytes: Uint8Array
+    readonly contentType: string
+  }
+}
+
+export interface ImageProcessor {
+  process(input: {
+    readonly bytes: Uint8Array
+    readonly codec: 'png' | 'jpeg'
+    readonly fit?: { readonly width: number; readonly height: number }
+    readonly thumbnail?: boolean
+  }): Promise<ProcessedImage>
+}
+
+export interface CreateAttachmentInput {
+  readonly postId: number | null
+  readonly forumId: number
+  readonly uploaderUserId: number
+  readonly filename: string
+  readonly contentType: string
+  readonly sizeBytes: number
+  readonly sourceKey: string | null
+  readonly storageKey: string | null
+  readonly status: 'pending' | 'ready'
+}
+
+export interface ReadyInput {
+  readonly storageKey: string
+  readonly thumbnailKey: string | null
+  readonly width: number | null
+  readonly height: number | null
+  readonly sizeBytes: number
+}
+
+export interface AttachmentForDownload {
+  readonly record: AttachmentRecord
+  readonly postVisibility: string
+  readonly threadVisibility: string
+  readonly threadAuthorUserId: number | null
+}
+
+export interface AttachmentRepository {
+  create(input: CreateAttachmentInput): Promise<AttachmentRecord>
+  findById(id: number): Promise<AttachmentRecord | null>
+  findForDownload(id: number): Promise<AttachmentForDownload | null>
+  listForPosts(postIds: readonly number[]): Promise<readonly AttachmentRecord[]>
+  countForPost(postId: number): Promise<number>
+  markReady(id: number, input: ReadyInput): Promise<void>
+  markFailed(id: number, reason: string): Promise<void>
+  recordDownload(id: number): Promise<void>
+  stalled(before: Date, limit: number): Promise<readonly AttachmentRecord[]>
+
+  attachTo(id: number, postId: number): Promise<AttachmentRecord | null>
+  deleteOrphans(before: Date, limit: number): Promise<readonly AttachmentRecord[]>
+
+  rememberKey(key: string): Promise<void>
+  forgetKeys(keys: readonly string[]): Promise<void>
+  staleKeys(before: Date, limit: number): Promise<readonly string[]>
+}
+
+export interface AttachmentServiceDeps {
+  readonly attachments: AttachmentRepository
+  readonly files: FileStore
+  readonly images: ImageProcessor
+  readonly random?: () => string
+  readonly now?: () => Date
+}
+
+export const ORPHAN_GRACE_MINUTES = 60
+
+export const PROCESSING_GRACE_MINUTES = 30
+
+export class AttachmentService {
+  private readonly deps: AttachmentServiceDeps
+  private readonly random: () => string
+  private readonly now: () => Date
+
+  constructor(deps: AttachmentServiceDeps) {
+    this.deps = deps
+    this.random = deps.random ?? defaultRandom
+    this.now = deps.now ?? (() => new Date())
+  }
+
+  async stage(uploads: readonly AcceptedUpload[]): Promise<readonly StagedUpload[]> {
+    const staged: StagedUpload[] = []
+    for (const upload of uploads) {
+      const opaque = upload.type.handling === 'opaque'
+      const key = storageKeyFor(opaque ? 'file' : 'source', this.random)
+
+      await this.deps.attachments.rememberKey(key)
+      await this.deps.files.put(key, upload.bytes, {
+        contentType: upload.type.contentType,
+        visibility: 'private',
+      })
+
+      staged.push({ upload, key, opaque })
+    }
+    return staged
+  }
+
+  async attach(
+    staged: readonly StagedUpload[],
+    post: { readonly postId: number; readonly forumId: number; readonly userId: number },
+  ): Promise<readonly AttachmentRecord[]> {
+    const created: AttachmentRecord[] = []
+
+    for (const item of staged) {
+      const record = await this.deps.attachments.create({
+        postId: post.postId,
+        forumId: post.forumId,
+        uploaderUserId: post.userId,
+        filename: item.upload.filename,
+        contentType: item.upload.type.contentType,
+        sizeBytes: item.upload.bytes.length,
+        sourceKey: item.opaque ? null : item.key,
+        storageKey: item.opaque ? item.key : null,
+        status: item.opaque ? 'ready' : 'pending',
+      })
+      await this.deps.attachments.forgetKeys([item.key])
+      created.push(record)
+    }
+
+    return created
+  }
+
+  async uploadOrphan(
+    upload: AcceptedUpload,
+    owner: { readonly forumId: number; readonly uploaderUserId: number },
+  ): Promise<AttachmentRecord> {
+    const opaque = upload.type.handling === 'opaque'
+    const key = storageKeyFor(opaque ? 'file' : 'source', this.random)
+
+    await this.deps.attachments.rememberKey(key)
+    await this.deps.files.put(key, upload.bytes, {
+      contentType: upload.type.contentType,
+      visibility: 'private',
+    })
+
+    const record = await this.deps.attachments.create({
+      postId: null,
+      forumId: owner.forumId,
+      uploaderUserId: owner.uploaderUserId,
+      filename: upload.filename,
+      contentType: upload.type.contentType,
+      sizeBytes: upload.bytes.length,
+      sourceKey: opaque ? null : key,
+      storageKey: opaque ? key : null,
+      status: opaque ? 'ready' : 'pending',
+    })
+    await this.deps.attachments.forgetKeys([key])
+
+    return record
+  }
+
+  async claim(
+    ids: readonly number[],
+    post: { readonly postId: number; readonly forumId: number; readonly uploaderUserId: number },
+  ): Promise<readonly AttachmentRecord[]> {
+    const claimed: AttachmentRecord[] = []
+
+    for (const id of ids) {
+      const record = await this.deps.attachments.findById(id)
+      if (record === null || record.postId !== null) continue
+      if (record.forumId !== post.forumId || record.uploaderUserId !== post.uploaderUserId) continue
+
+      const attached = await this.deps.attachments.attachTo(id, post.postId)
+      if (attached !== null) claimed.push(attached)
+    }
+
+    return claimed
+  }
+
+  async process(attachmentId: number): Promise<'done' | 'skipped' | 'failed'> {
+    const record = await this.deps.attachments.findById(attachmentId)
+    if (record === null || record.status !== 'pending' || record.sourceKey === null) {
+      return 'skipped'
+    }
+
+    const type = attachmentCodec(record.contentType)
+    if (type === null) {
+      await this.deps.attachments.markFailed(record.id, 'Unsupported image type.')
+      return 'failed'
+    }
+
+    const source = await this.deps.files.get(record.sourceKey)
+    if (source === undefined) {
+      await this.deps.attachments.markFailed(record.id, 'The uploaded file is no longer available.')
+      return 'failed'
+    }
+
+    let processed: ProcessedImage
+    try {
+      processed = await this.deps.images.process({ bytes: source, codec: type })
+    } catch {
+      await this.deps.attachments.markFailed(record.id, 'That image could not be read.')
+      await this.discard(record.sourceKey)
+      return 'failed'
+    }
+
+    const fileKey = storageKeyFor('file', this.random)
+    await this.deps.attachments.rememberKey(fileKey)
+    await this.deps.files.put(fileKey, processed.bytes, {
+      contentType: processed.contentType,
+      visibility: 'private',
+    })
+
+    let thumbKey: string | null = null
+    if (processed.thumbnail !== undefined) {
+      thumbKey = storageKeyFor('thumb', this.random)
+      await this.deps.attachments.rememberKey(thumbKey)
+      await this.deps.files.put(thumbKey, processed.thumbnail.bytes, {
+        contentType: processed.thumbnail.contentType,
+        visibility: 'private',
+      })
+    }
+
+    await this.deps.attachments.markReady(record.id, {
+      storageKey: fileKey,
+      thumbnailKey: thumbKey,
+      width: processed.width,
+      height: processed.height,
+      sizeBytes: processed.bytes.length,
+    })
+    await this.deps.attachments.forgetKeys(thumbKey === null ? [fileKey] : [fileKey, thumbKey])
+
+    await this.discard(record.sourceKey)
+    return 'done'
+  }
+
+  async sweep(limit = 200): Promise<{ deleted: number; failed: number }> {
+    const now = this.now()
+
+    const stalled = await this.deps.attachments.stalled(
+      new Date(now.getTime() - PROCESSING_GRACE_MINUTES * 60_000),
+      limit,
+    )
+    for (const record of stalled) {
+      await this.deps.attachments.markFailed(
+        record.id,
+        'Processing did not finish. Please upload it again.',
+      )
+      if (record.sourceKey !== null) await this.discard(record.sourceKey)
+    }
+
+    const orphanCutoff = new Date(now.getTime() - ORPHAN_GRACE_MINUTES * 60_000)
+
+    const staleOrphans = await this.deps.attachments.deleteOrphans(orphanCutoff, limit)
+    for (const record of staleOrphans) {
+      for (const key of [record.sourceKey, record.storageKey, record.thumbnailKey]) {
+        if (key !== null) await this.discard(key)
+      }
+    }
+
+    const keys = await this.deps.attachments.staleKeys(orphanCutoff, limit)
+    for (const key of keys) await this.discard(key)
+
+    return { deleted: keys.length + staleOrphans.length, failed: stalled.length }
+  }
+
+  private async discard(key: string): Promise<void> {
+    await this.deps.files.delete(key)
+    await this.deps.attachments.forgetKeys([key])
+  }
+}
+
+export interface StagedUpload {
+  readonly upload: AcceptedUpload
+  readonly key: string
+  readonly opaque: boolean
+}
+
+function attachmentCodec(contentType: string): 'png' | 'jpeg' | null {
+  if (contentType === 'image/png') return 'png'
+  if (contentType === 'image/jpeg') return 'jpeg'
+  return null
+}
+
+function defaultRandom(): string {
+  return crypto.randomUUID()
+}
+
+export function isViewable(record: AttachmentRecord, type: AttachmentType | undefined): boolean {
+  return record.status === 'ready' && record.storageKey !== null && type?.inline === true
+}

package/src/types.ts

@@ -0,0 +1,105 @@
+export type AttachmentHandling = 'reencode' | 'opaque'
+
+export interface AttachmentType {
+  readonly contentType: string
+  readonly extensions: readonly string[]
+  readonly magic: readonly (readonly number[])[]
+  readonly handling: AttachmentHandling
+  readonly codec: 'png' | 'jpeg' | null
+  readonly inline: boolean
+}
+
+export const ATTACHMENT_TYPES: readonly AttachmentType[] = [
+  {
+    contentType: 'image/png',
+    extensions: ['png'],
+    magic: [[0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a]],
+    handling: 'reencode',
+    codec: 'png',
+    inline: true,
+  },
+  {
+    contentType: 'image/jpeg',
+    extensions: ['jpg', 'jpeg', 'jpe'],
+    magic: [[0xff, 0xd8, 0xff]],
+    handling: 'reencode',
+    codec: 'jpeg',
+    inline: true,
+  },
+  {
+    contentType: 'application/pdf',
+    extensions: ['pdf'],
+    magic: [[0x25, 0x50, 0x44, 0x46, 0x2d]],
+    handling: 'opaque',
+    codec: null,
+    inline: false,
+  },
+  {
+    contentType: 'application/zip',
+    extensions: ['zip'],
+    magic: [
+      [0x50, 0x4b, 0x03, 0x04],
+      [0x50, 0x4b, 0x05, 0x06],
+      [0x50, 0x4b, 0x07, 0x08],
+    ],
+    handling: 'opaque',
+    codec: null,
+    inline: false,
+  },
+] as const
+
+export const MAGIC_BYTES_NEEDED = ATTACHMENT_TYPES.reduce(
+  (most, type) => Math.max(most, ...type.magic.map((m) => m.length)),
+  0,
+)
+
+export function sniff(bytes: Uint8Array): AttachmentType | undefined {
+  return ATTACHMENT_TYPES.find((type) =>
+    type.magic.some(
+      (signature) =>
+        bytes.length >= signature.length && signature.every((byte, at) => bytes[at] === byte),
+    ),
+  )
+}
+
+export function attachmentType(contentType: string): AttachmentType | undefined {
+  return ATTACHMENT_TYPES.find((type) => type.contentType === contentType)
+}
+
+export const ACCEPTED_EXTENSIONS: readonly string[] = ATTACHMENT_TYPES.flatMap(
+  (type) => type.extensions,
+)
+
+export const ATTACHMENT_FIELD = 'attachments'
+
+export type AttachmentStatus = 'pending' | 'ready' | 'failed'
+
+export interface AttachmentRecord {
+  readonly id: number
+  readonly postId: number | null
+  readonly forumId: number
+  readonly uploaderUserId: number | null
+  readonly filename: string
+  readonly contentType: string
+  readonly sizeBytes: number
+  readonly storageKey: string | null
+  readonly sourceKey: string | null
+  readonly thumbnailKey: string | null
+  readonly width: number | null
+  readonly height: number | null
+  readonly status: AttachmentStatus
+  readonly failureReason: string | null
+  readonly downloadCount: number
+  readonly createdAt: Date
+}
+
+export interface IncomingFile {
+  readonly filename: string
+  readonly bytes: Uint8Array
+}
+
+export interface AcceptedUpload {
+  readonly filename: string
+  readonly type: AttachmentType
+  readonly bytes: Uint8Array
+}