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

package/src/index.ts

@@ -0,0 +1,253 @@
+import {
+  type AcceptedUpload,
+  acceptFile,
+  type ImageProcessor,
+  type IncomingFile,
+  storageKeyFor,
+} from '@meith/attachments'
+import type { FileStore } from '@meith/core'
+import { ForbiddenError, ValidationError } from '@meith/core'
+import { msg } from '@meith/i18n'
+
+import { AVATAR_BOX, AVATAR_MAX_BYTES } from './limits'
+
+export { AVATAR_BOX, AVATAR_MAX_BYTES } from './limits'
+
+export type AvatarStatus = 'none' | 'pending' | 'ready' | 'failed'
+
+export interface StoredAvatar {
+  readonly status: AvatarStatus
+  readonly key: string | null
+  readonly sourceKey: string | null
+  readonly width: number | null
+  readonly height: number | null
+  readonly failureReason: string | null
+  readonly updatedAt: Date | null
+  readonly locked: boolean
+  readonly lockedReason: string | null
+}
+
+export const NO_AVATAR: StoredAvatar = {
+  status: 'none',
+  key: null,
+  sourceKey: null,
+  width: null,
+  height: null,
+  failureReason: null,
+  updatedAt: null,
+  locked: false,
+  lockedReason: null,
+}
+
+export function avatarVisible(avatar: StoredAvatar): boolean {
+  return avatar.status === 'ready' && avatar.key !== null && !avatar.locked
+}
+
+export function avatarUrl(userId: number, avatar: StoredAvatar): string | null {
+  if (!avatarVisible(avatar)) return null
+  const version = avatar.updatedAt === null ? 0 : avatar.updatedAt.getTime()
+  return `/avatar/${userId}?v=${version}`
+}
+
+export interface AvatarRepository {
+  find(userId: number): Promise<StoredAvatar | null>
+  readMany(userIds: readonly number[]): Promise<ReadonlyMap<number, StoredAvatar>>
+  beginUpload(input: {
+    readonly userId: number
+    readonly sourceKey: string
+    readonly at: Date
+  }): Promise<{ readonly replaced: readonly string[] }>
+  markReady(input: {
+    readonly userId: number
+    readonly key: string
+    readonly width: number
+    readonly height: number
+  }): Promise<void>
+  markFailed(userId: number, reason: string): Promise<void>
+  clear(userId: number): Promise<{ readonly replaced: readonly string[] }>
+  lock(input: {
+    readonly userId: number
+    readonly locked: boolean
+    readonly reason: string | null
+  }): Promise<void>
+  stalled(before: Date, limit: number): Promise<readonly number[]>
+
+  rememberKey(key: string): Promise<void>
+  forgetKeys(keys: readonly string[]): Promise<void>
+}
+
+export interface AvatarServiceDeps {
+  readonly avatars: AvatarRepository
+  readonly files: FileStore
+  readonly images: ImageProcessor
+  readonly random?: () => string
+  readonly now?: () => Date
+}
+
+export const AVATAR_PROCESSING_GRACE_MINUTES = 30
+
+export class AvatarService {
+  private readonly deps: AvatarServiceDeps
+  private readonly random: () => string
+  private readonly now: () => Date
+
+  constructor(deps: AvatarServiceDeps) {
+    this.deps = deps
+    this.random = deps.random ?? (() => crypto.randomUUID())
+    this.now = deps.now ?? (() => new Date())
+  }
+
+  async upload(input: {
+    readonly userId: number
+    readonly file: IncomingFile
+    readonly mayUpload: boolean
+  }): Promise<void> {
+    if (!input.mayUpload) {
+      throw new ForbiddenError(msg('error.avatars.upload-avatar'))
+    }
+
+    const current = await this.deps.avatars.find(input.userId)
+    if (current?.locked === true) {
+      throw new ForbiddenError(msg('error.avatars.moderator-locked-avatar-so-changed'))
+    }
+
+    const accepted = this.accept(input.file)
+
+    const key = storageKeyFor('source', this.random)
+    await this.deps.avatars.rememberKey(key)
+    await this.deps.files.put(key, accepted.bytes, {
+      contentType: accepted.type.contentType,
+      visibility: 'private',
+    })
+
+    const { replaced } = await this.deps.avatars.beginUpload({
+      userId: input.userId,
+      sourceKey: key,
+      at: this.now(),
+    })
+    await this.deps.avatars.forgetKeys([key])
+    await this.sweepKeys(replaced)
+  }
+
+  private accept(file: IncomingFile): AcceptedUpload {
+    const accepted = acceptFile(file, {
+      maxPerPost: 1,
+      maxSizeKb: AVATAR_MAX_BYTES / 1024,
+    })
+
+    if (accepted.type.codec === null) {
+      throw new ValidationError(msg('error.avatars.avatar-must-png-jpeg'))
+    }
+    return accepted
+  }
+
+  async process(userId: number): Promise<'done' | 'skipped' | 'failed'> {
+    const current = await this.deps.avatars.find(userId)
+    if (current === null || current.status !== 'pending' || current.sourceKey === null) {
+      return 'skipped'
+    }
+
+    const source = await this.deps.files.get(current.sourceKey)
+    if (source === undefined) {
+      await this.fail(userId, 'The uploaded file is no longer available.', current.sourceKey)
+      return 'failed'
+    }
+
+    const accepted = (() => {
+      try {
+        return this.accept({ filename: 'avatar', bytes: source })
+      } catch {
+        return null
+      }
+    })()
+
+    if (accepted === null) {
+      await this.fail(userId, 'That image could not be read.', current.sourceKey)
+      return 'failed'
+    }
+
+    let processed: Awaited<ReturnType<ImageProcessor['process']>>
+    try {
+      processed = await this.deps.images.process({
+        bytes: source,
+        codec: accepted.type.codec as 'png' | 'jpeg',
+        fit: AVATAR_BOX,
+        thumbnail: false,
+      })
+    } catch {
+      await this.fail(userId, 'That image could not be read.', current.sourceKey)
+      return 'failed'
+    }
+
+    const key = storageKeyFor('file', this.random)
+    await this.deps.avatars.rememberKey(key)
+    await this.deps.files.put(key, processed.bytes, {
+      contentType: processed.contentType,
+      visibility: 'private',
+    })
+
+    await this.deps.avatars.markReady({
+      userId,
+      key,
+      width: processed.width,
+      height: processed.height,
+    })
+    await this.deps.avatars.forgetKeys([key])
+    await this.discard(current.sourceKey)
+    return 'done'
+  }
+
+  async remove(userId: number): Promise<void> {
+    const current = await this.deps.avatars.find(userId)
+    if (current?.locked === true) {
+      throw new ForbiddenError(msg('error.avatars.moderator-locked-avatar-so-changed'))
+    }
+    const { replaced } = await this.deps.avatars.clear(userId)
+    await this.sweepKeys(replaced)
+  }
+
+  async setLock(input: {
+    readonly userId: number
+    readonly locked: boolean
+    readonly reason: string
+  }): Promise<void> {
+    const reason = input.reason.trim()
+    if (input.locked && reason === '') {
+      throw new ValidationError(msg('error.avatars.give-reason-member-shown'))
+    }
+    await this.deps.avatars.lock({
+      userId: input.userId,
+      locked: input.locked,
+      reason: input.locked ? reason : null,
+    })
+  }
+
+  async sweep(limit = 200): Promise<number> {
+    const cutoff = new Date(this.now().getTime() - AVATAR_PROCESSING_GRACE_MINUTES * 60_000)
+    const stalled = await this.deps.avatars.stalled(cutoff, limit)
+
+    for (const userId of stalled) {
+      const current = await this.deps.avatars.find(userId)
+      await this.deps.avatars.markFailed(
+        userId,
+        'Processing did not finish. Please upload it again.',
+      )
+      if (current?.sourceKey != null) await this.discard(current.sourceKey)
+    }
+    return stalled.length
+  }
+
+  private async fail(userId: number, reason: string, sourceKey: string): Promise<void> {
+    await this.deps.avatars.markFailed(userId, reason)
+    await this.discard(sourceKey)
+  }
+
+  private async sweepKeys(keys: readonly string[]): Promise<void> {
+    for (const key of keys) await this.discard(key)
+  }
+
+  private async discard(key: string): Promise<void> {
+    await this.deps.files.delete(key)
+    await this.deps.avatars.forgetKeys([key])
+  }
+}

package/src/limits.ts

@@ -0,0 +1,3 @@
+export const AVATAR_BOX = { width: 200, height: 200 } as const
+
+export const AVATAR_MAX_BYTES = 2 * 1024 * 1024